refactor: remove unittest dependency and start using pytest (#5)

* refactor: remove unittest dependency and start using pytest

* code format

* ci(github-actions): update coverage badge

---------

Co-authored-by: Arun Rai <ciw8981@bb-usmia-v019-l-s-nafd-dscn01.krft.net>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: 3 people

Pipfile

@@ -14,6 +14,7 @@ pytest-cov = "*"
 pre-commit = "*"
 isort = "*"
 commitizen = "*"
+pytest-mock = "*"
 
 [requires]
 python_version = "3.10"

Pipfile.lock

@@ -1,6 +1,6 @@
 # Example for Setting Up Pytest and Pipenv
 
-![Coverage Badge](https://img.shields.io/badge/coverage-95%25-brightgreen)
+![Coverage Badge](https://img.shields.io/badge/coverage-96%25-brightgreen)
 ![Python Version](https://img.shields.io/badge/Python-3.10-blue)
 ![License](https://img.shields.io/badge/License-MIT-green)
 

README.md

@@ -1,6 +1,7 @@
 from typing import Optional
 
 import requests
+import json
 from requests.exceptions import RequestException
 
 
@@ -41,5 +42,5 @@ def get_weather(city: str, api_key: Optional[str] = None) -> Optional[float]:
         if temperature is None:
             raise WeatherServiceError("Temperature data is missing in the response")
         return temperature
-    except ValueError as e:
+    except AttributeError as e:
         raise WeatherServiceError("Failed to parse weather data") from e

src/weather_service.py

@@ -1,91 +1,92 @@
-from unittest.mock import Mock, patch
-
 import pytest  # type: ignore
 from requests.exceptions import RequestException
 
 from src.weather_service import WeatherServiceError, get_weather
 
 
-@patch("src.weather_service.requests.get")
-def test_get_weather_success(mock_get):
+def test_get_weather_success(mocker):
     """
     Test that get_weather returns the correct temperature when the API call succeeds.
     """
-    mock_response = Mock()
-    mock_response.status_code = 200
-    mock_response.json.return_value = {"temperature": 22}
-    mock_get.return_value = mock_response
+    mocker.patch(
+        "requests.get",
+        return_value=mocker.MagicMock(
+            status_code=200, json=lambda: {"temperature": 22}
+        ),
+    )
 
     result = get_weather("New York", api_key="test_api_key")
     assert result == 22
 
 
-@patch("src.weather_service.requests.get")
-def test_get_weather_none_temperature(mock_get):
+def test_get_weather_none_temperature(mocker):
     """
     Test that get_weather raises WeatherServiceError if the temperature is None.
     """
-    mock_response = Mock()
-    mock_response.status_code = 200
-    mock_response.json.return_value = {"temperature": None}
-    mock_get.return_value = mock_response
+    mocker.patch(
+        "requests.get",
+        return_value=mocker.MagicMock(
+            status_code=200, json=lambda: {"temperature": None}
+        ),
+    )
 
     with pytest.raises(
         WeatherServiceError, match="Temperature data is missing in the response"
     ):
         get_weather("New York", api_key="test_api_key")
 
 
-@patch("src.weather_service.requests.get")
-def test_get_weather_failure(mock_get):
+def test_get_weather_failure(mocker):
     """
     Test that get_weather raises WeatherServiceError when the API call fails.
     """
-    mock_response = Mock()
-    mock_response.status_code = 404
-    mock_get.return_value = mock_response
+
+    mocker.patch(
+        "requests.get",
+        return_value=mocker.MagicMock(
+            status_code=404, json=lambda: {"temperature": None}
+        ),
+    )
 
     with pytest.raises(
         WeatherServiceError, match="Failed to fetch weather data for NonExistentCity"
     ):
         get_weather("NonExistentCity", api_key="test_api_key")
 
 
-@patch("src.weather_service.requests.get")
-def test_get_weather_missing_temperature(mock_get):
+def test_get_weather_missing_temperature(mocker):
     """
     Test that get_weather raises WeatherServiceError if temperature is missing in the response.
     """
-    mock_response = Mock()
-    mock_response.status_code = 200
-    mock_response.json.return_value = {}
-    mock_get.return_value = mock_response
 
+    mocker.patch(
+        "requests.get",
+        return_value=mocker.MagicMock(status_code=200, json=lambda: {}),
+    )
     with pytest.raises(
         WeatherServiceError, match="Temperature data is missing in the response"
     ):
         get_weather("New York", api_key="test_api_key")
 
 
-@patch("src.weather_service.requests.get")
-def test_get_weather_json_parsing_error(mock_get):
+def test_get_weather_json_parsing_error(mocker):
     """
     Test that get_weather raises WeatherServiceError if JSON parsing fails.
     """
-    mock_response = Mock()
-    mock_response.status_code = 200
-    mock_response.json.side_effect = ValueError
-    mock_get.return_value = mock_response
+    mocker.patch(
+        "requests.get",
+        return_value=mocker.MagicMock(status_code=200, json=lambda: "Invalid Json"),
+    )
 
     with pytest.raises(WeatherServiceError, match="Failed to parse weather data"):
         get_weather("New York", api_key="test_api_key")
 
 
-@patch("src.weather_service.requests.get")
-def test_get_weather_request_exception(mock_get):
+def test_get_weather_request_exception(mocker):
     """
     Test that get_weather raises WeatherServiceError if a request exception occurs.
     """
+    mock_get = mocker.patch("requests.get")
     mock_get.side_effect = RequestException("Network error")
 
     with pytest.raises(