prelude-sdk 2.6.33__tar.gz → 2.6.34__tar.gz

{prelude_sdk-2.6.33 → prelude_sdk-2.6.34}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prelude-sdk
-Version: 2.6.33
+Version: 2.6.34
 Summary: For interacting with the Prelude API
 Home-page: https://github.com/preludeorg
 Author: Prelude Research

{prelude_sdk-2.6.33 → prelude_sdk-2.6.34}/prelude_sdk/controllers/scm_controller.py

@@ -593,3 +593,72 @@ class ScmController(HttpController):
                 ],
             )
         return history
+
+    @verify_credentials
+    def get_report(self, report_id: str):
+        """Get SCM report by ID"""
+        res = self.get(
+            f"{self.account.hq}/scm/reports/{report_id}",
+            headers=self.account.headers,
+            timeout=10,
+        )
+        return res.json()
+
+    @verify_credentials
+    def list_reports(self):
+        """List SCM reports"""
+        res = self.get(
+            f"{self.account.hq}/scm/reports",
+            headers=self.account.headers,
+            timeout=10,
+        )
+        return res.json()
+
+    @verify_credentials
+    def delete_report(self, report_id: str):
+        """Delete SCM report by ID"""
+        res = self.delete(
+            f"{self.account.hq}/scm/reports/{report_id}",
+            headers=self.account.headers,
+            timeout=10,
+        )
+        return res.json()
+
+    @verify_credentials
+    def put_report(self, report_data: dict, report_id: str = None):
+        """Put SCM report by ID"""
+        res = self.put(
+            f"{self.account.hq}/scm/reports",
+            headers=self.account.headers,
+            json=dict(report=report_data, id=report_id),
+            timeout=10,
+        )
+        return res.json()
+
+    @verify_credentials
+    def get_chart_data(
+        self,
+        scm_category: SCMCategory,
+        sort_by: str,
+        group_by: str,
+        group_limit: int,
+        scopes: str = None,
+        filter: str = None,
+    ):
+        """Get SCM chart data"""
+        params = {
+            "scm_category": scm_category.name,
+            "sort_by": sort_by,
+            "group_by": group_by,
+            "group_limit": group_limit,
+            "scopes": scopes,
+        }
+        if filter:
+            params["$filter"] = filter
+        res = self.get(
+            f"{self.account.hq}/scm/chart_data",
+            headers=self.account.headers,
+            params=params,
+            timeout=30,
+        )
+        return res.json()

{prelude_sdk-2.6.33 → prelude_sdk-2.6.34}/prelude_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prelude-sdk
-Version: 2.6.33
+Version: 2.6.34
 Summary: For interacting with the Prelude API
 Home-page: https://github.com/preludeorg
 Author: Prelude Research

{prelude_sdk-2.6.33 → prelude_sdk-2.6.34}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = prelude-sdk
-version = 2.6.33
+version = 2.6.34
 author = Prelude Research
 author_email = support@preludesecurity.com
 description = For interacting with the Prelude API

prelude_sdk-2.6.34/tests/test_scm_build.py

