fluent-plugin-slack 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f75a082b3fc4e977a269cd78744064139e102945
-  data.tar.gz: c9a28cc8cfafa9b4bb80522b2b6261de9b4af55a
+  metadata.gz: 63a07a1d2026c16d55cd088092f69953404b202e
+  data.tar.gz: 33f8b2de136067d8e0e7adfa69457bb676d97eaa
 SHA512:
-  metadata.gz: fc23d99226fe190408dbbb144325a90de7d19af07d67ab54544170059124cb1c6e03b68610aa4e976abeeca47cafc12b4d5120e8c67ff8f7301157d199911114
-  data.tar.gz: 1eca5ba6bac83f01942b4aec43a24327b5c50d04cdf964c0478dec2d0ce2afbcecea49d492bfc0061a1478186f33aabbad3512afdd43984020fb82e80c818561
+  metadata.gz: 429287c6ea93b6a2af9371e7c50624142295be16a2e81e2ba27f3d293dc310eed431a0481f33b349c52384839db415401285f38ee7a4dbbcc778dc2f5017ad06
+  data.tar.gz: 50b5c8f83db6ef873cc448c85106b63e6dd7c6ff547f960701ec0634077d9539d09cbb5adfea347448c17982c538f87c5cfd37a44876eb5f90c2e91d43c3dfc6

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 0.6.0 (2015/04/02)
+
+This version has impcompatibility with previous versions in default option values
+
+Enhancements:
+
+* Support `link_names` and `parse` option. `link_names` option is `true` as default
+
+Changes:
+
+* the default payload of Incoming Webhook was changed
+* `color` is `nil` as default
+* `icon_emoji` is `nil` as default
+* `username` is `nil` as default
+* `mrkdwn` is `true` as default
+
 ## 0.5.5 (2015/04/01)
 
 Enhancements:

data/README.md

@@ -14,7 +14,6 @@ $ fluent-gem install fluent-plugin-slack
   webhook_url https://hooks.slack.com/services/XXX/XXX/XXX
   channel general
   username sowasowa
-  color good
   icon_emoji :ghost:
   flush_interval 60s
 </match>
