fluent-plugin-slack 0.4.0 → 0.5.0

data/lib/fluent/plugin/slack_client.rb

@@ -0,0 +1,107 @@
+require 'uri'
+require 'net/http'
+
+module Fluent
+  module SlackClient
+    class Error < StandardError; end
+
+    # This slack client only supports posting message
+    class Base
+      attr_accessor :log, :debug_dev
+
+      DEFAULT_ENDPOINT = "https://slack.com/api/chat.postMessage"
+
+      def initialize(endpoint = nil)
+        # Configure Incoming Webhook endpoint instead of chat.postMessage API
+        @endpoint = URI.parse(endpoint) if endpoint
+      end
+
+      def endpoint
+        @endpoint ||= URI.parse(DEFAULT_ENDPOINT)
+      end
+
+      # Sends a message to a channel.
+      #
+      # @option params [channel] :channel
+      #   Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
+      # @option params [Object] :text
+      #   Text of the message to send. See below for an explanation of formatting.
+      # @option params [Object] :username
+      #   Name of bot.
+      # @option params [Object] :parse
+      #   Change how messages are treated. See below.
+      # @option params [Object] :link_names
+      #   Find and link channel names and usernames.
+      # @option params [Object] :attachments
+      #   Structured message attachments.
+      # @option params [Object] :unfurl_links
+      #   Pass true to enable unfurling of primarily text-based content.
+      # @option params [Object] :unfurl_media
+      #   Pass false to disable unfurling of media content.
+      # @option params [Object] :icon_url
+      #   URL to an image to use as the icon for this message
+      # @option params [Object] :icon_emoji
+      #   emoji to use as the icon for this message. Overrides `icon_url`.
+      # @see https://api.slack.com/methods/chat.postMessage
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.postMessage.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.postMessage.json
+      def post_message(params = {})
+        http = Net::HTTP.new(endpoint.host, endpoint.port)
+        http.use_ssl = (endpoint.scheme == 'https')
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.set_debug_output(debug_dev) if debug_dev
+
+        req = Net::HTTP::Post.new(endpoint.path)
+        req['Host'] = endpoint.host
+        req['Accept'] = 'application/json; charset=utf-8'
+        req['User-Agent'] = 'fluent-plugin-slack'
+        req.body = encode_body(params)
+
+        log.info { "out_slack: post #{params.dup.tap {|p| p[:token] = '[FILTERED]' if p[:token] }}" } if log
+        res = http.request(req)
+        response_check(res)
+      end
+
+      def encode_body(params)
+        raise NotImplementedError
+      end
+
+      def response_check(res)
+        if res.code != "200"
+          raise Error, "Slack.com - #{res.code} - #{res.body}"
+        end
+      end
+    end
+
+    class IncomingWebhook < Base
+      def encode_body(params = {})
+        params.to_json
+      end
+
+      def response_check(res)
+        super
+        unless res.body == 'ok'
+          raise Error, "Slack.com - #{res.code} - #{res.body}"
+        end
+      end
+    end
+
+    class WebApi < Base
+      def encode_body(params = {})
+        body = params.dup
+        if params[:attachments]
+          body[:attachments] = params[:attachments].to_json
+        end
+        URI.encode_www_form(body)
+      end
+
+      def response_check(res)
+        super
+        params = JSON.parse(res.body)
+        unless params['ok']
+          raise Error, "Slack.com - #{res.code} - #{res.body}"
+        end
+      end
+    end
+  end
+end

data/test/plugin/test_out_slack.rb

