-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ConfigTest.java
514 lines (438 loc) · 20.5 KB
/
ConfigTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
/*
* Copyright (c) 2002-2018 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.configuration;
import org.hamcrest.CoreMatchers;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.mockito.InOrder;
import java.io.File;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
import javax.annotation.Nonnull;
import org.neo4j.configuration.DocumentedDefaultValue;
import org.neo4j.configuration.Dynamic;
import org.neo4j.configuration.Internal;
import org.neo4j.configuration.LoadableConfig;
import org.neo4j.configuration.ReplacedBy;
import org.neo4j.configuration.Secret;
import org.neo4j.graphdb.config.InvalidSettingException;
import org.neo4j.graphdb.config.Setting;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.logging.Log;
import org.neo4j.test.rule.TestDirectory;
import static java.util.Collections.singletonList;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.neo4j.helpers.collection.MapUtil.stringMap;
import static org.neo4j.kernel.configuration.Settings.BOOLEAN;
import static org.neo4j.kernel.configuration.Settings.STRING;
import static org.neo4j.kernel.configuration.Settings.setting;
public class ConfigTest
{
public static class MyMigratingSettings implements LoadableConfig
{
@SuppressWarnings( "unused" ) // accessed by reflection
@Migrator
public static ConfigurationMigrator migrator = new BaseConfigurationMigrator()
{
{
add( new SpecificPropertyMigration( "old", "Old has been replaced by newer!" )
{
@Override
public void setValueWithOldSetting( String value, Map<String,String> rawConfiguration )
{
rawConfiguration.put( newer.name(), value );
}
} );
}
};
public static Setting<String> newer = setting( "newer", STRING, "" );
}
public static class MySettingsWithDefaults implements LoadableConfig
{
public static final Setting<String> hello = setting( "hello", STRING, "Hello, World!" );
public static final Setting<Boolean> boolSetting = setting( "bool_setting", BOOLEAN, Settings.TRUE );
@Internal
@DocumentedDefaultValue( "<documented default value>" )
public static final Setting<Boolean> secretSetting = setting( "secret_setting", BOOLEAN, Settings.TRUE );
@Deprecated
@ReplacedBy( "hello" )
public static final Setting<String> oldHello = setting( "old_hello", STRING, "Hello, Bob" );
@Deprecated
public static final Setting<String> oldSetting = setting( "some_setting", STRING, "Has no replacement" );
@Secret
public static final Setting<String> password = setting( "password", STRING, "This text should not appear in logs or toString" );
}
private static class HelloHasToBeNeo4jConfigurationValidator implements ConfigurationValidator
{
@Override
public Map<String,String> validate( @Nonnull Config config, @Nonnull Log log ) throws InvalidSettingException
{
if ( !config.get( MySettingsWithDefaults.hello ).equals( "neo4j" ) )
{
throw new InvalidSettingException( "Setting hello has to set to neo4j" );
}
return Collections.emptyMap();
}
}
private static MyMigratingSettings myMigratingSettings = new MyMigratingSettings();
private static MySettingsWithDefaults mySettingsWithDefaults = new MySettingsWithDefaults();
private static Config Config()
{
return Config( Collections.emptyMap() );
}
private static Config Config( Map<String,String> params )
{
return Config.fromSettings( params )
.withConfigClasses( Arrays.asList( mySettingsWithDefaults, myMigratingSettings ) ).build();
}
@Rule
public TestDirectory testDirectory = TestDirectory.testDirectory();
@Rule
public ExpectedException expect = ExpectedException.none();
@Test
public void shouldApplyDefaults()
{
Config config = Config();
assertThat( config.get( MySettingsWithDefaults.hello ), is( "Hello, World!" ) );
}
@Test
public void shouldApplyMigrations()
{
// When
Config config = Config( stringMap( "old", "hello!" ) );
// Then
assertThat( config.get( MyMigratingSettings.newer ), is( "hello!" ) );
}
@Test( expected = InvalidSettingException.class )
public void shouldNotAllowSettingInvalidValues()
{
Config( stringMap( MySettingsWithDefaults.boolSetting.name(), "asd" ) );
fail( "Expected validation to fail." );
}
@Test
public void shouldBeAbleToAugmentConfig() throws Exception
{
// Given
Config config = Config();
// When
config.augment( MySettingsWithDefaults.boolSetting, Settings.FALSE );
config.augment( MySettingsWithDefaults.hello, "Bye" );
// Then
assertThat( config.get( MySettingsWithDefaults.boolSetting ), equalTo( false ) );
assertThat( config.get( MySettingsWithDefaults.hello ), equalTo( "Bye" ) );
}
@Test
public void augmentAnotherConfig() throws Exception
{
Config config = Config();
config.augment( MySettingsWithDefaults.hello, "Hi" );
Config anotherConfig = Config();
anotherConfig.augment( stringMap( MySettingsWithDefaults.boolSetting.name(),
Settings.FALSE, MySettingsWithDefaults.hello.name(), "Bye" ) );
config.augment( anotherConfig );
assertThat( config.get( MySettingsWithDefaults.boolSetting ), equalTo( false ) );
assertThat( config.get( MySettingsWithDefaults.hello ), equalTo( "Bye" ) );
}
@Test
public void shouldWarnAndDiscardUnknownOptionsInReservedNamespaceAndPassOnBufferedLogInWithMethods()
throws Exception
{
// Given
Log log = mock( Log.class );
File confFile = testDirectory.file( "test.conf" );
assertTrue( confFile.createNewFile() );
Config config = Config.fromFile( confFile )
.withSetting( GraphDatabaseSettings.strict_config_validation, "false" )
.withSetting( "ha.jibberish", "baah" )
.withSetting( "dbms.jibberish", "booh" ).build();
// When
config.setLogger( log );
config.augment( "causal_clustering.jibberish", "baah" );
// Then
verify( log ).warn( "Unknown config option: %s", "dbms.jibberish" );
verify( log ).warn( "Unknown config option: %s", "ha.jibberish" );
verifyNoMoreInteractions( log );
}
@Test
public void shouldLogDeprecationWarnings()
throws Exception
{
// Given
Log log = mock( Log.class );
File confFile = testDirectory.file( "test.conf" );
assertTrue( confFile.createNewFile() );
Config config = Config.fromFile( confFile )
.withSetting( MySettingsWithDefaults.oldHello, "baah" )
.withSetting( MySettingsWithDefaults.oldSetting, "booh" )
.withConfigClasses( Arrays.asList( mySettingsWithDefaults, myMigratingSettings,
new GraphDatabaseSettings() ) )
.build();
// When
config.setLogger( log );
// Then
verify( log ).warn( "%s is deprecated. Replaced by %s", MySettingsWithDefaults.oldHello.name(),
MySettingsWithDefaults.hello.name() );
verify( log ).warn( "%s is deprecated.", MySettingsWithDefaults.oldSetting.name() );
verifyNoMoreInteractions( log );
}
@Test
public void shouldSetInternalParameter()
throws Exception
{
// Given
Config config = Config.builder()
.withSetting( MySettingsWithDefaults.secretSetting, "false" )
.withSetting( MySettingsWithDefaults.hello, "ABC" )
.withConfigClasses( Arrays.asList( mySettingsWithDefaults, myMigratingSettings ) )
.build();
// Then
assertTrue( config.getConfigValues().get( MySettingsWithDefaults.secretSetting.name() ).internal() );
assertFalse( config.getConfigValues().get( MySettingsWithDefaults.hello.name() ).internal() );
}
@Test
public void shouldSetSecretParameter()
{
// Given
Config config = Config.builder()
.withSetting( MySettingsWithDefaults.password, "this should not be visible" )
.withSetting( MySettingsWithDefaults.hello, "ABC" )
.withConfigClasses( Arrays.asList( mySettingsWithDefaults, myMigratingSettings ) )
.build();
// Then
assertTrue( config.getConfigValues().get( MySettingsWithDefaults.password.name() ).isSecret() );
assertFalse( config.getConfigValues().get( MySettingsWithDefaults.hello.name() ).isSecret() );
String configText = config.toString();
assertTrue( configText.contains( Secret.OBSFUCATED ) );
assertFalse( configText.contains( "this should not be visible" ) );
assertFalse( configText.contains( config.get( MySettingsWithDefaults.password ) ) );
}
@Test
public void shouldSetDocumentedDefaultValue()
throws Exception
{
// Given
Config config = Config.builder()
.withSetting( MySettingsWithDefaults.secretSetting, "false" )
.withSetting( MySettingsWithDefaults.hello, "ABC" )
.withConfigClasses( Arrays.asList( new MySettingsWithDefaults(), myMigratingSettings ) )
.build();
// Then
assertEquals( Optional.of( "<documented default value>" ),
config.getConfigValues().get( MySettingsWithDefaults.secretSetting.name() )
.documentedDefaultValue() );
assertEquals( Optional.empty(),
config.getConfigValues().get( MySettingsWithDefaults.hello.name() ).documentedDefaultValue() );
}
@Test
public void validatorsShouldBeCalledWhenBuilding() throws Exception
{
// Should not throw
Config.builder()
.withSetting( MySettingsWithDefaults.hello, "neo4j" )
.withValidator( new HelloHasToBeNeo4jConfigurationValidator() )
.withConfigClasses( Arrays.asList( mySettingsWithDefaults, myMigratingSettings ) ).build();
expect.expect( InvalidSettingException.class );
expect.expectMessage( "Setting hello has to set to neo4j" );
// Should throw
Config.builder()
.withSetting( MySettingsWithDefaults.hello, "not-neo4j" )
.withValidator( new HelloHasToBeNeo4jConfigurationValidator() )
.withConfigClasses( Arrays.asList( mySettingsWithDefaults, myMigratingSettings ) ).build();
}
@Group( "a.b.c" )
private static class GroupedSetting
{
}
@Test
public void identifiersFromGroup() throws Exception
{
// Given
File confFile = testDirectory.file( "test.conf" );
assertTrue( confFile.createNewFile() );
Config config = Config.fromFile( confFile )
.withSetting( GraphDatabaseSettings.strict_config_validation, "false" )
.withSetting( "a.b.c.first.jibberish", "baah" )
.withSetting( "a.b.c.second.jibberish", "baah" )
.withSetting( "a.b.c.third.jibberish", "baah" )
.withSetting( "a.b.c.forth.jibberish", "baah" ).build();
Set<String> identifiers = config.identifiersFromGroup( GroupedSetting.class );
Set<String> expectedIdentifiers = new HashSet<>( Arrays.asList( "first", "second", "third", "forth" ) );
assertEquals( expectedIdentifiers, identifiers );
}
@Test
public void isConfigured() throws Exception
{
Config config = Config();
assertFalse( config.isConfigured( MySettingsWithDefaults.hello ) );
config.augment( MySettingsWithDefaults.hello, "Hi" );
assertTrue( config.isConfigured( MySettingsWithDefaults.hello ) );
}
@Test
public void isConfiguredShouldNotReturnTrueEvenThoughDefaultValueExists() throws Exception
{
Config config = Config();
assertFalse( config.isConfigured( MySettingsWithDefaults.hello ) );
assertEquals( "Hello, World!", config.get( MySettingsWithDefaults.hello ) );
}
@Test
public void withConnectorsDisabled() throws Exception
{
Connector httpConnector = new HttpConnector();
Connector boltConnector = new BoltConnector();
Config config = Config.builder()
.withSetting( httpConnector.enabled, "true" )
.withSetting( httpConnector.type, Connector.ConnectorType.HTTP.name() )
.withSetting( boltConnector.enabled, "true" )
.withSetting( boltConnector.type, Connector.ConnectorType.BOLT.name() )
.withConnectorsDisabled().build();
assertFalse( config.get( httpConnector.enabled ) );
assertFalse( config.get( boltConnector.enabled ) );
}
@Test
public void augmentDefaults() throws Exception
{
Config config = Config();
assertEquals( "Hello, World!", config.get( MySettingsWithDefaults.hello ) );
config.augmentDefaults( MySettingsWithDefaults.hello, "new default" );
assertEquals( "new default", config.get( MySettingsWithDefaults.hello ) );
}
public static class MyDynamicSettings implements LoadableConfig
{
@Dynamic
public static final Setting<Boolean> boolSetting = setting( "bool_setting", BOOLEAN, Settings.TRUE );
@Dynamic
@Secret
public static final Setting<String> secretSetting = setting( "password", STRING, "secret" );
}
@Test
public void updateDynamicShouldLogChanges() throws Exception
{
String settingName = MyDynamicSettings.boolSetting.name();
String changedMessage = "Setting changed: '%s' changed from '%s' to '%s'";
Config config = Config.builder().withConfigClasses( singletonList( new MyDynamicSettings() ) ).build();
Log log = mock( Log.class );
config.setLogger( log );
config.updateDynamicSetting( settingName, "false" );
config.updateDynamicSetting( settingName, "true" );
config.updateDynamicSetting( settingName, "" );
InOrder order = inOrder( log );
order.verify( log ).info( changedMessage, settingName, "default (true)", "false" );
order.verify( log ).info( changedMessage, settingName, "false", "true" );
order.verify( log ).info( changedMessage, settingName, "true", "default (true)" );
verifyNoMoreInteractions( log );
}
@Test
public void updateDynamicShouldThrowIfSettingIsNotDynamic() throws Exception
{
Config config = Config.builder().withConfigClasses( singletonList( mySettingsWithDefaults ) ).build();
expect.expect( IllegalArgumentException.class );
config.updateDynamicSetting( MySettingsWithDefaults.hello.name(), "hello" );
}
@Test
public void updateDynamicShouldInformRegisteredListeners() throws Exception
{
Config config = Config.builder().withConfigClasses( singletonList( new MyDynamicSettings() ) ).build();
AtomicInteger counter = new AtomicInteger( 0 );
config.registerDynamicUpdateListener( MyDynamicSettings.boolSetting, ( previous, update ) ->
{
counter.getAndIncrement();
assertTrue( previous );
assertFalse( update );
} );
config.updateDynamicSetting( MyDynamicSettings.boolSetting.name(), "false" );
assertThat( counter.get(), is( 1 ) );
}
@Test
public void updateDynamicShouldNotAllowInvalidSettings() throws Exception
{
Config config = Config.builder().withConfigClasses( singletonList( new MyDynamicSettings() ) ).build();
expect.expect( InvalidSettingException.class );
config.updateDynamicSetting( MyDynamicSettings.boolSetting.name(), "this is not a boolean" );
}
@Test
public void registeringUpdateListenerOnNonDynamicSettingMustThrow() throws Exception
{
Config config = Config.builder().withConfigClasses( singletonList( mySettingsWithDefaults ) ).build();
expect.expect( IllegalArgumentException.class );
config.registerDynamicUpdateListener( MySettingsWithDefaults.hello, ( a, b ) -> fail( "never called" ) );
}
@Test
public void updateDynamicShouldLogExceptionsFromUpdateListeners() throws Exception
{
Config config = Config.builder().withConfigClasses( singletonList( new MyDynamicSettings() ) ).build();
IllegalStateException exception = new IllegalStateException( "Boo" );
config.registerDynamicUpdateListener( MyDynamicSettings.boolSetting, ( a, b ) ->
{
throw exception;
} );
Log log = mock( Log.class );
config.setLogger( log );
String settingName = MyDynamicSettings.boolSetting.name();
config.updateDynamicSetting( settingName, "" );
verify( log ).error( "Failure when notifying listeners after dynamic setting change; " +
"new setting might not have taken effect: Boo", exception );
}
@Test
public void updateDynamicShouldWorkWithSecret() throws Exception
{
// Given a secret dynamic setting with a registered update listener
String settingName = MyDynamicSettings.secretSetting.name();
String changedMessage = "Setting changed: '%s' changed from '%s' to '%s'";
Config config = Config.builder().withConfigClasses( singletonList( new MyDynamicSettings() ) ).build();
Log log = mock( Log.class );
config.setLogger( log );
AtomicInteger counter = new AtomicInteger( 0 );
config.registerDynamicUpdateListener( MyDynamicSettings.secretSetting, ( previous, update ) ->
{
counter.getAndIncrement();
assertThat( "Update listener should not see obsfucated secret", previous, not( CoreMatchers.equalTo( Secret.OBSFUCATED ) ) );
assertThat( "Update listener should not see obsfucated secret", update, not( CoreMatchers.equalTo( Secret.OBSFUCATED ) ) );
} );
// When changing secret settings three times
config.updateDynamicSetting( settingName, "another" );
config.updateDynamicSetting( settingName, "secret2" );
config.updateDynamicSetting( settingName, "" );
// Then we should see obsfucated log messages
InOrder order = inOrder( log );
order.verify( log ).info( changedMessage, settingName, "default (" + Secret.OBSFUCATED + ")", Secret.OBSFUCATED );
order.verify( log ).info( changedMessage, settingName, Secret.OBSFUCATED, Secret.OBSFUCATED );
order.verify( log ).info( changedMessage, settingName, Secret.OBSFUCATED, "default (" + Secret.OBSFUCATED + ")" );
verifyNoMoreInteractions( log );
// And see 3 calls to the update listener
assertThat( counter.get(), is( 3 ) );
}
}