require_relative '../helper'
require 'fluent/test/driver/output'
require 'fluent/plugin/out_forward'
require 'flexmock/test_unit'
require 'fluent/test/driver/input'
require 'fluent/plugin/in_forward'
class ForwardOutputTest < Test::Unit::TestCase
def setup
Fluent::Test.setup
FileUtils.rm_rf(TMP_DIR)
FileUtils.mkdir_p(TMP_DIR)
@d = nil
end
def teardown
@d.instance_shutdown if @d
end
TMP_DIR = File.join(__dir__, "../tmp/out_forward#{ENV['TEST_ENV_NUMBER']}")
TARGET_HOST = '127.0.0.1'
TARGET_PORT = unused_port
CONFIG = %[
send_timeout 51
heartbeat_type udp
name test
host #{TARGET_HOST}
port #{TARGET_PORT}
]
TARGET_CONFIG = %[
port #{TARGET_PORT}
bind #{TARGET_HOST}
]
def create_driver(conf=CONFIG)
Fluent::Test::Driver::Output.new(Fluent::Plugin::ForwardOutput) {
attr_reader :response_chunk_ids, :exceptions, :sent_chunk_ids
def initialize
super
@sent_chunk_ids = []
@response_chunk_ids = []
@exceptions = []
end
def try_write(chunk)
retval = super
@sent_chunk_ids << chunk.unique_id
retval
end
def read_ack_from_sock(sock, unpacker)
retval = super
@response_chunk_ids << retval
retval
rescue => e
@exceptions << e
raise e
end
}.configure(conf)
end
test 'configure' do
@d = d = create_driver(%[
self_hostname localhost
name test
host #{TARGET_HOST}
port #{TARGET_PORT}
])
nodes = d.instance.nodes
assert_equal 60, d.instance.send_timeout
assert_equal :transport, d.instance.heartbeat_type
assert_equal 1, nodes.length
node = nodes.first
assert_equal "test", node.name
assert_equal '127.0.0.1', node.host
assert_equal TARGET_PORT, node.port
end
test 'configure_traditional' do
@d = d = create_driver(<
name test
host #{TARGET_HOST}
port #{TARGET_PORT}
buffer_chunk_limit 10m
EOL
instance = d.instance
assert instance.chunk_key_tag
assert !instance.chunk_key_time
assert_equal [], instance.chunk_keys
assert{ instance.buffer.is_a?(Fluent::Plugin::MemoryBuffer) }
assert_equal( 10*1024*1024, instance.buffer.chunk_limit_size )
end
test 'configure_udp_heartbeat' do
@d = d = create_driver(CONFIG + "\nheartbeat_type udp")
assert_equal :udp, d.instance.heartbeat_type
end
test 'configure_none_heartbeat' do
@d = d = create_driver(CONFIG + "\nheartbeat_type none")
assert_equal :none, d.instance.heartbeat_type
end
test 'configure_expire_dns_cache' do
@d = d = create_driver(CONFIG + "\nexpire_dns_cache 5")
assert_equal 5, d.instance.expire_dns_cache
end
test 'configure_dns_round_robin udp' do
assert_raise(Fluent::ConfigError) do
create_driver(CONFIG + "\nheartbeat_type udp\ndns_round_robin true")
end
end
test 'configure_dns_round_robin transport' do
@d = d = create_driver(CONFIG + "\nheartbeat_type transport\ndns_round_robin true")
assert_equal true, d.instance.dns_round_robin
end
test 'configure_dns_round_robin none' do
@d = d = create_driver(CONFIG + "\nheartbeat_type none\ndns_round_robin true")
assert_equal true, d.instance.dns_round_robin
end
test 'configure_no_server' do
assert_raise(Fluent::ConfigError, 'forward output plugin requires at least one is required') do
create_driver('')
end
end
test 'configure with ignore_network_errors_at_startup' do
normal_conf = config_element('match', '**', {}, [
config_element('server', '', {'name' => 'test', 'host' => 'unexisting.yaaaaaaaaaaaaaay.host.example.com'})
])
assert_raise SocketError do
create_driver(normal_conf)
end
conf = config_element('match', '**', {'ignore_network_errors_at_startup' => 'true'}, [
config_element('server', '', {'name' => 'test', 'host' => 'unexisting.yaaaaaaaaaaaaaay.host.example.com'})
])
@d = d = create_driver(conf)
expected_log = "failed to resolve node name when configured"
expected_detail = 'server="test" error_class=SocketError'
logs = d.logs
assert{ logs.any?{|log| log.include?(expected_log) && log.include?(expected_detail) } }
end
data('CA cert' => 'tls_ca_cert_path',
'non CA cert' => 'tls_cert_path')
test 'configure tls_cert_path/tls_ca_cert_path' do |param|
dummy_cert_path = File.join(TMP_DIR, "dummy_cert.pem")
FileUtils.touch(dummy_cert_path)
conf = %[
send_timeout 5
transport tls
tls_insecure_mode true
#{param} #{dummy_cert_path}
host #{TARGET_HOST}
port #{TARGET_PORT}
]
@d = d = create_driver(conf)
# In the plugin, tls_ca_cert_path is used for both cases
assert_equal([dummy_cert_path], d.instance.tls_ca_cert_path)
end
test 'compress_default_value' do
@d = d = create_driver
assert_equal :text, d.instance.compress
node = d.instance.nodes.first
assert_equal :text, node.instance_variable_get(:@compress)
end
test 'set_compress_is_gzip' do
@d = d = create_driver(CONFIG + %[compress gzip])
assert_equal :gzip, d.instance.compress
assert_equal :gzip, d.instance.buffer.compress
node = d.instance.nodes.first
assert_equal :gzip, node.instance_variable_get(:@compress)
end
test 'set_compress_is_gzip_in_buffer_section' do
mock = flexmock($log)
mock.should_receive(:log).with("buffer is compressed. If you also want to save the bandwidth of a network, Add `compress` configuration in ")
@d = d = create_driver(CONFIG + %[
type memory
compress gzip
])
assert_equal :text, d.instance.compress
assert_equal :gzip, d.instance.buffer.compress
node = d.instance.nodes.first
assert_equal :text, node.instance_variable_get(:@compress)
end
test 'phi_failure_detector disabled' do
@d = d = create_driver(CONFIG + %[phi_failure_detector false \n phi_threshold 0])
node = d.instance.nodes.first
stub(node.failure).phi { raise 'Should not be called' }
node.tick
assert_equal node.available, true
end
test 'phi_failure_detector enabled' do
@d = d = create_driver(CONFIG + %[phi_failure_detector true \n phi_threshold 0])
node = d.instance.nodes.first
node.tick
assert_equal node.available, false
end
test 'require_ack_response is disabled in default' do
@d = d = create_driver(CONFIG)
assert_equal false, d.instance.require_ack_response
assert_equal 190, d.instance.ack_response_timeout
end
test 'require_ack_response can be enabled' do
@d = d = create_driver(CONFIG + %[
require_ack_response true
ack_response_timeout 2s
])
assert d.instance.require_ack_response
assert_equal 2, d.instance.ack_response_timeout
end
test 'verify_connection_at_startup is disabled in default' do
@d = d = create_driver(CONFIG)
assert_false d.instance.verify_connection_at_startup
end
test 'verify_connection_at_startup can be enabled' do
@d = d = create_driver(CONFIG + %[
verify_connection_at_startup true
])
assert_true d.instance.verify_connection_at_startup
end
test 'send tags in str (utf-8 strings)' do
target_input_driver = create_target_input_driver
@d = d = create_driver(CONFIG + %[flush_interval 1s])
time = event_time("2011-01-02 13:14:15 UTC")
tag_in_utf8 = "test.utf8".encode("utf-8")
tag_in_ascii = "test.ascii".encode("ascii-8bit")
emit_events = [
[tag_in_utf8, time, {"a" => 1}],
[tag_in_ascii, time, {"a" => 2}],
]
target_input_driver.run(expect_records: 2) do
d.run do
emit_events.each do |tag, t, record|
d.feed(tag, t, record)
end
end
end
events = target_input_driver.events
assert_equal_event_time(time, events[0][1])
assert_equal ['test.utf8', time, emit_events[0][2]], events[0]
assert_equal Encoding::UTF_8, events[0][0].encoding
assert_equal_event_time(time, events[1][1])
assert_equal ['test.ascii', time, emit_events[1][2]], events[1]
assert_equal Encoding::UTF_8, events[1][0].encoding
assert_empty d.instance.exceptions
end
test 'send_with_time_as_integer' do
target_input_driver = create_target_input_driver
@d = d = create_driver(CONFIG + %[flush_interval 1s])
time = event_time("2011-01-02 13:14:15 UTC")
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.run(expect_records: 2) do
d.run(default_tag: 'test') do
records.each do |record|
d.feed(time, record)
end
end
end
events = target_input_driver.events
assert_equal_event_time(time, events[0][1])
assert_equal ['test', time, records[0]], events[0]
assert_equal_event_time(time, events[1][1])
assert_equal ['test', time, records[1]], events[1]
assert_empty d.instance.exceptions
end
test 'send_without_time_as_integer' do
target_input_driver = create_target_input_driver
@d = d = create_driver(CONFIG + %[
flush_interval 1s
time_as_integer false
])
time = event_time("2011-01-02 13:14:15 UTC")
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.run(expect_records: 2) do
d.run(default_tag: 'test') do
records.each do |record|
d.feed(time, record)
end
end
end
events = target_input_driver.events
assert_equal_event_time(time, events[0][1])
assert_equal ['test', time, records[0]], events[0]
assert_equal_event_time(time, events[1][1])
assert_equal ['test', time, records[1]], events[1]
assert_empty d.instance.exceptions
end
test 'send_comprssed_message_pack_stream_if_compress_is_gzip' do
target_input_driver = create_target_input_driver
@d = d = create_driver(CONFIG + %[
flush_interval 1s
compress gzip
])
time = event_time('2011-01-02 13:14:15 UTC')
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.run(expect_records: 2) do
d.run(default_tag: 'test') do
records.each do |record|
d.feed(time, record)
end
end
end
event_streams = target_input_driver.event_streams
assert_true event_streams[0][1].is_a?(Fluent::CompressedMessagePackEventStream)
events = target_input_driver.events
assert_equal ['test', time, records[0]], events[0]
assert_equal ['test', time, records[1]], events[1]
end
test 'send_to_a_node_supporting_responses' do
target_input_driver = create_target_input_driver
@d = d = create_driver(CONFIG + %[flush_interval 1s])
time = event_time("2011-01-02 13:14:15 UTC")
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.run(expect_records: 2) do
d.run(default_tag: 'test') do
records.each do |record|
d.feed(time, record)
end
end
end
events = target_input_driver.events
assert_equal ['test', time, records[0]], events[0]
assert_equal ['test', time, records[1]], events[1]
assert_empty d.instance.response_chunk_ids # not attempt to receive responses, so it's empty
assert_empty d.instance.exceptions
end
test 'send_to_a_node_not_supporting_responses' do
target_input_driver = create_target_input_driver
@d = d = create_driver(CONFIG + %[flush_interval 1s])
time = event_time("2011-01-02 13:14:15 UTC")
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.run(expect_records: 2) do
d.run(default_tag: 'test') do
records.each do |record|
d.feed(time, record)
end
end
end
events = target_input_driver.events
assert_equal ['test', time, records[0]], events[0]
assert_equal ['test', time, records[1]], events[1]
assert_empty d.instance.response_chunk_ids # not attempt to receive responses, so it's empty
assert_empty d.instance.exceptions
end
test 'a node supporting responses' do
target_input_driver = create_target_input_driver
@d = d = create_driver(CONFIG + %[
require_ack_response true
ack_response_timeout 1s
flush_mode immediate
retry_type periodic
retry_wait 30s
flush_at_shutdown false # suppress errors in d.instance_shutdown
])
time = event_time("2011-01-02 13:14:15 UTC")
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.run(expect_records: 2) do
d.end_if{ d.instance.response_chunk_ids.length > 0 }
d.run(default_tag: 'test', wait_flush_completion: false, shutdown: false) do
d.feed([[time, records[0]], [time,records[1]]])
end
end
events = target_input_driver.events
assert_equal ['test', time, records[0]], events[0]
assert_equal ['test', time, records[1]], events[1]
assert_equal 1, d.instance.response_chunk_ids.size
assert_equal d.instance.sent_chunk_ids.first, d.instance.response_chunk_ids.first
assert_empty d.instance.exceptions
end
data('ack true' => true,
'ack false' => false)
test 'TLS transport and ack parameter combination' do |ack|
omit "TLS and 'ack false' always fails on AppVeyor. Need to debug" if Fluent.windows? && !ack
input_conf = TARGET_CONFIG + %[
insecure true
]
target_input_driver = create_target_input_driver(conf: input_conf)
output_conf = %[
send_timeout 5
require_ack_response #{ack}
transport tls
tls_insecure_mode true
host #{TARGET_HOST}
port #{TARGET_PORT}
#flush_mode immediate
flush_interval 0s
flush_at_shutdown false # suppress errors in d.instance_shutdown
]
@d = d = create_driver(output_conf)
time = event_time("2011-01-02 13:14:15 UTC")
records = [{"a" => 1}, {"a" => 2}]
target_input_driver.run(expect_records: 2, timeout: 3) do
d.run(default_tag: 'test', wait_flush_completion: false, shutdown: false) do
records.each do |record|
d.feed(time, record)
end
end
end
events = target_input_driver.events
assert{ events != [] }
assert_equal(['test', time, records[0]], events[0])
assert_equal(['test', time, records[1]], events[1])
end
test 'a destination node not supporting responses by just ignoring' do
target_input_driver = create_target_input_driver(response_stub: ->(_option) { nil }, disconnect: false)
@d = d = create_driver(CONFIG + %[
require_ack_response true
ack_response_timeout 1s
flush_mode immediate
retry_type periodic
retry_wait 30s
flush_at_shutdown false # suppress errors in d.instance_shutdown
flush_thread_interval 30s
])
node = d.instance.nodes.first
delayed_commit_timeout_value = nil
time = event_time("2011-01-02 13:14:15 UTC")
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.end_if{ d.instance.rollback_count > 0 }
target_input_driver.end_if{ !node.available }
target_input_driver.run(expect_records: 2, timeout: 25) do
d.run(default_tag: 'test', timeout: 20, wait_flush_completion: false, shutdown: false, flush: false) do
delayed_commit_timeout_value = d.instance.delayed_commit_timeout
d.feed([[time, records[0]], [time,records[1]]])
end
end
assert_equal (1 + 2), delayed_commit_timeout_value
events = target_input_driver.events
assert_equal ['test', time, records[0]], events[0]
assert_equal ['test', time, records[1]], events[1]
assert{ d.instance.rollback_count > 0 }
logs = d.instance.log.logs
assert{ logs.any?{|log| log.include?("no response from node. regard it as unavailable.") } }
end
test 'a destination node not supporting responses by disconnection' do
target_input_driver = create_target_input_driver(response_stub: ->(_option) { nil }, disconnect: true)
@d = d = create_driver(CONFIG + %[
require_ack_response true
ack_response_timeout 5s
flush_mode immediate
retry_type periodic
retry_wait 30s
flush_at_shutdown false # suppress errors in d.instance_shutdown
flush_thread_interval 30s
])
node = d.instance.nodes.first
delayed_commit_timeout_value = nil
time = event_time("2011-01-02 13:14:15 UTC")
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.end_if{ d.instance.rollback_count > 0 }
target_input_driver.end_if{ !node.available }
target_input_driver.run(expect_records: 2, timeout: 25) do
d.run(default_tag: 'test', timeout: 20, wait_flush_completion: false, shutdown: false, flush: false) do
delayed_commit_timeout_value = d.instance.delayed_commit_timeout
d.feed([[time, records[0]], [time,records[1]]])
end
end
assert_equal (5 + 2), delayed_commit_timeout_value
events = target_input_driver.events
assert_equal ['test', time, records[0]], events[0]
assert_equal ['test', time, records[1]], events[1]
assert{ d.instance.rollback_count > 0 }
logs = d.instance.log.logs
assert{ logs.any?{|log| log.include?("no response from node. regard it as unavailable.") } }
end
test 'authentication_with_shared_key' do
input_conf = TARGET_CONFIG + %[
self_hostname in.localhost
shared_key fluentd-sharedkey
host 127.0.0.1
]
target_input_driver = create_target_input_driver(conf: input_conf)
output_conf = %[
send_timeout 51
self_hostname localhost
shared_key fluentd-sharedkey
name test
host #{TARGET_HOST}
port #{TARGET_PORT}
shared_key fluentd-sharedkey
]
@d = d = create_driver(output_conf)
time = event_time("2011-01-02 13:14:15 UTC")
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.run(expect_records: 2, timeout: 15) do
d.run(default_tag: 'test') do
records.each do |record|
d.feed(time, record)
end
end
end
events = target_input_driver.events
assert{ events != [] }
assert_equal(['test', time, records[0]], events[0])
assert_equal(['test', time, records[1]], events[1])
end
test 'authentication_with_user_auth' do
input_conf = TARGET_CONFIG + %[
self_hostname in.localhost
shared_key fluentd-sharedkey
user_auth true
username fluentd
password fluentd
host 127.0.0.1
]
target_input_driver = create_target_input_driver(conf: input_conf)
output_conf = %[
send_timeout 51
self_hostname localhost
shared_key fluentd-sharedkey
name test
host #{TARGET_HOST}
port #{TARGET_PORT}
shared_key fluentd-sharedkey
username fluentd
password fluentd
]
@d = d = create_driver(output_conf)
time = event_time("2011-01-02 13:14:15 UTC")
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.run(expect_records: 2, timeout: 15) do
d.run(default_tag: 'test') do
records.each do |record|
d.feed(time, record)
end
end
end
events = target_input_driver.events
assert{ events != [] }
assert_equal(['test', time, records[0]], events[0])
assert_equal(['test', time, records[1]], events[1])
end
# This test is not 100% but test failed with previous Node implementation which has race condition
test 'Node with security is thread-safe on multi threads' do
input_conf = TARGET_CONFIG + %[
self_hostname in.localhost
shared_key fluentd-sharedkey
host 127.0.0.1
]
target_input_driver = create_target_input_driver(conf: input_conf)
output_conf = %[
send_timeout 51
self_hostname localhost
shared_key fluentd-sharedkey
name test
host #{TARGET_HOST}
port #{TARGET_PORT}
shared_key fluentd-sharedkey
]
@d = d = create_driver(output_conf)
chunk = Fluent::Plugin::Buffer::MemoryChunk.new(Fluent::Plugin::Buffer::Metadata.new(nil, nil, nil))
target_input_driver.run(timeout: 15) do
d.run(shutdown: false) do
node = d.instance.nodes.first
arr = []
4.times {
arr << Thread.new {
node.send_data('test', chunk) rescue nil
}
}
arr.each { |a| a.join }
end
end
logs = d.logs
assert_false(logs.any? { |log| log.include?("invalid format for PONG message") || log.include?("shared key mismatch") }, "'#{logs.last.strip}' happens")
end
def create_target_input_driver(response_stub: nil, disconnect: false, conf: TARGET_CONFIG)
require 'fluent/plugin/in_forward'
# TODO: Support actual TCP heartbeat test
Fluent::Test::Driver::Input.new(Fluent::Plugin::ForwardInput) {
if response_stub.nil?
# do nothing because in_forward responds for ack option in default
else
define_method(:response) do |options|
return response_stub.(options)
end
end
}.configure(conf)
end
test 'heartbeat_type_none' do
@d = d = create_driver(CONFIG + "\nheartbeat_type none")
node = d.instance.nodes.first
assert_equal Fluent::Plugin::ForwardOutput::NoneHeartbeatNode, node.class
d.instance_start
assert_nil d.instance.instance_variable_get(:@loop) # no HeartbeatHandler, or HeartbeatRequestTimer
assert_nil d.instance.instance_variable_get(:@thread) # no HeartbeatHandler, or HeartbeatRequestTimer
stub(node.failure).phi { raise 'Should not be called' }
node.tick
assert_equal node.available, true
end
test 'heartbeat_type_udp' do
@d = d = create_driver(CONFIG + "\nheartbeat_type udp")
d.instance_start
usock = d.instance.instance_variable_get(:@usock)
servers = d.instance.instance_variable_get(:@_servers)
timers = d.instance.instance_variable_get(:@_timers)
assert_equal Fluent::PluginHelper::Socket::WrappedSocket::UDP, usock.class
assert_kind_of UDPSocket, usock
assert servers.find{|s| s.title == :out_forward_heartbeat_receiver }
assert timers.include?(:out_forward_heartbeat_request)
mock(usock).send("\0", 0, Socket.pack_sockaddr_in(TARGET_PORT, '127.0.0.1')).once
d.instance.send(:on_timer)
end
test 'acts_as_secondary' do
i = Fluent::Plugin::ForwardOutput.new
conf = config_element(
'match',
'primary.**',
{'@type' => 'forward'},
[
config_element('server', '', {'host' => '127.0.0.1'}),
config_element('secondary', '', {}, [
config_element('server', '', {'host' => '192.168.1.2'}),
config_element('server', '', {'host' => '192.168.1.3'})
]),
]
)
assert_nothing_raised do
i.configure(conf)
end
end
sub_test_case 'verify_connection_at_startup' do
test 'nodes are not available' do
@d = d = create_driver(CONFIG + %[
verify_connection_at_startup true
flush_mode immediate
retry_type periodic
retry_wait 30s
flush_at_shutdown false # suppress errors in d.instance_shutdown
])
assert_raise Fluent::UnrecoverableError do
d.instance_start
end
d.instance_shutdown
end
test 'nodes_shared_key_miss_match' do
input_conf = TARGET_CONFIG + %[
self_hostname in.localhost
shared_key fluentd-sharedkey
]
target_input_driver = create_target_input_driver(conf: input_conf)
output_conf = %[
send_timeout 30
heartbeat_type transport
transport tls
tls_verify_hostname false
verify_connection_at_startup true
require_ack_response true
ack_response_timeout 5s
self_hostname localhost
shared_key key_miss_match
flush_mode immediate
retry_type periodic
retry_wait 30s
flush_at_shutdown false # suppress errors in d.instance_shutdown
flush_thread_interval 31s
host #{TARGET_HOST}
port #{TARGET_PORT}
]
@d = d = create_driver(output_conf)
target_input_driver.run(expect_records: 1, timeout: 15) do
assert_raise Fluent::UnrecoverableError do
d.instance_start
end
d.instance_shutdown
end
end
test 'nodes_shared_key_match' do
input_conf = TARGET_CONFIG + %[
self_hostname in.localhost
shared_key fluentd-sharedkey
host 127.0.0.1
]
target_input_driver = create_target_input_driver(conf: input_conf)
output_conf = %[
send_timeout 51
verify_connection_at_startup true
self_hostname localhost
shared_key fluentd-sharedkey
name test
host #{TARGET_HOST}
port #{TARGET_PORT}
shared_key fluentd-sharedkey
]
@d = d = create_driver(output_conf)
time = event_time("2011-01-02 13:14:15 UTC")
records = [
{"a" => 1},
{"a" => 2}
]
target_input_driver.run(expect_records: 2, timeout: 15) do
d.run(default_tag: 'test') do
records.each do |record|
d.feed(time, record)
end
end
end
events = target_input_driver.events
assert{ events != [] }
assert_equal(['test', time, records[0]], events[0])
assert_equal(['test', time, records[1]], events[1])
end
end
end