fluent-plugin-ufw 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c71257b4fae307040cd23f60bed50163d90b8697
-  data.tar.gz: 07e224c028339bfc0e9c4fb6b86324ed2e85c8b6
+  metadata.gz: 327bf9d605416f3711df25a1dd321466808ab38d
+  data.tar.gz: 846b003b4a06b26ea9bda0f190db70dbceab319c
 SHA512:
-  metadata.gz: aa814ea8afb5b0e17c6029abbafb34a0f635bc6b232e79885dff49bc96cc680779618276a3d733712edf730896673084d5d91dc035815d6556fbf61c935f5624
-  data.tar.gz: 5724616c78a568c9a6c13d5588ce9a69ae3c1ed8a7150070717e76b7718899f3de60aa8cfc473dedf0412cf08ebfd0183a7b0c15239aaf19367b65bd0d2c3397
+  metadata.gz: c3b8c1415317687bfcf6f7ccec3f4c47bbcc1fc6de389b8ef97adc741b46e257b87bd5e2d40166fd7838543e15dda284816c98175e4756448e921ff8c0fff424
+  data.tar.gz: c24a485875a92407fe9cdde3d607e38dc01a15856bc6b39a01e63d4699bea45acdece78213aec87e74144aa16945b9e6da6410a20dea0f1d9843d5b2a307e730

data/.travis.yml

@@ -1,16 +1,20 @@
+sudo: required
 language: ruby
-sudo: true
+services:
+  - docker
 before_install:
   - gem update bundler
-  - gem update
 
 rvm:
-#  - 1.9.3	
-#  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.3
-  - 2.4.0
+  - 2.1.*
+  - 2.2.*
+  - 2.3.*
+  - 2.4.*
+  - 2.5.*
 
 gemfile:
   - Gemfile
+
+after_script:
+  - docker-compose build
+  - docker-compose run builder ./run_appraisal.sh

data/Appraisals

@@ -1,61 +1,22 @@
-appraise "fluentd-0.12.39" do
-  gem "fluentd", "0.12.39"
+appraise "fluentd-1.2.6" do
 end
 
-appraise "test-unit-3" do
-  gem "fluentd", "0.12.39"
-  gem "test-unit", "3.0.0"
-end
-
-appraise "test-unit-2" do
-  gem "fluentd", "0.12.39"
-  gem "test-unit", "2.0.0"
-end
-
-# ok
-appraise "test-unit-1" do
-  gem "fluentd", "0.12.39"
-  gem "test-unit", "1.2.3"
-end
-
-appraise "rake-0.9.2" do
-  gem "fluentd", "0.12.39"
-  gem "test-unit", "1.2.3"
-  gem "rake", "0.9.2"
+appraise "fluentd-1.2.6" do
+  gem "fluentd", "1.2.6"
 end
 
-appraise "appraisal-1.0.0" do
-  gem "fluentd", "0.12.39"
-  gem "test-unit", "1.2.3"
-  gem "rake", "0.9.2"
-  gem "appraisal", "1.0.0"
-end
-
-# ok
-appraise "fluentd-0.12.30" do
-  gem "fluentd", "0.12.30"
-end
-
-# ng
-appraise "fluentd-0.12.29" do
-  gem "fluentd", "0.12.29"
+appraise "test-unit-3-1.2.6" do
+  gem "fluentd", "1.2.6"
+  gem "test-unit", "3.0.0"
 end
 
-# ok
-appraise "fluentd-0.12.25" do
-  gem "fluentd", "0.12.25"
+appraise "fluentd-0.14.22" do
+  gem "fluentd", "0.14.22"
 end
 
-# ok
-appraise "fluentd-0.12.22" do
-  gem "fluentd", "0.12.22"
+appraise "test-unit-3-0.14.22" do
+  gem "fluentd", "0.14.22"
+  gem "test-unit", "3.0.0"
 end
 
-appraise "fluentd-0.12.21" do
-  gem "fluentd", "0.12.21"
-end
 
-# failed
-#appraise "fluentd-0.12.20" do
-#  gem "fluentd", "0.12.20"
-#end

data/Dockerfile

@@ -1,8 +1,11 @@
-FROM fluent/fluentd:v0.14.20
+FROM ubuntu:16.04
+LABEL maintainer "Takashi Masuyama <mamewotoko@gmail.com>"
 
-COPY pkg/fluent-plugin-ufw-*.gem .
-RUN gem install --local fluent-plugin-ufw-*.gem
+RUN apt-get update && apt-get upgrade -y && apt-get install -y ruby git ruby-bundler ruby-dev curl make gcc
+# install fluentd (gem)
+RUN curl -L https://toolbelt.treasuredata.com/sh/install-ubuntu-xenial-td-agent3.sh | sed 's:sudo ::g' | sh
 
-COPY docker/etc/fluent.conf /fluentd/etc/
-RUN mkdir /var/log/ufw/
-COPY docker/var/log/ufw/ufw.log /var/log/ufw/
+RUN mkdir work
+
+WORKDIR work
+VOLUME work

data/README.md

