fluent-plugin-redmine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a74312227f9285179b5f863968c01f87b2a838f3
+  data.tar.gz: 8ebda1d917fe773ad253643a1cbe10a5dc8cf269
+SHA512:
+  metadata.gz: 9399d0e446fbb7a11e3ec429230a7e02a946fae7334658e66567c45855b2d87a8edc37a2a3c7a9852b0238be87ca15358c1c7585617645c89509bd8e55174484
+  data.tar.gz: 9e51506a72aa1ff0b2cbc6505abf30d414a32c6e15e2cbb693c57701245e4a0f482689ad75bf5b5a6a7c53673658ea39eb5cd6fe51943a0a789cc2c219f67cf7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-redmine.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2012- Takuma Kanari
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,48 @@
+# fluent-plugin-redmine
+
+## Overview
+
+Output fplugin for [Fluentd](http://fluentd.org). Create and regist a ticket to redmine from messages.
+
+## Installation
+
+Install with `gem`, `fluent-gem` or `td-agent-gem` command as:
+
+```
+# for system installed fluentd
+$ gem install fluent-plugin-redmine
+
+# for td-agent
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-redmine
+
+# for td-agent2
+$ sudo td-agent-gem install fluent-plugin-redmine
+```
+
+## Usage
+
+In your fluentd configration, use type redmine. 
+
+Here is example settings:
+
+    type redmine
+    url http://localhost:3000/
+    api_key 40a96d43a98b1626c542b04c5780f881c1e1a969
+    project_id apitest
+    tracker_id 1
+    priority_id 3
+    subject The new issue %{issue}
+    description This is the new issue called %{name}. we cought new exception %{error}!
+
+
+and here is optional configuration:
+
+    tag_key my_tag # 'tag' is used by default
+
+### placeholders
+
+You can look values in records by using `%{hoge}` for subject and description. If you specify *tag_key* in configuration, you can also look tag value by `%{your_specified_tag_key}`.
+
+## TODO
+
+Pull requests are very welcome!!

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-redmine.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-redmine"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Takuma kanari"]
+  spec.email         = ["chemtrails.t@gmail.com"]
+  spec.summary       = %q{Output filter plugin to create ticket in redmine}
+  spec.description   = %q{Output filter plugin to create ticket in redmine}
+  spec.homepage      = "https://github.com/takumakanari"
+  spec.rubyforge_project = "fluent-plugin-redmine"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "fluentd"
+end

data/lib/fluent/plugin/out_redmine.rb

@@ -0,0 +1,127 @@
+module Fluent
+
+  class RedmineOutput < Output
+    Fluent::Plugin.register_output('redmine', self)
+
+    # Define `log` method for v0.10.42 or earlier
+    unless method_defined?(:log)
+      define_method("log") { $log }
+    end
+
+    config_param :url, :string, :default => nil
+    config_param :api_key, :string, :default => nil
+    config_param :tag_key, :string, :default => "tag"
+    config_param :project_id, :string, :default => nil
+    config_param :tracker_id, :integer
+    config_param :priority_id, :integer
+    config_param :subject, :string, :default => "Fluent::RedmineOutput plugin"
+    config_param :description, :string, :default => ""
+
+    def initialize
+      super
+      require "json"
+      require "net/http"
+    end
+    
+    def configure(conf)
+      super
+
+      if @url.nil?
+        raise Fluent::ConfigError, "'url' must be specified."
+      end
+
+      if @api_key.nil?
+        raise Fluent::ConfigError, "'api_key' must be specified."
+      end
+
+      @subject_expander = TemplateExpander.new(@subject)
+      @description_expander = TemplateExpander.new(@description)
+      @redmine_uri = URI.parse("#{@url}/issues.json")
+
+      @redmine_request_header = {
+        "Content-Type" => "application/json",
+        "X-Redmine-API-Key" => @api_key
+      }
+    end
+
+    def emit(tag, es, chain)
+      bulk = []
+      es.each do |time,record|
+        bulk << [
+          @subject_expander.bind(make_record(tag, record)),
+          @description_expander.bind(make_record(tag, record))
+        ]
+      end
+      bulk.each do |subject, desc|
+        begin
+          submit_ticket(subject, desc)
+        rescue => e
+          log.warn "out_redmine: failed to create ticket to #{@redmine_uri}, subject: #{subject}, description: #{desc}, error_class: #{e.class}, error_message: #{e.message}, error_backtrace: #{e.backtrace.first}"
+        end
+      end
+      chain.next
+    end
+
+    def submit_ticket(subject, desc)
+      request = Net::HTTP::Post.new(
+        @redmine_uri.request_uri,
+        initheader = @redmine_request_header
+      )
+      request.body = JSON.generate(make_payload(subject, desc))
+      Net::HTTP.new(@redmine_uri.host, @redmine_uri.port).start do |http|
+        res = http.request(request)
+        unless res.code.to_i == 201
+          raise Exception.new("Error: #{res.code}, #{res.body}")
+        end
+        return res.body
+      end
+    end
+
+    def make_payload(subject, desc)
+      {
+        :issue => {
+          :project_id => @project_id,
+          :tracker_id => @tracker_id,
+          :priority_id => @priority_id,
+          :subject => subject,
+          :description => desc
+        }
+      }
+    end
+
+    private
+
+    def make_record(tag, record)
+      dest = Hash.new
+      dest[:"#{@tag_key}"] = tag
+      record.map do |key, value|
+        dest[:"#{key}"] = value
+      end
+      dest
+    end
+
+    class TemplateExpander
+      attr_reader :template, :placeholders
+
+      Empty = ''
+
+      def initialize(template)
+        @template = template
+        @placeholders = Array.new
+        @template.gsub(/%{([^}]+)}/) do
+          @placeholders << $1 unless @placeholders.include?($1)
+        end
+      end
+
+      def bind(values)
+        @placeholders.each do |key|
+          key_ = :"#{key}"
+          values[key_] = Empty unless values.key?(key_)
+        end
+        @template % values
+      end
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+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'
+
+$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
+
+require 'fluent/plugin/out_redmine'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_redmine.rb

