Coverage reporting in Django

Introduction

Coverage reporting helps you see which parts of your Django code are tested. It shows what is tested and what is not, so you can improve your tests.

You want to check if your Django views have enough tests.

You want to find untested parts of your Django models or forms.

You want to improve your test quality before releasing your app.

You want to measure how much of your Django project your tests cover.

Syntax

Django

coverage run manage.py test
coverage report
coverage html

coverage run manage.py test runs your tests and collects coverage data.

coverage report shows a summary in the terminal.

coverage html creates a detailed report you can open in a browser.

Examples

Run tests only for the app named myapp and collect coverage data.

Django

coverage run manage.py test myapp

Show coverage report with missing lines marked.

Django

coverage report -m

Generate an HTML report you can open in a browser to see coverage details.

Django

coverage html

Sample Program

This example shows the steps to run coverage on your Django tests. First, install the coverage tool. Then run your tests with coverage enabled. Next, see a summary report in the terminal. Finally, create a detailed HTML report.

Django

1. Install coverage: pip install coverage
2. Run tests with coverage: coverage run manage.py test
3. Show coverage report: coverage report -m
4. Generate HTML report: coverage html

Important Notes

Make sure to install the coverage package before running coverage commands.

Run coverage commands from your Django project root where manage.py is located.

Use the HTML report to visually explore which lines are missing tests.

Summary

Coverage reporting shows which parts of your Django code are tested.

Use coverage run manage.py test to collect coverage data.

View results with coverage report or coverage html for detailed info.

Practice

1. What is the main purpose of coverage reporting in Django testing?

easy

A. To deploy the Django app to a server

B. To speed up the test execution

C. To automatically fix bugs in the code

D. To show which parts of your code are tested

Solution

1. Step 1: Understand coverage reporting

   Coverage reporting tracks which lines of code are executed during tests.

2. Step 2: Identify the main goal

   The goal is to see which parts of the code are covered by tests to improve test quality.

3. Final Answer:

   To show which parts of your code are tested -> Option D

4. Quick Check:

   Coverage shows tested code = A [OK]

Hint: Coverage shows tested code parts clearly [OK]

Common Mistakes:

• Thinking coverage speeds up tests
• Believing coverage fixes bugs automatically
• Confusing coverage with deployment

2. Which command correctly runs Django tests with coverage collection?

easy

A. coverage test manage.py run

B. python manage.py coverage test

C. coverage run manage.py test

D. manage.py coverage run test

Solution

1. Step 1: Recall the correct coverage command syntax

   The coverage tool runs the test command with: coverage run manage.py test

2. Step 2: Compare options

   Only coverage run manage.py test matches the correct syntax; others mix command order incorrectly.

3. Final Answer:

   coverage run manage.py test -> Option C

4. Quick Check:

   Correct coverage test command = A [OK]

Hint: Use 'coverage run' before 'manage.py test' [OK]

Common Mistakes:

• Swapping command order
• Using 'coverage test' instead of 'coverage run'
• Adding 'coverage' after manage.py

3. After running coverage run manage.py test, what command shows a summary of coverage results in the terminal?

medium

A. coverage report

B. coverage summary

C. coverage show

D. coverage list

Solution

1. Step 1: Identify the command for coverage summary

   The command to display coverage results in the terminal is 'coverage report'.

2. Step 2: Eliminate incorrect options

   Commands like 'coverage summary', 'coverage show', and 'coverage list' do not exist or do not show coverage summary.

3. Final Answer:

   coverage report -> Option A

4. Quick Check:

   Terminal coverage summary = coverage report = C [OK]

Hint: Use 'coverage report' to see terminal summary [OK]

Common Mistakes:

• Using non-existent commands like 'coverage summary'
• Confusing 'coverage html' with terminal report
• Trying 'coverage show' which is invalid

4. You ran coverage run manage.py test but coverage report shows 0% coverage. What is the likely cause?

medium

A. Coverage data file was deleted before report

B. Tests did not execute any code

C. Coverage was run without the test command

D. Coverage report command is misspelled

Solution

1. Step 1: Understand why coverage shows 0%

   If coverage data file is missing or deleted, report shows 0% coverage.

2. Step 2: Check other options

   Tests running but no coverage data means data file issue; misspelling report command causes error, not 0%.

3. Final Answer:

   Coverage data file was deleted before report -> Option A

4. Quick Check:

   Missing data file = 0% coverage = B [OK]

Hint: Check if .coverage file exists before report [OK]

Common Mistakes:

• Assuming tests never ran
• Thinking coverage run without test causes 0%
• Misspelling report causes error, not zero coverage

5. You want a detailed HTML report of your Django test coverage. Which sequence of commands should you run?

hard

A. coverage report && coverage run manage.py test

B. coverage run manage.py test && coverage html

C. coverage html && coverage run manage.py test

D. manage.py test coverage run && coverage report

Solution

1. Step 1: Run tests with coverage collection

   Use 'coverage run manage.py test' to collect coverage data while running tests.

2. Step 2: Generate HTML report

   Run 'coverage html' after tests to create a detailed HTML coverage report.

3. Step 3: Verify command order

   coverage run manage.py test && coverage html correctly chains these commands; others have wrong order or commands.

4. Final Answer:

   coverage run manage.py test && coverage html -> Option B

5. Quick Check:

   Run tests then html report = D [OK]

Hint: Run tests first, then 'coverage html' for report [OK]

Common Mistakes:

• Running 'coverage html' before tests
• Mixing command order
• Using 'manage.py test coverage run' which is invalid