Coverage reporting in Django - Mini Project: Build & Apply

Coverage Reporting in Django

📖 Scenario: You are working on a Django project and want to check how much of your code is tested by your tests. This helps you find parts of your code that need more tests.

🎯 Goal: Set up coverage reporting in your Django project to measure test coverage and generate a report.

📋 What You'll Learn

Create a Django test file with a simple test case

Add a coverage configuration variable

Run tests with coverage measurement

Generate a coverage report in the terminal

💡 Why This Matters

🌍 Real World

Coverage reporting helps developers see which parts of their Django code are tested and which are not. This improves code quality and confidence.

💼 Career

Many software development jobs require writing tests and measuring coverage to ensure reliable applications.

1

Create a simple Django test case

Create a file called tests.py in your Django app folder. Inside it, write a test class called SimpleTest that inherits from django.test.TestCase. Add a test method called test_addition that checks if 1 + 1 equals 2 using self.assertEqual.

Django

# Your code here

Hint

Remember to import TestCase from django.test. Your test method name must start with test_.

2

Add a coverage configuration variable

Create a variable called COVERAGE_CONFIG and set it to the string ".coveragerc". This will be the name of the coverage configuration file.

Django

from django.test import TestCase

class SimpleTest(TestCase):
    def test_addition(self):
        self.assertEqual(1 + 1, 2)

# Your code here

Hint

This variable holds the filename for coverage settings.

3

Run tests with coverage measurement

Write a command string called coverage_command that runs coverage to measure tests. Set coverage_command to "coverage run --rcfile=.coveragerc manage.py test".

Django

from django.test import TestCase

class SimpleTest(TestCase):
    def test_addition(self):
        self.assertEqual(1 + 1, 2)

COVERAGE_CONFIG = ".coveragerc"

# Your code here

Hint

This command runs tests with coverage using the config file.

4

Generate a coverage report

Write a command string called report_command that generates a coverage report in the terminal. Set report_command to "coverage report --rcfile=.coveragerc".

Django

from django.test import TestCase

class SimpleTest(TestCase):
    def test_addition(self):
        self.assertEqual(1 + 1, 2)

COVERAGE_CONFIG = ".coveragerc"

coverage_command = "coverage run --rcfile=.coveragerc manage.py test"

# Your code here

Hint

This command shows the coverage summary in the terminal.

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