fastlane-plugin-run_tests_firebase_testlab 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18a59923efe2a8fd8f60fb14bc84738914c176b2
+  data.tar.gz: cdc8410dc9a9d2a14005aefd500f0dbc0cd900cd
+SHA512:
+  metadata.gz: a164455b68cf929e313fb692c06b400d841988f3dd1868a6dbee6238ea689aeae014ba27cb2066ba94848e9e33cafba68285a8a855ddeec252bd0abf889ce9a8
+  data.tar.gz: 489780097f63d24dfdc2124ea16461750f5bb23c35c87a79728222c5debec3b74d317e6abab5711612704299156a9e998acd8c855b8ee08a76d8c2f8817c95a8

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Pink Room
+
+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,172 @@
+# run_tests_firebase_testlab plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-run_tests_firebase_testlab)
+[![Build
+Status](https://travis-ci.org/pink-room/fastlane-plugin-run_tests_firebase_testlab.svg?branch=master)](https://travis-ci.org/pink-room/fastlane-plugin-run_tests_firebase_testlab)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-run_tests_firebase_testlab`, add it to your project by running:
+
+```bash
+fastlane add_plugin run_tests_firebase_testlab
+```
+
+## About run_tests_firebase_testlab
+
+* Authenticates with Google Cloud.
+
+* Runs Android tests in Firebase Test Lab.
+
+* Fetches the results to a local directory.
+
+* Deletes the results from firebase bucket if wanted.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin.
+
+### Simple usage
+
+```
+run_tests_firebase_testlab(
+    project_id: "your-firebase-project-id",
+    model: "Nexus6P",
+    version: "27")
+```
+
+### Parameters
+
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Description</th>
+<th>Optional</th>
+<th>Default</th>
+</tr>
+</thead>
+<tbody>
+
+<tr>
+<td><b>project_id</b></td>
+<td>Your Firebase project id</td>
+<td>No</td>
+<td>-</td>
+</tr>
+
+<tr>
+<td><b>model</b></td>
+<td>The device's model on which the tests will be run</td>
+<td>No</td>
+<td>-</td>
+</tr>
+
+<tr>
+<td><b>version</b></td>
+<td>The Android api version of the device</td>
+<td>No</td>
+<td>-</td>
+</tr>
+
+<tr>
+<td>app_apk</td>
+<td>The path for your app apk</td>
+<td>Yes</td>
+<td>app/build/outputs/apk/debug/<br>app-debug.apk</td>
+</tr>
+
+<tr>
+<td>android_test_apk</td>
+<td>The path for your android test apk</td>
+<td>Yes</td>
+<td>app/build/outputs/apk/androidTest/<br>debug/app-debug-androidTest.apk</td>
+</tr>
+
+<tr>
+<td>locale</td>
+<td>The locale to test against</td>
+<td>Yes</td>
+<td>en_US</td>
+</tr>
+
+<tr>
+<td>orientation</td>
+<td>The orientation of the device</td>
+<td>Yes</td>
+<td>portrait</td>
+</tr>
+
+<tr>
+<td>timeout</td>
+<td>The max time this test execution can run before it is cancelled</td>
+<td>Yes</td>
+<td>30m</td>
+</tr>
+
+<tr>
+<td>output_dir</td>
+<td>The directory to save the output results</td>
+<td>Yes</td>
+<td>firebase</td>
+</tr>
+
+<tr>
+<td>bucket_url</td>
+<td>The bucket url where the test results were stored</td>
+<td>Yes</td>
+<td>Parsed automatically from tests output</td>
+</tr>
+
+<tr>
+<td>delete_firebase_files</td>
+<td>A flag to control if the firebase files should be deleted from the bucket or not</td>
+<td>Yes</td>
+<td>false</td>
+</tr>
+
+<tr>
+<td>extra_options</td>
+<td>Extra options that you need to pass to the gcloud command</td>
+<td>Yes</td>
+<td>empty string</td>
+</tr>
+
+<tr>
+<td>gcloud_service_key_file</td>
+<td>File path containing the gcloud auth key</td>
+<td>Yes</td>
+<td>Created from GCLOUD_SERVICE_KEY environment variable</td>
+</tr>
+
+</tbody>
+</table>
+
+## 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).

data/lib/fastlane/plugin/run_tests_firebase_testlab.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/run_tests_firebase_testlab/version'
+
+module Fastlane
+  module RunTestsFirebaseTestlab
+    # Return all .rb files inside the "actions" and "commands" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,commands}/*.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::RunTestsFirebaseTestlab.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/run_tests_firebase_testlab/actions/run_tests_firebase_testlab_action.rb

@@ -0,0 +1,196 @@
+module Fastlane
+  module Actions
+    class RunTestsFirebaseTestlabAction < Action
+      @client_secret_file = "client-secret.json"
+      @test_console_output_file = "instrumentation_output.txt"
+
+      class << self
+        attr_reader :client_secret_file, :test_console_output_file
+      end
+
+      def self.run(params)
+        UI.message("Starting run_tests_firebase_testlab plugin...")
+
+        if params[:gcloud_service_key_file].nil?
+          UI.message("Save Google Cloud credentials.")
+          File.open(@client_secret_file, 'w') do |file|
+            file.write(ENV["GCLOUD_SERVICE_KEY"])
+          end
+        else
+          @client_secret_file = params[:gcloud_service_key_file]
+        end
+
+        UI.message("Set Google Cloud target project.")
+        Action.sh("#{Commands.config} #{params[:project_id]}")
+
+        UI.message("Authenticate with Google Cloud.")
+        Action.sh("#{Commands.auth} --key-file #{@client_secret_file}")
+
+        UI.message("Running instrumentation tests in Firebase Test Lab...")
+        Action.sh("#{Commands.run_tests} "\
+                  "--type instrumentation "\
+                  "--app #{params[:app_apk]} "\
+                  "--test #{params[:android_test_apk]} "\
+                  "--device model=#{params[:model]},version=#{params[:version]},locale=#{params[:locale]},orientation=#{params[:orientation]} "\
+                  "--timeout #{params[:timeout]} "\
+                  "#{params[:extra_options]} "\
+                  "2>&1 | tee #{@test_console_output_file}")
+
+        UI.message("Create firebase directory (if not exists) to store test results.")
+        FileUtils.mkdir_p(params[:output_dir])
+
+        if params[:bucket_url].nil?
+          UI.message("Parse firebase bucket url.")
+          params[:bucket_url] = scrape_bucket_url
+          UI.message("bucket: #{params[:bucket_url]}")
+        end
+
+        UI.message("Downloading instrumentation test results from Firebase Test Lab...")
+        Action.sh("#{Commands.download_results} #{params[:bucket_url]} #{params[:output_dir]}/")
+
+        if params[:delete_firebase_files]
+          UI.message("Deleting files from firebase storage...")
+          Action.sh("#{Commands.delete_resuls} #{params[:bucket_url]}")
+        end
+      end
+
+      def self.description
+        "Runs Android tests in Firebase Test Lab."
+      end
+
+      def self.authors
+        ["bffcorreia"]
+      end
+
+      def self.details
+        [
+          "Authenticates with Google Cloud.",
+          "Runs tests in Firebase Test Lab.",
+          "Fetches the results to a local directory.",
+          "Deletes the results from firebase bucket if wanted."
+        ].join("\n")
+      end
+
+      def self.output
+        [
+          ['bugreport.txt', 'A bugreport of the app.'],
+          ['instrumentation.results', 'The results of the instrumentation tests.'],
+          ['logcat', 'Logs from logcat.'],
+          ['test_result_0.xml', 'A xml file that contains all the tests.'],
+          ['video.mp4', 'A video of the tests.']
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "PROJECT_ID",
+                                       description: "Your Firebase project id",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :model,
+                                       env_name: "MODEL",
+                                       description: "The device's model on which the tests will be run",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :version,
+                                       env_name: "VERSION",
+                                       description: "The Android api version of the device",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :app_apk,
+                                       env_name: "APP_APK",
+                                       description: "The path for your app apk. Default: app/build/outputs/apk/debug/app-debug.apk",
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: "app/build/outputs/apk/debug/app-debug.apk"),
+          FastlaneCore::ConfigItem.new(key: :android_test_apk,
+                                       env_name: "ANDROID_TEST_APK",
+                                       description: "The path for your android test apk. Default: app/build/outputs/apk/androidTest/debug/app-debug-androidTest.apk",
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: "app/build/outputs/apk/androidTest/debug/app-debug-androidTest.apk"),
+          FastlaneCore::ConfigItem.new(key: :locale,
+                                       env_name: "LOCALE",
+                                       description: "The locale to test against. Default: en_US",
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: "en_US"),
+          FastlaneCore::ConfigItem.new(key: :orientation,
+                                       env_name: "ORIENTATION",
+                                       description: "The orientation of the device. Default: portrait",
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: "portrait"),
+          FastlaneCore::ConfigItem.new(key: :timeout,
+                                       env_name: "TIMEOUT",
+                                       description: "The max time this test execution can run before it is cancelled. Default: 30m",
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: "30m"),
+          FastlaneCore::ConfigItem.new(key: :output_dir,
+                                       env_name: "OUTPUT_DIR",
+                                       description: "The directory to save the output results. Default: firebase",
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: "firebase"),
+          FastlaneCore::ConfigItem.new(key: :bucket_url,
+                                       env_name: "BUCKET_URL",
+                                       description: "The bucket url where the test results were stored. Default: Parsed automatically from tests output",
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: nil),
+          FastlaneCore::ConfigItem.new(key: :delete_firebase_files,
+                                       env_name: "DELETE_FIREBASE_FILES",
+                                       description: "A flag to controll if the firebase files should be deleted from the bucket or not. Default: false",
+                                       is_string: false,
+                                       optional: true,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :extra_options,
+                                       env_name: "EXTRA_OPTIONS",
+                                       description: "Extra options that you need to pass to the gcloud command. Default: empty string",
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: ""),
+          FastlaneCore::ConfigItem.new(key: :gcloud_service_key_file,
+                                       env_name: "GCLOUD_SERVICE_KEY_FILE",
+                                       description: "File path containing the gcloud auth key. Default: Created from GCLOUD_SERVICE_KEY environment variable",
+                                       is_string: true,
+                                       optional: true,
+                                       default_value: nil)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+
+      def self.example_code
+        [
+          'run_tests_firebase_testlab(
+              project_id: "your-firebase-project-id",
+              model: "Nexus6P",
+              version: "27",
+              delete_firebase_files: true
+          )'
+        ]
+      end
+
+      def self.category
+        :testing
+      end
+
+      def self.scrape_bucket_url
+        File.open(@test_console_output_file).each do |line|
+          url = line.scan(/\[(.*)\]/).last&.first
+          next unless !url.nil? and (!url.empty? and url.include?("test-lab-"))
+          splitted_url = url.split("/")
+          length = splitted_url.length
+          return "gs://#{splitted_url[length - 2]}/#{splitted_url[length - 1]}"
+        end
+      end
+
+      private_class_method :scrape_bucket_url
+    end
+  end
+end

data/lib/fastlane/plugin/run_tests_firebase_testlab/commands/commands.rb

@@ -0,0 +1,23 @@
+module Fastlane
+  module Commands
+    def self.config
+      "gcloud config set project"
+    end
+
+    def self.auth
+      "gcloud auth activate-service-account"
+    end
+
+    def self.run_tests
+      "gcloud firebase test android run"
+    end
+
+    def self.download_results
+      "gsutil -m cp -r"
+    end
+
+    def self.delete_resuls
+      "gsutil rm -r"
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module RunTestsFirebaseTestlab
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-run_tests_firebase_testlab
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Correia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-06 00:00:00.000000000 Z
+dependencies:
+- !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.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.79.0
+description: 
+email: bruno@pinkroom.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/run_tests_firebase_testlab.rb
+- lib/fastlane/plugin/run_tests_firebase_testlab/actions/run_tests_firebase_testlab_action.rb
+- lib/fastlane/plugin/run_tests_firebase_testlab/commands/commands.rb
+- lib/fastlane/plugin/run_tests_firebase_testlab/version.rb
+homepage: https://github.com/pink-room/fastlane-plugin-run_tests_firebase_testlab
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Runs Android tests in Firebase Test Lab.
+test_files: []