fastlane-plugin-emerge 0.6.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1447dca3b388a05160397929cd49bd402f82c97cce36e3118b5fc8a91dc0b8
-  data.tar.gz: 94f2deab73ca67cb4520c7b2958a003106b07b16c32abd614613c0f0d1b6c13c
+  metadata.gz: e170856bceb03b9747e72d074ce9a96d124dfe6519e5bc9f47becffb39b1acea
+  data.tar.gz: 71d34166a5fa640ac3af5ec2763a8b373052e3da358c0dc68dce5ed4bb46bd32
 SHA512:
-  metadata.gz: e747d8c426f8d873e7a89dc30dce0c03e24a8dbf9e697aab6f7a3b66d0de7aeef0308518a67427e0a91ac7a8d7192385e7404449607bcbf7d77d9b58f76d5260
-  data.tar.gz: dd5874a90ad2edfdf97a99eda6736ad9e442a75fdc9e204c7ef2e116db68801175dbe32d7bf98c00f8e401b1381012131ee2133bd3775c1703551843ef77eed4
+  metadata.gz: '07929884d01b7ce42b2863dc9973768b2bb033da495e6d63c6dd09a66e63d6613e55c41a0845eff819afcd8689897d5c32c6099028e0059e2f12df9aed1470af'
+  data.tar.gz: a971a076cb1724adec271841883b49a0ecfac4fe245884076b64cc655f1fabf930af60830f76cf7dbd46005d6e28c5a16d01d716a6ae63133df8a7cf6a013f56

data/lib/fastlane/plugin/emerge/actions/emerge_action.rb

@@ -1,6 +1,8 @@
 require 'fastlane/action'
 require 'fastlane_core/print_table'
 require_relative '../helper/emerge_helper'
+require_relative '../helper/git'
+require_relative '../helper/github'
 require 'pathname'
 require 'tmpdir'
 require 'json'
@@ -13,20 +15,21 @@ module Fastlane
         api_token = params[:api_token]
         file_path = params[:file_path] || lane_context[SharedValues::XCODEBUILD_ARCHIVE]
 
-        if file_path == nil
+        if file_path.nil?
           file_path = Dir.glob("#{lane_context[SharedValues::SCAN_DERIVED_DATA_PATH]}/Build/Products/Debug-iphonesimulator/*.app").first
         end
-        pr_number = params[:pr_number]
-        branch = params[:branch]
-        sha = params[:sha] || params[:build_id]
-        base_sha = params[:base_sha] || params[:base_build_id]
-        repo_name = params[:repo_name]
+        git_params = Helper::EmergeHelper.make_git_params
+        pr_number = params[:pr_number] || git_params.pr_number
+        branch = params[:branch] || git_params.branch
+        sha = params[:sha] || params[:build_id] || git_params.sha
+        base_sha = params[:base_sha] || params[:base_build_id] || git_params.base_sha
+        repo_name = params[:repo_name] || git_params.repo_name
         gitlab_project_id = params[:gitlab_project_id]
-        build_type = params[:build_type]
+        tag = params[:tag]
         order_file_version = params[:order_file_version]
         config_path = params[:config_path]
 
-        if file_path == nil || !File.exist?(file_path)
+        if file_path.nil? || !File.exist?(file_path)
           UI.error("Invalid input file")
           return
         end
@@ -38,8 +41,8 @@ module Fastlane
           Dir.mktmpdir do |d|
             application_folder = "#{d}/archive.xcarchive/Products/Applications/"
             dsym_folder = "#{d}/archive.xcarchive/dSYMs/"
-            FileUtils.mkdir_p application_folder
-            FileUtils.mkdir_p dsym_folder
+            FileUtils.mkdir_p(application_folder)
+            FileUtils.mkdir_p(dsym_folder)
             if params[:linkmaps] && params[:linkmaps].length > 0
               linkmap_folder = "#{d}/archive.xcarchive/Linkmaps/"
               FileUtils.mkdir_p(linkmap_folder)
@@ -51,13 +54,14 @@ module Fastlane
             FileUtils.cp_r(file_path, application_folder)
             copy_dsyms("#{absolute_path.dirname}/*.dsym", dsym_folder)
             copy_dsyms("#{absolute_path.dirname}/*/*.dsym", dsym_folder)
-            Xcodeproj::Plist.write_to_path({"NAME" => "Emerge Upload"}, "#{d}/archive.xcarchive/Info.plist")
+            Xcodeproj::Plist.write_to_path({ "NAME" => "Emerge Upload" }, "#{d}/archive.xcarchive/Info.plist")
             file_path = "#{absolute_path.dirname}/archive.xcarchive.zip"
             ZipAction.run(
               path: "#{d}/archive.xcarchive",
               output_path: file_path,
               exclude: [],
-              include: [])
+              include: []
+            )
             UI.message("Archive generated at #{file_path}")
           end
         elsif File.extname(file_path) == '.xcarchive'
@@ -74,11 +78,12 @@ module Fastlane
             path: file_path,
             output_path: zip_path,
             exclude: [],
-            include: [])
+            include: []
+          )
           file_path = zip_path
         elsif File.extname(file_path) == '.zip' && params[:linkmaps] && params[:linkmaps].length > 0
           UI.error("Provided zipped archive and linkmaps, linkmaps will not be added to zip.")
-        elsif !File.extname(file_path) == '.zip'
+        elsif File.extname(file_path) != '.zip'
           UI.error("Invalid input file")
           return
         end
@@ -86,7 +91,7 @@ module Fastlane
         filename = File.basename(file_path)
         url = 'https://api.emergetools.com/upload'
         params = {
-          filename: filename,
+          filename: filename
         }
         if pr_number
           params[:prNumber] = pr_number
@@ -109,24 +114,33 @@ module Fastlane
         if order_file_version
           params[:orderFileVersion] = order_file_version
         end
-        params[:buildType] = build_type || "development"
+        params[:tag] = tag || "default"
         FastlaneCore::PrintTable.print_values(
           config: params,
           hide_keys: [],
-          title: "Summary for Emerge #{Fastlane::Emerge::VERSION}")
-        resp = Faraday.post(url, params.to_json, {'Content-Type' => 'application/json', 'X-API-Token' => api_token})
+          title: "Summary for Emerge #{Fastlane::Emerge::VERSION}"
+        )
+        resp = Faraday.post(
+          url,
+          params.to_json,
+          'Content-Type' => 'application/json', 'X-API-Token' => api_token, 'User-Agent' => "fastlane-plugin-emerge/#{Fastlane::Emerge::VERSION}"
+        )
         case resp.status
         when 200
           json = JSON.parse(resp.body)
           upload_id = json["upload_id"]
           upload_url = json["uploadURL"]
-          Helper::EmergeHelper.perform_upload(upload_url, upload_id, file_path)
+          warning = json["warning"]
+          if warning
+            UI.important(warning)
+          end
+          return Helper::EmergeHelper.perform_upload(upload_url, upload_id, file_path)
         when 403
           UI.error("Invalid API token")
         when 400
           UI.error("Invalid parameters")
           json = JSON.parse(resp.body)
-          UI.error("Error: #{json["errorMessage"]}")
+          UI.error("Error: #{json['errorMessage']}")
         else
           UI.error("Upload failed")
         end
@@ -140,10 +154,10 @@ module Fastlane
       end
 
       def self.copy_config(config_path, tmp_dir)
-        return unless config_path != nil
+        return if config_path.nil?
 
         expanded_path = File.expand_path(config_path)
-        if not File.exist?(expanded_path)
+        unless File.exist?(expanded_path)
           UI.error("No config file found at path '#{expanded_path}'.\nUploading without config file")
           return
         end
@@ -161,84 +175,79 @@ module Fastlane
       end
 
       def self.return_value
-        # If your method provides a return value, you can describe here what it does
+        "If successful, returns the upload id of the generated build"
       end
 
       def self.details
