Аутентифицировать клиента модульного тестирования Flask из другого сервиса (архитектура микросервисов)? - PullRequest
2 голосов
/ 09 апреля 2019

Проблема:

Итак, моя проблема в том, что у меня микросервис Flask хочет внедрить в него модульные тесты, поэтому, когда я начинаю писать свои тесты, я обнаружил, что мне нужно аутентифицировать клиента модульного тестирования из-за некоторыхконечные точки нуждаются в авторизации, и здесь возникает проблема всей системы аутентификации в другом сервисе, который все службы могут делать с аутентификацией, заключается в проверке токена JWT и получении идентификатора пользователя из него, так что вот один из views.py

from flask_restful import Resource

from common.decorators import authorize


class PointsView(Resource):
    decorators = [authorize]

    def get(self, user):
        result = {"points": user.active_points}
        return result

и авторизовать декоратор из decorators.py

import flask
import jwt
from jwt.exceptions import DecodeError, InvalidSignatureError
from functools import wraps
from flask import request
from flask import current_app as app

from app import db
from common.models import User
from common.utils import generate_error_response

def authorize(f):
    """This decorator for validate the logged in user """

    @wraps(f)
    def decorated_function(*args, **kwargs):
        if 'Authorization' not in request.headers:
            return "Unable to log in with provided credentials.", 403

        raw_token = request.headers.get('Authorization')
        if raw_token[0:3] != 'JWT':
            return generate_error_response("Unable to log in with provided credentials.", 403)
        token = str.replace(str(raw_token), 'JWT ', '')
        try:
            data = jwt_decode_handler(token)
        except (DecodeError, InvalidSignatureError):
            return generate_error_response("Unable to log in with provided credentials.", 403)

        user = User.query.filter_by(id=int(data['user_id'])).first()
        return f(user, *args, **kwargs)

    return decorated_function

и контрольный пример из tests.py

import unittest

from app import create_app, db
from common.models import User


class TestMixin(object):
    """
    Methods to help all or most Test Cases
    """

    def __init__(self):
        self.user = None

    """ User Fixture for testing """

    def user_test_setup(self):
        self.user = User(
            username="user1",
            active_points=0
        )
        db.session.add(self.user)
        db.session.commit()

    def user_test_teardown(self):
        db.session.query(User).delete()
        db.session.commit()


class PointsTestCase(unittest.TestCase, TestMixin):
    """This class represents the points test case"""

    def setUp(self):
        """Define test variables and initialize app."""
        self.app = create_app("testing")
        self.client = self.app.test_client
        with self.app.app_context():
            self.user_test_setup()

    def test_get_points(self):
        """Test API can create a points (GET request)"""
        res = self.client().get('/user/points/')
        self.assertEqual(res.status_code, 200)
        self.assertEquals(res.data, {"active_points": 0})

    def tearDown(self):
        with self.app.app_context():
            self.user_test_teardown()


# Make the tests conveniently executable
if __name__ == "__main__":
    unittest.main()

Моя система аутентификации работает следующим образом:

  1. Любая служба (включая эту) запрашивает службу пользователя для получения токена JWT пользователя.
  2. Любая служба принимает декодированный токен JWT и получает от него идентификатор пользователя.
  3. Получение объекта пользователя избазы данных по его идентификатору

, поэтому я не знал, как сделать проверку подлинности в тестовых случаях.

Ответы [ 2 ]

2 голосов
/ 10 апреля 2019

Вот только пример.Я пропустил некоторые мелочи, такие как create_app, jwt.decode(token) и т. Д. Я уверен, что вы можете понять основной подход.Структура:

src
├── __init__.py # empty
├── app.py
└── auth_example.py

app.py:

from flask import Flask

from src.auth_example import current_identity, authorize

app = Flask(__name__)


@app.route('/')
@authorize()
def main():
    """
    You can use flask_restful - doesn't matter
    Do here all what you need:
        user = User.query.filter_by(id=int(current_identity['user_id'])).first()
        etc..
    just demo - return current user_id
    """

    return current_identity['user_id']

auth_example.py :

from flask import request, _request_ctx_stack
from functools import wraps
from werkzeug.local import LocalProxy

current_identity = LocalProxy(lambda: getattr(_request_ctx_stack.top, 'current_identity', None))


def jwt_decode_handler(token):
    """
    just do here all what you need. Should return current user data
    :param str token:
    :return: dict
    """
    # return jwt.decode(token), but now - just demo
    raise Exception('just demo')


def authorize():
    def _authorize(f):

        @wraps(f)
        def __authorize(*args, **kwargs):
            if 'Authorization' not in request.headers:
                return "Unable to log in with provided credentials.", 403

            raw_token = request.headers.get('Authorization')
            if raw_token[0:3] != 'JWT':
                return "Unable to log in with provided credentials.", 403
            token = str.replace(str(raw_token), 'JWT ', '')
            try:
                # I don't know do you use Flask-JWT or not
                # this is doesn't matter - all what you need is just to mock jwt_decode_handler result 
                _request_ctx_stack.top.current_identity = jwt_decode_handler(token)
            except Exception:
                return "Unable to log in with provided credentials.", 403

            return f(*args, **kwargs)

        return __authorize
    return _authorize

Нашиtest:

import unittest

from mock import patch

from src.app import app

app.app_context().push()


class TestExample(unittest.TestCase):

    def test_main_403(self):
        # just a demo that @authorize works fine
        result = app.test_client().get('/')
        self.assertEqual(result.status_code, 403)

    def test_main_ok(self):
        expected = '1'
        # we say that jwt_decode_handler will return {'user_id': '1'}
        patcher = patch('src.auth_example.jwt_decode_handler', return_value={'user_id': expected})
        patcher.start()
        result = app.test_client().get(
            '/',
            # send a header to skip errors in the __authorize
            headers={
                'Authorization': 'JWT=blabla',
            },
        )
        # as you can see current_identity['user_id'] is '1' (so, it was mocked in view)
        self.assertEqual(result.data, expected)
        patcher.stop()

Итак, в вашем случае вам нужно просто смоделировать jwt_decode_handler.Также я рекомендую не добавлять никаких дополнительных аргументов внутри декораторов.Отладка будет сложной, если у вас более двух декораторов с разными аргументами, рекурсией, сложной обработкой и т. Д.

Надеюсь, это поможет.

0 голосов
/ 10 апреля 2019

Не могли бы вы создать в фреймворке модульного тестирования несколько фиктивных токенов (которые ваш декоратор может фактически декодировать, как в реальном запросе) и отправить их вместе с вашим тестовым клиентом?Пример того, как это может выглядеть, можно увидеть здесь: https://github.com/vimalloc/flask-jwt-extended/blob/master/tests/test_view_decorators.py#L321

...