fastlane-plugin-saucectl 0.1.3.pre → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfe7383a6621d0f63d8b47202f757eff6873b3eb2fdd9b2482de329fe4aa81f1
-  data.tar.gz: faa221723b72ad9b14583c0bbcef9b0a547cdf8158f9947b8be4c420b96a249f
+  metadata.gz: 6ab968db699553cb2d744fe26a66dcd3e02b56e796935092b408d04ec2b5566b
+  data.tar.gz: c5c3cbf2f72e159be64c0a47f025e11136c24285260488a12699322f88892caf
 SHA512:
-  metadata.gz: 385e2b1b519e2c90e2b9fd70dc25912040e5ac9c913dc0992111d17266beab22647dc6808532dc191b85f10ccdb3f877b400880a62a05d08a70ff68c77816257
-  data.tar.gz: 182fb2ec4023e3d6a2dac3623a0b34ebf19cec8ba9e40d55867ceb29063439fcbb215033dcd1a04f6dafe16fe9b236a31943672e340b06151bd8c558d89acb34
+  metadata.gz: c26a558fa620c0c8f6cc20f9739b6ad7e8dc5382b1a82b88a2439b10f9621fae7d45a92b54c085c2d19a2b249f2d75155ef96d67d0051ef223b4d36cdffa3497
+  data.tar.gz: cc8dfb29b8d3576dffba855245a140e43a3809ea337c0ddf5c8a1d14844b5f31f9a89d254c159127e70647c5f6593a1659f4d9a5d2724c6bde2f8cb2562de559

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/delete_from_storage_action.rb

@@ -0,0 +1,96 @@
+require 'fastlane/action'
+require 'json'
+require 'yaml'
+require_relative '../helper/api'
+require_relative '../helper/storage'
+
+module Fastlane
+  module Actions
+    class DeleteFromStorageAction < Action
+      @messages = YAML.load_file("#{__dir__}/../strings/messages.yml")
+
+      def self.run(params)
+        if params[:group_id].nil?
+          Fastlane::Saucectl::Storage.new(params).delete_app_with_file_id
+        else
+          Fastlane::Saucectl::Storage.new(params).delete_all_apps_for_group_id
+        end
+      end
+
+      def self.description
+        "Delete test artifacts from sauce labs storage"
+      end
+
+      def self.details
+        "Delete test artifacts from sauce labs storage by storage id or group id"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :region,
+                                       description: "Data Center region (us or eu), set using: region: 'eu'",
+                                       optional: false,
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!(@messages['region_error'].gsub!('$region', value)) if value.empty? || !@messages['supported_regions'].include?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :sauce_username,
+                                       env_name: "SAUCE_USERNAME",
+                                       description: "Your sauce labs username in order to authenticate delete file from app storage",
+                                       default_value: Actions.lane_context[SharedValues::SAUCE_USERNAME],
+                                       optional: false,
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!(@messages['sauce_username_error']) if value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :sauce_access_key,
+                                       env_name: "SAUCE_ACCESS_KEY",
+                                       description: "Your sauce labs access key in order to authenticate delete file from app storage",
+                                       default_value: Actions.lane_context[SharedValues::SAUCE_ACCESS_KEY],
+                                       optional: false,
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!(@messages['sauce_api_key_error']) if value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :app_id,
+                                       description: "The application id from sauce labs storage",
+                                       optional: true,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :group_id,
+                                       description: "The group id for sauce labs storage",
+                                       optional: true,
+                                       is_string: true)
+        ]
+      end
+
+      def self.authors
+        ["Ian Hamilton"]
+      end
+
+      def self.category
+        :testing
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+
+      def self.example_code
+        [
+          "delete_from_storage(
+            region: 'eu',
+            sauce_username: 'sauce username',
+            sauce_access_key: 'sauce api name',
+            app_id: '1234-1234-1234-1234'
+          )",
+          "delete_from_storage(
+            region: 'eu',
+            sauce_username: 'sauce username',
+            sauce_access_key: 'sauce api name',
+            group_id: '123456789'
+          )"
+        ]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+require 'fastlane/action'
+require 'json'
+require 'yaml'
+require_relative '../helper/espresso'
+require_relative '../helper/xctest'
+
+module Fastlane
+  module Actions
+    class DisabledTestsAction < Action
+      @messages = YAML.load_file("#{__dir__}/../strings/messages.yml")
+
+      def self.run(params)
+        verify_config(params)
+        if params[:platform].eql?('android')
+          params[:path_to_tests] ? params[:path_to_tests] : params[:path_to_tests] = "app/src/androidTest"
+          Fastlane::Saucectl::Espresso.new(params).fetch_disabled_tests(params[:path_to_tests])
+        else
+          Fastlane::Saucectl::XCTest.new(params).fetch_disabled_tests
+        end
+      end
+
+      def self.verify_config(params)
+        if params[:platform].eql?('ios') && params[:test_plan].nil?
+          UI.user_error!('Cannot get skipped tests for an ios project without a known test_plan')
+        end
+        if params[:platform].eql?('android') && !params[:test_plan].nil?
+          UI.user_error!('test_plan option is reserved for ios projects only')
+        end
+      end
+
+      def self.description
+        "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,
+                                       description: "application under test platform (ios or android)",
+                                       optional: false,
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!(@messages['platform_error']) if value.to_s.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :path_to_tests,
+                                       description: "Android only, path to espresso tests. Default to app/src/androidTest",
+                                       optional: true,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :test_plan,
+                                       description: "Name of xcode test plan",
+                                       optional: true,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :test_target,
+                                       description: "Name of xcode test target",
+                                       optional: true,
+                                       is_string: true)
+        ]
+      end
+
+      def self.authors
+        ["Ian Hamilton"]
+      end
+
+      def self.category
+        :testing
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+
+      def self.example_code
+        [
+          "disabled_tests({ platform: 'android',
+                            path_to_tests: 'my-demo-app-android/app/src/androidTest'
+          })",
+          "disabled_tests({ platform: 'ios',
+                            test_plan: 'UITests'
+          })",
+          "disabled_tests({ platform: 'ios',
+                            test_plan: 'UITests'
+          })"
+        ]
+      end
+    end
+  end
+end

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_apps_action.rb