@@ -0,0 +1,259 @@
+require_relative '../test_helper'
+require 'fluent/plugin/out_slack'
+require 'time'
+
+class SlackOutputTest < Test::Unit::TestCase
+
+  def setup
+    super
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    channel channel
+    token   XXX-XXX-XXX
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::SlackOutput).configure(conf)
+  end
+
+  # old version compatibility with v0.4.0"
+  def test_old_config
+    # default check
+    d = create_driver
+    assert_equal true,         d.instance.localtime
+    assert_equal 'fluentd',    d.instance.username
+    assert_equal 'good',       d.instance.color
+    assert_equal ':question:', d.instance.icon_emoji
+
+    # incoming webhook endpoint was changed. api_key option should be ignored
+    assert_nothing_raised do
+      create_driver(CONFIG + %[api_key testtoken])
+    end
+
+    # incoming webhook endpoint was changed. team option should be ignored
+    assert_nothing_raised do
+      create_driver(CONFIG + %[team sowasowa])
+    end
+
+    # rtm? it was not calling `rtm.start`. rtm option was removed and should be ignored
+    assert_nothing_raised do
+      create_driver(CONFIG + %[rtm true])
+    end
+
+    # channel should be URI.unescape-ed
+    d = create_driver(CONFIG + %[channel %23test])
+    assert_equal '#test', d.instance.channel
+
+    # timezone should work
+    d = create_driver(CONFIG + %[timezone Asia/Tokyo])
+    assert_equal 'Asia/Tokyo', d.instance.timezone
+  end
+
+  def test_configure
+    d = create_driver(%[
+      channel      channel
+      time_format  %Y/%m/%d %H:%M:%S
+      username     username
+      color        bad
+      icon_emoji   :ghost:
+      token        XX-XX-XX
+      title        slack notice!
+      message      %s
+      message_keys message
+    ])
+    assert_equal '#channel', d.instance.channel
+    assert_equal '%Y/%m/%d %H:%M:%S', d.instance.time_format
+    assert_equal 'username', d.instance.username
+    assert_equal 'bad', d.instance.color
+    assert_equal ':ghost:', d.instance.icon_emoji
+    assert_equal 'XX-XX-XX', d.instance.token
+    assert_equal '%s', d.instance.message
+    assert_equal ['message'], d.instance.message_keys
+
+    assert_raise(Fluent::ConfigError) do
+      create_driver(CONFIG + %[title %s %s\ntitle_keys foo])
+    end
+
+    assert_raise(Fluent::ConfigError) do
+      create_driver(CONFIG + %[message %s %s\nmessage_keys foo])
+    end
+
+    assert_raise(Fluent::ConfigError) do
+      create_driver(CONFIG + %[channel %s %s\nchannel_keys foo])
+    end
+  end
+
+  def test_timezone_configure
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+
+    d = create_driver(CONFIG + %[localtime])
+    with_timezone('Asia/Tokyo') do
+      assert_equal true,       d.instance.localtime
+      assert_equal "07:00:00", d.instance.timef.format(time)
+    end
+
+    d = create_driver(CONFIG + %[utc])
+    with_timezone('Asia/Tokyo') do
+      assert_equal false,      d.instance.localtime
+      assert_equal "22:00:00", d.instance.timef.format(time)
+    end
+
+    d = create_driver(CONFIG + %[timezone Asia/Taipei])
+    with_timezone('Asia/Tokyo') do
+      assert_equal "Asia/Taipei", d.instance.timezone
+      assert_equal "06:00:00",    d.instance.timef.format(time)
+    end
+  end
+
+  def test_time_format_configure
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+
+    d = create_driver(CONFIG + %[time_format %Y/%m/%d %H:%M:%S])
+    with_timezone('Asia/Tokyo') do
+      assert_equal "2014/01/02 07:00:00", d.instance.timef.format(time)
+    end
+  end
+
+  def test_buffer_configure
+    assert_nothing_raised do
+      create_driver(CONFIG + %[buffer_type file\nbuffer_path tmp/])
+    end
+  end
+
+  def test_default_incoming_webhook
+    d = create_driver(%[
+      channel channel
+      webhook_url https://hooks.slack.com/services/XXX/XXX/XXX
+    ])
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    mock(d.instance.slack).post_message(
+      channel:     '#channel',
+      username:    'fluentd',
+      icon_emoji:  ':question:',
+      attachments: [{
+        color:    'good',
+        fallback: 'test',
+        fields:   [{
+          title: 'test',
+          value: "[07:00:00] sowawa1\n[07:00:00] sowawa2\n",
+        }],
+      }]
+    )
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'sowawa1'}, time)
+      d.emit({message: 'sowawa2'}, time)
+      d.run
+    end
+  end
+
+  def test_default_slack_api
+    d = create_driver(%[
+      channel channel
+      token   XX-XX-XX
+    ])
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    mock(d.instance.slack).post_message(
+      token:       'XX-XX-XX',
+      channel:     '#channel',
+      username:    'fluentd',
+      icon_emoji:  ':question:',
+      attachments: [{
+        color:    'good',
+        fallback: "sowawa1\nsowawa2\n",
+        text:     "sowawa1\nsowawa2\n",
+      }]
+    )
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'sowawa1'}, time)
+      d.emit({message: 'sowawa2'}, time)
+      d.run
+    end
+  end
+
+  def test_title_keys
+    d = create_driver(CONFIG + %[title %s\ntitle_keys tag])
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    # attachments field should be changed to show the title
+    mock(d.instance.slack).post_message(
+      token:       'XXX-XXX-XXX',
+      channel:     '#channel',
+      username:    'fluentd',
+      icon_emoji:  ':question:',
+      attachments: [{
+        color:    'good',
+        fallback: d.tag,
+        fields:   [
+          {
+            title: d.tag,
+            value: "sowawa1\nsowawa2\n",
+          }
+        ]
+      }]
+    )
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'sowawa1'}, time)
+      d.emit({message: 'sowawa2'}, time)
+      d.run
+    end
+  end
+
+  def test_message_keys
+    d = create_driver(CONFIG + %[message %s %s\nmessage_keys tag,message])
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    mock(d.instance.slack).post_message(
+      token:       'XXX-XXX-XXX',
+      channel:     '#channel',
+      username:    'fluentd',
+      icon_emoji:  ':question:',
+      attachments: [{
+        color:    'good',
+        fallback: "test sowawa1\ntest sowawa2\n",
+        text:     "test sowawa1\ntest sowawa2\n",
+      }]
+    )
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'sowawa1'}, time)
+      d.emit({message: 'sowawa2'}, time)
+      d.run
+    end
+  end
+
+  def test_channel_keys
+    d = create_driver(CONFIG + %[channel %s\nchannel_keys channel])
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    mock(d.instance.slack).post_message(
+      token:       'XXX-XXX-XXX',
+      channel:     '#channel1',
+      username:    'fluentd',
+      icon_emoji:  ':question:',
+      attachments: [{
+        color:    'good',
+        fallback: "sowawa1\n",
+        text:     "sowawa1\n",
+      }]
+    )
+    mock(d.instance.slack).post_message(
+      token:       'XXX-XXX-XXX',
+      channel:     '#channel2',
+      username:    'fluentd',
+      icon_emoji:  ':question:',
+      attachments: [{
+        color:    'good',
+        fallback: "sowawa2\n",
+        text:     "sowawa2\n",
+      }]
+    )
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'sowawa1', channel: 'channel1'}, time)
+      d.emit({message: 'sowawa2', channel: 'channel2'}, time)
+      d.run
+    end
+  end
+end

