pantograph 0.1.0

data/pantograph/lib/pantograph/actions/slack.rb

@@ -0,0 +1,288 @@
+# rubocop:disable Style/CaseEquality
+# rubocop:disable Style/MultilineTernaryOperator
+# rubocop:disable Style/NestedTernaryOperator
+module Pantograph
+  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 Pantfile, 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
+        [
+          PantographCore::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),
+          PantographCore::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),
+          PantographCore::ConfigItem.new(key: :channel,
+                                       env_name: "FL_SLACK_CHANNEL",
+                                       description: "#channel or @username",
+                                       optional: true),
+          PantographCore::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),
+          PantographCore::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),
+          PantographCore::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: "pantograph",
+                                       is_string: true,
+                                       optional: true),
+          PantographCore::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/pantograph.tools/pantograph.png",
+                                       is_string: true,
+                                       optional: true),
+          PantographCore::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),
+          PantographCore::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),
+          PantographCore::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),
+          PantographCore::ConfigItem.new(key: :success,
+                                       env_name: "FL_SLACK_SUCCESS",
+                                       description: "Was this build successful? (true/false)",
+                                       optional: true,
+                                       default_value: true,
+                                       is_string: false),
+          PantographCore::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),
+          PantographCore::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 PantographCore::Env.truthy?('PANTOGRAPH_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/pantograph/lib/pantograph/actions/sonar.rb

@@ -0,0 +1,156 @@
+module Pantograph
+  module Actions
+    class SonarAction < Action
+      def self.run(params)
+        verify_sonar_scanner_binary
+
+        command_prefix = [
+          'cd',
+          File.expand_path('.').shellescape,
+          '&&'
+        ].join(' ')
+
+        sonar_scanner_args = []
+        sonar_scanner_args << "-Dproject.settings=\"#{params[:project_configuration_path]}\"" if params[:project_configuration_path]
+        sonar_scanner_args << "-Dsonar.projectKey=\"#{params[:project_key]}\"" if params[:project_key]
+        sonar_scanner_args << "-Dsonar.projectName=\"#{params[:project_name]}\"" if params[:project_name]
+        sonar_scanner_args << "-Dsonar.projectVersion=\"#{params[:project_version]}\"" if params[:project_version]
+        sonar_scanner_args << "-Dsonar.sources=\"#{params[:sources_path]}\"" if params[:sources_path]
+        sonar_scanner_args << "-Dsonar.language=\"#{params[:project_language]}\"" if params[:project_language]
+        sonar_scanner_args << "-Dsonar.sourceEncoding=\"#{params[:source_encoding]}\"" if params[:source_encoding]
+        sonar_scanner_args << "-Dsonar.login=\"#{params[:sonar_login]}\"" if params[:sonar_login]
+        sonar_scanner_args << "-Dsonar.host.url=\"#{params[:sonar_url]}\"" if params[:sonar_url]
+        sonar_scanner_args << "-Dsonar.branch.name=\"#{params[:branch_name]}\"" if params[:branch_name]
+        sonar_scanner_args << "-Dsonar.pullrequest.branch=\"#{params[:pull_request_branch]}\"" if params[:pull_request_branch]
+        sonar_scanner_args << "-Dsonar.pullrequest.base=\"#{params[:pull_request_base]}\"" if params[:pull_request_base]
+        sonar_scanner_args << "-Dsonar.pullrequest.key=\"#{params[:pull_request_key]}\"" if params[:pull_request_key]
+        sonar_scanner_args << params[:sonar_runner_args] if params[:sonar_runner_args]
+
+        command = [
+          command_prefix,
+          'sonar-scanner',
+          sonar_scanner_args
+        ].join(' ')
+        # hide command, as it may contain credentials
+        Pantograph::Actions.sh_control_output(command, print_command: false, print_command_output: true)
+      end
+
+      def self.verify_sonar_scanner_binary
+        UI.user_error!("You have to install sonar-scanner using `brew install sonar-scanner`") unless `which sonar-scanner`.to_s.length > 0
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Invokes sonar-scanner to programmatically run SonarQube analysis"
+      end
+
+      def self.details
+        [
+          "See [http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner](http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner) for details.",
+          "It can process unit test results if formatted as junit report as shown in [xctest](https://docs.pantograph.tools/actions/xctest/) action. It can also integrate coverage reports in Cobertura format, which can be transformed into by the [slather](https://docs.pantograph.tools/actions/slather/) action."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :project_configuration_path,
+                                        env_name: "FL_SONAR_RUNNER_PROPERTIES_PATH",
+                                        description: "The path to your sonar project configuration file; defaults to `sonar-project.properties`", # default is enforced by sonar-scanner binary
+                                        optional: true,
+                                        verify_block: proc do |value|
+                                          UI.user_error!("Couldn't find file at path '#{value}'") unless value.nil? || File.exist?(value)
+                                        end),
+          PantographCore::ConfigItem.new(key: :project_key,
+                                       env_name: "FL_SONAR_RUNNER_PROJECT_KEY",
+                                       description: "The key sonar uses to identify the project, e.g. `name.gretzki.awesomeApp`. Must either be specified here or inside the sonar project configuration file",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :project_name,
+                                       env_name: "FL_SONAR_RUNNER_PROJECT_NAME",
+                                       description: "The name of the project that gets displayed on the sonar report page. Must either be specified here or inside the sonar project configuration file",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :project_version,
+                                       env_name: "FL_SONAR_RUNNER_PROJECT_VERSION",
+                                       description: "The project's version that gets displayed on the sonar report page. Must either be specified here or inside the sonar project configuration file",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :sources_path,
+                                       env_name: "FL_SONAR_RUNNER_SOURCES_PATH",
+                                       description: "Comma-separated paths to directories containing source files. Must either be specified here or inside the sonar project configuration file",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :project_language,
+                                       env_name: "FL_SONAR_RUNNER_PROJECT_LANGUAGE",
+                                       description: "Language key, e.g. objc",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :source_encoding,
+                                       env_name: "FL_SONAR_RUNNER_SOURCE_ENCODING",
+                                       description: "Used encoding of source files, e.g., UTF-8",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :sonar_runner_args,
+                                       env_name: "FL_SONAR_RUNNER_ARGS",
+                                       description: "Pass additional arguments to sonar-scanner. Be sure to provide the arguments with a leading `-D` e.g. FL_SONAR_RUNNER_ARGS=\"-Dsonar.verbose=true\"",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :sonar_login,
+                                       env_name: "FL_SONAR_LOGIN",
+                                       description: "Pass the Sonar Login token (e.g: xxxxxxprivate_token_XXXXbXX7e)",
+                                       optional: true,
+                                       is_string: true,
+                                       sensitive: true),
+          PantographCore::ConfigItem.new(key: :sonar_url,
+                                       env_name: "FL_SONAR_URL",
+                                       description: "Pass the url of the Sonar server",
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :branch_name,
+                                       env_name: "FL_SONAR_RUNNER_BRANCH_NAME",
+                                       description: "Pass the branch name which is getting scanned",
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :pull_request_branch,
+                                       env_name: "FL_SONAR_RUNNER_PULL_REQUEST_BRANCH",
+                                       description: "The name of the branch that contains the changes to be merged",
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :pull_request_base,
+                                       env_name: "FL_SONAR_RUNNER_PULL_REQUEST_BASE",
+                                       description: "The long-lived branch into which the PR will be merged",
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :pull_request_key,
+                                       env_name: "FL_SONAR_RUNNER_PULL_REQUEST_KEY",
+                                       description: "Unique identifier of your PR. Must correspond to the key of the PR in GitHub or TFS",
+                                       optional: true,
+                                       is_string: true)
+        ]
+      end
+
+      def self.return_value
+        "The exit code of the sonar-scanner binary"
+      end
+
+      def self.authors
+        ["c_gretzki"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'sonar(
+            project_key: "name.gretzki.awesomeApp",
+            project_version: "1.0",
+            project_name: "AwesomeApp",
+            sources_path: File.expand_path("../AwesomeApp")
+          )'
+        ]
+      end
+
+      def self.category
+        :testing
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/ssh.rb

