fastlane-plugin-android_testlab_script_swit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 544c96a23ea810aac737ecc922a626b5502e1932268c9efbb4aec58c12f40b9b
+  data.tar.gz: 52990223d6f31acf67041c4d44d4001d23b5d652b8ea0a2a03a560e990f04635
+SHA512:
+  metadata.gz: 1aa78e6af867191f619ed47a4ad5c0f4797a5d4c5928aca118463edf43a16681282d9c83e322926e836c57b4935a1b9dde8de62ece5420849343795d3fa74513
+  data.tar.gz: ef6c7314c32232b8a5b0696c0d31e64afd63a96d4ebacdbd90e9b6550b12b9cb89e419633a3bb1e72f12e145b6f57d44a4b0cc40252618e5c02284bf6d6582bc

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 나비이쁜이 <munkijung1992@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,52 @@
+# android_testlab_script_swit plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-android_testlab_script_swit)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-android_testlab_script_swit`, add it to your project by running:
+
+```bash
+fastlane add_plugin android_testlab_script_swit
+```
+
+## About android_testlab_script_swit
+
+short
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## 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/android_testlab_script_swit/actions/android_testlab_script_swit_action.rb

@@ -0,0 +1,255 @@
+require 'fastlane/action'
+require 'json'
+require 'fileutils'
+
+require_relative '../helper/firebase_testlab_with_script_android_helper'
+
+module Fastlane
+  module Actions
+    class FirebaseTestlabWithScriptAndroidAction < Action
+
+      # actions run
+      def self.run(params)
+        UI.message("Start Action")
+
+        results_bucket = params[:firebase_test_lab_results_bucket] || "#{params[:project_id]}_test_results"
+        results_dir = params[:firebase_test_lab_results_dir] || "firebase_test_result_#{DateTime.now.strftime('%Y-%m-%d-%H:%M:%S')}"
+
+        # Set target project
+        Helper.config(params[:project_id])
+
+        # Activate service account
+        Helper.authenticate(params[:gcloud_service_key_file])
+
+        # RoboScriptOption Add
+        robo_script_option = params[:robo_script_path].nil? ? "" : "--robo-script #{params[:robo_script_path]} "
+
+        # Run Firebase Test Lab
+        Helper.run_tests(params[:gcloud_components_channel], "--type #{params[:type]} "\
+                  "--app #{params[:app_apk]} "\
+                  "#{"--test #{params[:app_test_apk]} " unless params[:app_test_apk].nil?}"\
+                  "#{"--use-orchestrator " if params[:type] == "instrumentation" && params[:use_orchestrator]}"\
+                  "#{params[:devices].map { |d| "--device model=#{d[:model]},version=#{d[:version]},locale=#{d[:locale]},orientation=#{d[:orientation]} " }.join}"\
+                  "--timeout #{params[:timeout]} "\
+                  "--results-bucket #{results_bucket} "\
+                  "--results-dir #{results_dir} "\
+                  "#{params[:extra_options]} "\
+                  "#{robo_script_option}"\
+                  "--format=json 1>#{Helper.if_need_dir(params[:console_log_file_name])}"
+        )
+
+        json = JSON.parse(File.read(params[:console_log_file_name]))
+        UI.message("Test status: #{json}")
+
+        # Fetch results
+        download_dir = params[:download_dir]
+        if download_dir
+          UI.message("Fetch results from Firebase Test Lab results bucket")
+          json.each do |status|
+            axis = status["axis_value"]
+            Helper.if_need_dir("#{download_dir}/#{axis}")
+            Helper.copy_from_gcs("#{results_bucket}/#{results_dir}/#{axis}", download_dir)
+            Helper.set_public("#{results_bucket}/#{results_dir}/#{axis}")
+          end
+        end
+
+        UI.message("Finish Action")
+      end
+
+      # Short Detils
+      def self.description
+        "Android Firebase TestLab with Robo Script Test"
+      end
+
+      # Authors
+      def self.authors
+        ["나비이쁜이"]
+      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
+
+      # Long Detils
+      def self.details
+        "This plug-in uses Firebase TestLab. You can also include RoboScript files."
+      end
+
+      # Option val
+      def self.available_options
+        [
+            # project_id (true)
+            FastlaneCore::ConfigItem.new(key: :project_id,
+                                         env_name: "PROJECT_ID",
+                                         description: "Your Firebase project id",
+                                         is_string: true,
+                                         optional: false),
+
+            # gcloud_key_file (true)
+            FastlaneCore::ConfigItem.new(key: :gcloud_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),
+
+            # test type (true)
+            FastlaneCore::ConfigItem.new(key: :type,
+                                         env_name: "TYPE",
+                                         description: "Test type. Default: robo (robo/instrumentation)",
+                                         is_string: true,
+                                         optional: true,
+                                         default_value: "robo",
+                                         verify_block: proc do |value|
+                                           if value != "robo" && value != "instrumentation"
+                                             UI.user_error!("Unknown test type.")
+                                           end
+                                         end),
+
+            # device (true)
+            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),
+
+            # timeout (ture)
+            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)",
+                                         type: String,
+                                         optional: false,
+                                         default_value: "3m"),
+
+            # apk (true)
+            FastlaneCore::ConfigItem.new(key: :app_apk,
+                                         env_name: "APP_APK",
+                                         description: "The path for your android app apk",
+                                         type: String,
+                                         optional: false),
+
+            # test apk (false)
+            FastlaneCore::ConfigItem.new(key: :app_test_apk,
+                                         env_name: "APP_TEST_APK",
+                                         description: "The path for your android test apk. Default: empty string",
+                                         type: String,
+                                         optional: true,
+                                         default_value: nil),
+
+            # orchestrator (false)
+            FastlaneCore::ConfigItem.new(key: :use_orchestrator,
+                                         env_name: "USE_ORCHESTRATOR",
+                                         description: "If you use orchestrator when set instrumentation test. Default: false",
+                                         type: Boolean,
+                                         optional: true,
+                                         default_value: false),
+
+            # gcloud_components_channel (false)
+            FastlaneCore::ConfigItem.new(key: :gcloud_components_channel,
+                                         env_name: "gcloud_components_channel",
+                                         description: "If you use beta or alpha components. Default stable (alpha/beta)",
+                                         is_string: true,
+                                         optional: true,
+                                         default_value: "stable",
+                                         verify_block: proc do |value|
+                                           if value != "stable" && value != "alpha" && value != "beta"
+                                             UI.user_error!("Unknown gcloud component channel.")
+                                           end
+                                         end),
+
+            # console_log_file_name (false)
+            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",
+                                         type: String,
+                                         optional: true,
+                                         default_value: "./console_output.log"),
+
+            # extra_options (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",
+                                         type: String,
+                                         optional: true,
+                                         default_value: ""),
+
+            # firebase_test_lab_results_bucket (false)
+            FastlaneCore::ConfigItem.new(key: :firebase_test_lab_results_bucket,
+                                         env_name: "FIREBASE_TEST_LAB_RESULTS_BUCKET",
+                                         description: "Name of Firebase Test Lab results bucket",
+                                         type: String,
+                                         optional: true,
+                                         default_value: nil),
+
+            # firebase_test_lab_results_dir (false)
+            FastlaneCore::ConfigItem.new(key: :firebase_test_lab_results_dir,
+                                         env_name: "FIREBASE_TEST_LAB_RESULTS_DIR",
+                                         description: "Name of Firebase Test Lab results directory",
+                                         type: String,
+                                         optional: true,
+                                         default_value: nil),
+
+            # download_dir (false)
+            FastlaneCore::ConfigItem.new(key: :download_dir,
+                                         env_name: "DOWNLOAD_DIR",
+                                         description: "Target directory to download screenshots from firebase",
+                                         type: String,
+                                         optional: true,
+                                         default_value: nil),
+
+            # robo_script_path (false)
+            FastlaneCore::ConfigItem.new(key: :robo_script_path,
+                                         env_name: "ROBO_SCRIPT_PATH",
+                                         description: "Path to Robo script JSON file",
+                                         is_string: true,
+                                         optional: true,
+                                         verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find JSON file at path '#{value}'") unless File.exist?(value) end)
+      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
+
+      # android platform
+      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
+
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/android_testlab_script_swit/helper/android_testlab_script_swit_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class AndroidTestlabScriptSwitHelper
+      # class methods that you define here become available in your action
+      # as `Helper::AndroidTestlabScriptSwitHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the android_testlab_script_swit plugin helper!")
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/android_testlab_script_swit.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/android_testlab_script_swit/version'
+
+module Fastlane
+  module AndroidTestlabScriptSwit
+    # 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::AndroidTestlabScriptSwit.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-android_testlab_script_swit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 나비이쁜이
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-24 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: 2.214.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.214.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: 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: 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'
+description:
+email: munkijung1992@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/android_testlab_script_swit.rb
+- lib/fastlane/plugin/android_testlab_script_swit/actions/android_testlab_script_swit_action.rb
+- lib/fastlane/plugin/android_testlab_script_swit/helper/android_testlab_script_swit_helper.rb
+- lib/fastlane/plugin/android_testlab_script_swit/version.rb
+homepage: https://github.com/munki1992/android_testlab_script_swit
+licenses:
+- MIT
+metadata: {}
+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: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: short
+test_files: []