fluent-plugin-json 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6050c4a9e856b17fa79709e5538548d6ee7e0231262b6dc27c2ce5483a889c04
-  data.tar.gz: 649ec3f78940ebbfd3c71e1b75ff1827b36219ab7c84a75c20c01f312332028a
+  metadata.gz: cffdd05fc081766a31eff1b72f9f7175967fa7bf3835b258a542e8aae29fdf0c
+  data.tar.gz: b1025d1e3f2886957b2fbc02ed3a4a6f0427b9bae42e6238227d6b309a086878
 SHA512:
-  metadata.gz: 10d413ae604284ba904e055fb4df38b1be4e9ae8c2b5bada64e0e19027f6a1943973db819813cf46c9989bfbbf464f263293c64fc97fecf136dc1d764a49991c
-  data.tar.gz: 4f6b1687ca31db8219d6376139cd5add99023660645e747f846b30a2de2176b5a186d4ba93fe5794dd25c129e4156489f797b926db8287efeb0e4fee4f928cbe
+  metadata.gz: 6214f18f40adb9bb2d6ddf0e658484096bd032454b1bdd8f6375e254359f09d976da5f56eb23c0713192227784e7108ece9e0c148c6d6fac932318d866ad6523
+  data.tar.gz: 6596c550da1aa829e9441a268dd60ae143f809f77ee724fdac28fc6beb147ca9c673d9d99b93dcb0845bc1fc83e3becc3cbdfa3cafd0c7444babf5af32e54d6b

data/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: ci
+
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+      - '.rubocop.yml'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '.rubocop.yml'
+
+jobs:
+  run-tests:
+    name: Run tests
+    strategy:
+      matrix:
+        os: [ubuntu-18.04]
+        ruby-version: ['2.5', '2.6', '2.7']
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+
+    - name: Bundle install
+      run: |
+        gem install bundler && \
+        bundle install --jobs 4 --retry 3
+
+    - name: Tests
+      run: bundle exec rake test

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# RuboCop Default Config: https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml
+
+AllCops:
+  NewCops: disable
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/README.md

@@ -1,5 +1,14 @@
 # fluent-plugin-json
 
