fastlane-plugin-testdroid_runner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f16ce9b557eeeebabcfff7b66d2a0e5e78f2a0b123d3fe60fd68ea1e2cc6e14
+  data.tar.gz: b4ec4035cb1a231bcbf064b8658045f83d15a53eb381d362813f792298900dc6
+SHA512:
+  metadata.gz: 69e98928b795a57ccf70f5fc7ac590a56ee3957b881ac56477bea722cee3ba8fdd16e76afe64a19ae7325c7b0d0c9e455b8bc6b48fcd3ba36e5055c590249bad
+  data.tar.gz: 6931504731c0a50c61f9d8e343de488783117a4bf6ed263b07d892633f5686ae3d89d8c0a666c35033dbec1581e9eb43cec02f278f5f1edaf968da4a9665eac2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 josepmc <jmateu.clemente@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,58 @@
+# testdroid_runner plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-testdroid_runner)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-testdroid_runner`, add it to your project by running:
+
+```bash
+fastlane add_plugin testdroid_runner
+```
+
+## About testdroid_runner
+
+Allows to run BitBar tests on fastlane. It has two lanes, testdroid_runner (which runs the tests) and upload_testdroid (uploads a binary to testdroid to use as a live test).
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. The Fastfile includes 4 lanes ready to plugin to your project with a few variables.
+Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+## Run tests for this plugin
+
+If you want to run the tests, you need the following variables defined in your environment:
+
+- TESTDROID_RUNNER_API_KEY: The API Key from Bitbar
+- TESTDROID_RUNNER_APPLICATION_FILE: The Application to Test
+- TESTDROID_RUNNER_TEST_FILE: An Espresso/XCUITest runner binary
+- TESTDROID_RUNNER_PROJECT: A BitBar Project
+- TESTDROID_RUNNER_DEVICE_GROUP: A BitBar Device Group
+- TESTDROID_RUNNER_REPORT_DIR: The directory where all the files produced in BitBar will be stored
+
+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).

data/lib/fastlane/plugin/testdroid_runner.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/testdroid_runner/version'
+
+module Fastlane
+  module TestdroidRunner
+    # Return all .rb files inside the "actions" and "helper" directory
+    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::TestdroidRunner.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/testdroid_runner/actions/testdroid_runner_action.rb

@@ -0,0 +1,87 @@
+require 'fastlane/action'
+require_relative '../helper/testdroid_runner_helper'
+
+module Fastlane
+  module Actions
+    class TestdroidRunnerAction < Action
+      def self.run(params)
+        $stdout.sync = true
+        Helper::RunTest.run(params)
+      end
+
+      def self.description
+        "BitBar Test Runner"
+      end
+
+      def self.authors
+        ["josepmc"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "A quick test runner for BitBar that allows either Espresso or XCUITests to be ran through fastlane"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                  env_name: "TESTDROID_RUNNER_API_KEY",
+                                  description: "The API key used to connect to BitBar",
+                                  optional: false,
+                                  type: String),
+          FastlaneCore::ConfigItem.new(key: :application_file,
+                                  env_name: "TESTDROID_RUNNER_APPLICATION_FILE",
+                                  description: "Either an IPA or APK containing the core application",
+                                  optional: false,
+                                  type: String),
+          FastlaneCore::ConfigItem.new(key: :test_file,
+                                  env_name: "TESTDROID_RUNNER_TEST_FILE",
+                                  description: "Either an IPA or APK containing the test code",
+                                  optional: true,
+                                  type: String),
+          FastlaneCore::ConfigItem.new(key: :project,
+                                  env_name: "TESTDROID_RUNNER_PROJECT",
+                                  description: "A BitBar project where to store the test run",
+                                  optional: true,
+                                  type: String),
+          FastlaneCore::ConfigItem.new(key: :device_group,
+                                  env_name: "TESTDROID_RUNNER_DEVICE_GROUP",
+                                  description: "The BitBar device group to use as target devices",
+                                  optional: true,
+                                  type: String),
+          FastlaneCore::ConfigItem.new(key: :wait_complete,
+                                  env_name: "TESTDROID_RUNNER_WAIT_COMPLETE",
+                                  description: "Whether to wait for the tests execution to be complete",
+                                  optional: true,
+                                  default_value: true,
+                                  is_string: false),
+          FastlaneCore::ConfigItem.new(key: :report_dir,
+                                  env_name: "TESTDROID_RUNNER_REPORT_DIR",
+                                  description: "The directory where to download the report files. If :wait_complete is false, this setting will be ignored",
+                                  optional: true,
+                                  type: String),
+          FastlaneCore::ConfigItem.new(key: :concurrency,
+                                  env_name: "TESTDROID_RUNNER_CONCURRENCY",
+                                  description: "Number of purchased concurrency lanes. Testdroid jobs have a maximum device amount of 2x purchased lanes. The runner will split the selected lists into smaller runs in order to fit around this restriction",
+                                  optional: true,
+                                  type: Integer,
+                                  default_value: 2),
+          FastlaneCore::ConfigItem.new(key: :scheduler,
+                                  env_name: "TESTDROID_RUNNER_SCHEDULER",
+                                  description: "Which type of scheduler to use, by default it will only run one device at a time",
+                                  optional: true,
+                                  type: String,
+                                  default_value: "SERIAL")
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/testdroid_runner/actions/upload_testdroid_action.rb

