Skip to content

Remove properties cache and token-based matching #2849

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

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Remove properties cache and token-based matching #2849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 12 additions & 41 deletions log4j-api-test/src/test/java/org/apache/logging/log4j/util/PropertiesUtilOrderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@

@ExtendWith(SystemStubsExtension.class)
@ResourceLock(value = Resources.SYSTEM_PROPERTIES)
public class PropertiesUtilOrderTest {
class PropertiesUtilOrderTest {

public static class NonEnumerablePropertySource implements PropertySource {
private static class NonEnumerablePropertySource implements PropertySource {

private final Properties props;

Expand Down Expand Up @@ -67,14 +67,6 @@ public boolean containsProperty(final String key) {
}
}

public static class NullPropertySource implements PropertySource {

@Override
public int getPriority() {
return Integer.MIN_VALUE;
}
}

private final Properties properties = new Properties();

@BeforeEach
Expand All @@ -85,7 +77,7 @@ public void setUp() throws Exception {
}

@Test
public void testNormalizedOverrideLegacy() {
void testNormalizedOverrideLegacy() {
final PropertiesUtil util = new PropertiesUtil(properties);
final String legacy = "props.legacy";
final String normalized = "props.normalized";
Expand All @@ -104,20 +96,7 @@ public void testNormalizedOverrideLegacy() {
}

@Test
public void testFallsBackToTokenMatching() {
final PropertiesUtil util = new PropertiesUtil(properties);
for (int i = 1; i <= 4; i++) {
final String key = "log4j2.tokenBasedProperty" + i;
assertTrue(util.hasProperty(key));
assertEquals("props.token", util.getStringProperty(key));
}
// No fall back (a normalized property is present)
assertTrue(util.hasProperty("log4j2.normalizedProperty"));
assertEquals("props.normalized", util.getStringProperty("log4j2.normalizedProperty"));
}

@Test
public void testOrderOfNormalizedProperties(final EnvironmentVariables env, final SystemProperties sysProps) {
void testOrderOfNormalizedProperties(final EnvironmentVariables env, final SystemProperties sysProps) {
properties.remove("log4j2.normalizedProperty");
properties.remove("LOG4J_normalized.property");
final PropertiesUtil util = new PropertiesUtil(properties);
Expand All @@ -128,29 +107,26 @@ public void testOrderOfNormalizedProperties(final EnvironmentVariables env, fina
assertEquals(null, util.getStringProperty("log4j2.normalizedProperty"));

properties.setProperty("log4j2.normalizedProperty", "props.normalized");
util.reload();
assertTrue(util.hasProperty("Log4jNormalizedProperty"));
assertEquals("props.normalized", util.getStringProperty("Log4jNormalizedProperty"));
assertTrue(util.hasProperty("log4j2.normalizedProperty"));
assertEquals("props.normalized", util.getStringProperty("log4j2.normalizedProperty"));

env.set("LOG4J_NORMALIZED_PROPERTY", "env");
util.reload();
assertTrue(util.hasProperty("Log4jNormalizedProperty"));
assertEquals("env", util.getStringProperty("Log4jNormalizedProperty"));
assertTrue(util.hasProperty("log4j2.normalizedProperty"));
assertEquals("env", util.getStringProperty("log4j2.normalizedProperty"));

sysProps.set("log4j2.normalizedProperty", "sysProps");
util.reload();
assertTrue(util.hasProperty("Log4jNormalizedProperty"));
assertEquals("sysProps", util.getStringProperty("Log4jNormalizedProperty"));
assertTrue(util.hasProperty("log4j2.normalizedProperty"));
assertEquals("sysProps", util.getStringProperty("log4j2.normalizedProperty"));
}

@Test
public void testLegacySystemPropertyHasHigherPriorityThanEnv(
void testLegacySystemPropertyHasHigherPriorityThanEnv(
final EnvironmentVariables env, final SystemProperties sysProps) {
env.set("LOG4J_CONFIGURATION_FILE", "env");
final PropertiesUtil util = new PropertiesUtil(properties);
Expand All @@ -159,18 +135,16 @@ public void testLegacySystemPropertyHasHigherPriorityThanEnv(
assertEquals("env", util.getStringProperty("log4j.configurationFile"));

sysProps.set("log4j.configurationFile", "legacy");
util.reload();
assertTrue(util.hasProperty("log4j.configurationFile"));
assertEquals("legacy", util.getStringProperty("log4j.configurationFile"));

sysProps.set("log4j2.configurationFile", "new");
util.reload();
assertTrue(util.hasProperty("log4j.configurationFile"));
assertEquals("new", util.getStringProperty("log4j.configurationFile"));
}

@Test
public void testHighPriorityNonEnumerableSource(final SystemProperties sysProps) {
void testHighPriorityNonEnumerableSource(final SystemProperties sysProps) {
// In both datasources
assertNotNull(properties.getProperty("log4j2.normalizedProperty"));
assertNotNull(properties.getProperty("log4j.onlyLegacy"));
Expand Down Expand Up @@ -201,22 +175,19 @@ public void testHighPriorityNonEnumerableSource(final SystemProperties sysProps)
}

/**
* Checks the for missing null checks. The {@link NullPropertySource} returns
* Checks the for missing null checks, using a {@link PropertySource}, which returns
* {@code null} in almost every call.
*
* @param sysProps
*/
@Test
public void testNullChecks(final SystemProperties sysProps) {
void testNullChecks(final SystemProperties sysProps) {
sysProps.set("log4j2.someProperty", "sysProps");
sysProps.set("Log4jLegacyProperty", "sysProps");
final PropertiesUtil util = new PropertiesUtil(new NullPropertySource());
assertTrue(util.hasProperty("log4j2.someProperty"));
assertEquals("sysProps", util.getStringProperty("log4j2.someProperty"));
final PropertiesUtil util = new PropertiesUtil(() -> Integer.MIN_VALUE);

assertTrue(util.hasProperty("Log4jSomeProperty"));
assertEquals("sysProps", util.getStringProperty("log4jSomeProperty"));
assertTrue(util.hasProperty("Log4jLegacyProperty"));
assertEquals("sysProps", util.getStringProperty("Log4jLegacyProperty"));
assertTrue(util.hasProperty("log4j.legacyProperty"));
assertEquals("sysProps", util.getStringProperty("log4j.legacyProperty"));
assertFalse(util.hasProperty("log4j2.nonExistentProperty"));
assertNull(util.getStringProperty("log4j2.nonExistentProperty"));
}
Expand Down
22 changes: 12 additions & 10 deletions log4j-api-test/src/test/java/org/apache/logging/log4j/util/PropertiesUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,15 +212,15 @@ void testBadPropertySource() {
{null, "org.apache.logging.log4j.level"},
{null, "Log4jAnotherProperty"},
{null, "log4j2.catalinaBase"},
{"ok", "log4j2.configurationFile"},
{"ok", "log4j2.defaultStatusLevel"},
{"ok", "log4j2.newLevel"},
{"ok", "log4j2.asyncLoggerTimeout"},
{"ok", "log4j2.asyncLoggerConfigRingBufferSize"},
{"ok", "log4j2.disableThreadContext"},
{"ok", "log4j2.disableThreadContextStack"},
{"ok", "log4j2.disableThreadContextMap"},
{"ok", "log4j2.isThreadContextMapInheritable"}
{"ok", "log4j.configurationFile"},
{"ok", "Log4jDefaultStatusLevel"},
{"ok", "org.apache.logging.log4j.newLevel"},
{"ok", "AsyncLogger.Timeout"},
{"ok", "AsyncLoggerConfig.RingBufferSize"},
{"ok", "disableThreadContext"},
{"ok", "disableThreadContextStack"},
{"ok", "disableThreadContextMap"},
{"ok", "isThreadContextMapInheritable"}
};

/**
Expand All @@ -232,7 +232,9 @@ void testBadPropertySource() {
void testResolvesOnlyLog4jProperties() {
final PropertiesUtil util = new PropertiesUtil("Jira3413Test.properties");
for (final String[] pair : data) {
assertEquals(pair[0], util.getStringProperty(pair[1]));
assertThat(util.getStringProperty(pair[1]))
.as("Checking property %s", pair[1])
.isEqualTo(pair[0]);
}
}

Expand Down
18 changes: 9 additions & 9 deletions log4j-api-test/src/test/resources/Jira3413Test.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ another.property=fail
catalina.base=fail

# Some legacy properties with a characteristic prefix
log4j.configurationFile=ok
Log4jDefaultStatusLevel=ok
org.apache.logging.log4j.newLevel=ok
log4j2.configurationFile=ok
log4j2.defaultStatusLevel=ok
log4j2.newLevel=ok

# No characteristic prefix
AsyncLogger.Timeout=ok
AsyncLoggerConfig.RingBufferSize=ok
disableThreadContext=ok
disableThreadContextStack=ok
disableThreadContextMap=ok
isThreadContextMapInheritable=ok
log4j2.asyncLoggerTimeout=ok
log4j2.asyncLoggerConfigRingBufferSize=ok
log4j2.disableThreadContext=ok
log4j2.disableThreadContextStack=ok
log4j2.disableThreadContextMap=ok
log4j2.isThreadContextMapInheritable=ok
Loading