@@ -51,7 +50,6 @@ fluent_logger.post('slack', {
   token xoxb-XXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXX
   channel general
   username sowasowa
-  color good
   icon_emoji :ghost:
   flush_interval 60s
 </match>
@@ -68,16 +66,18 @@ fluent_logger.post('slack', {
 |parameter|description|default|
 |---|---|---|
 |webhook_url|Incoming Webhook URI (Required for Incoming Webhook mode). See https://api.slack.com/incoming-webhooks||
-|slackbot_url|Slackbot URI (Required for Slackbot mode). See https://api.slack.com/slackbot. `username`, `color`, `icon_emoji`, `icon_url` are not available for this mode, but Desktop Notification via Highlight Words works with only this mode (Notification via Mentions works from Incoming Webhook and Web API with link_names=1, but Notification via Highlight Words does not)||
+|slackbot_url|Slackbot URI (Required for Slackbot mode). See https://api.slack.com/slackbot. NOTE: most of optional parameters such as `username`, `color`, `icon_emoji`, `icon_url`, and `title` are not available for this mode, but Desktop Notification via Highlight Words works with only this mode||
 |token|Token for Web API (Required for Web API mode). See https://api.slack.com/web||
-|username|name of bot|fluentd|
-|color|color to use|good|
-|icon_emoji|emoji to use as the icon. either of icon_emoji or icon_url can be specified|`:question:`|
-|icon_url|url to an image to use as the icon. either of icon_emoji or icon_url can be specified|nil|
-|mrkdwn|enable formatting. see https://api.slack.com/docs/formatting|false|
+|username|name of bot|nil|
+|color|color to use such as `good` or `bad`. See `Color` section of https://api.slack.com/docs/attachments. NOTE: This parameter must **not** be specified to receive Desktop Notification via Mentions in cases of Incoming Webhook and Slack Web API|nil|
+|icon_emoji|emoji to use as the icon. either of `icon_emoji` or `icon_url` can be specified|nil|
+|icon_url|url to an image to use as the icon. either of `icon_emoji` or `icon_url` can be specified|nil|
+|mrkdwn|enable formatting. see https://api.slack.com/docs/formatting|true|
+|link_names|find and link channel names and usernames. NOTE: This parameter must be `true` to receive Desktop Notification via Mentions in cases of Incoming Webhook and Slack Web API|true|
+|parse|change how messages are treated. `none` or `full` can be specified. See `Parsing mode` section of https://api.slack.com/docs/formatting|nil|
 |channel|channel to send messages (without first '#')||
 |channel_keys|keys used to format channel. %s will be replaced with value specified by channel_keys if this option is used|nil|
-|title|title format. %s will be replaced with value specified by title_keys. title is created from the first appeared record on each tag|nil|
+|title|title format. %s will be replaced with value specified by title_keys. title is created from the first appeared record on each tag. NOTE: This parameter must **not** be specified to receive Desktop Notification via Mentions in cases of Incoming Webhook and Slack Web API|nil|
 |title_keys|keys used to format the title|nil|
 |message|message format. %s will be replaced with value specified by message_keys|%s|
 |message_keys|keys used to format messages|message|
@@ -97,6 +97,17 @@ fluent_logger.post('slack', {
 
 `fluent-plugin-slack` is a kind of BufferedOutput plugin, so you can also use [Buffer Parameters](http://docs.fluentd.org/articles/out_exec#buffer-parameters).
 
+## FAQ
+
+### Desktop Notification seems not working?
+
+Currently, slack.com has following limitations:
+
+1. Desktop Notification via both Highlight Words and Mentions works only with Slackbot Remote Control
+2. Desktop Notification via Mentions works for the `text` field if `link_names` parameter is specified in cases of Incoming Webhook and Slack Web API, that is,
+  * Desktop Notification does not work for the `attachments` filed (used in `color` and `title`)
+  * Desktop Notification via Highlight Words does not work for Incoming Webhook and Slack Web API anyway
+
 ## ChangeLog
 
 See [CHANGELOG.md](CHANGELOG.md) for details.

data/VERSION

@@ -1 +1 @@
-0.5.5
+0.6.0

data/lib/fluent/plugin/out_buffered_slack.rb

@@ -14,11 +14,13 @@ module Fluent
     config_param :webhook_url,          :string, default: nil # incoming webhook
     config_param :slackbot_url,         :string, default: nil # slackbot
     config_param :token,                :string, default: nil # api token
-    config_param :username,             :string, default: 'fluentd'
-    config_param :color,                :string, default: 'good'
+    config_param :username,             :string, default: nil
+    config_param :color,                :string, default: nil
     config_param :icon_emoji,           :string, default: nil
     config_param :icon_url,             :string, default: nil
-    config_param :mrkdwn,               :bool,   default: false
+    config_param :mrkdwn,               :bool,   default: true
+    config_param :link_names,           :bool,   default: true
+    config_param :parse,                :string, default: nil
     config_param :auto_channels_create, :bool,   default: false
     config_param :https_proxy,          :string, default: nil
 
@@ -56,25 +58,19 @@ module Fluent
         if @webhook_url.empty?
           raise Fluent::ConfigError.new("`webhook_url` is an empty string")
         end
-        # following default values are for old version compatibility
-        @title         ||= '%s'
-        @title_keys    ||= %w[tag]
-        @message       ||= '[%s] %s'
-        @message_keys  ||= %w[time message]
         @slack = Fluent::SlackClient::IncomingWebhook.new(@webhook_url)
       elsif @slackbot_url
         if @slackbot_url.empty?
           raise Fluent::ConfigError.new("`slackbot_url` is an empty string")
         end
-        @message      ||= '%s'
-        @message_keys ||= %w[message]
+        if @username or @color or @icon_emoji or @icon_url
+          log.warn "out_slack: `username`, `color`, `icon_emoji`, `icon_url` parameters are not available for Slackbot Remote Control"
+        end
         @slack = Fluent::SlackClient::Slackbot.new(@slackbot_url)
       elsif @token
         if @token.empty?
           raise Fluent::ConfigError.new("`token` is an empty string")
         end
-        @message      ||= '%s'
-        @message_keys ||= %w[message]
         @slack = Fluent::SlackClient::WebApi.new
       else
         raise Fluent::ConfigError.new("One of `webhook_url` or `slackbot_url`, or `token` is required")
@@ -86,6 +82,8 @@ module Fluent
         @slack.https_proxy = @https_proxy
       end
 
+      @message      ||= '%s'
+      @message_keys ||= %w[message]
       begin
         @message % (['1'] * @message_keys.length)
       rescue ArgumentError
@@ -109,13 +107,16 @@ module Fluent
       if @icon_emoji and @icon_url
         raise Fluent::ConfigError, "either of `icon_emoji` or `icon_url` can be specified"
       end
-      @icon_emoji ||= ':question:' unless @icon_url
 
       if @mrkdwn
         # Enable markdown for attachments. See https://api.slack.com/docs/formatting
         @mrkdwn_in = %w[text fields]
       end
 
+      if @parse and !%w[none full].include?(@parse)
+        raise Fluent::ConfigError, "`parse` must be either of `none` or `full`"
+      end
+
       @post_message_opts = @auto_channels_create ? {auto_channels_create: true} : {}
     end
 
@@ -142,6 +143,8 @@ module Fluent
     def build_payloads(chunk)
       if @title
         build_title_payloads(chunk)
+      elsif @color
+        build_color_payloads(chunk)
       else
         build_plain_payloads(chunk)
       end
@@ -150,9 +153,12 @@ module Fluent
     def common_payload
       return @common_payload if @common_payload
       @common_payload = {}
-      @common_payload[:username]   = @username
+      @common_payload[:username]   = @username   if @username
       @common_payload[:icon_emoji] = @icon_emoji if @icon_emoji
       @common_payload[:icon_url]   = @icon_url   if @icon_url
+      @common_payload[:mrkdwn]     = @mrkdwn     if @mrkdwn
+      @common_payload[:link_names] = @link_names if @link_names
+      @common_payload[:parse]      = @parse      if @parse
       @common_payload[:token]      = @token      if @token
       @common_payload
     end
@@ -160,7 +166,8 @@ module Fluent
     def common_attachment
       return @common_attachment if @common_attachment
       @common_attachment = {}
-      @common_attachment[:mrkdwn_in]  = @mrkdwn_in  if @mrkdwn_in
+      @common_attachment[:color]     = @color     if @color
+      @common_attachment[:mrkdwn_in] = @mrkdwn_in if @mrkdwn_in
       @common_attachment
     end
 
@@ -179,7 +186,6 @@ module Fluent
         {
           channel: channel,
           attachments: [{
-            :color    => @color,
             :fallback => fields.values.map(&:title).join(' '), # fallback is the message shown on popup
             :fields   => fields.values.map(&:to_h)
           }.merge(common_attachment)],
@@ -187,7 +193,7 @@ module Fluent
       end
     end
 
-    def build_plain_payloads(chunk)
+    def build_color_payloads(chunk)
       messages = {}
       chunk.msgpack_each do |tag, time, record|
         channel = build_channel(record)
@@ -198,7 +204,6 @@ module Fluent
         {
           channel: channel,
           attachments: [{
-            :color    => @color,
             :fallback => text,
             :text     => text,
           }.merge(common_attachment)],
@@ -206,6 +211,21 @@ module Fluent
       end
     end
 
+    def build_plain_payloads(chunk)
+      messages = {}
+      chunk.msgpack_each do |tag, time, record|
+        channel = build_channel(record)
+        messages[channel] ||= ''
+        messages[channel] << "#{build_message(record)}\n"
+      end
+      messages.map do |channel, text|
+        {
+          channel: channel,
+          text:    text,
+        }.merge(common_payload)
+      end
+    end
+
     def build_message(record)
       values = fetch_keys(record, @message_keys)
       @message % values

data/lib/fluent/plugin/out_slack.rb

@@ -14,11 +14,13 @@ module Fluent
     config_param :webhook_url,          :string, default: nil # incoming webhook
     config_param :slackbot_url,         :string, default: nil # slackbot
     config_param :token,                :string, default: nil # api token
-    config_param :username,             :string, default: 'fluentd'
-    config_param :color,                :string, default: 'good'
+    config_param :username,             :string, default: nil
+    config_param :color,                :string, default: nil
     config_param :icon_emoji,           :string, default: nil
     config_param :icon_url,             :string, default: nil
-    config_param :mrkdwn,               :bool,   default: false
+    config_param :mrkdwn,               :bool,   default: true
+    config_param :link_names,           :bool,   default: true
+    config_param :parse,                :string, default: nil
     config_param :auto_channels_create, :bool,   default: false
     config_param :https_proxy,          :string, default: nil
 
@@ -56,25 +58,19 @@ module Fluent
         if @webhook_url.empty?
           raise Fluent::ConfigError.new("`webhook_url` is an empty string")
         end
-        # following default values are for old version compatibility
-        @title         ||= '%s'
-        @title_keys    ||= %w[tag]
-        @message       ||= '[%s] %s'
-        @message_keys  ||= %w[time message]
         @slack = Fluent::SlackClient::IncomingWebhook.new(@webhook_url)
       elsif @slackbot_url
         if @slackbot_url.empty?
           raise Fluent::ConfigError.new("`slackbot_url` is an empty string")
         end
-        @message      ||= '%s'
-        @message_keys ||= %w[message]
+        if @username or @color or @icon_emoji or @icon_url
+          log.warn "out_slack: `username`, `color`, `icon_emoji`, `icon_url` parameters are not available for Slackbot Remote Control"
+        end
         @slack = Fluent::SlackClient::Slackbot.new(@slackbot_url)
       elsif @token
         if @token.empty?
           raise Fluent::ConfigError.new("`token` is an empty string")
         end
-        @message      ||= '%s'
-        @message_keys ||= %w[message]
         @slack = Fluent::SlackClient::WebApi.new
       else
         raise Fluent::ConfigError.new("One of `webhook_url` or `slackbot_url`, or `token` is required")
@@ -86,6 +82,8 @@ module Fluent
         @slack.https_proxy = @https_proxy
       end
 
+      @message      ||= '%s'
+      @message_keys ||= %w[message]
       begin
         @message % (['1'] * @message_keys.length)
       rescue ArgumentError
@@ -109,13 +107,16 @@ module Fluent
       if @icon_emoji and @icon_url
         raise Fluent::ConfigError, "either of `icon_emoji` or `icon_url` can be specified"
       end
-      @icon_emoji ||= ':question:' unless @icon_url
 
       if @mrkdwn
         # Enable markdown for attachments. See https://api.slack.com/docs/formatting
         @mrkdwn_in = %w[text fields]
       end
 
+      if @parse and !%w[none full].include?(@parse)
+        raise Fluent::ConfigError, "`parse` must be either of `none` or `full`"
+      end
+
       @post_message_opts = @auto_channels_create ? {auto_channels_create: true} : {}
     end
 
@@ -142,6 +143,8 @@ module Fluent
     def build_payloads(chunk)
       if @title
         build_title_payloads(chunk)
+      elsif @color
+        build_color_payloads(chunk)
       else
         build_plain_payloads(chunk)
       end
@@ -150,9 +153,12 @@ module Fluent
     def common_payload
       return @common_payload if @common_payload
       @common_payload = {}
-      @common_payload[:username]   = @username
+      @common_payload[:username]   = @username   if @username
       @common_payload[:icon_emoji] = @icon_emoji if @icon_emoji
       @common_payload[:icon_url]   = @icon_url   if @icon_url
+      @common_payload[:mrkdwn]     = @mrkdwn     if @mrkdwn
+      @common_payload[:link_names] = @link_names if @link_names
+      @common_payload[:parse]      = @parse      if @parse
       @common_payload[:token]      = @token      if @token
       @common_payload
     end
@@ -160,7 +166,8 @@ module Fluent
     def common_attachment
       return @common_attachment if @common_attachment
       @common_attachment = {}
-      @common_attachment[:mrkdwn_in]  = @mrkdwn_in  if @mrkdwn_in
+      @common_attachment[:color]     = @color     if @color
+      @common_attachment[:mrkdwn_in] = @mrkdwn_in if @mrkdwn_in
       @common_attachment
     end
 
@@ -179,7 +186,6 @@ module Fluent
         {
           channel: channel,
           attachments: [{
-            :color    => @color,
             :fallback => fields.values.map(&:title).join(' '), # fallback is the message shown on popup
             :fields   => fields.values.map(&:to_h)
           }.merge(common_attachment)],
@@ -187,7 +193,7 @@ module Fluent
       end
     end
 
-    def build_plain_payloads(chunk)
+    def build_color_payloads(chunk)
       messages = {}
       chunk.msgpack_each do |tag, time, record|
         channel = build_channel(record)
@@ -198,7 +204,6 @@ module Fluent
         {
           channel: channel,
           attachments: [{
-            :color    => @color,
             :fallback => text,
             :text     => text,
           }.merge(common_attachment)],
@@ -206,6 +211,21 @@ module Fluent
       end
     end
 
+    def build_plain_payloads(chunk)
+      messages = {}
+      chunk.msgpack_each do |tag, time, record|
+        channel = build_channel(record)
+        messages[channel] ||= ''
+        messages[channel] << "#{build_message(record)}\n"
+      end
+      messages.map do |channel, text|
+        {
+          channel: channel,
+          text:    text,
+        }.merge(common_payload)
+      end
+    end
+
     def build_message(record)
       values = fetch_keys(record, @message_keys)
       @message % values

data/lib/fluent/plugin/slack_client.rb

@@ -151,8 +151,12 @@ module Fluent
       end
 
       def encode_body(params = {})
-        raise ArgumentError, 'params[:attachments] is required' unless params[:attachments]
-        attachment = Array(params[:attachments]).first # let me see only the first for now
+        return params[:text]if params[:text]
+        unless params[:attachments]
+          raise ArgumentError, 'params[:text] or params[:attachments] is required'
+        end
+        # handle params[:attachments]
+        attachment = Array(params[:attachments]).first # see only the first for now
         # {
         #   attachments: [{
         #     text: "HERE",
@@ -168,7 +172,7 @@ module Fluent
         #   }]
         # }
         if text.nil? and attachment[:fields]
-          text = Array(attachment[:fields]).first[:value] # let me see only the first for now
+          text = Array(attachment[:fields]).first[:value] # see only the first for now
         end
         text
       end

data/test/plugin/test_out_slack.rb

@@ -12,9 +12,23 @@ class SlackOutputTest < Test::Unit::TestCase
 
   CONFIG = %[
     channel channel
-    token   XXX-XXX-XXX
+    webhook_url https://hooks.slack.com/services/XXXX/XXXX/XXX
   ]
 
+  def default_payload
+    {
+      channel:    '#channel',
+      mrkdwn:     true,
+      link_names: true,
+    }
+  end
+
+  def default_attachment
+    {
+      mrkdwn_in: %w[text fields],
+    }
+  end
+
   def create_driver(conf = CONFIG)
     Fluent::Test::BufferedOutputTestDriver.new(Fluent::SlackOutput).configure(conf)
   end
@@ -23,12 +37,15 @@ class SlackOutputTest < Test::Unit::TestCase
   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
+    assert_equal true, d.instance.localtime
+    assert_equal nil,  d.instance.username   # 'fluentd'    break lower version compatibility
+    assert_equal nil,  d.instance.color      # 'good'       break lower version compatibility
+    assert_equal nil,  d.instance.icon_emoji # ':question:' break lower version compatibility
+    assert_equal nil,  d.instance.icon_url
+    assert_equal true, d.instance.mrkdwn
+    assert_equal true, d.instance.link_names
+    assert_equal nil,  d.instance.parse
 
-    # incoming webhook endpoint was changed. api_key option should be ignored
     assert_nothing_raised do
       create_driver(CONFIG + %[api_key testtoken])
     end
@@ -84,7 +101,9 @@ class SlackOutputTest < Test::Unit::TestCase
     assert_raise(Fluent::ConfigError) do
       create_driver(CONFIG + %[channel %s %s\nchannel_keys foo])
     end
+  end
 
+  def test_slack_configure
     # One of webhook_url or slackbot_url, or token is required
     assert_raise(Fluent::ConfigError) do
       create_driver(%[channel foo])
@@ -146,7 +165,7 @@ class SlackOutputTest < Test::Unit::TestCase
   def test_icon_configure
     # default
     d = create_driver(CONFIG)
-    assert_equal ':question:', d.instance.icon_emoji
+    assert_equal nil, d.instance.icon_emoji
     assert_equal nil, d.instance.icon_url
 
     # either of icon_emoji or icon_url can be specified
@@ -165,28 +184,66 @@ class SlackOutputTest < Test::Unit::TestCase
     assert_equal @icon_url, d.instance.icon_url
   end
 
-  def test_https_proxy_configure
+  def test_link_names_configure
     # default
     d = create_driver(CONFIG)
-    assert_equal nil, d.instance.slack.https_proxy
-    assert_equal Net::HTTP, d.instance.slack.proxy_class
+    assert_equal true, d.instance.link_names
 
-    # https_proxy
-    d = create_driver(CONFIG + %[https_proxy https://proxy.foo.bar:443])
-    assert_equal URI.parse('https://proxy.foo.bar:443'), d.instance.slack.https_proxy
-    assert_not_equal Net::HTTP, d.instance.slack.proxy_class # Net::HTTP.Proxy
+    # true
+    d = create_driver(CONFIG + %[link_names true])
+    assert_equal true, d.instance.link_names
+
+    # false
+    d = create_driver(CONFIG + %[link_names false])
+    assert_equal false, d.instance.link_names
+  end
+
+  def test_parse_configure
+    # default
+    d = create_driver(CONFIG)
+    assert_equal nil, d.instance.parse
+
+    # none
+    d = create_driver(CONFIG + %[parse none])
+    assert_equal 'none', d.instance.parse
+
+    # full
+    d = create_driver(CONFIG + %[parse full])
+    assert_equal 'full', d.instance.parse
+
+    # invalid
+    assert_raise(Fluent::ConfigError) do
+      d = create_driver(CONFIG + %[parse invalid])
+    end
   end
 
   def test_mrkwn_configure
     # default
     d = create_driver(CONFIG)
-    assert_equal false, d.instance.mrkdwn
-    assert_equal nil, d.instance.mrkdwn_in
+    assert_equal true, d.instance.mrkdwn
+    assert_equal %w[text fields], d.instance.mrkdwn_in
 
-    # mrkdwn
+    # true
     d = create_driver(CONFIG + %[mrkdwn true])
     assert_equal true, d.instance.mrkdwn
     assert_equal %w[text fields], d.instance.mrkdwn_in
+
+    # false
+    d = create_driver(CONFIG + %[mrkdwn false])
+    assert_equal false, d.instance.mrkdwn
+    assert_equal nil, d.instance.mrkdwn_in
+  end
+
+  def test_https_proxy_configure
+    # default
+    d = create_driver(CONFIG)
+    assert_equal nil, d.instance.slack.https_proxy
+    assert_equal Net::HTTP, d.instance.slack.proxy_class
+
+    # https_proxy
+    d = create_driver(CONFIG + %[https_proxy https://proxy.foo.bar:443])
+    assert_equal URI.parse('https://proxy.foo.bar:443'), d.instance.slack.https_proxy
+    assert_not_equal Net::HTTP, d.instance.slack.proxy_class # Net::HTTP.Proxy
   end
 
   def test_default_incoming_webhook
@@ -197,19 +254,9 @@ class SlackOutputTest < Test::Unit::TestCase
     assert_equal Fluent::SlackClient::IncomingWebhook, d.instance.slack.class
     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",
-        }],
-      }]
-    }, {})
+    mock(d.instance.slack).post_message(default_payload.merge({
+      text: "sowawa1\nsowawa2\n",
+    }), {})
     with_timezone('Asia/Tokyo') do
       d.emit({message: 'sowawa1'}, time)
       d.emit({message: 'sowawa2'}, time)
@@ -225,16 +272,9 @@ class SlackOutputTest < Test::Unit::TestCase
     assert_equal Fluent::SlackClient::Slackbot, d.instance.slack.class
     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: "sowawa1\nsowawa2\n",
-        text:     "sowawa1\nsowawa2\n",
-      }]
-    }, {})
+    mock(d.instance.slack).post_message(default_payload.merge({
+      text: "sowawa1\nsowawa2\n",
+    }), {})
     with_timezone('Asia/Tokyo') do
       d.emit({message: 'sowawa1'}, time)
       d.emit({message: 'sowawa2'}, time)
@@ -250,17 +290,69 @@ class SlackOutputTest < Test::Unit::TestCase
     assert_equal Fluent::SlackClient::WebApi, d.instance.slack.class
     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',
+    mock(d.instance.slack).post_message(default_payload.merge({
+      token: 'XX-XX-XX',
+      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_payload
+    title = "mytitle"
+    d = create_driver(CONFIG + %[title #{title}])
+    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(default_payload.merge({
+      attachments: [default_attachment.merge({
+        fallback: title,
+        fields:   [
+          {
+            title: title,
+            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_color_payload
+    color = 'good'
+    d = create_driver(CONFIG + %[color #{color}])
+    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(default_payload.merge({
+      attachments: [default_attachment.merge({
+        color:    color,
         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_plain_payload
+    d = create_driver(CONFIG)
+    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(default_payload.merge({
+      text: "sowawa1\nsowawa2\n",
+    }), {})
     with_timezone('Asia/Tokyo') do
       d.emit({message: 'sowawa1'}, time)
       d.emit({message: 'sowawa2'}, time)
@@ -269,26 +361,21 @@ class SlackOutputTest < Test::Unit::TestCase
   end
 
   def test_title_keys
-    d = create_driver(CONFIG + %[title %s\ntitle_keys tag])
+    d = create_driver(CONFIG + %[title [%s] %s\ntitle_keys time,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,
+    mock(d.instance.slack).post_message(default_payload.merge({
+      attachments: [default_attachment.merge({
+        fallback: "[07:00:00] #{d.tag}",
         fields:   [
           {
-            title: d.tag,
+            title: "[07:00:00] #{d.tag}",
             value: "sowawa1\nsowawa2\n",
           }
         ],
-      }]
-    }, {})
+      })]
+    }), {})
     with_timezone('Asia/Tokyo') do
       d.emit({message: 'sowawa1'}, time)
       d.emit({message: 'sowawa2'}, time)
@@ -297,20 +384,12 @@ class SlackOutputTest < Test::Unit::TestCase
   end
 
   def test_message_keys
-    d = create_driver(CONFIG + %[message %s %s\nmessage_keys tag,message])
+    d = create_driver(CONFIG + %[message [%s] %s %s\nmessage_keys time,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",
-      }]
-    }, {})
+    mock(d.instance.slack).post_message(default_payload.merge({
+      text: "[07:00:00] test sowawa1\n[07:00:00] test sowawa2\n",
+    }), {})
     with_timezone('Asia/Tokyo') do
       d.emit({message: 'sowawa1'}, time)
       d.emit({message: 'sowawa2'}, time)
@@ -322,28 +401,14 @@ class SlackOutputTest < Test::Unit::TestCase
     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",
-      }]
-    }, {})
+    mock(d.instance.slack).post_message(default_payload.merge({
+      channel: '#channel1',
+      text:    "sowawa1\n",
+    }), {})
+    mock(d.instance.slack).post_message(default_payload.merge({
+      channel: '#channel2',
+      text:    "sowawa2\n",
+    }), {})
     with_timezone('Asia/Tokyo') do
       d.emit({message: 'sowawa1', channel: 'channel1'}, time)
       d.emit({message: 'sowawa2', channel: 'channel2'}, time)
@@ -355,17 +420,10 @@ class SlackOutputTest < Test::Unit::TestCase
     d = create_driver(CONFIG + %[icon_emoji :ghost:])
     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:  ':ghost:',
-      attachments: [{
-        color:    'good',
-        fallback: "foo\n",
-        text:     "foo\n",
-      }]
-    }, {})
+    mock(d.instance.slack).post_message(default_payload.merge({
+      icon_emoji: ':ghost:',
+      text:       "foo\n",
+    }), {})
     with_timezone('Asia/Tokyo') do
       d.emit({message: 'foo'}, time)
       d.run
@@ -376,17 +434,10 @@ class SlackOutputTest < Test::Unit::TestCase
     d = create_driver(CONFIG + %[icon_url #{@icon_url}])
     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_url:    @icon_url,
-      attachments: [{
-        color:    'good',
-        fallback: "foo\n",
-        text:     "foo\n",
-      }]
-    }, {})
+    mock(d.instance.slack).post_message(default_payload.merge({
+      icon_url: @icon_url,
+      text:     "foo\n",
+    }), {})
     with_timezone('Asia/Tokyo') do
       d.emit({message: 'foo'}, time)
       d.run
@@ -397,18 +448,56 @@ class SlackOutputTest < Test::Unit::TestCase
     d = create_driver(CONFIG + %[mrkdwn true])
     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',
+    mock(d.instance.slack).post_message(default_payload.merge({
+      mrkdwn: true,
+      text:   "foo\n",
+    }), {})
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'foo'}, time)
+      d.run
+    end
+  end
+
+  def test_mrkdwn_in
+    d = create_driver(CONFIG + %[mrkdwn true\ncolor good])
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    mock(d.instance.slack).post_message(default_payload.merge({
+      attachments: [default_attachment.merge({
+        color:    "good",
         fallback: "foo\n",
         text:     "foo\n",
         mrkdwn_in: ["text", "fields"],
-      }]
-    }, {})
+      })]
+    }), {})
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'foo'}, time)
+      d.run
+    end
+  end
+
+  def test_link_names
+    d = create_driver(CONFIG + %[link_names true])
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    mock(d.instance.slack).post_message(default_payload.merge({
+      link_names: true,
+      text:       "foo\n",
+    }), {})
+    with_timezone('Asia/Tokyo') do
+      d.emit({message: 'foo'}, time)
+      d.run
+    end
+  end
+
+  def test_parse
+    d = create_driver(CONFIG + %[parse full])
+    time = Time.parse("2014-01-01 22:00:00 UTC").to_i
+    d.tag  = 'test'
+    mock(d.instance.slack).post_message(default_payload.merge({
+      parse: "full",
+      text:  "foo\n",
+    }), {})
     with_timezone('Asia/Tokyo') do
       d.emit({message: 'foo'}, time)
       d.run

data/test/plugin/test_slack_client.rb

@@ -10,10 +10,11 @@ require 'webrick/httpproxy'
 # Create .env file with contents as:
 #
 #     WEBHOOK_URL=https://hooks.slack.com/services/XXXX/YYYY/ZZZZ
-#     TOKEN=XXXXX
+#     SLACKBOt_URL=https://xxxx.slack.com/services/hooks/slackbot?token=XXXX
+#     SLACK_API_TOKEN=XXXXX
 #
 Dotenv.load
-if ENV['WEBHOOK_URL'] and ENV['SLACKBOT_URL'] and ENV['TOKEN']
+if ENV['WEBHOOK_URL'] and ENV['SLACKBOT_URL'] and ENV['SLACK_API_TOKEN']
 
   class TestProxyServer
     def initialize
@@ -47,152 +48,148 @@ if ENV['WEBHOOK_URL'] and ENV['SLACKBOT_URL'] and ENV['TOKEN']
   end
 
   class SlackClientTest < Test::Unit::TestCase
+    class << self
+      attr_reader :proxy
+
+      def startup
+        @proxy = TestProxyServer.new.tap {|proxy| proxy.start }
+      end
+
+      def shutdown
+        @proxy.shutdown
+      end
+    end
+
     def setup
       super
       @incoming       = Fluent::SlackClient::IncomingWebhook.new(ENV['WEBHOOK_URL'])
       @slackbot       = Fluent::SlackClient::Slackbot.new(ENV['SLACKBOT_URL'])
       @api            = Fluent::SlackClient::WebApi.new
 
-      @proxy          = TestProxyServer.new.tap {|proxy| proxy.start }
-      @incoming_proxy = Fluent::SlackClient::IncomingWebhook.new(ENV['WEBHOOK_URL'], @proxy.proxy_url)
-      @slackbot_proxy = Fluent::SlackClient::Slackbot.new(ENV['SLACKBOT_URL'], @proxy.proxy_url)
-      @api_proxy      = Fluent::SlackClient::WebApi.new(nil, @proxy.proxy_url)
+      proxy_url       = self.class.proxy.proxy_url
+      @incoming_proxy = Fluent::SlackClient::IncomingWebhook.new(ENV['WEBHOOK_URL'], proxy_url)
+      @slackbot_proxy = Fluent::SlackClient::Slackbot.new(ENV['SLACKBOT_URL'], proxy_url)
+      @api_proxy      = Fluent::SlackClient::WebApi.new(nil, proxy_url)
 
       @icon_url = 'http://www.google.com/s2/favicons?domain=www.google.de'
     end
 
-    def teardown
-      @proxy.shutdown
+    def token(client)
+      client.is_a?(Fluent::SlackClient::IncomingWebhook) ? {} : {token: ENV['SLACK_API_TOKEN']}
     end
 
-    def token(client)
-      client.is_a?(Fluent::SlackClient::IncomingWebhook) ? {} : {token: ENV['TOKEN']}
+    def default_payload(client)
+      {
+        channel:   '#general',
+        mrkdwn:     true,
+        link_names: true,
+      }.merge!(token(client))
     end
 
-    def test_post_message_text
+    def default_attachment
+      {
+        mrkdwn_in: %w[text fields]
+      }
+    end
+
+    # Notification via Mention works for all three with plain text payload
+    def test_post_message_plain_payload_mention
       [@incoming, @slackbot, @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))
-          )
+          slack.post_message(default_payload(slack).merge({
+            text: "#general @everyone\n",
+          }))
         end
       end
     end
 
-    def test_post_message_fields
+    # Notification via Highlight Words works with only Slackbot with plain text payload
+    # NOTE: Please add `sowawa1` to Highlight Words
+    def test_post_message_plain_payload_highlight_words
       [@incoming, @slackbot, @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))
-          )
+          slack.post_message(default_payload(slack).merge({
+            text: "sowawa1\n",
+          }))
         end
       end
     end
 
-    def test_post_via_proxy
-      [@incoming_proxy, @slackbot_proxy, @api_proxy].each do |slack|
+    # Notification via Mention does not work for attachments
+    def test_post_message_color_payload
+      [@incoming, @slackbot, @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))
-          )
+          slack.post_message(default_payload(slack).merge({
+            attachments: [default_attachment.merge({
+              color:    'good',
+              fallback: "sowawa1\n@everyone\n",
+              text:     "sowawa1\n@everyone\n",
+            })]
+          }))
         end
       end
     end
 
-    def test_post_message_icon_url
-      [@incoming, @api].each do |slack|
+    # Notification via Mention does not work for attachments
+    def test_post_message_fields_payload
+      [@incoming, @slackbot, @api].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(default_payload(slack).merge({
+            attachments: [default_attachment.merge({
+              color:    'good',
+              fallback: 'test1 test2',
+              fields:   [
+                {
+                  title: 'test1',
+                  value: "[07:00:00] sowawa1\n[07:00:00] @everyone\n",
+                },
+                {
+                  title: 'test2',
+                  value: "[07:00:00] sowawa1\n[07:00:00] @everyone\n",
+                },
+              ],
+            })]
+          }))
+        end
+      end
+    end
+
+    def test_post_via_proxy
+      [@incoming_proxy, @slackbot_proxy, @api_proxy].each do |slack|
         assert_nothing_raised do
-          slack.post_message(
-            {
-              channel:     '#general',
-              username:    'fluentd',
-              icon_url:    @icon_url,
-              attachments: [{
-                color:    'good',
-                fallback: "sowawa1\nsowawa2\n",
-                text:     "sowawa1\nsowawa2\n",
-              }]
-            }.merge(token(slack))
-          )
+          slack.post_message(default_payload(slack).merge({
+            attachments: [default_attachment.merge({
+              color:    'good',
+              fallback: "sowawa1\n@everyone\n",
+              text:     "sowawa1\n@everyone\n",
+            })]
+          }))
         end
       end
     end
 
-    def test_post_message_text_mrkdwn
+    def test_post_message_username
       [@incoming, @api].each do |slack|
         assert_nothing_raised do
-          slack.post_message(
-            {
-              channel:     '#general',
-              username:    'fluentd',
-              attachments: [{
-                color:    'good',
-                fallback: "plain *bold* _italic_ `preformat`\n", # mrkdwn not work
-                text:     "plain *bold* _italic_ `preformat`\n",
-                mrkdwn_in: ['text', 'fields'],
-              }]
-            }.merge(token(slack))
-          )
+          slack.post_message(default_payload(slack).merge({
+            username: 'fluentd',
+            text:     "#general @everyone\n",
+          }))
         end
       end
     end
 
-    def test_post_message_fields_mrkdwn
+    def test_post_message_icon_url
       [@incoming, @api].each do |slack|
         assert_nothing_raised do
-          slack.post_message(
-            {
-              channel:     '#general',
-              username:    'fluentd',
-              attachments: [{
-                color:    'good',
-                fallback: "plain *bold* _italic_ `preformat`\n", # mrkdwn not work
-                fields:   [
-                  {
-                    title: 'plain *bold* _italic* `preformat`', # mrkdwn not work
-                    value: "plain *bold* _italic* `preformat`\n",
-                  },
-                ],
-                mrkdwn_in: ['text', 'fields'],
-              }]
-            }.merge(token(slack))
-          )
+          slack.post_message(default_payload(slack).merge({
+            icon_url:    @icon_url,
+            attachments: [default_attachment.merge({
+              color:    'good',
+              fallback: "sowawa1\n@everyone\n",
+              text:     "sowawa1\n@everyone\n",
+            })]
+          }))
         end
       end
     end
@@ -201,11 +198,9 @@ if ENV['WEBHOOK_URL'] and ENV['SLACKBOT_URL'] and ENV['TOKEN']
     # but slack does not provide channels.delete API
     def test_channels_create
       begin
-        @api.channels_create(
-          {
-            name: '#test_channels_create',
-          }.merge(token(@api))
-        )
+        @api.channels_create(token(@api).merge({
+          name: '#test_channels_create',
+        }))
       rescue Fluent::SlackClient::NameTakenError
       end
     end
@@ -214,17 +209,11 @@ if ENV['WEBHOOK_URL'] and ENV['SLACKBOT_URL'] and ENV['TOKEN']
     # but slack does not provide channels.delete API
     def test_auto_channels_create
       assert_nothing_raised do
-        @api.post_message(
+        @api.post_message(default_payload(@api).merge(
           {
-            channel:     '#test_auto_api',
-            username:    'fluentd',
-            icon_emoji:  ':question:',
-            attachments: [{
-              color:    'good',
-              fallback: "bar\n",
-              text:     "bar\n",
-            }]
-          }.merge(token(@api)),
+            channel:  '#test_auto_api',
+            text:     "bar\n",
+          }),
           {
             auto_channels_create: true,
           }
@@ -232,17 +221,11 @@ if ENV['WEBHOOK_URL'] and ENV['SLACKBOT_URL'] and ENV['TOKEN']
       end
 
       assert_nothing_raised do
-        @slackbot.post_message(
+        @slackbot.post_message(default_payload(@slackbot).merge(
           {
-            channel:     '#test_auto_slackbot',
-            username:    'fluentd',
-            icon_emoji:  ':question:',
-            attachments: [{
-              color:    'good',
-              fallback: "bar\n",
-              text:     "bar\n",
-            }]
-          }.merge(token(@api)),
+            channel:  '#test_auto_slackbot',
+            text:     "bar\n",
+          }),
           {
             auto_channels_create: true,
           }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-slack
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Keisuke SOGAWA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd