如何使用 SQLAlchemy 设置 Flask 应用程序进行测试？

Question

Flask 中的常见做法似乎是这样开始的：

from flask import Flask
from flaskext.sqlalchemy import SQLAlchemy
app = Flask(__name__)
SQLALCHEMY_DATABASE_URI = 'something'
app.config.from_object(__name__)
db = SQLAlchemy(app)

然后在任何地方导入并使用 app 和 db 。但是，当您像这样创建 db 时，它会从应用程序中获取配置，并且似乎该配置一旦发生就无法被覆盖。 Flask 的网站上有一些关于创建应用程序工厂的页面，但不清楚如果我这样做的话，我如何能够在任何地方仍然使用 app 和 db 。

如何编写脚本来使用不同的数据库测试我的 Flask 应用程序？我应该如何构建我的应用程序才能实现这一点？我必须使用模块吗？

Answer 1

您使用环境变量的直觉是正确的。但是，使用错误的数据库运行单元测试存在一些危险。另外，您可能不希望在每个请求以及想要使用 db 的任何地方都使用 connect_db。您可以使用显式设置的配置目录和环境变量。这是迄今为止我想出的最好的办法。

run.py
shell.py

config/__init__.py
config/test.py
config/postgres.py
...

main/__init__.py
main/someapp/__init__.py
main/someapp/models.py

...
main/tests/__init__.py
main/tests/testutils.py

所以，配置文件可能是：

# config/test.py
SQLALCHEMY_DATABASE_URI = "sqlite://"

所以

# config/postgres.py
SQLALCHEMY_DATABASE_URI = 'postgresql://user:pw@localhost/somedb'

，我可以在我的基本测试用例中显式设置数据库：

import os
from flask.ext.testing import TestCase

os.environ["DIAG_CONFIG_MODULE"] = "config.test"
from main import app, db


class SQLAlchemyTest(TestCase):

    def create_app(self):
        return app

    def setUp(self):
        db.create_all()

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

然后，对我来说，main/__init__.py：

import os

from flask import Flask, render_template, g
from flask.ext.sqlalchemy import SQLAlchemy

# by default, let's use a DB we don't care about
# but, we can override if we want
config_obj = os.environ.get("DIAG_CONFIG_MODULE", "config.test")
app = Flask(__name__)
app.config.from_object(config_obj)
db = SQLAlchemy(app)

@app.before_request
def before_request():
    g.db = db
    g.app = app

# ...
@app.route('/', methods=['GET'])
def get():
    return render_template('home.html')
# ...    
from main.someapp.api import mod as someappmod
app.register_blueprint(someappmod)

然后，在其他文件中，我知道我想运行什么配置，可能：

# run.py
import os
os.environ["DIAG_CONFIG_MODULE"] = "config.postgres"
from main import app
app.run(debug=True)

也许

# shell.py
import os
os.environ["DIAG_CONFIG_MODULE"] = "config.postgres"

from main import app, db
from main.symdiag.models import *
from main.auth.models import *
print sorted(k for k in locals().keys() if not k.startswith("_"))
import IPython
IPython.embed()

..到目前为止最好的：P。

Answer 2

您不希望在导入时连接到数据库。继续在导入时配置您的应用程序，因为您始终可以在尝试测试或运行应用程序之前调整测试中的配置。在下面的示例中，您的数据库连接将位于一些使用应用程序配置的函数后面，因此在单元测试中，您实际上可以更改数据库连接以指向不同的文件，然后继续并在您的设置中显式连接。

假设您有一个包含 myapp.py 的 myapp 包，如下所示：

# myapp/myapp.py
from __future__ import with_statement
from sqlite3 import dbapi2 as sqlite3
from contextlib import closing
from flask import Flask, request, session, g, redirect, url_for, abort, \
     render_template, flash

# configuration
DATABASE = '/tmp/flaskr.db'
DEBUG = True
SECRET_KEY = 'development key'
USERNAME = 'admin'
PASSWORD = 'default'

# create our little application :)
app = Flask(__name__)
app.config.from_object(__name__)
app.config.from_envvar('MYAPP_SETTINGS', silent=True)

def connect_db():
    """Returns a new connection to the database."""
    return sqlite3.connect(app.config['DATABASE'])


def init_db():
    """Creates the database tables."""
    with closing(connect_db()) as db:
        with app.open_resource('schema.sql') as f:
            db.cursor().executescript(f.read())
        db.commit()


@app.before_request
def before_request():
    """Make sure we are connected to the database each request."""
    g.db = connect_db()


@app.after_request
def after_request(response):
    """Closes the database again at the end of the request."""
    g.db.close()
    return response

@app.route('/')
def show_entries():
    cur = g.db.execute('select title, text from entries order by id desc')
    entries = [dict(title=row[0], text=row[1]) for row in cur.fetchall()]
    return render_template('show_entries.html', entries=entries)

if __name__=="__main__":
    app.run()

您的测试文件 myapp/test_myapp.py 将如下所示：

import os
import myapp
import unittest
import tempfile

class MyappTestCase(unittest.TestCase):

    def setUp(self):
        self.db_fd, myapp.app.config['DATABASE'] = tempfile.mkstemp()
        self.app = myapp.app.test_client()
        myapp.init_db()

    def tearDown(self):
        os.close(self.db_fd)
        os.unlink(myapp.app.config['DATABASE'])

    def test_empty_db(self):
        rv = self.app.get('/')
        assert 'No entries here so far' in rv.data

当然，如果您想使用 SQLAlchemy，则必须适当更新 connect_db 和 init_db 函数，但是希望你能明白。

Answer 3

首先，您不是直接在脚本中实例化 Flask 应用程序，而是使用应用程序工厂。这意味着您创建一个以配置文件作为参数的函数，并返回实例化的应用程序对象。然后，您创建不带参数的全局 SQLAlchemy 对象，并在创建应用程序时配置它，如此处所述。

db = SQLAlchemy()

def create_app(configfile):
    app = Flask(__name__)

    app.config.from_pyfile(config, silent=True)
    db.init_app(app)

    # create routes, etc.

    return app

要运行该应用程序，您只需执行以下操作：

app = create_app('config.py')
app.run()

要运行单元测试，您可以执行以下操作：

class Test(TestCase):
    def setUp(self):
        # init test database, etc.
        app = create_app('test_config.py')
        self.app = app.test_client()
    def tearDown(self):
        # delete test database, etc.

在我的例子中，我直接使用 SQLAlchemy 和scoped_session 而不是 Flask-SQLAlchemy。
我也做了同样的事情，但是使用了Lazy SQLAlchemy 设置。