Files
brew/Library/Homebrew/test/cask/dsl_spec.rb
T
Mike McQuaid 204ea7e964 Make tests use public APIs and enable their cops
- Make every statically-poked method public and call it directly,
  keeping `public_send` only for dynamically-named public methods.
- Read and write state through public `attr_*` accessors instead of
  instance variable reflection.
- Enable `Homebrew/NoSendInTests` and
  `Homebrew/NoInstanceVariableAccessInTests` now the test suite is
  clean, so neither pattern creeps back in.
- Keep rare justified disables, e.g. `Module#remove_const` is
  private core Ruby and raw memoisation state has no accessor.
2026-07-27 08:11:46 +01:00

859 lines
24 KiB
Ruby

# typed: false
# frozen_string_literal: true
RSpec.describe Cask::DSL, :cask, :no_api do
let(:cask) { Cask::CaskLoader.load(token) }
let(:token) { "basic-cask" }
describe "stanzas" do
it "lets you set url, homepage and version" do
expect(cask.url.to_s).to eq("https://brew.sh/TestCask-1.2.3.dmg")
expect(cask.homepage).to eq("https://brew.sh/")
expect(cask.version.to_s).to eq("1.2.3")
end
it "exposes formula path helpers" do
cask = Cask::Cask.new("formula-path-helper") do
name formula_opt_bin("foo").to_s
end
expect(cask.name).to eq([(HOMEBREW_PREFIX/"opt/foo/bin").to_s])
end
it "exposes formula path helpers in flight blocks" do
expect(Cask::DSL::Postflight.new(Cask::Cask.new("formula-path-helper")).formula_opt_bin("foo"))
.to eq(HOMEBREW_PREFIX/"opt/foo/bin")
end
end
describe "when a Cask includes an unknown method" do
let(:attempt_unknown_method) do
Cask::Cask.new("unexpected-method-cask") do
future_feature :not_yet_on_your_machine
end
end
it "raises a CaskInvalidError" do
expect { attempt_unknown_method }.to raise_error(
Cask::CaskInvalidError,
/undefined method 'future_feature' for Cask 'unexpected-method-cask'/,
)
end
end
describe "header line" do
context "when invalid" do
let(:token) { "invalid-header-format" }
it "raises an error" do
expect { cask }.to raise_error(Cask::CaskUnreadableError)
end
end
context "when token does not match the file name" do
let(:token) { "invalid-header-token-mismatch" }
it "raises an error" do
expect do
cask
end.to raise_error(Cask::CaskTokenMismatchError, /header line does not match the file name/)
end
end
context "when it contains no DSL version" do
let(:token) { "no-dsl-version" }
it "does not require a DSL version in the header" do
expect(cask.token).to eq("no-dsl-version")
expect(cask.url.to_s).to eq("https://brew.sh/TestCask-1.2.3.dmg")
expect(cask.homepage).to eq("https://brew.sh/")
expect(cask.version.to_s).to eq("1.2.3")
end
end
end
describe "name stanza" do
it "lets you set the full name via a name stanza" do
cask = Cask::Cask.new("name-cask") do
name "Proper Name"
end
expect(cask.name).to eq([
"Proper Name",
])
end
it "Accepts an array value to the name stanza" do
cask = Cask::Cask.new("array-name-cask") do
name ["Proper Name", "Alternate Name"]
end
expect(cask.name).to eq([
"Proper Name",
"Alternate Name",
])
end
it "Accepts multiple name stanzas" do
cask = Cask::Cask.new("multi-name-cask") do
name "Proper Name"
name "Alternate Name"
end
expect(cask.name).to eq([
"Proper Name",
"Alternate Name",
])
end
end
describe "desc stanza" do
it "lets you set the description via a desc stanza" do
cask = Cask::Cask.new("desc-cask") do
desc "The package's description"
end
expect(cask.desc).to eq("The package's description")
end
end
describe "sha256 stanza" do
it "lets you set checksum via sha256" do
cask = Cask::Cask.new("checksum-cask") do
sha256 "imasha2"
end
expect(cask.sha256).to eq("imasha2")
end
context "with a different arm and intel checksum" do
let(:cask) do
Cask::Cask.new("checksum-cask") do
sha256 arm: "imasha2arm", intel: "imasha2intel"
end
end
context "when running on arm" do
before do
allow(Hardware::CPU).to receive(:type).and_return(:arm)
end
it "stores only the arm checksum" do
expect(cask.sha256).to eq("imasha2arm")
end
end
context "when running on intel" do
before do
allow(Hardware::CPU).to receive(:type).and_return(:intel)
end
it "stores only the intel checksum" do
expect(cask.sha256).to eq("imasha2intel")
end
end
end
context "with checksums for only one OS" do
it "has no checksum on macOS when only Linux checksums are set" do
Homebrew::SimulateSystem.with(os: :macos, arch: :arm) do
cask = Cask::Cask.new("checksum-cask") do
sha256 x86_64_linux: "imasha2intellinux", arm64_linux: "imasha2armlinux"
end
expect(cask.sha256).to be_nil
end
end
it "stores the matching checksum on Linux" do
Homebrew::SimulateSystem.with(os: :linux, arch: :intel) do
cask = Cask::Cask.new("checksum-cask") do
sha256 x86_64_linux: "imasha2intellinux", arm64_linux: "imasha2armlinux"
end
expect(cask.sha256).to eq("imasha2intellinux")
end
end
it "has no checksum on Linux when only macOS checksums are set" do
Homebrew::SimulateSystem.with(os: :linux, arch: :arm) do
cask = Cask::Cask.new("checksum-cask") do
sha256 arm: "imasha2arm", intel: "imasha2intel"
end
expect(cask.sha256).to be_nil
end
end
it "raises when the running-architecture macOS checksum is missing" do
Homebrew::SimulateSystem.with(os: :macos, arch: :intel) do
expect do
Cask::Cask.new("checksum-cask") do
sha256 arm: "imasha2arm", arm64_linux: "imasha2armlinux"
end
end.to raise_error(Cask::CaskInvalidError, /invalid 'sha256' value/)
end
end
it "raises when the running-architecture Linux checksum is missing" do
Homebrew::SimulateSystem.with(os: :linux, arch: :intel) do
expect do
Cask::Cask.new("checksum-cask") do
sha256 arm64_linux: "imasha2armlinux", intel: "imasha2intel"
end
end.to raise_error(Cask::CaskInvalidError, /invalid 'sha256' value/)
end
end
end
end
describe "no_autobump! stanze" do
it "returns true if no_autobump! is not set" do
expect(cask.autobump?).to be(true)
end
context "when no_autobump! is set" do
let(:cask) do
Cask::Cask.new("checksum-cask") do
no_autobump! because: "some reason"
end
end
it "returns false" do
expect(cask.autobump?).to be(false)
expect(cask.no_autobump_message).to eq("some reason")
end
end
context "when used in an unofficial tap" do
it "raises an error" do
expect do
Cask::Cask.new("test-cask", tap: Tap.fetch("someone", "repo")) do
no_autobump! because: "some reason"
end
end.to raise_error(Cask::CaskInvalidError, /official Homebrew taps/)
end
it "does not raise for internal no_autobump! usage from common DSL stanzas" do
expect do
Cask::Cask.new("test-cask", tap: Tap.fetch("someone", "repo")) do
version :latest
url "https://brew.sh/TestCask.dmg"
livecheck do
url "https://brew.sh/TestCask.plist"
strategy :extract_plist
end
end
end.not_to raise_error
end
end
end
describe "language stanza" do
context "when language is set explicitly" do
subject(:cask) do
Cask::Cask.new("cask-with-apps") do
language "zh" do
sha256 "abc123"
"zh-CN"
end
language "en", default: true do
sha256 "xyz789"
"en-US"
end
url "https://example.org/#{language}.zip"
end
end
matcher :be_the_chinese_version do
match do |cask|
expect(cask.language).to eq("zh-CN")
expect(cask.sha256).to eq("abc123")
expect(cask.url.to_s).to eq("https://example.org/zh-CN.zip")
end
end
matcher :be_the_english_version do
match do |cask|
expect(cask.language).to eq("en-US")
expect(cask.sha256).to eq("xyz789")
expect(cask.url.to_s).to eq("https://example.org/en-US.zip")
end
end
let(:languages) { [] }
before do
config = cask.config
config.languages = languages
cask.config = config
end
describe "to 'zh'" do
let(:languages) { ["zh"] }
it { is_expected.to be_the_chinese_version }
end
describe "to 'zh-XX'" do
let(:languages) { ["zh-XX"] }
it { is_expected.to be_the_chinese_version }
end
describe "to 'en'" do
let(:languages) { ["en"] }
it { is_expected.to be_the_english_version }
end
describe "to 'xx-XX'" do
let(:languages) { ["xx-XX"] }
it { is_expected.to be_the_english_version }
end
describe "to 'xx-XX,zh,en'" do
let(:languages) { ["xx-XX", "zh", "en"] }
it { is_expected.to be_the_chinese_version }
end
describe "to 'xx-XX,en-US,zh'" do
let(:languages) { ["xx-XX", "en-US", "zh"] }
it { is_expected.to be_the_english_version }
end
end
it "returns an empty array if no languages are specified" do
cask = lambda do
Cask::Cask.new("cask-with-apps") do
url "https://example.org/file.zip"
end
end
expect(cask.call.languages).to be_empty
end
it "returns an array of available languages" do
cask = lambda do
Cask::Cask.new("cask-with-apps") do
language "zh" do
sha256 "abc123"
"zh-CN"
end
language "en-US", default: true do
sha256 "xyz789"
"en-US"
end
url "https://example.org/file.zip"
end
end
expect(cask.call.languages).to eq(["zh", "en-US"])
end
end
describe "app stanza" do
it "allows you to specify app stanzas" do
cask = Cask::Cask.new("cask-with-apps") do
app "Foo.app"
app "Bar.app"
end
expect(cask.artifacts.map(&:to_s)).to eq(["Foo.app (App)", "Bar.app (App)"])
end
it "allow app stanzas to be empty" do
cask = Cask::Cask.new("cask-with-no-apps")
expect(cask.artifacts).to be_empty
end
end
describe "caveats stanza" do
it "allows caveats to be specified via a method define" do
cask = Cask::Cask.new("plain-cask")
expect(cask.caveats).to be_empty
cask = Cask::Cask.new("cask-with-caveats") do
def caveats
<<~EOS
When you install this Cask, you probably want to know this.
EOS
end
end
expect(cask.caveats).to eq("When you install this Cask, you probably want to know this.\n")
end
end
describe "pkg stanza" do
it "allows installable pkgs to be specified" do
cask = Cask::Cask.new("cask-with-pkgs") do
pkg "Foo.pkg"
pkg "Bar.pkg"
end
expect(cask.artifacts.map(&:to_s)).to eq(["Foo.pkg (Pkg)", "Bar.pkg (Pkg)"])
end
end
describe "url stanza" do
let(:token) { "invalid-two-url" }
it "prevents defining multiple urls" do
expect { cask }.to raise_error(Cask::CaskInvalidError, /'url' stanza may only appear once/)
end
it "allows the `verified` parameter as a no-op" do
cask = Cask::Cask.new("cask-with-verified-url") do
url "https://brew.sh/test.zip", verified: "brew.sh"
end
expect(cask.url.specs).not_to have_key(:verified)
end
end
describe "homepage stanza" do
let(:token) { "invalid-two-homepage" }
it "prevents defining multiple homepages" do
expect { cask }.to raise_error(Cask::CaskInvalidError, /'homepage' stanza may only appear once/)
end
it "records when a human browsed the homepage" do
cask = Cask::Cask.new("cask-with-browsed-homepage") do
homepage "https://brew.sh/", browsed: "2026-07-26"
end
expect(cask.homepage_browsed).to eq(Date.new(2026, 7, 26))
end
it "requires a homepage URL when a human browser check is specified" do
expect do
Cask::Cask.new("cask-without-homepage") do
homepage browsed: "2026-07-26"
end
end.to raise_error(Cask::CaskInvalidError, /`browsed` requires a homepage URL/)
end
end
describe "version stanza" do
let(:token) { "invalid-two-version" }
it "prevents defining multiple versions" do
expect { cask }.to raise_error(Cask::CaskInvalidError, /'version' stanza may only appear once/)
end
end
describe "arch stanza" do
let(:token) { "invalid-two-arch" }
it "prevents defining multiple arches" do
expect { cask }.to raise_error(Cask::CaskInvalidError, /'arch' stanza may only appear once/)
end
context "when no intel value is specified" do
let(:token) { "arch-arm-only" }
context "when running on arm" do
before do
allow(Hardware::CPU).to receive(:type).and_return(:arm)
end
it "returns the value" do
expect(cask.url.to_s).to eq "file://#{TEST_FIXTURE_DIR}/cask/caffeine-arm.zip"
end
end
context "when running on intel" do
before do
allow(Hardware::CPU).to receive(:type).and_return(:intel)
end
it "defaults to `nil` for the other when no arrays are passed" do
expect(cask.url.to_s).to eq "file://#{TEST_FIXTURE_DIR}/cask/caffeine.zip"
end
end
end
end
describe "depends_on stanza" do
let(:token) { "invalid-depends-on-key" }
it "refuses to load with an invalid depends_on key" do
expect { cask }.to raise_error(Cask::CaskInvalidError)
end
end
describe "depends_on formula" do
context "with one Formula" do
let(:token) { "with-depends-on-formula" }
it "allows depends_on formula to be specified" do
expect(cask.depends_on.formula).not_to be_nil
end
end
context "with multiple Formulae" do
let(:token) { "with-depends-on-formula-multiple" }
it "allows multiple depends_on formula to be specified" do
expect(cask.depends_on.formula).not_to be_nil
end
end
end
describe "depends_on cask" do
context "with a single cask" do
let(:token) { "with-depends-on-cask" }
it "is allowed" do
expect(cask.depends_on.cask).not_to be_nil
end
end
context "when specifying multiple" do
let(:token) { "with-depends-on-cask-multiple" }
it "is allowed" do
expect(cask.depends_on.cask).not_to be_nil
end
end
end
describe "depends_on macos" do
context "when bare :macos is used without a version" do
let(:token) { "with-depends-on-macos-bare" }
it "creates a MacOSRequirement without a version" do
macos_requirement = cask.depends_on.macos
expect(macos_requirement).to be_a(MacOSRequirement)
expect(macos_requirement.version_specified?).to be false
expect(macos_requirement.to_h).to eq({})
end
end
context "when a symbol is used" do
let(:token) { "with-depends-on-macos-symbol" }
it "creates a minimum MacOSRequirement" do
expect(cask.depends_on.macos).to eq(MacOSRequirement.new([MacOS.version.to_sym], comparator: ">="))
end
end
context "when the depends_on macos value is invalid" do
let(:token) { "invalid-depends-on-macos-bad-release" }
it "refuses to load" do
expect { cask }.to raise_error(Cask::CaskInvalidError)
end
end
context "when there are conflicting depends_on macos forms" do
let(:token) { "invalid-depends-on-macos-conflicting-forms" }
it "refuses to load" do
expect { cask }.to raise_error(Cask::CaskInvalidError)
end
end
context "when bare macOS and a block-scoped macOS version are used" do
it "allows the active block to provide the macOS version" do
Homebrew::SimulateSystem.with(os: :tahoe, arch: :intel) do
cask = Cask::Cask.new("with-block-scoped-macos-version") do
depends_on :macos
on_intel do
depends_on macos: :ventura
end
end
expect(cask.depends_on.macos).to eq(MacOSRequirement.new([:ventura], comparator: ">="))
expect(cask.depends_on.requires_macos?).to be true
end
end
end
end
describe "depends_on linux" do
context "when bare :linux is used" do
let(:token) { "with-depends-on-linux-bare" }
it "creates a LinuxRequirement" do
expect(cask.depends_on.linux).to be_a(LinuxRequirement)
end
end
context "when macOS and Linux are both required" do
let(:token) { "invalid-depends-on-macos-and-linux" }
it "refuses to load" do
expect { cask }.to raise_error(Cask::CaskInvalidError)
end
end
end
describe "depends_on maximum_macos" do
context "when a symbol is used" do
let(:token) { "with-depends-on-maximum-macos" }
it "creates a maximum MacOSRequirement" do
expect(cask.depends_on.maximum_macos).to eq(MacOSRequirement.new([:tahoe], comparator: "<="))
end
end
context "when a deprecated string comparator is used" do
let(:token) { "invalid-depends-on-maximum-macos-comparator" }
it "refuses to load" do
expect { cask }.to raise_error(MethodDeprecatedError)
end
end
context "when multiple values are used" do
let(:token) { "invalid-depends-on-maximum-macos-array" }
it "refuses to load" do
expect { cask }.to raise_error(Cask::CaskInvalidError)
end
end
end
describe "depends_on arch" do
context "when valid" do
let(:token) { "with-depends-on-arch" }
it "is allowed to be specified" do
expect(cask.depends_on.arch).not_to be_nil
end
end
context "with invalid depends_on arch value" do
let(:token) { "invalid-depends-on-arch-value" }
it "refuses to load" do
expect { cask }.to raise_error(Cask::CaskInvalidError)
end
end
end
describe "conflicts_with cask" do
let(:local_caffeine) do
Cask::CaskLoader.load(cask_path("local-caffeine"))
end
let(:with_conflicts_with) do
Cask::CaskLoader.load(cask_path("with-conflicts-with"))
end
it "raises an error when a conflicting cask is already installed" do
InstallHelper.stub_cask_installation(local_caffeine)
expect(local_caffeine).to be_installed
expect do
Cask::Installer.new(with_conflicts_with).install
end.to raise_error(Cask::CaskConflictError, "Cask 'with-conflicts-with' conflicts with 'local-caffeine'.")
expect(with_conflicts_with).not_to be_installed
end
it "ignores an uninstalled conflicting cask from an untrusted tap", :trust_store do
tap = Tap.fetch("thirdparty", "foo")
cask_file = tap.cask_dir/"conflicting-cask.rb"
cask_file.dirname.mkpath
cask_file.write <<~RUBY
cask "conflicting-cask" do
version "1.0"
end
RUBY
cask = Cask::Cask.new("requested-cask", tap:) do
version "1.0"
conflicts_with cask: "#{tap}/conflicting-cask"
end
Homebrew::Trust.trust!(:cask, "#{tap}/requested-cask")
with_env(HOMEBREW_REQUIRE_TAP_TRUST: "1") do
expect { Cask::Installer.new(cask).check_conflicts }.not_to raise_error
end
ensure
FileUtils.rm_rf HOMEBREW_TAP_DIRECTORY/"thirdparty"
end
it "raises for an installed conflicting cask from an untrusted tap without loading it", :trust_store do
tap = Tap.fetch("thirdparty", "foo")
cask_file = tap.cask_dir/"conflicting-cask.rb"
cask_file.dirname.mkpath
cask_file.write <<~RUBY
raise "untrusted tap cask evaluated"
RUBY
installed_cask_dir = Cask::Caskroom.path/"conflicting-cask/.metadata/1.0/20250101000000.000/Casks"
installed_cask_dir.mkpath
(installed_cask_dir/"conflicting-cask.rb").write <<~RUBY
raise "untrusted installed cask evaluated"
RUBY
cask = Cask::Cask.new("requested-cask", tap:) do
version "1.0"
conflicts_with cask: "#{tap}/conflicting-cask"
end
Homebrew::Trust.trust!(:cask, "#{tap}/requested-cask")
with_env(HOMEBREW_REQUIRE_TAP_TRUST: "1") do
expect { Cask::Installer.new(cask).check_conflicts }
.to raise_error(Cask::CaskConflictError, "Cask 'requested-cask' conflicts with 'conflicting-cask'.")
end
ensure
FileUtils.rm_rf HOMEBREW_TAP_DIRECTORY/"thirdparty"
end
end
describe "conflicts_with stanza" do
context "when valid" do
let(:token) { "with-conflicts-with" }
it "allows conflicts_with stanza to be specified" do
expect(cask.conflicts_with[:formula]).to be_empty
end
end
context "with invalid conflicts_with key" do
let(:token) { "invalid-conflicts-with-key" }
it "refuses to load invalid conflicts_with key" do
expect { cask }.to raise_error(Cask::CaskInvalidError)
end
end
end
describe "installer stanza" do
context "when script" do
let(:token) { "with-installer-script" }
it "allows installer script to be specified" do
expect(cask.artifacts.to_a.first.path).to eq(Pathname("/usr/bin/true"))
expect(cask.artifacts.to_a.first.args[:args]).to eq(["--flag"])
expect(cask.artifacts.to_a.second.path).to eq(Pathname("/usr/bin/false"))
expect(cask.artifacts.to_a.second.args[:args]).to eq(["--flag"])
end
end
context "when manual" do
let(:token) { "with-installer-manual" }
it "allows installer manual to be specified" do
installer = cask.artifacts.first
expect(installer.manual_install).to be true
expect(installer.path).to eq(Pathname("Caffeine.app"))
end
end
end
describe "stage_only stanza" do
context "when there is no other activatable artifact" do
let(:token) { "stage-only" }
it "allows stage_only stanza to be specified" do
expect(cask.artifacts).to contain_exactly a_kind_of Cask::Artifact::StageOnly
end
end
context "when there is are activatable artifacts" do
let(:token) { "invalid-stage-only-conflict" }
it "prevents specifying stage_only" do
expect { cask }.to raise_error(Cask::CaskInvalidError, /'stage_only' must be the only activatable artifact/)
end
end
end
describe "auto_updates stanza" do
let(:token) { "auto-updates" }
it "allows auto_updates stanza to be specified" do
expect(cask.auto_updates).to be true
end
end
describe "#appdir" do
context "with interpolation of the appdir in stanzas" do
let(:token) { "appdir-interpolation" }
it "is allowed" do
expect(cask.artifacts.first.source).to eq(cask.config.appdir/"some/path")
end
end
it "does not include a trailing slash" do
config = Cask::Config.new(explicit: {
appdir: "/Applications/",
})
cask = Cask::Cask.new("appdir-trailing-slash", config:) do
binary "#{appdir}/some/path"
end
expect(cask.artifacts.first.source).to eq(Pathname("/Applications/some/path"))
end
end
describe "#artifacts" do
it "sorts artifacts according to the preferable installation order" do
cask = Cask::Cask.new("appdir-trailing-slash") do
postflight do
next
end
preflight do
next
end
binary "binary"
app "App.app"
end
expect(cask.artifacts.map { |artifact| artifact.class.dsl_key }).to eq [
:preflight,
:app,
:binary,
:postflight,
]
end
end
describe "rename stanza" do
it "allows setting single rename operation" do
cask = Cask::Cask.new("rename-cask") do
rename "Source*.pkg", "Target.pkg"
end
expect(cask.rename.length).to eq(1)
expect(cask.rename.first.from).to eq("Source*.pkg")
expect(cask.rename.first.to).to eq("Target.pkg")
end
it "allows setting multiple rename operations" do
cask = Cask::Cask.new("multi-rename-cask") do
rename "App*.pkg", "App.pkg"
rename "Doc*.dmg", "Doc.dmg"
end
expect(cask.rename.length).to eq(2)
expect(cask.rename.first.from).to eq("App*.pkg")
expect(cask.rename.first.to).to eq("App.pkg")
expect(cask.rename.last.from).to eq("Doc*.dmg")
expect(cask.rename.last.to).to eq("Doc.dmg")
end
end
end