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

Merge pull request #15201 from hyuraku/remove_cask/cmd/audit

Browse Source 
remove `cask/cmd/audit`
This commit is contained in:
Mike McQuaid 2023-04-19 10:01:06 +01:00 committed by GitHub
commit 0b4c0350c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 24 additions and 314 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Library/Homebrew/cask/cmd.rb
View File

@ -10,7 +10,6 @@ require "extend/optparse"
require "cask/config"
require "cask/cmd/abstract_command"
require "cask/cmd/audit"
require "cask/cmd/install"
module Cask

110
Library/Homebrew/cask/cmd/audit.rb
View File

@ -1,110 +0,0 @@
# typed: false
# frozen_string_literal: true
require "utils/github/actions"
module Cask
class Cmd
# Cask implementation of the `brew audit` command.
#
# @api private
class Audit < AbstractCommand
extend T::Sig
def self.parser
super do
switch "--[no-]download",
description: "Audit the downloaded file"
switch "--[no-]appcast",
description: "Audit the appcast",
replacement: false
switch "--[no-]token-conflicts",
description: "Audit for token conflicts"
switch "--[no-]signing",
description: "Audit for signed apps, which is required on ARM"
switch "--[no-]strict",
description: "Run additional, stricter style checks"
switch "--[no-]online",
description: "Run additional, slower style checks that require a network connection"
switch "--new-cask",
description: "Run various additional style checks to determine if a new cask is eligible " \
"for Homebrew. This should be used when creating new casks and implies " \
"`--strict` and `--online`"
end
end
sig { void }
def run
casks = args.named.flat_map do |name|
next name if File.exist?(name)
next Tap.fetch(name).cask_files if name.count("/") == 1
name
end
casks = casks.map { |c| CaskLoader.load(c, config: Config.from_args(args)) }
any_named_args = casks.any?
casks = Cask.to_a if casks.empty?
results = self.class.audit_casks(
*casks,
download: args.download?,
online: args.online?,
strict: args.strict?,
signing: args.signing?,
new_cask: args.new_cask?,
token_conflicts: args.token_conflicts?,
quarantine: args.quarantine?,
any_named_args: any_named_args,
language: args.language,
only: [],
except: [],
)
failed_casks = results.reject { |_, result| result[:errors].empty? }.map(&:first)
return if failed_casks.empty?
raise CaskError, "audit failed for casks: #{failed_casks.join(" ")}"
end
def self.audit_casks(
*casks,
download:,
online:,
strict:,
signing:,
new_cask:,
token_conflicts:,
quarantine:,
any_named_args:,
language:,
only:,
except:
)
options = {
audit_download: download,
audit_online: online,
audit_strict: strict,
audit_signing: signing,
audit_new_cask: new_cask,
audit_token_conflicts: token_conflicts,
quarantine: quarantine,
language: language,
any_named_args: any_named_args,
only: only,
except: except,
}.compact
options[:quarantine] = true if options[:quarantine].nil?
Homebrew.auditing = true
require "cask/auditor"
casks.to_h do |cask|
odebug "Auditing Cask #{cask}"
[cask.sourcefile_path, { errors: Auditor.audit(cask, **options), warnings: [] }]
end
end
end
end
end

43
Library/Homebrew/dev-cmd/audit.rb
View File

