Python unittest Test Discovery and CLI Commands

unittest discovery searches for matching test modules, commonly test*.

Understanding the Concept

unittest discovery searches for matching test modules, commonly test*.py, and runs collected TestCase methods. Use python -m unittest discover -s tests -p "test_*.py" in a project layout.

From a project root, run python -m unittest discover -s tests -p "test_*.py".

How this fits into a real test suite

A reliable test starts with a specific expected behavior. Keep the fixture small, arrange the input, call the real code, and assert a result the reader can verify. Add one boundary or failure case so the test does not pass only for a convenient example. In a larger project, run the same test automatically after each change.

Tests are repeatable experiments. Use temporary resources and injected dependencies where possible; when the environment is part of the requirement, add a separate integration test rather than weakening the unit test.

Worked Example

Read the code from the first line to the last. Identify which values are inputs, which operation is being demonstrated and what should happen before running it.

import unittest
class DiscoveredExampleTests(unittest.TestCase):
    def test_example(self):
        self.assertEqual(10 // 2, 5)
print(unittest.defaultTestLoader.loadTestsFromTestCase(DiscoveredExampleTests).countTestCases())

Walkthrough: What Each Part Does

The imports make unittest available. These are standard-library building blocks unless the example explicitly names an external tool.
The definition DiscoveredExampleTests creates reusable behavior. Its body runs when called, awaited or instantiated; defining it alone does not run the body of an ordinary function.
The final check compares actual behavior with an explicit expectation. A successful test tells you that this particular case passed, not that every possible input works.

This demonstration focuses on one practical behavior. Before changing several lines, vary one input or one configuration choice and check whether the result changes for the reason you expected.

The example uses terminal, platform, external tool or process behavior that was not exercised automatically. Run it only in a suitable environment after reviewing the shown permissions and paths.

Important Behavior and Edge Cases

Naming files so discovery cannot find them or running discovery from the wrong directory.

From a project root, run python -m unittest discover -s tests -p "test_*.py".

Practice Exercise

Create a tests/ folder, put one TestCase there, and run the discover command.

Write down the result you expect before running your changed code. Check at least one normal case and one boundary or failure case. If your example starts workers or opens resources, verify how they are cleaned up.

Further reading: official documentation and API reference.

Common Beginner Mistakes

Naming files so discovery cannot find them or running discovery from the wrong directory.
Writing assertions that check implementation details but fail to validate the behavior that matters to the caller.

Key Takeaways

unittest discovery searches for matching test modules, commonly test*.
From a project root, run python -m unittest discover -s tests -p "test_*.py".
Practice: Create a tests/ folder, put one TestCase there, and run the discover command.