puppet_webhook 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7285f0d9e15b365e5b9e4b715a419182fc78e266f104762da4be350f45c05ffc
-  data.tar.gz: 619d6b615710aeb263f36f0d79162dd7036d18739ca5d5aa2dbe150f195f06a3
+  metadata.gz: 906dfa13bf22e727fd153eff673db49f0122e7fa5417ef213177f9bb5e210abc
+  data.tar.gz: db34a880e6a705920606229f35f5f9e48eeec57b64f583335ac3253d1041f042
 SHA512:
-  metadata.gz: 761de6f49d6d89c87a8c90fd790e2886b6d0fd316d996749cf2cc13ae8605deddd3e360ffa00f27a7449171856ffccc1b03854a590572031c1974a63e615b01a
-  data.tar.gz: a4f40e21093d3eebe62a95fc167297d84dc9b027f442d1be2efbd80a0394f65cb22ba66bc67fdba44118315d8588b399e76de49cf0108c79995bf36fb4675963
+  metadata.gz: bd6610589cdd23e673ae70ad39cdea36c042bf64dc73c785bebfdc550b792be616f431a451f425c7a21e6acae7ebb2b6c6c9847d251dec6d7d7266a6922d6b17
+  data.tar.gz: 79860c041ffe00bbca6b39e2a025a3818805b8fb960143e7a262dfe665feeaf2c0d0cfad42384f25c3111f0f9ea3e3202137b157bd3ce81ea0f2a6b241165b95

data/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 Each new release typically also includes the latest modulesync defaults.
 These should not affect the functionality of the module.
 
