fastlane-plugin-wpmreleasetoolkit 4.1.0 → 5.1.0

data/lib/fastlane/plugin/wpmreleasetoolkit/models/firebase_device.rb

@@ -0,0 +1,62 @@
+module Fastlane
+  class FirebaseDevice
+    attr_reader :model, :version, :locale, :orientation
+
+    def initialize(model:, version:, orientation:, locale: 'en')
+      raise 'Invalid Model' unless FirebaseDevice.valid_model_names.include? model
+      raise 'Invalid Version' unless FirebaseDevice.valid_version_numbers.include? version
+      raise 'Invalid Locale' unless FirebaseDevice.valid_locales.include? locale
+      raise 'Invalid Orientation' unless FirebaseDevice.valid_orientations.include? orientation
+
+      @model = model
+      @version = version
+      @locale = locale
+      @orientation = orientation
+    end
+
+    def to_s
+      "model=#{@model},version=#{@version},locale=#{@locale},orientation=#{@orientation}"
+    end
+
+    class << self
+      @locale_data = nil
+      @model_data = nil
+      @version_data = nil
+
+      def valid_model_names
+        JSON.parse(model_data).map { |device| device['codename'] }
+      end
+
+      def valid_version_numbers
+        JSON.parse(version_data).map { |version| version['apiLevel'].to_i }
+      end
+
+      def valid_locales
+        JSON.parse(locale_data).map { |locale| locale['id'] }
+      end
+
+      def valid_orientations
+        %w[portrait landscape]
+      end
+
+      def locale_data
+        FirebaseDevice.verify_logged_in!
+        @locale_data ||= Fastlane::Actions.sh('gcloud', 'firebase', 'test', 'android', 'locales', 'list', '--format="json"', log: false)
+      end
+
+      def model_data
+        FirebaseDevice.verify_logged_in!
+        @model_data ||= Fastlane::Actions.sh('gcloud', 'firebase', 'test', 'android', 'models', 'list', '--format="json"', log: false)
+      end
+
+      def version_data
+        FirebaseDevice.verify_logged_in!
+        @version_data ||= Fastlane::Actions.sh('gcloud', 'firebase', 'test', 'android', 'versions', 'list', '--format="json"', log: false)
+      end
+
+      def verify_logged_in!
+        UI.user_error!('You must call `firebase_login` before creating a FirebaseDevice object') unless FirebaseAccount.authenticated?
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/models/firebase_test_lab_result.rb

@@ -0,0 +1,36 @@
+module Fastlane
+  class FirebaseTestLabResult
+    def initialize(log_file_path:)
+      raise "No log file found at path #{log_file_path}" unless File.file? log_file_path
+
+      @path = log_file_path
+    end
+
+    # Scan the log file to for indications that no test cases failed
+    def success?
+      File.readlines(@path).any? { |line| line.include?('Passed') && line.include?('test cases passed') }
+    end
+
+    # Parse the log for the "More details are available..." URL
+    def more_details_url
+      File.readlines(@path)
+          .flat_map { |line| URI.extract(line) }
+          .find { |url| URI(url).host == 'console.firebase.google.com' && url.include?('/matrices/') }
+    end
+
+    # Parse the log for the Google Cloud Storage Bucket URL
+    def raw_results_paths
+      uri = File.readlines(@path)
+                .flat_map { |line| URI.extract(line) }
+                .map { |string| URI(string) }
+                .find { |u| u.scheme == 'gs' }
+
+      return nil if uri.nil?
+
+      return {
+        bucket: uri.host,
+        prefix: uri.path.delete_prefix('/').chomp('/')
+      }
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/models/firebase_test_runner.rb

