fastlane-plugin-create_simulator_devices 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbcf5d008c0e2e248db6b53d80c89c681cd516837439e1da34e95375c135e934
-  data.tar.gz: adc56432be831c59c299204092d96392f3a9483d08ae625a6c5d31695d58a3f0
+  metadata.gz: d67f3fc97805357d10286a81d1d7fcbf18ede6af69da32b176c6fcd73ab72a2f
+  data.tar.gz: baf9ecd15c0dc7fbc66c413f61d48f44bf37a6ff32963fb4647cdcf9b586bdeb
 SHA512:
-  metadata.gz: ded9ef76090109dd7f69d96384625e3899bed635d8d59aee8213954cfe33003be2874de36b0b8aae3bf16cf7e10a27bd59adfd51a9cd4d7d3a2600061bf39d8e
-  data.tar.gz: 02cf2720d898e0cb315bb37d13eb1d86a9b10815635def22781465a3a268e1119b836bf39da22793b4c07d317565f67f118a329511035d478865ab3b3accf285
+  metadata.gz: 8de8e706a371d863ee1646ca85c899ee96c42ce7f94a2c6bb97fabbc579b03af429ddc439356ea7a6d429507e0ccc4c21fda66007ffef6a16fd6925e99ef033f
+  data.tar.gz: ddd40fb588c98656bae804668cc5ee899af6c09fc660a629edc6a6c443f431832375a0e3930dcb27ebc89153d325780386961dc8e4fececb877fb16b2488648a

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

@@ -31,7 +31,8 @@ module Fastlane
           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
+          device_naming_style: params[:device_naming_style].to_sym,
+          remove_cached_runtimes: params[:remove_cached_runtimes]
         )
 
         runner.run(required_devices)
@@ -106,7 +107,13 @@ module Fastlane
                                          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),
