fastlane-plugin-saucectl 0.1.3.pre → 0.1.3

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

@@ -0,0 +1,166 @@
+require 'base64'
+require 'fastlane'
+require 'fastlane_core/ui/ui'
+require_relative 'espresso'
+require_relative 'xctest'
+
+module Fastlane
+  module Saucectl
+    #
+    # This class will create test suites for ios applications based on user specified configuration properties
+    #
+    class IosSuites
+      include FileUtils
+
+      UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+      def initialize(config)
+        UI.user_error!("❌ For the ios platform you must specify `devices` array") if config[:devices].nil?
+        UI.user_error!("❌ #{config[:kind]} is not a supported test framework for iOS. Use xcuitest") unless config[:kind].eql?('xcuitest')
+        @config = config
+      end
+
+      def generate
+        check_for_android_params
+
+        if @config[:test_distribution] || @config[:test_plan]
+          create_test_distribution_suite
+        elsif @config[:test_class].kind_of?(Array)
+          custom_test_class_suite
+        else
+          test_runner_suite
+        end
+      end
+
+      def check_for_android_params
+        type = @config[:annotation] ? 'annotation' : 'size'
+        UI.user_error!("❌ execution by #{type} is not supported on the iOS platform!") if @config[:size] || @config[:annotation]
+      end
+
+      def create_test_distribution_suite
+        if @config[:test_distribution].eql?('shard')
+          shard_real_device_suites
+        else
+          test_distribution_suite
+        end
+      end
+
+      def test_distribution_array
+        @config[:test_class] || Fastlane::Saucectl::XCTest.new(@config).test_distribution
+      end
+
+      def suite_name(name)
+        if ENV['JOB_NAME'].nil? && ENV['BUILD_NUMBER'].nil?
+          "#{@config[:kind]}-#{name}"
+        else
+          "#{ENV['JOB_NAME']}-#{ENV['BUILD_NUMBER']}-#{name}"
+        end
+      end
+
+      def shard_real_device_suites
+        test_suites = []
+        arr = test_distribution_array
+        shards = arr.each_slice((arr.size / @config[:devices].size.to_f).round).to_a
+        shards.each_with_index do |suite, i|
+          device_name = @config[:devices][i].key?(:id) ? @config[:devices][i][:id] : @config[:devices][i][:name]
+          test_suites << {
+            'name' => suite_name("#{device_name}-shard-#{i + 1}").downcase,
+            'testOptions' => default_test_options(suite)
+          }.merge(real_device_options(@config[:devices][i]))
+        end
+        test_suites
+      end
+
+      def test_runner_suite
+        test_suites = []
+        @config[:devices].each do |device|
+          device_name = device.key?(:id) ? device[:id] : device[:name]
+          test_suites << {
+            'name' => suite_name(device_name),
+            'testOptions' => default_test_options(nil)
+          }.merge(real_device_options(device))
+        end
+        test_suites
+      end
+
+      def custom_test_class_suite
+        test_suites = []
+        @config[:devices].each do |device|
+          device_options = real_device_options(device)
+          test_classes = @config[:test_class].reject(&:empty?).join(',')
+          test_suites << {
+            'name' => suite_name(device[:name]).downcase,
+            'testOptions' => default_test_options(test_classes.split(','))
+          }.merge(device_options)
+        end
+        test_suites
+      end
+
+      def test_distribution_suite
+        test_suites = []
+        if @config[:test_plan]
+          @config[:devices].each do |device|
+            test_suites << {
+              'name' => suite_name(@config[:test_plan]).downcase,
+              'testOptions' => default_test_options(test_distribution_array)
+            }.merge(real_device_options(device))
+          end
+        else
+          @config[: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))
+            end
+          end
+        end
+        test_suites
+      end
+
+      def test_plan_distribution
+        test_suites = []
+        @config[:devices].each do |device|
+          test_suites << {
+            'name' => suite_name(@config[:test_plan]).downcase,
+            'testOptions' => default_test_options(test_distribution_array)
+          }.merge(real_device_options(device))
+        end
+        test_suites
+      end
+
+      def real_device_options(device)
+        { 'devices' => [rdc_options(device)] }
+      end
+
+      def rdc_options(device)
+        device_type_key = device.key?(:id) ? 'id' : 'name'
+        name = device.key?(:id) ? device[:id] : device[:name]
+        base_device_hash = {
+          device_type_key => name,
+          'orientation' => device[:orientation]
+        }.merge('options' => device_options(device))
+
+        unless device[:platform_version].nil?
+          base_device_hash = base_device_hash.merge({ 'platformVersion' => device[:platform_version] })
+        end
+
+        base_device_hash
+      end
+
+      def device_options(device)
+        {
+          'carrierConnectivity' => device[:carrier_connectivity],
+          'deviceType' => device[:device_type].upcase!,
+          'private' => device[:private]
+        }
+      end
+
+      def default_test_options(test_type)
+        unless test_type.nil?
+          { 'class' => test_type }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'fastlane'
+require 'open3'
+require 'fastlane_core/ui/ui'
+require_relative "file_utils"
+
+module Fastlane
+  module Saucectl
+    #
+    # This class provides the ability to execute tests via configured specifications and capture the output of the sauce executable.
+    #
+    class Runner
+      include FileUtils
+      EXECUTABLE = 'saucectl'
+      UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+      def execute
+        unless File.exist?(EXECUTABLE)
+          UI.user_error!("❌ sauce labs executable file does not exist! Expected sauce executable file to be located at:'#{Dir.pwd}/#{EXECUTABLE}'")
+        end
+
+        system("chmod +x #{EXECUTABLE}")
+        system("./#{EXECUTABLE} run")
+      end
+
+      def system(*cmd)
+        Open3.popen2e(*cmd) do |stdin, stdout_stderr, wait_thread|
+          Thread.new do
+            stdout_stderr.each do |out|
+              message = out.gsub(/(?:\[[^\]].*\])|(?:\(\d{4}\))/, '')
+              puts(message)
+            end
+          end
+          stdin.close
+          wait_thread.value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require 'uri'
+require 'net/http'
+require 'json'
+require_relative 'api'
+
+module Fastlane
+  module Saucectl
+    # This class provides the ability to store, delete, and retrieve data from the Sauce Labs Storage API
+    class Storage
+      def initialize(config)
+        @config = config
+      end
+
+      # Get App Storage Files
+      # @return the set of files that have been uploaded to Sauce Storage by the requester.
+      def retrieve_all_apps
+        api = Fastlane::Saucectl::Api.new(@config)
+        api.retrieve_all_apps
+      end
+
+      # Delete app by the Sauce Labs identifier of the stored file. You can look up file IDs using the Get App Storage Files endpoint.
+      # https://docs.saucelabs.com/dev/api/storage/#get-app-storage-files
+      # @return json response containing the file id and the number of files deleted.
+      def delete_app_with_file_id
+        api = Fastlane::Saucectl::Api.new(@config)
+        api.delete_app("v1/storage/files/#{@config[:app_id]}")
+      end
+
+      # Deletes the specified group of files from Sauce Storage.
+      # The Sauce Labs identifier of the group of files. You can look up file IDs using the Get App Storage Groups endpoint.
+      # https://docs.saucelabs.com/dev/api/storage/#get-app-storage-groups
+      # @return json response containing the group ID and the number of files deleted.
+      def delete_all_apps_for_group_id
+        path = "v1/storage/files/#{@config[:group_id]}"
+        api = Fastlane::Saucectl::Api.new(@config)
+        api.delete_app(path)
+      end
+
+      # Uploads an application file to Sauce Storage for the purpose of mobile application testing
+      # @return a unique file ID assigned to the app.
+      def upload_app
+        Fastlane::Saucectl::Api.new(@config).upload
+      end
+    end
+  end
+end

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

