fastlane-plugin-firebase_test_lab_android 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8703f0c3e4487ecd05516d8e1104a7d341068f87
+  data.tar.gz: 2337373ee1df4b4aa368372769e1583489c74c57
+SHA512:
+  metadata.gz: ff4d07eacfec1045c78398479c1f4cdd90359d92191a481a27fc41fb00d873457e7d1698d6a14ef6f5be25d1e35fc81c74ad00bf70386beec3f868dbf9be63c9
+  data.tar.gz: d8841242fa07b00aef2e2a5417c5e4a8ec9dc80fd6475c8b51e4f99d6e48e68003d2f0b71cdf7ce9a52c2787623a4dd2db16660bc7b3efe3e40604a769849b9f

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,102 @@
+# Firebase Test Lab plugin for fastlane
+
+<p align="center">
+  <img src="./art/firebase-test-lab.jpg" width="600" />
+</p>
+
+Inspired by [Firebase test lab plugin for ios](https://github.com/fastlane/fastlane-plugin-firebase_test_lab)
+
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-firebase_test_lab_android`, add it to your project by running:
+
+```bash
+(not yet)
+fastlane add_plugin firebase_test_lab_android 
+```
+
+### If you are not current user of Firebase
+
+You need to set up Firebase first. These only needs to be done once for an organization.
+
+- If you have not used Google Cloud before, you need to [create a new Google Cloud project](https://cloud.google.com/resource-manager/docs/creating-managing-projects#Creating%20a%20Project) first.
+- Go to the [Firebase Console](https://console.firebase.google.com/). Add Firebase into your Google Cloud project by clicking on "Add project" and then choose your just-created project.
+
+### Configure Google credentials through service accounts
+
+To authenticate, Google Cloud credentials will need to be set for any machine where _fastlane_ and this plugin runs on.
+
+If you are running this plugin on Google Cloud [Compute Engine](https://cloud.google.com/compute), [Kubernetes Engine](https://cloud.google.com/kubernetes-engine) or [App Engine flexible environment](https://cloud.google.com/appengine/docs/flexible/), a default service account is automatically provisioned. You will not need to create a service account. See [this](https://cloud.google.com/compute/docs/access/service-accounts#compute_engine_default_service_account) for more details.
+
+In all other cases, you need to configure the service account manually. You can follow [this guide](https://cloud.google.com/docs/authentication/getting-started) on how to create a new service account and create a key for it. You will need to set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable pointing to the service account key file according to the document.
+
+No matter if you are a using an automatically provisioned service account or a manually created one, the service account must be configured to have the project editor role.
+
+### Enable relevant Google APIs
+
+- You need to enable the following APIs on your [Google Cloud API library](https://console.cloud.google.com/apis/library) (see [this](https://support.google.com/cloud/answer/6158841) for instructions how):
+  1. Cloud Testing API
+  2. Cloud Tool Results API
+
+### Find the devices you want to test on
+
+If you have [gcloud tool](https://cloud.google.com/sdk/gcloud/), you can run
+
+```no-highlight
+gcloud beta firebase test android models list
+```
+
+to get a list of supported devices and their identifiers.
+
+Alternatively all available devices can also be seen [here](https://firebase.google.com/docs/test-lab/ios/available-testing-devices). 
+
+
+## Actions
+
+Test your app with Firebase Test Lab with ease using fastlane.  
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin.
+
+```ruby
+before_all do
+  ENV["SLACK_URL"] = "https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX"
+end
+
+firebase_test_lab_android(
+  project_id: "cats-firebase",
+  gcloud_service_key_file: "fastlane/client-secret.json",
+  type: "robo",
+  devices: [
+    {
+      model: "hammerhead",
+      version: "21",
+      locale: "ja_JP",
+      orientation: "portrait"
+    },
+    {
+      model: "Pixel2",
+      version: "28"
+    }
+  ],
+  app_apk: "test.apk",
+  console_log_file_name: "fastlane/console_output.log",
+  timeout: "1m",
+  notify_to_slack: true
+)
+```
+
+## 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/firebase_test_lab_android.rb

@@ -0,0 +1,15 @@
+require 'fastlane/plugin/firebase_test_lab_android/version'
+
+module Fastlane
+  module FirebaseTestLabAndroid
+    def self.all_classes
+      Dir[File.expand_path('**/{actions}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions
+# A plugin can contain any number of actions and plugins
+Fastlane::FirebaseTestLabAndroid.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/firebase_test_lab_android/actions/firebase_test_lab_android_action.rb

@@ -0,0 +1,197 @@
+require 'fastlane/action'
+
+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
+  end
+
+  module Actions
+    class FirebaseTestLabAndroidAction < Action
+      PIPE = "testlab-pipe"
+
+      def self.run(params)
+        UI.message("Starting...")
+
+        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 #{params[:gcloud_service_key_file]}")
+
+        UI.message("Running...")
+        Action.sh("rm #{PIPE}") if File.exist?(PIPE)
+        Action.sh("mkfifo #{PIPE}")
+        Action.sh("set +e;"\
+                  "tee #{params[:console_log_file_name]} < #{PIPE} & "\
+                  "#{Commands.run_tests} "\
+                  "--type #{params[:type]} "\
+                  "--app #{params[:app_apk]} "\
+                  "#{"--test #{params[:app_test_apk]} " unless params[:app_test_apk].nil?}"\
+                  "#{params[:devices].map { |d| "--device model=#{d[:model]},version=#{d[:version]},locale=#{d[:locale]},orientation=#{d[:orientation]} " }.join}"\
+                  "--timeout #{params[:timeout]} "\
+                  "#{params[:extra_options]} "\
+                  "> #{PIPE} 2>&1;"\
+                  "set -e")
+        Action.sh("rm #{PIPE}") if File.exist?(PIPE)
+
+        if params[:notify_to_slack]
+          output = File.read(params[:console_log_file_name])
+          failed = output.include?("Failed") || output.include?("Inconclusive")
+          other_action.slack(message: output,
+                             success: !failed,
+                             use_webhook_configured_username_and_icon: true,
+                             default_payloads: [:git_branch, :git_author, :last_git_commit])
+        end
+      end
+
+      def self.description
+        "Runs Android tests in Firebase Test Lab."
+      end
+
+      def self.authors
+        ["Wasabeef"]
+      end
+
+      def self.return_value
+        ["Authenticates with Google Cloud.",
+         "Runs tests in Firebase Test Lab.",
+         "Fetches the results to a local directory."].join("\n")
+      end
+
+      def self.details
+        # Optional:
+        "Test your app with Firebase Test Lab with ease using fastlane"
+      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: :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: false),
+         FastlaneCore::ConfigItem.new(key: :type,
+                                      env_name: "TYPE",
+                                      description: "Test type. Default: robo (robo/instrumentation)",
+                                      is_string: true,
+                                      optional: true,
+                                      default_value: "robo"),
+         FastlaneCore::ConfigItem.new(key: :devices,
+                                      description: "Devices to test the app on",
+                                      type: Array,
+                                      default_value: [{
+                                                          model: "Nexus6",
+                                                          version: "21",
+                                                          locale: "en_US",
+                                                          orientation: "portrait"
+                                                      }],
+                                      verify_block: proc do |value|
+                                        if value.empty?
+                                          UI.user_error!("Devices cannot be empty")
+                                        end
+                                        value.each do |current|
+                                          if current.class != Hash
+                                            UI.user_error!("Each device must be represented by a Hash object, " \
+                                               "#{current.class} found")
+                                          end
+                                          check_has_property(current, :model)
+                                          check_has_property(current, :version)
+                                          set_default_property(current, :locale, "en_US")
+                                          set_default_property(current, :orientation, "portrait")
+                                        end
+                                      end),
+         FastlaneCore::ConfigItem.new(key: :timeout,
+                                      env_name: "TIMEOUT",
+                                      description: "The max time this test execution can run before it is cancelled. Default: 5m (this value must be greater than or equal to 1m)",
+                                      is_string: true,
+                                      optional: true,
+                                      default_value: "5m"),
+         FastlaneCore::ConfigItem.new(key: :app_apk,
+                                      env_name: "APP_APK",
+                                      description: "The path for your android app apk",
+                                      is_string: true,
+                                      optional: false),
+         FastlaneCore::ConfigItem.new(key: :app_test_apk,
+                                      env_name: "APP_TEST_APK",
+                                      description: "The path for your android test apk. Default: empty string",
+                                      is_string: true,
+                                      optional: true,
+                                      default_value: nil),
+         FastlaneCore::ConfigItem.new(key: :console_log_file_name,
+                                      env_name: "CONSOLE_LOG_FILE_NAME",
+                                      description: "The filename to save the output results. Default: ./console_output.log",
+                                      is_string: true,
+                                      optional: true,
+                                      default_value: "./console_output.log"),
+         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: :notify_to_slack,
+                                      env_name: "NOTIFY_TO_SLACK",
+                                      description: "Notify to Slack after finishing of the test. Default: false",
+                                      is_string: false,
+                                      optional: true,
+                                      default_value: false)]
+      end
+
+      def self.check_has_property(hash_obj, property)
+        UI.user_error!("Each device must have #{property} property") unless hash_obj.key?(property)
+      end
+
+      def self.set_default_property(hash_obj, property, default)
+        unless hash_obj.key?(property)
+          hash_obj[property] = default
+        end
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+
+      def self.output
+        [['console_output.log', 'A console log when running Firebase Test Lab with gcloud']]
+      end
+
+      def self.example_code
+        ['firebase_test_lab_android(
+              project_id: "winticket-firebase",
+              gcloud_service_key_file: "fastlane/client-secret.json",
+              type: "robo",
+              devices: [
+                {
+                    model: "hammerhead",
+                    version: "21",
+                    locale: "ja_JP",
+                    orientation: "portrait"
+                },
+                {
+                    model: "Pixel2",
+                    version: "28"
+                }
+              ],
+              app_apk: "test.apk",
+              console_log_file_name: "fastlane/console_output.log",
+              timeout: "3m",
+              notify_to_slack: true
+          )']
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-firebase_test_lab_android
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wasabeef
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-01 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.116.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.116.0
+description: 
+email: dadadada.chop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/firebase_test_lab_android.rb
+- lib/fastlane/plugin/firebase_test_lab_android/actions/firebase_test_lab_android_action.rb
+- lib/fastlane/plugin/firebase_test_lab_android/version.rb
+homepage: https://github.com/cats-oss/fastlane-plugin-firebase_test_lab_android
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Test your app with Firebase Test Lab with ease using fastlane
+test_files: []