@ -245,30 +245,35 @@ module Homebrew
cask_results = if audit_casks.empty?
{}
else
require "cask/cmd/abstract_command"
require "cask/cmd/audit"
if args.display_failures_only?
odeprecated "`brew audit <cask> --display-failures-only`", "`brew audit <cask>` without the argument"
end
# For switches, we add `|| nil` so that `nil` will be passed instead of `false` if they aren't set.
# This way, we can distinguish between "not set" and "set to false".
Cask::Cmd::Audit.audit_casks(
*audit_casks,
download: nil,
# No need for `|| nil` for `--[no-]signing` because boolean switches are already `nil` if not passed
signing: args.signing?,
online: args.online? || nil,
strict: args.strict? || nil,
new_cask: args.new_cask? || nil,
token_conflicts: args.token_conflicts? || nil,
quarantine: nil,
any_named_args: !no_named_args,
language: nil,
only: args.only,
except: args.except,
)
require "cask/auditor"
audit_casks.to_h do |cask|
odebug "Auditing Cask #{cask}"
errors = Cask::Auditor.audit(
cask,
# For switches, we add `|| nil` so that `nil` will be passed
# instead of `false` if they aren't set.
# This way, we can distinguish between "not set" and "set to false".
audit_online: (args.online? || nil),
audit_strict: (args.strict? || nil),
# No need for `|| nil` for `--[no-]signing`
# because boolean switches are already `nil` if not passed
audit_signing: args.signing?,
audit_new_cask: (args.new_cask? || nil),
audit_token_conflicts: (args.token_conflicts? || nil),
quarantine: true,
any_named_args: !no_named_args,
only: args.only,
except: args.except,
)
[cask.sourcefile_path, { errors: errors, warnings: [] }]
end
end
failed_casks = cask_results.reject { |_, result| result[:errors].empty? }

161
Library/Homebrew/test/cask/cmd/audit_spec.rb
View File

@ -1,161 +0,0 @@
# typed: false
# frozen_string_literal: true
require "cask/auditor"
describe Cask::Cmd::Audit, :cask do
let(:cask) { Cask::Cask.new("cask") }
let(:cask_with_many_languages) { Cask::CaskLoader.load(cask_path("with-many-languages")) }
let(:result) { Set.new }
describe "selection of Casks to audit" do
it "audits all Casks if no tokens are given" do
allow(Cask::Cask).to receive(:to_a).and_return([cask, cask])
expect(Cask::Auditor).to receive(:audit).twice.and_return(result)
described_class.run
end
it "audits specified Casks if tokens are given" do
cask_token = "nice-app"
expect(Cask::CaskLoader).to receive(:load).with(cask_token, any_args).and_return(cask)
expect(Cask::Auditor).to receive(:audit)
.with(
cask,
audit_new_cask: false, quarantine: true, any_named_args: true,
only: [], except: []
)
.and_return(result)
described_class.run(cask_token)
end
end
it "does not pass anything if no flags are specified" do
allow(Cask::CaskLoader).to receive(:load).and_return(cask)
expect(Cask::Auditor).to receive(:audit)
.with(
cask,
audit_new_cask: false, quarantine: true, any_named_args: true,
only: [], except: []
)
.and_return(result)
described_class.run("casktoken")
end
it "passes `audit_download` if the `--download` flag is specified" do
allow(Cask::CaskLoader).to receive(:load).and_return(cask)
expect(Cask::Auditor).to receive(:audit)
.with(
cask,
audit_download: true, audit_new_cask: false, quarantine: true, any_named_args: true,
only: [], except: []
)
.and_return(result)
described_class.run("casktoken", "--download")
end
it "passes `audit_token_conflicts` if the `--token-conflicts` flag is specified" do
allow(Cask::CaskLoader).to receive(:load).and_return(cask)
expect(Cask::Auditor).to receive(:audit)
.with(
cask,
audit_token_conflicts: true, audit_new_cask: false, quarantine: true, any_named_args: true,
only: [], except: []
)
.and_return(result)
described_class.run("casktoken", "--token-conflicts")
end
it "passes `audit_strict` if the `--strict` flag is specified" do
allow(Cask::CaskLoader).to receive(:load).and_return(cask)
expect(Cask::Auditor).to receive(:audit)
.with(
cask,
audit_strict: true, audit_new_cask: false, quarantine: true, any_named_args: true,
only: [], except: []
)
.and_return(result)
described_class.run("casktoken", "--strict")
end
it "passes `audit_online` if the `--online` flag is specified" do
allow(Cask::CaskLoader).to receive(:load).and_return(cask)
expect(Cask::Auditor).to receive(:audit)
.with(
cask,
audit_online: true, audit_new_cask: false, quarantine: true, any_named_args: true,
only: [], except: []
)
.and_return(result)
described_class.run("casktoken", "--online")
end
it "passes `audit_new_cask` if the `--new-cask` flag is specified" do
allow(Cask::CaskLoader).to receive(:load).and_return(cask)
expect(Cask::Auditor).to receive(:audit)
.with(
cask,
audit_new_cask: true, quarantine: true, any_named_args: true,
only: [], except: []
)
.and_return(result)
described_class.run("casktoken", "--new-cask")
end
it "passes `language` if the `--language` flag is specified" do
allow(Cask::CaskLoader).to receive(:load).and_return(cask)
expect(Cask::Auditor).to receive(:audit)
.with(
cask,
audit_new_cask: false, quarantine: true, language: ["de-AT"], any_named_args: true,
only: [], except: []
)
.and_return(result)
described_class.run("casktoken", "--language=de-AT")
end
it "passes `quarantine` if the `--no-quarantine` flag is specified" do
allow(Cask::CaskLoader).to receive(:load).and_return(cask)
expect(Cask::Auditor).to receive(:audit)
.with(
cask,
audit_new_cask: false, quarantine: false, any_named_args: true,
only: [], except: []
)
.and_return(result)
described_class.run("casktoken", "--no-quarantine")
end
it "passes `quarantine` if the `--no-quarantine` flag is in HOMEBREW_CASK_OPTS" do
ENV["HOMEBREW_CASK_OPTS"] = "--no-quarantine"
allow(Cask::CaskLoader).to receive(:load).and_return(cask)
expect(Cask::Auditor).to receive(:audit)
.with(
cask,
audit_new_cask: false, quarantine: false, any_named_args: true,
only: [], except: []
)
.and_return(result)
described_class.run("casktoken")
end
it "audits a sample of language when cask contains more than 10 languages" do
allow(Cask::CaskLoader).to receive(:load).and_return(cask_with_many_languages)
expect do
described_class.run("with-many-languages")
end.to output(/==> auditing a sample of available languages/im).to_stdout
end
end

