Asserting log messages in PyTest - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of asserting log messages in pytest?

Asserting log messages helps verify that the expected log entries are created during test execution, ensuring the code logs important events or errors correctly.

beginner

Which pytest fixture is commonly used to capture log messages during a test?

The pytest fixture called caplog is used to capture log messages so you can assert their content in your tests.

intermediate

How do you check if a specific message was logged at the WARNING level using caplog?

You can check by asserting if the message is in caplog.text and that caplog.records contain a record with level logging.WARNING and the expected message.

beginner

What is a simple example of asserting a log message in pytest?

Use with caplog.at_level(logging.INFO): to set log level, run code that logs, then assert 'expected message' in caplog.text.

beginner

Why is it important to assert log messages in automated tests?

Because logs provide insight into program behavior, asserting them ensures that important events and errors are recorded, helping with debugging and monitoring.

Which pytest fixture captures log messages for assertions?

A capturelog

B logcapture

C logassert

D caplog

The caplog fixture is the standard way in pytest to capture log messages.

How do you specify the log level when capturing logs with caplog?

A caplog.set_level(logging.LEVEL)

B with caplog.at_level(logging.LEVEL):

C caplog.level = logging.LEVEL

D caplog.log_level(logging.LEVEL)

Use with caplog.at_level(logging.LEVEL): to set the log level context for capturing logs.

What attribute of caplog contains all captured log messages as a single string?

A caplog.records

B caplog.messages

C caplog.text

D caplog.logs

caplog.text holds all captured log messages concatenated as a string.

To assert a log message was logged at WARNING level, you should check:

A caplog.text contains message and caplog.records have level WARNING

B caplog.text contains message only

C caplog.records have level WARNING only

D caplog.records is empty

You verify both the message text and the log level in the records to ensure correct logging.

Why might you want to assert log messages in your tests?

A To verify important events or errors are logged

B To check program output formatting

C To speed up test execution

D To avoid writing assertions

Asserting logs confirms that the program records important information for debugging and monitoring.

Explain how to use pytest's caplog fixture to assert that a specific log message was generated at a certain log level.

Think about capturing logs, setting level, and checking both message and level.

Why is asserting log messages useful in automated testing? Give an example scenario.

Consider how logs help understand what happened inside the program.