Testing routes and responses in Flask - Mini Project: Build & Apply

Testing routes and responses

📖 Scenario: You are building a simple web app using Flask. You want to make sure your routes return the correct responses.

🎯 Goal: Create a Flask app with one route, then write tests to check the route's response status code and content.

📋 What You'll Learn

Create a Flask app with a route /hello that returns 'Hello, World!'

Create a test client to test the Flask app

Write a test to check the status code of the /hello route is 200

Write a test to check the response data of the /hello route contains 'Hello, World!'

💡 Why This Matters

🌍 Real World

Testing routes ensures your web app works correctly before users see it. It helps catch bugs early.

💼 Career

Web developers often write tests for their APIs and web routes to maintain quality and reliability.

1

Create a Flask app with a route

Create a Flask app called app and add a route /hello that returns the string 'Hello, World!'.

Flask

# Your code here

Hint

Use Flask(__name__) to create the app and @app.route('/hello') to define the route.

2

Create a test client

Create a test client from the app by calling app.test_client() and assign it to a variable called client.

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/hello')
def hello():
    return 'Hello, World!'

# Create a test client called client
# Your code here

Hint

Use app.test_client() to create the test client.

3

Write a test for status code

Use the client to send a GET request to '/hello' and assign the response to a variable called response. Then check if response.status_code equals 200.

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/hello')
def hello():
    return 'Hello, World!'

client = app.test_client()

# Send GET request to '/hello' and assign to response
# Check if response.status_code == 200
# Your code here

Hint

Use client.get('/hello') to get the response and check response.status_code.

4

Write a test for response content

Check if the response.data contains the bytes of 'Hello, World!' by asserting b'Hello, World!' in response.data.

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/hello')
def hello():
    return 'Hello, World!'

client = app.test_client()

response = client.get('/hello')
assert response.status_code == 200

# Assert that b'Hello, World!' is in response.data
# Your code here

Hint

Remember response data is bytes, so use b'Hello, World!'.

Practice

1. What is the main purpose of using app.test_client() in Flask testing?

easy

A. To create a database connection for testing

B. To start the Flask server for manual testing

C. To simulate HTTP requests to routes without running the server

D. To generate HTML templates automatically

Solution

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

   This method creates a client that can send HTTP requests to the Flask app internally without needing the server to run.

2. Step 2: Compare with other options

   Starting the server or creating a database connection are unrelated to test_client(). It does not generate templates either.

3. Final Answer:

   To simulate HTTP requests to routes without running the server -> Option C

4. Quick Check:

   app.test_client() simulates requests [OK]

Hint: Remember test_client() simulates requests internally [OK]

Common Mistakes:

• Thinking test_client() starts the server
• Confusing test_client() with database setup
• Assuming it generates HTML templates

2. Which of the following is the correct way to test a GET request to the '/' route using Flask's test client?

easy

A. response = client.post('/')

B. response = client.get('/')

C. response = client.request('PUT', '/')

D. response = client.fetch('/')

Solution

1. Step 1: Identify the HTTP method for the route

   The question asks for a GET request, so the method should be get().

2. Step 2: Match the method with the test client syntax

   Flask test client uses client.get(path) to send GET requests. Other methods like post() or request('PUT', ...) are for different HTTP verbs.

3. Final Answer:

   response = client.get('/') -> Option B

4. Quick Check:

   GET request uses client.get() [OK]

Hint: Use client.get() for GET requests in tests [OK]

Common Mistakes:

• Using post() instead of get() for GET requests
• Using client.fetch() which does not exist
• Confusing HTTP methods in test calls

3. Given this Flask test code:

with app.test_client() as client:
    response = client.get('/hello')
    print(response.status_code)
    print(response.data.decode())

If the '/hello' route returns 'Hello, World!' with status 200, what will be printed?

medium

A. 200
Hello, World!

B. 404
Not Found

C. 500
Internal Server Error

D. 200
b'Hello, World!'

Solution

1. Step 1: Understand the route response

   The route '/hello' returns the string 'Hello, World!' with HTTP status 200.

2. Step 2: Analyze the test output

   The response.status_code will be 200. The response.data is bytes, so decoding it with decode() converts it to the string 'Hello, World!'.

3. Final Answer:

   200 Hello, World! -> Option A

4. Quick Check:

   Status 200 and decoded response text [OK]

Hint: Decode response.data to get string content [OK]

Common Mistakes:

• Not decoding response.data (shows bytes)
• Expecting 404 or 500 status codes incorrectly
• Confusing status_code with response content

4. What is wrong with this Flask test code snippet?

client = app.test_client()
response = client.get('/missing')
assert response.status_code == 200

Assuming '/missing' route does not exist.

medium

A. The status code will be 404, so the assertion fails

B. The get method should be post for missing routes

C. The test client must be used inside a context manager

D. The response object does not have status_code attribute

Solution

1. Step 1: Check the route existence

   The route '/missing' does not exist, so Flask returns a 404 Not Found status.

2. Step 2: Evaluate the assertion

   The assertion expects status code 200, but the actual is 404, causing the test to fail.

3. Final Answer:

   The status code will be 404, so the assertion fails -> Option A

4. Quick Check:

   Missing route returns 404, assertion expects 200 [OK]

Hint: Check route exists before asserting status 200 [OK]

Common Mistakes:

• Assuming missing routes return 200
• Thinking get() must be post() for missing routes
• Believing status_code attribute is missing

5. You want to test a Flask route that returns JSON data {"success": true, "count": 5} with status 201. Which test code correctly verifies both the status and JSON content?

hard

A. response = client.get('/data')
assert response.status_code == 201
assert response.json() == {"success": True, "count": 5}

B. response = client.get('/data')
assert response.status_code == 200
assert response.json == {"success": True, "count": 5}

C. response = client.post('/data')
assert response.status_code == 200
assert response.get_json() == {"success": True, "count": 5}

D. response = client.get('/data')
assert response.status_code == 201
assert response.get_json() == {"success": True, "count": 5}

Solution

1. Step 1: Check HTTP method and status code

   The route returns status 201, so the test must assert response.status_code == 201. The method is GET as per the question.

2. Step 2: Verify JSON content correctly

   Flask test response uses get_json() to parse JSON data. Using response.json is incorrect in Flask.

3. Final Answer:

   response = client.get('/data') assert response.status_code == 201 assert response.get_json() == {"success": True, "count": 5} -> Option D

4. Quick Check:

   Use get_json() and check status 201 [OK]

Hint: Use get_json() to check JSON response content [OK]

Common Mistakes:

• Using response.json instead of get_json()
• Checking wrong status code (200 instead of 201)
• Using POST instead of GET method