fastlane-plugin-firebase_app_distribution 0.2.0.pre.3 → 0.2.2.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c591cb4a3b841f9fc26c94f3ff32b78b321ed904cc176e05a053e330543cd535
-  data.tar.gz: 0114a22cc34eec1970b5b280746b46b9d858407bbb5c1c7b3f3d54842e75b4d5
+  metadata.gz: c5ca3144300e192d87eb1e9457152c5484a057dfcb0d492d672da8cbbf983368
+  data.tar.gz: ab60ae5cf17ba96547e2278b34c4858149960247fcc593e3bd3cb1794d9eaef9
 SHA512:
-  metadata.gz: 493da92f746defa50af47f9b2d920b65fa5fcbfbb085f0be74979fe7f26f684b78697be17c5e32eeac7fe1d0d78667ece5ef7198138358f6831870c382a5d753
-  data.tar.gz: 7afb5987aa4fd08032d4fa684b9c291d3c4dc762d2978b37bbe4e921ae5730a9a547819a49b61ee2d120617d961b13891b03f17f1ad48deb004eb125b658ad65
+  metadata.gz: 14da8737b9424a01aca4e6df1fdc3ce5254343b89e01fbdac31c9e9176cec5b5d351a78dc1d03adc0d1c031207fee049c5a517cf63ce440cf45fa7326cab45a2
+  data.tar.gz: eda22a0b5c8cee1b0c990db5f0137c867d7e5a2be8ee7bd30c50811ba80e9b2585e4af5f56bdd82fcaee1adcfa0367286511c6be3fbdf7f550abb69e88941ea6

data/lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_action.rb

@@ -20,22 +20,14 @@ module Fastlane
 
       def self.run(params)
         params.values # to validate all inputs before looking for the ipa/apk
+
+        app_id = app_id_from_params(params)
+        platform = lane_platform || platform_from_app_id(app_id)
+        binary_path = binary_path_from_platform(platform, params[:ipa_path], params[:apk_path])
+
         auth_token = fetch_auth_token(params[:service_credentials_file], params[:firebase_cli_token])
         fad_api_client = Client::FirebaseAppDistributionApiClient.new(auth_token, platform)
-        binary_path = params[:ipa_path] || params[:apk_path]
-
-        if params[:app] # Set app_id if it is specified as a parameter
-          app_id = params[:app]
-        elsif platform == :ios
-          archive_path = Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE]
-          if archive_path
-            app_id = get_ios_app_id_from_archive(archive_path)
-          end
-        end
 
-        if app_id.nil?
-          UI.crash!(ErrorMessage::MISSING_APP_ID)
-        end
         release_id = fad_api_client.upload(app_id, binary_path, platform.to_s)
         if release_id.nil?
           return
@@ -49,7 +41,7 @@ module Fastlane
         emails = string_to_array(testers)
         group_ids = string_to_array(groups)
         fad_api_client.enable_access(app_id, release_id, emails, group_ids)
-        UI.success("App Distribution upload finished successfully")
+        UI.success("🎉 App Distribution upload finished successfully.")
       end
 
       def self.description
@@ -65,16 +57,56 @@ module Fastlane
         "Release your beta builds with Firebase App Distribution"
       end
 
-      def self.platform
-        @platform ||= Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+      def self.app_id_from_params(params)
+        if params[:app]
+          app_id = params[:app]
+        elsif xcode_archive_path
+          plist_path = params[:googleservice_info_plist_path]
+          app_id = get_ios_app_id_from_archive_plist(xcode_archive_path, plist_path)
+        end
+        if app_id.nil?
+          UI.crash!(ErrorMessage::MISSING_APP_ID)
+        end
+        app_id
+      end
+
+      def self.xcode_archive_path
+        # prevents issues on cross-platform build environments where an XCode build happens within
+        # the same lane
+        return nil if lane_platform == :android
+
+        Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE]
+      end
+
+      def self.lane_platform
+        Actions.lane_context[Actions::SharedValues::PLATFORM_NAME]
+      end
+
+      def self.platform_from_app_id(app_id)
+        if app_id.include?(':ios:')
+          :ios
+        elsif app_id.include?(':android:')
+          :android
+        end
+      end
+
+      def self.binary_path_from_platform(platform, ipa_path, apk_path)
+        case platform
+        when :ios
+          ipa_path
+        when :android
+          apk_path
+        else
+          ipa_path || apk_path
+        end
       end
 
       def self.available_options
-        if platform == :ios || platform.nil?
+        if lane_platform == :ios || lane_platform.nil?
           ipa_path_default = Dir["*.ipa"].sort_by { |x| File.mtime(x) }.last
         end
 
-        if platform == :android
+        if lane_platform == :android
           apk_path_default = Dir["*.apk"].last || Dir[File.join("app", "build", "outputs", "apk", "app-release.apk")].last
         end
 
@@ -89,6 +121,12 @@ module Fastlane
                                        verify_block: proc do |value|
                                          UI.user_error!("firebase_app_distribution: Couldn't find ipa file at path '#{value}'") unless File.exist?(value)
                                        end),
