Flaky test management in Testing Fundamentals - Framework Patterns

Framework Mode - Flaky test management

Folder Structure for Flaky Test Management

flaky-test-project/
├── tests/
│   ├── stable/
│   │   └── test_login.py
│   ├── flaky/
│   │   └── test_payment_retry.py
│   └── __init__.py
├── utils/
│   ├── flaky_handler.py
│   ├── retry_decorator.py
│   └── __init__.py
├── config/
│   ├── environments.yaml
│   └── settings.yaml
├── reports/
│   └── latest_report.html
├── conftest.py
└── pytest.ini

Test Framework Layers for Flaky Test Management

• Test Layer: Contains test cases separated into stable and flaky folders to isolate flaky tests.
• Utility Layer: Includes helpers like retry_decorator.py to rerun flaky tests automatically and flaky_handler.py to mark or log flaky tests.
• Configuration Layer: Holds environment and test settings to control test runs and retries.
• Reporting Layer: Generates test reports highlighting flaky test results for easy review.
• Test Runner Layer: Uses pytest with plugins or custom hooks to manage flaky test retries and reporting.

Configuration Patterns for Flaky Test Management

• Retry Settings: Define retry count and delay in pytest.ini or settings.yaml to control how many times flaky tests rerun before failing.
• Environment Variables: Use environment flags to enable or disable flaky test retries during CI or local runs.
• Marking Flaky Tests: Use decorators or markers (e.g., @pytest.mark.flaky) to identify flaky tests clearly.
• Logging: Configure detailed logs for flaky test runs to analyze failure patterns.

Test Reporting and CI/CD Integration

• Flaky Test Reports: Generate separate reports or highlight flaky tests in main reports to track their stability over time.
• CI/CD Integration: Configure pipelines to rerun flaky tests automatically and fail builds only after retries are exhausted.
• Notifications: Send alerts for flaky test failures to the team for investigation.
• Trend Analysis: Store historical flaky test data to identify patterns and improve test reliability.

Best Practices for Flaky Test Management

1. Isolate Flaky Tests: Keep flaky tests separate from stable ones to avoid blocking the whole test suite.
2. Use Automatic Retries: Implement retries with limits to reduce false failures without hiding real issues.
3. Mark and Track: Clearly mark flaky tests and track their history to prioritize fixing them.
4. Analyze Root Causes: Regularly review flaky test failures to find and fix underlying problems.
5. Keep Tests Simple and Reliable: Design tests to minimize external dependencies and timing issues that cause flakiness.

Self Check Question

Where in this folder structure would you add a new utility to log flaky test retries?

Key Result

Separate flaky tests, use retries, mark clearly, and track to manage flaky test reliability.

Practice

1. What is a flaky test in software testing?

easy

A. A test that always passes successfully

B. A test that sometimes passes and sometimes fails without code changes

C. A test that is never executed

D. A test that always fails due to a bug

Solution

1. Step 1: Understand flaky test behavior

   A flaky test is one that shows inconsistent results, passing or failing randomly without changes in the code.

2. Step 2: Compare options to definition

   Only A test that sometimes passes and sometimes fails without code changes describes this behavior correctly; others describe consistent outcomes or unrelated cases.

3. Final Answer:

   A test that sometimes passes and sometimes fails without code changes -> Option B

4. Quick Check:

   Flaky test = random pass/fail [OK]

Hint: Flaky tests fail unpredictably without code changes [OK]

Common Mistakes:

• Thinking flaky tests always fail
• Confusing flaky tests with skipped tests
• Assuming flaky tests are due to code bugs only

2. Which of the following is the correct way to mark a flaky test in Python using pytest?

easy

A. @pytest.mark.flaky

B. @pytest.flaky()

C. @flaky_test

D. @pytest.mark.flaky(reruns=3)

Solution

1. Step 1: Recall pytest flaky test marking syntax

   Pytest uses decorators with @pytest.mark.flaky and parameters like reruns to mark flaky tests.

2. Step 2: Identify correct syntax among options

   @pytest.mark.flaky(reruns=3) correctly uses @pytest.mark.flaky(reruns=3) to rerun flaky tests up to 3 times.

3. Final Answer:

   @pytest.mark.flaky(reruns=3) -> Option D

4. Quick Check:

   pytest flaky mark = @pytest.mark.flaky(reruns=3) [OK]

Hint: Look for decorator with reruns parameter in pytest [OK]

Common Mistakes:

• Using incorrect decorator syntax
• Missing reruns parameter for flaky tests
• Confusing pytest.mark with other decorators

3. Consider this pseudocode for a flaky test management system:

tests = ['testA', 'testB', 'testC']
flaky_tests = set()

for test in tests:
    result = run_test(test)
    if result == 'fail':
        flaky_tests.add(test)

print(sorted(flaky_tests))

If run_test('testA') returns 'pass', run_test('testB') returns 'fail', and run_test('testC') returns 'fail', what will be printed?

medium

A. ['testB', 'testC']

B. ['testA', 'testB', 'testC']

C. ['testA']

D. []

Solution

1. Step 1: Analyze test results and flaky test additions

   Only tests with 'fail' results are added to flaky_tests set: testB and testC.

2. Step 2: Sort and print flaky_tests

   Sorted flaky_tests will be ['testB', 'testC'].

3. Final Answer:

   ['testB', 'testC'] -> Option A

4. Quick Check:

   Failed tests = ['testB', 'testC'] [OK]

Hint: Add only failed tests to flaky set, then sort [OK]

Common Mistakes:

• Including passed tests in flaky list
• Not sorting the output
• Confusing set behavior with list

4. You have a flaky test marked with a retry decorator, but it still fails intermittently. What is the most likely cause?

medium

A. The retry count is too low to cover all flaky failures

B. The test code has a syntax error

C. The test is not marked as flaky

D. The test always passes and never fails

Solution

1. Step 1: Understand retry decorator purpose

   Retry decorators rerun flaky tests a set number of times to reduce false failures.

2. Step 2: Identify cause of intermittent failure despite retries

   If failures persist, likely the retry count is too low to catch all flaky cases.

3. Final Answer:

   The retry count is too low to cover all flaky failures -> Option A

4. Quick Check:

   Low retry count causes flaky failures [OK]

Hint: Check retry count if flaky test still fails [OK]

Common Mistakes:

• Assuming syntax error causes flaky behavior
• Forgetting to mark test as flaky
• Ignoring retry count limits

5. A team wants to manage flaky tests without blocking releases. Which approach best balances fixing flaky tests and maintaining release flow?

hard

A. Run flaky tests only once before release

B. Remove flaky tests permanently to avoid failures

C. Temporarily mark flaky tests to skip during release, then fix them later

D. Ignore flaky tests and release as usual

Solution

1. Step 1: Understand impact of flaky tests on releases

   Flaky tests can block releases if they fail randomly, so managing them is critical.

2. Step 2: Evaluate options for balancing fixes and release flow

   Temporarily marking flaky tests to skip during release avoids blocking while allowing later fixes.

3. Final Answer:

   Temporarily mark flaky tests to skip during release, then fix them later -> Option C

4. Quick Check:

   Skip flaky tests temporarily to keep releases smooth [OK]

Hint: Skip flaky tests temporarily, fix later to keep releases smooth [OK]

Common Mistakes:

• Deleting flaky tests instead of fixing
• Ignoring flaky tests causing release failures
• Running flaky tests only once risking missed failures