Testing forms in Django - Mini Project: Build & Apply

Testing forms

📖 Scenario: You are building a simple Django web app with a form for users to submit their name and email. You want to write tests to check that the form works correctly.

🎯 Goal: Write Django form tests step-by-step to verify the form validates input and saves data properly.

📋 What You'll Learn

Create a Django form class with fields name and email

Add a test case class to test the form

Write a test to check the form is valid with correct data

Write a test to check the form is invalid with missing data

💡 Why This Matters

🌍 Real World

Forms are common in web apps for user input. Testing forms ensures users cannot submit wrong or incomplete data.

💼 Career

Django developers often write form tests to maintain app quality and prevent bugs in user input handling.

1

Create the form class

Create a Django form class called ContactForm with two fields: name as a CharField and email as an EmailField.

Django

# Your code here to create ContactForm with name and email fields

Hint

Use forms.Form as the base class. Define name and email as form fields.

2

Set up the test case class

Create a Django test case class called ContactFormTest that inherits from django.test.TestCase.

Django

from django import forms
from django.test import TestCase

class ContactForm(forms.Form):
    name = forms.CharField()
    email = forms.EmailField()

# Your code here to create ContactFormTest inheriting from TestCase

Hint

Import TestCase from django.test. Define an empty test class for now.

3

Write a test for valid form data

Inside ContactFormTest, write a test method called test_form_valid_data that creates a ContactForm with valid name and email data and asserts the form is valid using form.is_valid().

Django

from django import forms
from django.test import TestCase

class ContactForm(forms.Form):
    name = forms.CharField()
    email = forms.EmailField()

class ContactFormTest(TestCase):
    # Your code here to write test_form_valid_data method

Hint

Create the form with a dictionary of valid data. Use self.assertTrue to check validity.

4

Write a test for invalid form data

Inside ContactFormTest, write a test method called test_form_invalid_data that creates a ContactForm with missing email and asserts the form is invalid using form.is_valid().

Django

from django import forms
from django.test import TestCase

class ContactForm(forms.Form):
    name = forms.CharField()
    email = forms.EmailField()

class ContactFormTest(TestCase):
    def test_form_valid_data(self):
        form = ContactForm(data={'name': 'Alice', 'email': '[e-mail]'})
        self.assertTrue(form.is_valid())

    # Your code here to write test_form_invalid_data method

Hint

Create the form with missing email. Use self.assertFalse to check it is invalid.

Practice

1. What does the form.is_valid() method do in Django form testing?

easy

A. Checks if the form data meets all validation rules

B. Saves the form data to the database

C. Clears all data from the form

D. Returns the form's HTML code

Solution

1. Step 1: Understand the purpose of form.is_valid()

   This method runs all validation checks on the form data to ensure it meets the rules defined in the form fields.

2. Step 2: Identify what form.is_valid() returns

   It returns True if all data is valid, otherwise False. It does not save or clear data.

3. Final Answer:

   Checks if the form data meets all validation rules -> Option A

4. Quick Check:

   Validation check = A [OK]

Hint: Remember: is_valid() checks data correctness, not saving [OK]

Common Mistakes:

• Thinking is_valid() saves data
• Confusing is_valid() with form rendering
• Assuming is_valid() clears form data

2. Which of the following is the correct way to create a form instance with POST data in a Django test?

easy

A. form = MyForm(request.GET)

B. form = MyForm(data=request.GET)

C. form = MyForm()

D. form = MyForm(request.POST)

Solution

1. Step 1: Recall how to instantiate a form with POST data

   In Django, you pass POST data directly as the first argument to the form constructor, like MyForm(request.POST).

2. Step 2: Evaluate each option

   form = MyForm(request.GET) uses GET data, which is incorrect for POST forms. form = MyForm(data=request.GET) uses GET data with keyword argument data=, incorrect for POST. form = MyForm(request.POST) correctly passes request.POST as the first argument. form = MyForm() creates an empty form without data.

3. Final Answer:

   form = MyForm(request.POST) -> Option D

4. Quick Check:

   Form with POST data = C [OK]

Hint: Pass POST data as first argument: MyForm(request.POST) [OK]

Common Mistakes:

• Using GET data instead of POST
• Forgetting to pass data to the form
• Using incorrect keyword arguments

3. Given the following form test code, what will print(form.errors) output if the 'email' field is missing?

data = {'name': 'Alice'}
form = ContactForm(data)
form.is_valid()
print(form.errors)

medium

A. {'email': ['This field is required.']}

B. {}

C. {'name': ['Invalid input.']}

D. None

Solution

1. Step 1: Understand form validation with missing required fields

   If a required field like 'email' is missing, form.is_valid() returns False and form.errors contains an error message for that field.

2. Step 2: Analyze the error output

   The error dictionary will have a key 'email' with a list containing the message 'This field is required.' since 'email' was not provided.

3. Final Answer:

   {'email': ['This field is required.']} -> Option A

4. Quick Check:

   Missing required field error = D [OK]

Hint: Missing required field shows error in form.errors [OK]

Common Mistakes:

• Expecting empty errors when required field missing
• Confusing error keys with field names
• Assuming errors is None instead of a dict

4. Identify the error in this Django form test snippet:

form = MyForm()
form.is_valid()
print(form.errors)

Why might form.errors always be empty here?

medium

A. form.errors only shows errors after saving

B. is_valid() was not called before accessing errors

C. Form was not given any data to validate

D. MyForm has no fields defined

Solution

1. Step 1: Check how the form instance is created

   The form is created without passing any data, so it has no input to validate.

2. Step 2: Understand why errors are empty

   Without data, form.is_valid() returns False but form.errors is empty because no fields were checked against input data.

3. Final Answer:

   Form was not given any data to validate -> Option C

4. Quick Check:

   No data means no validation errors = A [OK]

Hint: Always pass data to form to test validation errors [OK]

Common Mistakes:

• Assuming errors appear without data
• Forgetting to call is_valid() before errors
• Thinking errors require saving form

5. You want to test a Django form that has a custom clean method rejecting empty 'username' and a password confirmation field. Which test approach correctly checks both validations?

hard

A. Submit data with valid 'username' and matching passwords, then check form.errors is empty

B. Submit data with empty 'username' and mismatched passwords, then check form.errors for both fields

C. Submit data with empty 'username' only, ignoring password fields

D. Submit data with mismatched passwords only, ignoring 'username'

Solution

1. Step 1: Understand the form validations

   The form has two validations: a custom clean method that rejects empty 'username' and a password confirmation check.

2. Step 2: Design a test that triggers both errors

   To test both, submit data with an empty 'username' and mismatched passwords, then call form.is_valid() and check form.errors contains errors for both fields.

3. Final Answer:

   Submit data with empty 'username' and mismatched passwords, then check form.errors for both fields -> Option B

4. Quick Check:

   Test all validations with bad data = B [OK]

Hint: Test all validations by submitting data that breaks each rule [OK]

Common Mistakes:

• Testing only one validation at a time
• Ignoring password confirmation in tests
• Assuming valid data tests validation errors