@@ -0,0 +1,104 @@
+import pytest
+import uuid
+
+from prelude_sdk.controllers.scm_controller import ScmController
+from prelude_sdk.models.codes import ControlCategory
+
+
+@pytest.mark.order(8)
+@pytest.mark.usefixtures("setup_account")
+class TestScmBuild:
+    def setup_class(self):
+        if not pytest.expected_account["features"]["policy_evaluator"]:
+            pytest.skip("POLICY_EVALUATOR feature not enabled")
+        self.scm = ScmController(pytest.account)
+
+    def test_create_object_exception(self, unwrap):
+        res = unwrap(self.scm.create_object_exception)(
+            self.scm,
+            ControlCategory.ASSET_MANAGER,
+            "hostname eq 'host1'",
+            name="filter me",
+            expires="5555-05-05",
+        )
+        assert res["exception_id"]
+        pytest.exception_id = res["exception_id"]
+
+    def test_update_object_exception(self, unwrap):
+        res = unwrap(self.scm.update_object_exception)(
+            self.scm,
+            pytest.exception_id,
+            filter="hostname eq 'host2'",
+            expires=None,
+        )
+        assert res["status"]
+
+    def test_list_object_exceptions(self, unwrap):
+        res = unwrap(self.scm.list_object_exceptions)(self.scm)
+        exception = [x for x in res if x["id"] == pytest.exception_id]
+        assert len(exception) == 1
+        exception = exception[0]
+        del exception["author"]
+        del exception["created"]
+        assert exception == {
+            "category": ControlCategory.ASSET_MANAGER.value,
+            "expires": None,
+            "filter": "hostname eq 'host2'",
+            "id": pytest.exception_id,
+            "name": "filter me",
+        }
+
+    def test_delete_object_exception(self, unwrap):
+        res = unwrap(self.scm.delete_object_exception)(self.scm, pytest.exception_id)
+        assert res["status"]
+        res = unwrap(self.scm.list_object_exceptions)(self.scm)
+        assert not any(x["id"] == pytest.exception_id for x in res)
+
+    def test_put_report(self, unwrap):
+        report_blob = {
+            "name": "test report",
+            "sections": [
+                {
+                    "name": "test section",
+                    "charts": [
+                        {
+                            "name": "test chart",
+                            "columns": ["platforms"],
+                            "type": "PIE",
+                            "filter": "instances/any(i: i/control eq 1)",
+                            "group_by": "platforms",
+                            "scm_category": "ENDPOINT",
+                        }
+                    ],
+                }
+            ],
+        }
+        res = unwrap(self.scm.put_report)(self.scm, report_data=report_blob)
+        pytest.report_id = res["report_id"]
+        for section in res["report"]["sections"]:
+            assert "id" in section
+        for chart in res["report"]["sections"][0]["charts"]:
+            assert "id" in chart
+            assert "ignore" in chart
+
+    def test_list_reports(self, unwrap):
+        res = unwrap(self.scm.list_reports)(self.scm)
+        report = [r for r in res if r["report_id"] == pytest.report_id]
+        assert len(report) == 1
+        assert report[0]["name"] == "test report"
+        assert "report" not in report[0]
+
+    def test_get_report(self, unwrap):
+        res = unwrap(self.scm.get_report)(self.scm, pytest.report_id)
+        assert res["report_id"] == pytest.report_id
+        for section in res["report"]["sections"]:
+            assert "id" in section
+        for chart in res["report"]["sections"][0]["charts"]:
+            assert "id" in chart
+            assert "ignore" in chart
+
+    def test_delete_report(self, unwrap):
+        res = unwrap(self.scm.delete_report)(self.scm, pytest.report_id)
+        assert res["status"]
+        res = unwrap(self.scm.list_reports)(self.scm)
+        assert not any(r["report_id"] == pytest.report_id for r in res)

prelude_sdk-2.6.33/tests/test_scm_build.py

@@ -1,55 +0,0 @@
-import pytest
-from datetime import datetime, timezone, timedelta
-
-from prelude_sdk.controllers.scm_controller import ScmController
-from prelude_sdk.models.codes import Control, ControlCategory
-
-
-@pytest.mark.order(8)
-@pytest.mark.usefixtures("setup_account")
-class TestScmBuild:
-    def setup_class(self):
-        if not pytest.expected_account["features"]["policy_evaluator"]:
-            pytest.skip("POLICY_EVALUATOR feature not enabled")
-        self.scm = ScmController(pytest.account)
-
-    def test_create_object_exception(self, unwrap):
-        res = unwrap(self.scm.create_object_exception)(
-            self.scm,
-            ControlCategory.ASSET_MANAGER,
-            "hostname eq 'host1'",
-            name="filter me",
-            expires="5555-05-05",
-        )
-        assert res["exception_id"]
-        pytest.exception_id = res["exception_id"]
-
-    def test_update_object_exception(self, unwrap):
-        res = unwrap(self.scm.update_object_exception)(
-            self.scm,
-            pytest.exception_id,
-            filter="hostname eq 'host2'",
-            expires=None,
-        )
-        assert res["status"]
-
-    def test_list_object_exceptions(self, unwrap):
-        res = unwrap(self.scm.list_object_exceptions)(self.scm)
-        exception = [x for x in res if x["id"] == pytest.exception_id]
-        assert len(exception) == 1
-        exception = exception[0]
-        del exception["author"]
-        del exception["created"]
-        assert exception == {
-            "category": ControlCategory.ASSET_MANAGER.value,
-            "expires": None,
-            "filter": "hostname eq 'host2'",
-            "id": pytest.exception_id,
-            "name": "filter me",
-        }
-
-    def test_delete_object_exception(self, unwrap):
-        res = unwrap(self.scm.delete_object_exception)(self.scm, pytest.exception_id)
-        assert res["status"]
-        res = unwrap(self.scm.list_object_exceptions)(self.scm)
-        assert not any(x["id"] == pytest.exception_id for x in res)