fastlane-plugin-create_simulator_devices 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e4f2a4d905fad425dc7b871cb55ee0ea48c0d36b8417d26d6cfa1a49fd97737
-  data.tar.gz: 1f123387acdf4df42f374ec7ba14d2c0aed1f30587c1c2ba8c9f362a848641fe
+  metadata.gz: fbcf5d008c0e2e248db6b53d80c89c681cd516837439e1da34e95375c135e934
+  data.tar.gz: adc56432be831c59c299204092d96392f3a9483d08ae625a6c5d31695d58a3f0
 SHA512:
-  metadata.gz: 7183aeb1d262c2b7faeadb35750ecf0f04982ef9a978b2e397ec66c5fac5a5a10b94494a525355b74711a25a26a8f7c5a1af2415c57fb6d2db2ff7776461dd16
-  data.tar.gz: 9404401a0f27c170011f87e3707a901f0ac3ae1294ce7ebceb1519648b94b3e6e74cd049b520d288471160852d0c1cf1bc931a05ca8413fa177624da82b60cf3
+  metadata.gz: ded9ef76090109dd7f69d96384625e3899bed635d8d59aee8213954cfe33003be2874de36b0b8aae3bf16cf7e10a27bd59adfd51a9cd4d7d3a2600061bf39d8e
+  data.tar.gz: 02cf2720d898e0cb315bb37d13eb1d86a9b10815635def22781465a3a268e1119b836bf39da22793b4c07d317565f67f118a329511035d478865ab3b3accf285

data/lib/fastlane/plugin/create_simulator_devices/actions/create_simulator_devices_action.rb

@@ -4,6 +4,7 @@ require 'fastlane'
 require 'spaceship'
 require_relative '../helpers/create_simulator_devices/runner'
 require_relative '../helpers/create_simulator_devices/models'
+require_relative '../helpers/create_simulator_devices/models/device_naming_style'
 
 module Fastlane
   module Actions
@@ -22,12 +23,15 @@ module Fastlane
         UI.user_error!('No devices specified') if required_devices.nil? || required_devices.empty?
 
         shell_helper = CreateSimulatorDevices::ShellHelper.new(print_command: params[:print_command], print_command_output: params[:print_command_output], action_context: self)
-        runtime_helper = CreateSimulatorDevices::RuntimeHelper.new(cache_dir: params[:cache_dir], shell_helper:, verbose:)
+        runtime_helper = CreateSimulatorDevices::RuntimeHelper.new(cache_dir: params[:cache_dir], shell_helper: shell_helper, verbose: verbose)
 
         runner = CreateSimulatorDevices::Runner.new(
           runtime_helper: runtime_helper,
           shell_helper: shell_helper,
-          verbose: verbose
+          verbose: verbose,
+          can_rename_devices: params[:rename_devices],
+          can_delete_duplicate_devices: params[:delete_duplicate_devices],
+          device_naming_style: params[:device_naming_style].to_sym
         )
 
         runner.run(required_devices)
@@ -52,7 +56,7 @@ module Fastlane
         )"
       end
 
-      def self.available_options
+      def self.available_options # rubocop:disable Metrics/MethodLength
         [
           ::FastlaneCore::ConfigItem.new(key: :devices,
                                          env_name: 'SCAN_DEVICES',
@@ -80,7 +84,29 @@ module Fastlane
                                          description: 'Print xcrun simctl commands output',
                                          type: Boolean,
                                          optional: true,
-                                         default_value: false)
+                                         default_value: false),
+          ::FastlaneCore::ConfigItem.new(key: :rename_devices,
+                                         env_name: 'CREATE_SIMULATOR_DEVICES_RENAME_DEVICES',
+                                         description: 'Rename devices if needed',
+                                         type: Boolean,
+                                         optional: true,
+                                         default_value: false),
+          ::FastlaneCore::ConfigItem.new(key: :delete_duplicate_devices,
+                                         env_name: 'CREATE_SIMULATOR_DEVICES_DELETE_DUPLICATE_DEVICES',
+                                         description: 'Delete duplicate devices',
+                                         type: Boolean,
+                                         optional: true,
+                                         default_value: false),
+          ::FastlaneCore::ConfigItem.new(key: :device_naming_style,
+                                         env_name: 'CREATE_SIMULATOR_DEVICES_DEVICE_NAMING_STYLE',
+                                         description: 'Device naming style',
+                                         type: String,
+                                         optional: true,
+                                         default_value: CreateSimulatorDevices::DeviceNamingStyle::SCAN.to_s,
+                                         verify_block: proc do |value|
+                                           allowed_values = CreateSimulatorDevices::DeviceNamingStyle::ALL
+                                           UI.user_error!("Invalid device naming style: #{value}. Allowed values: #{allowed_values.map(&:to_s).join(', ')}") unless allowed_values.include?(value.to_sym)
+                                         end)
         ]
       end
 

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