+          FastlaneCore::ConfigItem.new(key: :googleservice_info_plist_path,
+                                       env_name: "GOOGLESERVICE_INFO_PLIST_PATH",
+                                       description: "Path to your GoogleService-Info.plist file, relative to the root of your Xcode project",
+                                       default_value: "GoogleService-Info.plist",
+                                       optional: true,
+                                       type: String),
           # Android Specific
           FastlaneCore::ConfigItem.new(key: :apk_path,
                                        env_name: "FIREBASEAPPDISTRO_APK_PATH",
@@ -105,9 +143,9 @@ module Fastlane
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_path,
+                                       deprecated: "This plugin no longer uses the Firebase CLI",
                                        env_name: "FIREBASEAPPDISTRO_FIREBASE_CLI_PATH",
                                        description: "The absolute path of the firebase cli command",
-                                       optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :groups,
                                        env_name: "FIREBASEAPPDISTRO_GROUPS",
@@ -175,18 +213,6 @@ module Fastlane
           CODE
         ]
       end
-
-      ## TODO: figure out if we can surpress color output.
-      def self.is_firebasecmd_supported?(cmd)
-        outerr, status = Open3.capture2e(cmd, "--non-interactive", FIREBASECMD_ACTION, "--help")
-        return false unless status.success?
-
-        if outerr =~ /is not a Firebase command/
-          return false
-        end
-
-        true
-      end
     end
   end
 end

data/lib/fastlane/plugin/firebase_app_distribution/client/firebase_app_distribution_api_client.rb

@@ -33,7 +33,7 @@ module Fastlane
       # Throws a user_error if app_id, emails, or group_ids are invalid
       def enable_access(app_id, release_id, emails, group_ids)
         if (emails.nil? || emails.empty?) && (group_ids.nil? || group_ids.empty?)
-          UI.message("No testers passed in. Skipping this step")
+          UI.success("✅ No testers passed in. Skipping this step.")
           return
         end
         payload = { emails: emails, groupIds: group_ids }
@@ -46,7 +46,7 @@ module Fastlane
         rescue Faraday::ClientError
           UI.user_error!("#{ErrorMessage::INVALID_TESTERS} \nEmails: #{emails} \nGroups: #{group_ids}")
         end
-        UI.success("Added testers/groups successfully.")
+        UI.success("✅ Added testers/groups.")
       end
 
       # Posts notes for the specified app release. Skips this
@@ -61,7 +61,7 @@ module Fastlane
       def post_notes(app_id, release_id, release_notes)
         payload = { releaseNotes: { releaseNotes: release_notes } }
         if release_notes.nil? || release_notes.empty?
-          UI.message("No release notes passed in. Skipping this step.")
+          UI.success("✅ No release notes passed in. Skipping this step.")
           return
         end
         begin
@@ -73,7 +73,7 @@ module Fastlane
           # rescue Faraday::ClientError
           #   UI.user_error!("#{ErrorMessage::INVALID_RELEASE_ID}: #{release_id}")
         end
-        UI.success("Posted release notes.")
+        UI.success("✅ Posted release notes.")
       end
 
       # Returns the url encoded upload token used for get_upload_status calls:
@@ -89,7 +89,7 @@ module Fastlane
         if binary_path.nil? || !File.exist?(binary_path)
           UI.crash!("#{ErrorMessage.binary_not_found(@binary_type)}: #{binary_path}")
         end
-        binary_hash = Digest::SHA256.hexdigest(File.open(binary_path).read)
+        binary_hash = Digest::SHA256.hexdigest(read_binary(binary_path))
 
         begin
           response = connection.get(v1_apps_url(app_id)) do |request|
@@ -105,17 +105,25 @@ module Fastlane
         return upload_token_format(response.body[:appId], response.body[:projectNumber], binary_hash)
       end
 
+      # Uploads the app binary to the Firebase API
+      #
+      # args
+      #   app_id - Firebase App ID
+      #   binary_path - Absolute path to your app's apk/ipa file
+      #   platform - 'android' or 'ios'
+      #
+      # Throws a user_error if an invalid app id is passed in, or if the binary file does not exist
       def upload_binary(app_id, binary_path, platform)
-        connection.post(binary_upload_url(app_id), File.open(binary_path).read) do |request|
+        connection.post(binary_upload_url(app_id), read_binary(binary_path)) do |request|
           request.headers["Authorization"] = "Bearer " + @auth_token
           request.headers["X-APP-DISTRO-API-CLIENT-ID"] = "fastlane"
           request.headers["X-APP-DISTRO-API-CLIENT-TYPE"] =  platform
           request.headers["X-APP-DISTRO-API-CLIENT-VERSION"] = Fastlane::FirebaseAppDistribution::VERSION
         end
       rescue Faraday::ResourceNotFound
