Pruebas de Mock para APIs con Python y UnitTest

Lo más probable es que lo sepan pero por sí no cuando el profe consiguió alinear todo de golpe lo que hizo fue presionar alt+ click izquierdo para seleccionar varias partes del código ... finalmente solo dió un enter Abrazo colegas

para los que esten en un entorno windows y no les funcione el `pip freeze | grep requests` deben de usar `pip freeze | Select-String -Pattern "requests"` Esto es debido a que `grep` no es nativo de Windows.

El equivalente de "grep" en windows cmd es "findstr"

Qué tal gente, qué buen curso, lo hubiera deseado hace 2 años. Casi me despiden de un trabajo x n o saber moviese y escribir bien unittests. Les comento que para trabajar con requests hay una librería que se llama requests_mock denle una probada.

El reto: ```python import requests def get_location(ip): url = f'https://freeipapi.com/api/json/{ip}' response = requests.get(url) response.raise_for_status() data = response.json() #print(data) return { "country": data["countryName"], "region": data["regionName"], "city": data["cityName"], "code": data["countryCode"], "language": data["language"] } if __name__=="__main__": print(get_location("8.8.8.8")) #test import unittest from src.api_client import get_location from unittest.mock import patch class ApiClientTest(unittest.TestCase): @patch('src.api_client.requests.get') def test_get_location_return_expected_data(self, mock_get): mock_get.return_value.status_code = 200 mock_get.return_value.json.return_value = { "countryName": "USA", "regionName": "FLORIDA", "cityName": "MIAMI", "countryCode": "US", "language": "ENGLISH", } result = get_location("8.8.8.8") self.assertEqual(result.get("country"), "USA") self.assertEqual(result.get("region"), "FLORIDA") self.assertEqual(result.get("city"), "MIAMI") self.assertEqual(result.get("code"), "US") self.assertEqual(result.get("language"), "ENGLISH") mock_get.assert_called_once_with("https://freeipapi.com/api/json/8.8.8.8") ```import requests def get\_location(ip): url = f'https://freeipapi.com/api/json/{ip}' response = requests.get(url) response.raise\_for\_status() data = response.json() #print(data) return { "country": data\["countryName"], "region": data\["regionName"], "city": data\["cityName"], "code": data\["countryCode"], "language": data\["language"] } if \_\_name\_\_=="\_\_main\_\_": print(get\_location("8.8.8.8"))

Cuando se utiliza ipdb, el profe uso ; Muy probablemente sea algo raro sino lo habían visto ante por que en python no se usa ; no? La realidad es que si pero es muy raro. En este caso se usa para agrupar dos lineas de codigo en una

profe pero todo esté código no está hardcodeado ? la idea es que funcione con valores que pudieran ser dinámicos o me equivoco ?

```js import requests def get_location(ip): url = f"https://freeipapi.com/api/json/{ip}" response = requests.get(url) response.raise_for_status() data = response.json() # import ipdb; ipdb.set_trace() print(data) return { "country": data["countryName"], "region": data["regionName"], "city": data["cityName"], "language": data["language"], "zip": data["zipCode"], } if __name__ == "__main__": location = get_location("8.8.8.8") print(location) ``````js import unittest from unittest.mock import patch from src.api_client import get_location class ApiClientTests(unittest.TestCase): @patch('src.api_client.requests.get') def test_get_location_returns_exected_data(self, mock_get): mock_get.return_value.status_code = 200 # mock_get.return_value.json.return_value = { # {'ipVersion': 4, # 'ipAddress': '8.8.8.8', # 'latitude': 37.386051, # 'longitude': -122.083847, # 'countryName': 'United States of America', # 'countryCode': 'US', # 'timeZone': '-07:00', # 'zipCode': '94035', # 'cityName': 'Mountain View', # 'regionName': 'California', # 'isProxy': False, # 'continent': 'Americas', # 'continentCode': 'AM', # 'currency': {'code': 'USD', 'name': 'US Dollar'}, # 'language': 'English', # 'timeZones': ['America/Adak', 'America/Anchorage', 'America/Boise', 'America/Chicago', 'America/Denver', 'America/Detroit', 'America/Indiana/Indianapolis', 'America/Indiana/Knox', 'America/Indiana/Marengo', 'America/Indiana/Petersburg', 'America/Indiana/Tell_City', 'America/Indiana/Vevay', 'America/Indiana/Vincennes', 'America/Indiana/Winamac', 'America/Juneau', 'America/Kentucky/Louisville', 'America/Kentucky/Monticello', 'America/Los_Angeles', 'America/Menominee', 'America/Metlakatla', 'America/New_York', 'America/Nome', 'America/North_Dakota/Beulah', 'America/North_Dakota/Center', 'America/North_Dakota/New_Salem', 'America/Phoenix', 'America/Sitka', 'America/Yakutat', 'Pacific/Honolulu'], # 'tlds': ['.us']} # } mock_get.return_value.json.return_value = { "countryName": "USA", "regionName": "FLORIDA", "cityName": "MIAMI", "language": "English", "zipCode": "331" } result = get_location("8.8.8.8") self.assertEqual(result.get("country"), "USA") self.assertEqual(result.get("region"), "FLORIDA") self.assertEqual(result.get("city"), "MIAMI") self.assertEqual(result.get("language"), "English") self.assertEqual(result.get("zip"), "331") # Validando que se esta llamando a la URL correcta mock_get.assert_called_once_with("https://freeipapi.com/api/json/8.8.8.8") ```

