Skip to content

HADOOP-8865. Log warning message when loading deprecated properties from resources #7737

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

Closed
wants to merge 1 commit into from
Closed

HADOOP-8865. Log warning message when loading deprecated properties from resources #7737

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
1 change: 1 addition & 0 deletions hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/conf/Configuration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3433,6 +3433,7 @@ void handleEndProperty() {
deprecations.getDeprecatedKeyMap().get(confName);

if (keyInfo != null) {
logDeprecation(keyInfo.getWarningMessage(confName, wrapper.toString()));
keyInfo.clearAccessed();
for (String key : keyInfo.newKeys) {
// update new keys with deprecated key's value
Expand Down
33 changes: 30 additions & 3 deletions ...-common-project/hadoop-common/src/test/java/org/apache/hadoop/conf/TestConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@
import org.apache.log4j.AppenderSkeleton;
import org.apache.log4j.Logger;
import org.apache.log4j.spi.LoggingEvent;
import org.junit.jupiter.api.io.TempDir;
import org.mockito.Mockito;

public class TestConfiguration {
Expand Down Expand Up @@ -120,7 +121,7 @@ public class TestConfiguration {

@BeforeEach
public void setUp() throws Exception {
conf = new Configuration();
conf = new Configuration(false);
}

@AfterEach
Expand Down Expand Up @@ -356,6 +357,33 @@ public void testFinalWarningsMultipleOverride() throws Exception {
}
}

@Test
public void testDeprecatedPropertyInXMLFileGeneratesLogMessage(@TempDir java.nio.file.Path tmp) throws IOException {
String oldProp = "test.deprecation.old.conf.a";
String newProp = "test.deprecation.new.conf.a";
Configuration.addDeprecation(oldProp, newProp);
java.nio.file.Path confFile = Files.createFile(tmp.resolve("TestConfiguration.xml"));
String confXml = "<configuration><property><name>" + oldProp + "</name><value>a</value></property></configuration>";
Files.write(confFile, confXml.getBytes());

TestAppender appender = new TestAppender();
Logger deprecationLogger = Logger.getLogger("org.apache.hadoop.conf.Configuration.deprecation");
deprecationLogger.addAppender(appender);

try {
conf.addResource(new Path(confFile.toUri()));
// Properties are lazily initialized so access them to trigger the loading of the resource
conf.getProps();
} finally {
deprecationLogger.removeAppender(appender);
}

Pattern deprecationMsgPattern = Pattern.compile(oldProp + " in file:" + confFile + " is deprecated");
boolean hasDeprecationMessage = appender.log.stream().map(LoggingEvent::getRenderedMessage)
.anyMatch(msg -> deprecationMsgPattern.matcher(msg).find());
assertTrue(hasDeprecationMessage);
}

/**
* A simple appender for white box testing.
*/
Expand Down Expand Up @@ -845,8 +873,7 @@ public void testToString() throws IOException {
conf.addResource(fileResource);

String expectedOutput =
"Configuration: core-default.xml, core-site.xml, " +
fileResource.toString();
"Configuration: " + fileResource;
assertEquals(expectedOutput, conf.toString());
}

Expand Down