fastlane-plugin-maestro 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ddf938129d4e0385bc14555c532053b5e736a27fc2082da740ea727a1313d3f
-  data.tar.gz: a05a596cad7786aa095f7464dfe820300e72a74df3e75b187376cb7e4009bbef
+  metadata.gz: 0103c17face38cbcd796b2dfe0bd3def13bdc168725147c5762fa3a9d82bfc5b
+  data.tar.gz: 755c3ce2fac773ab52e85be741e7bd10c387f953a2160f6c24d9f23b54cd0d48
 SHA512:
-  metadata.gz: 272b6143ae66f487269004a2cdf2441bbd7c9a40490210e93cc48840f193a08523c0eaad987bff9714930ec4528e0036489e47933c416a59d05a047e2848880d
-  data.tar.gz: 2d4c37eea7e99f172f50f0b49c63d4d487133721c6ab3b8e9d11389751b3c7fc4a6561971ef2c94ae3cbc0055e39124ec13e4c78cf33631e12f2852ff5b97259
+  metadata.gz: '0923e9a98ee7ea40c064edf8b30712209a4f359c6e4a21ed6a0188b4e9171f96c19854711ce5fb5fb9b4a20ba03c736566a112d6a7708601010e8f5ab9c4be63'
+  data.tar.gz: dbf92fd9cba26dbce68fd233f9c2e744f93aa66fb12a49c8512146dad354dbd7269c5e828608360d727c9b26622e5c6d20897fb61a197c965c69c5d56c9115d1

data/README.md