@@ -0,0 +1,168 @@
+require "find"
+require "open3"
+require "json"
+require_relative "file_utils"
+
+module Fastlane
+  module Saucectl
+    # This class is responsible for creating test execution plans for ios applications and will distribute tests
+    # that will be be executed via the cloud provider.
+    #
+    class XCTest
+      include FileUtils
+      UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+      TEST_FUNCTION_REGEX = /(test+[A-Z][a-zA-Z]+)[(][)]/.freeze
+
+      def initialize(config)
+        @config = config
+      end
+
+      def test_plan_exists?
+        File.exist?(Dir["**/#{@config[:test_plan]}.xctestplan"][0])
+      rescue StandardError
+        false
+      end
+
+      def valid_test_plan?
+        File.exist?(Dir["**/#{@config[:test_plan]}.xctestplan"][0])
+      rescue StandardError
+        UI.user_error!("#{@config[:test_plan]} was not found in workspace")
+      end
+
+      def fetch_test_plan
+        plan_path = Dir["**/#{@config[:test_plan]}.xctestplan"][0]
+        selected = File.read(plan_path)
+        JSON.parse(selected)["testTargets"][0]
+      end
+
+      def fetch_target_from_test_plan
+        fetch_test_plan["target"]["name"]
+      end
+
+      def test_data
+        if test_plan_exists?
+          valid_test_plan?
+          if fetch_test_plan.include?("skippedTests")
+            strip_skipped(all_tests)
+          else
+            fetch_selected_tests
+          end
+        else
+          all_tests
+        end
+      end
+
+      def test_target
+        @config[:test_target].nil? ? fetch_target_from_test_plan : @config[:test_target]
+      end
+
+      def test_distribution
+        test_distribution_check
+        tests_arr = []
+
+        test_distribution = @config[:test_plan].nil? ? @config[:test_distribution] : 'testPlan'
+        case test_distribution
+        when 'testCase', 'testPlan'
+          test_data.each do |type|
+            type[:tests].each { |test| tests_arr << "#{test_target.tr(" ", "_")}.#{type[:class]}/#{test}" }
+          end
+        else
+          test_data.each do |type|
+            tests_arr << "#{test_target.tr(" ", "_")}.#{type[:class]}"
+          end
+        end
+        tests_arr.uniq
+      end
+
+      def test_distribution_check
+        return @config[:test_distribution] if @config[:test_distribution].kind_of?(Array)
+
+        distribution_types = %w[class testCase shard]
+        unless distribution_types.include?(@config[:test_distribution]) || @config[:test_distribution].nil?
+          UI.user_error!("#{@config[:test_distribution]} is not a valid method of test distribution. \n Supported types for iOS: \n #{distribution_types}")
+        end
+      end
+
+      def fetch_selected_tests
+        ui_tests = []
+        fetch_test_plan["selectedTests"].each do |test|
+          test_case = test.gsub('/', ' ').split
+          ui_tests << { class: test_case[0], tests: [test_case[1].gsub(/[()]/, "").to_s] }
+        end
+        ui_tests
+      end
+
+      def strip_skipped(all_tests)
+        enabled_ui_tests = []
+        skipped_tests = fetch_disabled_tests
+        all_tests.each do |tests|
+          tests[:tests].each do |test|
+            unless skipped_tests.to_s.include?(test)
+              enabled_ui_tests << { class: tests[:class].to_s, tests: [test] }
+            end
+          end
+        end
+        enabled_ui_tests
+      end
+
+      def fetch_disabled_tests
+        skipped = fetch_test_plan["skippedTests"]
+        ui_tests = []
+        skipped.each do |item|
+          if item.include?('/')
+            test_case = item.gsub('/', ' ').split
+            ui_tests << sort_ui_tests(test_case[0], test_case[1])
+          else
+            ui_tests << scan_test_class(item)
+          end
+        end
+        ui_tests
+      end
+
+      def sort_ui_tests(cls, test_case)
+        { class: cls, tests: test_case.gsub(/[()]/, "").to_s }
+      end
+
+      def all_tests
+        test_details = []
+        test_dir = Dir["**/#{test_target}"][0]
+        search_retrieve_test_classes(test_dir).each do |f|
+          next unless File.basename(f) =~ CLASS_NAME_REGEX
+
+          test_details << { class: File.basename(f).gsub(FILE_TYPE_REGEX, ""), tests: tests_from(f) }
+        end
+
+        strip_empty(test_details)
+      end
+
+      def scan_test_class(cls)
+        test_details = []
+        test_dir = Dir["**/#{test_target}"][0]
+        search_retrieve_test_classes(test_dir).each do |f|
+          next unless File.basename(f) =~ /#{cls}/
+
+          test_details << { class: File.basename(f).gsub(FILE_TYPE_REGEX, ""), tests: tests_from(f) }
+        end
+
+        strip_empty(test_details)
+      end
+
+      def tests_from(path)
+        stdout, = find(path, "func")
+        test_cases = []
+        stdout.split.each do |line|
+          test_cases << line.match(TEST_FUNCTION_REGEX).to_s.gsub(/[()]/, "") if line =~ TEST_FUNCTION_REGEX
+        end
+        test_cases
+      end
+
+      def strip_empty(test_details)
+        tests = []
+        test_details.each do |test|
+          tests << test unless test[:tests].size.zero?
+        end
+        tests
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Saucectl
+    VERSION = '0.1.3'.freeze
+  end
+end