@@ -0,0 +1,104 @@
+require 'json'
+require 'uri'
+require 'fileutils'
+require 'google/cloud/storage'
+
+module Fastlane
+  class FirebaseTestRunner
+    VALID_TEST_TYPES = %w[instrumentation robo].freeze
+
+    def self.preflight(verify_gcloud_binary: true, verify_logged_in: true)
+      verify_has_gcloud_binary! if verify_gcloud_binary
+      verify_logged_in! if verify_logged_in
+    end
+
+    # Run a given APK and Test Bundle on the given device type.
+    #
+    # @param [String] project_id The Google Firebase Console Project ID.
+    # @param [String] apk_path Path to the application APK on disk.
+    # @param [String] test_apk_path Path to the test runner APK on disk.
+    # @param [FirebaseDevice] device The virtual device to run tests on.
+    # @param [String] type The type of test to run.
+    #
+    def self.run_tests(project_id:, apk_path:, test_apk_path:, device:, type: 'instrumentation')
+      raise "Unable to find apk: #{apk_path}" unless File.file?(apk_path)
+      raise "Unable to find apk: #{test_apk_path}" unless File.file?(test_apk_path)
+      raise "Invalid Type: #{type}" unless VALID_TEST_TYPES.include?(type)
+
+      command = Shellwords.join [
+        'gcloud', 'firebase', 'test', 'android', 'run',
+        '--project', project_id,
+        '--type', type,
+        '--app', apk_path,
+        '--test', test_apk_path,
+        '--device', device.to_s,
+        '--verbosity', 'info',
+      ]
+
+      log_file_path = Fastlane::Actions.lane_context[:FIREBASE_TEST_LOG_FILE_PATH]
+
+      UI.message "Streaming log output to #{log_file_path}"
+      Action.sh("#{command} 2>&1 | tee #{log_file_path}")
+
+      # Make the file object available to other tasks
+      result = FirebaseTestLabResult.new(log_file_path: log_file_path)
+      Fastlane::Actions.lane_context[:FIREBASE_TEST_LOG_FILE] = result
+
+      result
+    end
+
+    # Downloads all files associated with a Firebase Test Run to the local machine.
+    #
+    # @param [FirebaseTestLabResult] result The result bundle for a given test run.
+    # @param [String] destination The local directory to store all downloaded files.
+    # @param [String] project_id The Google Cloud Project ID – required for Google Cloud Storage access.
+    # @param [String] key_file_path The path to the key file – required for Google Cloud Storage access.
+    #
+    def self.download_result_files(result:, destination:, project_id:, key_file_path:)
+      UI.user_error! 'You must pass a `FirebaseTestLabResult` to this method' unless result.is_a? Fastlane::FirebaseTestLabResult
+
+      paths = result.raw_results_paths
+      UI.user_error! "Log File doesn't contain a raw results URL" if paths.nil?
+
+      FileUtils.mkdir_p(destination) unless File.directory?(destination)
+
+      storage = Google::Cloud::Storage.new(
+        project_id: project_id,
+        credentials: key_file_path
+      )
+
+      # Set up the download
+      bucket = storage.bucket(paths[:bucket])
+      files_to_download = bucket.files(prefix: paths[:prefix])
+
+      # Download the files
+      UI.header "Downloading Results Files to #{destination}"
+      files_to_download.each { |file| download_file(file: file, destination: destination) }
+    end
+
+    # Download a Google Cloud Storage file to the local machine, creating intermediate directories as needed.
+    #
+    # @param [Google::Cloud::Storage::File] file Usually provided via `bucket.files`.
+    # @param [String] destination The local directory to store the file. It will retain its original name.
+    #
+    def self.download_file(file:, destination:)
+      destination = File.join(destination, file.name)
+      FileUtils.mkdir_p(File.dirname(destination))
+
+      # Print our progress
+      UI.message(file.name)
+
+      file.download(destination)
+    end
+
+    def self.verify_has_gcloud_binary!
+      Action.sh('command', '-v', 'gcloud', print_command: false, print_command_output: false)
+    rescue StandardError
+      UI.user_error!("The `gcloud` binary isn't available on this machine. Unable to continue.")
+    end
+
+    def self.verify_logged_in!
+      UI.user_error!('You are not logged into Firebase on this machine. Unable to continue.') unless FirebaseAccount.authenticated?
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Wpmreleasetoolkit
-    VERSION = '4.1.0'
+    VERSION = '5.1.0'
   end
 end

data/lib/fastlane/plugin/wpmreleasetoolkit.rb

@@ -2,9 +2,9 @@ require 'fastlane/plugin/wpmreleasetoolkit/version'
 
 module Fastlane
   module Wpmreleasetoolkit
-    # Return all .rb files inside the "actions" and "helper" directory
+    # Return all .rb files inside the "actions", "helper" and "models" directories
     def self.all_classes
-      Dir[File.expand_path('**/{actions,helper}/**/*.rb', File.dirname(__FILE__))]
+      Dir[File.expand_path('**/{actions,helper,models}/**/*.rb', File.dirname(__FILE__))]
     end
   end
 end