Как издеваться над тестированием API Python
Я пытаюсь высмеять пример функции ниже. Почему-то я получаю ошибку.
Например,
У меня есть класс, как показано ниже myclass.py:
import os, requests
class MyClass:
def __init__(self, login_url):
self.username = os.environ.get('username')
self.password = os.environ.get('password')
self.login_url = login_url
self.auth_credentials = {
'name': self.username,
'password': self.password
}
def get_access_token(self):
token = ""
headers = {
'Authorization': f'Bearer {token}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.post(self.login_url, json=self.auth_credentials, headers=headers, verify=False)
access_token = response.json().get('access_token')
return access_token
Теперь у меня есть модульный тест, как показано ниже unit_test.py, который на самом деле выдает ошибку:
import os
import requests
import unittest
from unittest.mock import Mock, patch, MagicMock
import MyClass
class TestModule(unittest.TestCase):
# @patch('MyClass.get_access_token')
def test_execute(self):
# Test/Mock API:
_obj = MyClass(login_url = "https://www.my-website.com/login/")
mock_access_token = "abc123def456ghi789"
with patch('MyClass.get_access_token') as _access:
_access.return_value.status_code = 200
_access.return_value.json.return_value = mock_access_token
response = _obj.get_access_token()
self.assertEqual(response.status_code, 200)
self.assertEqual(response, mock_access_token)
if __name__ == "__main__":
unittest.main()
Итак, чего мне здесь не хватает unit_test.py?
Название не совсем соответствует вопросу, вам следует его обновить.
Собственно, не надо утомительного копипаста ошибок в вопрос. Поскольку предоставляется полная версия MWE, любой может самостоятельно запустить код и посмотреть, какую ошибку он получит. Вам все равно придется запустить код, чтобы устранить неполадки и дать хороший ответ. Таким образом, хотя и неприятно, что любопытные прохожие (которые не умеют запускать код Python) остаются в подвешенном состоянии, на самом деле это не мешает кому-то знающему дать ответ.
@Dommondke, хотя это пример очень хорошо сформулированного вопроса, ошибка все еще ценна. Например, если ошибка была ImportError, изменение теста не имело бы никакого эффекта. Включение ошибки в вопрос помогает сузить проблему и предотвратить ненужные циклы обратной связи. Кроме того, копирование ошибки занимает ~ 10 секунд. Настройка среды, установка всех зависимостей, копирование и запуск кода занимают больше времени.
Ответы 2
В этой строке вы заменяете MyClass.get_access_token экземпляром MagicMock:
with patch('MyClass.get_access_token') as _access:
Это означает, что он начнет возвращать еще один MagicMock каждый раз, когда вы вызываете некоторые методы. Он также будет игнорировать все внутри вашего метода get_access_token (вы заменили его макетом, помните?). Однако ваш тестовый код все еще пытается проверить внутреннюю логику этого метода, например, доступ к методам ответа.
Что вы действительно хотите здесь высмеять, так это сетевой запрос, а не ваш метод. Ваш метод сам по себе не имеет побочных эффектов, а библиотеки, которые он вызывает, имеют. Так что вам нужно издеваться над библиотеками, в данном случае requests. Вам необходимо реализовать соответствующие макеты таким образом, чтобы при вызове get_access_tokenrequests.post вместо фактического запроса POST он возвращал макетный ответ с соответствующими членами (например, json()).
Поскольку requests немного сложен, вам может пригодиться следующее: Как я могу имитировать запросы и ответы?
В вашем коде также есть куча ошибок импорта (ModuleNotFoundError). Я не буду вдаваться в подробности, потому что это должен быть отдельный вопрос. Когда они исправлены, тест начинает завершаться сбоем (т. е. не завершается сбоем) в этой строке:
self.assertEqual(response, mock_access_token)
Это связано с тем, что response — это экземпляр MagicMock, а mock_access_token — строка, поэтому очевидно, что они не могут быть равны. Когда вы перепишете это как:
self.assertEqual(response.json(), mock_access_token)
Это проходит. Однако я подозреваю, что тест не проверяет то, что вы думаете, поэтому я бы рекомендовал внести в метод некоторые ошибки и посмотреть, обнаружит ли их тест. Как я уже сказал, вы, вероятно, захотите переписать весь модульный тест, чтобы он был насмешливым requests, а не вашим методом.
Спасибо за подробности. Да, я это исправил.
Я это исправил. Теперь работает.
import os
import requests
import unittest
from unittest.mock import patch
from myclass import MyClass
class TestModule(unittest.TestCase):
def test_execute(self):
# Test/Mock API:
_obj = MyClass(login_url = "https://www.my-website.com/login/")
mock_access_token = "abc123def456ghi789"
with patch('myclass.MyClass.get_access_token') as mock_get_access_token:
mock_get_access_token.return_value = mock_access_token
response = _obj.get_access_token()
self.assertEqual(response, mock_access_token)
print("Done")
if __name__ == "__main__":
unittest.main()
Этот тест бессмысленен. Вы тоже можете assert True. Пожалуйста, прочитайте ответ @Dommondke.
Пожалуйста, также добавьте ошибку в свой вопрос.