feat: implemented new Policy Exceptions API endpoint (#85)

* feat: implemented new Policy Exceptions API endpoint

* docs: updated docs for new endpoint

Author: alannix-lw

docs/laceworksdk/api.html

@@ -49,6 +49,7 @@ <h2>Submodules</h2>
                 <li><a href="v2/inventory.html">inventory</a></li>
                 <li><a href="v2/organization_info.html">organization_info</a></li>
                 <li><a href="v2/policies.html">policies</a></li>
+                <li><a href="v2/policy_exceptions.html">policy_exceptions</a></li>
                 <li><a href="v2/queries.html">queries</a></li>
                 <li><a href="v2/report_definitions.html">report_definitions</a></li>
                 <li><a href="v2/report_rules.html">report_rules</a></li>

docs/laceworksdk/api/crud_endpoint.html

@@ -51,8 +51,8 @@ <h1 class="modulename">
                         <div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="c1"># coding: utf-8</span>
 </span><span id="L-2"><a href="#L-2"><span class="linenos">2</span></a><span class="c1"># file generated by setuptools_scm</span>
 </span><span id="L-3"><a href="#L-3"><span class="linenos">3</span></a><span class="c1"># don&#39;t change, don&#39;t track in version control</span>
-</span><span id="L-4"><a href="#L-4"><span class="linenos">4</span></a><span class="n">version</span> <span class="o">=</span> <span class="s1">&#39;1.0.1.dev1+gfd44171.d20220203&#39;</span>
-</span><span id="L-5"><a href="#L-5"><span class="linenos">5</span></a><span class="n">version_tuple</span> <span class="o">=</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;dev1&#39;</span><span class="p">,</span> <span class="s1">&#39;gfd44171.d20220203&#39;</span><span class="p">)</span>
+</span><span id="L-4"><a href="#L-4"><span class="linenos">4</span></a><span class="n">version</span> <span class="o">=</span> <span class="s1">&#39;1.6.0&#39;</span>
+</span><span id="L-5"><a href="#L-5"><span class="linenos">5</span></a><span class="n">version_tuple</span> <span class="o">=</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;dev1&#39;</span><span class="p">,</span> <span class="s1">&#39;gb2da4df&#39;</span><span class="p">)</span>
 </span></pre></div>
 
 

docs/laceworksdk/api/v2.html

@@ -39,6 +39,7 @@
 from .v2.inventory import InventoryAPI
 from .v2.organization_info import OrganizationInfoAPI
 from .v2.policies import PoliciesAPI
+from .v2.policy_exceptions import PolicyExceptionsAPI
 from .v2.queries import QueriesAPI
 from .v2.report_definitions import ReportDefinitionsAPI
 from .v2.report_rules import ReportRulesAPI
@@ -160,6 +161,7 @@ def __init__(self,
         self.integrations = IntegrationsAPI(self._session)
         self.organization_info = OrganizationInfoAPI(self._session)
         self.policies = PoliciesAPI(self._session)
+        self.policy_exceptions = PolicyExceptionsAPI(self._session)
         self.queries = QueriesAPI(self._session)
         self.recommendations = RecommendationsAPI(self._session)
         self.report_definitions = ReportDefinitionsAPI(self._session)

docs/laceworksdk/api/v2/policy_exceptions.html

@@ -20,7 +20,7 @@ def __init__(self,
 
         super().__init__(session, object_type, endpoint_root)
 
-    def create(self, **request_params):
+    def create(self, params=None, **request_params):
         """
         A method to create a new object.
 
@@ -33,7 +33,7 @@ def create(self, **request_params):
             request_params
         )
 
-        response = self._session.post(self.build_url(), json=json)
+        response = self._session.post(self.build_url(), json=json, params=params)
 
         return response.json()
 
@@ -70,7 +70,7 @@ def search(self, json=None, **kwargs):
 
         return response.json()
 
-    def update(self, id=None, **request_params):
+    def update(self, id=None, params=None, **request_params):
         """
         A method to update an object.
 
@@ -84,11 +84,11 @@ def update(self, id=None, **request_params):
             request_params
         )
 
-        response = self._session.patch(self.build_url(id=id), json=json)
+        response = self._session.patch(self.build_url(id=id), json=json, params=params)
 
         return response.json()
 
-    def delete(self, id):
+    def delete(self, id, params=None):
         """
         A method to delete an object.
 
@@ -97,7 +97,7 @@ def delete(self, id):
         :return response json
         """
 
-        response = self._session.delete(self.build_url(id=id))
+        response = self._session.delete(self.build_url(id=id), params=params)
 
         return response
 

docs/laceworksdk/version.html

@@ -0,0 +1,136 @@
+# -*- coding: utf-8 -*-
+"""
+Lacework Exceptions API wrapper.
+"""
+
+from laceworksdk.api.crud_endpoint import CrudEndpoint
+
+
+class PolicyExceptionsAPI(CrudEndpoint):
+
+    def __init__(self, session):
+        """
+        Initializes the PolicyExceptionsAPI object.
+
+        :param session: An instance of the HttpSession class
+
+        :return PolicyExceptionsAPI object.
+        """
+
+        super().__init__(session, "Exceptions")
+
+    def create(self,
+               policy_id,
+               description,
+               constraints,
+               **request_params):
+        """
+        A method to create a new Exceptions object.
+
+        :param policy_id: A string representing the object policy ID.
+        :param description: A string representing the object description.
+        :param constraints: A string representing the object contraints.
+            :obj
+                :param field_key: A string representing the contraint key
+                    ('accountIds', 'resourceNames', 'regionNames' and 'resourceTags')
+                :param field_values: An array of strings representing constraint values
+        :param request_params: Additional request parameters.
+            (provides support for parameters that may be added in the future)
+
+        :return response json
+        """
+
+        params = self.build_dict_from_items(
+            policy_id=policy_id
+        )
+
+        return super().create(
+            params=params,
+            description=description,
+            constraints=constraints,
+            **request_params
+        )
+
+    def get(self,
+            exception_id=None,
+            policy_id=None):
+        """
+        A method to get Exceptions objects.
+
+        :param exception_id: A string representing the exception ID.
+        :param policy_id: A string representing the object policy ID.
+
+        :return response json
+        """
+
+        return super().get(id=exception_id, policy_id=policy_id)
+
+    def get_by_id(self,
+                  exception_id,
+                  policy_id):
+        """
+        A method to get a Exceptions object by policy ID.
+
+        :param exception_id: A string representing the exception ID.
+        :param policy_id: A string representing the object policy ID.
+
+        :return response json
+        """
+
+        return self.get(
+            exception_id=exception_id,
+            policy_id=policy_id
+        )
+
+    def update(self,
+               exception_id,
+               policy_id,
+               description=None,
+               constraints=None,
+               **request_params):
+        """
+        A method to create a new Exceptions object.
+
+        :param exception_id: A string representing the exception ID.
+        :param policy_id: A string representing the object policy ID.
+        :param description: A string representing the object description.
+        :param constraints: A string representing the object contraints.
+            :obj
+                :param field_key: A string representing the contraint key
+                    ('accountIds', 'resourceNames', 'regionNames' and 'resourceTags')
+                :param field_values: An array of strings representing constraint values
+        :param request_params: Additional request parameters.
+            (provides support for parameters that may be added in the future)
+
+        :return response json
+        """
+
+        params = self.build_dict_from_items(
+            policy_id=policy_id
+        )
+
+        return super().update(
+            id=exception_id,
+            params=params,
+            description=description,
+            constraints=constraints,
+            **request_params
+        )
+
+    def delete(self,
+               exception_id,
+               policy_id):
+        """
+        A method to delete an Exceptions object.
+
+        :param exception_id: A string representing the exception ID.
+        :param policy_id: A string representing the object policy ID.
+
+        :return response json
+        """
+
+        params = self.build_dict_from_items(
+            policy_id=policy_id
+        )
+
+        return super().delete(id=exception_id, params=params)

docs/search.js

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+"""
+Test suite for the community-developed Python SDK for interacting with Lacework APIs.
+"""
+
+import pytest
+
+from laceworksdk.api.v2.policy_exceptions import PolicyExceptionsAPI
+from tests.api.test_crud_endpoint import CrudEndpoint
+
+
+# Tests
+
+@pytest.fixture(scope="module")
+def api_object(api):
+    return api.policy_exceptions
+
+
+@pytest.fixture(scope="module")
+def policy_id():
+    return "lacework-global-270"
+
+
+@pytest.fixture(scope="module")
+def api_object_create_body(random_text):
+    return {
+        "description": f"Test Policy Exception {random_text}",
+        "constraints": [
+            {
+                "fieldKey": "resourceLabel",
+                "fieldValues": [
+                    {"key": "TestKey", "value": "TestValue"}
+                ]
+            }
+        ]
+    }
+
+
+@pytest.fixture(scope="module")
+def api_object_update_body(random_text):
+    return {
+        "description": f"Test Policy Exception {random_text} (Updated)",
+        "constraints": [
+            {
+                "fieldKey": "resourceLabel",
+                "fieldValues": []
+            }
+        ]
+    }
+
+
+class TestPolicyExceptions(CrudEndpoint):
+
+    OBJECT_ID_NAME = "exceptionId"
+    OBJECT_TYPE = PolicyExceptionsAPI
+
+    def test_api_get(self, api_object, policy_id):
+        response = api_object.get(policy_id=policy_id)
+
+        assert "data" in response.keys()
+
+    def test_api_create(self, api_object, policy_id, api_object_create_body, request):
+        response = api_object.create(policy_id, **api_object_create_body)
+
+        assert "data" in response.keys()
+        self._check_object_values(api_object_create_body, response)
+
+        request.config.cache.set(self.OBJECT_ID_NAME, response["data"][self.OBJECT_ID_NAME])
+
+    def test_api_get_by_guid(self, api_object, policy_id, request):
+        guid = request.config.cache.get(self.OBJECT_ID_NAME, None)
+        assert guid is not None
+        if guid:
+            response = api_object.get(guid, policy_id)
+            assert "data" in response.keys()
+
+    def test_api_search(self):
+        pass
+
+    def test_api_update(self, api_object, policy_id, api_object_update_body, request):
+        guid = request.config.cache.get(self.OBJECT_ID_NAME, None)
+
+        if guid is None:
+            guid = self._get_random_object(api_object, self.OBJECT_ID_NAME)
+
+        assert guid is not None
+        if guid:
+            response = api_object.update(guid, policy_id, **api_object_update_body)
+
+            assert "data" in response.keys()
+
+            self._check_object_values(api_object_update_body, response)
+
+    def test_api_delete(self, api_object, policy_id, request):
+        guid = request.config.cache.get(self.OBJECT_ID_NAME, None)
+        assert guid is not None
+        if guid:
+            response = api_object.delete(guid, policy_id)
+            assert response.status_code == 204