Merge pull request #21941 from Homebrew/cliff-perfume

Fix `supports_linux?` for platform-agnostic casks

Author: MikeMcQuaid

Library/Homebrew/cask/cask.rb

@@ -123,6 +123,7 @@ def config=(config)
 
     def refresh
       @dsl = DSL.new(self)
+      @contains_os_specific_artifacts = nil
       return unless @block
 
       @dsl.instance_eval(&@block)
@@ -185,35 +186,41 @@ def supports_linux?
 
       return false if contains_os_specific_artifacts?
 
-      os_value.present?
+      # Casks with OS-specific blocks rely on the os stanza for Linux support
+      return os_value.present? if @dsl.on_os_blocks_exist?
+
+      # Platform-agnostic casks: reject macOS-only artifacts and manual installers
+      artifacts.none? do |a|
+        Artifact::MACOS_ONLY_ARTIFACTS.include?(a.class) ||
+          (a.is_a?(Artifact::Installer) && a.manual_install)
+      end
     end
 
     sig { returns(T::Boolean) }
     def contains_os_specific_artifacts?
       return false unless @dsl.on_system_blocks_exist?
 
+      return @contains_os_specific_artifacts unless @contains_os_specific_artifacts.nil?
+
       any_loaded = T.let(false, T::Boolean)
-      @contains_os_specific_artifacts ||= begin
-        OnSystem::VALID_OS_ARCH_TAGS.each do |bottle_tag|
-          Homebrew::SimulateSystem.with_tag(bottle_tag) do
-            refresh
-
-            any_loaded = true if artifacts.any? do |artifact|
-              (bottle_tag.linux? && ::Cask::Artifact::MACOS_ONLY_ARTIFACTS.include?(artifact.class)) ||
-              (bottle_tag.macos? && ::Cask::Artifact::LINUX_ONLY_ARTIFACTS.include?(artifact.class))
-            end
-          end
-        rescue CaskInvalidError
-          # Invalid for this OS/arch tag; treat as having no OS-specific artifacts.
-          next
-        ensure
+      OnSystem::VALID_OS_ARCH_TAGS.each do |bottle_tag|
+        Homebrew::SimulateSystem.with_tag(bottle_tag) do
           refresh
-        end
 
-        any_loaded
+          any_loaded = true if artifacts.any? do |artifact|
+            (bottle_tag.linux? && ::Cask::Artifact::MACOS_ONLY_ARTIFACTS.include?(artifact.class)) ||
+            (bottle_tag.macos? && ::Cask::Artifact::LINUX_ONLY_ARTIFACTS.include?(artifact.class))
+          end
+        end
+      rescue CaskInvalidError
+        # Invalid for this OS/arch tag; treat as having no OS-specific artifacts.
+        next
+      ensure
+        refresh
       end
 
-      @contains_os_specific_artifacts
+      @contains_os_specific_artifacts = T.let(any_loaded, T.nilable(T::Boolean))
+      any_loaded
     end
 
     # The caskfile is needed during installation when there are

Library/Homebrew/cask/dsl.rb

@@ -112,6 +112,7 @@ class DSL
       :autobump?,
       :no_autobump_message,
       :on_system_blocks_exist?,
+      :on_os_blocks_exist?,
       :on_system_block_min_os,
       :depends_on_set_in_block?,
       *ORDINARY_ARTIFACT_CLASSES.map(&:dsl_key),
@@ -168,6 +169,7 @@ def initialize(cask)
       @name = T.let([], T::Array[String])
       @no_autobump_defined = T.let(false, T::Boolean)
       @on_system_blocks_exist = T.let(false, T::Boolean)
+      @on_os_blocks_exist = T.let(false, T::Boolean)
       @on_system_block_min_os = T.let(nil, T.nilable(MacOSVersion))
       @os = T.let(nil, T.nilable(String))
       @os_set_in_block = T.let(false, T::Boolean)
@@ -197,6 +199,9 @@ def livecheck_defined? = @livecheck_defined
     sig { returns(T::Boolean) }
     def on_system_blocks_exist? = @on_system_blocks_exist
 
+    sig { returns(T::Boolean) }
+    def on_os_blocks_exist? = @on_os_blocks_exist
+
     # Specifies the cask's name.
     #
     # NOTE: Multiple names can be specified.
@@ -487,6 +492,7 @@ def os(macos: nil, linux: nil)
 
       set_unique_stanza(:os, should_return) do
         @on_system_blocks_exist = true