@@ -58,11 +58,19 @@ module Fastlane
         return self == other unless lhs_is_beta && rhs_is_beta && @build_version.length == rhs_build_version.to_s.length
 
         # Take only leading chars up to the first letter included e.g. 22C146 -> 22C
-        minor_version == rhs_build_version.minor_version
+        major == rhs_build_version.major && minor == rhs_build_version.minor && patch == rhs_build_version.patch
       end
 
-      def minor_version
-        AppleBuildVersion.new(@build_version.match(/^[0-9]+[A-Z]+/)[0])
+      def major
+        @build_version.match(/^([0-9]+)([A-Z][0-9]{2,3})([0-9]+)/)[1]
+      end
+
+      def minor
+        @build_version.match(/^([0-9]+)([A-Z][0-9]{2,3})([0-9]+)/)[2]
+      end
+
+      def patch
+        @build_version.match(/^([0-9]+)([A-Z][0-9]{2,3})([0-9]+)/)[3]
       end
 
       def <(other)

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Fastlane
+  module CreateSimulatorDevices
+    class DeviceNamingStyle
+      SCAN = :scan
+      RUN_TESTS = :run_tests
+      SNAPSHOT = :snapshot
+      CAPTURE_IOS_SCREENSHOTS = :capture_ios_screenshots
+
+      ALL = [SCAN, RUN_TESTS, SNAPSHOT, CAPTURE_IOS_SCREENSHOTS].freeze
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ require_relative 'models/xcodebuild/sdk'
 require_relative 'models/required_device'
 require_relative 'models/required_runtime'
 require_relative 'models/apple_build_version'
+require_relative 'models/device_naming_style'
 require 'fastlane'
 
 module Fastlane

data/lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/runner.rb

@@ -3,20 +3,24 @@
 require_relative 'runtime_helper'
 require 'fastlane'
 require_relative 'shared_values'
+require_relative 'models/device_naming_style'
 
 module Fastlane
   # Create simulator devices.
   module CreateSimulatorDevices
     # Does all the work to create simulator devices.
-    class Runner
+    class Runner # rubocop:disable Metrics/ClassLength
       UI = ::Fastlane::UI unless defined?(UI)
 
-      attr_accessor :shell_helper, :verbose, :runtime_helper
+      attr_accessor :shell_helper, :verbose, :runtime_helper, :can_rename_devices, :can_delete_duplicate_devices, :device_naming_style
 
-      def initialize(runtime_helper:, shell_helper:, verbose:)
+      def initialize(runtime_helper:, shell_helper:, verbose:, can_rename_devices:, can_delete_duplicate_devices:, device_naming_style:) # rubocop:disable Metrics/ParameterLists
         self.shell_helper = shell_helper
         self.verbose = verbose
         self.runtime_helper = runtime_helper
+        self.can_rename_devices = can_rename_devices
+        self.can_delete_duplicate_devices = can_delete_duplicate_devices
+        self.device_naming_style = device_naming_style
       end
 
       def run(devices)
@@ -50,11 +54,11 @@ module Fastlane
 
         log_matched_devices(matched_devices: matched_devices)
 
-        Actions.lane_context[Actions::SharedValues::AVAILABLE_SIMULATOR_DEVICES] = matched_devices
-
-        matched_devices_names = matched_devices.map(&:description)
+        matched_devices_names = matched_devices.map { |matched_device| returning_device_name_for_required_device(matched_device) }
         UI.message("Available simulator devices: #{matched_devices_names.join(', ')}")
 
