Skip to content

Commit 5a907b9

Browse files
vyvy
committed
Consolidate Windows-specific constants in tests (#2767)
1 parent 45ce728 commit 5a907b9

File tree

3 files changed

+44
-24
lines changed

3 files changed

+44
-24
lines changed

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/KeyStoreConfigurationTest.java‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,9 @@ static Stream<Arguments> configurations() {
8181
(Supplier<char[]>) SslKeyStoreConstants::KEYSTORE_P12_NOPASS_PWD,
8282
SslKeyStoreConstants.KEYSTORE_P12_NOPASS_TYPE));
8383
if (OS.WINDOWS.isCurrentOs()) {
84-
builder.add(Arguments.of(null, (Supplier<char[]>) () -> null, "Windows-MY"))
85-
.add(Arguments.of(null, (Supplier<char[]>) () -> null, "Windows-ROOT"));
84+
builder.add(Arguments.of(null, (Supplier<char[]>) () -> null, SslKeyStoreConstants.WINDOWS_KEYSTORE_TYPE))
85+
.add(Arguments.of(
86+
null, (Supplier<char[]>) () -> null, SslKeyStoreConstants.WINDOWS_TRUSTSTORE_TYPE));
8687
}
8788
return builder.build();
8889
}
@@ -151,8 +152,10 @@ static Stream<Arguments> wrongConfigurations() {
151152
(Supplier<char[]>) SslKeyStoreConstants::KEYSTORE_P12_NOPASS_PWD,
152153
SslKeyStoreConstants.KEYSTORE_P12_TYPE));
153154
if (OS.WINDOWS.isCurrentOs()) {
154-
builder.add(Arguments.of(null, (Supplier<char[]>) () -> new char[0], "Windows-MY"))
155-
.add(Arguments.of(null, (Supplier<char[]>) () -> new char[0], "Windows-ROOT"));
155+
builder.add(Arguments.of(
156+
null, (Supplier<char[]>) () -> new char[0], SslKeyStoreConstants.WINDOWS_KEYSTORE_TYPE))
157+
.add(Arguments.of(
158+
null, (Supplier<char[]>) () -> new char[0], SslKeyStoreConstants.WINDOWS_TRUSTSTORE_TYPE));
156159
}
157160
return builder.build();
158161
}

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/SslConfigurationFactoryTest.java‎

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -33,45 +33,54 @@
3333
@UsingStatusListener // Suppresses `StatusLogger` output, unless there is a failure
3434
public class SslConfigurationFactoryTest {
3535

36-
private static final String trustStorelocation = "log4j2.trustStoreLocation";
37-
private static final String trustStorePassword = "log4j2.trustStorePassword";
38-
private static final String trustStoreKeyStoreType = "log4j2.trustStoreKeyStoreType";
39-
private static final String keyStoreLocation = "log4j2.keyStoreLocation";
40-
private static final String keyStorePassword = "log4j2.keyStorePassword";
41-
private static final String keyStoreType = "log4j2.keyStoreType";
36+
private static final String TRUSTSTORE_LOCATION_PROP_NAME = "log4j2.trustStoreLocation";
37+
38+
private static final String TRUSTSTORE_PASSWORD_PROP_NAME = "log4j2.trustStorePassword";
39+
40+
private static final String TRUSTSTORE_TYPE_PROP_NAME = "log4j2.trustStoreKeyStoreType";
41+
42+
private static final String KEYSTORE_LOCATION_PROP_NAME = "log4j2.keyStoreLocation";
43+
44+
private static final String KEYSTORE_PASSWORD_PROP_NAME = "log4j2.keyStorePassword";
45+
46+
private static final String KEYSTORE_TYPE_PROP_NAME = "log4j2.keyStoreType";
4247

4348
private static void addKeystoreConfiguration(final Properties props) {
44-
props.setProperty(keyStoreLocation, SslKeyStoreConstants.KEYSTORE_LOCATION);
45-
props.setProperty(keyStoreType, SslKeyStoreConstants.KEYSTORE_TYPE);
49+
props.setProperty(KEYSTORE_LOCATION_PROP_NAME, SslKeyStoreConstants.KEYSTORE_LOCATION);
50+
props.setProperty(KEYSTORE_TYPE_PROP_NAME, SslKeyStoreConstants.KEYSTORE_TYPE);
4651
}
4752

4853
private static void addTruststoreConfiguration(final Properties props) {
49-
props.setProperty(trustStorelocation, SslKeyStoreConstants.TRUSTSTORE_LOCATION);
50-
props.setProperty(trustStoreKeyStoreType, SslKeyStoreConstants.TRUSTSTORE_TYPE);
54+
props.setProperty(TRUSTSTORE_LOCATION_PROP_NAME, SslKeyStoreConstants.TRUSTSTORE_LOCATION);
55+
props.setProperty(TRUSTSTORE_TYPE_PROP_NAME, SslKeyStoreConstants.TRUSTSTORE_TYPE);
5156
}
5257

5358
@Test
5459
public void testStaticConfiguration() {
60+
61+
// Case 1: Empty configuration
5562
final Properties props = new Properties();
5663
final PropertiesUtil util = new PropertiesUtil(props);
57-
// No keystore and truststore -> no SslConfiguration
5864
SslConfiguration sslConfiguration = SslConfigurationFactory.createSslConfiguration(util);
5965
assertNull(sslConfiguration);
60-
// Only keystore
66+
67+
// Case 2: Only key store
6168
props.clear();
6269
addKeystoreConfiguration(props);
6370
sslConfiguration = SslConfigurationFactory.createSslConfiguration(util);
6471
assertNotNull(sslConfiguration);
6572
assertNotNull(sslConfiguration.getKeyStoreConfig());
6673
assertNull(sslConfiguration.getTrustStoreConfig());
67-
// Only truststore
74+
75+
// Case 3: Only trust store
6876
props.clear();
6977
addTruststoreConfiguration(props);
7078
sslConfiguration = SslConfigurationFactory.createSslConfiguration(util);
7179
assertNotNull(sslConfiguration);
7280
assertNull(sslConfiguration.getKeyStoreConfig());
7381
assertNotNull(sslConfiguration.getTrustStoreConfig());
74-
// Both
82+
83+
// Case 4: Both key and trust stores
7584
props.clear();
7685
addKeystoreConfiguration(props);
7786
addTruststoreConfiguration(props);
@@ -96,19 +105,23 @@ static Stream<Arguments> windowsKeystoreConfigs() {
96105
@ParameterizedTest
97106
@MethodSource("windowsKeystoreConfigs")
98107
public void testPasswordLessStores(final String location, final String password) {
108+
109+
// Create the configuration
99110
final Properties props = new Properties();
100-
props.setProperty(keyStoreType, "Windows-MY");
101-
props.setProperty(trustStoreKeyStoreType, "Windows-ROOT");
111+
props.setProperty(KEYSTORE_TYPE_PROP_NAME, SslKeyStoreConstants.WINDOWS_KEYSTORE_TYPE);
112+
props.setProperty(TRUSTSTORE_TYPE_PROP_NAME, SslKeyStoreConstants.WINDOWS_TRUSTSTORE_TYPE);
102113
if (location != null) {
103-
props.setProperty(keyStoreLocation, location);
104-
props.setProperty(trustStorelocation, location);
114+
props.setProperty(KEYSTORE_LOCATION_PROP_NAME, location);
115+
props.setProperty(TRUSTSTORE_LOCATION_PROP_NAME, location);
105116
}
106117
if (password != null) {
107-
props.setProperty(keyStorePassword, password);
108-
props.setProperty(trustStorePassword, password);
118+
props.setProperty(KEYSTORE_PASSWORD_PROP_NAME, password);
119+
props.setProperty(TRUSTSTORE_PASSWORD_PROP_NAME, password);
109120
}
110121
final PropertiesUtil util = new PropertiesUtil(props);
111122
final SslConfiguration config = SslConfigurationFactory.createSslConfiguration(util);
123+
124+
// Verify the configuration
112125
assertNotNull(config);
113126
final KeyStoreConfiguration keyStoreConfig = config.getKeyStoreConfig();
114127
assertNotNull(keyStoreConfig);

‎log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/SslKeyStoreConstants.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,4 +83,8 @@ public static char[] KEYSTORE_P12_NOPASS_PWD() {
8383
/// Other /////////////////////////////////////////////////////////////////
8484

8585
public static final char[] NULL_PWD = null;
86+
87+
public static final String WINDOWS_KEYSTORE_TYPE = "Windows-MY";
88+
89+
public static final String WINDOWS_TRUSTSTORE_TYPE = "Windows-ROOT";
8690
}

0 commit comments

Comments
 (0)