Logging with Log4j2 — Structured Debugging

<!-- Add to pom.xml -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.23.1</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.23.1</version>
    <scope>test</scope>
</dependency>

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Properties>
        <Property name="LOG_PATTERN">
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level
            %logger{36} - %msg%n
        </Property>
    </Properties>

    <Appenders>
        <!-- Console — shows in terminal/IDE -->
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${LOG_PATTERN}" />
        </Console>

        <!-- File — saved for debugging later -->
        <RollingFile name="File"
            fileName="logs/test-execution.log"
            filePattern=
                "logs/test-execution-%d{yyyy-MM-dd}.log">
            <PatternLayout pattern="${LOG_PATTERN}" />
            <Policies>
                <SizeBasedTriggeringPolicy size="10MB" />
            </Policies>
            <DefaultRolloverStrategy max="5" />
        </RollingFile>
    </Appenders>

    <Loggers>
        <!-- Suppress noisy Selenium internal logs -->
        <Logger name="org.openqa.selenium" level="WARN" />

        <Root level="INFO">
            <AppenderRef ref="Console" />
            <AppenderRef ref="File" />
        </Root>
    </Loggers>
</Configuration>

// What good test logging looks like:

public class BankingLoginTests extends BaseTest {
    private static final Logger logger =
        LogManager.getLogger(BankingLoginTests.class);

    @Test
    public void testSuccessfulLogin() {
        logger.info("=== Test: Successful Login ===");

        navigateTo("/banking");
        logger.info("Navigated to Banking portal");

        LoginPage loginPage = new LoginPage(getDriver());
        logger.info("Entering credentials for: testuser");
        DashboardPage dashboard = loginPage.loginAs(
            "testuser", "password123");

        logger.info("Verifying dashboard loaded");
        Assert.assertTrue(dashboard.isLoaded());

        String balance = dashboard.getAccountBalance();
        logger.info("Account balance: " + balance);

        logger.info("=== Test Completed Successfully ===");
    }
}

// Log output:
// 2025-01-15 10:30:01.123 [main] INFO  BankingLoginTests
//   - === Test: Successful Login ===
// 2025-01-15 10:30:01.456 [main] INFO  BaseTest
//   - Navigating to: https://testerrank.com/banking
// 2025-01-15 10:30:02.789 [main] INFO  BankingLoginTests
//   - Navigated to Banking portal
// 2025-01-15 10:30:02.790 [main] INFO  BankingLoginTests
//   - Entering credentials for: testuser
// 2025-01-15 10:30:03.012 [main] INFO  LoginPage
//   - Logging in as: testuser
// 2025-01-15 10:30:03.456 [main] INFO  BankingLoginTests
//   - Verifying dashboard loaded
// 2025-01-15 10:30:03.789 [main] INFO  BankingLoginTests
//   - Account balance: Rs. 50,000
// 2025-01-15 10:30:03.790 [main] INFO  BankingLoginTests
//   - === Test Completed Successfully ===