-
Notifications
You must be signed in to change notification settings - Fork 40.2k
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 application names containing parenthesis
Closes gh-39564
- Loading branch information
1 parent
244f7c5
commit ba3602b
Showing
6 changed files
with
229 additions
and
16 deletions.
There are no files selected for viewing
50 changes: 50 additions & 0 deletions
50
...boot/src/main/java/org/springframework/boot/logging/logback/ApplicationNameConverter.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,50 @@ | ||
| /* | ||
| * Copyright 2012-2024 the original author or authors. | ||
| * | ||
| * Licensed 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 | ||
| * | ||
| * https://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.springframework.boot.logging.logback; | ||
|
|
||
| import ch.qos.logback.classic.pattern.ClassicConverter; | ||
| import ch.qos.logback.classic.pattern.PropertyConverter; | ||
| import ch.qos.logback.classic.spi.ILoggingEvent; | ||
|
|
||
| import org.springframework.boot.logging.LoggingSystemProperty; | ||
|
|
||
| /** | ||
| * Logback {@link ClassicConverter} to convert the | ||
| * {@link LoggingSystemProperty#APPLICATION_NAME APPLICATION_NAME} into a value suitable | ||
| * for logging. Similar to Logback's {@link PropertyConverter} but a non-existent property | ||
| * is logged as an empty string rather than {@code null}. | ||
| * | ||
| * @author Andy Wilkinson | ||
| * @since 3.2.4 | ||
| */ | ||
| public class ApplicationNameConverter extends ClassicConverter { | ||
|
|
||
| @Override | ||
| public String convert(ILoggingEvent event) { | ||
| String applicationName = event.getLoggerContextVO() | ||
| .getPropertyMap() | ||
| .get(LoggingSystemProperty.APPLICATION_NAME.getEnvironmentVariableName()); | ||
| if (applicationName == null) { | ||
| applicationName = System.getProperty(LoggingSystemProperty.APPLICATION_NAME.getEnvironmentVariableName()); | ||
| if (applicationName == null) { | ||
| applicationName = ""; | ||
| } | ||
| } | ||
| return applicationName; | ||
| } | ||
|
|
||
| } |
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
81 changes: 81 additions & 0 deletions
81
...src/test/java/org/springframework/boot/logging/logback/ApplicationNameConverterTests.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,81 @@ | ||
| /* | ||
| * Copyright 2012-2024 the original author or authors. | ||
| * | ||
| * Licensed 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 | ||
| * | ||
| * https://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.springframework.boot.logging.logback; | ||
|
|
||
| import java.util.Collections; | ||
|
|
||
| import ch.qos.logback.classic.LoggerContext; | ||
| import ch.qos.logback.classic.spi.LoggerContextVO; | ||
| import ch.qos.logback.classic.spi.LoggingEvent; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import org.springframework.boot.logging.LoggingSystemProperty; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| /** | ||
| * Tests for {@link ApplicationNameConverter}. | ||
| * | ||
| * @author Andy Wilkinson | ||
| */ | ||
| class ApplicationNameConverterTests { | ||
|
|
||
| private final ApplicationNameConverter converter; | ||
|
|
||
| private final LoggingEvent event = new LoggingEvent(); | ||
|
|
||
| ApplicationNameConverterTests() { | ||
| this.converter = new ApplicationNameConverter(); | ||
| this.converter.setContext(new LoggerContext()); | ||
| this.event.setLoggerContextRemoteView( | ||
| new LoggerContextVO("test", Collections.emptyMap(), System.currentTimeMillis())); | ||
| } | ||
|
|
||
| @Test | ||
| void whenNoLoggedApplicationNameConvertReturnsEmptyString() { | ||
| withLoggedApplicationName(null, () -> { | ||
| this.converter.start(); | ||
| String converted = this.converter.convert(this.event); | ||
| assertThat(converted).isEqualTo(""); | ||
| }); | ||
| } | ||
|
|
||
| @Test | ||
| void whenLoggedApplicationNameConvertReturnsIt() { | ||
| withLoggedApplicationName("my-application", () -> { | ||
| this.converter.start(); | ||
| String converted = this.converter.convert(this.event); | ||
| assertThat(converted).isEqualTo("my-application"); | ||
| }); | ||
| } | ||
|
|
||
| private void withLoggedApplicationName(String name, Runnable action) { | ||
| if (name == null) { | ||
| System.clearProperty(LoggingSystemProperty.APPLICATION_NAME.getEnvironmentVariableName()); | ||
| } | ||
| else { | ||
| System.setProperty(LoggingSystemProperty.APPLICATION_NAME.getEnvironmentVariableName(), name); | ||
| } | ||
| try { | ||
| action.run(); | ||
| } | ||
| finally { | ||
| System.clearProperty(LoggingSystemProperty.APPLICATION_NAME.getEnvironmentVariableName()); | ||
| } | ||
| } | ||
|
|
||
| } |
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