Merge pull request #21380 from Homebrew/feat/cask/arch_ci

Make Cask CI generate correctly for partial arch dependencies

Author: SMillerDev

Library/Homebrew/cask/artifact.rb

@@ -52,5 +52,7 @@ module Artifact
       ::Cask::Artifact::VstPlugin,
       ::Cask::Artifact::Vst3Plugin,
     ].freeze
+
+    LINUX_ONLY_ARTIFACTS = T.let([].freeze, T::Array[T.untyped])
   end
 end

Library/Homebrew/cask/cask.rb

@@ -168,11 +168,41 @@ def supports_macos? = true
     def supports_linux?
       return true if font?
 
-      return false if artifacts.any? do |artifact|
-        ::Cask::Artifact::MACOS_ONLY_ARTIFACTS.include?(artifact.class)
+      # Cache the os value before contains_os_specific_artifacts? refreshes the cask
+      # (the refresh clears @dsl.os in generic/non-OS-specific contexts)
+      os_value = @dsl.os
+
+      return false if contains_os_specific_artifacts?
+
+      os_value.present?
+    end
+
+    sig { returns(T::Boolean) }
+    def contains_os_specific_artifacts?
+      return false unless @dsl.on_system_blocks_exist?
+
+      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
+            refresh
+        end
+
+        any_loaded
       end
 
-      @dsl.os.present?
+      @contains_os_specific_artifacts
     end
 
     # The caskfile is needed during installation when there are

Library/Homebrew/dev-cmd/generate-cask-ci-matrix.rb

@@ -139,21 +139,43 @@ def filter_runners(cask)
           RUNNERS.dup
         end
 
-        filtered_runners = filtered_runners.merge(LINUX_RUNNERS) if cask.supports_linux?
-
-        archs = architectures(cask:)
+        macos_archs = architectures(cask:, os: :macos)
         filtered_runners.select! do |runner, _|
-          archs.include?(runner.fetch(:arch))
+          macos_archs.include?(runner.fetch(:arch))
         end
 
-        filtered_runners
+        return filtered_runners unless cask.supports_linux?
+
+        linux_archs = architectures(cask:, os: :linux)
+        linux_runners = LINUX_RUNNERS.select do |runner, _|
+          linux_archs.include?(runner.fetch(:arch))
+        end
+
+        filtered_runners.merge(linux_runners)
       end
 
-      sig { params(cask: Cask::Cask).returns(T::Array[Symbol]) }
-      def architectures(cask:)
-        return RUNNERS.keys.map { |r| r.fetch(:arch).to_sym }.uniq.sort if cask.depends_on.arch.blank?
+      private
+
+      sig { params(cask: Cask::Cask, os: Symbol).returns(T::Array[Symbol]) }
+      def architectures(cask:, os:)
+        architectures = T.let([], T::Array[Symbol])
+        [:arm, :intel].each do |arch|
+          tag = Utils::Bottles::Tag.new(system: os, arch: arch)
+          Homebrew::SimulateSystem.with_tag(tag) do
+            cask.refresh
+
+            if cask.depends_on.arch.blank?
+              architectures = RUNNERS.keys.map { |r| r.fetch(:arch).to_sym }.uniq.sort
+              next
+            end
+
+            architectures = cask.depends_on.arch.map { |arch| arch[:type] }
+          end
+        rescue ::Cask::CaskInvalidError
+          # Can't read cask for this system-arch combination.
+        end
 
-        cask.depends_on.arch.map { |arch| arch[:type] }.uniq.sort
+        architectures
       end
 
       sig {
@@ -251,11 +273,11 @@ def generate_matrix(tap, labels: [], cask_names: [], skip_install: false, new_ca
           cask = Cask::CaskLoader.load(path.expand_path)
 
           runners, multi_os = runners(cask:)
-          runners.product(architectures(cask:)).filter_map do |runner, arch|
+          runners.product(architectures(cask:, os: :macos)).filter_map do |runner, arch|
             native_runner_arch = arch == runner.fetch(:arch)
-            # we don't need to run simulated archs on Linux
+            # we don't need to run simulated archs on Linux or macOS Sequoia
+            # because they exist as real GitHub hosted runner
             next if runner.fetch(:symbol) == :linux && !native_runner_arch
-            # we don't need to run simulated archs on macOS
             next if runner.fetch(:symbol) == :sequoia && !native_runner_arch
 
             # If it's just a single OS test then we can just use the two real arch runners.

Library/Homebrew/test/cask/cask_spec.rb

@@ -299,6 +299,68 @@
     end
   end
 
+  describe "#contains_os_specific_artifacts?" do
+    it "returns false when there are no OSes defined" do
+      cask = described_class.new("test-no-os") do
+        version "0.0.1,2"
+
+        url "https://brew.sh/test-0.0.1.dmg"
+        name "Test"
+        desc "Test cask"
+        homepage "https://brew.sh"
+      end
+
+      expect(cask.contains_os_specific_artifacts?).to be false
+    end
+
+    it "returns false when there are no artifacts" do
+      cask = described_class.new("test-os-no-artifacts") do
+        os macos: "mac", linux: "Linux"
+        version "0.0.1,2"
+
+        url "https://brew.sh/test-0.0.1.dmg"
+        name "Test"
+        desc "Test cask"
+        homepage "https://brew.sh"
+      end
+
+      expect(cask.contains_os_specific_artifacts?).to be false
+    end
+
+    it "returns false when there are scoped app" do
+      cask = described_class.new("test-macos-app-artifact") do
+        version "0.0.1,2"
+
+        url "https://brew.sh/test-0.0.1.dmg"
+        name "Test"
+        desc "Test cask"
+        homepage "https://brew.sh"
+
+        on_macos do
+          app "Test.app"
+        end
+      end
+
+      expect(cask.contains_os_specific_artifacts?).to be false
+    end
+
+    it "returns true when there are unscoped app artifacts" do
+      cask = described_class.new("test-os-app-artifact") do
+        os macos: "mac", linux: "Linux"
+        version "0.0.1,2"
+
+        url "https://brew.sh/test-0.0.1.dmg"
+        name "Test"
+        desc "Test cask"
+        homepage "https://brew.sh"
+
+        app "Test.app"
+      end
+
+      expect(cask.contains_os_specific_artifacts?).to be true
+    end
+  end
+
   describe "#to_h" do
     let(:expected_json) { (TEST_FIXTURE_DIR/"cask/everything.json").read.strip }