fix: better matched runtime build detection (#43)

* fix: apple build version

* fix: better matched runtime build detection

Author: nekrich

lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/models.rb

@@ -9,6 +9,7 @@
 require_relative 'models/required_runtime'
 require_relative 'models/apple_build_version'
 require_relative 'models/device_naming_style'
+require_relative 'models/simctl/matched_runtime'
 require 'fastlane'
 
 module Fastlane

lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/models/apple_build_version.rb

@@ -62,15 +62,15 @@ def almost_equal?(other)
       end
 
       def major
-        @build_version.match(/^([0-9]+)([A-Z][0-9]{1,3})([0-9]+)/)[1]
+        @build_version.match(/^([0-9]+)([A-Z])([0-9]+)/)[1]
       end
 
       def minor
-        @build_version.match(/^([0-9]+)([A-Z][0-9]{1,3})([0-9]+)/)[2]
+        @build_version.match(/^([0-9]+)([A-Z])([0-9]+)/)[2]
       end
 
       def patch
-        @build_version.match(/^([0-9]+)([A-Z][0-9]{1,3})([0-9]+)/)[3]
+        @build_version.match(/^([0-9]+)([A-Z])([0-9]+)/)[3]
       end
 
       def <(other)

lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/models/simctl/matched_runtime.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'runtime_supported_device_type'
+require_relative '../apple_build_version'
+
+module Fastlane
+  module CreateSimulatorDevices
+    module SimCTL
+      # Represents a matched runtime from `xcrun simctl runtime match list --json` output.
+      class MatchedRuntime
+        attr_accessor :identifier, :default_build, :chosen_runtime_build, :sdk_build, :sdk_version, :platform
+
+        def initialize(identifier:, default_build:, chosen_runtime_build:, sdk_build:, sdk_version:, platform:) # rubocop:disable Metrics/ParameterLists
+          self.identifier = identifier
+          self.default_build = default_build
+          self.chosen_runtime_build = chosen_runtime_build
+          self.sdk_build = sdk_build
+          self.sdk_version = sdk_version
+          self.platform = platform
+        end
+
+        def self.from_hash(hash, identifier:)
+          new(
+            identifier: identifier.to_s,
+            default_build: AppleBuildVersion.new(hash[:defaultBuild]),
+            chosen_runtime_build: AppleBuildVersion.new(hash[:chosenRuntimeBuild]),
+            sdk_build: AppleBuildVersion.new(hash[:sdkBuild]),
+            sdk_version: Gem::Version.new(hash[:sdkVersion]),
+            platform: hash[:platform].to_s
+          )
+        end
+      end
+    end
+  end
+end
+
+# Example of a Runtime object from `xcrun simctl list runtimes --json` output:
+#
+# {"iphoneos26.1" : {
+#   "chosenRuntimeBuild" : "23B80",
+#   "defaultBuild" : "23B77",
+#   "platform" : "com.apple.platform.iphoneos",
+#   "sdkBuild" : "23B77",
+#   "sdkDirectory" : "\/Applications\/Xcode-26.1.1.app\/Contents\/Developer\/Platforms\/iPhoneOS.platform\/Developer\/SDKs\/iPhoneOS26.1.sdk",
+#   "sdkVersion" : "26.1"
+# }

lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/runtime_helper.rb

@@ -25,6 +25,13 @@ def initialize(cache_dir:, shell_helper:, verbose:)
         'xrsimulator' => 'xrOS'
       }.freeze
 
+      OS_NAME_TO_MATCHED_RUNTIME_IDENTIFIER = {
+        'iOS' => 'iphoneos',
+        'tvOS' => 'appletvos',
+        'watchOS' => 'watchos',
+        'xrOS' => 'xros'
+      }.freeze
+
       def delete_unusable_runtimes
         deletable_runtimes = shell_helper.installed_runtimes_with_state
           .select { |runtime| runtime.unusable? && runtime.deletable? }
@@ -153,6 +160,16 @@ def runtime_build_version_for_filename(filename)
         AppleBuildVersion.new(build_version)
       end
 
+      def matched_runtime_for_missing_runtime(missing_runtime)
+        matched_runtimes = shell_helper.simctl_matched_runtimes(force: true)
+
+        matched_runtime_identifier = "#{OS_NAME_TO_MATCHED_RUNTIME_IDENTIFIER[missing_runtime.os_name]}#{missing_runtime.product_version}"
+
+        matched_runtimes = matched_runtimes.select { |matched_runtime| matched_runtime.identifier == matched_runtime_identifier && matched_runtime.sdk_build == missing_runtime.product_build_version }
+
+        matched_runtimes.max_by(&:chosen_runtime_build)
+      end
+
       def cached_runtime_file(missing_runtime)
         FileUtils.mkdir_p(cache_dir)
 
