Why CI integration enables continuous quality in PyTest

Introduction

CI integration helps catch problems early by running tests automatically every time code changes. This keeps the software quality high all the time.

When you want to check your code works after every change without doing it manually.

When multiple people work on the same project and you want to avoid breaking each other's work.

When you want fast feedback about bugs or errors in your code.

When you want to make sure your software is always ready to release.

When you want to save time by automating repetitive testing tasks.

Syntax

PyTest

name: Run Tests
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.12'
      - name: Install dependencies
        run: pip install pytest
      - name: Run tests
        run: pytest

This is a simple GitHub Actions workflow example for CI integration.

It runs tests automatically on code push or pull request.

Examples

Runs tests only when code is pushed to the repository.

PyTest

on: push
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run tests
        run: pytest

Runs tests when a pull request is created or updated.

PyTest

on: pull_request
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run tests
        run: pytest

Sample Program

This is a simple test script using pytest. It tests the add function with different inputs.

When integrated with CI, this test runs automatically on every code change.

PyTest

def add(a, b):
    return a + b

def test_add():
    assert add(2, 3) == 5
    assert add(-1, 1) == 0
    assert add(0, 0) == 0

Important Notes

CI tools like GitHub Actions, Jenkins, or GitLab CI can run your tests automatically.

Automated tests in CI help find bugs early before they reach users.

Make sure your tests are fast and reliable for best CI results.

Summary

CI integration runs tests automatically on every code change.

This helps keep software quality high all the time.

It saves time and catches bugs early.

Practice

1. What is the main benefit of integrating pytest with Continuous Integration (CI) systems?

easy

A. CI integration slows down the development process

B. Tests run only when manually triggered by developers

C. Tests run automatically on every code change to catch bugs early

D. CI integration replaces the need for writing tests

Solution

1. Step 1: Understand CI integration purpose

   CI systems run tests automatically whenever code changes are pushed.

2. Step 2: Identify the benefit of automatic testing

   This automatic testing helps catch bugs early and maintain software quality continuously.

3. Final Answer:

   Tests run automatically on every code change to catch bugs early -> Option C

4. Quick Check:

   CI runs tests automatically = A [OK]

Hint: CI runs tests on every change to catch bugs early [OK]

Common Mistakes:

• Thinking tests run only manually
• Believing CI slows development
• Assuming CI replaces writing tests

2. Which pytest command is commonly used in a CI pipeline to run all tests?

easy

A. pytest --run-all

B. pytest

C. pytest --ci-mode

D. pytest --skip

Solution

1. Step 1: Recall pytest basic command

   The basic command to run all tests is simply pytest.

2. Step 2: Check other options for validity

   Options like --run-all, --ci-mode, and --skip are not standard pytest commands.

3. Final Answer:

   pytest -> Option B

4. Quick Check:

   Run all tests = pytest [OK]

Hint: Use plain 'pytest' to run all tests in CI [OK]

Common Mistakes:

• Adding non-existent flags
• Using commands that skip tests
• Confusing pytest options with other tools

3. Given this pytest output in a CI pipeline:

============================= test session starts =============================
collected 3 items

test_sample.py ..F                                                      [100%]

================================== FAILURES ===================================
____________________________ test_divide_by_zero _____________________________

    def test_divide_by_zero():
>       assert 1 / 0
E       ZeroDivisionError: division by zero

What does this output tell you about the test results?

medium

A. All tests passed successfully

B. Tests did not run because of a syntax error

C. Tests were skipped

D. One test failed due to a division by zero error

Solution

1. Step 1: Analyze the test summary

   The output shows 3 tests collected, with two dots (.) meaning passed tests and one F meaning a failure.

2. Step 2: Identify failure cause

   The failure is due to a ZeroDivisionError in test_divide_by_zero.

3. Final Answer:

   One test failed due to a division by zero error -> Option D

4. Quick Check:

   F indicates one test failed due to ZeroDivisionError = C [OK]

Hint: F means failure; check error message for cause [OK]

Common Mistakes:

• Assuming all tests passed
• Confusing failure with skipped tests
• Ignoring error details

4. You added pytest tests to your project and integrated them with CI. However, the CI pipeline always shows zero tests collected. What is the most likely cause?

medium

A. Test files or functions are not named correctly (e.g., missing 'test_' prefix)

B. The CI server is offline

C. pytest is not installed on the CI server

D. Tests contain assertion errors

Solution

1. Step 1: Understand pytest test discovery rules

   pytest only collects tests from files and functions named starting with test_.

2. Step 2: Identify why zero tests are collected

   If no tests are found, likely the naming conventions are not followed, so pytest skips them.

3. Final Answer:

   Test files or functions are not named correctly (e.g., missing 'test_' prefix) -> Option A

4. Quick Check:

   pytest needs 'test_' prefix to find tests [OK]

Hint: Name test files/functions starting with 'test_' [OK]

Common Mistakes:

• Assuming CI server offline causes zero tests
• Ignoring pytest naming conventions
• Thinking assertion errors prevent test collection

5. In a CI pipeline using pytest, you want to ensure that tests run only if code formatting passes with black --check. Which approach best integrates this to maintain continuous quality?

hard

A. Run black --check first; if it fails, stop the pipeline; else run pytest tests

B. Run pytest tests first; then run black --check regardless of test results

C. Run both black --check and pytest tests in parallel without stopping

D. Skip black --check and only run pytest tests

Solution

1. Step 1: Understand quality gate concept in CI

   Code formatting checks should block further testing if they fail to maintain quality.

2. Step 2: Determine correct pipeline order

   Run black --check first; if it fails, stop pipeline to fix formatting before running tests.

3. Final Answer:

   Run black --check first; if it fails, stop the pipeline; else run pytest tests -> Option A

4. Quick Check:

   Fail fast on formatting, then test = A [OK]

Hint: Fail formatting check before tests to keep quality [OK]

Common Mistakes:

• Running tests before fixing formatting
• Ignoring formatting failures
• Running checks in parallel without order