安装 Flask-Testing¶

使用 pip 或者 easy_install 安装:

pip install Flask-Testing

或者从版本控制系统(github)中下载最新的版本:

git clone https://github.com/jarus/flask-testing.git
cd flask-testing
python setup.py develop

如果你正在使用 virtualenv，假设你会安装 Flask-Testing 在运行你的 Flask 应用程序的同一个 virtualenv 上。

编写测试用例¶

简单地继承 TestCase 的 MyTest:

from flask.ext.testing import TestCase

class MyTest(TestCase):

    pass

你必须定义 create_app 方法，该方法返回一个 Flask 实例:

from flask import Flask
from flask.ext.testing import TestCase

class MyTest(TestCase):

    def create_app(self):

        app = Flask(__name__)
        app.config['TESTING'] = True
        return app

如果不定义 create_app，NotImplementedError 异常将会抛出。

import urllib2
from flask import Flask
from flask.ext.testing import LiveServerTestCase

class MyTest(LiveServerTestCase):

    def create_app(self):
        app = Flask(__name__)
        app.config['TESTING'] = True
        # Default port is 5000
        app.config['LIVESERVER_PORT'] = 8943
        return app

    def test_server_is_up_and_running(self):
        response = urllib2.urlopen(self.get_server_url())
        self.assertEqual(response.code, 200)

@app.route("/ajax/")
def some_json():
    return jsonify(success=True)

class TestViews(TestCase):
    def test_some_json(self):
        response = self.client.get("/ajax/")
        self.assertEquals(response.json, dict(success=True))

class TestNotRenderTemplates(TestCase):

    render_templates = False

    def test_assert_not_process_the_template(self):
        response = self.client.get("/template/")

        assert "" == response.data

class TestNotRenderTemplates(TestCase):

    render_templates = False

    def test_assert_mytemplate_used(self):
        response = self.client.get("/template/")

        self.assert_template_used('mytemplate.html')

def test_something_with_twill(self):

    with Twill(self.app, port=3000) as t:
        t.browser.go(t.url("/"))

from flask.ext.testing import TestCase

from myapp import create_app, db

class MyTest(TestCase):

    SQLALCHEMY_DATABASE_URI = "sqlite://"
    TESTING = True

    def create_app(self):

        # pass in test configuration
        return create_app(self)

    def setUp(self):

        db.create_all()

    def tearDown(self):

        db.session.remove()
        db.drop_all()

class SomeTest(MyTest):

    def test_something(self):

        user = User()
        db.session.add(user)
        db.session.commit()

        # this works
        assert user in db.session

        response = self.client.get("/")

        # this raises an AssertionError
        assert user in db.session

运行测试用例¶

import unittest
import flask.ext.testing

# your test cases

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

更新历史¶

API¶

class flask.ext.testing.TestCase(methodName='runTest')¶

assert200(response)¶

Checks if response status code is 200

Parameters:	response – Flask response

assert400(response)¶

Checks if response status code is 400

Versionadded:	0.2.5
Parameters:	response – Flask response

assert401(response)¶

Checks if response status code is 401

Versionadded:	0.2.1
Parameters:	response – Flask response

assert403(response)¶

Checks if response status code is 403

Versionadded:	0.2
Parameters:	response – Flask response

assert404(response)¶

Checks if response status code is 404

Parameters:	response – Flask response

assert405(response)¶

Checks if response status code is 405

Versionadded:	0.2
Parameters:	response – Flask response

assert500(response)¶

Checks if response status code is 500

Versionadded:	0.4.1
Parameters:	response – Flask response

assertContext(name, value)¶

Checks if given name exists in the template context and equals the given value.

Versionadded:	0.2
Parameters:	name – name of context variable value – value to check against

assertRedirects(response, location)¶

Checks if response is an HTTP redirect to the given location.

Parameters:	response – Flask response location – relative URL (i.e. without http://localhost)

assertStatus(response, status_code)¶

Helper method to check matching response status.

Parameters:	response – Flask response status_code – response status code (e.g. 200)

assertTemplateUsed(name, tmpl_name_attribute='name')¶

Checks if a given template is used in the request. Only works if your version of Flask has signals support (0.6+) and blinker is installed. If the template engine used is not Jinja2, provide tmpl_name_attribute with a value of its Template class attribute name which contains the provided name value.

Versionadded:	0.2
Parameters:	name – template name tmpl_name_attribute – template engine specific attribute name

assert_200(response)¶

Checks if response status code is 200

Parameters:	response – Flask response

assert_400(response)¶

Checks if response status code is 400

Versionadded:	0.2.5
Parameters:	response – Flask response

assert_401(response)¶

Checks if response status code is 401

Versionadded:	0.2.1
Parameters:	response – Flask response

assert_403(response)¶

Checks if response status code is 403

Versionadded:	0.2
Parameters:	response – Flask response

assert_404(response)¶

Checks if response status code is 404

Parameters:	response – Flask response

assert_405(response)¶

Checks if response status code is 405

Versionadded:	0.2
Parameters:	response – Flask response

assert_500(response)¶

Checks if response status code is 500

Versionadded:	0.4.1
Parameters:	response – Flask response

assert_context(name, value)¶

Checks if given name exists in the template context and equals the given value.

Versionadded:	0.2
Parameters:	name – name of context variable value – value to check against

assert_redirects(response, location)¶

Checks if response is an HTTP redirect to the given location.

Parameters:	response – Flask response location – relative URL (i.e. without http://localhost)

assert_status(response, status_code)¶

Helper method to check matching response status.

Parameters:	response – Flask response status_code – response status code (e.g. 200)

assert_template_used(name, tmpl_name_attribute='name')¶

Checks if a given template is used in the request. Only works if your version of Flask has signals support (0.6+) and blinker is installed. If the template engine used is not Jinja2, provide tmpl_name_attribute with a value of its Template class attribute name which contains the provided name value.

Versionadded:	0.2
Parameters:	name – template name tmpl_name_attribute – template engine specific attribute name

create_app()¶

Create your Flask app here, with any configuration you need.

get_context_variable(name)¶

Returns a variable from the context passed to the template. Only works if your version of Flask has signals support (0.6+) and blinker is installed.

Raises a ContextVariableDoesNotExist exception if does not exist in context.

Versionadded:	0.2
Parameters:	name – name of variable

class flask.ext.testing.Twill(app, host='127.0.0.1', port=5000, scheme='http')¶

Versionadded:	0.3

Twill wrapper utility class.

Creates a Twill browser instance and handles WSGI intercept.

Usage:

t = Twill(self.app)
with t:
    t.browser.go("/")
    t.url("/")

url(url)¶

Makes complete URL based on host, port and scheme Twill settings.

Parameters:	url – relative URL

class flask.ext.testing.TwillTestCase(methodName='runTest')¶

Deprecated:	use Twill helper class instead.

Creates a Twill browser instance and handles WSGI intercept.

make_twill_url(url)¶

Makes complete URL based on host, port and scheme Twill settings.

Parameters:	url – relative URL