web-dev-qa-db-ja.com

テスト用にSQLAlchemyを使用してFlaskアプリケーションをどのように設定しますか？

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のWebサイトには、アプリケーションファクトリの作成に関するページがいくつかありますが、それを実行した場合に、どこでもappとdbをどのように使用できるかは明確ではありません。

Flaskアプリケーションを別のデータベースでテストするスクリプトを作成するにはどうすればよいですか？これを可能にするためにアプリケーションをどのように構成する必要がありますか？modulesを使用する必要がありますか？

pythonunit-testingtestingsqlalchemyflask
26
Nick Retallack

環境変数を使用するというあなたの本能は正しいです。ただし、間違ったデータベースで単体テストを実行する危険性があります。また、すべてのリクエストで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'

したがって、ベースのTestCaseでデータベースを明示的に設定できます。

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。

11
Skylar Saveland

インポート時にデータベースへの接続を行わせたくないでしょう。アプリをテストまたは実行する前に、いつでもテストで構成を微調整できるため、インポート時にアプリを構成してください。以下の例では、アプリケーション構成を使用するいくつかの関数の背後にデータベース接続があるため、単体テストで実際にデータベース接続を変更して別のファイルを指すようにしてから、セットアップで明示的に接続できます。

次のような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関数を適切に更新する必要がありますが、うまくいけば、アイデアが得られます。

6
stderr

まず、スクリプトでFlask appを直接インスタンス化する代わりに、 アプリケーションファクトリ を使用します。これは、構成ファイルをパラメーターとして受け取る関数を作成し、インスタンス化されたアプリオブジェクト。次に、パラメーターなしでグローバル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.

私の場合、Flask-SQLAlchemyの代わりにscoped_sessionでSQLAlchemyを直接使用しています。私も同じことをしましたが、 Lazy SQLAlchemy setup を使用しました。

3
Charles Brunet