Coverage reporting in Django - Step-by-Step Execution

Concept Flow - Coverage reporting

Write Django Tests

↓

Run Tests with Coverage

↓

Coverage Tool Tracks Lines

↓

Generate Coverage Report

↓

Review Report for Missing Coverage

↓

Improve Tests and Repeat

This flow shows how coverage reporting works in Django: write tests, run them with coverage tracking, generate a report, and improve tests based on it.

Execution Sample

Django

coverage run manage.py test
coverage report
coverage html

Run Django tests with coverage tracking, then show a text report and generate an HTML report.

Execution Table

Step	Action	Coverage Tool Behavior	Output
1	Run 'coverage run manage.py test'	Starts coverage tracking, runs all Django tests	Tests run, coverage data collected
2	Tests execute lines in views.py	Coverage tool marks executed lines as covered	Coverage data updated for views.py
3	Tests execute lines in models.py	Coverage tool marks executed lines as covered	Coverage data updated for models.py
4	Tests skip some lines in utils.py	Coverage tool marks those lines as missing coverage	Coverage data shows missing lines in utils.py
5	Run 'coverage report'	Summarizes coverage data in terminal	Text report shows % covered per file
6	Run 'coverage html'	Generates detailed HTML report with line highlights	HTML files created in 'htmlcov' folder
7	Open 'htmlcov/index.html'	View detailed coverage with green/red lines	Visual report shows covered and missed lines
8	Review report and add tests for missed lines	Coverage data will improve on next run	Cycle repeats for better coverage

💡 Coverage report generated and reviewed; testing cycle can repeat to improve coverage.

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	Final
coverage_data	empty	views.py lines covered	models.py lines covered	utils.py missing lines noted	complete coverage data with misses

Key Moments - 2 Insights

Why do some lines show as missing coverage even though tests run?

Because those lines were not executed by any test, as shown in execution_table row 4 where utils.py lines are skipped.

What does the 'coverage html' command do differently than 'coverage report'?

'coverage html' creates a detailed visual report with colored lines, while 'coverage report' shows a summary in the terminal, as seen in rows 5 and 6.

Visual Quiz - 3 Questions

Look at the execution table, what happens at step 4?

A All lines are covered by tests

B Coverage tool marks some lines as missing coverage

C Tests fail to run

D HTML report is generated

💡 Hint

Check the 'Coverage Tool Behavior' column at step 4 in the execution_table.

At which step is the HTML coverage report created?

A Step 2

B Step 3

C Step 6

D Step 8

💡 Hint

Look for 'Generates detailed HTML report' in the execution_table.

If you add tests for missed lines, what will happen to coverage_data after rerunning tests?

A Coverage data will show more lines covered

B Coverage data will be empty

C Coverage data will show fewer lines covered

D Coverage data will not change

💡 Hint

Refer to the last row in execution_table about improving coverage by adding tests.

Concept Snapshot

Coverage Reporting in Django:
- Run tests with 'coverage run manage.py test'
- Use 'coverage report' for terminal summary
- Use 'coverage html' for detailed visual report
- Review missing lines and add tests
- Repeat to improve coverage percentage

Full Transcript

Coverage reporting in Django helps you see which parts of your code are tested. You run your tests with coverage tracking using 'coverage run manage.py test'. The coverage tool watches which lines run during tests. Then you generate a report with 'coverage report' to see a summary in the terminal or 'coverage html' to get a detailed colored report in your browser. This report shows green lines for covered code and red lines for missed code. You can then add tests for missed lines and run coverage again to improve your test coverage. This cycle helps you write better tested Django apps.

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