improve handling of text responses

gabrielburnworth · gabrielburnworth · commit a1fb4dc79acf · 2024-08-28T14:18:48.000-07:00
diff --git a/functions/api.py b/functions/api.py
@@ -79,6 +79,14 @@ def get_token(self, email, password, server="https://my.farm.bot"):
         self.state.print_status(description=self.state.error)
         return self.state.error
 
+    @staticmethod
+    def parse_text(text):
+        """Parse response text."""
+        if '<html' in text:
+            parser = HTMLResponseParser()
+            return parser.read(text)
+        return text
+
     def request_handling(self, response):
         """Handle errors associated with different endpoint errors."""
 
@@ -89,25 +97,23 @@ def request_handling(self, response):
             502: "Please check your internet connection and try again."
         }
 
+        text = self.parse_text(response.text)
+
         # Handle HTTP status codes
         if response.status_code == 200:
             self.state.print_status(description="Successfully sent request via API.")
             return 200
         if 400 <= response.status_code < 500:
             self.state.error = f"CLIENT ERROR {response.status_code}: {error_messages.get(response.status_code, response.reason)}"
         elif 500 <= response.status_code < 600:
-            self.state.error = f"SERVER ERROR {response.status_code}: {response.text}"
+            self.state.error = f"SERVER ERROR {response.status_code}: {text}"
         else:
-            self.state.error = f"UNEXPECTED ERROR {response.status_code}: {response.text}"
+            self.state.error = f"UNEXPECTED ERROR {response.status_code}: {text}"
 
         try:
             response.json()
         except requests.exceptions.JSONDecodeError:
-            if '<html>' in response.text:
-                parser = HTMLResponseParser()
-                self.state.error += f" ({parser.read(response.text)})"
-            else:
-                self.state.error += f" ({response.text})"
+                self.state.error += f" ({text})"
         else:
             self.state.error += f" ({json.dumps(response.json(), indent=2)})"
 
diff --git a/tests/tests_main.py b/tests/tests_main.py
@@ -39,6 +39,7 @@ def test_get_token_default_server(self, mock_post):
         expected_token = {'token': 'abc123'}
         mock_response.json.return_value = expected_token
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_post.return_value = mock_response
         self.fb.state.token = None
         # Call with default server
@@ -58,6 +59,7 @@ def test_get_token_custom_server(self, mock_post):
         expected_token = {'token': 'abc123'}
         mock_response.json.return_value = expected_token
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_post.return_value = mock_response
         self.fb.state.token = None
         # Call with custom server
@@ -246,6 +248,7 @@ def test_get_info_endpoint_only(self, mock_request):
         expected_response = {'device': 'info'}
         mock_response.json.return_value = expected_response
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         # Call with endpoint only
         response = self.fb.get_info('device')
@@ -267,6 +270,7 @@ def test_get_info_with_id(self, mock_request):
         expected_response = {'peripheral': 'info'}
         mock_response.json.return_value = expected_response
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         # Call with specific ID
         response = self.fb.get_info('peripherals', '12345')
@@ -317,6 +321,7 @@ def test_edit_info(self, mock_request):
         '''test edit_info function'''
         mock_response = Mock()
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_response.json.return_value = {'name': 'new name'}
         mock_request.return_value = mock_response
         device_info = self.fb.edit_info('device', {'name': 'new name'})
@@ -338,6 +343,7 @@ def test_add_info(self, mock_request):
         '''test add_info function'''
         mock_response = Mock()
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_response.json.return_value = {'name': 'new name'}
         mock_request.return_value = mock_response
         point = self.fb.add_info('points', {'name': 'new name'})
@@ -360,6 +366,7 @@ def test_group_one(self, mock_request):
         mock_response = Mock()
         mock_response.json.return_value = {'name': 'Group 0'}
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         group_info = self.fb.group(12345)
         mock_request.assert_called_once_with(
@@ -379,6 +386,7 @@ def test_group_all(self, mock_request):
         mock_response = Mock()
         mock_response.json.return_value = [{'name': 'Group 0'}]
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         group_info = self.fb.group()
         mock_request.assert_called_once_with(
@@ -398,6 +406,7 @@ def test_curve_one(self, mock_request):
         mock_response = Mock()
         mock_response.json.return_value = {'name': 'Curve 0'}
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         curve_info = self.fb.curve(12345)
         mock_request.assert_called_once_with(
@@ -417,6 +426,7 @@ def test_curve_all(self, mock_request):
         mock_response = Mock()
         mock_response.json.return_value = [{'name': 'Curve 0'}]
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         curve_info = self.fb.curve()
         mock_request.assert_called_once_with(
@@ -436,6 +446,7 @@ def test_safe_z(self, mock_request):
         mock_response = Mock()
         mock_response.json.return_value = {'safe_height': 100}
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         safe_height = self.fb.safe_z()
         mock_request.assert_called_once_with(
@@ -460,6 +471,7 @@ def test_garden_size(self, mock_request):
             'movement_step_per_mm_y': 5,
         }
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         garden_size = self.fb.garden_size()
         mock_request.assert_called_once_with(
@@ -478,6 +490,7 @@ def test_log(self, mock_request):
         '''test log function'''
         mock_response = Mock()
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         self.fb.log('test message', 'info', 'toast')
         mock_request.assert_called_once_with(
@@ -567,6 +580,7 @@ def send_command_test_helper(self, *args, **kwargs):
         mock_response = Mock()
         mock_response.json.return_value = mock_api_response
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         execute_command()
         if expected_command is None:
@@ -1178,6 +1192,7 @@ def helper_get_seed_tray_cell(self, *args, **kwargs):
         }
         mock_response.json.return_value = mock_api_response
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         cell = self.fb.get_seed_tray_cell(123, cell)
         mock_request.assert_called_once_with(
@@ -1251,6 +1266,7 @@ def helper_get_seed_tray_cell_error(self, *args, **kwargs):
         }
         mock_response.json.return_value = mock_api_response
         mock_response.status_code = 200
+        mock_response.text = 'text'
         mock_request.return_value = mock_response
         with self.assertRaises(ValueError) as cm:
             self.fb.get_seed_tray_cell(123, cell)
