fastlane_iac_publish 0.1.0

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

@@ -0,0 +1,288 @@
+# 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
+
+      # 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 self.run(options)
+        require 'slack-notifier'
+
+        options[:message] = self.trim_message(options[:message].to_s || '')
+        options[:message] = Slack::Notifier::Util::LinkFormatter.format(options[:message])
+
+        options[:pretext] = options[:pretext].gsub('\n', "\n") unless options[:pretext].nil?
+
+        if options[:channel].to_s.length > 0
+          channel = options[:channel]
+          channel = ('#' + options[:channel]) unless ['#', '@'].include?(channel[0]) # send message to channel by default
+        end
+
+        username = options[:use_webhook_configured_username_and_icon] ? nil : options[:username]
+
+        notifier = Slack::Notifier.new(options[:slack_url], channel: channel, username: username)
+
+        link_names = options[:link_names]
+
+        icon_url = options[:use_webhook_configured_username_and_icon] ? nil : options[:icon_url]
+
+        slack_attachment = generate_slack_attachments(options)
+
+        return [notifier, slack_attachment] if Helper.test? # tests will verify the slack attachments and other properties
+
+        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)
+            else
+              UI.error(message)
+            end
+          end
+        end
+      end
+
+      def self.description
+        "Send a success/error message to your [Slack](https://slack.com) group"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "FL_SLACK_MESSAGE",
+                                       description: "The message that should be displayed on Slack. This supports the standard Slack markup language",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :pretext,
+                                       env_name: "FL_SLACK_PRETEXT",
+                                       description: "This is optional text that appears above the message attachment block. This supports the standard Slack markup language",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :channel,
+                                       env_name: "FL_SLACK_CHANNEL",
+                                       description: "#channel or @username",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :use_webhook_configured_username_and_icon,
+                                       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,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :slack_url,
+                                       env_name: "SLACK_URL",
+                                       sensitive: true,
+                                       description: "Create an Incoming WebHook for your Slack group",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Invalid URL, must start with https://") unless value.start_with?("https://")
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       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://s3-eu-west-1.amazonaws.com/fastlane.tools/fastlane.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),
+          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,
+                                       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),
+          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),
+          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),
+          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)
+        ]
+      end
+
+      def self.author
+        "KrauseFx"
+      end
+
+      def self.example_code
+        [
+          'slack(message: "App successfully released!")',
+          'slack(
+            message: "App successfully released!",
+            channel: "#channel",  # Optional, by default will post to the default channel configured for the POST URL.
+            success: true,        # Optional, defaults to true.
+            payload: {            # Optional, lets you specify any number of your own Slack attachments.
+              "Build Date" => Time.new.to_s,
+              "Built by" => "Jenkins",
+            },
+            default_payloads: [:git_branch, :git_author], # Optional, lets you specify a whitelist 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`.
+            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",
+              fields: [{
+                title: "My Field",
+                value: "My Value",
+                short: true
+              }]
+            }
+          )'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
+
+      def self.details
+        "Create an Incoming WebHook and export this as `SLACK_URL`. Can send a message to **#channel** (by default), a direct message to **@username** or a message to a private group **group** with success (green) or failure (red) status."
+      end
+
+      #####################################################
+      # @!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])
+      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
+  end
+end
+# rubocop:enable Style/CaseEquality
+# rubocop:enable Style/MultilineTernaryOperator
+# rubocop:enable Style/NestedTernaryOperator

data/fastlane/lib/fastlane/actions/slather.rb

