fluentd-hubspot 0.14.14.1

data/test/command/test_fluentd.rb

@@ -0,0 +1,618 @@
+require_relative '../helper'
+
+# require 'fluent/command/fluentd'
+# don't require it... it runs immediately
+
+require 'fileutils'
+require 'timeout'
+
+class TestFluentdCommand < ::Test::Unit::TestCase
+  TMP_DIR = File.expand_path(File.dirname(__FILE__) + "/../tmp/command/fluentd#{ENV['TEST_ENV_NUMBER']}")
+  SUPERVISOR_PID_PATTERN = /starting fluentd-[.0-9]+ pid=(\d+)/
+  WORKER_PID_PATTERN = /starting fluentd worker pid=(\d+) /
+
+  setup do
+    FileUtils.rm_rf(TMP_DIR)
+    FileUtils.mkdir_p(TMP_DIR)
+    @supervisor_pid = nil
+    @worker_pids = []
+  end
+
+  def process_exist?(pid)
+    begin
+      r = Process.waitpid(pid, Process::WNOHANG)
+      return true if r.nil?
+      false
+    rescue SystemCallError
+      false
+    end
+  end
+
+  def create_conf_file(name, content)
+    conf_path = File.join(TMP_DIR, name)
+    File.open(conf_path, 'w') do |file|
+      file.write content
+    end
+    conf_path
+  end
+
+  def create_plugin_file(name, content)
+    file_path = File.join(TMP_DIR, 'plugin', name)
+    FileUtils.mkdir_p(File.dirname(file_path))
+    File.open(file_path, 'w') do |file|
+      file.write content
+    end
+    file_path
+  end
+
+  def create_cmdline(conf_path, *fluentd_options)
+    cmd_path = File.expand_path(File.dirname(__FILE__) + "../../../bin/fluentd")
+    ["bundle", "exec", "ruby", cmd_path, "-c", conf_path, *fluentd_options]
+  end
+
+  def execute_command(cmdline, chdir=TMP_DIR)
+    null_stream = File.open(File::NULL, 'w')
+    gemfile_path = File.expand_path(File.dirname(__FILE__) + "../../../Gemfile")
+
+    env = {
+      "BUNDLE_GEMFILE" => gemfile_path,
+    }
+    cmdname = cmdline.shift
+    arg0 = "testing-fluentd"
+    # p(here: "executing process", env: env, cmdname: cmdname, arg0: arg0, args: cmdline)
+    IO.popen(env, [[cmdname, arg0], *cmdline], chdir: chdir, err: [:child, :out]) do |io|
+      pid = io.pid
+      begin
+        yield pid, io
+        # p(here: "execute command", pid: pid, worker_pids: @worker_pids)
+      ensure
+        Process.kill(:KILL, pid) rescue nil
+        if @supervisor_pid
+          Process.kill(:KILL, @supervisor_pid) rescue nil
+        end
+        @worker_pids.each do |cpid|
+          Process.kill(:KILL, cpid) rescue nil
+        end
+        # p(here: "execute command", pid: pid, exist: process_exist?(pid), worker_pids: @worker_pids, exists: @worker_pids.map{|i| process_exist?(i) })
+        Timeout.timeout(10){ sleep 0.1 while process_exist?(pid) }
+      end
+    end
+  ensure
+    null_stream.close rescue nil
+  end
+
+  def assert_log_matches(cmdline, *pattern_list, patterns_not_match: [], timeout: 10)
+    matched = false
+    assert_error_msg = "matched correctly"
+    stdio_buf = ""
+    begin
+      execute_command(cmdline) do |pid, stdout|
+        begin
+          waiting(timeout) do
+            while process_exist?(pid) && !matched
+              readables, _, _ = IO.select([stdout], nil, nil, 1)
+              next unless readables
+              break if readables.first.eof?
+
+              buf = readables.first.readpartial(1024)
+              # puts buf
+              stdio_buf << buf
+              lines = stdio_buf.split("\n")
+              if pattern_list.all?{|ptn| lines.any?{|line| ptn.is_a?(Regexp) ? ptn.match(line) : line.include?(ptn) } }
+                matched = true
+              end
+            end
+          end
+        ensure
+          if SUPERVISOR_PID_PATTERN =~ stdio_buf
+            @supervisor_pid = $1.to_i
+          end
+          stdio_buf.scan(WORKER_PID_PATTERN) do |worker_pid|
+            @worker_pids << worker_pid.first.to_i
+          end
+        end
+      end
+    rescue Timeout::Error
+      assert_error_msg = "execution timeout with command out:\n" + stdio_buf
+    rescue => e
+      assert_error_msg = "unexpected error in launching fluentd: #{e.inspect}\n" + stdio_buf
+    end
+    assert matched, assert_error_msg
+
+    unless patterns_not_match.empty?
+      lines = stdio_buf.split("\n")
+      patterns_not_match.each do |ptn|
+        matched_wrongly = if ptn.is_a? Regexp
+                            lines.any?{|line| ptn.match(line) }
+                          else
+                            lines.any?{|line| line.include?(ptn) }
+                          end
+        assert_false matched_wrongly, "pattern exists in logs wrongly:\n" + stdio_buf
+      end
+    end
+  end
+
+  def assert_fluentd_fails_to_start(cmdline, *pattern_list, timeout: 10)
+    # empty_list.all?{ ... } is always true
+    matched = false
+    running = false
+    assert_error_msg = "failed to start correctly"
+    stdio_buf = ""
+    begin
+      execute_command(cmdline) do |pid, stdout|
+        begin
+          waiting(timeout) do
+            while process_exist?(pid) && !running
+              readables, _, _ = IO.select([stdout], nil, nil, 1)
+              next unless readables
+              next if readables.first.eof?
+
+              stdio_buf << readables.first.readpartial(1024)
+              lines = stdio_buf.split("\n")
+              if lines.any?{|line| line.include?("fluentd worker is now running") }
+                running = true
+              end
+              if pattern_list.all?{|ptn| lines.any?{|line| ptn.is_a?(Regexp) ? ptn.match(line) : line.include?(ptn) } }
+                matched = true
+              end
+            end
+          end
+        ensure
+          if SUPERVISOR_PID_PATTERN =~ stdio_buf
+            @supervisor_pid = $1.to_i
+          end
+          stdio_buf.scan(WORKER_PID_PATTERN) do |worker_pid|
+            @worker_pids << worker_pid.first.to_i
+          end
+        end
+      end
+    rescue Timeout::Error
+      assert_error_msg = "execution timeout with command out:\n" + stdio_buf
+    rescue => e
+      assert_error_msg = "unexpected error in launching fluentd: #{e.inspect}\n" + stdio_buf
+      assert false, assert_error_msg
+    end
+    assert !running, "fluentd started to run incorrectly:\n" + stdio_buf
+    unless matched
+      assert_error_msg = "fluentd failed to start, without specified regular expressions:\n" + stdio_buf
+    end
+    assert matched, assert_error_msg
+  end
+
+  sub_test_case 'with valid configuration' do
+    test 'runs successfully' do
+      conf = <<CONF
+<source>
+  @type dummy
+  @id dummy
+  @label @dummydata
+  tag dummy
+  dummy {"message": "yay!"}
+</source>
+<label @dummydata>
+  <match dummy>
+    @type null
+    @id   blackhole
+  </match>
+</label>
+CONF
+      conf_path = create_conf_file('valid.conf', conf)
+      assert File.exist?(conf_path)
+
+      assert_log_matches(create_cmdline(conf_path), "fluentd worker is now running", 'worker=0')
+    end
+  end
+
+  sub_test_case 'with system configuration about root directory' do
+    setup do
+      @root_path = File.join(TMP_DIR, "rootpath")
+      FileUtils.rm_rf(@root_path)
+      @conf = <<CONF
+<system>
+  root_dir #{@root_path}
+</system>
+<source>
+  @type dummy
+  @id dummy
+  @label @dummydata
+  tag dummy
+  dummy {"message": "yay!"}
+</source>
+<label @dummydata>
+  <match dummy>
+    @type null
+    @id   blackhole
+  </match>
+</label>
+CONF
+    end
+
+    test 'use the specified existing directory as root' do
+      FileUtils.mkdir_p(@root_path)
+      conf_path = create_conf_file('existing_root_dir.conf', @conf)
+      assert Dir.exist?(@root_path)
+
+      assert_log_matches(create_cmdline(conf_path), "fluentd worker is now running", 'worker=0')
+    end
+
+    test 'creates the specified root directory if missing' do
+      conf_path = create_conf_file('missing_root_dir.conf', @conf)
+      assert_false Dir.exist?(@root_path)
+
+      assert_log_matches(create_cmdline(conf_path), "fluentd worker is now running", 'worker=0')
+      assert Dir.exist?(@root_path)
+    end
+
+    test 'fails to launch fluentd if specified root path is invalid path for directory' do
+      File.open(@root_path, 'w') do |_|
+        # create file and close it
+      end
+      conf_path = create_conf_file('existing_root_dir.conf', @conf)
+
+      assert_fluentd_fails_to_start(
+        create_cmdline(conf_path),
+        "non directory entry exists:#{@root_path} (Fluent::InvalidRootDirectory)",
+      )
+    end
+  end
+
+  sub_test_case 'configured to route log events to plugins' do
+    setup do
+      @basic_conf = <<CONF
+<source>
+  @type dummy
+  @id dummy
+  tag dummy
+  dummy {"message": "yay!"}
+</source>
+<match dummy>
+  @type null
+  @id   blackhole
+</match>
+CONF
+    end
+
+    test 'by top level <match fluent.*> section' do
+      conf = @basic_conf + <<CONF
+<match fluent.**>
+  @type stdout
+</match>
+CONF
+      conf_path = create_conf_file('logevent_1.conf', conf)
+      assert_log_matches(
+        create_cmdline(conf_path),
+        "fluentd worker is now running",
+        'fluent.info: {"worker":0,"message":"fluentd worker is now running worker=0"}',
+        patterns_not_match: ['[warn]: some tags for log events are not defined (to be ignored) tags=["fluent.trace", "fluent.debug"]'],
+      )
+    end
+
+    test 'by top level <match> section with warning for missing log levels (and warnings for each log event records)' do
+      conf = @basic_conf + <<CONF
+<match fluent.warn fluent.error fluent.fatal>
+  @type stdout
+</match>
+CONF
+      conf_path = create_conf_file('logevent_2.conf', conf)
+      assert_log_matches(
+        create_cmdline(conf_path),
+        "fluentd worker is now running",
+        '[warn]: match for some tags of log events are not defined (to be ignored) tags=["fluent.trace", "fluent.debug", "fluent.info"]',
+        '[warn]: #0 no patterns matched tag="fluent.info"',
+      )
+    end
+
+    test 'by <label @FLUENT_LOG> section' do
+      conf = @basic_conf + <<CONF
+<label @FLUENT_LOG>
+  <match **>
+    @type stdout
+  </match>
+</label>
+CONF
+      conf_path = create_conf_file('logevent_3.conf', conf)
+      assert_log_matches(
+        create_cmdline(conf_path),
+        "fluentd worker is now running",
+        'fluent.info: {"worker":0,"message":"fluentd worker is now running worker=0"}',
+        patterns_not_match: ['[warn]: some tags for log events are not defined (to be ignored)'],
+      )
+    end
+
+    test 'by <label> section with warning for missing log levels' do
+      conf = @basic_conf + <<CONF
+<label @FLUENT_LOG>
+  <match fluent.{trace,debug}>
+    @type null
+  </match>
+  <match fluent.warn fluent.error>
+    @type stdout
+  </match>
+</label>
+CONF
+      conf_path = create_conf_file('logevent_4.conf', conf)
+      assert_log_matches(
+        create_cmdline(conf_path),
+        "fluentd worker is now running",
+        '[warn]: match for some tags of log events are not defined (to be ignored) tags=["fluent.info", "fluent.fatal"]',
+        patterns_not_match: ['[warn]: no patterns matched tag="fluent.info"'],
+      )
+    end
+  end
+
+  sub_test_case 'configured to suppress configration dump' do
+    setup do
+      @basic_conf = <<CONF
+<source>
+  @type dummy
+  @id dummy
+  @label @dummydata
+  tag dummy
+  dummy {"message": "yay!"}
+</source>
+<label @dummydata>
+  <match dummy>
+    @type null
+    @id   blackhole
+  </match>
+</label>
+CONF
+    end
+
+    test 'configured by system config' do
+      conf = <<SYSTEM + @basic_conf
+<system>
+  suppress_config_dump
+</system>
+SYSTEM
+      conf_path = create_conf_file('suppress_conf_dump_1.conf', conf)
+      assert_log_matches(create_cmdline(conf_path), "fluentd worker is now running", patterns_not_match: ["tag dummy"])
+    end
+
+    test 'configured by command line option' do
+      conf_path = create_conf_file('suppress_conf_dump_2.conf', @basic_conf)
+      assert_log_matches(create_cmdline(conf_path, '--suppress-config-dump'), "fluentd worker is now running", patterns_not_match: ["tag dummy"])
+    end
+
+    test 'configured as false by system config, but overridden as true by command line option' do
+      conf = <<SYSTEM + @basic_conf
+<system>
+  suppress_config_dump false
+</system>
+SYSTEM
+      conf_path = create_conf_file('suppress_conf_dump_3.conf', conf)
+      assert_log_matches(create_cmdline(conf_path, '--suppress-config-dump'), "fluentd worker is now running", patterns_not_match: ["tag dummy"])
+    end
+  end
+
+  sub_test_case 'configuration with wrong plugin type' do
+    test 'failed to start' do
+      conf = <<CONF
+<source>
+  @type
+  @id dummy
+  @label @dummydata
+  tag dummy
+  dummy {"message": "yay!"}
+</source>
+<label @dummydata>
+  <match dummy>
+    @type null
+    @id   blackhole
+  </match>
+</label>
+CONF
+      conf_path = create_conf_file('type_missing.conf', conf)
+      assert File.exist?(conf_path)
+
+      assert_fluentd_fails_to_start(
+        create_cmdline(conf_path),
+        "config error",
+        "error=\"Unknown input plugin ''. Run 'gem search -rd fluent-plugin' to find plugins",
+      )
+    end
+  end
+
+  sub_test_case 'configuration to load plugin file with syntax error' do
+    test 'failed to start' do
+      script =  "require 'fluent/plugin/input'\n"
+      script << "module Fluent::Plugin\n"
+      script << "  class BuggyInput < Input\n"
+      script << "    Fluent::Plugin.register_input('buggy', self)\n"
+      script << "  end\n"
+      plugin_path = create_plugin_file('in_buggy.rb', script)
+
+      conf = <<CONF
+<source>
+  @type buggy
+  @id dummy
+  @label @dummydata
+  tag dummy
+  dummy {"message": "yay!"}
+</source>
+<label @dummydata>
+  <match dummy>
+    @type null
+    @id   blackhole
+  </match>
+</label>
+CONF
+      conf_path = create_conf_file('buggy_plugin.conf', conf)
+      assert File.exist?(conf_path)
+
+      assert_fluentd_fails_to_start(
+        create_cmdline(conf_path, "-p", File.dirname(plugin_path)),
+        "error_class=SyntaxError",
+        "in_buggy.rb:5: syntax error, unexpected end-of-input, expecting keyword_end",
+      )
+    end
+  end
+
+  sub_test_case 'configuration to load plugin which raises unrecoverable error in #start' do
+    test 'failed to start' do
+      script =  "require 'fluent/plugin/input'\n"
+      script << "require 'fluent/error'\n"
+      script << "module Fluent::Plugin\n"
+      script << "  class CrashingInput < Input\n"
+      script << "    Fluent::Plugin.register_input('crashing', self)\n"
+      script << "    def start\n"
+      script << "      raise Fluent::UnrecoverableError"
+      script << "    end\n"
+      script << "  end\n"
+      script << "end\n"
+      plugin_path = create_plugin_file('in_crashing.rb', script)
+
+      conf = <<CONF
+<source>
+  @type crashing
+  @id dummy
+  @label @dummydata
+  tag dummy
+  dummy {"message": "yay!"}
+</source>
+<label @dummydata>
+  <match dummy>
+    @type null
+    @id   blackhole
+  </match>
+</label>
+CONF
+      conf_path = create_conf_file('crashing_plugin.conf', conf)
+      assert File.exist?(conf_path)
+
+      assert_fluentd_fails_to_start(
+        create_cmdline(conf_path, "-p", File.dirname(plugin_path)),
+        'unexpected error error_class=Fluent::UnrecoverableError error="an unrecoverable error occurs in Fluentd process"',
+      )
+    end
+  end
+
+  sub_test_case 'configured to run 2 workers' do
+    setup do
+      @root_path = File.join(TMP_DIR, "rootpath")
+      FileUtils.rm_rf(@root_path)
+      FileUtils.mkdir_p(@root_path)
+    end
+
+    test 'success to start the number of workers specified in configuration' do
+      conf = <<CONF
+<system>
+  workers 2
+  root_dir #{@root_path}
+</system>
+<source>
+  @type dummy
+  @id dummy
+  @label @dummydata
+  tag dummy
+  dummy {"message": "yay!"}
+</source>
+<label @dummydata>
+  <match dummy>
+    @type null
+    @id   blackhole
+  </match>
+</label>
+CONF
+      conf_path = create_conf_file('workers1.conf', conf)
+      assert Dir.exist?(@root_path)
+
+      assert_log_matches(
+        create_cmdline(conf_path),
+        "#0 fluentd worker is now running worker=0",
+        "#1 fluentd worker is now running worker=1"
+      )
+    end
+
+    test 'success to start the number of workers specified by command line option' do
+      conf = <<CONF
+<system>
+  root_dir #{@root_path}
+</system>
+<source>
+  @type dummy
+  @id dummy
+  @label @dummydata
+  tag dummy
+  dummy {"message": "yay!"}
+</source>
+<label @dummydata>
+  <match dummy>
+    @type null
+    @id   blackhole
+  </match>
+</label>
+CONF
+      conf_path = create_conf_file('workers2.conf', conf)
+      assert_log_matches(
+        create_cmdline(conf_path, '--workers', '2'),
+        "#0 fluentd worker is now running worker=0",
+        "#1 fluentd worker is now running worker=1"
+      )
+    end
+
+    test 'failed to start workers when configured plugins do not support multi worker configuration' do
+      script =  "require 'fluent/plugin/input'\n"
+      script << "module Fluent::Plugin\n"
+      script << "  class SingleInput < Input\n"
+      script << "    Fluent::Plugin.register_input('single', self)\n"
+      script << "    def multi_workers_ready?\n"
+      script << "      false\n"
+      script << "    end\n"
+      script << "  end\n"
+      script << "end\n"
+      plugin_path = create_plugin_file('in_single.rb', script)
+
+      conf = <<CONF
+<system>
+  workers 2
+</system>
+<source>
+  @type single
+  @id single
+  @label @dummydata
+</source>
+<label @dummydata>
+  <match dummy>
+    @type null
+    @id   blackhole
+  </match>
+</label>
+CONF
+      conf_path = create_conf_file('workers_invalid1.conf', conf)
+      assert_fluentd_fails_to_start(
+        create_cmdline(conf_path, "-p", File.dirname(plugin_path)),
+        "Plugin 'single' does not support multi workers configuration (Fluent::Plugin::SingleInput)",
+      )
+    end
+
+    test 'failed to start workers when file buffer is configured in non-workers way' do
+      conf = <<CONF
+<system>
+  workers 2
+</system>
+<source>
+  @type single
+  @id single
+  @label @dummydata
+</source>
+<label @dummydata>
+  <match dummy>
+    @type null
+    @id   blackhole
+    <buffer>
+      @type file
+      path #{File.join(@root_path, "buf", "file.*.log")}
+    </buffer>
+  </match>
+</label>
+CONF
+      conf_path = create_conf_file('workers_invalid2.conf', conf)
+      assert_fluentd_fails_to_start(
+        create_cmdline(conf_path),
+        "[blackhole] file buffer with multi workers should be configured to use directory 'path', or system root_dir and plugin id",
+        "config error file=\"#{conf_path}\" error_class=Fluent::ConfigError error=\"Plugin 'file' does not support multi workers configuration (Fluent::Plugin::FileBuffer)\"",
+      )
+    end
+  end
+end