fastlane-plugin-maestro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37f335eafb373f14938384183d72cb7163b04af56c657b6ba278476fb2f34a68
+  data.tar.gz: 6215b246874984611ee549ea6f5b5cf0dd77a36b81aae67f0f9d7f48aaac3e8a
+SHA512:
+  metadata.gz: f0ca71d04d9781a0534088d3ece247467d3730e93ba6dffbf975a0f05860936053a22c5901a2e29172c1ebba6b39fd5109a82ec82434f56ceae64b9e63aa33ce
+  data.tar.gz: 5b1c7b72c864462d8240be53e306386ef2767aa4712a3786644ab0b589bb339a62a0b48f71369abfa2a97efbd23ad282a6303cb9b0235f2b862371f6fd99a4fe

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Marc Bormeth <marc.bormeth@icloud.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+🧪 Maestro fastlane plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-maestro)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started
+with `fastlane-plugin-maestro`, add it to your project by adding the following line to your `Pluginfile`:
+
+```ruby
+gem "fastlane-plugin-maestro", git: "https://github.com/inf2381/fastlane-plugin-maestro.git", branch: "main"
+```
+
+## 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`
+
+Additionally to the maestro action, this plugin provides an action to start an iOS simulator and install a given .app
+file to it.
+
+## Examples
+
+Create a simulator, install a .app file on it and patch the device for testing
+
+```ruby
+app = File.realpath(Dir["../**/*.app"].first)
+
+device = launch_simulator(
+  app_path: app,
+  device_name: "iPhone 14",
+  language: "en-US"
+)
+```
+
+Run all flows defined in the folder .maestro/screenshot
+
+```ruby
+maestro(
+  command: 'test',
+  directory: '.maestro/screenshot',
+  report_type: 'junit'
+)
+```
+
+Install maestro
+
+```ruby
+maestro(
+  command: 'install'
+)
+```
+
+Download the samples
+
+```ruby
+maestro(
+  command: 'download_samples'
+)
+```
+
+For other examples, please have a look at the [Fastfile of this repository](./fastlane/Fastfile)
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out
+the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out
+the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more,
+check out [fastlane.tools](https://fastlane.tools).

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

@@ -0,0 +1,105 @@
+require 'fastlane/action'
+require 'fileutils'
+require 'simctl'
+
+module Fastlane
+  module Actions
+    class LaunchSimulatorAction < Action
+      def self.run(params)
+        device_type = SimCtl.devicetype(name: params[:device_name])
+        device_name = "Maestro - #{params[:device_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]}"
+        end
+        runtime = SimCtl.runtime(name: runtime_name)
+        UI.message("Creating device #{device_name} with runtime #{runtime_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 }
+
+        unless params[:language].nil? || params[:language].empty?
+          UI.message("Setting device language to #{params[:language]}")
+          device.settings.set_language(params[:language])
+          device.settings.set_locale(params[:language])
+        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,
+          dataNetwork: '5g',
+          wifiMode: 'active',
+          cellularMode: 'active',
+          batteryState: 'charging',
+          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
+        'Prepares an iOS simulator for Maestro testing'
+      end
+
+      def self.authors
+        ['Marc Bormeth']
+      end
+
+      def self.return_value
+        "Object of [SimCtl::Device](https://www.rubydoc.info/gems/simctl/SimCtl/Device)"
+      end
+
+      def self.details
+        'Creates a simulator for the given `:ios_version` and `:device`. \nAfterwards, it patches the language, locale & status bar and installs the given :app on it.'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :app_path,
+                                        env_name: "FL_APP_PATH",
+                                        description: "Path to the .app file for simulators",
+                                        type: String,
+                                        default_value: ""),
+          FastlaneCore::ConfigItem.new(key: :ios_version,
+                                        description: "iOS runtime version to be used for the simulator",
+                                        short_option: "-i", # same as for scan
+                                        optional: true,
+                                        default_value: ''),
+          FastlaneCore::ConfigItem.new(key: :language,
+                                        description: "The language which should be used",
+                                        short_option: "-g", # same as for scan
+                                        type: String,
+                                        default_value: 'en-US',
+                                        optional: true),
+          FastlaneCore::ConfigItem.new(key: :device_name,
+                                        short_option: "-a", # same as for scan
+                                        optional: false,
+                                        type: String,
+                                        env_name: "MAESTRO_DEVICE",
+                                        description: "The name of the simulator type you want to run tests on (e.g. 'iPhone 14' or 'iPhone SE (2nd generation) (14.5)')")
+        ]
+      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
+  end
+end

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