Otra cosa que Comentar... si al ejecutar ipdb en la terminal e ingresar "data" les vota el siguiente error "signal.set\_wakeup\_fd(-1) ValueError: set\_wakeup\_fd only works in main thread" Lo mas probable es que su versión de python sea el problema.... Yo tenia la 3.8 y no me permitía usar ipdb Únicamente descarguen la mas reciente y cambien sus variables de entorno para ejecutar el script con la version reciente

En que caso de que quieran hacerle un mock a más de una función que se ejecuta dentro de otra función (por ejemplo, si tuvieran una base de datos con las IP's de tus clientes y quieres verificar no solo que la IP sea de un país aceptado, sino que además pertenece al cliente que está intentando acceder) se puede hacer siguiendo la siguiente estructura: ```python @patch('nombre_modulo.funcion_a_parchear_1') @patch('nombre_modulo.funcion_a_parchear_2') def test_my_function(mock_func2, mock_func1): # mock_func2 corresponde a funcion_a_parchear_2 # mock_func1 corresponde a funcion_a_parchear_1 # Configurar returns de las funciones a mockear mock_func1.return_value = "mock_value1" mock_func2.return_value = "mock_value2" ``` Como vemos, tenemos que aplicar el decorador 2 veces y la función recibe los mock como parámetros en el orden inverso al que se definió, es decir, si definiste un patch para mock de la \*función 1\* y abajo el de la \*función 2\*, el primer parámetro mock de la función corresponderá al de la función que definimos de último (\*función 2\* en este caso) y de ahí vamos ascendiendo hasta llegar a la primera función a la que le hicimos el patch.

Ejemplo usando `pytest `y `mock:` ```python import pytest import httpx from unittest.mock import patch # Usa pytest-mock o el decorador patch de unittest para simular la solicitud @patch("httpx.Client.get") def test_perfil_endpoint_mock(mock_get): # Configuramos el mock para devolver una respuesta simulada mock_response = httpx.Response( status_code=200, json={ "rol": "Software Engineer", "description": "Soy Ingeniero Informático con sólida experiencia en el desarrollo de software.", "skills": ["python", "javascript", "fastapi"], "username": "jimcostdev", "avatar": "https://avatars.githubusercontent.com/u/53100460?v=4", "id": 1 } ) mock_get.return_value = mock_response # Simula el cliente HTTP with httpx.Client() as client: response = client.get("https://ficticious-url.local/test-endpoint") # Comprueba que los datos sean correctos assert response.status_code == 200 assert response.json()["username"] == "jimcostdev" assert response.json() == mock_response.json() ```

Hola otra forma muy interesante de "mockear" las respuestas es guardarlas en archivos .json y luego usarla , por acá un ejemplo: ```js import unittest, json from unittest.mock import patch from src.api_client import get_location class ApiClientTest(unittest.TestCase): @patch('src.api_client.requests.get') def test_get_location_returns_expected_data(self, mock_get)-> None: mock_get.return_value.status_code = 200 mock_response = '' with open('tests/support/mock_freeapi.json', 'r') as f: mock_response = json.load(f) mock_get.return_value.json.return_value = mock_response result = get_location('8.8.8.8') self.assertEqual(result.get('country'), 'United States of America') self.assertEqual(result.get('region'), 'California') self.assertEqual(result.get('city'), 'Mountain View') mock_get.assert_called_once_with("https://freeipapi.com/api/json/8.8.8.8") ```

Reto: Test ```python @patch("src.api_client.requests.get") def test_get_location_returns_expected_data(self, mock_get): mock_get.return_value.status_code = 200 mock_get.return_value.json.return_value = { "countryName": "USA", "regionName": "Florida", "cityName": "Miami", "language": "English", "currency": {"code": "USD"}, "zipCode": "33101", } result = get_location("8.8.8.8") self.assertEqual(result.get("country"), "USA") self.assertEqual(result.get("region"), "Florida") self.assertEqual(result.get("city"), "Miami") self.assertEqual(result.get("language"), "English") self.assertEqual(result.get("currency"), "USD") self.assertEqual(result.get("zip_code"), "33101") mock_get.assert_called_once_with("https://freeipapi.com/api/json/8.8.8.8") ```@patch("src.api\_client.requests.get")    def test\_get\_location\_returns\_expected\_data(self, mock\_get):        mock\_get.return\_value.status\_code = 200        mock\_get.return\_value.json.return\_value = {            "countryName": "USA",            "regionName": "Florida",            "cityName": "Miami",            "language": "English",            "currency": {"code": "USD"},            "zipCode": "33101",        }        result = get\_location("8.8.8.8")        self.assertEqual(result.get("country"), "USA")        self.assertEqual(result.get("region"), "Florida")        self.assertEqual(result.get("city"), "Miami")        self.assertEqual(result.get("language"), "English")        self.assertEqual(result.get("currency"), "USD")        self.assertEqual(result.get("zip\_code"), "33101")         mock\_get.assert\_called\_once\_with("https://freeipapi.com/api/json/8.8.8.8") Fun. get\_location ```python def get_location(ip): url = f"https://freeipapi.com/api/json/{ip}" response = requests.get(url) response.raise_for_status() data = response.json() return { "country": data["countryName"], "region": data["regionName"], "city": data["cityName"], "language": data["language"], "currency": data["currency"]["code"], "zip_code": data["zipCode"], } ```def get\_location(ip):    url = f"https://freeipapi.com/api/json/{ip}"    response = requests.get(url)    response.raise\_for\_status()    data = response.json()    return {        "country": data\["countryName"],        "region": data\["regionName"],        "city": data\["cityName"],        "language": data\["language"],        "currency": data\["currency"]\["code"],        "zip\_code": data\["zipCode"],    }