test-jq 0.5.1

data/test/plugin/test_formatter_jq.rb

@@ -0,0 +1,57 @@
+require "helper"
+require "fluent/test/driver/formatter"
+require "fluent/plugin/formatter_jq"
+
+class JqFormatterTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  teardown do
+    @driver.instance.shutdown if @driver
+  end
+
+  test "it should require jq parameter" do
+    assert_raise(Fluent::ConfigError) { create_driver '' }
+  end
+
+  test "it should raise error on invalid jq parameter" do
+    e = assert_raise(Fluent::ConfigError) { create_driver 'jq blah' }
+    assert_match(/compile error/, e.message)
+  end
+
+  test "it should work" do
+    d = create_driver 'jq .log'
+    record = {"log" => "this is a log", "source" => "stdout"}
+    text = d.instance.format("some.tag", event_time, record)
+    assert_equal record["log"], text
+  end
+
+  test "it should ignore error by default" do
+    d = create_driver 'jq .[1]'
+    record = {"log" => "some message"}
+    text = d.instance.format "some.tag", event_time, record
+    assert_equal record.to_json, text
+  end
+
+  test "it can skip on error" do
+    d = create_driver "jq .[1]\non_error skip"
+    record = {"log" => "some message"}
+    text = d.instance.format "some.tag", event_time, record
+    assert_equal '', text
+  end
+
+  test "it can raise error on error" do
+    d = create_driver "jq .[1]\non_error raise_error"
+    record = {"log" => "some message"}
+    assert_raise(RuntimeError) {
+      d.instance.format "some.tag", event_time, record
+    }
+  end
+
+  private
+
+  def create_driver(conf)
+    @driver = Fluent::Test::Driver::Formatter.new(Fluent::Plugin::JqFormatter).configure(conf).tap { |d| d.instance.start }
+  end
+end

data/test/plugin/test_out_jq.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "helper"
+require "fluent/test/driver/output"
+require "fluent/plugin/out_jq"
+
+class JqOutputTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  test "it should require jq" do
+    assert_raise(Fluent::ConfigError) { create_driver '' }
+  end
+
+  test "it should raise error on invalid jq program" do
+    e = assert_raise(Fluent::ConfigError) { create_driver 'jq blah' }
+    assert_match(/compile error/, e.message)
+  end
+
+  test "it should work on tag" do
+    events = create_driver('jq "{tag}"').events
+    assert_equal events.size, 1
+    assert_equal events[0][2]["tag"], "some.tag"
+  end
+
+  test "it should work on time" do
+    events = create_driver('jq "{time: .time | gmtime }"').events
+    assert_equal events.size, 1
+    assert_equal events[0][2]["time"][0..5], [2018, 2, 22, 1, 23, 45]
+  end
+
+  test "it should support array" do
+    events = create_driver('jq ".record | to_entries"').events.map { |evt| evt[2] }
+    assert_equal events.size, 2
+    assert_include events, {"key" => "log", "value" => "this is a log"}
+    assert_include events, {"key" => "source", "value" => "stdout"}
+  end
+
+  test "it should remove specified tag prefix" do
+    events = create_driver(<<~CONF).events
+      jq ".record"
+      remove_tag_prefix some
+    CONF
+
+    assert_equal events.size, 1
+    assert_equal events[0][0], "tag"
+  end
+
+  private
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::JqOutput).configure(conf).tap { |d|
+      time = event_time("2018-03-22 01:23:45 UTC")
+      d.run { d.feed "some.tag", time, {"log" => "this is a log", "source" => "stdout"} }
+    }
+  end
+end

data/test/plugin/test_parser_jq.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "helper"
+require "fluent/test/driver/parser"
+require "fluent/plugin/parser_jq"
+
+class JqParserTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  teardown do
+    @driver.instance.shutdown if @driver
+  end
+
+  test "it should require jq" do
+    assert_raise(Fluent::ConfigError) { create_driver '' }
+  end
+
+  test "it should raise error on invalid jq program" do
+    e = assert_raise(Fluent::ConfigError) { create_driver 'jq blah' }
+    assert_match(/compile error/, e.message)
+  end
+
+  test "it should work" do
+    d = create_driver 'jq split(",") | reduce .[] as $item ({}; ($item | split(":")) as $pair | .[$pair[0]] = $pair[1])'
+    text = "name:jq,type:parser,author:Gimi"
+    expected_record = {"name" => "jq", "type" => "parser", "author" => "Gimi"}
+    d.instance.parse(text) { |time, record|
+      assert_equal expected_record, record
+    }
+    assert_nil d.instance.log.logs.find { |log| log =~ /\[error\]/ }
+  end
+
+  test "it should skip if it does not return a hash" do
+    d = create_driver 'jq split(",")'
+    text = "name:jq,type:parser,author:Gimi"
+    expected_record = {"name": "jq", "type": "parser", "author": "Gimi"}
+    d.instance.parse(text) { |time, record| assert false }
+    assert d.instance.log.logs.any? { |log| log =~ /\[error\]/ }
+  end
+
+  private
+
+  def create_driver(conf)
+    @driver = Fluent::Test::Driver::Parser.new(Fluent::Plugin::JqParser).configure(conf).tap { |d| d.instance.start }
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: test-jq
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Rock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+description: fluent-plungin-jq is a collection of fluentd plugins which uses the jq
+  engine to transform or format fluentd events.
+email:
+- rbaek@splunk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGES.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- VERSION
+- example/Dockerfile
+- example/fluent.conf
+- example/statsd.sample
+- fluent-plugin-jq.gemspec
+- lib/fluent/plugin/filter_jq_transformer.rb
+- lib/fluent/plugin/formatter_jq.rb
+- lib/fluent/plugin/jq_mixin.rb
+- lib/fluent/plugin/out_jq.rb
+- lib/fluent/plugin/parser_jq.rb
+- run_ci.sh
+- test/helper.rb
+- test/plugin/test_filter_jq_transformer.rb
+- test/plugin/test_formatter_jq.rb
+- test/plugin/test_out_jq.rb
+- test/plugin/test_parser_jq.rb
+homepage: https://github.com/rockb1017/fluent-plugin-jq
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Fluentd plugins uses the jq engine.
+test_files:
+- test/helper.rb
+- test/plugin/test_formatter_jq.rb
+- test/plugin/test_parser_jq.rb
+- test/plugin/test_filter_jq_transformer.rb
+- test/plugin/test_out_jq.rb