如何使用HTTPBasicAuth批注测试Flask路由器方法

时间:2018-07-09 14:41:27

标签: python python-3.x testing flask python-unittest

我是Python的新手,我尝试在Flask上实现REST API服务。我遇到了与代码测试有关的问题。我的Flask应用看起来像这样:

from flask import Flask, jsonify, make_response, request
from flask_httpauth import HTTPBasicAuth
import os

auth = HTTPBasicAuth()

@auth.get_password
def get_password(username):
    if username == os.environ['SERVICE_KEY']:
        return os.environ['SERVICE_PASS']
    return None

@auth.error_handler
def unauthorized():
    return make_response(jsonify({'error': 'Unauthorized access'}), 403)

app = Flask(__name__)

tweets = [
    {
        'id': 1,
        'profileId': '1',
        'message': 'My test tweet'
    },
    {
        'id': 2,
        'profileId': '1',
        'message': 'Second tweet!'
    }
]

@app.route('/api/v1/tweets', methods=['GET'])
@auth.login_required
def get_tweets():
    return jsonify({'tweets': tweets}), 200

@app.errorhandler(404)
@auth.login_required
def not_found(error):
    return make_response(jsonify({'error': 'Not found'}), 404)

if __name__ == '__main__':
    app.run(debug=True)

这是我的测试(当前仅适用于not_found方法):

import unittest
from app import app

class TestApp(unittest.TestCase):

    def setUp(self):
        self.app = app.test_client()

    def test_404(self):
        rv = self.app.get('/i-am-not-found')
        self.assertEqual(rv.status_code, 404)


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

但是当我尝试运行测试时,由于收到“未经授权的访问”响应而失败:

>python test.py
F
======================================================================
FAIL: test_404 (__main__.TestApp)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "test.py", line 25, in test_404
    self.assertEqual(rv.status_code, 404)
AssertionError: 403 != 404

----------------------------------------------------------------------
Ran 1 test in 0.000s

FAILED (failures=1)

哪种方法测试路由方法更适合处理授权?以及如何解决失败的测试?

1 个答案:

答案 0 :(得分:1)

您需要创建一个包含您的身份验证详细信息的自定义标头,并将其与您的请求一起发送。像这样:

from base64 import b64encode    
...
headers = {'Authorization': 'Basic ' + b64encode("{0}:{1}".format(username, password))}
rv = self.app.get('/i-am-not-found', headers=headers)
...


import unittest
from app import app

class TestApp(unittest.TestCase):

    def setUp(self):
        self.app = app.test_client()

    def test_404(self):
        headers = {
            'Authorization': 'Basic ' + b64encode("username:password")
        }
        rv = self.app.get('/i-am-not-found', headers=headers)
        self.assertEqual(rv.status_code, 404)


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

您的用户名和密码以username:password的形式发送,但使用base64编码。如果要对此进行扩展,则可以使用一些方法来简化此过程,例如提取到始终传递标头的函数并外部化用户名/密码进行测试。

编辑:另外,我认为您应该在此处返回401代码。通常在凭据不正确时使用401,在成功认证自己但无权访问资源时通常使用403。一个非常简化的示例已登录到Facebook,但被禁止访问标记为私人的他人照片。