fluent-mixin-config-placeholders 0.2.3 → 0.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cf47545aa0315f25907042c77498e98fed3b4a9
+  data.tar.gz: b5f57c7a7781cfa19b654c3e7e144bb48473908e
+SHA512:
+  metadata.gz: 5f0e041fb2cb87f82c98944ed033842ffbefd6ce16073ba55843e1c2f3b15550c4001d3158416b226de5ba42bbe41fc7cf40b502c20666781882da735c22f413
+  data.tar.gz: 4176165b3c8645705be7e46ce6b34b391aae31d45eae9d152e715e4969b61faf4531a1dbb6216fb21bac8ee06b336bdad28956b913e462768fa7766331c05bd1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/fluent-mixin-config-placeholders.gemspec

@@ -1,12 +1,13 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = "fluent-mixin-config-placeholders"
-  gem.version       = "0.2.3"
+  gem.version       = "0.2.4"
   gem.authors       = ["TAGOMORI Satoshi"]
   gem.email         = ["tagomoris@gmail.com"]
   gem.description   = %q{to add various placeholders for plugin configurations}
   gem.summary       = %q{Configuration syntax extension mixin for fluentd plugin}
   gem.homepage      = "https://github.com/tagomoris/fluent-mixin-config-placeholders"
+  gem.license       = "APLv2"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -15,4 +16,5 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency "fluentd"
   gem.add_runtime_dependency "uuidtools"
+  gem.add_development_dependency "rake"
 end

data/lib/fluent/mixin/config_placeholders.rb

@@ -38,9 +38,21 @@ module Fluent
         map.reduce(value){|r,p| r.gsub(p[0], p[1].call())}
       end
 
+      def has_replace_pattern?(value)
+        value =~ /\$\{(?:hostname|uuid:[a-z]+)\}/ ||
+          value =~ /\%\{(?:hostname|uuid:[a-z]+)\}/ ||
+          value =~ /__(?:HOSTNAME|UUID_[A-Z]+)__/
+      end
+
       def configure(conf)
-        # Element#has_key? inserts key name into 'used' list, so we should escape that method...
-        hostname = conf.keys.include?('hostname') ? conf['hostname'] : `hostname`.chomp
+        # Element#has_key? inserts key name into 'used' list, so we should not use that method...
+        hostname = if conf.keys.include?('hostname') && has_replace_pattern?( conf.fetch('hostname') )
+                     `hostname`.chomp
+                   elsif conf.keys.include?('hostname')
+                     conf['hostname']
+                   else
+                     `hostname`.chomp
+                   end
 
         placeholders = self.respond_to?(:placeholders) ? self.placeholders : PLACEHOLDERS_DEFAULT
 

data/test/mixin/test_config_placeholders.rb

@@ -8,26 +8,27 @@ class ConfigPlaceholdersTest < Test::Unit::TestCase
   end
 
   def test_unused
+    # 'id' used by Fluentd core as plugin id...
     conf = %[
 tag HOGE
 path POSPOSPOS
 ]
     p = Fluent::Test::InputTestDriver.new(Fluent::ConfigPlaceholdersTest2Input).configure(conf).instance
-    assert_equal ['tag','path'], p.conf.used
+    assert_equal [], p.conf.unused
 
     conf = %[
 tag HOGE
 path POSPOSPOS
 ]
     p = Fluent::Test::InputTestDriver.new(Fluent::ConfigPlaceholdersTestXInput).configure(conf).instance
-    assert_equal [], p.conf.used
+    assert_equal ['tag', 'path'], p.conf.unused
 
     conf = %[
 tag HOGE
 path POSPOSPOS ${hostname} MOGEMOGE
 ]
     p = Fluent::Test::InputTestDriver.new(Fluent::ConfigPlaceholdersTestXInput).configure(conf).instance
-    assert_equal [], p.conf.used
+    assert_equal ['tag', 'path'], p.conf.unused
   end
 
   def test_default
@@ -220,4 +221,51 @@ path /path/to/file.log
     assert_equal "value.1." + uuid, p3.conf.elements.first.elements[0]['field']
     assert_equal "value.2." + uuid, p3.conf.elements.first.elements[1]['field']
   end