+        Actions.lane_context[Actions::SharedValues::AVAILABLE_SIMULATOR_DEVICES] = matched_devices_names
+
         matched_devices_names
       end
 
@@ -85,14 +89,91 @@ module Fastlane
 
         simctl_devices = shell_helper.simctl_devices_for_runtimes[required_device.simctl_runtime.identifier.to_sym]
 
-        return [] if simctl_devices.nil?
+        return nil if simctl_devices.nil?
 
         # Find the device with the same name as the required device.
         devices_with_same_type = simctl_devices
           .select { |simctl_device| simctl_device.device_type_identifier == required_device.device_type.identifier }
 
-        devices_with_same_type
-          .detect { |simctl_device| simctl_device.name == required_device.device_type.name }
+        preferred_device_name = device_name_for_required_device(required_device)
+
+        # Prefer device with the same name that includes the runtime version.
+        matching_device = devices_with_same_type.detect { |simctl_device| simctl_device.name == preferred_device_name }
+
+        if can_rename_devices
+          # Otherwise, if rename is enabled, use the first device with the same type.
+          matching_device ||= devices_with_same_type.first
+          rename_device_if_needed(matching_device, preferred_device_name)
+        end
+
+        delete_duplicate_devices(devices_with_same_type, matching_device) if can_delete_duplicate_devices
+
+        matching_device
+      end
+
+      def rename_device_if_needed(matching_device, preferred_device_name)
+        return if matching_device.nil? || matching_device.name == preferred_device_name
+
+        UI.message("Renaming device #{matching_device.name} (udid: #{matching_device.udid}) to #{preferred_device_name}")
+        shell_helper.rename_device(udid: matching_device.udid, name: preferred_device_name)
+        matching_device.name = preferred_device_name
+      end
+
+      def delete_duplicate_devices(matching_devices, matching_device)
+        return if matching_device.nil?
+
+        matching_devices
+          .reject { |simctl_device| simctl_device.udid == matching_device.udid }
+          .each do |simctl_device|
+            UI.message("Deleting duplicate device #{simctl_device.name} (udid: #{simctl_device.udid})")
+            shell_helper.delete_device(udid: simctl_device.udid)
+          end
+      end
+
+      # Returns the device name for the required device.
+      #
+      # This name is used in the simctl device name.
+      def device_name_for_required_device(required_device)
+        case device_naming_style
+        when DeviceNamingStyle::SCAN, DeviceNamingStyle::RUN_TESTS
+          # scan modifies the device name by removing the runtime version when searching for a passed device name.
+          # E.g.:
+          #   * given "iPhone 15 (17.0)" match will search for simulator named "iPhone 15" with the SDK version 17.0.
+          #   * given "iPhone 15" match will search for simulator named "iPhone 15" with the default SDK version.
+          # So we need to name the device by the device type name for scan to find the correct device.
+          required_device.device_type.name
+        when DeviceNamingStyle::SNAPSHOT, DeviceNamingStyle::CAPTURE_IOS_SCREENSHOTS
+          # snapshot nither does not modify the device name when searching for a passed device name nor extracts the runtime version from the device name.
+          # E.g.:
+          #   * given "iPhone 15 (17.0)" match will search for device named exactly "iPhone 15 (17.0)".
+          #   * given "iPhone 15" match will search for device named exactly "iPhone 15".
+          # So we need to return the full device name for the required device for snapshot to find the correct device.
+          runtime_build = required_device.simctl_runtime.build_version
+          build_suffix = runtime_build.beta? ? "-#{runtime_build}" : ''
+          "#{required_device.device_type.name} (#{required_device.simctl_runtime.version}#{build_suffix})"
+        end
+      end
+
+      # Returns the device name for the required device.
+      #
+      # This name is used when passing the device name to the scan or snapshot.
+      def returning_device_name_for_required_device(required_device)
+        case device_naming_style
+        when DeviceNamingStyle::SCAN, DeviceNamingStyle::RUN_TESTS
+          # scan respects the runtime version in the devices list, so we need to return the full device name for the required device, otherwise the default SDK version will be used.
+          # E.g.:
+          #   * given "iPhone 15 (17.0)" match will search for simulator named "iPhone 15" with the SDK version 17.0.
+          #   * given "iPhone 15" match will search for simulator named "iPhone 15" with the default SDK version.
+          # So we need to return the device name and the required runtime version for scan to find the correct device.
+          "#{required_device.simctl_device.name} (#{required_device.required_runtime.product_version})"
+        when DeviceNamingStyle::SNAPSHOT, DeviceNamingStyle::CAPTURE_IOS_SCREENSHOTS
+          # snapshot does not modify the device name when searching for a passed device name nor extracts the runtime version from the device name.
+          # E.g.:
+          #   * given "iPhone 15 (17.0)" match will search for device named exactly "iPhone 15 (17.0)".
+          #   * given "iPhone 15" match will search for device named exactly "iPhone 15" .
+          # So we need to return the full device name for the required device for snapshot to find the correct device.
+          required_device.simctl_device.name
+        end
       end
 
       def create_missing_devices(required_devices)