+          ::FastlaneCore::ConfigItem.new(key: :remove_cached_runtimes,
+                                         env_name: 'CREATE_SIMULATOR_DEVICES_REMOVE_CACHED_RUNTIMES',
+                                         description: 'Remove cached runtimes after successful installation',
+                                         type: Boolean,
+                                         optional: true,
+                                         default_value: true)
         ]
       end
 

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

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require 'fastlane'
+require 'spaceship'
+require_relative '../helpers/create_simulator_devices/shell_helper'
+require_relative '../helpers/create_simulator_devices/runner'
+require_relative '../helpers/create_simulator_devices/models/device_naming_style'
+require_relative '../helpers/gather_simctl_diagnose/runner'
+
+module Fastlane
+  module Actions
+    GatherSimctlDiagnose = ::Fastlane::GatherSimctlDiagnose
+    CreateSimulatorDevices = ::Fastlane::CreateSimulatorDevices
+
+    # Gather simctl diagnose data.
+    class GatherSimctlDiagnoseAction < Fastlane::Action
+      UI = ::Fastlane::UI unless defined?(UI)
+
+      attr_accessor :shell_helper
+
+      def self.run(params)
+        verbose = params[:verbose]
+        params[:devices] = params[:devices].split(',').map(&:strip) if params[:devices].is_a?(String)
+        required_devices = params[:devices]
+        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: nil, shell_helper: shell_helper, verbose: verbose)
+
+        create_simulator_devices_runner = ::Fastlane::CreateSimulatorDevices::Runner.new(
+          runtime_helper: runtime_helper,
+          shell_helper: shell_helper,
+          verbose: verbose,
+          can_rename_devices: false,
+          can_delete_duplicate_devices: false,
+          device_naming_style: params[:device_naming_style].to_sym,
+          remove_cached_runtimes: false
+        )
+
+        runner = GatherSimctlDiagnose::Runner.new(
+          runtime_helper: runtime_helper,
+          shell_helper: shell_helper,
+          verbose: verbose,
+          device_naming_style: params[:device_naming_style].to_sym,
+          create_simulator_devices_runner: create_simulator_devices_runner,
+          output_dir: params[:output_dir],
+          timeout: params[:timeout],
+          include_all_device_logs: params[:include_all_device_logs],
+          include_booted_device_data_directory: params[:include_booted_device_data_directory]
+        )
+
+        runner.run(required_devices)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Gathers simctl diagnose data'
+      end
+
+      def self.details
+        "This action gathers simctl diagnose data.
+
+        Usage sample:
+
+        gather_simctl_diagnose(
+          devices: ['iPhone 15 (17.0)', 'iPhone 16', 'iPhone 14 (16.3)']
+          output_dir: 'diagnose'
+        )"
+      end
+
+      def self.available_options # rubocop:disable Metrics/MethodLength
+        [
+          ::FastlaneCore::ConfigItem.new(key: :devices,
+                                         env_name: 'SCAN_DEVICES',
+                                         description: 'A list of simulator devices to install (e.g. "iPhone 16")',
+                                         is_string: false,
+                                         default_value: 'iPhone 16'),
+          ::FastlaneCore::ConfigItem.new(key: :verbose,
+                                         env_name: 'VERBOSE',
+                                         description: 'Verbose output',
+                                         type: Boolean,
+                                         optional: true,
+                                         default_value: ::FastlaneCore::Globals.verbose?,
+                                         default_value_dynamic: true),
+          ::FastlaneCore::ConfigItem.new(key: :output_dir,
+                                         env_name: 'GATHER_SIMCTL_DIAGNOSE_OUTPUT_DIR',
+                                         description: 'Output directory',
+                                         type: String,
+                                         optional: false),
+          ::FastlaneCore::ConfigItem.new(key: :print_command,
+                                         description: 'Print xcrun simctl commands',
+                                         type: Boolean,
+                                         optional: true,
+                                         default_value: false),
+          ::FastlaneCore::ConfigItem.new(key: :print_command_output,
+                                         description: 'Print xcrun simctl commands output',
+                                         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),
+          ::FastlaneCore::ConfigItem.new(key: :timeout,
+                                         env_name: 'GATHER_SIMCTL_DIAGNOSE_TIMEOUT',
+                                         description: 'Timeout',
+                                         type: Integer,
+                                         optional: true,
+                                         default_value: 300),
+          ::FastlaneCore::ConfigItem.new(key: :include_all_device_logs,
+                                         env_name: 'GATHER_SIMCTL_DIAGNOSE_INCLUDE_ALL_DEVICE_LOGS',
+                                         description: 'Include all device logs',
+                                         type: Boolean,
+                                         optional: true,
+                                         default_value: false),
+          ::FastlaneCore::ConfigItem.new(key: :include_booted_device_data_directory,
+                                         env_name: 'GATHER_SIMCTL_DIAGNOSE_INCLUDE_BOOTED_DEVICE_DATA_DIRECTORY',
+                                         description: 'Include booted device data directory. Warning: May include private information, app data containers, and increases the size of the archive! Default is NOT to collect the data container',
+                                         type: Boolean,
+                                         optional: true,
+                                         default_value: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['GATHER_SIMCTL_DIAGNOSE_OUTPUT_FILE', 'Output archive file with simctl diagnose data']
+        ]
+      end
+
+      def self.return_value
+        'Returns a path to the output archive file with simctl diagnose data'
+      end
+
+      def self.authors
+        ['nekrich']
+      end
+
+      def self.is_supported?(_platform) # rubocop:disable Naming/PredicatePrefix
+        true
+      end
+    end
+  end
+end

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

@@ -12,15 +12,16 @@ module Fastlane
     class Runner # rubocop:disable Metrics/ClassLength
       UI = ::Fastlane::UI unless defined?(UI)
 
-      attr_accessor :shell_helper, :verbose, :runtime_helper, :can_rename_devices, :can_delete_duplicate_devices, :device_naming_style
+      attr_accessor :shell_helper, :verbose, :runtime_helper, :can_rename_devices, :can_delete_duplicate_devices, :device_naming_style, :remove_cached_runtimes
 
-      def initialize(runtime_helper:, shell_helper:, verbose:, can_rename_devices:, can_delete_duplicate_devices:, device_naming_style:) # rubocop:disable Metrics/ParameterLists
+      def initialize(runtime_helper:, shell_helper:, verbose:, can_rename_devices:, can_delete_duplicate_devices:, device_naming_style:, remove_cached_runtimes:) # 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
+        self.remove_cached_runtimes = remove_cached_runtimes
       end
 
       def run(devices)

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

@@ -50,7 +50,7 @@ module Fastlane
         end
 
         missing_runtimes.each do |missing_runtime|
-          download_and_install_missing_runtime(missing_runtime)
+          download_and_install_missing_runtime(missing_runtime, remove_cached_runtimes: remove_cached_runtimes)
         end
 
         # Update simctl_runtimes after installing the runtimes.
@@ -128,7 +128,7 @@ module Fastlane
         simctl_runtime
       end
 
-      def download_and_install_missing_runtime(missing_runtime)
+      def download_and_install_missing_runtime(missing_runtime, remove_cached_runtimes:)
         UI.message("Attempting to install #{missing_runtime.runtime_name} runtime.")
 
         downloaded_runtime_file = cached_runtime_file(missing_runtime)
@@ -139,6 +139,8 @@ module Fastlane
         end
 
         shell_helper.import_runtime(downloaded_runtime_file, missing_runtime.runtime_name)
+
+        FileUtils.rm_rf(downloaded_runtime_file) if remove_cached_runtimes
       end
 
       def runtime_build_version_for_filename(filename)

data/lib/fastlane/plugin/create_simulator_devices/helpers/gather_simctl_diagnose/module.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'fastlane'
+
+module Fastlane
+  # Gather simctl diagnose data.
+  module GatherSimctlDiagnose
+    UI = ::Fastlane::UI unless defined?(UI)
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative 'module'
+require 'fastlane'
+require_relative 'shared_values'
+require_relative '../create_simulator_devices/models/device_naming_style'
+
+module Fastlane
+  # Gather simctl diagnose data.
+  module GatherSimctlDiagnose
+    # Does all the work to create simulator devices.
+    class Runner
+      UI = ::Fastlane::UI unless defined?(UI)
+
+      attr_accessor :shell_helper, :verbose, :runtime_helper, :device_naming_style, :create_simulator_devices_runner, :output_dir, :timeout, :include_all_device_logs, :include_booted_device_data_directory, :print_command, :print_command_output
+
+      def initialize( # rubocop:disable Metrics/ParameterLists
+        runtime_helper:,
+        shell_helper:,
+        verbose:,
+        device_naming_style:,
+        create_simulator_devices_runner:,
+        output_dir:,
+        timeout:,
+        include_all_device_logs:,
+        include_booted_device_data_directory:
+      )
+        self.shell_helper = shell_helper
+        self.verbose = verbose
+        self.runtime_helper = runtime_helper
+        self.device_naming_style = device_naming_style
+        self.create_simulator_devices_runner = create_simulator_devices_runner
+        self.output_dir = output_dir
+        self.timeout = timeout
+        self.include_all_device_logs = include_all_device_logs
+        self.include_booted_device_data_directory = include_booted_device_data_directory
+      end
+
+      def run(devices) # rubocop:disable Metrics/AbcSize
+        UI.message("Simulator devices to gather diagnose data: #{devices.join(', ')}")
+
+        # Create distict required devices from a given list of device strings.
+        required_devices = devices
+          .filter_map { |device| create_simulator_devices_runner.required_device_for_device(device) }
+          .uniq { |required_device| [required_device.device_type.name, required_device.required_runtime.product_version] }
+
+        if verbose
+          UI.message('Unique required devices:')
+          UI.message("  #{required_devices.map(&:description).join("\n  ")}")
+        end
+
+        # Return distinct matched devices strings
+        matched_devices = create_simulator_devices_runner.find_runtime_and_device_for_required_devices(required_devices)
+          .reject { |required_device| required_device.simctl_device.nil? }
+
+        matched_devices_udids = matched_devices.map { |matched_device| matched_device.simctl_device.udid }
+        UI.message("Available simulator devices: #{matched_devices_udids.join(', ')}")
+
+        temp_output_dir = "#{File.expand_path(output_dir)}/simctl_diagnose_#{Time.now.strftime('%Y%m%d%H%M%S')}"
+
+        diagnose_args = matched_devices_udids.map { |udid| "--udid=#{udid}" }
+        diagnose_args << '-b' # Do NOT show the resulting archive in a Finder window upon completion.
+        diagnose_args << '--all-logs' if include_all_device_logs
+        diagnose_args << '--data-container' if include_booted_device_data_directory
+        diagnose_args << "--timeout=#{timeout}"
+
+        cmd_args = diagnose_args.map(&:shellescape).join(' ')
+
+        collect_diagnose_data_script_path = File.expand_path("#{__dir__}/scripts/collect_simctl_diagnose_data.sh")
+
+        shell_helper.sh(
+          command: "SIMCTL_DIAGNOSE_OUTPUT_FOLDER=#{temp_output_dir.shellescape} #{collect_diagnose_data_script_path.shellescape} #{cmd_args}",
+          print_command: verbose,
+          print_command_output: verbose
+        )
+
+        archive_name = "#{temp_output_dir}.tar.gz"
+        Actions.lane_context[Actions::SharedValues::GATHER_SIMCTL_DIAGNOSE_OUTPUT_FILE] = archive_name
+
+        archive_name
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/create_simulator_devices/helpers/gather_simctl_diagnose/scripts/collect_simctl_diagnose_data.expect

@@ -0,0 +1,9 @@
+#!/usr/bin/env expect
+
+# Runs xcrun simctl diagnose with given parameters.
+# xcrun simctl diagnose needs user to press ENTER which is not possible to do in non-interactive shell.
+
+spawn xcrun simctl diagnose {*}$argv
+expect -exact "Press ENTER to continue\r\n"
+send -- "\r"
+expect eof

data/lib/fastlane/plugin/create_simulator_devices/helpers/gather_simctl_diagnose/scripts/collect_simctl_diagnose_data.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+# Runs xcrun simctl diagnose with given parameters.
+# Manages the output folder and the archive.
+#
+# When --data-container is passed simctl diagnose doesn't create archive,
+# and w/o archive the artifacts step on CI hangs.
+#
+# For this case we handle the archive creation manually.
+
+set -Eeo pipefail
+
+export SIMCTL_DIAGNOSE_OUTPUT_FOLDER="${SIMCTL_DIAGNOSE_OUTPUT_FOLDER:-"logs/simctl_diagnose"}"
+
+FOLDER_NAME="$(basename "${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}")"
+OUTPUT_FOLDER_PATH="$(dirname "${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}")"
+
+echo "Cleaning up previous simctl logs at ${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}"
+rm -rf "${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}" || true
+rm -rf "${OUTPUT_FOLDER_PATH}/${FOLDER_NAME}."* || true
+mkdir -p "${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}"
+
+echo "Collecting simctl logs to ${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}..."
+"$(dirname "${0}")/$(basename "${0}" .sh).expect" "${@}" --output="${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}"
+
+if [ -d "${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}" ]; then
+  echo "Compressing simctl logs to ${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}.tar.gz..."
+  cd "${OUTPUT_FOLDER_PATH}"
+  tar -czf "${FOLDER_NAME}.tar.gz" "${FOLDER_NAME}"
+  echo "Removing folder ${FOLDER_NAME}"
+  # Remove folder becuse it contains symlinks and zip doesn't remove them and tar doesn't remove it at all.
+  rm -rf "${FOLDER_NAME}" || true
+  echo "Archive size: $(du -h "${FOLDER_NAME}.tar.gz" | cut -f1)"
+elif [ -f "${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}.zip" ]; then
+  echo "Archive size: $(du -h "${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}.zip" | cut -f1)"
+elif [ -f "${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}.tar.gz" ]; then
+  echo "Archive size: $(du -h "${SIMCTL_DIAGNOSE_OUTPUT_FOLDER}.tar.gz" | cut -f1)"
+fi
+
+echo "Simctl logs collected successfully at $OUTPUT_FOLDER_PATH"

data/lib/fastlane/plugin/create_simulator_devices/helpers/gather_simctl_diagnose/shared_values.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'fastlane'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GATHER_SIMCTL_DIAGNOSE_OUTPUT_FILE = :GATHER_SIMCTL_DIAGNOSE_OUTPUT_FILE
+    end
+  end
+end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-create_simulator_devices
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Vitalii Budnik
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-29 00:00:00.000000000 Z
+date: 2025-09-04 00:00:00.000000000 Z
 dependencies: []
 description:
 email: developers@setapp.com
@@ -20,6 +20,7 @@ files:
 - README.md
 - lib/fastlane/plugin/create_simulator_devices.rb
 - lib/fastlane/plugin/create_simulator_devices/actions/create_simulator_devices_action.rb
+- lib/fastlane/plugin/create_simulator_devices/actions/gather_simctl_diagnose_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
@@ -34,6 +35,11 @@ files:
 - lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/runtime_helper.rb
 - lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/shared_values.rb
 - lib/fastlane/plugin/create_simulator_devices/helpers/create_simulator_devices/shell_helper.rb
+- lib/fastlane/plugin/create_simulator_devices/helpers/gather_simctl_diagnose/module.rb
+- lib/fastlane/plugin/create_simulator_devices/helpers/gather_simctl_diagnose/runner.rb
+- lib/fastlane/plugin/create_simulator_devices/helpers/gather_simctl_diagnose/scripts/collect_simctl_diagnose_data.expect
+- lib/fastlane/plugin/create_simulator_devices/helpers/gather_simctl_diagnose/scripts/collect_simctl_diagnose_data.sh
+- lib/fastlane/plugin/create_simulator_devices/helpers/gather_simctl_diagnose/shared_values.rb
 - lib/fastlane/plugin/create_simulator_devices/version.rb
 homepage:
 licenses: