fastlane_hotfix 2.165.1 → 2.187.0

data/fastlane/lib/fastlane/actions/set_pod_key.rb

@@ -36,22 +36,21 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :use_bundle_exec,
                                        env_name: "FL_SET_POD_KEY_USE_BUNDLE_EXEC",
                                        description: "Use bundle exec when there is a Gemfile presented",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: true),
           FastlaneCore::ConfigItem.new(key: :key,
                                        env_name: "FL_SET_POD_KEY_ITEM_KEY",
                                        description: "The key to be saved with cocoapods-keys",
-                                       is_string: true,
                                        optional: false),
           FastlaneCore::ConfigItem.new(key: :value,
                                        env_name: "FL_SET_POD_KEY_ITEM_VALUE",
                                        description: "The value to be saved with cocoapods-keys",
-                                       is_string: true,
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
                                        optional: false),
           FastlaneCore::ConfigItem.new(key: :project,
                                        env_name: "FL_SET_POD_KEY_PROJECT",
                                        description: "The project name",
-                                       is_string: true,
                                        optional: true)
         ]
       end

data/fastlane/lib/fastlane/actions/setup_ci.rb

@@ -92,12 +92,11 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :force,
                                        env_name: "FL_SETUP_CI_FORCE",
                                        description: "Force setup, even if not executed by CI",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false),
           FastlaneCore::ConfigItem.new(key: :provider,
                                        env_name: "FL_SETUP_CI_PROVIDER",
                                        description: "CI provider. If none is set, the provider is detected automatically",
-                                       is_string: true,
                                        optional: true,
                                        verify_block: proc do |value|
                                          value = value.to_s

data/fastlane/lib/fastlane/actions/setup_circle_ci.rb

@@ -31,7 +31,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :force,
                                        env_name: "FL_SETUP_CIRCLECI_FORCE",
                                        description: "Force setup, even if not executed by CircleCI",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false)
         ]
       end

data/fastlane/lib/fastlane/actions/setup_jenkins.rb

@@ -118,34 +118,32 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :force,
                                        env_name: "FL_SETUP_JENKINS_FORCE",
                                        description: "Force setup, even if not executed by Jenkins",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false),
 
           # Keychain
           FastlaneCore::ConfigItem.new(key: :unlock_keychain,
                                        env_name: "FL_SETUP_JENKINS_UNLOCK_KEYCHAIN",
                                        description: "Unlocks keychain",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: true),
           FastlaneCore::ConfigItem.new(key: :add_keychain_to_search_list,
                                        env_name: "FL_SETUP_JENKINS_ADD_KEYCHAIN_TO_SEARCH_LIST",
-                                       description: "Add to keychain search list",
-                                       is_string: false,
+                                       description: "Add to keychain search list, valid values are true, false, :add, and :replace",
+                                       skip_type_validation: true, # allow Boolean, Symbol
                                        default_value: :replace),
           FastlaneCore::ConfigItem.new(key: :set_default_keychain,
                                        env_name: "FL_SETUP_JENKINS_SET_DEFAULT_KEYCHAIN",
                                        description: "Set keychain as default",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: true),
           FastlaneCore::ConfigItem.new(key: :keychain_path,
                                        env_name: "KEYCHAIN_PATH",
                                        description: "Path to keychain",
-                                       is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :keychain_password,
                                        env_name: "KEYCHAIN_PASSWORD",
                                        description: "Keychain password",
-                                       is_string: true,
                                        sensitive: true,
                                        default_value: ""),
 
@@ -153,29 +151,26 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :set_code_signing_identity,
                                        env_name: "FL_SETUP_JENKINS_SET_CODE_SIGNING_IDENTITY",
                                        description: "Set code signing identity from CODE_SIGNING_IDENTITY environment",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: true),
           FastlaneCore::ConfigItem.new(key: :code_signing_identity,
                                        env_name: "CODE_SIGNING_IDENTITY",
                                        description: "Code signing identity",
-                                       is_string: true,
                                        optional: true),
 
           # Xcode parameters
           FastlaneCore::ConfigItem.new(key: :output_directory,
                                        env_name: "FL_SETUP_JENKINS_OUTPUT_DIRECTORY",
                                        description: "The directory in which the ipa file should be stored in",
-                                       is_string: true,
                                        default_value: "./output"),
           FastlaneCore::ConfigItem.new(key: :derived_data_path,
                                        env_name: "FL_SETUP_JENKINS_DERIVED_DATA_PATH",
                                        description: "The directory where built products and other derived data will go",
-                                       is_string: true,
                                        default_value: "./derivedData"),
           FastlaneCore::ConfigItem.new(key: :result_bundle,
                                        env_name: "FL_SETUP_JENKINS_RESULT_BUNDLE",
                                        description: "Produce the result bundle describing what occurred will be placed",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: true)
         ]
       end

data/fastlane/lib/fastlane/actions/setup_travis.rb

@@ -30,7 +30,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :force,
                                        env_name: "FL_SETUP_TRAVIS_FORCE",
                                        description: "Force setup, even if not executed by travis",
-                                       is_string: false,
+                                       type: Boolean,
                                        default_value: false)
         ]
       end

data/fastlane/lib/fastlane/actions/sh.rb

@@ -24,17 +24,15 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(key: :command,
                                          description: 'Shell command to be executed',
-                                         optional: false,
-                                         is_string: true),
+                                         optional: false),
           FastlaneCore::ConfigItem.new(key: :log,
                                          description: 'Determines whether fastlane should print out the executed command itself and output of the executed command. If command line option --troubleshoot is used, then it overrides this option to true',
                                          optional: true,
-                                         is_string: false,
+                                         type: Boolean,
                                          default_value: true),
           FastlaneCore::ConfigItem.new(key: :error_callback,
                                          description: 'A callback invoked with the command output if there is a non-zero exit status',
                                          optional: true,
-                                         is_string: false,
                                          type: :string_callback,
                                          default_value: nil)
         ]

data/fastlane/lib/fastlane/actions/slack.rb

@@ -1,70 +1,178 @@
+require 'fastlane/notification/slack'
+
 # rubocop:disable Style/CaseEquality
 # rubocop:disable Style/MultilineTernaryOperator
 # rubocop:disable Style/NestedTernaryOperator
 module Fastlane
   module Actions
     class SlackAction < Action
-      def self.is_supported?(platform)
-        true
-      end
+      class Runner
+        def initialize(slack_url)
+          @notifier = Fastlane::Notification::Slack.new(slack_url)
+        end
 
-      # As there is a text limit in the notifications, we are
-      # usually interested in the last part of the message
-      # e.g. for tests
-      def self.trim_message(message)
-        # We want the last 7000 characters, instead of the first 7000, as the error is at the bottom
-        start_index = [message.length - 7000, 0].max
-        message = message[start_index..-1]
-        # We want line breaks to be shown on slack output so we replace
-        # input non-interpreted line break with interpreted line break
-        message.gsub('\n', "\n")
-      end
+        def run(options)
+          options[:message] = self.class.trim_message(options[:message].to_s || '')
+          options[:message] = Fastlane::Notification::Slack::LinkConverter.convert(options[:message])
 
-      def self.run(options)
-        require 'slack-notifier'
+          options[:pretext] = options[:pretext].gsub('\n', "\n") unless options[:pretext].nil?
 
-        options[:message] = self.trim_message(options[:message].to_s || '')
-        options[:message] = Slack::Notifier::Util::LinkFormatter.format(options[:message])
+          if options[:channel].to_s.length > 0
+            channel = options[:channel]
+            channel = ('#' + options[:channel]) unless ['#', '@'].include?(channel[0]) # send message to channel by default
+          end
 
-        options[:pretext] = options[:pretext].gsub('\n', "\n") unless options[:pretext].nil?
+          username = options[:use_webhook_configured_username_and_icon] ? nil : options[:username]
 
-        if options[:channel].to_s.length > 0
-          channel = options[:channel]
-          channel = ('#' + options[:channel]) unless ['#', '@'].include?(channel[0]) # send message to channel by default
+          slack_attachment = self.class.generate_slack_attachments(options)
+          link_names = options[:link_names]
+          icon_url = options[:use_webhook_configured_username_and_icon] ? nil : options[:icon_url]
+
+          post_message(
+            channel: channel,
+            username: username,
+            attachments: [slack_attachment],
+            link_names: link_names,
+            icon_url: icon_url,
+            fail_on_error: options[:fail_on_error]
+          )
         end
 
-        username = options[:use_webhook_configured_username_and_icon] ? nil : options[:username]
+        def post_message(channel:, username:, attachments:, link_names:, icon_url:, fail_on_error:)
+          @notifier.post_to_legacy_incoming_webhook(
+            channel: channel,
+            username: username,
+            link_names: link_names,
+            icon_url: icon_url,
+            attachments: attachments
+          )
+          UI.success('Successfully sent Slack notification')
+        rescue => error
+          UI.error("Exception: #{error}")
+          message = "Error pushing Slack message, maybe the integration has no permission to post on this channel? Try removing the channel parameter in your Fastfile, this is usually caused by a misspelled or changed group/channel name or an expired SLACK_URL"
+          if fail_on_error
+            UI.user_error!(message)
+          else
+            UI.error(message)
+          end
+        end
 
-        notifier = Slack::Notifier.new(options[:slack_url], channel: channel, username: username)
+        # As there is a text limit in the notifications, we are
+        # usually interested in the last part of the message
+        # e.g. for tests
+        def self.trim_message(message)
+          # We want the last 7000 characters, instead of the first 7000, as the error is at the bottom
+          start_index = [message.length - 7000, 0].max
+          message = message[start_index..-1]
+          # We want line breaks to be shown on slack output so we replace
+          # input non-interpreted line break with interpreted line break
+          message.gsub('\n', "\n")
+        end
 
-        link_names = options[:link_names]
+        def self.generate_slack_attachments(options)
+          color = (options[:success] ? 'good' : 'danger')
+          should_add_payload = ->(payload_name) { options[:default_payloads].map(&:to_sym).include?(payload_name.to_sym) }
 
-        icon_url = options[:use_webhook_configured_username_and_icon] ? nil : options[:icon_url]
+          slack_attachment = {
+            fallback: options[:message],
+            text: options[:message],
+            pretext: options[:pretext],
+            color: color,
+            mrkdwn_in: ["pretext", "text", "fields", "message"],
+            fields: []
+          }
 
-        slack_attachment = generate_slack_attachments(options)
+          # custom user payloads
+          slack_attachment[:fields] += options[:payload].map do |k, v|
+            {
+              title: k.to_s,
+              value: Fastlane::Notification::Slack::LinkConverter.convert(v.to_s),
+              short: false
+            }
+          end
 
-        return [notifier, slack_attachment] if Helper.test? # tests will verify the slack attachments and other properties
+          # Add the lane to the Slack message
+          # This might be nil, if slack is called as "one-off" action
+          if should_add_payload[:lane] && Actions.lane_context[Actions::SharedValues::LANE_NAME]
+            slack_attachment[:fields] << {
+              title: 'Lane',
+              value: Actions.lane_context[Actions::SharedValues::LANE_NAME],
+              short: true
+            }
+          end
 
-        begin
-          results = notifier.ping('', link_names: link_names, icon_url: icon_url, attachments: [slack_attachment])
-        rescue => exception
-          UI.error("Exception: #{exception}")
-        ensure
-          result = results.first if results
-          if !result.nil? && result.code.to_i == 200
-            UI.success('Successfully sent Slack notification')
-          else
-            UI.verbose(result) unless result.nil?
-            message = "Error pushing Slack message, maybe the integration has no permission to post on this channel? Try removing the channel parameter in your Fastfile, this is usually caused by a misspelled or changed group/channel name or an expired SLACK_URL"
-            if options[:fail_on_error]
-              UI.user_error!(message)
+          # test_result
+          if should_add_payload[:test_result]
+            slack_attachment[:fields] << {
+              title: 'Result',
+              value: (options[:success] ? 'Success' : 'Error'),
+              short: true
+            }
+          end
+
+          # git branch
+          if Actions.git_branch && should_add_payload[:git_branch]
+            slack_attachment[:fields] << {
+              title: 'Git Branch',
+              value: Actions.git_branch,
+              short: true
+            }
+          end
+
+          # git_author
+          if Actions.git_author_email && should_add_payload[:git_author]
+            if FastlaneCore::Env.truthy?('FASTLANE_SLACK_HIDE_AUTHOR_ON_SUCCESS') && options[:success]
+            # We only show the git author if the build failed
             else
-              UI.error(message)
+              slack_attachment[:fields] << {
+                title: 'Git Author',
+                value: Actions.git_author_email,
+                short: true
+              }
             end
           end
+
+          # last_git_commit
+          if Actions.last_git_commit_message && should_add_payload[:last_git_commit]
+            slack_attachment[:fields] << {
+              title: 'Git Commit',
+              value: Actions.last_git_commit_message,
+              short: false
+            }
+          end
+
+          # last_git_commit_hash
+          if Actions.last_git_commit_hash(true) && should_add_payload[:last_git_commit_hash]
+            slack_attachment[:fields] << {
+              title: 'Git Commit Hash',
+              value: Actions.last_git_commit_hash(short: true),
+              short: false
+            }
+          end
+
+          # merge additional properties
+          deep_merge(slack_attachment, options[:attachment_properties])
+        end
+
+        # Adapted from https://stackoverflow.com/a/30225093/158525
+        def self.deep_merge(a, b)
+          merger = proc do |key, v1, v2|
+            Hash === v1 && Hash === v2 ?
+              v1.merge(v2, &merger) : Array === v1 && Array === v2 ?
+                                        v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2
+          end
+          a.merge(b, &merger)
         end
       end
 
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.run(options)
+        Runner.new(options[:slack_url]).run(options)
+      end
+
       def self.description
         "Send a success/error message to your [Slack](https://slack.com) group"
       end
@@ -87,7 +195,7 @@ module Fastlane
                                        env_name: "FL_SLACK_USE_WEBHOOK_CONFIGURED_USERNAME_AND_ICON",
                                        description: "Use webhook's default username and icon settings? (true/false)",
                                        default_value: false,
-                                       is_string: false,
+                                       type: Boolean,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :slack_url,
                                        env_name: "SLACK_URL",
@@ -100,47 +208,45 @@ module Fastlane
                                        env_name: "FL_SLACK_USERNAME",
                                        description: "Overrides the webhook's username property if use_webhook_configured_username_and_icon is false",
                                        default_value: "fastlane",
-                                       is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :icon_url,
                                        env_name: "FL_SLACK_ICON_URL",
                                        description: "Overrides the webhook's image property if use_webhook_configured_username_and_icon is false",
                                        default_value: "https://fastlane.tools/assets/img/fastlane_icon.png",
-                                       is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :payload,
                                        env_name: "FL_SLACK_PAYLOAD",
                                        description: "Add additional information to this post. payload must be a hash containing any key with any value",
                                        default_value: {},
-                                       is_string: false),
+                                       type: Hash),
           FastlaneCore::ConfigItem.new(key: :default_payloads,
                                        env_name: "FL_SLACK_DEFAULT_PAYLOADS",
-                                       description: "Remove some of the default payloads. More information about the available payloads on GitHub",
-                                       optional: true,
+                                       description: "Specifies default payloads to include. Pass an empty array to suppress all the default payloads",
+                                       default_value: ['lane', 'test_result', 'git_branch', 'git_author', 'last_git_commit', 'last_git_commit_hash'],
                                        type: Array),
           FastlaneCore::ConfigItem.new(key: :attachment_properties,
                                        env_name: "FL_SLACK_ATTACHMENT_PROPERTIES",
                                        description: "Merge additional properties in the slack attachment, see https://api.slack.com/docs/attachments",
                                        default_value: {},
-                                       is_string: false),
+                                       type: Hash),
           FastlaneCore::ConfigItem.new(key: :success,
                                        env_name: "FL_SLACK_SUCCESS",
                                        description: "Was this build successful? (true/false)",
                                        optional: true,
                                        default_value: true,
-                                       is_string: false),
+                                       type: Boolean),
           FastlaneCore::ConfigItem.new(key: :fail_on_error,
                                        env_name: "FL_SLACK_FAIL_ON_ERROR",
                                        description: "Should an error sending the slack notification cause a failure? (true/false)",
                                        optional: true,
                                        default_value: true,
-                                       is_string: false),
+                                       type: Boolean),
           FastlaneCore::ConfigItem.new(key: :link_names,
                                        env_name: "FL_SLACK_LINK_NAMES",
                                        description: "Find and link channel names and usernames (true/false)",
                                        optional: true,
                                        default_value: false,
-                                       is_string: false)
+                                       type: Boolean)
         ]
       end
 
@@ -159,8 +265,7 @@ module Fastlane
               "Build Date" => Time.new.to_s,
               "Built by" => "Jenkins",
             },
