fastlane-plugin-saucectl 0.1.0.pre

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

@@ -0,0 +1,36 @@
+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 { |out| UI.message(out) }
+          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/suites.rb

@@ -0,0 +1,201 @@
+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 based on user specified configuration properties
+    #
+    class Suites
+      include FileUtils
+
+      UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+      def initialize(config)
+        @config = config
+      end
+
+      def create_test_plan
+        check_kind
+        if @config[:platform].casecmp('ios').zero?
+          is_ios_reqs_satisfied?
+          Fastlane::Saucectl::XCTest.new(@config)
+        else
+          Fastlane::Saucectl::Espresso.new(@config)
+        end
+      end
+
+      def check_kind
+        if @config[:platform].eql?('android')
+          UI.user_error!("❌ #{@config[:kind]} is not a supported test framework for android. Use espresso") unless @config[:kind].eql?('espresso')
+        else
+          UI.user_error!("❌ #{@config[:kind]} is not a supported test framework for iOS. Use xcuitest") unless @config[:kind].eql?('xcuitest')
+        end
+      end
+
+      def is_ios_reqs_satisfied?
+        if @config[:test_target].nil? && @config[:test_plan].nil?
+          UI.user_error!("❌ For ios you must specify test_target or test_plan")
+        end
+      end
+
+      def test_distribution_array
+        @config[:test_class] || create_test_plan.test_distribution
+      end
+
+      def suite_name(test_type)
+        if ENV['JOB_NAME'].nil? && ENV['BUILD_NUMBER'].nil?
+          "#{@config[:kind]}-#{test_type.split('.')[-1]}"
+        else
+          "#{ENV['JOB_NAME']}-#{ENV['BUILD_NUMBER']}-#{test_type.split('.')[-1]}"
+        end
+      end
+
+      def create_virtual_device_suites
+        if @config[:test_distribution] == 'shard'
+          shard_virtual_device_suites
+        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
+        end
+      end
+
+      def shard_virtual_device_suites
+        UI.user_error!("❌ Cannot split #{@config[:test_distribution]}'s across virtual devices with a single emulator. \nPlease specify a minimum of two devices!") if @config[:emulators].size.eql?(1)
+        test_suites = []
+        arr = test_distribution_array
+        shards = arr.each_slice((arr.size / @config[:emulators].size.to_f).round).to_a
+        shards.each_with_index do |suite, i|
+          test_suites << {
+            'name' => suite_name("shard #{i + 1}").downcase,
+            'testOptions' => default_test_options(suite)
+          }.merge(virtual_device_options(@config[:emulators][i]))
+        end
+        test_suites
+      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|
+          test_suites << {
+            'name' => suite_name("shard #{i + 1}").downcase,
+            'testOptions' => default_test_options(suite)
+          }.merge(real_device_options(@config[:devices][i]))
+        end
+        test_suites
+      end
+
+      def test_plan_suites
+        test_suites = []
+        @config[:devices].each do |device|
+          test_suites << {
+            'name' => suite_name(@config[:test_plan].to_s).downcase,
+            'testOptions' => default_test_options(test_distribution_array)
+          }.merge(real_device_options(device))
+        end
+        test_suites
+      end
+
+      def custom_test_classes
+        test_suites = []
+        devices = @config[:devices].nil? ? @config[:emulators] : @config[:devices]
+        devices.each do |device|
+          device_options = @config[:devices].nil? ? virtual_device_options(device) : 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 create_real_device_suites
+        if !@config[:test_plan].nil? && @config[:test_distribution].eql?('class')
+          test_plan_suites
+        elsif @config[:test_distribution] == 'shard'
+          shard_real_device_suites
+        elsif @config[:test_class].kind_of?(Array)
+          custom_test_classes
+        else
+          test_suites = []
+          @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
+          test_suites
+        end
+      end
+
+      def virtual_device_options(device)
+        platform_versions = device[:platform_versions].reject(&:empty?).join(',')
+        { 'emulators' => [{ 'name' => device[:name],
+                            'orientation' => device[:orientation],
+                            'platformVersions' => platform_versions.split(',') }] }
+      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)
+        test_option_type = @config[:test_distribution].eql?('package') ? 'package' : 'class'
+        if @config[:platform] == 'android'
+          { test_option_type => test_type }.merge(android_test_options)
+        else
+          { 'class' => test_type }
+        end
+      end
+
+      def android_test_options
+        {
+          'clearPackageData' => @config[:clear_data],
+          'useTestOrchestrator' => @config[:use_test_orchestrator]
+        }
+      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}.#{type[:class]}/#{test}" }
+          end
+        else
+          test_data.each do |type|
+            tests_arr << "#{test_target}.#{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/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Saucectl
+    VERSION = "0.1.0.pre"
+  end
+end

data/lib/fastlane/plugin/saucectl.rb

@@ -0,0 +1,17 @@
+require 'fastlane'
+
+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__))]
+    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

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-saucectl
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Ian Hamilton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-23 00:00:00.000000000 Z
+dependencies:
+- !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: 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: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.5
+- !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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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: webmock
+  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'
+description:
+email: ian.ross.hamilton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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/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/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/runner.rb
+- 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/version.rb
+homepage: https://github.com/ianrhamilton/fastlane-plugin-saucectl
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Test your iOS and and Android apps at scale using Sauce Labs toolkit.
+test_files: []