Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix audit for verified parameter. #9524

Merged
merged 1 commit into from Dec 16, 2020
Merged

Fix audit for verified parameter. #9524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 19 additions & 14 deletions Library/Homebrew/cask/audit.rb
View file
Open in desktop
Expand Up @@ -359,7 +359,7 @@ def domain
end

def url_match_homepage?
host = cask.url.to_s.downcase
host = cask.url.to_s
host_uri = URI(host)
host = if host.match?(/:\d/) && host_uri.port != 80
"#{host_uri.host}:#{host_uri.port}"
Expand All @@ -377,52 +377,57 @@ def url_match_homepage?
end

def strip_url_scheme(url)
url.sub(%r{^.*://(www\.)?}, "")
url.sub(%r{^[^:/]+://(www\.)?}, "")
end

def url_from_verified
cask.url.verified.sub(%r{^https?://}, "")
strip_url_scheme(cask.url.verified)
end

def verified_matches_url?
strip_url_scheme(cask.url.to_s).start_with?(url_from_verified)
url_domain, url_path = strip_url_scheme(cask.url.to_s).split("/", 2)
verified_domain, verified_path = url_from_verified.split("/", 2)

(url_domain == verified_domain || (verified_domain && url_domain&.end_with?(".#{verified_domain}"))) &&
(!verified_path || url_path&.start_with?(verified_path))
end

def verified_present?
cask.url.verified.present?
end

def url_includes_file?
cask.url.to_s.start_with?("file://")
def file_url?
URI(cask.url.to_s).scheme == "file"
end

def check_unnecessary_verified
return unless verified_present?
return unless url_match_homepage?
return unless verified_matches_url?

add_warning "The URL's #{domain} matches the homepage #{homepage}, " \
"the `verified` parameter of the `url` stanza is unnecessary. " \
"See https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#when-url-and-homepage-hostnames-differ-add-verified"
add_error "The URL's domain #{domain} matches the homepage domain #{homepage}, " \
"the `verified` parameter of the `url` stanza is unnecessary. " \
"See https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#when-url-and-homepage-hostnames-differ-add-verified"
end

def check_missing_verified
return if cask.url.from_block?
return if url_includes_file?
return if file_url?
return if url_match_homepage?
return if verified_present?

add_warning "#{domain} does not match #{homepage}, a `verified` parameter of the `url` has to be added. " \
" See https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#when-url-and-homepage-hostnames-differ-add-verified"
add_error "The URL's domain #{domain} does not match the homepage domain #{homepage}, " \
"a `verified` parameter has to be added to the `url` stanza. " \
"See https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#when-url-and-homepage-hostnames-differ-add-verified"
end

def check_no_match
return if url_match_homepage?
return unless verified_present?
return if !url_match_homepage? && verified_matches_url?

add_warning "#{url_from_verified} does not match #{strip_url_scheme(cask.url.to_s)}. " \
"See https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#when-url-and-homepage-hostnames-differ-add-verified"
add_error "Verified URL #{url_from_verified} does not match URL #{strip_url_scheme(cask.url.to_s)}. " \
"See https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/url.md#when-url-and-homepage-hostnames-differ-add-verified"
end

def check_generic_artifacts
Expand Down
32 changes: 16 additions & 16 deletions Library/Homebrew/test/cask/audit_spec.rb
View file
Open in desktop
Expand Up @@ -918,32 +918,32 @@ def tmp_cask(name, text)
let(:cask) do
tmp_cask cask_token.to_s, <<~RUBY
cask '#{cask_token}' do
version '1.8.0_72,8.13.0.5'
sha256 '8dd95daa037ac02455435446ec7bc737b34567afe9156af7d20b2a83805c1d8a'
url 'https://brew.sh/foo.zip'
name 'Audit'
desc 'Audit Description'
homepage 'https://foo.example.org'
app 'Audit.app'
version "1.8.0_72,8.13.0.5"
sha256 "8dd95daa037ac02455435446ec7bc737b34567afe9156af7d20b2a83805c1d8a"
url "https://brew.sh/foo-\#{version.after_comma}.zip"
name "Audit"
desc "Audit Description"
homepage "https://foo.example.org"
app "Audit.app"
end
RUBY
end

it { is_expected.to warn_with(/a `verified` parameter of the `url` has to be added./) }
it { is_expected.to fail_with(/a `verified` parameter has to be added/) }
end

context "when the url does not match the homepage with verified" do
let(:cask_token) { "foo" }
let(:cask) do
tmp_cask cask_token.to_s, <<~RUBY
cask '#{cask_token}' do
version '1.8.0_72,8.13.0.5'
sha256 '8dd95daa037ac02455435446ec7bc737b34567afe9156af7d20b2a83805c1d8a'
url 'https://brew.sh/foo.zip', verified: 'brew.sh'
name 'Audit'
desc 'Audit Description'
homepage 'https://foo.example.org'
app 'Audit.app'
cask "#{cask_token}" do
version "1.8.0_72,8.13.0.5"
sha256 "8dd95daa037ac02455435446ec7bc737b34567afe9156af7d20b2a83805c1d8a"
url "https://brew.sh/foo-\#{version.after_comma}.zip", verified: "brew.sh"
name "Audit"
desc "Audit Description"
homepage "https://foo.example.org"
app "Audit.app"
end
RUBY
end
Expand Down