@@ -0,0 +1,174 @@
+require "helper"
+require "webrick"
+require "thread"
+require "net/http"
+require "uri"
+require "fluent/plugin/out_redmine"
+
+
+class RedmineOutputTest < Test::Unit::TestCase
+
+  CONFIG_DEFAULT = %[
+    type redmine
+    url http://localhost:4000
+    api_key test-api-key
+    tag_key test
+    project_id 1
+    tracker_id 2
+    priority_id 3
+    subject awesome
+    description this is description %{d1} - %{d2} - %{d3}
+  ]
+
+  CONFIG_TO_FORMAT = %[
+    type redmine
+    url http://localhost:4000
+    api_key test-api-key
+    project_id 1
+    tracker_id 2
+    priority_id 3
+    subject %{tag}: awesome %{name}, %{age}, %{message}, unknown:%{unknown}
+    description %{tag}: this is description %{name}, %{age}, %{message}, unknown:%{unknown}
+  ]
+
+  def setup
+    Fluent::Test.setup
+    boot_dummy_redmine_server
+  end
+
+  def boot_dummy_redmine_server
+    @tickets = []
+    @dummy_redmine = Thread.new do
+      s = WEBrick::HTTPServer.new({
+        :BindAddress => "127.0.0.1",
+        :Port => 4000,
+        :DoNotReverseLookup => true
+      })
+      begin
+        s.mount_proc("/") do |req, res|
+          unless req.request_method == "POST"
+            res.status = 405
+            res.body = "request method mismatch"
+            next
+          end
+          if req.path == "/"
+            res.status = 200
+          elsif req.path == "/issues.json"
+            @tickets << JSON.parse(req.body)
+            res.status = 201
+          else
+            res.status = 404
+            next
+          end
+          res.body = "OK"
+        end
+        s.start
+      ensure
+        s.shutdown
+      end
+    end
+
+    cv = ConditionVariable.new
+
+    watcher = Thread.new {
+      connected = false
+      while not connected
+        begin
+          client = Net::HTTP.start("localhost", 4000)
+          connected = client.request_post("/", "").code.to_i == 200
+          puts connected
+        rescue Errno::ECONNREFUSED
+          sleep 0.1
+        rescue StandardError => e
+          p e
+          sleep 0.1
+        end
+      end
+      cv.signal
+    }
+    mutex = Mutex.new
+    mutex.synchronize {
+      cv.wait(mutex)
+    }
+  end
+
+  def teardown
+    @dummy_redmine.kill
+    @dummy_redmine.join
+  end
+
+  def create_driver(conf=CONFIG_OUT_KEYS,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::RedmineOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    p = nil
+    assert_nothing_raised { p = create_driver(CONFIG_DEFAULT).instance }
+    assert_equal "http://localhost:4000", p.url
+    assert_equal "test", p.tag_key
+    assert_equal "1", p.project_id
+    assert_equal 2, p.tracker_id
+    assert_equal 3, p.priority_id
+    assert_equal "awesome", p.subject
+    assert_equal "this is description %{d1} - %{d2} - %{d3}", p.description
+  end
+
+  def test_configure_fail_by_url
+    assert_raise(Fluent::ConfigError){ create_driver(<<CONFIG) }
+  type redmine
+  api_key test-api-key
+  project_id 1
+  tracker_id 2
+  priority_id 3
+  subject awesome
+  description this is description
+CONFIG
+  end
+
+  def test_configure_fail_by_api_key
+    assert_raise(Fluent::ConfigError){ create_driver(<<CONFIG) }
+  type redmine
+  url http://localhost:4000
+  project_id 1
+  tracker_id 2
+  priority_id 3
+  subject awesome
+  description this is description
+CONFIG
+  end
+
+  def test_make_payload
+    p = create_driver(CONFIG_DEFAULT).instance
+    ret = p.make_payload("subject", "description")
+    assert_equal "subject", ret[:issue][:subject]
+    assert_equal "description", ret[:issue][:description]
+    assert_equal p.project_id, ret[:issue][:project_id]
+    assert_equal p.tracker_id, ret[:issue][:tracker_id]
+    assert_equal p.priority_id, ret[:issue][:priority_id]
+  end
+
+  def test_emit
+    d = create_driver(CONFIG_TO_FORMAT)
+    record = {
+      "name" => "John",
+      "age" => 25,
+      "message" => "this is message!"
+    }
+    t = Time.now
+    d.run do
+      d.emit(record, t.to_i)
+    end
+
+    assert_equal @tickets.size, 1
+
+    issue = @tickets.first["issue"]
+
+    assert_equal "1", issue["project_id"]
+    assert_equal 2, issue["tracker_id"]
+    assert_equal 3, issue["priority_id"]
+    assert_equal "test: awesome John, 25, this is message!, unknown:", issue["subject"]
+    assert_equal "test: this is description John, 25, this is message!, unknown:", issue["description"]
+  end
+
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-redmine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takuma kanari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: fluentd
+  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: Output filter plugin to create ticket in redmine
+email:
+- chemtrails.t@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-redmine.gemspec
+- lib/fluent/plugin/out_redmine.rb
+- test/helper.rb
+- test/plugin/test_out_redmine.rb
+homepage: https://github.com/takumakanari
+licenses: []
+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: fluent-plugin-redmine
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Output filter plugin to create ticket in redmine
+test_files:
+- test/helper.rb
+- test/plugin/test_out_redmine.rb