-        # Optional:
         ""
       end
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :api_token,
-                                  env_name: "EMERGE_API_TOKEN",
-                               description: "An API token for Emerge",
-                                  optional: false,
-                                      type: String),
+                                       env_name: "EMERGE_API_TOKEN",
+                                       description: "An API token for Emerge",
+                                       optional: false,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :file_path,
-                                  env_name: "EMERGE_FILE_PATH",
-                               description: "Path to the zipped xcarchive or app to upload",
-                                  optional: true,
-                                      type: String),
+                                       env_name: "EMERGE_FILE_PATH",
+                                       description: "Path to the zipped xcarchive or app to upload",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :linkmaps,
-                                   description: "List of paths to linkmaps",
-                                      optional: true,
-                                          type: Array),
+                                       description: "List of paths to linkmaps",
+                                       optional: true,
+                                       type: Array),
           FastlaneCore::ConfigItem.new(key: :pr_number,
-                               description: "The PR number that triggered this upload",
-                                  optional: true,
-                                      type: String),
+                                       description: "The PR number that triggered this upload",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :branch,
-                              description: "The current git branch",
-                                optional: true,
-                                    type: String),
+                                       description: "The current git branch",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :sha,
-                              description: "The git SHA that triggered this build",
-                                optional: true,
-                                    type: String),
+                                       description: "The git SHA that triggered this build",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :base_sha,
-                               description: "The git SHA of the base build",
-                                  optional: true,
-                                      type: String),
+                                       description: "The git SHA of the base build",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :build_id,
-                               description: "A string to identify this build",
-                                deprecated: "Replaced by `sha`",
-                                  optional: true,
-                                      type: String),
+                                       description: "A string to identify this build",
+                                       deprecated: "Replaced by `sha`",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :base_build_id,
-                               description: "Id of the build to compare with this upload",
-                                deprecated: "Replaced by `base_sha`",
-                                  optional: true,
-                                      type: String),
+                                       description: "Id of the build to compare with this upload",
+                                       deprecated: "Replaced by `base_sha`",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :repo_name,
-                               description: "Full name of the respository this upload was triggered from. For example: EmergeTools/Emerge",
-                                  optional: true,
-                                      type: String),
+                                       description: "Full name of the respository this upload was triggered from. For example: EmergeTools/Emerge",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :gitlab_project_id,
-                               description: "Id of the gitlab project this upload was triggered from",
-                                  optional: true,
-                                      type: Integer),
-          FastlaneCore::ConfigItem.new(key: :build_type,
-                               description: "String to identify the type of build such as release/development. Used to filter size graphs. Defaults to development",
-                                  optional: true,
-                                      type: String),
+                                       description: "Id of the gitlab project this upload was triggered from",
+                                       optional: true,
+                                       type: Integer),
+          FastlaneCore::ConfigItem.new(key: :tag,
+                                       description: "String to label the build. Useful for grouping builds together in our dashboard, like development, default, or pull-request",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :order_file_version,
-                               description: "Version of the order file to download",
-                                  optional: true,
-                                      type: String),
+                                       description: "Version of the order file to download",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :config_path,
-                               description: "Path to Emerge config path",
-                                  optional: true,
-                                      type: String),
+                                       description: "Path to Emerge config path",
+                                       optional: true,
+                                       type: String)
         ]
       end
 
       def self.is_supported?(platform)
-        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
-        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
-        #
-        # [:ios, :mac, :android].include?(platform)
         platform == :ios
       end
     end

data/lib/fastlane/plugin/emerge/actions/emerge_comment_action.rb

@@ -12,23 +12,23 @@ module Fastlane
         project_id = params[:gitlab_project_id]
         pr_number = params[:pr_number]
         gitlab_access_token = params[:gitlab_access_token]
