Troubleshooting unit test failures

Author: NeonDaniel

neon_api_proxy/services/wolfram_api.py

@@ -54,6 +54,8 @@ class WolframAPI(CachedAPI):
     def __init__(self, api_key: str = None, cache_seconds: int = 3600, **_):
         super().__init__("wolfram")
         self._api_key = api_key or find_neon_wolfram_key()
+        if not self._api_key:
+            LOG.error("No Wolfram|Alpha API key provided!")
         self.session.allowable_codes = (200, 501)
         self.cache_time = timedelta(seconds=cache_seconds)
 
@@ -65,9 +67,9 @@ def _build_query_url(self, query_type: QueryUrl, query_arg: str) -> str:
         :return: valid URL to query for a response
         """
         if not query_type:
-            raise ValueError(f"query_type not defined!")
+            raise ValueError("query_type not defined!")
         if not query_arg:
-            raise ValueError(f"query_url not defined!")
+            raise ValueError("query_url not defined!")
         if not isinstance(query_type, QueryUrl):
             raise TypeError(f"Not a QueryUrl: {query_arg}")
         if not isinstance(query_arg, str):

tests/test_wolfram_api.py

@@ -140,6 +140,9 @@ def test_handle_query_invalid_query(self):
         self.assertEqual(resp["status_code"], -1)
 
     def test_handle_query_invalid_response(self):
+        # Check that the API key is defined (troubleshooting failures)
+        self.assertIsInstance(self.api._api_key, str)
+        self.assertGreater(len(self.api._api_key), 0)
         resp = self.api.handle_query(api="short",
                                      query="i like",
                                      units="metric",
@@ -154,14 +157,19 @@ def test_handle_query_invalid_key(self):
 
         resp = self.api.handle_query(query="how far away is mars")
         self.assertIsInstance(resp, dict)
-        self.assertEqual(resp["status_code"], 403)
+        # Response code should indicate a 4xx error for a bad request
+        self.assertGreaterEqual(resp["status_code"], 400)
+        self.assertLess(resp["status_code"], 500)
         self.assertIsInstance(resp["content"], bytes)
         self.assertIsInstance(resp["encoding"], str)
         self.assertIsInstance(resp["content"].decode(resp["encoding"]), str)
 
         self.api._api_key = valid_key
 
     def test_handle_query_valid_ip(self):
+        # Check that the API key is defined (troubleshooting failures)
+        self.assertIsInstance(self.api._api_key, str)
+        self.assertGreater(len(self.api._api_key), 0)
         resp = self.api.handle_query(api="short",
                                      query="how far away is the moon?",
                                      units="metric",
@@ -178,6 +186,9 @@ def test_handle_query_valid_ip(self):
         self.assertEqual(resp, cached)
 
     def test_handle_query_valid_lat_lng(self):
+        # Check that the API key is defined (troubleshooting failures)
+        self.assertIsInstance(self.api._api_key, str)
+        self.assertGreater(len(self.api._api_key), 0)
         resp = self.api.handle_query(api="short",
                                      query="how far away is the moon?",
                                      units="metric",
@@ -190,6 +201,9 @@ def test_handle_query_valid_lat_lng(self):
         self.assertIsInstance(resp["content"].decode(resp["encoding"]), str)
 
     def test_handle_query_valid_latlong(self):
+        # Check that the API key is defined (troubleshooting failures)
+        self.assertIsInstance(self.api._api_key, str)
+        self.assertGreater(len(self.api._api_key), 0)
         resp = self.api.handle_query(api="short",
                                      query="how far away is the moon?",
                                      units="metric",