admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #3087 from GauthamGoli/patches_missing_rule_fix

Browse Source 
audit: Add previously unported GH patch audit rule in Patches cop
This commit is contained in:
Mike McQuaid 2017-08-26 14:23:39 +01:00 committed by GitHub
commit 4d90ae2f4d
2 changed files with 127 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Library/Homebrew/rubocops/patches_cop.rb
View File

@ -25,12 +25,22 @@ module RuboCop
def patch_problems(patch)
patch_url = string_content(patch)
gh_patch_param_pattern = %r{https?://github\.com/.+/.+/(?:commit|pull)/[a-fA-F0-9]*.(?:patch|diff)}
if regex_match_group(patch, gh_patch_param_pattern)
if patch_url !~ /\?full_index=\w+$/
problem <<-EOS.undent
GitHub patches should use the full_index parameter:
#{patch_url}?full_index=1
EOS
end
end
gh_patch_patterns = Regexp.union([%r{/raw\.github\.com/},
%r{gist\.github\.com/raw},
%r{gist\.github\.com/.+/raw},
%r{gist\.githubusercontent\.com/.+/raw}])
if regex_match_group(patch, gh_patch_patterns)
unless patch_url =~ /[a-fA-F0-9]{40}/
if patch_url !~ /[a-fA-F0-9]{40}/
problem <<-EOS.undent.chomp
GitHub/Gist patches should specify a revision:
#{patch_url}

38
Library/Homebrew/test/rubocops/patches_cop_spec.rb
View File

@ -48,6 +48,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
"http://trac.macports.org/export/102865/trunk/dports/mail/uudeview/files/inews.c.patch",
"http://bugs.debian.org/cgi-bin/bugreport.cgi?msg=5;filename=patch-libunac1.txt;att=1;bug=623340",
"https://patch-diff.githubusercontent.com/raw/foo/foo-bar/pull/100.patch",
"https://github.com/dlang/dub/pull/1221.patch",
]
patch_urls.each do |patch_url|
source = <<-EOS.undent
@ -61,8 +62,8 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS
inspect_source(cop, source)
if patch_url =~ %r{/raw\.github\.com/}
expected_offenses = [{ message: <<-EOS.undent.chomp,
expected_offense = if patch_url =~ %r{/raw\.github\.com/}
[{ message: <<-EOS.undent.chomp,
GitHub/Gist patches should specify a revision:
#{patch_url}
EOS
@ -71,7 +72,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
column: 12,
source: source }]
elsif patch_url =~ %r{macports/trunk}
expected_offenses = [{ message: <<-EOS.undent.chomp,
[{ message: <<-EOS.undent.chomp,
MacPorts patches should specify a revision instead of trunk:
#{patch_url}
EOS
@ -80,7 +81,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
column: 33,
source: source }]
elsif patch_url =~ %r{^http://trac\.macports\.org}
expected_offenses = [{ message: <<-EOS.undent.chomp,
[{ message: <<-EOS.undent.chomp,
Patches from MacPorts Trac should be https://, not http:
#{patch_url}
EOS
@ -89,7 +90,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
column: 5,
source: source }]
elsif patch_url =~ %r{^http://bugs\.debian\.org}
expected_offenses = [{ message: <<-EOS.undent.chomp,
[{ message: <<-EOS.undent.chomp,
Patches from Debian should be https://, not http:
#{patch_url}
EOS
@ -98,7 +99,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
column: 5,
source: source }]
elsif patch_url =~ %r{https?://patch-diff\.githubusercontent\.com/raw/(.+)/(.+)/pull/(.+)\.(?:diff|patch)}
expected_offenses = [{ message: <<-EOS.undent,
[{ message: <<-EOS.undent,
use GitHub pull request URLs:
https://github.com/foo/foo-bar/pull/100.patch
Rather than patch-diff:
@ -108,8 +109,17 @@ describe RuboCop::Cop::FormulaAudit::Patches do
line: 5,
column: 5,
source: source }]
elsif patch_url =~ %r{https?://github\.com/.+/.+/(?:commit|pull)/[a-fA-F0-9]*.(?:patch|diff)}
[{ message: <<-EOS.undent,
GitHub patches should use the full_index parameter:
#{patch_url}?full_index=1
EOS
severity: :convention,
line: 5,
column: 5,
source: source }]
end
expected_offenses.zip([cop.offenses.last]).each do |expected, actual|
expected_offense.zip([cop.offenses.last]).each do |expected, actual|
expect_offense(expected, actual)
end
end
@ -174,8 +184,8 @@ describe RuboCop::Cop::FormulaAudit::Patches do
EOS
inspect_source(cop, source)
if patch_url =~ %r{/raw\.github\.com/}
expected_offenses = [{ message: <<-EOS.undent.chomp,
expected_offense = if patch_url =~ %r{/raw\.github\.com/}
[{ message: <<-EOS.undent.chomp,
GitHub/Gist patches should specify a revision:
#{patch_url}
EOS
@ -184,7 +194,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
column: 16,
source: source }]
elsif patch_url =~ %r{macports/trunk}
expected_offenses = [{ message: <<-EOS.undent.chomp,
[{ message: <<-EOS.undent.chomp,
MacPorts patches should specify a revision instead of trunk:
#{patch_url}
EOS
@ -193,7 +203,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
column: 37,
source: source }]
elsif patch_url =~ %r{^http://trac\.macports\.org}
expected_offenses = [{ message: <<-EOS.undent.chomp,
[{ message: <<-EOS.undent.chomp,
Patches from MacPorts Trac should be https://, not http:
#{patch_url}
EOS
@ -202,7 +212,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
column: 9,
source: source }]
elsif patch_url =~ %r{^http://bugs\.debian\.org}
expected_offenses = [{ message: <<-EOS.undent.chomp,
[{ message: <<-EOS.undent.chomp,
Patches from Debian should be https://, not http:
#{patch_url}
EOS
@ -211,7 +221,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
column: 9,
source: source }]
elsif patch_url =~ %r{https?://patch-diff\.githubusercontent\.com/raw/(.+)/(.+)/pull/(.+)\.(?:diff|patch)}
expected_offenses = [{ message: <<-EOS.undent,
[{ message: <<-EOS.undent,
use GitHub pull request URLs:
https://github.com/foo/foo-bar/pull/100.patch
Rather than patch-diff:
@ -222,7 +232,7 @@ describe RuboCop::Cop::FormulaAudit::Patches do
column: 9,
source: source }]
end
expected_offenses.zip([cop.offenses.last]).each do |expected, actual|
expected_offense.zip([cop.offenses.last]).each do |expected, actual|
expect_offense(expected, actual)
end
end