-        
-        requestParams = {
+
+        request_params = {
           buildId: params[:build_id],
           baseBuildId: params[:base_build_id]
         }
-        resp = Faraday.get(url, requestParams, {'x-api-token' => api_token})
+        resp = Faraday.get(url, request_params, 'x-api-token' => api_token)
         case resp.status
         when 200
           UI.message("Received comment from Emerge")
           baseURL = gitlab_url ? gitlab_url : "https://gitlab.com"
           url = "#{baseURL}/api/v4/projects/#{project_id}/merge_requests/#{pr_number}/notes"
-          gitlabResponse = Faraday.post(url, {"body" => resp.body}, {'Authorization' => "Bearer #{gitlab_access_token}"})
-          case gitlabResponse.status
+          gitlab_response = Faraday.post(url, { "body" => resp.body }, 'Authorization' => "Bearer #{gitlab_access_token}")
+          case gitlab_response.status
           when 200...299
             UI.message("Successfully posted comment")
           else
-            UI.error("Received error #{gitlabResponse.status} from Gitlab")
+            UI.error("Received error #{gitlab_response.status} from Gitlab")
           end
         else
           UI.error("Received error #{resp.status} from Emerge")
@@ -46,35 +46,35 @@ module Fastlane
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :api_token,
-                                  env_name: "EMERGE_API_TOKEN",
-                               description: "An API token for Emerge",
-                                  optional: false,
-                                      type: String),
+                                       env_name: "EMERGE_API_TOKEN",
+                                       description: "An API token for Emerge",
+                                       optional: false,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :gitlab_acces_token,
-                                  env_name: "GITLAB_ACCESS_TOKEN",
-                               description: "An access token for Gitlab",
-                                  optional: false,
-                                      type: String),
+                                       env_name: "GITLAB_ACCESS_TOKEN",
+                                       description: "An access token for Gitlab",
+                                       optional: false,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :pr_number,
-                               description: "The PR number that triggered this upload",
-                                  optional: false,
-                                      type: String),
+                                       description: "The PR number that triggered this upload",
+                                       optional: false,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :build_id,
-                               description: "A string to identify this build",
-                                  optional: false,
-                                      type: String),
+                                       description: "A string to identify this build",
+                                       optional: false,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :base_build_id,
-                               description: "Id of the build to compare with this upload",
-                                  optional: false,
-                                      type: String),
+                                       description: "Id of the build to compare with this upload",
+                                       optional: false,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :gitlab_url,
-                               description: "URL of the self hosted gitlab instance",
-                                  optional: true,
-                                      type: String),
+                                       description: "URL of the self hosted gitlab instance",
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :gitlab_project_id,
-                               description: "Id of the gitlab project this upload was triggered from",
-                                  optional: false,
-                                      type: Integer)
+                                       description: "Id of the gitlab project this upload was triggered from",
+                                       optional: false,
+                                       type: Integer)
         ]
       end
 
@@ -83,4 +83,4 @@ module Fastlane
       end
     end
   end
-end
+end

data/lib/fastlane/plugin/emerge/helper/emerge_helper.rb

@@ -4,21 +4,57 @@ require 'faraday'
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
 
+  class GitResult
+    attr_accessor :sha, :base_sha, :branch, :pr_number, :repo_name
+
+    def initialize(sha:, base_sha:, branch:, pr_number: nil, repo_name: nil)
+      @pr_number = pr_number
+      @sha = sha
+      @base_sha = base_sha
+      @branch = branch
+      @repo_name = repo_name
+    end
+  end
+
   module Helper
     class EmergeHelper
       def self.perform_upload(upload_url, upload_id, file_path)
         UI.message("Starting upload")
         response = Faraday.put(upload_url) do |req|
           req.headers['Content-Type'] = 'application/zip'
-          req.headers['Content-Length'] = "#{File.size(file_path)}"
+          req.headers['Content-Length'] = File.size(file_path).to_s
           req.body = Faraday::UploadIO.new(file_path, 'application/zip')
         end
         case response.status
         when 200
-          UI.success("Your app is processing, you can find the results at https://emergetools.com/build/#{upload_id}")
+          UI.success("🎉 Your app is processing, you can find the results at https://emergetools.com/build/#{upload_id}")
+          return upload_id
         else
           UI.error("Upload failed")
         end
+        return nil
+      end
+
+      def self.make_git_params
+        git_result = if Helper::Github.is_supported_github_event?
+                       UI.message("Fetching Git info from Github event")
+                       GitResult.new(
+                         sha: Helper::Github.sha,
+                         base_sha: Helper::Github.base_sha,
+                         branch: Helper::Github.branch,
+                         pr_number: Helper::Github.pr_number,
+                         repo_name: Helper::Github.repo_name
+                       )
+                     else
+                       UI.message("Fetching Git info from system Git")
+                       GitResult.new(
+                         sha: Helper::Git.sha,
+                         base_sha: Helper::Git.base_sha,
+                         branch: Helper::Git.branch
+                       )
+                     end
+        UI.message("Got git result #{git_result.inspect}")
+        git_result
       end
     end
   end

data/lib/fastlane/plugin/emerge/helper/git.rb