data/test/plugin/test_slack_client.rb

@@ -0,0 +1,73 @@
+require_relative '../test_helper'
+require 'fluent/plugin/slack_client'
+require 'time'
+require 'dotenv'
+
+# HOW TO RUN
+#
+# Create .env file with contents as:
+#
+#     WEBHOOK_URL=https://hooks.slack.com/services/XXXX/YYYY/ZZZZ
+#     TOKEN=XXXXX
+#
+Dotenv.load
+if ENV['WEBHOOK_URL'] and ENV['TOKEN']
+  class SlackClientTest < Test::Unit::TestCase
+    def setup
+      super
+      @incoming_webhook = Fluent::SlackClient::IncomingWebhook.new(ENV['WEBHOOK_URL'])
+      @api = Fluent::SlackClient::WebApi.new
+    end
+
+    def token(client)
+      client == @api ? {token: ENV['TOKEN']} : {}
+    end
+
+    def test_text
+      [@incoming_webhook, @api].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(
+            {
+              channel:     '#general',
+              username:    'fluentd',
+              icon_emoji:  ':question:',
+              attachments: [{
+                color:    'good',
+                fallback: "sowawa1\nsowawa2\n",
+                text:     "sowawa1\nsowawa2\n",
+              }]
+            }.merge(token(slack))
+          )
+        end
+      end
+    end
+
+    def test_fields
+      [@incoming_webhook, @api].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(
+            {
+              channel:     '#general',
+              username:    'fluentd',
+              icon_emoji:  ':question:',
+              attachments: [{
+                color:    'good',
+                fallback: 'test1 test2',
+                fields:   [
+                  {
+                    title: 'test1',
+                    value: "[07:00:00] sowawa1\n[07:00:00] sowawa2\n",
+                  },
+                  {
+                    title: 'test2',
+                    value: "[07:00:00] sowawa1\n[07:00:00] sowawa2\n",
+                  },
+                ],
+              }]
+            }.merge(token(slack))
+          )
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -23,5 +23,11 @@ unless ENV.has_key?('VERBOSE')
   $log = nulllogger
 end
 
-require 'fluent/plugin/out_buffered_slack'
+def with_timezone(tz)
+  oldtz, ENV['TZ'] = ENV['TZ'], tz
+  yield
+ensure
+  ENV['TZ'] = oldtz
+end
+
 require 'rr'