@@ -0,0 +1,50 @@
+require 'fastlane/action'
+require_relative '../helper/upload_file_helper'
+
+module Fastlane
+  module Actions
+    class UploadTestdroidAction < Action
+      def self.run(params)
+        $stdout.sync = true
+        Helper::UploadFile.run(params)
+      end
+
+      def self.description
+        "Uploads a file to bitbar"
+      end
+
+      def self.authors
+        ["josepmc"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+        "Returns the uploaded file id"
+      end
+
+      def self.details
+        # Optional:
+        "Uploads a file to bitbar"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                  env_name: "TESTDROID_RUNNER_API_KEY",
+                                  description: "The API key used to connect to BitBar",
+                                  optional: false,
+                                  type: String),
+          FastlaneCore::ConfigItem.new(key: :application_file,
+                                  env_name: "TESTDROID_RUNNER_APPLICATION_FILE",
+                                  description: "Either an IPA or APK containing the core application",
+                                  optional: false,
+                                  type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/testdroid_runner/helper/shared.rb

@@ -0,0 +1,39 @@
+require 'testdroid-api-client'
+
+module Fastlane
+  module Helper
+    class TestdroidRunnerHelper
+      @user = nil
+      def self.get_user(params)
+        if @user.nil?
+          client = TestdroidAPI::ApikeyClient.new(params[:api_key])
+          @user = client.authorize
+        end
+        @user
+      end
+
+      def self.get_os(params)
+        if params[:application_file].end_with?(".apk")
+          return { name: "ANDROID", framework: "s_osType_eq_ANDROID;s_name_like_%Instrumentation", extname: "apk" }
+        end
+        if params[:application_file].end_with?(".ipa", ".app")
+          # XCTest would be return { name: "IOS", framework: "s_osType_eq_IOS;s_name_like_%XCTest", extname: "ipa" }
+          return { name: "IOS", framework: "s_osType_eq_IOS;s_name_like_%XCUITest", extname: "ipa" }
+        end
+        raise "Unknown extension for #{params.application_file}"
+      end
+
+      def self.upload_file(file)
+        file_name = File.basename(file)
+        duplicated_files = @user.files.list({ filter: "s_name_eq_#{file_name}" })
+        unless duplicated_files.nil? || duplicated_files.length == 0
+          puts("[testdroid] Deleting duplicated files with ids: #{duplicated_files.collect(&:id)}")
+          duplicated_files.each(&:delete)
+        end
+        uploaded_file = @user.files.upload(file)
+        puts("[testdroid] Uploaded: #{uploaded_file.id}")
+        uploaded_file
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/testdroid_runner/helper/testdroid_runner_helper.rb

@@ -0,0 +1,67 @@
+require_relative './shared'
+
+module Fastlane
+  module Helper
+    class RunTest
+      def self.run(params)
+        # source: https://github.com/bitbar/testdroid-api-client-ruby/blob/master/sample/sample.rb
+        user = Helper::TestdroidRunnerHelper.get_user(params)
+        os_config = Helper::TestdroidRunnerHelper.get_os(params)
+        puts("[testdroid] Starting test run with:\napp #{os_config[:extname]}: #{params[:application_file]}\ntest #{os_config[:extname]}: #{params[:test_file]}")
+        # Create project
+        project = user.projects.list.detect { |proj| proj.name.casecmp(params[:project]) == 0 }
+
+        # get all the devices to run on
+        device_group = user.device_groups.list.detect { |group| group.display_name.casecmp(params[:device_group]) == 0 }
+        run_devices = device_group.devices.list.select { |device| device.os_type.casecmp(os_config[:name]) == 0 }
+        puts("[testdroid] Running on devices #{run_devices.collect(&:display_name)}")
+
+        # get IDs of the devices
+        id_list = run_devices.collect(&:id)
+
+        # get the framework id
+        framework_id = user.available_frameworks.list({ filter: os_config[:framework] })[0].id
+
+        # Upload file
+        puts("[testdroid] Uploading app #{os_config[:extname]}...")
+        file_app = Helper::TestdroidRunnerHelper.upload_file(params[:application_file])
+        # instrumentation package
+        puts("[testdroid] Uploading test #{os_config[:extname]}...")
+        file_test = Helper::TestdroidRunnerHelper.upload_file(params[:test_file])
+
+        i = 0
+        until id_list[i, i + params[:concurrency] * 2].nil?
+          list = id_list[i, i + params[:concurrency] * 2]
+          i += params[:concurrency] * 2
+          # start test run
+          test_run = user.runs.create("{\"osType\": \"#{os_config[:name]}\", \"projectId\": #{project.id}, \"frameworkId\":#{framework_id},
+              \"deviceIds\": #{list}, \"scheduler\": \"#{params[:scheduler] || 'SERIAL'}\", \"files\": [{\"id\": #{file_app.id}, \"action\": \"INSTALL\" },
+              {\"id\": #{file_test.id}, \"action\": \"RUN_TEST\" }]}")
+          puts("[testdroid] Started test run, access it using this link: https://cloud.bitbar.com/#testing/projects/#{project.id}/#{test_run.id}")
+
+          # wait until the whole test run is completed
+          next unless params[:wait_complete]
+          until test_run.refresh.state == "FINISHED"
+            print(".")
+            sleep(20)
+          end
+
+          print("\n")
+
+          puts("[testdroid] Test run finished with success ratio: #{test_run.success_ratio * 100}% [executed:#{test_run.execution_ratio * 100}%]")
+          # download all files from all device sessions
+
+          next unless params[:report_dir]
+          puts("[testdroid] Downloading files...")
+          test_run.device_sessions.list({ limit: 0 })
+                  .each { |ds| ds.download_all_files(params[:report_dir]) }
+          puts("[testdroid] All files downloaded")
+        end
+      ensure
+        puts("[testdroid] Cleaning up...")
+        file_app.delete unless file_app.nil?
+        file_test.delete unless file_test.nil?
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/testdroid_runner/helper/upload_file_helper.rb

@@ -0,0 +1,17 @@
+require_relative './shared'
+
+module Fastlane
+  module Helper
+    class UploadFile
+      def self.run(params)
+        Helper::TestdroidRunnerHelper.get_user(params)
+        os_config = Helper::TestdroidRunnerHelper.get_os(params)
+        puts("[testdroid] Uploading #{os_config[:extname]} for live services: #{params[:application_file]}...")
+        file_app = Helper::TestdroidRunnerHelper.upload_file(params[:application_file])
+
+        puts("[testdroid] Test the app on a live device: https://cloud.bitbar.com/#testing/interactive-choose-device")
+        file_app.id
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module TestdroidRunner
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-testdroid_runner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- josepmc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: testdroid-api-client
+  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'
+- !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.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !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: 2.148.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.148.1
+description: 
+email: jmateu.clemente@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/testdroid_runner.rb
+- lib/fastlane/plugin/testdroid_runner/actions/testdroid_runner_action.rb
+- lib/fastlane/plugin/testdroid_runner/actions/upload_testdroid_action.rb
+- lib/fastlane/plugin/testdroid_runner/helper/shared.rb
+- lib/fastlane/plugin/testdroid_runner/helper/testdroid_runner_helper.rb
+- lib/fastlane/plugin/testdroid_runner/helper/upload_file_helper.rb
+- lib/fastlane/plugin/testdroid_runner/version.rb
+homepage: https://github.com/josepmc/fastlane-plugin-testdroid_runner
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Allows to run BitBar tests on fastlane
+test_files: []