@@ -0,0 +1,66 @@
+require 'fastlane_core/print_table'
+require 'open3'
+
+module Fastlane
+  module Helper
+    module Git
+      def self.branch
+        shell_command = "git rev-parse --abbrev-ref HEAD"
+        UI.command(shell_command)
+        stdout, _, status = Open3.capture3(shell_command)
+        stdout.strip if status.success?
+      end
+
+      def self.sha
+        shell_command = "git rev-parse HEAD"
+        UI.command(shell_command)
+        stdout, _, status = Open3.capture3(shell_command)
+        stdout.strip if status.success?
+      end
+
+      def self.base_sha
+        shell_command = "git merge-base #{remote_head_branch} #{branch}"
+        UI.command(shell_command)
+        stdout, _, status = Open3.capture3(shell_command)
+        return nil if stdout.strip.empty? || !status.success?
+        current_sha = sha
+        stdout.strip == current_sha ? nil : stdout.strip
+      end
+
+      def self.primary_remote
+        remote = remote()
+        return nil if remote.nil?
+        remote.include?("origin") ? "origin" : remote.first
+      end
+
+      def self.remote_head_branch(remote = primary_remote)
+        return nil if remote.nil?
+        shell_command = "git remote show #{remote}"
+        UI.command(shell_command)
+        stdout, _, status = Open3.capture3(shell_command)
+        return nil if stdout.nil? || !status.success?
+        stdout
+          .split("\n")
+          .map(&:strip)
+          .find { |line| line.start_with?("HEAD branch: ") }
+          &.split(' ')
+          &.last
+      end
+
+      def self.remote_url(remote = primary_remote)
+        return nil if remote.nil?
+        shell_command = "git config --get remote.#{remote}.url"
+        UI.command(shell_command)
+        stdout, _, status = Open3.capture3(shell_command)
+        stdout if status.success?
+      end
+
+      def self.remote
+        shell_command = "git remote"
+        UI.command(shell_command)
+        stdout, _, status = Open3.capture3(shell_command)
+        stdout.split("\n") if status.success?
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/emerge/helper/github.rb

@@ -0,0 +1,77 @@
+require 'json'
+require 'fastlane_core/print_table'
+require_relative 'git'
+
+module Fastlane
+  module Helper
+    module Github
+      GITHUB_EVENT_PR = "pull_request".freeze
+      GITHUB_EVENT_PUSH = "push".freeze
+
+      def self.event_name
+        ENV['GITHUB_EVENT_NAME']
+      end
+
+      def self.is_supported_github_event?
+        UI.message("GitHub event name: #{event_name}")
+        is_pull_request? || is_push?
+      end
+
+      def self.is_pull_request?
+        event_name == GITHUB_EVENT_PR
+      end
+
+      def self.is_push?
+        event_name == GITHUB_EVENT_PUSH
+      end
+
+      def self.sha
+        if is_push?
+          ENV['GITHUB_SHA']
+        elsif is_pull_request?
+          github_event_data.dig(:pull_request, :head, :sha)
+        end
+      end
+
+      def self.base_sha
+        if is_pull_request?
+          github_event_data.dig(:pull_request, :base, :sha)
+        end
+      end
+
+      def self.pr_number
+        is_pull_request? ? github_event_data.dig(:number) : nil
+      end
+
+      def self.branch
+        is_pull_request? ? github_event_data.dig(:pull_request, :head, :ref) : Git.branch
+      end
+
+      def self.repo_owner
+        github_event_data.dig(:repository, :owner, :login)
+      end
+
+      def self.repo_name
+        github_event_data.dig(:repository, :full_name)
+      end
+
+      private_class_method
+
+      def self.github_event_data
+        github_event_path = ENV['GITHUB_EVENT_PATH']
+        UI.error!("GITHUB_EVENT_PATH is not set") if github_event_path.nil?
+
+        unless File.exist?(github_event_path)
+          UI.error!("File #{github_event_path} doesn't exist")
+        end
+
+        file_content = File.read(github_event_path)
+        file_json = JSON.parse(file_content, symbolize_names: true)
+        if ENV['DEBUG']
+          UI.message("Parsed GitHub event data: #{file_json.inspect}")
+        end
+        file_json
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Emerge
-    VERSION = "0.6.2"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-emerge
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Emerge Tools, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-30 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -163,6 +163,8 @@ files:
 - lib/fastlane/plugin/emerge/actions/emerge_comment_action.rb
 - lib/fastlane/plugin/emerge/actions/emerge_order_file_action.rb
 - lib/fastlane/plugin/emerge/helper/emerge_helper.rb
+- lib/fastlane/plugin/emerge/helper/git.rb
+- lib/fastlane/plugin/emerge/helper/github.rb
 - lib/fastlane/plugin/emerge/version.rb
 homepage: https://github.com/EmergeTools/fastlane-plugin-emerge
 licenses: