Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support @include/include directive for spaces included path. Fix #2485 #2780

Merged
merged 3 commits into from
Jan 20, 2020
Merged

Support @include/include directive for spaces included path. Fix #2485 #2780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aacecdf
Support @include/include directive for spaces included path. Fix #2485
cosmo0920 Jan 17, 2020
a5fa046
Use uri.gsub(' ', '+') method instead of URI.encode_www_form_components
cosmo0920 Jan 17, 2020
cd67858
Add a comment which describes why we use String#gsub to replace spaces
cosmo0920 Jan 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions lib/fluent/config/v1_parser.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,11 +147,13 @@ def parse_include(attrs, elems)
end

def eval_include(attrs, elems, uri)
u = URI.parse(uri)
if u.scheme == 'file' || (!u.scheme.nil? && u.scheme.length == 1) || u.path == uri # file path
# replace space(s)(' ') with '+' to prevent invalid uri due to space(s).
# See: https://github.com/fluent/fluentd/pull/2780#issuecomment-576081212
u = URI.parse(uri.gsub(/ /, '+'))
if u.scheme == 'file' || (!u.scheme.nil? && u.scheme.length == 1) || u.path == uri.gsub(/ /, '+') # file path
# When the Windows absolute path then u.scheme.length == 1
# e.g. C:
path = u.path
path = URI.decode_www_form_component(u.path)
if path[0] != ?/
pattern = File.expand_path("#{@include_basepath}/#{path}")
else
Expand Down
35 changes: 19 additions & 16 deletions test/config/test_config_parser.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,65 +362,68 @@ def test_parse_error(data)
# port from test_config.rb
sub_test_case '@include parsing' do
TMP_DIR = File.dirname(__FILE__) + "/tmp/v1_config#{ENV['TEST_ENV_NUMBER']}"
TMP_DIR_WITH_SPACES = File.dirname(__FILE__) + "/tmp/folder with spaces/v1_config#{ENV['TEST_ENV_NUMBER']}"

def write_config(path, data)
FileUtils.mkdir_p(File.dirname(path))
File.open(path, "w") { |f| f.write data }
end

def prepare_config
write_config "#{TMP_DIR}/config_test_1.conf", %[
def prepare_config(tmp_dir)
write_config "#{tmp_dir}/config_test_1.conf", %[
k1 root_config
include dir/config_test_2.conf #
@include #{TMP_DIR}/config_test_4.conf
include file://#{TMP_DIR}/config_test_5.conf
@include #{tmp_dir}/config_test_4.conf
include file://#{tmp_dir}/config_test_5.conf
@include config.d/*.conf
]
write_config "#{TMP_DIR}/dir/config_test_2.conf", %[
write_config "#{tmp_dir}/dir/config_test_2.conf", %[
k2 relative_path_include
@include ../config_test_3.conf
]
write_config "#{TMP_DIR}/config_test_3.conf", %[
write_config "#{tmp_dir}/config_test_3.conf", %[
k3 relative_include_in_included_file
]
write_config "#{TMP_DIR}/config_test_4.conf", %[
write_config "#{tmp_dir}/config_test_4.conf", %[
k4 absolute_path_include
]
write_config "#{TMP_DIR}/config_test_5.conf", %[
write_config "#{tmp_dir}/config_test_5.conf", %[
k5 uri_include
]
write_config "#{TMP_DIR}/config.d/config_test_6.conf", %[
write_config "#{tmp_dir}/config.d/config_test_6.conf", %[
k6 wildcard_include_1
<elem1 name>
include normal_parameter
</elem1>
]
write_config "#{TMP_DIR}/config.d/config_test_7.conf", %[
write_config "#{tmp_dir}/config.d/config_test_7.conf", %[
k7 wildcard_include_2
]
write_config "#{TMP_DIR}/config.d/config_test_8.conf", %[
write_config "#{tmp_dir}/config.d/config_test_8.conf", %[
<elem2 name>
@include ../dir/config_test_9.conf
</elem2>
]
write_config "#{TMP_DIR}/dir/config_test_9.conf", %[
write_config "#{tmp_dir}/dir/config_test_9.conf", %[
k9 embedded
<elem3 name>
nested nested_value
include hoge
</elem3>
]
write_config "#{TMP_DIR}/config.d/00_config_test_8.conf", %[
write_config "#{tmp_dir}/config.d/00_config_test_8.conf", %[
k8 wildcard_include_3
<elem4 name>
include normal_parameter
</elem4>
]
end

test 'parses @include / include correctly' do
prepare_config
c = read_config("#{TMP_DIR}/config_test_1.conf")
data("TMP_DIR without spaces" => TMP_DIR,
"TMP_DIR with spaces" => TMP_DIR_WITH_SPACES)
test 'parses @include / include correctly' do |data|
prepare_config(data)
c = read_config("#{data}/config_test_1.conf")
assert_equal('root_config', c['k1'])
assert_equal('relative_path_include', c['k2'])
assert_equal('relative_include_in_included_file', c['k3'])
Expand Down