@@ -0,0 +1,162 @@
+module Pantograph
+  module Actions
+    module SharedValues
+      SSH_STDOUT_VALUE = :SSH_STDOUT_VALUE
+      SSH_STDERR_VALUE = :SSH_STDERR_VALUE
+    end
+
+    class SshAction < Action
+      def self.ssh_exec!(ssh, command, log = true)
+        stdout_data = ""
+        stderr_data = ""
+        exit_code = nil
+        exit_signal = nil
+        ssh.open_channel do |channel|
+          channel.exec(command) do |ch, success|
+            unless success
+              abort("FAILED: couldn't execute command (ssh.channel.exec)")
+            end
+            channel.on_data do |ch1, data|
+              stdout_data += data
+              UI.command_output(data) if log
+            end
+
+            channel.on_extended_data do |ch2, type, data|
+              # Only type 1 data is stderr (though no other types are defined by the standard)
+              # See http://net-ssh.github.io/net-ssh/Net/SSH/Connection/Channel.html#method-i-on_extended_data
+              stderr_data += data if type == 1
+            end
+
+            channel.on_request("exit-status") do |ch3, data|
+              exit_code = data.read_long
+            end
+
+            channel.on_request("exit-signal") do |ch4, data|
+              exit_signal = data.read_long
+            end
+          end
+        end
+
+        # Wait for all open channels to close
+        ssh.loop
+        { stdout: stdout_data, stderr: stderr_data, exit_code: exit_code, exit_signal: exit_signal }
+      end
+
+      def self.run(params)
+        Actions.verify_gem!('net-ssh')
+        require "net/ssh"
+
+        Actions.lane_context[SharedValues::SSH_STDOUT_VALUE] = ""
+        Actions.lane_context[SharedValues::SSH_STDERR_VALUE] = ""
+        stdout = ""
+        stderr = ""
+
+        Net::SSH.start(params[:host], params[:username], { port: params[:port].to_i, password: params[:password] }) do |ssh|
+          params[:commands].each do |cmd|
+            UI.command(cmd) if params[:log]
+            return_value = ssh_exec!(ssh, cmd, params[:log])
+            if return_value[:exit_code] != 0
+              UI.error("SSH Command failed '#{cmd}' Exit-Code: #{return_value[:exit_code]}")
+              UI.user_error!("SSH Command failed")
+            end
+
+            stderr << return_value[:stderr]
+            stdout << return_value[:stdout]
+          end
+        end
+        command_word = params[:commands].count == 1 ? "command" : "commands"
+        UI.success("Successfully executed #{params[:commands].count} #{command_word} on host #{params[:host]}")
+        Actions.lane_context[SharedValues::SSH_STDOUT_VALUE] = stdout
+        Actions.lane_context[SharedValues::SSH_STDERR_VALUE] = stderr
+        return { stdout: Actions.lane_context[SharedValues::SSH_STDOUT_VALUE], stderr: Actions.lane_context[SharedValues::SSH_STDERR_VALUE] }
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Allows remote command execution using ssh"
+      end
+
+      def self.details
+        "Lets you execute remote commands via ssh using username/password or ssh-agent. If one of the commands in command-array returns non 0, it fails."
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :username,
+                                       short_option: "-u",
+                                       env_name: "FL_SSH_USERNAME",
+                                       description: "Username",
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :password,
+                                       short_option: "-p",
+                                       env_name: "FL_SSH_PASSWORD",
+                                       sensitive: true,
+                                       description: "Password",
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :host,
+                                       short_option: "-H",
+                                       env_name: "FL_SSH_HOST",
+                                       description: "Hostname",
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :port,
+                                       short_option: "-P",
+                                       env_name: "FL_SSH_PORT",
+                                       description: "Port",
+                                       optional: true,
+                                       default_value: "22",
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :commands,
+                                       short_option: "-C",
+                                       env_name: "FL_SSH_COMMANDS",
+                                       description: "Commands",
+                                       optional: true,
+                                       is_string: false,
+                                       type: Array),
+          PantographCore::ConfigItem.new(key: :log,
+                                       short_option: "-l",
+                                       env_name: "FL_SSH_LOG",
+                                       description: "Log commands and output",
+                                       optional: true,
+                                       default_value: true,
+                                       is_string: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['SSH_STDOUT_VALUE', 'Holds the standard output of all commands'],
+          ['SSH_STDERR_VALUE', 'Holds the standard error of all commands']
+        ]
+      end
+
+      def self.authors
+        ["hjanuschka"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'ssh(
+            host: "dev.januschka.com",
+            username: "root",
+            commands: [
+              "date",
+              "echo 1 > /tmp/file1"
+            ]
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end