+[![ci](https://github.com/iamazeem/fluent-plugin-json/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/iamazeem/fluent-plugin-json/actions/workflows/ci.yml)
+[![License: Apache](https://img.shields.io/badge/license-Apache-blue.svg?style=flat-square)](https://github.com/iamAzeem/fluent-plugin-json/blob/master/LICENSE)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/iamAzeem/fluent-plugin-json?style=flat-square)
+[![RubyGems Downloads](https://img.shields.io/gem/dt/fluent-plugin-json?color=blue&style=flat-square)](https://rubygems.org/gems/fluent-plugin-json)
+
+![Lines of code](https://img.shields.io/tokei/lines/github/iamAzeem/fluent-plugin-json?label=LOC&style=flat-square)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/iamAzeem/fluent-plugin-json?style=flat-square)
+![GitHub repo size](https://img.shields.io/github/repo-size/iamAzeem/fluent-plugin-json?style=flat-square)
+
 [Fluentd](https://fluentd.org/) filter plugin for JSON with JSON pointer support
 ([RFC-6901](https://tools.ietf.org/html/rfc6901)).
 
@@ -8,7 +17,7 @@
 ### RubyGems
 
 ```bash
-$ gem install fluent-plugin-json
+gem install fluent-plugin-json
 ```
 
 ### Bundler
@@ -16,13 +25,13 @@ $ gem install fluent-plugin-json
 Add the following line to your Gemfile:
 
 ```ruby
-gem "fluent-plugin-json"
+gem 'fluent-plugin-json'
 ```
 
 And then execute:
 
 ```bash
-$ bundle
+bundle
 ```
 
 ## Configuration
@@ -32,26 +41,27 @@ $ bundle
 * `pointer` (string) (required): The JSON pointer to an element.
 * `pattern` (regexp) (required): The regular expression to match the element.
 
-The configuration consists of one or more check(s). Each check contains a
-`pointer` to a JSON element and a `pattern` (regex) to test it.
+The configuration may consist of one or more checks. Each check contains a
+`pointer` to a JSON element and its corresponding `pattern` (regex) to test it.
 
 The checks are evaluated sequentially. The failure of a single check results in
-rejection of the event. A rejected event is not routed for further processing.
+the rejection of the event. A rejected event is not routed for further
+processing.
 
-NOTE: The JSON element pointed to by the `pointer` is always converted to string
-for testing with the `pattern` (regular expression).
+**NOTE**: The JSON element pointed to by the `pointer` is always converted to a
+string for testing with the `pattern` (regex).
 
-For examples of the syntax of:
+For the detailed syntax of:
 
-- JSON Pointer, see [RFC-6901](https://tools.ietf.org/html/rfc6901#section-5).
+- JSON Pointer, see [RFC-6901](https://tools.ietf.org/html/rfc6901#section-5); and,
 - Ruby's Regular Expression, see [Regexp](https://ruby-doc.org/core-2.4.1/Regexp.html).
 
 ### Example
 
-Here is a configuration with the input plugin
-[`forward`](https://docs.fluentd.org/v/1.0/input/forward), `json` filter plugin
-with multiple checks and routing to the output plugin
-[`stdout`](https://docs.fluentd.org/v/1.0/output/stdout):
+Here is a sample configuration with
+[`forward`](https://docs.fluentd.org/v/1.0/input/forward) input plugin, `json`
+filter plugin with multiple checks and the routing to
+[`stdout`](https://docs.fluentd.org/v/1.0/output/stdout) output plugin:
 
 ```text
 <source>
@@ -65,23 +75,22 @@ with multiple checks and routing to the output plugin
 
   <check>
     pointer   /log/user     # point to { "log": { "user": "test", ... } }
-    pattern   /test/i       # check it against username `test` (ignore case)
+    pattern   /test/i       # check it against the value of username `test` (ignore case)
   </check>
 
   <check>
     pointer   /log/codes/0  # point to { "log": { "codes": [123, ...] } }
-    pattern   /123/         # check it against 0th index of codes array
+    pattern   /123/         # check it against the value at 0th index of the codes array i.e. `123`
   </check>
 
   <check>
-    pointer   /log/level    # point to { "log": { "level": ... } }
-    pattern   /.*/          # check it against all log levels
+    pointer   /log/level    # point to { "log": { "level": "info", ... } }
+    pattern   /.*/          # check it against all the log levels
   </check>
 </filter>
 
 <match debug.test>
   @type       stdout
-  @id         stdout_output
 </match>
 ```
 
@@ -94,7 +103,7 @@ For a JSON message:
 Sent using `fluent-cat` with tag `debug.test`:
 
 ```bash
-$ echo '{ "log": {"user": "test", "codes": [123, 456], "level": "info"} }' | fluent-cat "debug.test"
+echo '{ "log": {"user": "test", "codes": [123, 456], "level": "info"} }' | fluent-cat "debug.test"
 ```
 
 After passing all the checks, the routed event to `stdout` would be:
@@ -103,17 +112,25 @@ After passing all the checks, the routed event to `stdout` would be:
 2020-07-23 22:36:06.093187459 +0500 debug.test: {"log":{"user":"test","codes":[123,456],"level":"info"}}
 ```
 
-By default, the logs for checks are generated in `debug` mode only:
+By default, the checks are logged in `debug` mode only:
 
-```bash
+```text
 2020-07-23 22:47:33 +0500 [debug]: #0 [json_filter] check: pass [/log/user -> 'test'] (/test/)
 2020-07-23 22:47:33 +0500 [debug]: #0 [json_filter] check: pass [/log/codes/0 -> '123'] (/123/)
 2020-07-23 22:47:33 +0500 [debug]: #0 [json_filter] check: pass [/log/level -> 'info'] (/.*/)
 2020-07-23 22:47:33.577900915 +0500 debug.test: {"log":{"user":"test","codes":[123,456],"level":"info"}}
 ```
 
-## Copyright
+## Contribute
+
+- Fork the project.
+- Check out the latest `main` branch.
+- Create a feature or bugfix branch from `main`.
+- Commit and push your changes.
+- Make sure to add and run tests locally: `bundle exec rake test`.
+- Run `rubocop` locally and fix all the lint warnings.
+- Submit the PR.
+
+## License
 
-* Copyright &copy; 2020 [Azeem Sajid](https://www.linkedin.com/in/az33msajid/)
-* License
-  * Apache License, Version 2.0
+[Apache 2.0](LICENSE)

data/fluent-plugin-json.gemspec

@@ -5,12 +5,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name           = 'fluent-plugin-json'
-  spec.version        = '0.1.0'
+  spec.version        = '0.2.0'
   spec.authors        = ['Azeem Sajid']
   spec.email          = ['azeem.sajid@gmail.com']
 
-  spec.summary        = 'Fluentd filter plugin for JSON events with JSON Pointer Support'
-  spec.description    = 'Fluentd filter plugin for JSON events with JSON Pointer Support to pinpoint elements.'
+  spec.summary        = 'Fluentd JSON filter plugin with JSON Pointer Support (RFC-6901)'
+  spec.description    = 'Fluentd JSON filter plugin with JSON Pointer Support (RFC-6901) to pinpoint elements.'
   spec.homepage       = 'https://github.com/iamAzeem/fluent-plugin-json'
   spec.license        = 'Apache-2.0'
 
@@ -22,9 +22,10 @@ Gem::Specification.new do |spec|
   spec.test_files     = test_files
   spec.require_paths  = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.1.0'
   spec.add_development_dependency 'hana', '~> 1.3', '>= 1.3.6'
   spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12', '<= 0.12.2'
   spec.add_development_dependency 'test-unit', '~> 3.0'
   spec.add_runtime_dependency 'fluentd', ['>= 0.14.10', '< 2']
   spec.add_runtime_dependency 'hana', '~> 1.3', '>= 1.3.6'

data/test/helper.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'simplecov'
+SimpleCov.start
+
 $LOAD_PATH.unshift(File.expand_path('..', __dir__))
 require 'test-unit'
 require 'fluent/test'

data/test/plugin/test_filter_json.rb

@@ -1,20 +1,110 @@
 # frozen_string_literal: true
 
 require 'helper'
-require 'fluent/plugin/filter_json.rb'
+require 'fluent/plugin/filter_json'
 
 class JsonFilterTest < Test::Unit::TestCase
   setup do
     Fluent::Test.setup
+    @time = event_time
   end
 
-  test 'failure' do
-    flunk
+  def create_driver(conf = '')
+    Fluent::Test::Driver::Filter.new(Fluent::Plugin::JsonFilter).configure(conf)
   end
 
-  private
+  sub_test_case 'configure' do
+    test 'test required section <check>' do
+      assert_raise(NameError) do
+        create_driver(conf)
+      end
+    end
 
-  def create_driver(conf)
-    Fluent::Test::Driver::Filter.new(Fluent::Plugin::JsonFilter).configure(conf)
+    test 'test required parameters' do
+      conf = %(
+        <check>
+        </check>
+      )
+      assert_raise(Fluent::ConfigError) do
+        create_driver(conf)
+      end
+    end
+
+    test 'test single check' do
+      conf = %(
+        <check>
+          pointer   /test/
+          pattern   /.*/
+        </check>
+      )
+      d = create_driver(conf)
+      assert_equal(1, d.instance.check.length)
+    end
+
+    test 'test multiple checks' do
+      conf = %(
+        <check>
+          pointer   /test/
+          pattern   /.*/
+        </check>
+        <check>
+          pointer   /test/
+          pattern   /.*/
+        </check>
+      )
+      d = create_driver(conf)
+      assert_equal(2, d.instance.check.length)
+    end
+
+    test 'test invalid pointer (JSON pointer should start with a slash)' do
+      conf = %(
+        <check>
+          pointer   .
+          pattern   /.*/
+        </check>
+      )
+      assert_raise(Fluent::ConfigError) do
+        create_driver(conf)
+      end
+    end
+  end
+
+  sub_test_case 'filter' do
+    def records
+      [
+        { 'log' => { 'user' => 'test', 'codes' => [123, 456], 'level' => 'info' } }
+      ]
+    end
+
+    def filter(conf, records)
+      d = create_driver(conf)
+      d.run do
+        records.each do |record|
+          d.feed('filter.test', @time, record)
+        end
+      end
+      d.filtered_records
+    end
+
+    test 'test multiple checks' do
+      conf = %(
+        <check>
+          pointer   /log/user
+          pattern   /test/i
+        </check>
+
+        <check>
+          pointer   /log/codes/0
+          pattern   /123/
+        </check>
+
+        <check>
+          pointer   /log/level
+          pattern   /.*/
+        </check>
+      )
+      filtered_records = filter(conf, records)
+      assert_equal(records.values_at(0), filtered_records)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-json
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Azeem Sajid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2021-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: hana
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +64,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +138,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.6
-description: Fluentd filter plugin for JSON events with JSON Pointer Support to pinpoint
+description: Fluentd JSON filter plugin with JSON Pointer Support (RFC-6901) to pinpoint
   elements.
 email:
 - azeem.sajid@gmail.com
@@ -120,7 +146,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -152,7 +180,7 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Fluentd filter plugin for JSON events with JSON Pointer Support
+summary: Fluentd JSON filter plugin with JSON Pointer Support (RFC-6901)
 test_files:
 - test/helper.rb
 - test/plugin/test_filter_json.rb