30

我正在开发一个 Flask 应用程序并使用 Flask-security 进行用户身份验证（这反过来又在下面使用 Flask-login）。

我有一条需要身份验证的路线，/user. 我正在尝试编写一个单元测试来测试，对于经过身份验证的用户，这将返回适当的响应。

在我的单元测试中，我正在创建一个用户并以该用户身份登录，如下所示：

from unittest import TestCase
from app import app, db
from models import User
from flask_security.utils import login_user

class UserTest(TestCase):
   def setUp(self):
       self.app = app
       self.client = self.app.test_client()
       self._ctx = self.app.test_request_context()
       self._ctx.push()

       db.create_all()

   def tearDown(self):
       if self._ctx is not None:
           self._ctx.pop()

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

   def test_user_authentication():
       # (the test case is within a test request context)
       user = User(active=True)
       db.session.add(user)
       db.session.commit()
       login_user(user)

       # current_user here is the user
       print(current_user)

       # current_user within this request is an anonymous user
       r = test_client.get('/user')

在测试中current_user返回正确的用户。但是，请求的视图总是AnonymousUser返回current_user.

路线/user定义为：

class CurrentUser(Resource):
    def get(self):
        return current_user  # returns an AnonymousUser

我很确定我只是没有完全理解测试 Flask 请求上下文是如何工作的。我已经阅读了很多 Flask Request Context 文档，但我仍然不明白如何处理这个特定的单元测试。

4

4 回答 4

34

问题是不同的请求上下文。

在您的普通 Flask 应用程序中，每个请求都会创建一个新的上下文，该上下文将在整个链中重复使用，直到创建最终响应并将其发送回浏览器。

当您创建和运行 Flask 测试并执行请求（例如self.client.post(...)）时，上下文在收到响应后被丢弃。因此，current_user始终是AnonymousUser。

为了解决这个问题，我们必须告诉 Flask 在整个测试中重用相同的上下文。您可以通过简单地包装您的代码来做到这一点：

with self.client:

您可以在以下精彩文章中阅读有关此主题的更多信息： https ://realpython.com/blog/python/python-web-applications-with-flask-part-iii/

例子

前：

def test_that_something_works():
    response = self.client.post('login', { username: 'James', password: '007' })

    # this will fail, because current_user is an AnonymousUser
    assertEquals(current_user.username, 'James')

后：

def test_that_something_works():
    with self.client:
        response = self.client.post('login', { username: 'James', password: '007' })

        # success
        assertEquals(current_user.username, 'James')
于 2015-03-02T17:35:38.700 回答
15

问题是test_client.get()调用会导致一个新的请求上下文被推送，所以你在setUp()测试用例的方法中推送的那个不是/user处理程序看到的那个。

我认为文档的登录和注销以及测试添加消息部分中显示的方法是测试登录的最佳方法。这个想法是通过应用程序发送登录请求，就像普通客户端一样。这将负责在测试客户端的用户会话中注册登录用户。

于 2014-02-02T04:13:44.150 回答
6

我不太喜欢显示的其他解决方案，主要是因为您必须将密码保存在单元测试文件中（而且我使用的是 Flask-LDAP-Login，因此添加虚拟用户等并不明显），所以我绕过它：

在我设置测试应用程序的地方，我添加了：

@app.route('/auto_login')
def auto_login():
    user = ( models.User
             .query
             .filter_by(username="Test User")
             .first() )
    login_user(user, remember=True)
    return "ok"

但是，我对烧瓶应用程序的测试实例进行了很多更改，例如使用不同的数据库，我在其中构建它，因此添加路由不会使代码明显混乱。Obv 这条路线在真实的应用程序中不存在。

然后我做：

def login(self):
    response = self.app.test_client.get("/auto_login")

之后所做的任何事情test_client都应该登录。

于 2014-10-23T16:56:16.167 回答
1

来自文档：https ://flask-login.readthedocs.io/en/latest/

单元测试时可以方便的全局关闭鉴权。要启用此功能，如果应用程序配置变量 LOGIN_DISABLED 设置为 True，则此装饰器将被忽略。

于 2019-12-27T19:12:26.267 回答