fluent-plugin-slack-stakater 0.6.8

data/test/plugin/test_slack_client.rb

@@ -0,0 +1,282 @@
+require_relative '../test_helper'
+require 'fluent/plugin/slack_client'
+require 'time'
+require 'dotenv'
+require 'webrick'
+require 'webrick/httpproxy'
+
+# HOW TO RUN
+#
+# Create .env file with contents as:
+#
+#     WEBHOOK_URL=https://hooks.slack.com/services/XXXX/YYYY/ZZZZ
+#     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['SLACK_API_TOKEN']
+
+  class TestProxyServer
+    def initialize
+      @proxy = WEBrick::HTTPProxyServer.new(
+        :BindAddress => '127.0.0.1',
+        :Port => unused_port,
+      )
+    end
+
+    def proxy_url
+      "https://127.0.0.1:#{unused_port}"
+    end
+
+    def start
+      @thread = Thread.new do
+        @proxy.start
+      end
+    end
+
+    def shutdown
+      @proxy.shutdown
+    end
+
+    def unused_port
+      return @unused_port if @unused_port
+      s = TCPServer.open(0)
+      port = s.addr[1]
+      s.close
+      @unused_port = port
+    end
+  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_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 token(client)
+      client.is_a?(Fluent::SlackClient::IncomingWebhook) ? {} : {token: ENV['SLACK_API_TOKEN']}
+    end
+
+    def default_payload(client)
+      {
+        channel:   '#general',
+        mrkdwn:     true,
+        link_names: true,
+      }.merge!(token(client))
+    end
+
+    def default_attachment
+      {
+        mrkdwn_in: %w[text fields]
+      }
+    end
+
+    def valid_utf8_encoded_string
+      "#general \xE3\x82\xA4\xE3\x83\xB3\xE3\x82\xB9\xE3\x83\x88\xE3\x83\xBC\xE3\x83\xAB\n"
+    end
+
+    def invalid_ascii8bit_encoded_utf8_string
+      str = "#general \xE3\x82\xA4\xE3\x83\xB3\xE3\x82\xB9\xE3\x83\x88\xE3\x83\xBC\xE3\x83\xAB\x81\n"
+      str.force_encoding(Encoding::ASCII_8BIT)
+    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(default_payload(slack).merge({
+            text: "#general @everyone\n",
+          }))
+        end
+      end
+    end
+
+    # 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(default_payload(slack).merge({
+            text: "sowawa1\n",
+          }))
+        end
+      end
+    end
+
+    # 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(default_payload(slack).merge({
+            attachments: [default_attachment.merge({
+              color:    'good',
+              fallback: "sowawa1\n@everyone\n",
+              text:     "sowawa1\n@everyone\n",
+            })]
+          }))
+        end
+      end
+    end
+
+    # 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(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_username
+      [@incoming, @api].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(default_payload(slack).merge({
+            username: 'fluentd',
+            text:     "#general @everyone\n",
+          }))
+        end
+      end
+    end
+
+    def test_post_message_icon_url
+      [@incoming, @api].each do |slack|
+        assert_nothing_raised do
+          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
+
+    # Hmm, I need to delete channels to test repeatedly,
+    # but slack does not provide channels.delete API
+    def test_channels_create
+      begin
+        @api.channels_create(token(@api).merge({
+          name: '#test_channels_create',
+        }))
+      rescue Fluent::SlackClient::NameTakenError
+      end
+    end
+
+    # Hmm, I need to delete channels to test repeatedly,
+    # but slack does not provide channels.delete API
+    def test_auto_channels_create
+      assert_nothing_raised do
+        @api.post_message(default_payload(@api).merge(
+          {
+            channel:  '#test_auto_api',
+            text:     "bar\n",
+          }),
+          {
+            auto_channels_create: true,
+          }
+        )
+      end
+
+      assert_nothing_raised do
+        @slackbot.post_message(default_payload(@slackbot).merge(
+          {
+            channel:  '#test_auto_slackbot',
+            text:     "bar\n",
+          }),
+          {
+            auto_channels_create: true,
+          }
+        )
+      end
+    end
+
+    # IncomingWebhook posts "#general インストール"
+    def test_post_message_utf8_encoded_text
+      [@incoming].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(default_payload(slack).merge({
+            text: valid_utf8_encoded_string,
+          }))
+        end
+      end
+    end
+
+    # IncomingWebhook posts "#general インストール?"
+    def test_post_message_ascii8bit_encoded_utf8_text
+      [@incoming].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(default_payload(slack).merge({
+            text: invalid_ascii8bit_encoded_utf8_string,
+          }))
+        end
+      end
+    end
+
+    # IncomingWebhook and API posts "#general インストール?"
+    def test_post_message_ascii8bit_encoded_utf8_attachments
+      [@incoming, @api].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(default_payload(slack).merge({
+            attachments: [default_attachment.merge({
+              color:    'good',
+              fallback: invalid_ascii8bit_encoded_utf8_string,
+              text:     invalid_ascii8bit_encoded_utf8_string,
+            })]
+          }))
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'test/unit/rr'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+def with_timezone(tz)
+  oldtz, ENV['TZ'] = ENV['TZ'], tz
+  yield
+ensure
+  ENV['TZ'] = oldtz
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-slack-stakater
+version: !ruby/object:Gem::Version
+  version: 0.6.8
+platform: ruby
+authors:
+- Keisuke SOGAWA
+- Naotoshi Seo
+- stakater
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: fluent Slack plugin
+email:
+- hello@stakater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.fluentd.0.12
+- README.md
+- Rakefile
+- VERSION
+- example.conf
+- fluent-plugin-slack.gemspec
+- lib/fluent/plugin/out_buffered_slack.rb
+- lib/fluent/plugin/out_slack.rb
+- lib/fluent/plugin/slack_client.rb
+- lib/fluent/plugin/slack_client/error.rb
+- test.sh
+- test/plugin/test_out_slack.rb
+- test/plugin/test_slack_client.rb
+- test/test_helper.rb
+homepage: https://github.com/stakater/fluent-plugin-slack
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: fluent Slack plugin
+test_files: []