@@ -0,0 +1,314 @@
+module Fastlane
+  module Actions
+    class SlatherAction < Action
+      # https://github.com/SlatherOrg/slather/blob/v2.4.2/lib/slather/command/coverage_command.rb
+      ARGS_MAP = {
+          travis: '--travis',
+          travis_pro: '--travispro',
+          circleci: '--circleci',
+          jenkins: '--jenkins',
+          buildkite: '--buildkite',
+          teamcity: '--teamcity',
+
+          coveralls: '--coveralls',
+          simple_output: '--simple-output',
+          gutter_json: '--gutter-json',
+          cobertura_xml: '--cobertura-xml',
+          llvm_cov: '--llvm-cov',
+          html: '--html',
+          show: '--show',
+
+          build_directory: '--build-directory',
+          source_directory: '--source-directory',
+          output_directory: '--output-directory',
+          ignore: '--ignore',
+          verbose: '--verbose',
+
+          input_format: '--input-format',
+          scheme: '--scheme',
+          configuration: '--configuration',
+          workspace: '--workspace',
+          binary_file: '--binary-file',
+          binary_basename: '--binary-basename',
+          arch: '--arch',
+          source_files: '--source-files',
+          decimals: '--decimals'
+      }.freeze
+
+      def self.run(params)
+        # This will fail if using Bundler. Skip the check rather than needing to
+        # require bundler
+        unless params[:use_bundle_exec]
+          Actions.verify_gem!('slather')
+        end
+
+        validate_params!(params)
+
+        command = build_command(params)
+        sh(command)
+      end
+
+      def self.has_config_file
+        File.file?('.slather.yml')
+      end
+
+      def self.slather_version
+        require 'slather'
+        Slather::VERSION
+      end
+
+      def self.configuration_available?
+        Gem::Version.new('2.4.1') <= Gem::Version.new(slather_version)
+      end
+
+      def self.validate_params!(params)
+        if params[:configuration]
+          UI.user_error!('configuration option is available since version 2.4.1') unless configuration_available?
+        end
+
+        if params[:proj] || has_config_file
+          true
+        else
+          UI.user_error!("You have to provide a project with `:proj` or use a .slather.yml")
+        end
+
+        # for backwards compatibility when :binary_file type was Boolean
+        if params[:binary_file] == true || params[:binary_file] == false
+          params[:binary_file] = nil
+        end
+
+        # :binary_file validation was skipped for backwards compatibility with Boolean. If a
+        # Boolean was passed in, it has now been removed. Revalidate :binary_file
+        binary_file_options = available_options.find { |a| a.key == :binary_file }
+        binary_file_options.skip_type_validation = false
+        binary_file_options.verify!(params[:binary_file])
+      end
+
+      def self.build_command(params)
+        command = []
+        command.push("bundle exec") if params[:use_bundle_exec] && shell_out_should_use_bundle_exec?
+        command << "slather coverage"
+
+        ARGS_MAP.each do |key, cli_param|
+          cli_value = params[key]
+          if cli_value
+            if cli_value.kind_of?(TrueClass)
+              command << cli_param
+            elsif cli_value.kind_of?(String)
+              command << cli_param
+              command << cli_value.shellescape
+            elsif cli_value.kind_of?(Array)
+              command << cli_value.map { |path| "#{cli_param} #{path.shellescape}" }
+            end
+          else
+            next
+          end
+        end
+
+        command << params[:proj].shellescape if params[:proj]
+        command.join(" ")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Use slather to generate a code coverage report"
+      end
+
+      def self.details
+        [
+          "Slather works with multiple code coverage formats, including Xcode 7 code coverage.",
+          "Slather is available at [https://github.com/SlatherOrg/slather](https://github.com/SlatherOrg/slather)."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :build_directory,
+                                       env_name: "FL_SLATHER_BUILD_DIRECTORY", # The name of the environment variable
+                                       description: "The location of the build output", # a short description of this parameter
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :proj,
+                                       env_name: "FL_SLATHER_PROJ", # The name of the environment variable
+                                       description: "The project file that slather looks at", # a short description of this parameter
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No project file specified, pass using `proj: 'Project.xcodeproj'`") unless value && !value.empty?
+                                       end,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :workspace,
+                                       env_name: "FL_SLATHER_WORKSPACE",
+                                       description: "The workspace that slather looks at",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+                                       env_name: "FL_SLATHER_SCHEME", # The name of the environment variable
+                                       description: "Scheme to use when calling slather",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :configuration,
+                                       env_name: "FL_SLATHER_CONFIGURATION", # The name of the environment variable
+                                       description: "Configuration to use when calling slather (since slather-2.4.1)",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :input_format,
+                                       env_name: "FL_SLATHER_INPUT_FORMAT", # The name of the environment variable
+                                       description: "The input format that slather should look for",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :buildkite,
+                                       env_name: "FL_SLATHER_BUILDKITE_ENABLED", # The name of the environment variable
+                                       description: "Tell slather that it is running on Buildkite",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :teamcity,
+                                       env_name: "FL_SLATHER_TEAMCITY_ENABLED", # The name of the environment variable
+                                       description: "Tell slather that it is running on TeamCity",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :jenkins,
+                                       env_name: "FL_SLATHER_JENKINS_ENABLED", # The name of the environment variable
+                                       description: "Tell slather that it is running on Jenkins",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :travis,
+                                       env_name: "FL_SLATHER_TRAVIS_ENABLED", # The name of the environment variable
+                                       description: "Tell slather that it is running on TravisCI",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :travis_pro,
+                                       env_name: "FL_SLATHER_TRAVIS_PRO_ENABLED", # The name of the environment variable
+                                       description: "Tell slather that it is running on TravisCI Pro",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :circleci,
+                                       env_name: "FL_SLATHER_CIRCLECI_ENABLED",
+                                       description: "Tell slather that it is running on CircleCI",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :coveralls,
+                                       env_name: "FL_SLATHER_COVERALLS_ENABLED",
+                                       description: "Tell slather that it should post data to Coveralls",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :simple_output,
+                                       env_name: "FL_SLATHER_SIMPLE_OUTPUT_ENABLED",
+                                       description: "Tell slather that it should output results to the terminal",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :gutter_json,
+                                       env_name: "FL_SLATHER_GUTTER_JSON_ENABLED",
+                                       description: "Tell slather that it should output results as Gutter JSON format",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :cobertura_xml,
+                                       env_name: "FL_SLATHER_COBERTURA_XML_ENABLED",
+                                       description: "Tell slather that it should output results as Cobertura XML format",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :llvm_cov,
+                                       env_name: "FL_SLATHER_LLVM_COV_ENABLED",
+                                       description: "Tell slather that it should output results as llvm-cov show format",
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :html,
+                                       env_name: "FL_SLATHER_HTML_ENABLED",
+                                       description: "Tell slather that it should output results as static HTML pages",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :show,
+                                       env_name: "FL_SLATHER_SHOW_ENABLED",
+                                       description: "Tell slather that it should open static html pages automatically",
+                                       is_string: false,
+                                       type: Boolean,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :source_directory,
+                                       env_name: "FL_SLATHER_SOURCE_DIRECTORY",
+                                       description: "Tell slather the location of your source files",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :output_directory,
+                                       env_name: "FL_SLATHER_OUTPUT_DIRECTORY",
+                                       description: "Tell slather the location of for your output files",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :ignore,
+                                       env_name: "FL_SLATHER_IGNORE",
+                                       description: "Tell slather to ignore files matching a path or any path from an array of paths",
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :verbose,
+                                       env_name: "FL_SLATHER_VERBOSE",
+                                       description: "Tell slather to enable verbose mode",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :use_bundle_exec,
+                                      env_name: "FL_SLATHER_USE_BUNDLE_EXEC",
+                                      description: "Use bundle exec to execute slather. Make sure it is in the Gemfile",
+                                      is_string: false,
+                                      type: Boolean,
+                                      default_value: false),
+          FastlaneCore::ConfigItem.new(key: :binary_basename,
+                                       env_name: "FL_SLATHER_BINARY_BASENAME",
+                                       description: "Basename of the binary file, this should match the name of your bundle excluding its extension (i.e. YourApp [for YourApp.app bundle])",
+                                       is_string: false,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :binary_file,
+                                       env_name: "FL_SLATHER_BINARY_FILE",
+                                       description: "Binary file name to be used for code coverage",
+                                       skip_type_validation: true, # skipping validation for backwards compatibility with Boolean type
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :arch,
+                                       env_name: "FL_SLATHER_ARCH",
+                                       description: "Specify which architecture the binary file is in. Needed for universal binaries",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :source_files,
+                                       env_name: "FL_SLATHER_SOURCE_FILES",
+                                       description: "A Dir.glob compatible pattern used to limit the lookup to specific source files. Ignored in gcov mode",
+                                       is_string: false,
+                                       default_value: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :decimals,
+                                      env_name: "FL_SLATHER_DECIMALS",
+                                      description: "The amount of decimals to use for % coverage reporting",
+                                      is_string: false,
+                                      default_value: false,
+                                      optional: true)
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.authors
+        ["mattdelves"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'slather(
+            build_directory: "foo",
+            input_format: "bah",
+            scheme: "MyScheme",
+            proj: "MyProject.xcodeproj"
+          )'
+        ]
+      end
+
+      def self.category
+        :testing
+      end
+    end
+  end
+end