Raise a MatchCodeIOException for invalid responses from MatchCode.io #1665 (#1666)

Signed-off-by: tdruez <[email protected]>

Author: tdruez

CHANGELOG.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+v34.12.0 (unreleased)
+---------------------
+
+- Raise a ``MatchCodeIOException`` when the response from the MatchCode.io service is
+  not valid in ``send_project_json_to_matchcode``.
+  This generally means an issue on the MatchCode.io server side.
+  https://github.com/aboutcode-org/scancode.io/issues/1665
+
 v34.11.0 (2025-05-02)
 ---------------------
 

scanpipe/pipelines/match_to_matchcode.py

@@ -63,10 +63,10 @@ def check_matchcode_service_availability(self):
                 "related settings to a MatchCode.io instance or reach out "
                 "to the maintainers for other arrangements."
             )
-            raise Exception(msg)
+            raise matchcode.MatchCodeIOException(msg)
 
         if not matchcode.is_available():
-            raise Exception("MatchCode.io is not available.")
+            raise matchcode.MatchCodeIOException("MatchCode.io is not available.")
 
     def send_project_json_to_matchcode(self):
         """Create a JSON scan of the project Codebase and send it to MatchCode.io."""

scanpipe/pipes/matchcode.py

@@ -314,6 +314,10 @@ def send_project_json_to_matchcode(
             timeout=timeout,
             files=files,
         )
+
+    if not response:
+        raise MatchCodeIOException("Invalid response from MatchCode.io")
+
     match_url = response["url"]
     run_url = response["runs"][0]["url"]
     return match_url, run_url

scanpipe/tests/pipes/test_matchcode.py

@@ -86,6 +86,15 @@ def mock_request_post_return(url, files, timeout):
         self.assertEqual(expected_match_url, match_url)
         self.assertEqual(expected_run_url, run_url)
 
+    @mock.patch("scanpipe.pipes.matchcode.request_post")
+    def test_scanpipe_pipes_matchcode_send_project_json_to_matchcode_failed_request(
+        self, mock_request_post
+    ):
+        mock_request_post.return_value = None
+        with self.assertRaises(matchcode.MatchCodeIOException) as context:
+            matchcode.send_project_json_to_matchcode(self.project1)
+        self.assertEqual("Invalid response from MatchCode.io", str(context.exception))
+
     @mock.patch("scanpipe.pipes.matchcode.request_get")
     @mock.patch("scanpipe.pipes.matchcode.is_available")
     def test_scanpipe_pipes_matchcode_get_run_url_status(
@@ -168,7 +177,7 @@ def test_scanpipe_pipes_matchcode_poll_run_url_status(
                 "log": "failure message",
             },
         ]
-        with self.assertRaises(Exception) as context:
+        with self.assertRaises(matchcode.MatchCodeIOException) as context:
             matchcode.poll_run_url_status(run_url, sleep=0)
         self.assertTrue("failure message" in str(context.exception))
 
@@ -197,7 +206,7 @@ def test_scanpipe_pipes_matchcode_poll_run_url_status(
                 "log": "stop message",
             },
         ]
-        with self.assertRaises(Exception) as context:
+        with self.assertRaises(matchcode.MatchCodeIOException) as context:
             matchcode.poll_run_url_status(run_url, sleep=0)
         self.assertTrue("stop message" in str(context.exception))
 
@@ -226,7 +235,7 @@ def test_scanpipe_pipes_matchcode_poll_run_url_status(
                 "log": "stale message",
             },
         ]
-        with self.assertRaises(Exception) as context:
+        with self.assertRaises(matchcode.MatchCodeIOException) as context:
             matchcode.poll_run_url_status(run_url, sleep=0)
         self.assertTrue("stale message" in str(context.exception))