Testing with database in Flask

Introduction

Testing with a database helps ensure your app works well with stored data. It checks if saving, reading, and updating data behaves as expected.

When you want to check if your app correctly saves user info.

When you need to verify that data updates happen without errors.

When you want to test queries that fetch data from the database.

When you want to catch bugs related to database connections or transactions.

Syntax

Flask

import unittest
from yourapp import create_app, db

class TestDatabase(unittest.TestCase):
    def setUp(self):
        self.app = create_app('testing')
        self.app_context = self.app.app_context()
        self.app_context.push()
        db.create_all()
        self.client = self.app.test_client()

    def tearDown(self):
        db.session.remove()
        db.drop_all()
        self.app_context.pop()

Use setUp to prepare a fresh test database before each test.

Use tearDown to clean up after each test to avoid leftover data.

Examples

This test adds a user and checks if the user count is 1.

Flask

def test_add_user(self):
    user = User(username='testuser')
    db.session.add(user)
    db.session.commit()
    self.assertEqual(User.query.count(), 1)

This test saves a user and then queries to confirm it exists.

Flask

def test_query_user(self):
    user = User(username='alice')
    db.session.add(user)
    db.session.commit()
    found = User.query.filter_by(username='alice').first()
    self.assertIsNotNone(found)

Sample Program

This example creates a simple Flask app with an in-memory database. It tests adding a user and then querying that user to confirm it was saved correctly.

Flask

import unittest
from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///:memory:'
app.config['TESTING'] = True

app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

db = SQLAlchemy(app)

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), unique=True, nullable=False)

class TestDatabase(unittest.TestCase):
    def setUp(self):
        self.app = app
        self.app_context = self.app.app_context()
        self.app_context.push()
        db.create_all()

    def tearDown(self):
        db.session.remove()
        db.drop_all()
        self.app_context.pop()

    def test_add_and_query_user(self):
        user = User(username='tester')
        db.session.add(user)
        db.session.commit()
        found = User.query.filter_by(username='tester').first()
        self.assertIsNotNone(found)
        self.assertEqual(found.username, 'tester')

if __name__ == '__main__':
    unittest.main()

Important Notes

Use an in-memory SQLite database for fast, isolated tests.

Always clean up the database after each test to avoid interference.

Use Flask's app.app_context() to access app resources during tests.

Summary

Testing with a database ensures your app handles data correctly.

Use setUp and tearDown to prepare and clean the test database.

Use simple queries to check if data is saved and retrieved as expected.

Practice

1. What is the main purpose of using a test database in Flask testing?

easy

A. To store user sessions permanently

B. To isolate tests so they don't affect the real data

C. To speed up the app in production

D. To replace the main database in deployment

Solution

1. Step 1: Understand test database role

   A test database is used to keep test data separate from real data to avoid unwanted changes.

2. Step 2: Identify isolation benefit

   This isolation ensures tests do not affect the real app data or state.

3. Final Answer:

   To isolate tests so they don't affect the real data -> Option B

4. Quick Check:

   Test database isolates data = C [OK]

Hint: Test DB keeps test data separate from real data [OK]

Common Mistakes:

• Thinking test DB speeds up production
• Confusing test DB with session storage
• Assuming test DB replaces main DB in deployment

2. Which Flask testing method is used to prepare the test database before each test runs?

easy

A. tearDown

B. initTest

C. setUp

D. runTest

Solution

1. Step 1: Recall Flask test lifecycle methods

   In Flask testing, setUp runs before each test to prepare the environment.

2. Step 2: Match method to database preparation

   Preparing the test database (like creating tables) happens in setUp.

3. Final Answer:

   setUp -> Option C

4. Quick Check:

   Prepare DB before test = setUp [OK]

Hint: Use setUp to prepare before each test [OK]

Common Mistakes:

• Confusing tearDown with setup
• Using runTest which is not for setup
• Assuming initTest is a Flask method

3. Given this test code snippet, what will print(len(users)) output?

def test_user_creation(self):
    user = User(name='Anna')
    db.session.add(user)
    db.session.commit()
    users = User.query.all()
    print(len(users))

medium

A. 1

B. 0

C. Error: session not initialized

D. Multiple users depending on previous tests

Solution

1. Step 1: Analyze user addition and commit

   The code adds one user and commits to the test database.

2. Step 2: Query all users after commit

   Querying all users returns a list with the one added user.

3. Final Answer:

   1 -> Option A

4. Quick Check:

   One user added and committed = 1 [OK]

Hint: Commit before query to see added users [OK]

Common Mistakes:

• Forgetting to commit before query
• Assuming previous tests add users
• Thinking session is not initialized

4. What is wrong with this test code snippet?

def tearDown(self):
    db.session.remove()
    db.drop_all()

medium

A. Missing call to create_all() in tearDown

B. tearDown should not remove session

C. drop_all() should be in setUp, not tearDown

D. No call to rollback() before drop_all()

Solution

1. Step 1: Understand tearDown purpose

   tearDown cleans up after tests by removing session and dropping tables.

2. Step 2: Identify missing rollback before drop_all()

   Without rollback, pending changes may not be discarded, potentially causing errors or inconsistent state.

3. Final Answer:

   No call to rollback() before drop_all() -> Option D

4. Quick Check:

   Rollback before drop_all to discard changes [OK]

Hint: Always rollback before dropping tables in tearDown [OK]

Common Mistakes:

• Thinking create_all belongs in tearDown
• Believing session removal is wrong in tearDown
• Ignoring rollback before drop_all

5. You want to test a Flask app that uses a database. Which sequence correctly sets up and cleans the test database for each test?

hard

A. Call db.create_all() in setUp, run test, then db.drop_all() in tearDown

B. Call db.drop_all() in setUp, run test, then db.create_all() in tearDown

C. Call db.session.commit() in setUp, then db.session.remove() in tearDown

D. Call db.create_all() and db.drop_all() both in setUp

Solution

1. Step 1: Understand test setup and cleanup

   Creating tables before each test ensures a fresh database state.

2. Step 2: Understand test teardown

   Dropping tables after each test cleans up to avoid data carryover.

3. Step 3: Match correct sequence

   Calling create_all() in setUp and drop_all() in tearDown is the correct pattern.

4. Final Answer:

   Call db.create_all() in setUp, run test, then db.drop_all() in tearDown -> Option A

5. Quick Check:

   Create tables before, drop after test = A [OK]

Hint: Create tables before test, drop after test [OK]

Common Mistakes:

• Dropping tables before test instead of after
• Calling create_all and drop_all both in setUp
• Confusing commit with setup/teardown