data/lib/fastlane/plugin/saucectl.rb

@@ -0,0 +1,15 @@
+require 'fastlane/plugin/saucectl/version'
+
+module Fastlane
+  module Saucectl
+    def self.all_classes
+      Dir[File.expand_path('*/{actions,helper}/*.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::Saucectl.all_classes.each do |current|
+  require current
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-saucectl
 version: !ruby/object:Gem::Version
-  version: 0.1.3.pre
+  version: 0.1.3
 platform: ruby
 authors:
 - Ian Hamilton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,7 +169,30 @@ email: ian.ross.hamilton@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-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_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
+- lib/fastlane/plugin/saucectl/actions/sauce_runner_action.rb
+- lib/fastlane/plugin/saucectl/actions/sauce_upload_action.rb
+- lib/fastlane/plugin/saucectl/helper/android_suites.rb
+- lib/fastlane/plugin/saucectl/helper/api.rb
+- lib/fastlane/plugin/saucectl/helper/config.rb
+- lib/fastlane/plugin/saucectl/helper/espresso.rb
+- lib/fastlane/plugin/saucectl/helper/file_utils.rb
+- lib/fastlane/plugin/saucectl/helper/installer.rb
+- lib/fastlane/plugin/saucectl/helper/ios_suites.rb
+- lib/fastlane/plugin/saucectl/helper/runner.rb
+- lib/fastlane/plugin/saucectl/helper/storage.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:
 - MIT
@@ -183,15 +206,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: []