This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/2.x by this push:
new 5a907b9cf0 Consolidate Windows-specific constants in tests (#2767)
5a907b9cf0 is described below
commit 5a907b9cf0aa5ad13724718b92c2a2ec62b73f89
Author: Volkan Yazıcı <[email protected]>
AuthorDate: Mon Sep 9 13:32:42 2024 +0200
Consolidate Windows-specific constants in tests (#2767)
---
.../core/net/ssl/KeyStoreConfigurationTest.java | 11 +++--
.../core/net/ssl/SslConfigurationFactoryTest.java | 53 ++++++++++++++--------
.../log4j/core/net/ssl/SslKeyStoreConstants.java | 4 ++
3 files changed, 44 insertions(+), 24 deletions(-)
diff --git
a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/KeyStoreConfigurationTest.java
b/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/KeyStoreConfigurationTest.java
index 8e78ede626..f7a22ac0cc 100644
---
a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/KeyStoreConfigurationTest.java
+++
b/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/KeyStoreConfigurationTest.java
@@ -81,8 +81,9 @@ public class KeyStoreConfigurationTest {
(Supplier<char[]>)
SslKeyStoreConstants::KEYSTORE_P12_NOPASS_PWD,
SslKeyStoreConstants.KEYSTORE_P12_NOPASS_TYPE));
if (OS.WINDOWS.isCurrentOs()) {
- builder.add(Arguments.of(null, (Supplier<char[]>) () -> null,
"Windows-MY"))
- .add(Arguments.of(null, (Supplier<char[]>) () -> null,
"Windows-ROOT"));
+ builder.add(Arguments.of(null, (Supplier<char[]>) () -> null,
SslKeyStoreConstants.WINDOWS_KEYSTORE_TYPE))
+ .add(Arguments.of(
+ null, (Supplier<char[]>) () -> null,
SslKeyStoreConstants.WINDOWS_TRUSTSTORE_TYPE));
}
return builder.build();
}
@@ -151,8 +152,10 @@ public class KeyStoreConfigurationTest {
(Supplier<char[]>)
SslKeyStoreConstants::KEYSTORE_P12_NOPASS_PWD,
SslKeyStoreConstants.KEYSTORE_P12_TYPE));
if (OS.WINDOWS.isCurrentOs()) {
- builder.add(Arguments.of(null, (Supplier<char[]>) () -> new
char[0], "Windows-MY"))
- .add(Arguments.of(null, (Supplier<char[]>) () -> new
char[0], "Windows-ROOT"));
+ builder.add(Arguments.of(
+ null, (Supplier<char[]>) () -> new char[0],
SslKeyStoreConstants.WINDOWS_KEYSTORE_TYPE))
+ .add(Arguments.of(
+ null, (Supplier<char[]>) () -> new char[0],
SslKeyStoreConstants.WINDOWS_TRUSTSTORE_TYPE));
}
return builder.build();
}
diff --git
a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/SslConfigurationFactoryTest.java
b/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/SslConfigurationFactoryTest.java
index 011d41746f..c413fd0ff5 100644
---
a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/SslConfigurationFactoryTest.java
+++
b/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/SslConfigurationFactoryTest.java
@@ -33,45 +33,54 @@ import org.junit.jupiter.params.provider.MethodSource;
@UsingStatusListener // Suppresses `StatusLogger` output, unless there is a
failure
public class SslConfigurationFactoryTest {
- private static final String trustStorelocation =
"log4j2.trustStoreLocation";
- private static final String trustStorePassword =
"log4j2.trustStorePassword";
- private static final String trustStoreKeyStoreType =
"log4j2.trustStoreKeyStoreType";
- private static final String keyStoreLocation = "log4j2.keyStoreLocation";
- private static final String keyStorePassword = "log4j2.keyStorePassword";
- private static final String keyStoreType = "log4j2.keyStoreType";
+ private static final String TRUSTSTORE_LOCATION_PROP_NAME =
"log4j2.trustStoreLocation";
+
+ private static final String TRUSTSTORE_PASSWORD_PROP_NAME =
"log4j2.trustStorePassword";
+
+ private static final String TRUSTSTORE_TYPE_PROP_NAME =
"log4j2.trustStoreKeyStoreType";
+
+ private static final String KEYSTORE_LOCATION_PROP_NAME =
"log4j2.keyStoreLocation";
+
+ private static final String KEYSTORE_PASSWORD_PROP_NAME =
"log4j2.keyStorePassword";
+
+ private static final String KEYSTORE_TYPE_PROP_NAME =
"log4j2.keyStoreType";
private static void addKeystoreConfiguration(final Properties props) {
- props.setProperty(keyStoreLocation,
SslKeyStoreConstants.KEYSTORE_LOCATION);
- props.setProperty(keyStoreType, SslKeyStoreConstants.KEYSTORE_TYPE);
+ props.setProperty(KEYSTORE_LOCATION_PROP_NAME,
SslKeyStoreConstants.KEYSTORE_LOCATION);
+ props.setProperty(KEYSTORE_TYPE_PROP_NAME,
SslKeyStoreConstants.KEYSTORE_TYPE);
}
private static void addTruststoreConfiguration(final Properties props) {
- props.setProperty(trustStorelocation,
SslKeyStoreConstants.TRUSTSTORE_LOCATION);
- props.setProperty(trustStoreKeyStoreType,
SslKeyStoreConstants.TRUSTSTORE_TYPE);
+ props.setProperty(TRUSTSTORE_LOCATION_PROP_NAME,
SslKeyStoreConstants.TRUSTSTORE_LOCATION);
+ props.setProperty(TRUSTSTORE_TYPE_PROP_NAME,
SslKeyStoreConstants.TRUSTSTORE_TYPE);
}
@Test
public void testStaticConfiguration() {
+
+ // Case 1: Empty configuration
final Properties props = new Properties();
final PropertiesUtil util = new PropertiesUtil(props);
- // No keystore and truststore -> no SslConfiguration
SslConfiguration sslConfiguration =
SslConfigurationFactory.createSslConfiguration(util);
assertNull(sslConfiguration);
- // Only keystore
+
+ // Case 2: Only key store
props.clear();
addKeystoreConfiguration(props);
sslConfiguration =
SslConfigurationFactory.createSslConfiguration(util);
assertNotNull(sslConfiguration);
assertNotNull(sslConfiguration.getKeyStoreConfig());
assertNull(sslConfiguration.getTrustStoreConfig());
- // Only truststore
+
+ // Case 3: Only trust store
props.clear();
addTruststoreConfiguration(props);
sslConfiguration =
SslConfigurationFactory.createSslConfiguration(util);
assertNotNull(sslConfiguration);
assertNull(sslConfiguration.getKeyStoreConfig());
assertNotNull(sslConfiguration.getTrustStoreConfig());
- // Both
+
+ // Case 4: Both key and trust stores
props.clear();
addKeystoreConfiguration(props);
addTruststoreConfiguration(props);
@@ -96,19 +105,23 @@ public class SslConfigurationFactoryTest {
@ParameterizedTest
@MethodSource("windowsKeystoreConfigs")
public void testPasswordLessStores(final String location, final String
password) {
+
+ // Create the configuration
final Properties props = new Properties();
- props.setProperty(keyStoreType, "Windows-MY");
- props.setProperty(trustStoreKeyStoreType, "Windows-ROOT");
+ props.setProperty(KEYSTORE_TYPE_PROP_NAME,
SslKeyStoreConstants.WINDOWS_KEYSTORE_TYPE);
+ props.setProperty(TRUSTSTORE_TYPE_PROP_NAME,
SslKeyStoreConstants.WINDOWS_TRUSTSTORE_TYPE);
if (location != null) {
- props.setProperty(keyStoreLocation, location);
- props.setProperty(trustStorelocation, location);
+ props.setProperty(KEYSTORE_LOCATION_PROP_NAME, location);
+ props.setProperty(TRUSTSTORE_LOCATION_PROP_NAME, location);
}
if (password != null) {
- props.setProperty(keyStorePassword, password);
- props.setProperty(trustStorePassword, password);
+ props.setProperty(KEYSTORE_PASSWORD_PROP_NAME, password);
+ props.setProperty(TRUSTSTORE_PASSWORD_PROP_NAME, password);
}
final PropertiesUtil util = new PropertiesUtil(props);
final SslConfiguration config =
SslConfigurationFactory.createSslConfiguration(util);
+
+ // Verify the configuration
assertNotNull(config);
final KeyStoreConfiguration keyStoreConfig =
config.getKeyStoreConfig();
assertNotNull(keyStoreConfig);
diff --git
a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/SslKeyStoreConstants.java
b/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/SslKeyStoreConstants.java
index f4416a95c3..387b0f46bd 100644
---
a/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/SslKeyStoreConstants.java
+++
b/log4j-core-test/src/test/java/org/apache/logging/log4j/core/net/ssl/SslKeyStoreConstants.java
@@ -83,4 +83,8 @@ public final class SslKeyStoreConstants {
/// Other /////////////////////////////////////////////////////////////////
public static final char[] NULL_PWD = null;
+
+ public static final String WINDOWS_KEYSTORE_TYPE = "Windows-MY";
+
+ public static final String WINDOWS_TRUSTSTORE_TYPE = "Windows-ROOT";
}