@@ -0,0 +1,96 @@
+require 'fastlane/action'
+require 'json'
+require 'yaml'
+require_relative '../helper/api'
+
+module Fastlane
+  module Actions
+    class SauceAppsAction < Action
+      @messages = YAML.load_file("#{__dir__}/../strings/messages.yml")
+      def self.run(params)
+        Fastlane::Saucectl::Api.new(params).retrieve_all_apps
+      end
+
+      def self.description
+        "Returns the set of files by specific app id that have been uploaded to Sauce Storage by the requester"
+      end
+
+      def self.details
+        "Returns the set of files by specific app id that have been uploaded to Sauce Storage by the requester"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :platform,
+                                       description: "application under test platform (ios or android)",
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!(@messages['platform_error']) if value.to_s.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :query,
+                                       description: "Any search term (such as build number or file name) by which you want to filter results",
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!(@messages['missing_file_name']) if value.to_s.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :region,
+                                       description: "Data Center region (us or eu), set using: region: 'eu'",
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!(@messages['region_error'].gsub!('$region', value)) unless @messages['supported_regions'].include?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :sauce_username,
+                                       env_name: "SAUCE_USERNAME",
+                                       description: "Your sauce labs username in order to authenticate upload requests",
+                                       default_value: Actions.lane_context[SharedValues::SAUCE_USERNAME],
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!(@messages['sauce_username_error']) unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :sauce_access_key,
+                                       env_name: "SAUCE_ACCESS_KEY",
+                                       description: "Your sauce labs access key in order to authenticate upload requests",
+                                       default_value: Actions.lane_context[SharedValues::SAUCE_ACCESS_KEY],
+                                       optional: false,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!(@messages['sauce_api_key_error']) unless value && !value.empty?
+                                       end)
+        ]
+      end
+
+      def self.authors
+        ["Ian Hamilton"]
+      end
+
+      def self.category
+        :testing
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+
+      def self.example_code
+        [
+          "sauce_apps({platform: 'android',
+                       query: 'test.apk',
+                       region: 'eu',
+                       sauce_username: 'foo',
+                       sauce_access_key: 'bar123',
+                     })",
+          "sauce_apps({platform: 'ios',
+                       query: 'test.app',
+                       region: 'eu',
+                       sauce_username: 'foo',
+                       sauce_access_key: 'bar123',
+                     })"
+        ]
+      end
+    end
+  end
+end