Logging with Log4j in Selenium Java - Framework Patterns

Framework Mode - Logging with Log4j

Folder Structure

src/
├── main/
│   ├── java/
│   │   └── com/example/project/
│   │       └── utils/
│   │           └── LoggerUtil.java  <-- Central logging utility
│   └── resources/
│       └── log4j2.xml               <-- Log4j configuration file
└── test/
    ├── java/
    │   └── com/example/project/tests/
    │       └── SampleTest.java      <-- Selenium test using Logger
    └── resources/
        └── testdata.properties      <-- Test data and configs

Test Framework Layers

• Logger Utility Layer: Contains LoggerUtil.java which wraps Log4j2 logger setup and usage.
• Test Layer: Selenium test classes that call LoggerUtil to log test steps and results.
• Configuration Layer: log4j2.xml defines logging levels, appenders (console, file), and formats.
• Utilities Layer: Helper classes for common functions, including logging helper.
• Resources Layer: Holds configuration files like log4j2.xml and test data properties.

Configuration Patterns

• log4j2.xml: Central XML file to configure logging levels (INFO, DEBUG, ERROR), appenders (console, file), and patterns.
• Environment-based Logging: Use different log4j2.xml files or properties to adjust logging verbosity per environment (dev, test, prod).
• Dynamic Log Level: Configure log level via system properties or environment variables to avoid code changes.
• Logger Initialization: LoggerUtil initializes Log4j logger once per class using LogManager.getLogger(ClassName.class).

Test Reporting and CI/CD Integration

• Logs generated by Log4j are saved to files and console for easy debugging.
• Log files can be archived and attached to CI/CD pipeline reports (e.g., Jenkins, GitHub Actions).
• Use log levels to filter important messages in CI logs to reduce noise.
• Integrate with test reports (e.g., Allure, TestNG reports) by linking log files or embedding key logs.
• Automate log cleanup and rotation to manage disk space in CI environments.

Best Practices

• Use Logger per Class: Create a logger instance per class to identify log source easily.
• Log Meaningful Messages: Include context like test step, input data, and expected vs actual results.
• Use Appropriate Log Levels: DEBUG for detailed info, INFO for general steps, ERROR for failures.
• Externalize Configuration: Keep log4j2.xml outside code to change logging without recompiling.
• Avoid Logging Sensitive Data: Do not log passwords or personal info to protect privacy.

Self Check

Where in this folder structure would you add a new logger utility class to support logging test execution details?

Key Result

Centralize logging with Log4j2 using a dedicated utility class and external XML configuration for flexible, meaningful test logs.

Practice

1. What is the main purpose of using Log4j in Selenium Java tests?

easy

A. To create graphical user interfaces for tests

B. To speed up the execution of Selenium tests

C. To record messages about test execution for debugging and analysis

D. To manage database connections during tests

Solution

1. Step 1: Understand Log4j's role

   Log4j is a logging tool used to record messages during program execution.

2. Step 2: Relate to Selenium tests

   In Selenium tests, logging helps track what happens and find issues.

3. Final Answer:

   To record messages about test execution for debugging and analysis -> Option C

4. Quick Check:

   Logging = record messages [OK]

Hint: Log4j records messages, not speeds or creates UI [OK]

Common Mistakes:

• Thinking Log4j speeds up tests
• Confusing logging with UI creation
• Assuming Log4j manages databases

2. Which of the following is the correct way to create a Logger instance using Log4j in Java?

easy

A. Logger logger = Logger.getLogger("MyLogger");

B. Logger logger = new Logger();

C. Logger logger = Logger.createLogger();

D. Logger logger = Logger.initLogger("MyLogger");

Solution

1. Step 1: Recall Log4j Logger creation syntax

   Log4j uses Logger.getLogger(String name) to create or get a logger.

2. Step 2: Check options

   Only Logger logger = Logger.getLogger("MyLogger"); uses the correct method Logger.getLogger("MyLogger").

3. Final Answer:

   Logger logger = Logger.getLogger("MyLogger"); -> Option A

4. Quick Check:

   Use getLogger() to create Logger [OK]

Hint: Use Logger.getLogger("name") to create logger [OK]

Common Mistakes:

• Trying to instantiate Logger with new
• Using non-existent methods like createLogger or initLogger
• Missing the logger name string

3. Given the following Log4j code snippet, what will be the output if the log level is set to WARN?

Logger logger = Logger.getLogger("TestLogger");
logger.info("Info message");
logger.warn("Warning message");
logger.error("Error message");

medium

A. Info message, Warning message, Error message

B. Warning message, Error message

C. Error message only

D. No output

Solution

1. Step 1: Understand log level filtering

   Log4j outputs messages at or above the set level. WARN level shows WARN and ERROR but not INFO.

2. Step 2: Apply to given messages

   INFO is below WARN, so skipped. WARN and ERROR messages are shown.

3. Final Answer:

   Warning message, Error message -> Option B

4. Quick Check:

   Log level WARN shows WARN and ERROR [OK]

Hint: Log4j shows messages at or above set level [OK]

Common Mistakes:

• Assuming all messages print regardless of level
• Thinking INFO is shown at WARN level
• Confusing ERROR with higher or lower level

4. You wrote this Log4j code but no logs appear when running your Selenium tests:

Logger logger = Logger.getLogger("MyTestLogger");
logger.debug("Debug message");

What is the most likely reason?

medium

A. The log level is set higher than DEBUG, so debug messages are ignored

B. The logger was not created correctly

C. You must call logger.start() before logging

D. Log4j does not support DEBUG level

Solution

1. Step 1: Check logger creation

   The logger creation syntax is correct, so this is not the issue.

2. Step 2: Understand log level filtering

   If the log level is set above DEBUG (like INFO or WARN), debug messages won't show.

3. Final Answer:

   The log level is set higher than DEBUG, so debug messages are ignored -> Option A

4. Quick Check:

   Higher log level hides lower level messages [OK]

Hint: Check log level; DEBUG hidden if level is INFO or higher [OK]

Common Mistakes:

• Thinking logger needs start() method
• Assuming DEBUG is unsupported
• Believing logger creation failed silently

5. You want to log messages in your Selenium Java tests using Log4j so that only ERROR and FATAL messages appear in the console, but INFO and WARN messages are saved to a file. Which Log4j feature should you use to achieve this?

hard

A. Use only one appender and filter messages in code before logging

B. Set the global log level to ERROR and log INFO messages manually to file

C. Log4j cannot separate messages by level to different outputs

D. Use two appenders with different thresholds and configure them in log4j.properties

Solution

1. Step 1: Understand Log4j appenders

   Appenders send log messages to different outputs like console or files.

2. Step 2: Use multiple appenders with thresholds

   You can configure one appender for console with ERROR level, and another for file with INFO or WARN level.

3. Step 3: Configure in log4j.properties

   This setup is done in the configuration file, not by manual code filtering.

4. Final Answer:

   Use two appenders with different thresholds and configure them in log4j.properties -> Option D

5. Quick Check:

   Multiple appenders + thresholds = selective logging [OK]

Hint: Use multiple appenders with level filters in config file [OK]

Common Mistakes:

• Trying to filter messages manually in code
• Setting global level only without appenders
• Thinking Log4j can't split outputs by level