Skip to content

Commit cd71a4b

Browse files
andselandsel
authored
Rename Java settings classes to <Name>Setting (#18171)
Minor change which fix Java settings class named to pattern <Name>Setting.
1 parent 08db1d1 commit cd71a4b

27 files changed

+185
-186
lines changed

‎logstash-core/lib/logstash/environment.rb‎

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -38,76 +38,76 @@ def self.as_java_range(r)
3838
end
3939

4040
[
41-
Setting::Boolean.new("allow_superuser", false),
42-
Setting::SettingString.new("node.name", Socket.gethostname),
43-
Setting::SettingNullableString.new("path.config", nil, false),
41+
Setting::BooleanSetting.new("allow_superuser", false),
42+
Setting::StringSetting.new("node.name", Socket.gethostname),
43+
Setting::NullableStringSetting.new("path.config", nil, false),
4444
Setting::WritableDirectory.new("path.data", ::File.join(LogStash::Environment::LOGSTASH_HOME, "data")),
45-
Setting::SettingNullableString.new("config.string", nil, false),
46-
Setting::Boolean.new("config.test_and_exit", false),
47-
Setting::Boolean.new("config.reload.automatic", false),
45+
Setting::NullableStringSetting.new("config.string", nil, false),
46+
Setting::BooleanSetting.new("config.test_and_exit", false),
47+
Setting::BooleanSetting.new("config.reload.automatic", false),
4848
Setting::TimeValue.new("config.reload.interval", "3s"), # in seconds
49-
Setting::Boolean.new("config.support_escapes", false),
50-
Setting::SettingString.new("config.field_reference.escape_style", "none", true, %w(none percent ampersand)),
51-
Setting::Boolean.new("metric.collect", true),
52-
Setting::SettingString.new("pipeline.id", "main"),
53-
Setting::Boolean.new("pipeline.system", false),
54-
Setting::SettingPositiveInteger.new("pipeline.workers", LogStash::Config::CpuCoreStrategy.maximum),
55-
Setting::SettingPositiveInteger.new("pipeline.batch.size", 125),
56-
Setting::SettingNumeric.new("pipeline.batch.delay", 50), # in milliseconds
57-
Setting::Boolean.new("pipeline.unsafe_shutdown", false),
58-
Setting::Boolean.new("pipeline.reloadable", true),
59-
Setting::Boolean.new("pipeline.plugin_classloaders", false),
60-
Setting::Boolean.new("pipeline.separate_logs", false),
49+
Setting::BooleanSetting.new("config.support_escapes", false),
50+
Setting::StringSetting.new("config.field_reference.escape_style", "none", true, %w(none percent ampersand)),
51+
Setting::BooleanSetting.new("metric.collect", true),
52+
Setting::StringSetting.new("pipeline.id", "main"),
53+
Setting::BooleanSetting.new("pipeline.system", false),
54+
Setting::PositiveIntegerSetting.new("pipeline.workers", LogStash::Config::CpuCoreStrategy.maximum),
55+
Setting::PositiveIntegerSetting.new("pipeline.batch.size", 125),
56+
Setting::NumericSetting.new("pipeline.batch.delay", 50), # in milliseconds
57+
Setting::BooleanSetting.new("pipeline.unsafe_shutdown", false),
58+
Setting::BooleanSetting.new("pipeline.reloadable", true),
59+
Setting::BooleanSetting.new("pipeline.plugin_classloaders", false),
60+
Setting::BooleanSetting.new("pipeline.separate_logs", false),
6161
Setting::CoercibleString.new("pipeline.ordered", "auto", true, ["auto", "true", "false"]),
6262
Setting::CoercibleString.new("pipeline.ecs_compatibility", "v8", true, %w(disabled v1 v8)),
6363
Setting.new("path.plugins", Array, []),
64-
Setting::SettingNullableString.new("interactive", nil, false),
65-
Setting::Boolean.new("config.debug", false),
66-
Setting::SettingString.new("log.level", "info", true, ["fatal", "error", "warn", "debug", "info", "trace"]),
67-
Setting::Boolean.new("version", false),
68-
Setting::Boolean.new("help", false),
69-
Setting::Boolean.new("enable-local-plugin-development", false),
70-
Setting::SettingString.new("log.format", "plain", true, ["json", "plain"]),
71-
Setting::Boolean.new("log.format.json.fix_duplicate_message_fields", true),
72-
Setting::Boolean.new("api.enabled", true),
73-
Setting::SettingString.new("api.http.host", "127.0.0.1"),
64+
Setting::NullableStringSetting.new("interactive", nil, false),
65+
Setting::BooleanSetting.new("config.debug", false),
66+
Setting::StringSetting.new("log.level", "info", true, ["fatal", "error", "warn", "debug", "info", "trace"]),
67+
Setting::BooleanSetting.new("version", false),
68+
Setting::BooleanSetting.new("help", false),
69+
Setting::BooleanSetting.new("enable-local-plugin-development", false),
70+
Setting::StringSetting.new("log.format", "plain", true, ["json", "plain"]),
71+
Setting::BooleanSetting.new("log.format.json.fix_duplicate_message_fields", true),
72+
Setting::BooleanSetting.new("api.enabled", true),
73+
Setting::StringSetting.new("api.http.host", "127.0.0.1"),
7474
Setting::PortRangeSetting.new("api.http.port", 9600..9700),
75-
Setting::SettingString.new("api.environment", "production"),
76-
Setting::SettingString.new("api.auth.type", "none", true, %w(none basic)),
77-
Setting::SettingString.new("api.auth.basic.username", nil, false).nullable,
75+
Setting::StringSetting.new("api.environment", "production"),
76+
Setting::StringSetting.new("api.auth.type", "none", true, %w(none basic)),
77+
Setting::StringSetting.new("api.auth.basic.username", nil, false).nullable,
7878
Setting::Password.new("api.auth.basic.password", nil, false).nullable,
79-
Setting::SettingString.new("api.auth.basic.password_policy.mode", "WARN", true, %w[WARN ERROR]),
80-
Setting::SettingNumeric.new("api.auth.basic.password_policy.length.minimum", 8),
81-
Setting::SettingString.new("api.auth.basic.password_policy.include.upper", "REQUIRED", true, %w[REQUIRED OPTIONAL]),
82-
Setting::SettingString.new("api.auth.basic.password_policy.include.lower", "REQUIRED", true, %w[REQUIRED OPTIONAL]),
83-
Setting::SettingString.new("api.auth.basic.password_policy.include.digit", "REQUIRED", true, %w[REQUIRED OPTIONAL]),
84-
Setting::SettingString.new("api.auth.basic.password_policy.include.symbol", "OPTIONAL", true, %w[REQUIRED OPTIONAL]),
85-
Setting::Boolean.new("api.ssl.enabled", false),
79+
Setting::StringSetting.new("api.auth.basic.password_policy.mode", "WARN", true, %w[WARN ERROR]),
80+
Setting::NumericSetting.new("api.auth.basic.password_policy.length.minimum", 8),
81+
Setting::StringSetting.new("api.auth.basic.password_policy.include.upper", "REQUIRED", true, %w[REQUIRED OPTIONAL]),
82+
Setting::StringSetting.new("api.auth.basic.password_policy.include.lower", "REQUIRED", true, %w[REQUIRED OPTIONAL]),
83+
Setting::StringSetting.new("api.auth.basic.password_policy.include.digit", "REQUIRED", true, %w[REQUIRED OPTIONAL]),
84+
Setting::StringSetting.new("api.auth.basic.password_policy.include.symbol", "OPTIONAL", true, %w[REQUIRED OPTIONAL]),
85+
Setting::BooleanSetting.new("api.ssl.enabled", false),
8686
Setting::ExistingFilePath.new("api.ssl.keystore.path", nil, false).nullable,
8787
Setting::Password.new("api.ssl.keystore.password", nil, false).nullable,
8888
Setting::StringArray.new("api.ssl.supported_protocols", nil, true, %w[TLSv1 TLSv1.1 TLSv1.2 TLSv1.3]),
89-
Setting::SettingString.new("queue.type", "memory", true, ["persisted", "memory"]),
90-
Setting::Boolean.new("queue.drain", false),
89+
Setting::StringSetting.new("queue.type", "memory", true, ["persisted", "memory"]),
90+
Setting::BooleanSetting.new("queue.drain", false),
9191
Setting::Bytes.new("queue.page_capacity", "64mb"),
9292
Setting::Bytes.new("queue.max_bytes", "1024mb"),
93-
Setting::SettingNumeric.new("queue.max_events", 0), # 0 is unlimited
94-
Setting::SettingNumeric.new("queue.checkpoint.acks", 1024), # 0 is unlimited
95-
Setting::SettingNumeric.new("queue.checkpoint.writes", 1024), # 0 is unlimited
96-
Setting::SettingNumeric.new("queue.checkpoint.interval", 1000), # remove it for #17155
97-
Setting::Boolean.new("queue.checkpoint.retry", true),
98-
Setting::Boolean.new("dead_letter_queue.enable", false),
93+
Setting::NumericSetting.new("queue.max_events", 0), # 0 is unlimited
94+
Setting::NumericSetting.new("queue.checkpoint.acks", 1024), # 0 is unlimited
95+
Setting::NumericSetting.new("queue.checkpoint.writes", 1024), # 0 is unlimited
96+
Setting::NumericSetting.new("queue.checkpoint.interval", 1000), # remove it for #17155
97+
Setting::BooleanSetting.new("queue.checkpoint.retry", true),
98+
Setting::BooleanSetting.new("dead_letter_queue.enable", false),
9999
Setting::Bytes.new("dead_letter_queue.max_bytes", "1024mb"),
100-
Setting::SettingNumeric.new("dead_letter_queue.flush_interval", 5000),
101-
Setting::SettingString.new("dead_letter_queue.storage_policy", "drop_newer", true, ["drop_newer", "drop_older"]),
102-
Setting::SettingNullableString.new("dead_letter_queue.retain.age"), # example 5d
100+
Setting::NumericSetting.new("dead_letter_queue.flush_interval", 5000),
101+
Setting::StringSetting.new("dead_letter_queue.storage_policy", "drop_newer", true, ["drop_newer", "drop_older"]),
102+
Setting::NullableStringSetting.new("dead_letter_queue.retain.age"), # example 5d
103103
Setting::TimeValue.new("slowlog.threshold.warn", "-1"),
104104
Setting::TimeValue.new("slowlog.threshold.info", "-1"),
105105
Setting::TimeValue.new("slowlog.threshold.debug", "-1"),
106106
Setting::TimeValue.new("slowlog.threshold.trace", "-1"),
107-
Setting::SettingString.new("keystore.classname", "org.logstash.secret.store.backend.JavaKeyStore"),
108-
Setting::SettingString.new("keystore.file", ::File.join(::File.join(LogStash::Environment::LOGSTASH_HOME, "config"), "logstash.keystore"), false), # will be populated on
109-
Setting::SettingNullableString.new("monitoring.cluster_uuid"),
110-
Setting::SettingString.new("pipeline.buffer.type", "heap", true, ["direct", "heap"])
107+
Setting::StringSetting.new("keystore.classname", "org.logstash.secret.store.backend.JavaKeyStore"),
108+
Setting::StringSetting.new("keystore.file", ::File.join(::File.join(LogStash::Environment::LOGSTASH_HOME, "config"), "logstash.keystore"), false), # will be populated on
109+
Setting::NullableStringSetting.new("monitoring.cluster_uuid"),
110+
Setting::StringSetting.new("pipeline.buffer.type", "heap", true, ["direct", "heap"])
111111
# post_process
112112
].each {|setting| SETTINGS.register(setting) }
113113

‎logstash-core/lib/logstash/settings.rb‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -412,12 +412,11 @@ def coerce(value)
412412
end
413413
### Specific settings #####
414414

415-
java_import org.logstash.settings.Boolean
416-
java_import org.logstash.settings.SettingNumeric
415+
java_import org.logstash.settings.BooleanSetting
416+
java_import org.logstash.settings.NumericSetting
417417

418-
java_import org.logstash.settings.SettingInteger
419-
420-
java_import org.logstash.settings.SettingPositiveInteger
418+
java_import org.logstash.settings.IntegerSetting
419+
java_import org.logstash.settings.PositiveIntegerSetting
421420

422421
java_import org.logstash.settings.PortSetting # seems unused
423422

@@ -434,9 +433,9 @@ def validate(value)
434433
end
435434
end
436435

437-
java_import org.logstash.settings.SettingString
436+
java_import org.logstash.settings.StringSetting
438437

439-
java_import org.logstash.settings.SettingNullableString
438+
java_import org.logstash.settings.NullableStringSetting
440439

441440
class Password < Coercible
442441
def initialize(name, default = nil, strict = true)

‎logstash-core/lib/logstash/util/settings_helper.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ module LogStash::Util::SettingsHelper
3333
# The `path.settings` and `path.logs` can not be defined in "logstash/environment" since the `Environment::LOGSTASH_HOME` doesn't
3434
# exist unless launched via "bootstrap/environment"
3535
def self.pre_process
36-
LogStash::SETTINGS.register(LogStash::Setting::SettingString.new("path.settings", ::File.join(LogStash::Environment::LOGSTASH_HOME, "config")))
37-
LogStash::SETTINGS.register(LogStash::Setting::SettingString.new("path.logs", ::File.join(LogStash::Environment::LOGSTASH_HOME, "logs")))
36+
LogStash::SETTINGS.register(LogStash::Setting::StringSetting.new("path.settings", ::File.join(LogStash::Environment::LOGSTASH_HOME, "config")))
37+
LogStash::SETTINGS.register(LogStash::Setting::StringSetting.new("path.logs", ::File.join(LogStash::Environment::LOGSTASH_HOME, "logs")))
3838
end
3939

4040
# Ensure that any settings are re-calculated after loading yaml

‎logstash-core/spec/logstash/api/commands/default_metadata_spec.rb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ def registerIfNot(setting)
3333
let(:report_class) { described_class }
3434

3535
before :all do
36-
registerIfNot(LogStash::Setting::Boolean.new("xpack.monitoring.enabled", false))
36+
registerIfNot(LogStash::Setting::BooleanSetting.new("xpack.monitoring.enabled", false))
3737
registerIfNot(LogStash::Setting::ArrayCoercible.new("xpack.monitoring.elasticsearch.hosts", String, ["http://localhost:9200"]))
38-
registerIfNot(LogStash::Setting::SettingNullableString.new("xpack.monitoring.elasticsearch.username", "logstash_TEST system"))
39-
registerIfNot(LogStash::Setting::SettingNullableString.new("xpack.monitoring.elasticsearch.username", "logstash_TEST system"))
38+
registerIfNot(LogStash::Setting::NullableStringSetting.new("xpack.monitoring.elasticsearch.username", "logstash_TEST system"))
39+
registerIfNot(LogStash::Setting::NullableStringSetting.new("xpack.monitoring.elasticsearch.username", "logstash_TEST system"))
4040
end
4141

4242
after :each do

‎logstash-core/spec/logstash/queue_factory_spec.rb‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@
2323
let(:settings_array) do
2424
[
2525
LogStash::Setting::WritableDirectory.new("path.queue", Stud::Temporary.pathname),
26-
LogStash::Setting::SettingString.new("queue.type", "memory", true, ["persisted", "memory"]),
26+
LogStash::Setting::StringSetting.new("queue.type", "memory", true, ["persisted", "memory"]),
2727
LogStash::Setting::Bytes.new("queue.page_capacity", "8mb"),
2828
LogStash::Setting::Bytes.new("queue.max_bytes", "64mb"),
29-
LogStash::Setting::SettingNumeric.new("queue.max_events", 0),
30-
LogStash::Setting::SettingNumeric.new("queue.checkpoint.acks", 1024),
31-
LogStash::Setting::SettingNumeric.new("queue.checkpoint.writes", 1024),
32-
LogStash::Setting::Boolean.new("queue.checkpoint.retry", false),
33-
LogStash::Setting::SettingString.new("pipeline.id", pipeline_id),
34-
LogStash::Setting::SettingPositiveInteger.new("pipeline.batch.size", 125),
35-
LogStash::Setting::SettingPositiveInteger.new("pipeline.workers", LogStash::Config::CpuCoreStrategy.maximum)
29+
LogStash::Setting::NumericSetting.new("queue.max_events", 0),
30+
LogStash::Setting::NumericSetting.new("queue.checkpoint.acks", 1024),
31+
LogStash::Setting::NumericSetting.new("queue.checkpoint.writes", 1024),
32+
LogStash::Setting::BooleanSetting.new("queue.checkpoint.retry", false),
33+
LogStash::Setting::StringSetting.new("pipeline.id", pipeline_id),
34+
LogStash::Setting::PositiveIntegerSetting.new("pipeline.batch.size", 125),
35+
LogStash::Setting::PositiveIntegerSetting.new("pipeline.workers", LogStash::Config::CpuCoreStrategy.maximum)
3636
]
3737
end
3838

‎logstash-core/spec/logstash/settings/integer_spec.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
require "spec_helper"
1919
require "logstash/settings"
2020

21-
describe LogStash::Setting::SettingInteger do
21+
describe LogStash::Setting::IntegerSetting do
2222
subject { described_class.new("a number", nil, false) }
2323
describe "#set" do
2424
context "when giving a number which is not an integer" do

‎logstash-core/spec/logstash/settings/nullable_spec.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
describe LogStash::Setting::Nullable do
2222
let(:setting_name) { "this.that" }
23-
let(:normal_setting) { LogStash::Setting::SettingString.new(setting_name, nil, false, possible_strings) }
23+
let(:normal_setting) { LogStash::Setting::StringSetting.new(setting_name, nil, false, possible_strings) }
2424
let(:possible_strings) { [] } # empty means any string passes
2525

2626
subject(:nullable_setting) { normal_setting.nullable }

‎logstash-core/spec/logstash/settings/numeric_spec.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
require "logstash/settings"
2020

2121
# Mirrored in java class org.logstash.settings.SettingNumeric
22-
describe LogStash::Setting::SettingNumeric do
22+
describe LogStash::Setting::NumericSetting do
2323
subject { described_class.new("a number", nil, false) }
2424
describe "#set" do
2525
context "when giving a string which doesn't represent a string" do

‎logstash-core/spec/logstash/settings/setting_with_deprecated_alias_spec.rb‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
let(:default_value) { "DeFaUlT" }
2626

2727
let(:settings) { LogStash::Settings.new }
28-
let(:canonical_setting) { LogStash::Setting::SettingString.new(canonical_setting_name, default_value, true) }
28+
let(:canonical_setting) { LogStash::Setting::StringSetting.new(canonical_setting_name, default_value, true) }
2929

3030
let(:events) { [] }
3131

@@ -124,7 +124,7 @@
124124
let(:value) { true }
125125
let(:default_value) { false }
126126

127-
let(:canonical_setting) { LogStash::Setting::Boolean.new(canonical_setting_name, default_value, true) }
127+
let(:canonical_setting) { LogStash::Setting::BooleanSetting.new(canonical_setting_name, default_value, true) }
128128

129129
it 'resolves to the value provided for the deprecated alias' do
130130
expect(settings.get(canonical_setting_name)).to eq(true)
@@ -147,7 +147,7 @@
147147
let(:old_value) { "iron man" }
148148
let(:canonical_name) { "iron.setting" }
149149
let(:deprecated_name) { "iron.oxide.setting" }
150-
subject { LogStash::Setting::SettingString.new(canonical_name, old_value, true) }
150+
subject { LogStash::Setting::StringSetting.new(canonical_name, old_value, true) }
151151

152152
it 'logs a deprecation warning with target remove version' do
153153
settings.set(deprecated_name, new_value)
@@ -162,7 +162,7 @@
162162
let(:old_value) { true }
163163
let(:canonical_name) { "bool.setting" }
164164
let(:deprecated_name) { "boo.setting" }
165-
subject { LogStash::Setting::Boolean.new(canonical_name, old_value, true) }
165+
subject { LogStash::Setting::BooleanSetting.new(canonical_name, old_value, true) }
166166

167167
it 'does not raise error' do
168168
expect { settings.set(deprecated_name, new_value) }.to_not raise_error

‎logstash-core/spec/logstash/settings/string_spec.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
require "logstash/settings"
2020

2121
# Mirrored in java class org.logstash.settings.SettingStringTest
22-
describe LogStash::Setting::SettingString do
22+
describe LogStash::Setting::StringSetting do
2323
let(:possible_values) { ["a", "b", "c"] }
2424
subject { described_class.new("mytext", possible_values.first, true, possible_values) }
2525
describe "#set" do

0 commit comments

Comments
 (0)