Merge pull request #202 from GeekMasher/octokit-errors-msg

fix: Solve issue with what key is used to find errors

Author: GeekMasher

Pipfile

@@ -17,6 +17,7 @@ twine = "*"
 sphinx = "*"
 myst-parser = "*"
 tomli = "*"
+responses = "*"
 
 [scripts]
 main = "python -m ghastoolkit"

Pipfile.lock

@@ -1,6 +1,6 @@
 [project]
 name = "ghastoolkit"
-version = "0.12.0"
+version = "0.12.1"
 authors = [{ name = "GeekMasher" }]
 description = "GitHub Advanced Security Python Toolkit"
 readme = "README.md"

pyproject.toml

@@ -3,7 +3,7 @@
 __name__ = "ghastoolkit"
 __title__ = "GHAS Toolkit"
 
-__version__ = "0.12.0"
+__version__ = "0.12.1"
 
 __description__ = "GitHub Advanced Security Python Toolkit"
 __summary__ = """\

src/ghastoolkit/__init__.py

@@ -215,20 +215,22 @@ def get(
             if expected and response.status_code != expected:
                 if display_errors:
                     logger.error(f"Error code from server :: {response.status_code}")
-                    logger.error(f"Content :: {response_json}")
 
                 known_error = __OCTOKIT_ERRORS__.get(response.status_code)
                 if known_error:
                     raise Exception(known_error)
 
             # Handle errors in the response
-            if isinstance(response_json, dict) and response_json.get("errors"):
+            if isinstance(response_json, dict) and response_json.get("message"):
                 # Custom error handler callback
                 if error_handler:
                     return error_handler(response.status_code, response_json)
 
                 # Default error handling
                 logger.error(response_json.get("message"))
+                logger.error(
+                    f"Documentation Link :: {response_json.get('documentation_url', '')}"
+                )
                 raise Exception("REST Request failed :: non-expected server error")
 
             if isinstance(response_json, dict):

src/ghastoolkit/octokit/octokit.py

@@ -1,13 +1,18 @@
 from dataclasses import dataclass, is_dataclass
 import unittest
 
-from ghastoolkit.octokit.octokit import OctoItem, Octokit, GraphQLRequest, loadOctoItem
+from ghastoolkit.octokit.octokit import (
+    OctoItem,
+    Octokit,
+    GraphQLRequest,
+    loadOctoItem,
+)
 from ghastoolkit.octokit.github import GitHub
 
 
 class TestOctokit(unittest.TestCase):
     def setUp(self) -> None:
-        GitHub.init(repository="GeekMasher/ghastoolkit@main")
+        GitHub.init(repository="GeekMasher/ghastoolkit@main", token="1234567890")
         return super().setUp()
 
     def test_route(self):

tests/test_octokit.py

@@ -0,0 +1,61 @@
+"""Test RestRequest class."""
+import unittest
+import responses
+
+from ghastoolkit.octokit.octokit import RestRequest
+from ghastoolkit.octokit.github import GitHub
+
+
+class TestRestRequest(unittest.TestCase):
+    def setUp(self) -> None:
+        GitHub.init(repository="GeekMasher/ghastoolkit@main")
+
+        self.rest = RestRequest()
+
+        return super().setUp()
+
+    @responses.activate
+    def test_errors(self):
+        responses.add(
+            responses.GET,
+            "https://api.github.com/repos/GeekMasher/ghastoolkit/secret-scanning/alerts",
+            json={
+                "message": "Secret scanning is disabled on this repository.",
+                "documentation_url": "https://docs.github.com/rest/secret-scanning/secret-scanning",
+            },
+            status=404,
+        )
+        responses.add(
+            responses.GET,
+            "https://api.github.com/repos/GeekMasher/ghastoolkit/secret-scanning/alerts/1",
+            json={
+                "message": "Not Found",
+                "documentation_url": "https://docs.github.com/rest/secret-scanning/secret-scanning",
+            },
+            status=404,
+        )
+
+        with self.assertRaises(Exception):
+            self.rest.get("/repos/{owner}/{repo}/secret-scanning/alerts")
+
+        with self.assertRaises(Exception):
+            self.rest.get("/repos/{owner}/{repo}/secret-scanning/alerts/1")
+
+    @responses.activate
+    def test_error_handler(self):
+        responses.add(
+            responses.GET,
+            "https://api.github.com/repos/GeekMasher/ghastoolkit/secret-scanning/alerts",
+            json={
+                "message": "Secret scanning is disabled on this repository.",
+                "documentation_url": "https://docs.github.com/rest/secret-scanning/secret-scanning",
+            },
+            status=404,
+        )
+
+        def handle(code, _):
+            self.assertEqual(code, 404)
+
+        self.rest.get(
+            "/repos/{owner}/{repo}/secret-scanning/alerts", error_handler=handle
+        )