-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix handling of
LoggerContextAware lookups
Due to the changes in #2278 `LoggerContextAware` lookups stopped working in `2.23.0`. This PR: * fixes the NPE in `Interpolator` that occurs if `Interpolator#setLoggerContext` was **not** called after instantiation. * Calls `Interpolator#setConfiguration` and `Interpolator#setLoggerContext` wherever it is possible. * Changes the way `Interpolator` propagates `Configuration` and `LoggerContext` to child lookups. Previously this occurred at each evaluation, now it occurs only in the setters. Closes #2309.
- Loading branch information
Showing
7 changed files
with
202 additions
and
78 deletions.
There are no files selected for viewing
99 changes: 99 additions & 0 deletions
99
...re-test/src/test/java/org/apache/logging/log4j/core/config/AbstractConfigurationTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to you under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.logging.log4j.core.config; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.Mockito.mock; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.Collections; | ||
| import java.util.Map; | ||
| import java.util.Map.Entry; | ||
| import org.apache.logging.log4j.core.LoggerContext; | ||
| import org.apache.logging.log4j.core.lookup.Interpolator; | ||
| import org.apache.logging.log4j.core.lookup.InterpolatorTest; | ||
| import org.apache.logging.log4j.core.lookup.StrSubstitutor; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.ValueSource; | ||
| import org.junitpioneer.jupiter.Issue; | ||
|
|
||
| class AbstractConfigurationTest { | ||
|
|
||
| @Test | ||
| void propertiesCanComeLast() { | ||
| final Configuration config = new TestConfiguration(null, Collections.singletonMap("console.name", "CONSOLE")); | ||
| config.initialize(); | ||
| final StrSubstitutor substitutor = config.getStrSubstitutor(); | ||
| assertThat(substitutor.replace("${console.name}")) | ||
| .as("No interpolation for '${console.name}'") | ||
| .isEqualTo("CONSOLE"); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @ValueSource(booleans = {false, true}) | ||
| @Issue("https://github.com/apache/logging-log4j2/issues/2309") | ||
| void substitutorHasConfigurationAndLoggerContext(final boolean hasProperties) { | ||
| final LoggerContext context = mock(LoggerContext.class); | ||
| final Configuration config = new TestConfiguration(context, hasProperties ? Collections.emptyMap() : null); | ||
| config.initialize(); | ||
| final Interpolator runtime = (Interpolator) config.getStrSubstitutor().getVariableResolver(); | ||
| final Interpolator configTime = | ||
| (Interpolator) config.getConfigurationStrSubstitutor().getVariableResolver(); | ||
| for (final Interpolator interpolator : Arrays.asList(runtime, configTime)) { | ||
| assertThat(InterpolatorTest.getConfiguration(interpolator)).isEqualTo(config); | ||
| assertThat(InterpolatorTest.getLoggerContext(interpolator)).isEqualTo(context); | ||
| } | ||
| } | ||
|
|
||
| private static class TestConfiguration extends AbstractConfiguration { | ||
|
|
||
| private final Map<String, String> map; | ||
|
|
||
| public TestConfiguration(final LoggerContext context, final Map<String, String> map) { | ||
| super(context, ConfigurationSource.NULL_SOURCE); | ||
| this.map = map; | ||
| } | ||
|
|
||
| @Override | ||
| public void setup() { | ||
| // Nodes | ||
| final Node loggers = newNode(rootNode, "Loggers"); | ||
| rootNode.getChildren().add(loggers); | ||
|
|
||
| final Node rootLogger = newNode(loggers, "Root"); | ||
| rootLogger.getAttributes().put("level", "INFO"); | ||
| loggers.getChildren().add(rootLogger); | ||
|
|
||
| if (map != null) { | ||
| final Node properties = newNode(rootNode, "Properties"); | ||
| rootNode.getChildren().add(properties); | ||
|
|
||
| for (final Entry<String, String> entry : map.entrySet()) { | ||
| final Node property = newNode(properties, "Property"); | ||
| property.getAttributes().put("name", entry.getKey()); | ||
| property.getAttributes().put("value", entry.getValue()); | ||
| properties.getChildren().add(property); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private Node newNode(final Node parent, final String name) { | ||
| return new Node(parent, name, pluginManager.getPluginType(name)); | ||
| } | ||
| } | ||
| } |
67 changes: 0 additions & 67 deletions
67
.../src/test/java/org/apache/logging/log4j/core/config/ConfigurationPropertiesOrderTest.java
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
src/changelog/.2.x.x/2309_fix_logger_context_aware_lookups.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xmlns="http://logging.apache.org/log4j/changelog" | ||
| xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.3.xsd" | ||
| type="changed"> | ||
| <issue id="2309" link="https://github.com/apache/logging-log4j2/pull/2309"/> | ||
| <description format="asciidoc">Fix handling of `LoggerContextAware` lookups.</description> | ||
| </entry> |