@@ -14,7 +14,7 @@ gem "fastlane-plugin-maestro", git: "https://github.com/inf2381/fastlane-plugin-
 ## About this plugin
 
 fastlane plugin for [maestro](https://github.com/mobile-dev-inc/maestro).
-You can directly pass the options to maestro or provide them in the file `fastlane/Maestrofile`
+You can directly pass the options to maestro or provide them in the file `fastlane/Maestrofile` when using the action `maestro_test`
 
 Additionally to the maestro action, this plugin provides an action to start an iOS simulator and install a given .app
 file to it.
@@ -36,10 +36,14 @@ device = launch_simulator(
 Run all flows defined in the folder .maestro/screenshot
 
 ```ruby
-maestro(
-  command: 'test',
-  tests: '.maestro/screenshot',
-  report_type: 'junit'
+maestro_test(
+  device: "EMULATOR_42",
+  tests: "test_dir",
+  debug_output: "my_output_dir",
+  env_vars: {
+    "USERNAME" => "testuser",
+    "PASSWORD" => "test123"
+  }
 )
 ```
 
@@ -59,6 +63,15 @@ maestro(
 )
 ```
 
+Generically call maestro
+
+```ruby
+maestro(
+  command: 'start-device',
+  flags: '--device-locale "de_DE"'
+)
+```
+
 For other examples, please have a look at the [Fastfile of this repository](./fastlane/Fastfile)
 
 ## Issues and Feedback

data/lib/fastlane/plugin/maestro/actions/launch_simulator.rb

@@ -6,24 +6,53 @@ module Fastlane
   module Actions
     class LaunchSimulatorAction < Action
       def self.run(params)
-        device_type = SimCtl.devicetype(name: params[:device_name])
+        FastlaneCore::PrintTable.print_values(config: params,
+                                              title: "Summary for launch_simulator #{Fastlane::Maestro::VERSION}")
         device_name = "Maestro - #{params[:device_name]}"
+        runtime_name = params[:ios_version].nil? || params[:ios_version].empty? ? SimCtl.list_runtimes()[0].name : "iOS #{params[:ios_version]}"
+        runtime = SimCtl.runtime(name: runtime_name)
 
-        runtime_name = ''
-        if params[:ios_version].nil? || params[:ios_version].empty?
-          runtime_name = SimCtl.list_runtimes()[0].name
-        else
-          runtime_name = "iOS #{params[:ios_version]}"
+        # Verify runtime identifier
+        if runtime.nil?
+          UI.user_error!("Could not find a runtime matching #{runtime_name}")
         end
-        runtime = SimCtl.runtime(name: runtime_name)
+
+        # List available devices
+        available_devices = SimCtl.list_devices
+
+        # Manually filter devices
+        existing_device = available_devices.find { |d| d.name == device_name && d.os == runtime.identifier }
+        if existing_device
+          if existing_device.state == :booted
+            UI.message("Device #{device_name} is already running. Patching settings…")
+            patch_device_settings(existing_device, params)
+            return existing_device
+          elsif existing_device.state == :shutdown
+            UI.message("Device #{device_name} is shutdown. Booting device…")
+            existing_device.boot
+            existing_device.wait { |d| d.state == :booted }
+            patch_device_settings(existing_device, params)
+            return existing_device
+          end
+        end
+
+        # Create and boot the device if it doesn't exist
         UI.message("Creating device #{device_name} with runtime #{runtime_name}…")
+        device_type = SimCtl.devicetype(name: params[:device_name])
         device = SimCtl.create_device(device_name, device_type, runtime)
-
         device.boot
 
         UI.message("Waiting for device to boot")
         device.wait { |d| d.state == :booted }
+        patch_device_settings(device, params)
 
+        UI.message("Installing app #{params[:app_path]} on the simulator")
+        device.install(params[:app_path])
+
+        return device
+      end
+
+      def self.patch_device_settings(device, params)
         unless params[:language].nil? || params[:language].empty?
           UI.message("Setting device language to #{params[:language]}")
           device.settings.set_language(params[:language])
@@ -31,10 +60,9 @@ module Fastlane
         end
 
         UI.message("Patching device settings for tests")
-        time = Time.new(2007, 1, 9, 9, 41, 0)
         device.status_bar.clear
         device.status_bar.override(
-          time: time.iso8601,
+          time: '9:41', # Time.new(2007, 1, 9, 9, 41, 0).iso8601 not possible as of iOS 18.2
           dataNetwork: '5g',
           wifiMode: 'active',
           cellularMode: 'active',
@@ -42,13 +70,7 @@ module Fastlane
           batteryLevel: 100
         )
         device.settings.disable_keyboard_helpers
-
         device.launch
-
-        UI.message("Installing app #{params[:app_path]} on the simulator")
-        device.install(params[:app_path])
-
-        return device
       end
 
       def self.description
@@ -95,9 +117,6 @@ module Fastlane
       end
 
       def self.is_supported?(platform)
-        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
-        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
-        #
         [:ios].include?(platform)
       end
     end

data/lib/fastlane/plugin/maestro/actions/maestro.rb

@@ -7,42 +7,21 @@ module Fastlane
   module Actions
     class MaestroAction < Action
       def self.run(params)
-        params.load_configuration_file("Maestrofile")
-        FastlaneCore::PrintTable.print_values(config: params,
-                                              title: "Summary for maestro #{Fastlane::Maestro::VERSION}")
-
         case params[:command]
         when "install"
           Maestro::Runner.install
-        when "test"
-          platform = (ENV['FASTLANE_PLATFORM_NAME'] ? ENV['FASTLANE_PLATFORM_NAME'].to_s : '')
-          if platform == 'ios'
-            self.check_ios_dependencies!
-          end
-          Maestro::Runner.run(params)
         when "download_samples"
           Maestro::Runner.download_samples
+        when "test"
+          UI.important("The `maestro(command: 'test')` action is deprecated. Please use `maestro_test` instead.")
+          Maestro::Runner.run_deprecated(params)
+        else
+          Maestro::Runner.run_generic(params[:command], params[:flags])
         end
       end
 
-      def self.check_ios_dependencies!
-        UI.message("Making sure you installed the dependencies to run Maestro…")
-
-        return if Maestro::Runner.command?("idb_companion")
-
-        UI.error("You have to install idb companion to use `maestro` with iOS simulators")
-        UI.error("")
-        UI.error("Install it via brew:")
-        UI.command("brew tap facebook/fb")
-        UI.command("brew install idb-companion")
-
-        UI.error("If you don't have homebrew, visit https://github.com/facebook/idb")
-
-        UI.user_error!("Please install idb companion and start your lane again.")
-      end
-
       def self.description
-        'Runs Maestro test'
+        'Runs the Maestro CLI'
       end
 
       def self.authors
@@ -60,7 +39,7 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(key: :command,
                                        env_name: 'FL_MAESTRO_COMMAND',
-                                       description: 'Command to be executed (`download_samples`, `install`, or `test`)',
+                                       description: 'Command to be executed (`download_samples`, `install`)',
                                        type: String,
                                        default_value: 'test',
                                        verify_block: proc do |value|
@@ -68,6 +47,11 @@ module Fastlane
                                            UI.user_error!("Unsupported value '#{value}' for parameter ':command'! \nAvailable options: `download_samples`, `install`, `test`")
                                          end
                                        end),
+          FastlaneCore::ConfigItem.new(key: :flags,
+                                       description: 'Allows to pass additional flags',
+                                       optional: true,
+                                       type: String,
+                                       default_value: ''),
           FastlaneCore::ConfigItem.new(key: :report_type,
                                        env_name: 'FL_MAESTRO_FORMAT',
                                        description: 'Format of the generated report (`junit`)',
@@ -79,32 +63,32 @@ module Fastlane
                                            UI.user_error!("Unsupported value '#{value}' for parameter ':format'! Available options: `junit`")
                                          end
                                        end),
-          FastlaneCore::ConfigItem.new(key: :output,
-                                       env_name: 'FL_MAESTRO_OUTPUT',
-                                       description: 'Allows to override the report filename. Requires parameter :format to be set as well',
-                                       optional: true,
-                                       type: String,
-                                       default_value: ''),
-          FastlaneCore::ConfigItem.new(key: :device,
-                                       env_name: 'FL_MAESTRO_DEVICE',
-                                       description: 'iOS UDID or Android device name to be used for running the tests ',
-                                       optional: true,
-                                       type: String,
-                                       default_value: ''),
-          FastlaneCore::ConfigItem.new(key: :tests,
-                                       env_name: 'FL_MAESTRO_TESTS',
-                                       description: 'Maestro flow (or folder containing flows) to be executed',
-                                       optional: true,
-                                       type: String,
-                                       verify_block: proc do |value|
-                                         v = File.expand_path(value.to_s)
-                                         UI.user_error!("No file or directory found with path '#{v}'") unless File.exist?(v)
-                                       end),
-          FastlaneCore::ConfigItem.new(key: :env_vars,
-                                       env_name: 'FL_MAESTRO_ENV_VARIABLES',
-                                       description: 'Allows to pass variables that the flow(s) might be using',
-                                       optional: true,
-                                       type: Hash)
+         FastlaneCore::ConfigItem.new(key: :output,
+                                      env_name: 'FL_MAESTRO_OUTPUT',
+                                      description: 'Allows to override the report filename. Requires parameter :format to be set as well',
+                                      optional: true,
+                                      type: String,
+                                      default_value: ''),
+         FastlaneCore::ConfigItem.new(key: :device,
+                                      env_name: 'FL_MAESTRO_DEVICE',
+                                      description: 'iOS UDID or Android device name to be used for running the tests ',
+                                      optional: true,
+                                      type: String,
+                                      default_value: ''),
+         FastlaneCore::ConfigItem.new(key: :tests,
+                                      env_name: 'FL_MAESTRO_TESTS',
+                                      description: 'Maestro flow (or folder containing flows) to be executed',
+                                      optional: true,
+                                      type: String,
+                                      verify_block: proc do |value|
+                                        v = File.expand_path(value.to_s)
+                                        UI.user_error!("No file or directory found with path '#{v}'") unless File.exist?(v)
+                                      end),
+         FastlaneCore::ConfigItem.new(key: :env_vars,
+                                      env_name: 'FL_MAESTRO_ENV_VARIABLES',
+                                      description: 'Allows to pass variables that the flow(s) might be using',
+                                      optional: true,
+                                      type: Hash)
         ]
       end
 

data/lib/fastlane/plugin/maestro/actions/maestro_test.rb

@@ -0,0 +1,136 @@
+require 'fastlane/action'
+require 'fileutils'
+
+require_relative '../helper/runner'
+
+module Fastlane
+  module Actions
+    class MaestroTestAction < Action
+      def self.run(params)
+        params.load_configuration_file("Maestrofile")
+        FastlaneCore::PrintTable.print_values(config: params,
+                                              title: "Summary for maestro #{Fastlane::Maestro::VERSION}")
+        platform = (ENV['FASTLANE_PLATFORM_NAME'] ? ENV['FASTLANE_PLATFORM_NAME'].to_s : '')
+        if platform == 'ios'
+          self.check_ios_dependencies!
+        end
+        Maestro::Runner.run(params)
+      end
+
+      def self.check_ios_dependencies!
+        UI.message("Making sure you installed the dependencies to run Maestro…")
+
+        return if Maestro::Runner.command?("idb_companion")
+
+        UI.error("You have to install idb companion to use `maestro` with iOS simulators")
+        UI.error("")
+        UI.error("Install it via brew:")
+        UI.command("brew tap facebook/fb")
+        UI.command("brew install idb-companion")
+
+        UI.error("If you don't have homebrew, visit https://github.com/facebook/idb")
+
+        UI.user_error!("Please install idb companion and start your lane again.")
+      end
+
+      def self.description
+        'Runs Maestro test'
+      end
+
+      def self.authors
+        ['Marc Bormeth']
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+        'Runs maestro test'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :continuous,
+                                       env_name: 'FL_MAESTRO_CONTINUOUS',
+                                       description: 'Run in continuous mode',
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :config,
+                                       env_name: 'FL_MAESTRO_CONFIG',
+                                       description: 'Optional YAML configuration file for the workspace (defaults to <workspace_path>/config.yaml)',
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :debug_output,
+                                       env_name: 'FL_MAESTRO_DEBUG_OUTPUT',
+                                       description: 'Configures the debug output in this path, instead of default',
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :env_vars,
+                                       env_name: 'FL_MAESTRO_ENV_VARIABLES',
+                                       description: 'Allows to pass variables that the flow(s) might be using',
+                                       optional: true,
+                                       type: Hash),
+          FastlaneCore::ConfigItem.new(key: :exclude_tags,
+                                       env_name: 'FL_MAESTRO_EXCLUDE_TAGS',
+                                       description: 'List of tags that will remove the Flows containing the provided tags',
+                                       optional: true,
+                                       type: Array),
+          FastlaneCore::ConfigItem.new(key: :flatten_debug_output,
+                                       env_name: 'FL_MAESTRO_FLATTEN_DEBUG_OUTPUT',
+                                       description: 'All file outputs from the test case are created in the folder without subfolders or timestamps for each run',
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :report_type,
+                                       env_name: 'FL_MAESTRO_FORMAT',
+                                       description: 'Format of the generated report (`junit`)',
+                                       optional: true,
+                                       type: String,
+                                       default_value: 'NOOP',
+                                       verify_block: proc do |value|
+                                         unless ["", "junit", "HTML", "NOOP"].include?(value)
+                                           UI.user_error!("Unsupported value '#{value}' for parameter ':format'! Available options: `junit`")
+                                         end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :include_tags,
+                                       env_name: 'FL_MAESTRO_INCLUDE_TAGS',
+                                       description: 'List of tags that will remove the Flows that does not have the provided tags',
+                                       optional: true,
+                                       type: Array),
+          FastlaneCore::ConfigItem.new(key: :output,
+                                       env_name: 'FL_MAESTRO_OUTPUT',
+                                       description: 'Allows to override the report filename. Requires parameter :format to be set as well',
+                                       optional: true,
+                                       type: String,
+                                       default_value: ''),
+          FastlaneCore::ConfigItem.new(key: :device,
+                                       env_name: 'FL_MAESTRO_DEVICE',
+                                       description: 'iOS UDID or Android device name to be used for running the tests (can also be a comma-separated list of devices)',
+                                       optional: true,
+                                       type: String,
+                                       default_value: ''),
+          FastlaneCore::ConfigItem.new(key: :tests,
+                                       env_name: 'FL_MAESTRO_TESTS',
+                                       description: 'Maestro flow (or folder containing flows) to be executed',
+                                       optional: true,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         v = File.expand_path(value.to_s)
+                                         UI.user_error!("No file or directory found with path '#{v}'") unless File.exist?(v)
+                                       end)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        [:ios, :android].include?(platform)
+
+      end
+
+      def self.category
+        :testing
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/maestro/helper/runner.rb

@@ -6,6 +6,60 @@ module Fastlane
     class Runner
 
       def self.run(options)
+        maestro_path = ENV["HOME"] + "/.maestro/bin/maestro"
+        command = [maestro_path]
+
+        unless options[:device].empty? || options[:device].nil?
+          command.push("--device", options[:device])
+          end
+
+        command.push("test")
+
+        # Flags with a value
+        {
+          config: "--config",
+          debug_output: "--debug-output",
+          exclude_tags: "--exclude-tags",
+          report_type: "--format",
+          include_tags: "--include-tags",
+          output: "--output"
+        }.each do |key, flag|
+          value = options[key]
+          next if value.nil? || value.empty?
+
+          command.push(flag, value)
+
+          # Make sure the directory exists for output files
+          FileUtils.mkdir_p(File.dirname(value)) if [:debug_output, :output].include?(key)
+        end
+
+        # Boolean flags
+        {
+          continuous: "--continuous",
+          flatten_debug_output: "--flatten-debug-output"
+        }.each do |key, flag|
+          value = options[key]
+          next if value.nil? || value.empty? || value == false
+
+          command.push(flag)
+        end
+
+        unless options[:env_vars].nil? || options[:env_vars].empty?
+          options[:env_vars].each do |key, value|
+            command.push("-e", "#{key}=\"#{value}\"")
+          end
+        end
+
+        command.push("#{options[:tests]}")
+        command_string = command.join(" ")
+        UI.message("Running command: #{command_string}")
+        Dir.chdir(ENV["PWD"]) do
+          # TODO: set exception based on parameter `failRun`
+          system(command_string, out: $stdout, err: :out, exception: true)
+        end
+      end
+
+      def self.run_deprecated(options)
         # TODO: add possibility to specify maestro path
         maestro_path = ENV["HOME"] + "/.maestro/bin/maestro"
 
@@ -25,7 +79,7 @@ module Fastlane
           # Make sure that the output folder is available
           FileUtils.mkdir_p(File.dirname(options[:output]))
         end
-        unless options[:env_vars].empty? || options[:env_vars].nil?
+        unless options[:env_vars].nil? || options[:env_vars].empty?
           options[:env_vars].each do |key, value|
             command.push("-e", "#{key}=#{value}")
           end
@@ -51,6 +105,13 @@ module Fastlane
         end
       end
 
+      def self.run_generic(cmd, flags)
+        maestro_path = ENV["HOME"] + "/.maestro/bin/maestro"
+        command = [maestro_path]
+        command.push(cmd)
+        command.push(flags)
+      end
+
       def self.command?(name)
         `which #{name}`
         $?.success?

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Maestro
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-maestro
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Marc Bormeth
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2024-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -161,6 +161,7 @@ files:
 - lib/fastlane/plugin/maestro.rb
 - lib/fastlane/plugin/maestro/actions/launch_simulator.rb
 - lib/fastlane/plugin/maestro/actions/maestro.rb
+- lib/fastlane/plugin/maestro/actions/maestro_test.rb
 - lib/fastlane/plugin/maestro/helper/runner.rb
 - lib/fastlane/plugin/maestro/version.rb
 homepage: https://github.com/inf2381/fastlane-plugin-maestro
@@ -182,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Running maestro test commands from fastlane