fastlane-plugin-saucectl 0.1.0.pre.beta.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e57867e9ee59c0310b1a657cc77cedad2b6ecd0e7baa01cb03b4862198790b0
-  data.tar.gz: e1e6583d43e376f642cec87a05d8cc8cd67d542878b142d8baa0bbac985d4ff9
+  metadata.gz: ecc67f53ebd122fc5083aeb466912f6cec328f7d5f966221c504c02577aa9534
+  data.tar.gz: c735f2e42ff6199e6429a9d8927a6164e59adce8d1e08dd6633a6bcef9e6d0fe
 SHA512:
-  metadata.gz: 74976f753280b80f14e02865179eafb767066988bfbb4ac59ff4cf9564468d29ce4a7bde7b11a642d5d03ceba8a592bcfe955479985387a763799d8d1cd6b747
-  data.tar.gz: 85ab453571d3de28d56e6ed9460708d3f5e40af21e2a1f1d24987b26caa2a9ea68e556df0080154dc2389ffe13dd7743b4b5d00bcc3c99c5a215d57cb6923806
+  metadata.gz: 5057e84ec4249ff5d9568a94838334c4324ffbc08be2d4fe83510a771b56512800adce790c8f4169eba62d30957a724401befab78c0f224e79b0db4fcf4faad6
+  data.tar.gz: 29bcaa1636728cb1915d135267233d7601901a1a6619d12c75bbef23c91dc513a470345e1306f620930c62e68b4e39ce3f43fd65228a10d5c510e6a4831b9579

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ian Hamilton <ian.ross.hamilton@gmail.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 @@
+# fastlane-plugin-saucectl
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-saucectl)
+[![Gem Version](https://badge.fury.io/rb/fastlane-plugin-saucectl.svg)](https://badge.fury.io/rb/fastlane-plugin-saucectl)
+[![Gem Downloads](https://img.shields.io/gem/dt/fastlane-plugin-saucectl?color=light-green)](https://img.shields.io/gem/dt/fastlane-plugin-saucectl)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-saucectl`, add it to your project by running:
+
+```bash
+fastlane add_plugin saucectl
+```
+
+## About fastlane-plugin-saucectl
+
+The purpose of this plugin is to simplify the set up, configuration, upload, and execution of espresso and XCUITest on the Sauce Labs platform by utilizing fastlane which will enable you to test your iOS and Android apps at scale.
+
+**IMPORTANT:** in order for you to use this plugin to execute UI tests, your test class names must proceed with `Spec`, `Specs`, `Tests`, or `Test`, for example `ExampleSpec`, `ExampleSpecs`, `ExampleTest`, `ExampleTests`. Your test case names must also begin with test, for example `testIDoSomething`, `testIDoSomethingElse`. This is so that the the plugin can search for test classes and their included test cases.
+
+Failure to do this will result in missing test classes and test cases from your test run.
+
+**For a detailed introduction to each of the actions available within this plugin, please see the [documentation](https://ianrhamilton.github.io/fastlane-plugin-saucectl/#fastlane-plugin-saucectl)**.
+
+| Available Actions   | Description                                                                                                                                                                                                  |
+|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `install_saucectl`    | Downloads the Sauce Labs saucectl cli binary for test execution. Optionally specify the [version](https://github.com/saucelabs/saucectl/releases/) you wish to install or automatically download the latest. |
+| `sauce_upload`        | Upload test artifacts to sauce labs storage                                                                                                                                                                  | 
+| `sauce_config`        | Create SauceLabs configuration file for test execution based on given parameters                                                                                                                             |
+| `sauce_runner`        | Execute automated tests on sauce labs platform via saucectl binary for specified configuration                                                                                                               | 
+| `delete_from_storage` | Delete test artifacts from sauce labs storage by storage id or group id                                                                                                                                      |
+| `sauce_apps`          | Returns the set of files by specific app id that have been uploaded to Sauce Storage by the requester                                                                                                        |
+| `sauce_devices`       | Returns a list of Device IDs for all devices in the data center that are currently free for testing.                                                                                                         |
+| `disabled_tests`      | Fetches any disabled ui test cases (for android searches for @Ignore tests, and for ios skipped tests within an xcode test plan). Plan is to use this in the future for generating pretty HTML reports       | 
+
+An order of which you may utilize the above actions in your continuous integration platform could be:
+1. Install the saucectl binary via `install_saucectl`
+2. Upload your test artifacts to Sauce Labs storage (for example app apk, and test runner apk)
+3. Create config.yml for given parameters via `sauce_config` 
+4. Execute test based on specified config via `sauce_runner`
+5. Delete test artifacts via `delete_from_storage` so that your storage does not fill up (if you're executing tests on every PR, for example)
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## 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).
+
+## Buy me a coffee
+If you're enjoying this plugin, feel free to **optionally** buy me a coffee :) 
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/ianrhamilton)

data/lib/fastlane/plugin/saucectl/actions/disabled_tests_action.rb

@@ -32,6 +32,10 @@ module Fastlane
         "Fetches any disabled ui test cases (for android searches for @Ignore tests, and for ios skipped tests within an xcode test plan). Will be used in future for generating pretty HTML reports"
       end
 
+      def self.details
+        "Fetches any disabled ui test cases (for android searches for @Ignore tests, and for ios skipped tests within an xcode test plan). Will be used in future for generating pretty HTML reports"
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :platform,

data/lib/fastlane/plugin/saucectl/actions/install_saucectl_action.rb

@@ -0,0 +1,44 @@
+require 'fastlane/action'
+require_relative '../helper/installer'
+
+module Fastlane
+  module Actions
+    class InstallSaucectlAction < Action
+      def self.run(version = nil)
+        version_message = version[:version].nil? ? 'Installing with latest version of saucectl' : "Installing saucectl with version #{version[:version]}"
+        UI.message("#{version_message} 🤖 🚀")
+        installer = Saucectl::Installer.new
+        installer.install(version)
+      end
+
+      def self.description
+        "Installs the Sauce Labs saucectl cli binary"
+      end
+
+      def self.details
+        "Optionally set the tag of the version you wish to install. If not tag is set, the latest tag will be downloaded. See: https://github.com/saucelabs/saucectl/tags "
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :version,
+                                       description: "Set the tag of saucectl you wish to install",
+                                       optional: true,
+                                       type: String)
+        ]
+      end
+
+      def self.authors
+        ["Ian Hamilton"]
+      end
+
+      def self.category
+        :testing
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb

@@ -81,6 +81,14 @@ module Fastlane
                                        description: "Array of tests to execute",
                                        optional: true,
                                        type: Array),
+          FastlaneCore::ConfigItem.new(key: :size,
+                                       description: "Instructs saucectl to run only tests that are annotated with the matching size value i.e @SmallTest, @MediumTest or @LargeTest. Valid values are small, medium, or large. You may only specify one value for this property",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :annotation,
+                                       description: "Instructs saucectl to run only tests that match a custom annotation that you have set",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :emulators,
                                        description: "The parent property that defines details for running this suite on virtual devices using an emulator",
                                        optional: true,

data/lib/fastlane/plugin/saucectl/actions/sauce_runner_action.rb

@@ -13,6 +13,10 @@ module Fastlane
         "Execute automated tests on sauce labs platform via saucectl binary for specified configuration"
       end
 
+      def self.details
+        "Execute automated tests on sauce labs platform via saucectl binary for specified configuration"
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :sauce_username,

data/lib/fastlane/plugin/saucectl/helper/espresso.rb

@@ -5,7 +5,7 @@ require_relative "file_utils"
 
 module Fastlane
   module Saucectl
-    # This class is responsible for creating test execution plans for ios applications and will distribute tests
+    # This class is responsible for creating test execution plans for android applications and will distribute tests
     # that will be be executed via the cloud provider.
     #
     class Espresso

data/lib/fastlane/plugin/saucectl/helper/installer.rb

@@ -12,11 +12,11 @@ module Fastlane
       include FileUtils
       UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
 
-      def install
-        timeout_in_seconds = 30
+      def install(version)
+        timeout_in_seconds = 90
         Timeout.timeout(timeout_in_seconds) do
           download_saucectl_installer
-          execute_saucectl_installer
+          execute_saucectl_installer(version)
           UI.success("✅ Successfully installed saucectl runner binary 🚀")
         rescue OpenURI::HTTPError => e
           response = e.io
@@ -26,13 +26,14 @@ module Fastlane
 
       def download_saucectl_installer
         URI.open('sauce', 'wb') do |file|
-          file << URI.open('https://saucelabs.github.io/saucectl/install').read
+          file << URI.open('https://saucelabs.github.io/saucectl/install', ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE).read
         end
       end
 
-      def execute_saucectl_installer
-        status = system('sh sauce')
-        status == 1 ? UI.user_error!("❌ failed to install saucectl: #{stderr}") : status
+      def execute_saucectl_installer(version)
+        saucectl_version = version[:version].nil? ? '' : "v#{version[:version]}"
+        status = system("sh sauce #{saucectl_version}")
+        status == 1 ? UI.user_error!("❌ failed to install saucectl") : status
         executable = 'saucectl'
         FileUtils.mv("bin/#{executable}", executable) unless File.exist?(executable)
       end
@@ -40,7 +41,9 @@ module Fastlane
       def system(*cmd)
         Open3.popen2e(*cmd) do |stdin, stdout_stderr, wait_thread|
           Thread.new do
-            stdout_stderr.each { |out| UI.message(out) }
+            stdout_stderr.each do |out|
+              UI.message(out)
+            end
           end
           stdin.close
           wait_thread.value

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

@@ -25,7 +25,9 @@ module Fastlane
       def system(*cmd)
         Open3.popen2e(*cmd) do |stdin, stdout_stderr, wait_thread|
           Thread.new do
-            stdout_stderr.each { |out| UI.message(out) }
+            stdout_stderr.each do |out|
+              UI.message(out)
+            end
           end
           stdin.close
           wait_thread.value

data/lib/fastlane/plugin/saucectl/helper/suites.rb

@@ -60,16 +60,7 @@ module Fastlane
         elsif @config[:test_class]
           custom_test_classes
         else
-          test_suites = []
-          @config[:emulators].each do |emulator|
-            test_distribution_array.each do |test_type|
-              test_suites << {
-                'name' => suite_name(test_type).downcase,
-                'testOptions' => default_test_options(test_type)
-              }.merge(virtual_device_options(emulator))
-            end
-          end
-          test_suites
+          default_execution_suite
         end
       end
 
@@ -133,17 +124,34 @@ module Fastlane
         elsif @config[:test_class].kind_of?(Array)
           custom_test_classes
         else
-          test_suites = []
-          @config[:devices].each do |device|
+          default_execution_suite
+        end
+      end
+
+      def default_execution_suite
+        type = @config[:annotation] ? 'annotation' : 'size'
+        UI.user_error!("❌ execution by #{type} is not supported on the iOS platform!") if @config[:platform].eql?('ios') && (@config[:size] || @config[:annotation])
+        is_real_device = @config[:devices]
+        test_devices = @config[:devices] || @config[:emulators]
+        test_suites = []
+        if @config[:size] || @config[:annotation]
+          test_devices.each do |device|
+            test_suites << {
+              'name' => suite_name(@config[:size] || @config[:annotation]).downcase,
+              'testOptions' => default_test_options(@config[:size])
+            }.merge(is_real_device ? real_device_options(device) : virtual_device_options(device))
+          end
+        else
+          test_devices.each do |device|
             test_distribution_array.each do |test_type|
               test_suites << {
                 'name' => suite_name(test_type).downcase,
                 'testOptions' => default_test_options(test_type)
-              }.merge(real_device_options(device))
+              }.merge(is_real_device ? real_device_options(device) : virtual_device_options(device))
             end
           end
-          test_suites
         end
+        test_suites
       end
 
       def virtual_device_options(device)
@@ -182,14 +190,24 @@ module Fastlane
       end
 
       def default_test_options(test_type)
-        test_option_type = @config[:test_distribution].eql?('package') ? 'package' : 'class'
         if @config[:platform] == 'android'
-          { test_option_type => test_type }.merge(android_test_options)
+          test_option_type(test_type)
         else
           { 'class' => test_type }
         end
       end
 
+      def test_option_type(test_type)
+        if @config[:size] || @config[:annotation]
+          key = @config[:size] ? 'size' : 'annotation'
+          value = @config[:size] || @config[:annotation]
+          { key => value }.merge(android_test_options)
+        else
+          test_option_type = @config[:test_distribution].eql?('package') ? 'package' : 'class'
+          { test_option_type => test_type }.merge(android_test_options)
+        end
+      end
+
       def android_test_options
         {
           'clearPackageData' => @config[:clear_data],

data/lib/fastlane/plugin/saucectl/strings/messages.yml

@@ -0,0 +1,12 @@
+---
+platform_error: "No platform specified, set using: platform: 'android'"
+app_path_error: "No App path given, set using: app_path: 'path/to/my/testApp.apk'"
+file_error: "No file path given, set using: app_path: 'path/to/my/testApp.apk'"
+app_name_error: "No App name given, set using: app_name: 'testApp.apk'"
+test_runner_app_error: "No Test runner application given, set using: test_runner_app: 'testRunnerApp.apk'"
+region_error: "$region is an invalid region. Supported regions are 'us' and 'eu'"
+sauce_username_error: "No sauce labs username provided, set using: sauce_username: 'sauce user name', or consider setting your credentials as environment variables."
+sauce_api_key_error: "No sauce labs access key provided, set using: sauce_access_key: '1234' or consider setting your credentials as environment variables."
+supported_regions: ['us', 'eu']
+accepted_file_types: ['.apk', '.aab', '.ipa', '.zip']
+missing_file_name: "Please specify the name of the app that you wish to query on sauce storage"

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Saucectl
-    VERSION = "0.1.0-beta.2"
+    VERSION = '0.1.1'.freeze
   end
 end

data/lib/fastlane/plugin/saucectl.rb

@@ -1,11 +1,9 @@
-require 'fastlane'
+require 'fastlane/plugin/saucectl/version'
 
 module Fastlane
   module Saucectl
-    UI = FastlaneCore::UI
-    # Return all .rb files inside the "actions" and "helper" directory
     def self.all_classes
-      Dir[File.expand_path('**/actions/*_action.rb', File.dirname(__FILE__))]
+      Dir[File.expand_path('*/{actions,helper}/*.rb', File.dirname(__FILE__))]
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-saucectl
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.beta.2
+  version: 0.1.1
 platform: ruby
 authors:
 - Ian Hamilton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,10 +170,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/fastlane/plugin/saucectl.rb
 - lib/fastlane/plugin/saucectl/actions/delete_from_storage_action.rb
 - lib/fastlane/plugin/saucectl/actions/disabled_tests_action.rb
-- lib/fastlane/plugin/saucectl/actions/install_toolkit_action.rb
+- lib/fastlane/plugin/saucectl/actions/install_saucectl_action.rb
 - lib/fastlane/plugin/saucectl/actions/sauce_apps_action.rb
 - lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb
 - lib/fastlane/plugin/saucectl/actions/sauce_devices_action.rb
@@ -188,6 +190,7 @@ files:
 - lib/fastlane/plugin/saucectl/helper/storage.rb
 - lib/fastlane/plugin/saucectl/helper/suites.rb
 - lib/fastlane/plugin/saucectl/helper/xctest.rb
+- lib/fastlane/plugin/saucectl/strings/messages.yml
 - lib/fastlane/plugin/saucectl/version.rb
 homepage: https://github.com/ianrhamilton/fastlane-plugin-saucectl
 licenses:
@@ -202,15 +205,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.10
 signing_key:
 specification_version: 4
-summary: Test your iOS and and Android apps at scale using Sauce Labs toolkit.
+summary: Simplify the set up, configuration, upload, and execution of espresso and
+  XCUITest on the Sauce Labs platform by utilizing fastlane which will enable you
+  to test your iOS and Android apps at scale.
 test_files: []

data/lib/fastlane/plugin/saucectl/actions/install_toolkit_action.rb

@@ -1,30 +0,0 @@
-require 'fastlane/action'
-require_relative '../helper/installer'
-
-module Fastlane
-  module Actions
-    class InstallToolkitAction < Action
-      def self.run(param = '')
-        UI.message("Installing saucectl 🤖 🚀")
-        installer = Saucectl::Installer.new
-        installer.install
-      end
-
-      def self.description
-        "Installs the Sauce Labs saucectl cli binary"
-      end
-
-      def self.authors
-        ["Ian Hamilton"]
-      end
-
-      def self.category
-        :testing
-      end
-
-      def self.is_supported?(platform)
-        [:ios, :android].include?(platform)
-      end
-    end
-  end
-end