Skip to content

fix(log): restore logger context after test to prevent pollution #6476

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
Nov 5, 2025
Merged

fix(log): restore logger context after test to prevent pollution #6476

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
5 changes: 4 additions & 1 deletion common/src/main/java/org/tron/common/log/LogService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,28 @@

import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.joran.JoranConfigurator;
import ch.qos.logback.core.util.StatusPrinter;
import java.io.File;
import org.slf4j.LoggerFactory;
import org.tron.core.exception.TronError;

public class LogService {

public static void load(String path) {
LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
try {
File file = new File(path);
if (!file.exists() || !file.isFile() || !file.canRead()) {
return;
}
LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
JoranConfigurator configurator = new JoranConfigurator();
configurator.setContext(lc);
lc.reset();
configurator.doConfigure(file);
} catch (Exception e) {
throw new TronError(e, TronError.ErrCode.LOG_LOAD);
} finally {
StatusPrinter.printInCaseOfErrorsOrWarnings(lc);
}
}
}
25 changes: 21 additions & 4 deletions framework/src/test/java/org/tron/core/exception/TronErrorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;

import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.util.ContextInitializer;
import ch.qos.logback.core.joran.spi.JoranException;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
import com.typesafe.config.ConfigObject;
Expand All @@ -27,6 +30,7 @@
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;
import org.slf4j.LoggerFactory;
import org.tron.common.arch.Arch;
import org.tron.common.log.LogService;
import org.tron.common.parameter.RateLimiterInitialization;
Expand All @@ -38,6 +42,7 @@
import org.tron.core.services.http.RateLimiterServlet;
import org.tron.core.zen.ZksnarkInitService;


@RunWith(MockitoJUnitRunner.class)
public class TronErrorTest {

Expand Down Expand Up @@ -85,10 +90,22 @@ public void ZksnarkInitTest() throws IllegalAccessException, NoSuchFieldExceptio

@Test
public void LogLoadTest() throws IOException {
LogService.load("non-existent.xml");
Path path = temporaryFolder.newFile("logback.xml").toPath();
TronError thrown = assertThrows(TronError.class, () -> LogService.load(path.toString()));
assertEquals(TronError.ErrCode.LOG_LOAD, thrown.getErrCode());
LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();

try {
LogService.load("non-existent.xml");
Path path = temporaryFolder.newFile("logback.xml").toPath();
TronError thrown = assertThrows(TronError.class, () -> LogService.load(path.toString()));
assertEquals(TronError.ErrCode.LOG_LOAD, thrown.getErrCode());
} finally {
try {
context.reset();
ContextInitializer ci = new ContextInitializer(context);
ci.autoConfig();
} catch (JoranException e) {
Assert.fail(e.getMessage());
}
}
}

@Test
Expand Down