@@ -164,10 +181,10 @@ def cached_runtime_file(missing_runtime)
         # E.g. Xcode 26.0 Beta 3 has iOS 26.0 (23A5287e) SDK, but
         # xcodebuild downloads iphonesimulator_26.0_23A5287g.dmg as latest.
         product_build_version = missing_runtime.product_build_version
+
         if product_build_version
           runtime_dmg_search_pattern += product_build_version.major.to_s
           runtime_dmg_search_pattern += product_build_version.minor.to_s
-          runtime_dmg_search_pattern += product_build_version.patch.to_s
         end
         runtime_dmg_search_pattern += '*.dmg'
 
@@ -177,9 +194,17 @@ def cached_runtime_file(missing_runtime)
           UI.message("Available files with pattern: #{Dir.glob(runtime_dmg_search_pattern)}")
         end
 
-        runtime_file = Dir
+        runtime_file = nil
+        runtime_files = Dir
           .glob(runtime_dmg_search_pattern)
-          .max_by { |filename| runtime_build_version_for_filename(filename) }
+
+        return nil if runtime_files.empty?
+
+        matched_runtime = matched_runtime_for_missing_runtime(missing_runtime)
+
+        runtime_file = runtime_files.detect { |filename| filename.end_with?("_#{matched_runtime.chosen_runtime_build}.dmg") } unless matched_runtime.nil?
+
+        runtime_file ||= runtime_files.max_by { |filename| runtime_build_version_for_filename(filename) }
 
         return nil if runtime_file.nil?
 

lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/shell_helper.rb

@@ -104,6 +104,17 @@ def simctl_runtimes(force: false)
         @simctl_runtimes
       end
 
+      def simctl_matched_runtimes(force: false)
+        return @simctl_matched_runtimes unless force || @simctl_matched_runtimes.nil?
+
+        UI.message('Fetching matched runtimes...')
+        json = sh(command: 'xcrun simctl runtime match list --json')
+
+        @simctl_matched_runtimes = JSON
+          .parse(json, symbolize_names: true)
+          .map { |identifier, runtime| SimCTL::MatchedRuntime.from_hash(runtime, identifier: identifier) }
+      end
+
       def installed_runtimes_with_state
         UI.message('Fetching runtimes with state...')
         json = sh(command: 'xcrun simctl runtime list --json')

spec/create_simulator_devices/runtime_helper_spec.rb

@@ -7,6 +7,7 @@
 RSpec.describe Fastlane::CreateSimulatorDevices::RuntimeHelper do
   AppleBuildVersion = Fastlane::CreateSimulatorDevices::AppleBuildVersion
   RequiredRuntime = Fastlane::CreateSimulatorDevices::RequiredRuntime
+  MatchedRuntime = Fastlane::CreateSimulatorDevices::SimCTL::MatchedRuntime
   RequiredDevice = Fastlane::CreateSimulatorDevices::RequiredDevice
   SimCTL = Fastlane::CreateSimulatorDevices::SimCTL
   Xcodebuild = Fastlane::CreateSimulatorDevices::Xcodebuild
@@ -242,12 +243,13 @@
                                         product_build_version: AppleBuildVersion.new('21A326'),
                                         runtime_name: 'iOS 17.0')
 
-      existing_file = '/tmp/test_cache/iphonesimulator_17.0.1_21A326.dmg'
+      existing_file = '/tmp/test_cache/iphonesimulator_17.0.1_21A327.dmg'
 
       allow(FileUtils).to receive(:mkdir_p).with(cache_dir)
-      allow(Dir).to receive(:glob).with('/tmp/test_cache/iphonesimulator_17.0*_21A326*.dmg').and_return([existing_file])
+      allow(Dir).to receive(:glob).with('/tmp/test_cache/iphonesimulator_17.0*_21A*.dmg').and_return([existing_file])
       allow(sut).to receive(:runtime_build_version_for_filename).and_return(AppleBuildVersion.new('21A326'))
       allow(Fastlane::UI).to receive(:message)
+      allow(sut).to receive(:matched_runtime_for_missing_runtime).and_return(instance_double(MatchedRuntime, chosen_runtime_build: '21A327'))
 
       # WHEN: Finding cached runtime file
       result = sut.cached_runtime_file(missing_runtime)