@@ -0,0 +1,118 @@
+require 'fastlane/action'
+require 'fileutils'
+
+require_relative '../helper/runner'
+
+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
+        end
+      end
+
+      def self.check_ios_dependencies!
+        UI.message("Making sure you installed the dependencies to run Maestro…")
+        return if `find #{ENV["HOMEBREW_REPOSITORY"]} -iname "idb_companion"`.include?('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!("Pleas 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
+        'Installs / updates Maestro or runs maestro test depending on the parameter `:command`'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :command,
+                                       env_name: 'FL_MAESTRO_COMMAND',
+                                       description: 'Command to be executed (`download_samples`, `install`, or `test`)',
+                                       type: String,
+                                       default_value: 'test',
+                                       verify_block: proc do |value|
+                                         unless ["download_samples", "install", "test"].include?(value)
+                                           UI.user_error!("Unsupported value '#{value}' for parameter ':command'! \nAvailable options: `download_samples`, `install`, `test`")
+                                         end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :report_type,
+                                       env_name: 'FL_MAESTRO_FORMAT',
+                                       description: 'Format of the generated report (`junit`)',
+                                       optional: true,
+                                       type: String,
+                                       default_value: '',
+                                       verify_block: proc do |value|
+                                         unless ["", "junit"].include?(value)
+                                           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)
+        ]
+      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

@@ -0,0 +1,46 @@
+require 'fastlane_core/print_table'
+
+HighLine.track_eof = false
+module Fastlane
+  module Maestro
+    class Runner
+
+      def self.run(options)
+        # TODO: add possibility to specify maestro path
+        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")
+
+        unless options[:report_type].empty? || options[:report_type].nil?
+          command.push("--format", options[:report_type])
+        end
+        unless options[:output].empty? || options[:output].nil?
+          command.push("--output", options[:output])
+          # Make sure that the output folder is available
+          FileUtils.mkdir_p(File.dirname(options[:output]))
+        end
+
+        command.push("#{options[:tests]}")
+        command_string = command.join(" ")
+        UI.message("Running command: #{command_string}")
+        # TODO: set exception based on parameter `failRun`
+        system(command_string, out: $stdout, err: :out, exception: true)
+      end
+
+      def self.install
+        system("curl -Ls 'https://get.maestro.mobile.dev' | bash", out: $stdout, err: :out, exception: true)
+      end
+
+      def self.download_samples
+        maestro_path = ENV["HOME"] + "/.maestro/bin/maestro"
+        system("#{maestro_path} download-samples", out: $stdout, err: :out, exception: true)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Maestro
+    VERSION = "0.0.1"
+  end
+end

data/lib/fastlane/plugin/maestro.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/maestro/version'
+
+module Fastlane
+  module Maestro
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Maestro.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-maestro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marc Bormeth
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simctl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: marc.bormeth@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/maestro.rb
+- lib/fastlane/plugin/maestro/actions/launch_simulator.rb
+- lib/fastlane/plugin/maestro/actions/maestro.rb
+- lib/fastlane/plugin/maestro/helper/runner.rb
+- lib/fastlane/plugin/maestro/version.rb
+homepage: https://github.com/inf2381/fastlane-plugin-maestro
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Running maestro test commands from fastlane
+test_files: []