Testing forms and POST data in Flask - Mini Project: Build & Apply

Testing forms and POST data

📖 Scenario: You are building a simple Flask web app that has a form where users can submit their name. You want to test that the form correctly sends the data using POST and that your Flask route processes it properly.

🎯 Goal: Build a Flask app with a form that submits a user's name via POST. Then write a test that sends POST data to the route and checks the response.

📋 What You'll Learn

Create a Flask app with a route /submit that accepts POST requests

Add a simple HTML form with a text input named username and a submit button

Write a test function using Flask's test client to send POST data with username

Verify the response contains the submitted username

💡 Why This Matters

🌍 Real World

Web developers often need to test that forms correctly send data and that backend routes process it as expected.

💼 Career

Testing form submissions is a common task in backend web development roles to ensure reliable user input handling.

1

Create the Flask app and route

Create a Flask app instance called app. Define a route /submit that accepts POST requests and returns the text Received: plus the value of username from the form data.

Flask

from flask import Flask, request

# Create Flask app instance

# Define /submit route that accepts POST

# Return 'Received: ' plus username from form data

Hint

Use request.form.get('username') to get the form data inside the route.

2

Add a simple HTML form

Add a route / that returns an HTML form with method POST and action /submit. The form should have a text input with name username and a submit button.

Flask

from flask import Flask, request

app = Flask(__name__)

@app.route('/submit', methods=['POST'])
def submit():
    username = request.form.get('username', '')
    return f"Received: {username}"

# Add route / that returns HTML form

Hint

Use triple quotes ''' to return multi-line HTML string in the route.

3

Write a test function to POST data

Write a test function called test_submit_post that uses app.test_client() to send a POST request to /submit with form data {'username': 'Alice'}. Store the response in a variable called response.

Flask

from flask import Flask, request

app = Flask(__name__)

@app.route('/')
def index():
    return '''
                
                Submit
              '''

@app.route('/submit', methods=['POST'])
def submit():
    username = request.form.get('username', '')
    return f"Received: {username}"

# Write test function test_submit_post

Hint

Use with app.test_client() as client: to create a test client context.

4

Check the response contains the username

Inside the test_submit_post function, add an assertion that checks response.data contains the bytes string b'Received: Alice'.

Flask

from flask import Flask, request

app = Flask(__name__)

@app.route('/')
def index():
    return '''
                
                Submit
              '''

@app.route('/submit', methods=['POST'])
def submit():
    username = request.form.get('username', '')
    return f"Received: {username}"

def test_submit_post():
    with app.test_client() as client:
        response = client.post('/submit', data={'username': 'Alice'})
        # Add assertion to check response data

Hint

Use assert b'Received: Alice' in response.data to check the response content.

Practice

1. What is the main purpose of using test_client() in Flask when testing forms and POST data?

easy

A. To automatically generate HTML forms for the app

B. To simulate HTTP requests like POST and test form handling without running the server

C. To create a real web server for users to submit forms

D. To store form data permanently in the database

Solution

1. Step 1: Understand the role of test_client()

   The test_client() in Flask creates a fake client that can send HTTP requests to the app without starting a real server.

2. Step 2: Identify what it simulates

   This client can simulate POST requests with form data to test how the app handles them.

3. Final Answer:

   To simulate HTTP requests like POST and test form handling without running the server -> Option B

4. Quick Check:

   test_client() simulates requests = C [OK]

Hint: Remember test_client() fakes requests, no real server needed [OK]

Common Mistakes:

• Thinking test_client() starts a real server
• Confusing test_client() with form creation
• Assuming test_client() stores data permanently

2. Which of the following is the correct way to send form data using Flask's test client for a POST request?

easy

A. client.post('/submit', data={'name': 'Alice'})

B. client.get('/submit', data={'name': 'Alice'})

C. client.post('/submit', json={'name': 'Alice'})

D. client.post('/submit', params={'name': 'Alice'})

Solution

1. Step 1: Identify the HTTP method for form submission

   Forms usually send data with POST requests, so client.post() is correct.

2. Step 2: Check how to send form data

   Form data is sent using the data argument as a dictionary, not json or params.

3. Final Answer:

   client.post('/submit', data={'name': 'Alice'}) -> Option A

4. Quick Check:

   POST with data dict = D [OK]

Hint: Use post() with data={} for form POST, not json or params [OK]

Common Mistakes:

• Using GET instead of POST for form submission
• Sending form data as JSON instead of form data
• Using params instead of data for POST

3. Given this Flask test code snippet, what will response.status_code be if the form is handled correctly?

with app.test_client() as client:
    response = client.post('/login', data={'username': 'user', 'password': 'pass'})

medium

A. 302

B. 404

C. 500

D. 200

Solution

1. Step 1: Understand typical form POST response

   After a successful login POST, apps often redirect to another page, sending a 302 status code.

2. Step 2: Recognize status codes meaning

   200 means OK (page loaded), 404 means not found, 500 means server error, 302 means redirect.

3. Final Answer:

   302 -> Option A

4. Quick Check:

   Successful POST login usually redirects = 302 [OK]

Hint: Successful POST often returns redirect status 302 [OK]

Common Mistakes:

• Expecting 200 instead of 302 after POST redirect
• Confusing 404 with form errors
• Assuming server error 500 on success

4. You wrote this test code but it fails with a TypeError: post() got an unexpected keyword argument 'params'. What is the error?

response = client.post('/submit', params={'field': 'value'})

medium

A. Add headers to specify content type

B. Change 'post' to 'get' method

C. Remove the dictionary and send raw string data

D. Use 'data' instead of 'params' to send form data

Solution

1. Step 1: Identify the invalid argument

   The error says params is unexpected for post(), meaning it's not a valid argument.

2. Step 2: Use correct argument for form data

   Flask test client expects form data in the data argument, not params.

3. Final Answer:

   Use 'data' instead of 'params' to send form data -> Option D

4. Quick Check:

   post() uses data= for form data, not params= [OK]

Hint: Use data= for POST form data, params= is invalid [OK]

Common Mistakes:

• Using params= instead of data= for POST
• Switching to GET without reason
• Ignoring error message details

5. You want to test a Flask form that accepts multiple fields and returns JSON with a success message. Which test code correctly sends form data and checks the JSON response?

with app.test_client() as client:
    response = client.post('/api/form', ???)
    data = response.get_json()
    assert data['status'] == 'success'

What should replace ????

hard

A. json={'field1': 'value1', 'field2': 'value2'}

B. params={'field1': 'value1', 'field2': 'value2'}

C. data={'field1': 'value1', 'field2': 'value2'}, content_type='application/x-www-form-urlencoded'

D. data='field1=value1&field2=value2'

Solution

1. Step 1: Choose correct data format for form POST

   Forms send data as URL-encoded, so data= with content_type='application/x-www-form-urlencoded' is needed.

2. Step 2: Understand JSON vs form data

   Using json= sends JSON body, not form data; params= is invalid; raw string without content type may fail.

3. Final Answer:

   data={'field1': 'value1', 'field2': 'value2'}, content_type='application/x-www-form-urlencoded' -> Option C

4. Quick Check:

   Form POST needs data= and correct content_type [OK]

Hint: Send form data with data= and set content_type for POST [OK]

Common Mistakes:

• Using json= instead of data= for form POST
• Forgetting to set content_type for form data
• Using params= which is invalid