+        @on_os_blocks_exist = true
 
         on_system_conditional(macos:, linux:)
       end

Library/Homebrew/on_system.rb

@@ -87,6 +87,7 @@ def self.setup_base_os_methods(base)
     BASE_OS_OPTIONS.each do |base_os|
       base.define_method(:"on_#{base_os}") do |&block|
         @on_system_blocks_exist = T.let(true, T.nilable(TrueClass))
+        @on_os_blocks_exist = T.let(true, T.nilable(TrueClass))
 
         return unless OnSystem.os_condition_met? OnSystem.condition_from_method_name(T.must(__method__))
 
@@ -100,6 +101,7 @@ def self.setup_base_os_methods(base)
 
     base.define_method(:on_system) do |linux, macos:, &block|
       @on_system_blocks_exist = T.let(true, T.nilable(TrueClass))
+      @on_os_blocks_exist = T.let(true, T.nilable(TrueClass))
 
       raise ArgumentError, "The first argument to `on_system` must be `:linux`" if linux != :linux
 
@@ -133,6 +135,7 @@ def self.setup_macos_methods(base)
     MacOSVersion::SYMBOLS.each_key do |os_name|
       base.define_method(:"on_#{os_name}") do |or_condition = nil, &block|
         @on_system_blocks_exist = T.let(true, T.nilable(TrueClass))
+        @on_os_blocks_exist = T.let(true, T.nilable(TrueClass))
 
         os_condition = OnSystem.condition_from_method_name T.must(__method__)
         return unless OnSystem.os_condition_met? os_condition, or_condition

Library/Homebrew/sorbet/rbi/dsl/cask/cask.rbi

@@ -84,6 +84,17 @@
       end
     end
 
+    context "with a platform-agnostic cask on Linux", :needs_linux do
+      let(:entry) { Homebrew::Bundle::Dsl::Entry.new(:cask, "testball") }
+
+      it "does not skip" do
+        allow(Cask::CaskLoader).to receive(:load).with("testball").and_return(
+          instance_double(Cask::Cask, supports_linux?: true),
+        )
+        expect(skipper.skip?(entry)).to be false
+      end
+    end
+
     context "with a listed formula in a failed tap" do
       let(:entry) { Homebrew::Bundle::Dsl::Entry.new(:brew, "org/repo/formula") }
 

Library/Homebrew/test/bundle/skipper_spec.rb

@@ -393,8 +393,24 @@
   end
 
   describe "#supports_linux?" do
-    it "returns false when Linux support is not explicitly declared" do
-      expect(Cask::CaskLoader.load("with-non-executable-binary").supports_linux?).to be false
+    it "reflects whether the cask has only platform-agnostic artifacts" do
+      expect(Cask::CaskLoader.load("with-non-executable-binary").supports_linux?).to be true
+      expect(Cask::CaskLoader.load("basic-cask").supports_linux?).to be false
+      expect(Cask::CaskLoader.load("with-installer-manual").supports_linux?).to be false
+
+      arch_only_cask = described_class.new("arch-only-binary") do
+        version "1.0"
+        sha256 arm: "aaaa", intel: "bbbb"
+
+        url "https://brew.sh/test-#{version}.tar.gz"
+        name "Arch Only Binary"
+        desc "Cask with arch-only sha256 and a binary artifact"
+        homepage "https://brew.sh"
+
+        binary "some-tool"
+      end
+
+      expect(arch_only_cask.supports_linux?).to be true
     end
   end
 

Library/Homebrew/test/cask/cask_spec.rb

@@ -302,7 +302,7 @@ def mock_cask_installed(cask_name)
       https://brew.sh/with-binary
       Not installed
       From: https://github.com/Homebrew/homebrew-cask/blob/HEAD/Casks/w/with-non-executable-binary.rb
-      #{requirements_section(installed("macOS >= 10.15"))}
+      #{requirements_section(installed("macOS >= 10.15 (or Linux)"))}
       ==> Artifacts
       naked_non_executable (Binary)
     EOS

Library/Homebrew/test/cask/info_spec.rb

@@ -287,6 +287,7 @@
       example.example.set_exception(e)
     ensure
       ENV.replace(@__env)
+      Homebrew::SimulateSystem.clear
       Context.current = Context::ContextStruct.new
 
       $stdout.reopen(@__stdout)