23
Library/Homebrew/test/cask/quarantine_spec.rb
View File

@ -1,7 +1,6 @@
# typed: false
# frozen_string_literal: true
require "cask/cmd/audit"
require "cask/cmd/install"
require "cask/cask_loader"
require "cask/download"
@ -36,17 +35,6 @@ describe Cask::Quarantine, :cask do
expect(cached_location).to be_quarantined
end
it "quarantines Cask audits" do
expect do
Cask::Cmd::Audit.run("local-transmission", "--download")
end.to not_raise_error.and not_to_output.to_stderr
local_transmission = Cask::CaskLoader.load(cask_path("local-transmission"))
cached_location = Cask::Download.new(local_transmission).fetch
expect(cached_location).to be_quarantined
end
it "quarantines Cask installs even if the fetch was not" do
download = Cask::Download.new(Cask::CaskLoader.load("local-transmission"), quarantine: false)
download.fetch
@ -151,17 +139,6 @@ describe Cask::Quarantine, :cask do
expect(cached_location).not_to be_quarantined
end
it "does not quarantine Cask audits" do
expect do
Cask::Cmd::Audit.run("local-transmission", "--download", "--no-quarantine")
end.to not_raise_error.and not_to_output.to_stderr
local_transmission = Cask::CaskLoader.load(cask_path("local-transmission"))
cached_location = Cask::Download.new(local_transmission).fetch
expect(cached_location).not_to be_quarantined
end
it "does not quarantine Cask installs even if the fetch was" do
download = Cask::Download.new(Cask::CaskLoader.load("local-transmission"), quarantine: true)
download.fetch