-        UI.crash!("#{ErrorMessage::INVALID_APP_ID}: #{app_id}")
-      rescue Errno::ENOENT
-        UI.crash!("#{ErrorMessage.binary_not_found(@binary_type)}: #{binary_path}")
+        UI.user_error!("#{ErrorMessage::INVALID_APP_ID}: #{app_id}")
+      rescue Errno::ENOENT # Raised when binary_path file does not exist
+        UI.user_error!("#{ErrorMessage.binary_not_found(@binary_type)}: #{binary_path}")
       end
 
       # Uploads the binary file if it has not already been uploaded
@@ -133,17 +141,16 @@ module Fastlane
         upload_token = get_upload_token(app_id, binary_path)
         upload_status_response = get_upload_status(app_id, upload_token)
         if upload_status_response.success? || upload_status_response.already_uploaded?
-          UI.success("This #{@binary_type} has been uploaded before. Skipping upload step.")
+          UI.success("✅ This #{@binary_type} has been uploaded before. Skipping upload step.")
         else
-          UI.message("This #{@binary_type} has not been uploaded before")
-          UI.message("Uploading the #{@binary_type}.")
           unless upload_status_response.in_progress?
+            UI.message("⌛ Uploading the #{@binary_type}.")
             upload_binary(app_id, binary_path, platform)
           end
           MAX_POLLING_RETRIES.times do
             upload_status_response = get_upload_status(app_id, upload_token)
             if upload_status_response.success? || upload_status_response.already_uploaded?
-              UI.success("Uploaded #{@binary_type} successfully!")
+              UI.success("✅ Uploaded the #{@binary_type}.")
               break
             elsif upload_status_response.in_progress?
               sleep(POLLING_INTERVAL_SECONDS)
@@ -163,14 +170,22 @@ module Fastlane
         upload_status_response.release_id
       end
 
-      # Gets the upload status for the app release.
-      def get_upload_status(app_id, app_token)
+      # Fetches the status of an uploaded binary
+      #
+      # args
+      #   app_id - Firebase App ID
+      #   upload_token - URL encoded upload token
+      #
+      # Returns the release ID on a successful release, otherwise returns nil.
+      #
+      # Throws a user_error if an invalid app_id is passed in
+      def get_upload_status(app_id, upload_token)
         begin
-          response = connection.get(upload_status_url(app_id, app_token)) do |request|
+          response = connection.get(upload_status_url(app_id, upload_token)) do |request|
             request.headers["Authorization"] = "Bearer " + @auth_token
           end
         rescue Faraday::ResourceNotFound
-          UI.crash!("#{ErrorMessage::INVALID_APP_ID}: #{app_id}")
+          UI.user_error!("#{ErrorMessage::INVALID_APP_ID}: #{app_id}")
         end
         return UploadStatusResponse.new(response.body)
       end
@@ -208,6 +223,11 @@ module Fastlane
           conn.adapter(Faraday.default_adapter)
         end
       end
+
+      def read_binary(path)
+        # File must be read in binary mode to work on Windows
+        File.open(path, 'rb').read
+      end
     end
   end
 end

data/lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_auth_client.rb

@@ -38,7 +38,7 @@ module Fastlane
         else
           UI.user_error!(ErrorMessage::MISSING_CREDENTIALS)
         end
-        UI.success("Successfully authenticated!")
+        UI.success("🔐 Authenticated successfully.")
         token
       end
 

data/lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_helper.rb

@@ -28,10 +28,10 @@ module Fastlane
         CFPropertyList.native_types(CFPropertyList::List.new(file: path).value)
       end
 
-      def get_ios_app_id_from_archive(path)
-        app_path = parse_plist("#{path}/Info.plist")["ApplicationProperties"]["ApplicationPath"]
-        UI.shell_error!("can't extract application path from Info.plist at #{path}") if app_path.empty?
-        identifier = parse_plist("#{path}/Products/#{app_path}/GoogleService-Info.plist")["GOOGLE_APP_ID"]
+      def get_ios_app_id_from_archive_plist(archive_path, plist_path)
+        app_path = parse_plist("#{archive_path}/Info.plist")["ApplicationProperties"]["ApplicationPath"]
+        UI.shell_error!("can't extract application path from Info.plist at #{archive_path}") if app_path.empty?
+        identifier = parse_plist("#{archive_path}/Products/#{app_path}/#{plist_path}")["GOOGLE_APP_ID"]
         UI.shell_error!("can't extract GOOGLE_APP_ID") if identifier.empty?
         return identifier
       end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module FirebaseAppDistribution
-    VERSION = "0.2.0.pre.3"
+    VERSION = "0.2.2.pre.2"
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-firebase_app_distribution
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.3
+  version: 0.2.2.pre.2
 platform: ruby
 authors:
 - Stefan Natchev
 - Manny Jimenez
 - Alonso Salas Infante
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -138,7 +138,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.127.1
-description: 
+description:
 email:
 - snatchev@google.com
 - mannyjimenez@google.com
@@ -162,7 +162,7 @@ homepage: https://github.com/fastlane/fastlane-plugin-firebase_app_distribution
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Release your beta builds to Firebase App Distribution. https://firebase.google.com/docs/app-distribution
 test_files: []