@@ -109,7 +190,7 @@ module Fastlane
         UI.message('Creating missing devices')
         missing_devices.each do |missing_device|
           shell_helper.create_device(
-            missing_device.device_type.name,
+            device_name_for_required_device(missing_device),
             missing_device.device_type.identifier,
             missing_device.simctl_runtime.identifier
           )

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

@@ -161,7 +161,12 @@ module Fastlane
         # shipped with Xcode betas and use the same product version.
         # E.g. Xcode 26.0 Beta 3 has iOS 26.0 (23A5287e) SDK, but
         # xcodebuild downloads iphonesimulator_26.0_23A5287g.dmg as latest.
-        runtime_dmg_search_pattern += missing_runtime.product_build_version.minor_version.to_s if missing_runtime.product_build_version
+        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'
 
         if verbose

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

@@ -66,7 +66,7 @@ module Fastlane
         @simctl_device_types
       end
 
-      def delete_device(udid)
+      def delete_device(udid:)
         UI.message("Deleting device #{udid}...")
         sh(command: "xcrun simctl delete #{udid.shellescape}")
       end
@@ -130,6 +130,11 @@ module Fastlane
         sh(command: "xcrun simctl create #{name.shellescape} #{device_type_identifier.shellescape} #{runtime_identifier.shellescape}")
       end
 
+      def rename_device(udid:, name:)
+        UI.message("Renaming device with udid #{udid} to #{name}")
+        sh(command: "xcrun simctl rename #{udid.shellescape} #{name.shellescape}")
+      end
+
       def delete_runtime(runtime_identifier)
         UI.message("Deleting runtime #{runtime_identifier}...")
         sh(command: "xcrun simctl runtime delete #{runtime_identifier.shellescape}")
@@ -150,8 +155,12 @@ module Fastlane
           missing_runtime.os_name.shellescape
         ]
 
-        command << '-buildVersion'
-        command << missing_runtime.product_version.to_s.shellescape
+        is_beta = missing_runtime.product_build_version.nil? ? false : missing_runtime.product_build_version.beta?
+
+        unless is_beta
+          command << '-buildVersion'
+          command << missing_runtime.product_version.to_s.shellescape
+        end
 
         sh(command: command.join(' '), print_command: true, print_command_output: true)
       end

data/lib/fastlane/plugin/create_simulator_devices/version.rb

@@ -2,6 +2,6 @@
 
 module Fastlane
   module CreateSimulatorDevices
-    VERSION = '0.0.12'
+    VERSION = '0.0.13'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-create_simulator_devices
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Vitalii Budnik
@@ -22,6 +22,7 @@ files:
 - lib/fastlane/plugin/create_simulator_devices/actions/create_simulator_devices_action.rb
 - lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/models.rb
 - lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/models/apple_build_version.rb
+- lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/models/device_naming_style.rb
 - lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/models/required_device.rb
 - lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/models/required_runtime.rb
 - lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/models/simctl/device.rb