-            default_payloads: [:git_branch, :git_author], # Optional, lets you specify an allowlist of default payloads to include. Pass an empty array to suppress all the default payloads.
-                                                          # Don\'t add this key, or pass nil, if you want all the default payloads. The available default payloads are: `lane`, `test_result`, `git_branch`, `git_author`, `last_git_commit`, `last_git_commit_hash`.
+            default_payloads: [:git_branch, :git_author], # Optional, lets you specify default payloads to include. Pass an empty array to suppress all the default payloads.
             attachment_properties: { # Optional, lets you specify any other properties available for attachments in the slack API (see https://api.slack.com/docs/attachments).
                                      # This hash is deep merged with the existing properties set using the other properties above. This allows your own fields properties to be appended to the existing fields that were created using the `payload` property for instance.
               thumb_url: "http://example.com/path/to/thumb.png",
@@ -186,99 +291,13 @@ module Fastlane
       # @!group Helper
       #####################################################
 
-      def self.generate_slack_attachments(options)
-        color = (options[:success] ? 'good' : 'danger')
-        should_add_payload = ->(payload_name) { options[:default_payloads].nil? || options[:default_payloads].map(&:to_sym).include?(payload_name.to_sym) }
-
-        slack_attachment = {
-          fallback: options[:message],
-          text: options[:message],
-          pretext: options[:pretext],
-          color: color,
-          mrkdwn_in: ["pretext", "text", "fields", "message"],
-          fields: []
-        }
-
-        # custom user payloads
-        slack_attachment[:fields] += options[:payload].map do |k, v|
-          {
-            title: k.to_s,
-            value: Slack::Notifier::Util::LinkFormatter.format(v.to_s),
-            short: false
-          }
-        end
-
-        # Add the lane to the Slack message
-        # This might be nil, if slack is called as "one-off" action
-        if should_add_payload[:lane] && Actions.lane_context[Actions::SharedValues::LANE_NAME]
-          slack_attachment[:fields] << {
-            title: 'Lane',
-            value: Actions.lane_context[Actions::SharedValues::LANE_NAME],
-            short: true
-          }
-        end
-
-        # test_result
-        if should_add_payload[:test_result]
-          slack_attachment[:fields] << {
-            title: 'Result',
-            value: (options[:success] ? 'Success' : 'Error'),
-            short: true
-          }
-        end
-
-        # git branch
-        if Actions.git_branch && should_add_payload[:git_branch]
-          slack_attachment[:fields] << {
-            title: 'Git Branch',
-            value: Actions.git_branch,
-            short: true
-          }
-        end
-
-        # git_author
-        if Actions.git_author_email && should_add_payload[:git_author]
-          if FastlaneCore::Env.truthy?('FASTLANE_SLACK_HIDE_AUTHOR_ON_SUCCESS') && options[:success]
-            # We only show the git author if the build failed
-          else
-            slack_attachment[:fields] << {
-              title: 'Git Author',
-              value: Actions.git_author_email,
-              short: true
-            }
-          end
-        end
-
-        # last_git_commit
-        if Actions.last_git_commit_message && should_add_payload[:last_git_commit]
-          slack_attachment[:fields] << {
-            title: 'Git Commit',
-            value: Actions.last_git_commit_message,
-            short: false
-          }
-        end
-
-        # last_git_commit_hash
-        if Actions.last_git_commit_hash(true) && should_add_payload[:last_git_commit_hash]
-          slack_attachment[:fields] << {
-            title: 'Git Commit Hash',
-            value: Actions.last_git_commit_hash(short: true),
-            short: false
-          }
-        end
-
-        # merge additional properties
-        deep_merge(slack_attachment, options[:attachment_properties])
+      def self.trim_message(message)
+        Runner.trim_message(message)
       end
 
-      # Adapted from https://stackoverflow.com/a/30225093/158525
-      def self.deep_merge(a, b)
-        merger = proc do |key, v1, v2|
-          Hash === v1 && Hash === v2 ?
-                 v1.merge(v2, &merger) : Array === v1 && Array === v2 ?
-                   v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2
-        end
-        a.merge(b, &merger)
+      def self.generate_slack_attachments(options)
+        UI.deprecated('`Fastlane::Actions::Slack.generate_slack_attachments` is subject to be removed as Slack recommends migrating `attachments` to Block Kit. fastlane will also follow the same direction.')
+        Runner.generate_slack_attachments(options)
       end
     end
   end