@@ -1,6 +1,5 @@
-fluent-plugin-ufw
+fluent-plugin-ufw [![Build Status](https://travis-ci.org/mamewotoko/fluent-plugin-ufw.svg?branch=master)](https://travis-ci.org/mamewotoko/fluent-plugin-ufw) [![Gem Version](https://badge.fury.io/rb/fluent-plugin-ufw.svg)](https://badge.fury.io/rb/fluent-plugin-ufw)
 ==================
-[![Build Status](https://travis-ci.org/mamewotoko/fluent-plugin-ufw.svg?branch=master)](https://travis-ci.org/mamewotoko/fluent-plugin-ufw)
 
 A [fluent](https://www.fluentd.org/) plugin to parse [ufw](https://help.ubuntu.com/community/UFW) log
 
@@ -29,13 +28,28 @@ specify `format ufw` in fluent.config like example below.
 * read [Interpreting Log Entries of UFW](https://help.ubuntu.com/community/UFW#Interpreting_Log_Entries)
 
 ## Test
-### A. Using installed fluetntd
+### Overview
+
+Test tool
+
+* a. unit-test
+* b. appraisal
+* c. manual
+
+Test environment
+
+* A. local pc
+* B. Vagrant VirtualBox VM (`ubuntu/xenial64`)
+* C. Docker
+
+### a. unit-test
+
 ```
 bundle install
 bundle exec rake
 ```
 
-### B. Multiple version of fluentd with appraisal tool
+### b. Multiple version of fluentd with appraisal tool
 
 ```
 bundle install
@@ -43,32 +57,88 @@ appraisal install
 appraisal rake test
 ```
 
-### C. Install gem and run with fluentd as docker container
-
-Run for fluentd version specified in Dockerfile
+### c. Install gem as fluentd plugin (manual test)
+1. build and install gem
 
 ```
-sh run_docker_test.sh
+bundle exec rake build
+gem install --local pkg/fluent-plugin-ufw-0.0.4.gem
 ```
 
-Run for multiple fluentd version
+2. write td-agent.conf
+
+sample
 
 ```
-sh run_docker_test.sh
+<source>
+  @type tail
+  time_key time
+  read_from_head true
+  format ufw
+ 
+  path /var/log/ufw.log
+  pos_file /var/log/td-agent/ufw.pos
+  tag ufw.combined
+</source>
+
+<match ufw.*>
+  @type file
+  path /var/log/td-agent/ufw.output
+  append true
+  flush_interval 5s
+  time_slice_format %Y%m%d
+  time_slice_wait 10m
+  time_format %Y%m%dT%H%M%S%z
+</match>
 ```
 
-## Install for development
-### A. build gem file and install
+3. restart td-agent and check output
+
+### a. local pc (ubuntu/debian)
 
 ```
+sudo apt-get update
+sudo apt-get install -y ruby git ruby-bundler ruby-dev
+curl -L https://toolbelt.treasuredata.com/sh/install-ubuntu-xenial-td-agent3.sh | sh
+
+# clone this source using git
+
 bundle exec rake build
-gem install --local pkg/fluent-plugin-ufw-0.0.1.gem
+gem install --local pkg/fluent-plugin-ufw-0.0.4.gem
+
+```
+
+### b. Vagrant
+
+[Vagrantfile](Vagrantfile) is to run virtual box vm to build and test gem
+
+1. prepare 
+
+```
+vagrant up
+```
+
+2. login to vm
+
+```
+vagrant ssh
+cd /vagrant
+```
+
+3. run test
+
+### c. docker container
+
+Build image for fluentd version specified in Dockerfile
+
+```
+docker-compose build
 ```
 
-### B. copy plugin file
+Then, run test run_test.sh or run_appraisal.sh
 
 ```
-cp lib/fluent/plugin/parser_ufw.rb /etc/fluent/plugin/
+docker-compose run builder ./run_test.sh
 ```
 
 ## License
@@ -91,7 +161,9 @@ limitations under the License.
 
 ## References
 * [UFW](https://help.ubuntu.com/community/UFW)
+* [test-unit](https://test-unit.github.io/)
+* [thoughtbot/appraisal](https://github.com/thoughtbot/appraisal)
 
 ----
 Takashi Masuyama < mamewotoko@gmail.com >  
-http://mamewo.ddo.jp/
+https://mamewo.ddo.jp/

data/TODO.md

@@ -0,0 +1,9 @@
+TODO
+====
+* add lint
+  * rubocop 
+* build gem using docker
+* test using docker
+  * method A
+  * method B
+  * method C

data/Vagrantfile

@@ -0,0 +1,31 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure(2) do |config|
+  config.vm.box = "ubuntu/xenial64"
+  config.vm.network "private_network", ip: "192.168.33.10"
+  config.vm.boot_timeout = 60 * 15
+
+  config.vm.provider "virtualbox" do |vb|
+    # Display the VirtualBox GUI when booting the machine
+    vb.gui = true
+  
+    # Customize the amount of memory on the VM:
+    vb.memory = "1024"
+  end
+
+  config.vm.provision "shell", inline: <<-SHELL
+     sudo apt-get update
+     sudo apt-get install -y ruby git ruby-bundler ruby-dev
+     curl -L https://toolbelt.treasuredata.com/sh/install-ubuntu-xenial-td-agent3.sh | sh
+
+    cd /vagrant
+    bundle exec rake build
+    gem install --local pkg/fluent-plugin-ufw-0.0.4.gem
+  SHELL
+end
+

data/docker-compose.yml

@@ -1,6 +1,7 @@
 version: '2'
 
 services:
-  fluent-plugin-ufw:
+  builder:
     build: .
-
+    volumes:
+      - .:/work

data/docker/etc/fluent.conf

@@ -12,6 +12,7 @@
 <match ufw.*>
   @type file
   path /home/fluent/ufw.output
+  flush_interval 5s
   time_slice_format %Y%m%d
   time_slice_wait 10m
   time_format %Y%m%dT%H%M%S%z

data/fluent-plugin-ufw.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-ufw"
-  s.version     = "0.0.3"
+  s.version     = "0.0.4"
   s.authors     = ["Takashi Masuyama"]
   s.email       = ["mamewotoko@gmail.com"]
   s.homepage    = "https://github.com/mamewotoko/fluent-plugin-ufw"
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.license       = "Apache-2.0"
 
-  s.add_runtime_dependency "fluentd", [">= 0.12.21"]
+  s.add_runtime_dependency "fluentd", [">= 0.14.0", "< 2"]
 
   s.add_development_dependency "rake", [">= 0.9.2"]
   s.add_development_dependency "test-unit", [">= 1.2.3"]

data/lib/fluent/plugin/parser_ufw.rb

@@ -1,7 +1,7 @@
-require 'fluent/parser'
+require 'fluent/plugin/parser'
 
 module Fluent
-  class TextParser
+  module Plugin
     class UFWParser < Parser
       # Register this parser as "time_key_value"
       Fluent::Plugin.register_parser("ufw", self)
@@ -41,7 +41,7 @@ module Fluent
           record[key] = value
         end
         record['time'] = m['time'] if @keep_time_key
-        
+
         yield time, record
       end
     end

data/run_appraisal.sh

@@ -0,0 +1,5 @@
+#! /bin/bash
+set -e
+bundle install
+appraisal install
+appraisal rake test

data/run_test.sh

@@ -0,0 +1,6 @@
+#! /bin/bash
+set -e
+
+bundle install
+bundle exec rake
+

data/test/fluent/plugin/test_parser_ufw.rb

@@ -3,8 +3,8 @@ require 'test_helper'
 class UFWTest < Test::Unit::TestCase
   def setup
     Fluent::Test.setup
-    
-    @parser = Fluent::Test::ParserTestDriver.new(Fluent::TextParser::UFWParser).configure({})
+
+    @parser = Fluent::Test::Driver::Parser.new(Fluent::Plugin::UFWParser).configure({})
     @expected = {
       'host' => 'hostnm',
       'action' => 'UFW BLOCK',
@@ -35,7 +35,8 @@ class UFWTest < Test::Unit::TestCase
       expected_time = Time.strptime('1/Aug 19:03:54', '%d/%b %H:%M:%S')
       assert_equal(expected_time.to_i, time.to_i)
       assert_equal(@expected, record)
+      p record.to_json
     }
   end
-    
+
 end

data/test/test_helper.rb

@@ -3,3 +3,4 @@ require 'fluent/plugin/parser_ufw'
 
 require 'test/unit'
 require 'fluent/test'
+require 'fluent/test/driver/parser'

metadata

@@ -1,69 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-ufw
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Takashi Masuyama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-05 00:00:00.000000000 Z
+date: 2018-10-06 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.21
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.12.21
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: appraisal
   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: Fluentd plugin to parse ufw log
@@ -73,8 +79,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Appraisals
 - Dockerfile
 - Dockerfile.template
@@ -82,14 +88,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
+- Vagrantfile
 - docker-compose.yml
 - docker/Dockerfile
 - docker/etc/fluent.conf
 - docker/var/log/ufw/ufw.log
 - fluent-plugin-ufw.gemspec
 - lib/fluent/plugin/parser_ufw.rb
-- run_docker_all_test.sh
-- run_docker_test.sh
+- run_appraisal.sh
+- run_test.sh
 - test/fluent/plugin/test_parser_ufw.rb
 - test/test_helper.rb
 homepage: https://github.com/mamewotoko/fluent-plugin-ufw
@@ -102,17 +110,17 @@ 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.0.14.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Fluentd plugin to parse ufw log

data/run_docker_all_test.sh

@@ -1,8 +0,0 @@
-#! /bin/bash
-IMAGE_VERSION="v0.12.39 v0.14.20"
-
-for v in $IMAGE_VERSION; do
-    sed "s/%%IMAGE_VERSION%%/$v/" Dockerfile.template > Dockerfile
-    sh run_docker_test.sh
-done
-

data/run_docker_test.sh

@@ -1,7 +0,0 @@
-#! /bin/sh
-set -e
-docker-compose up --build -d
-sleep 10
-docker-compose exec fluent-plugin-ufw sh -c "cat /home/fluent/ufw.output.*" | grep SRC && echo ok
-docker-compose logs
-docker-compose down