+## [v1.4.0](https://github.com/voxpupuli/puppet_webhook/tree/v1.4.0) (2018-05-02)
+[Full Changelog](https://github.com/voxpupuli/puppet_webhook/compare/v1.3.0...v1.4.0)
+
+**Implemented enhancements:**
+
+- Rocketchat plugin [\#53](https://github.com/voxpupuli/puppet_webhook/pull/53) ([dhollinger](https://github.com/dhollinger))
+- ChatOps Plugin Support [\#52](https://github.com/voxpupuli/puppet_webhook/pull/52) ([dhollinger](https://github.com/dhollinger))
+
 ## [v1.3.0](https://github.com/voxpupuli/puppet_webhook/tree/v1.3.0) (2018-04-24)
 [Full Changelog](https://github.com/voxpupuli/puppet_webhook/compare/v1.2.0...v1.3.0)
 
@@ -90,4 +98,4 @@ These should not affect the functionality of the module.
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -80,6 +80,77 @@ Any configuration option is placed in `/etc/puppet_webhook/server.yml` or `/etc/
 * `--ssl-key FILE`: Specify the SSL Private key to use. Pair with `--ssl-cert`. Requires `--ssl` or `ssl_enable: true` in config file.
 * `-c FILE, --configfile FILE`: Specifies a config file to use. Must be a `.yml` file in YAML format.
 
+#### Chatops Configuration
+
+Puppet_webhook can post to chatops tools via various APIs and Clients. At this time, only `Slack` is supported.
+
+To enable ChatOps support simply add the following to your `/etc/puppet_webhook/app.yml` file:
+``` yaml
+chatops: true
+```
+
+##### Slack Configuration
+
+You can enable Slack notifications for the webhook. You will need a Slack webhook URL and the `slack-notifier` gem installed.
+
+The `slack-notifier` gem is installed as a dependency to `puppet_webhook`
+
+To get the Slack webhook URL you need to:
+
+Go to https://slack.com/apps/A0F7XDUAZ-incoming-webhooks.
+Choose your team, press Configure.
+In configurations press Add configuration.
+Choose channel, press Add Incoming WebHooks integration.
+Then configure the webhook to add your Slack Webhook URL:
+
+``` yaml
+chatops: true
+chatops_service: 'slack' # Required so the app knows that you're sending to Slack.
+chatops_url: 'http://hooks.slack.com/services/path/to/your/webhook' # mandatory for usage
+chatops_channel: '#channel' # defaults to #general
+chatops_user: 'r10k' # defaults to puppet_webhook
+chatops_options:
+  icon_emoji: ':ocean:'
+  http_options: 
+    proxy_address: 'http://proxy.example.com'
+    proxy_port: '3128'
+    proxy_from_env: false
+```
+
+**NOTE: The legacy `slack_webhook`, `slack_user`, `slack_channel`, `slack_emoji`, and `slack_proxy_url` still work, but will be removed in 3.0.0**
+
+##### Rocket.Chat Configuration
+
+You can enable Rocket.Chat notifications for the webhook. You will need a
+Rocket.Chat incoming webhook URL and the `rocket-chat-notifier` gem installed.
+
+The `rocket-chat-notifier` gem is installed as a dependency to `puppet_webhook`
+
+To get the Rocket.Chat incoming webhook URL you need to:
+
+1. Go to your Rocket.Chat and then select `Administration-Integrations`.
+2. Choose `New integration`.
+3. Choose `Incoming WebHook`. In the webhook form configure:
+  * `Enabled`: `True`.
+  * `Name`: A name for your webhook.
+  * `Post to Channel`: The channel to post to by default.
+4. Save changes with `Save Changes` bottom.
+
+Then configure the webhook to add your Rocket.Chat Webhook URL:
+
+``` yaml
+chatops: true
+chatops_service: 'rocketchat' # Required so the app knows that you're sending to Rocket.Chat
+chatops_url: <your incoming webhook URL>  # mandatory for usage
+chatops_channel: '#channel' # defaults to #general
+chatops_user: 'r10k' # defaults to puppet_webhook
+chatops_options:
+  icon_emoji: ':ocean:'
+  http_options: 
+    open_timeout: 10
+```
+
+### Reference
 
 #### Server Configuration File
 
@@ -190,28 +261,81 @@ Whether or not to use MCollective CLI command. REQUIRES MCOLLECTIVE AND MCOLLECT
 MCollective Ruby discovery timeout. REQUIRES `use_mco_ruby` TO BE `true`.
 * Default: `'10'`
 
+##### chatops
+
+Enable the use of notifications to Slack or other ChatOps tool.
+* Valid options: [ `true`, `false` ]
+* Default: `false`
+
+##### chatops_service
+
+Name of ChatOps tool to send notifications to.
+* Valid options: [ `slack` ]
+* Default: `slack`
+
+##### chatops_url
+*Replaces `slack_webhook`*
+
+URL of the API or Webhook to send notifications to. See Documentation of your tool for details.
+* Default: `''`
+
+##### chatops_user
+*Replaces `slack_user`*
+
+User to post notification as.
+* Default: `puppet_webhook`
+
+##### chatops_channel
+*Replaces `slack_channel`*
+
+Channel/Team/Area to post to.
+* Default: `#general`
+
+##### chatops_options
+
+Hash of options to pass to the Chatops plugin. Each set of options are unique to each tool, so please see your tool's documentation for more information.
+* Default: `{}`
+
 ##### slack_webhook
+***DEPRECATED* - Please use `chatops_url` instead** 
 
 URL of your Slack Webhook receiver, if you wish not to use a Slack Webhook, then simply leave the option on `false`, otherwise use the full Wwebhook URL for your community as per https://api.slack.com/incoming-webhooks.
 * Valid options: [ `https://hooks.slack.com/services/<generated_hash>`, `false` ]
 * Default: `false`
 
 ##### slack_channel
+***DEPRECATED* - Please use `chatops_channel` instead** 
 
 Name of the Slack channel to post to. Ignored if `slack_webhook` is disabled.
 Default: `#general`
 
 ##### slack_user
+***DEPRECATED* - Please use `chatops_user` instead** 
 
 Name of the Slack user to post as. Ignored if `slack_webhook` is disabled.
 Default: `puppet_webhook`
 
 ##### slack_emoji
+***DEPRECATED* - Please use `chatops_options` instead.**
+**Example for new config ONLY:**
+``` yaml
+chatops_options:
+  icon_emoji: ':ocean:'
+``` 
 
 Icon emoji for the Webhook to use when posting. Ignored if `slack_webhook` is disabled.
 Default: `:ocean:`
 
 ##### slack_proxy_url
+***DEPRECATED* - Please use `chatops_options` instead.**
+**Example for new config ONLY:**
+``` yaml
+chatops_options:
+ http_options: 
+    proxy_address: 'http://proxy.example.com'
+    proxy_port: '3128'
+    proxy_from_env: false
+``` 
 
 The proxy URL for Slack if used.
 * MUST BE A VALID URL.

data/config/app.yml

@@ -10,8 +10,13 @@ use_mco_ruby: false
 use_mcollective: false
 discovery_timeout: '10'
 
-# Slack Notifications
-slack_webhook: false
+# Chatops Notification
+chatops: false
+# Slack Example
+# chatops_service: 'slack'
+# chatops_channel: '#general'
+# chatops_user: 'r10k'
+# chatops_url: 'https://hooks.slack.com/services/<hash>/<hash>/<hash>'
 
 # R10k
 default_branch: production

data/lib/helpers/deployments.rb

@@ -1,4 +1,5 @@
 require 'plugins/mcollective'
+require 'plugins/chatops'
 
 module Deployments # rubocop:disable Style/Documentation
   def deploy(branch, deleted)
@@ -23,18 +24,18 @@ module Deployments # rubocop:disable Style/Documentation
       command = "#{settings.command_prefix} r10k deploy environment #{branch} #{settings.r10k_deploy_arguments}"
       message = run_command(command)
     end
-    status_message = { status: :success, message: message.to_s, branch: branch, status_code: 200 }
+    status_message = { status: :success, message: message.to_s, branch: branch, status_code: 202 }
     LOGGER.info("message: #{message} branch: #{branch}")
     unless deleted
       generate_types(branch) if types?
     end
-    notify_slack(status_message) if slack?
+    notification(status_message)
     [status_message[:status_code], status_message.to_json]
   rescue StandardError => e
     status_message = { status: :fail, message: e.message, trace: e.backtrace, branch: branch, status_code: 500 }
     LOGGER.error("message: #{e.message} trace: #{e.backtrace}")
     status 500
-    notify_slack(status_message) if slack?
+    notification(status_message)
     status_message.to_json
   end
 
@@ -61,14 +62,14 @@ module Deployments # rubocop:disable Style/Documentation
       message = run_command(command)
     end
     LOGGER.info("message: #{message} module_name: #{module_name}")
-    status_message = { status: :success, message: message.to_s, module_name: module_name, status_code: 200 }
-    notify_slack(status_message) if slack?
+    status_message = { status: :success, message: message.to_s, module_name: module_name, status_code: 202 }
+    notification(status_message)
     status_message.to_json
   rescue StandardError => e
+    status_message = { status: :fail, message: e.message, trace: e.backtrace, branch: branch, status_code: 500 }
     LOGGER.error("message: #{e.message} trace: #{e.backtrace}")
     status 500
-    status_message = { status: :fail, message: e.message, trace: e.backtrace, module_name: module_name, status_code: 500 }
-    notify_slack(status_message) if slack?
+    notification(status_message)
     status_message.to_json
   end
 end

data/lib/helpers/tasks.rb

@@ -48,7 +48,7 @@ module Tasks # rubocop:disable Style/Documentation
 
   def run_command(command)
     message = "forked: #{command}"
-    exec "#{command} &"
+    system "#{command} &"
     message
   end
 
@@ -58,66 +58,53 @@ module Tasks # rubocop:disable Style/Documentation
     message = run_command(command)
     LOGGER.info("message: #{message} environment: #{environment}")
     status_message = { status: :success, message: message.to_s, environment: environment, status_code: 200 }
-    notify_slack(status_message) if slack?
+    notification(status_message)
   rescue StandardError => e
     LOGGER.error("message: #{e.message} trace: #{e.backtrace}")
     status_message = { status: :fail, message: e.message, trace: e.backtrace, environment: environment, status_code: 500 }
-    notify_slack(status_message) if slack?
+    notification(status_message)
   end
 
-  def notify_slack(status_message)
-    return unless settings.slack_webhook
-
-    if settings.slack_proxy_url
-      uri = URI(settings.slack_proxy_url)
-      http_options = {
-        proxy_address:  uri.hostname,
-        proxy_port:     uri.port,
-        proxy_from_env: false
-      }
-    else
-      http_options = {}
-    end
-
-    notifier = Slack::Notifier.new settings.slack_webhook do
-      defaults channel: settings.slack_channel,
-               username: settings.slack_user,
-               icon_emoji: settings.slack_emoji,
-               http_options: http_options
-    end
-
-    if status_message[:branch]
-      target = status_message[:branch]
-    elsif status_message[:module]
-      target = status_message[:module]
-    end
-
-    message = {
-      author: 'r10k for Puppet',
-      title: "r10k deployment of Puppet environment #{target}"
-    }
-
-    case status_message[:status_code]
-    when 200
-      message.merge!(
-        color: 'good',
-        text: "Successfully deployed #{target}",
-        fallback: "Successfully deployed #{target}"
-      )
-    when 500
-      message.merge!(
-        color: 'bad',
-        text: "Failed to deploy #{target}",
-        fallback: "Failed to deploy #{target}"
-      )
-    end
+  def notification(message)
+    return unless settings.chatops || settings.slack_webhook
+    slack_settings if settings.chatops == false && settings.slack_webhook != false
+    PuppetWebhook::Chatops.new(settings.chatops_service,
+                               settings.chatops_url,
+                               settings.chatops_channel,
+                               settings.chatops_user,
+                               settings.chatops_options).notify(message)
+  end
 
-    notifier.post text: message[:fallback], attachments: [message]
+  # Deprecated
+  # TODO: Remove in release 3.0.0
+  def slack_settings
+    settings.chatops_service = 'slack'
+    LOGGER.warn('settings.slack_webhook is deprecated and will be removed in puppet_webhook 3.0.0')
+    settings.chatops_url = settings.slack_webhook
+    LOGGER.warn('settings.slack_user is deprecated and will be removed in puppet_webhook 3.0.0')
+    settings.chatops_user = settings.slack_user
+    LOGGER.warn('settings.slack_channel is deprecated and will be removed in puppet_webhook 3.0.0')
+    settings.chatops_channel = settings.slack_channel
+    LOGGER.warn('settings.slack_emoji is deprecated and will be removed in puppet_webhook 3.0.0')
+    settings.chatops_options[:icon_emoji] = settings.slack_emoji
+    LOGGER.warn('settings.slack_proxy_url is deprecated and will be removed in puppet_webhook 3.0.0')
+    settings.chatops_options[:http_options] = if settings.slack_proxy_url
+                                                slack_proxy
+                                              else
+                                                {}
+                                              end
   end
 
-  def slack?
-    return false if settings.slack_webhook.nil?
-    settings.slack_webhook
+  # Deprecated
+  # TODO: Remove in release 3.0.0
+  def slack_proxy
+    uri = URI(settings.slack_proxy_url)
+    http_options = {
+      proxy_address:  uri.hostname,
+      proxy_port:     uri.port,
+      proxy_from_env: false
+    }
+    http_options
   end
 
   def types?

data/lib/plugins/chatops/rocketchat.rb

@@ -0,0 +1,60 @@
+require 'rocket-chat-notifier'
+
+class PuppetWebhook
+  class Chatops
+    # Sets up Rocketchat object that will send notifications to Slack via a webhook.
+    class Rocketchat
+      def initialize(channel, url, user, message, options = {})
+        @channel = channel
+        @url = url
+        @user = user
+        @message = message
+        @options = options
+      end
+
+      def notify
+        notifier = RocketChat::Notifier.new @url, http_options: @options[:http_options]
+        notifier.username = @user
+        notifier.channel = @channel
+
+        target = if @message[:branch]
+                   @message[:branch]
+                 elsif @message[:module]
+                   @message[:module]
+                 end
+
+        msg = "r10k deployment of Puppet environment/module #{target} started..."
+
+        attachment = format_attachment(target)
+
+        notifier.ping(msg, icon_emoji: @options[:icon_emoji], attachments: [attachment])
+      end
+
+      private
+
+      def format_attachment(target)
+        attachment = {
+          author: 'r10k for Puppet',
+          title: "r10k deployment of Puppet environment #{target}"
+        }
+
+        case @message[:status_code]
+        when 200
+          attachment.merge!(
+            color: 'good',
+            text: "Successfully started deployment of #{target}",
+            fallback: "Successfully started deployment of #{target}"
+          )
+        when 500
+          attachment.merge!(
+            color: 'bad',
+            text: "Failed to deploy #{target}",
+            fallback: "Failed to deploy #{target}"
+          )
+        end
+
+        attachment
+      end
+    end
+  end
+end

data/lib/plugins/chatops/slack.rb

@@ -0,0 +1,60 @@
+require 'slack-notifier'
+
+class PuppetWebhook
+  class Chatops
+    # Sets up Slack object that will send notifications to Slack via a webhook.
+    class Slack
+      def initialize(channel, url, user, message, options = {})
+        @channel = channel
+        @url = url
+        @user = user
+        @message = message
+        @options = options
+      end
+
+      def notify
+        notifier = ::Slack::Notifier.new @url, http_options: @options[:http_options]
+
+        target = if @message[:branch]
+                   @message[:branch]
+                 elsif @message[:module]
+                   @message[:module]
+                 end
+
+        msg = format_message(target)
+
+        notifier.post text: msg[:fallback],
+                      channel: @channel,
+                      username: @user,
+                      icon_emoji: @options[:icon_emoji],
+                      attachments: [msg]
+      end
+
+      private
+
+      def format_message(target)
+        message = {
+          author: 'r10k for Puppet',
+          title: "r10k deployment of Puppet environment #{target}"
+        }
+
+        case @message[:status_code]
+        when 202
+          message.merge!(
+            color: 'good',
+            text: "Successfully started deployment of #{target}",
+            fallback: "Successfully started deployment of #{target}"
+          )
+        when 500
+          message.merge!(
+            color: 'bad',
+            text: "Failed to deploy #{target}",
+            fallback: "Failed to deploy #{target}"
+          )
+        end
+
+        message
+      end
+    end
+  end
+end

data/lib/plugins/chatops.rb

@@ -0,0 +1,41 @@
+class PuppetWebhook
+  # Chatops object for sending webhook notifications to chatops tools
+  class Chatops
+    def initialize(service, url, channel, user, options = {})
+      @service = service
+      @url = url
+      @channel = channel
+      @user = user
+      @args = options
+    end
+
+    def notify(message)
+      case @service
+      when 'slack'
+        require 'plugins/chatops/slack'
+        LOGGER.info("Sending Slack webhook message to #{@url}")
+        Chatops::Slack.new(
+          @channel,
+          @url,
+          @user,
+          message,
+          http_options: @args[:http_options] || {},
+          icon_emoji: @args[:icon_emoji]
+        ).notify
+      when 'rocketchat'
+        require 'plugins/chatops/rocketchat'
+        LOGGER.info("Sending Rocket.Chat webhook message to #{@url}")
+        Chatops::Rocketchat.new(
+          @channel,
+          @url,
+          @user,
+          message,
+          http_options: @args[:http_options] || {},
+          icon_emoji: @args[:icon_emoji]
+        ).notify
+      else
+        LOGGER.error("Service #{@service} is not currently supported")
+      end
+    end
+  end
+end

data/lib/puppet_webhook.rb

@@ -37,11 +37,12 @@ class PuppetWebhook < Sinatra::Base # rubocop:disable Style/Documentation
   set :use_mco_ruby, false unless settings.respond_to? :use_mco_ruby=
   set :use_mcollective, false unless settings.respond_to? :use_mcollective=
   set :discovery_timeout, false unless settings.respond_to? :discovery_timeout=
-  set :slack_webhook, false unless settings.respond_to? :slack_webhook=
-  set :slack_channel, '#general' unless settings.respond_to? :slack_channel=
-  set :slack_user, 'puppet_webhook' unless settings.respond_to? :slack_user=
-  set :slack_emoji, ':ocean:' unless settings.respond_to? :slack_emoji=
-  set :slack_proxy_url, nil unless settings.respond_to? :slack_proxy_url=
+  set :chatops, false unless settings.respond_to? :chatops=
+  set :chatops_service, 'slack' unless settings.respond_to? :chatops_service=
+  set :chatops_url, '' unless settings.respond_to? :chatops_url=
+  set :chatops_channel, '#general' unless settings.respond_to? :chatops_channel=
+  set :chatops_user, 'puppet_webhook' unless settings.respond_to? :chatops_user=
+  set :chatops_options, {} unless settings.respond_to? :chatops_options=
   set :default_branch, 'production' unless settings.respond_to? :default_branch=
   set :ignore_environments, [] unless settings.respond_to? :ignore_environments=
   set :prefix, nil unless settings.respond_to? :prefix=
@@ -52,6 +53,13 @@ class PuppetWebhook < Sinatra::Base # rubocop:disable Style/Documentation
   set :github_secret, nil unless settings.respond_to? :github_secret=
   set :repository_events, nil unless settings.respond_to? :respository_events=
 
+  # Deprecated Settings
+  set :slack_webhook, false unless settings.respond_to? :slack_webhook=
+  set :slack_channel, '#general' unless settings.respond_to? :slack_channel=
+  set :slack_user, 'puppet_webhook' unless settings.respond_to? :slack_user=
+  set :slack_emoji, ':ocean:' unless settings.respond_to? :slack_emoji=
+  set :slack_proxy_url, nil unless settings.respond_to? :slack_proxy_url=
+
   require 'helpers/init'
 
   register Sinatra::PuppetWebhookRoutes::Default

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet_webhook
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rocket-chat-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -239,6 +253,9 @@ files:
 - lib/parsers/webhook_json_parser.rb
 - lib/parsers/webhook_parser.rb
 - lib/parsers/webhook_www_form_url_encoded_parser.rb
+- lib/plugins/chatops.rb
+- lib/plugins/chatops/rocketchat.rb
+- lib/plugins/chatops/slack.rb
 - lib/plugins/mcollective.rb
 - lib/puppet_webhook.rb
 - lib/routes/default.rb