+
+  def test_value_has_replace_pattern?
+    conf1 = %[
+hostname test.host.local
+attr1    ${hostname}
+]
+    p1 = Fluent::Test::InputTestDriver.new(Fluent::ConfigPlaceholdersTest3Input).configure(conf1).instance
+
+    assert p1.has_replace_pattern?('foo.__HOSTNAME__')
+    assert p1.has_replace_pattern?('foo.__UUID_RANDOM__')
+    assert p1.has_replace_pattern?('foo.__UUID_HOSTNAME__')
+    assert p1.has_replace_pattern?('foo.__UUID_TIMESTAMP__')
+    assert p1.has_replace_pattern?('foo.${hostname}.local')
+    assert p1.has_replace_pattern?('foo.${uuid:random}.local')
+    assert p1.has_replace_pattern?('foo.${uuid:hostname}.local')
+    assert p1.has_replace_pattern?('foo.${uuid:timestamp}.local')
+    assert p1.has_replace_pattern?('%{hostname}.local')
+    assert p1.has_replace_pattern?('%{uuid:random}.local')
+    assert p1.has_replace_pattern?('%{uuid:hostname}.local')
+    assert p1.has_replace_pattern?('%{uuid:timestamp}.local')
+  end
+
+  def test_attribute_hostname
+    # this configuration pattern is to set hostname itself
+    #  - @hostname should be set as 'test.host.local'
+    #  - @attr1 should be set as 'test.host.local'
+    conf1 = %[
+hostname test.host.local
+attr1    ${hostname}
+]
+    p1 = Fluent::Test::InputTestDriver.new(Fluent::ConfigPlaceholdersTest3Input).configure(conf1).instance
+    assert_equal "test.host.local", p1.hostname
+    assert_equal "test.host.local", p1.attr1
+
+    # this configuration pattern is to set hostname-attribute of plugins
+    #  when 'myhostname' is host name (result of `hostname` shell command),
+    #  - @hostname is set as 'myhostname.fluentd.local'
+    #  - @attr1 should be set as 'myhostname' only, it is default of mixin
+    conf2 = %[
+hostname ${hostname}.fluentd.local
+attr1    __HOSTNAME__
+]
+    p2 = Fluent::Test::InputTestDriver.new(Fluent::ConfigPlaceholdersTest3Input).configure(conf2).instance
+    hostname_cmd = `hostname`.chomp
+    assert_equal "#{hostname_cmd}.fluentd.local", p2.hostname
+    assert_equal hostname_cmd, p2.attr1
+  end
 end

data/test/plugin.rb

@@ -62,3 +62,20 @@ class Fluent::ConfigPlaceholdersTest2Input < Fluent::Input
     @conf = conf
   end
 end
+
+class Fluent::ConfigPlaceholdersTest3Input < Fluent::Input
+  Fluent::Plugin.register_input('config_placeholder_test_2', self)
+
+  config_param :hostname, :string
+  config_param :attr1, :string
+
+  include Fluent::Mixin::ConfigPlaceholders
+
+  attr_accessor :conf
+
+  def placeholders; [:dollar, :percent, :underscore]; end
+  def configure(conf)
+    super
+    @conf = conf
+  end
+end

metadata

@@ -1,46 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: fluent-mixin-config-placeholders
 version: !ruby/object:Gem::Version
-  version: 0.2.3
-  prerelease: 
+  version: 0.2.4
 platform: ruby
 authors:
 - TAGOMORI Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
 description: to add various placeholders for plugin configurations
@@ -51,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -61,30 +71,31 @@ files:
 - test/mixin/test_config_placeholders.rb
 - test/plugin.rb
 homepage: https://github.com/tagomoris/fluent-mixin-config-placeholders
-licenses: []
+licenses:
+- APLv2
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Configuration syntax extension mixin for fluentd plugin
 test_files:
 - test/helper.rb
 - test/mixin/test_config_placeholders.rb
 - test/plugin.rb
+has_rdoc: