feat: added endpoints for AzureSubscriptions and GcpProjects (#99)

* feat: added endpoints for `AzureSubscriptions` and `GcpProjects`

* fix: linting for EOF

Author: alannix-lw

laceworksdk/api/read_endpoint.py

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+
+from laceworksdk.api.base_endpoint import BaseEndpoint
+
+
+class ReadEndpoint(BaseEndpoint):
+    """
+    A class used to implement Read functionality for Lacework API Endpoints
+    """
+
+    # If defined, this is the resource used in the URL path
+    RESOURCE = ""
+
+    def __init__(self,
+                 session,
+                 object_type,
+                 endpoint_root="/api/v2"):
+        """
+        :param session: An instance of the HttpSession class.
+        :param object_type: The Lacework object type to use.
+        :param endpoint_root: The URL endpoint root to use.
+        """
+
+        super().__init__(session, object_type, endpoint_root)
+
+    def get(self, id=None, resource=None, **request_params):
+        """
+        A method to get objects.
+
+        :param guid: A string representing the object ID.
+        :param type: A string representing the object resource type.
+        :param request_params: A dictionary of parameters to add to the request.
+
+        :return response json
+        """
+
+        if not resource and self.RESOURCE:
+            resource = self.RESOURCE
+
+        params = self.build_dict_from_items(
+            request_params
+        )
+
+        response = self._session.get(self.build_url(id=id, resource=resource), params=params)
+
+        return response.json()

laceworksdk/api/v2/configs.py

@@ -3,6 +3,7 @@
 Lacework Configs API wrapper.
 """
 
+from laceworksdk.api.read_endpoint import ReadEndpoint
 from laceworksdk.api.search_endpoint import SearchEndpoint
 
 
@@ -29,7 +30,33 @@ def __init__(self, session):
         super().__init__()
         self._base_path = "Configs"
 
+        self.azure_subscriptions = AzureSubscriptions(session, self._base_path)
         self.compliance_evaluations = ComplianceEvaluationsAPI(session, self._base_path)
+        self.gcp_projects = GcpProjects(session, self._base_path)
+
+
+class AzureSubscriptions(ReadEndpoint):
+    """A class used to represent the Azure Subscriptions API endpoint.
+
+    Methods
+    -------
+    get(request_params=None)
+        A method to get AzureSubscription objects.
+        (tenantId is an optional parameter)
+    """
+    RESOURCE = "AzureSubscriptions"
+
+
+class GcpProjects(ReadEndpoint):
+    """A class used to represent the GCP Projects API endpoint.
+
+    Methods
+    -------
+    get(request_params=None)
+        A method to get GcpProjects objects.
+        (orgId is an optional parameter)
+    """
+    RESOURCE = "GcpProjects"
 
 
 class ComplianceEvaluationsAPI(SearchEndpoint):

tests/api/test_read_endpoint.py

@@ -10,10 +10,26 @@
 
 class ReadEndpoint(BaseEndpoint):
 
-    def test_api_get(self, api_object):
-        response = api_object.get()
+    OBJECT_TYPE = None
+    OBJECT_MAP = {}
+
+    def test_object_creation(self, api_object):
+
+        if self.OBJECT_TYPE:
+            assert isinstance(api_object, self.OBJECT_TYPE)
 
-        assert "data" in response.keys()
+        if len(self.OBJECT_MAP) > 0:
+            for attribute, object_type in self.OBJECT_MAP.items():
+                assert isinstance(getattr(api_object, attribute), object_type)
+
+    def test_api_get(self, api_object):
+        if len(self.OBJECT_MAP) > 0:
+            for attribute in self.OBJECT_MAP.keys():
+                response = getattr(api_object, attribute).get()
+                assert "data" in response.keys()
+        else:
+            response = api_object.get()
+            assert "data" in response.keys()
 
     def test_api_search(self, api_object):
         random_object_id = self._get_random_object(api_object, self.OBJECT_ID_NAME)

tests/api/v2/test_configs.py

@@ -7,8 +7,11 @@
 
 from laceworksdk.api.v2.configs import (
     ConfigsAPI,
-    ComplianceEvaluationsAPI
+    ComplianceEvaluationsAPI,
+    AzureSubscriptions,
+    GcpProjects
 )
+from tests.api.test_read_endpoint import ReadEndpoint
 from tests.api.test_search_endpoint import SearchEndpoint
 
 # Tests
@@ -30,3 +33,15 @@ class TestConfigsEndpoint(SearchEndpoint):
     def test_api_search_by_date(self, api_object, dataset):
 
         return super().test_api_search_by_date(api_object=api_object, filters={"dataset": dataset})
+
+
+class TestConfigsLookups(ReadEndpoint):
+
+    OBJECT_TYPE = ConfigsAPI
+    OBJECT_MAP = {
+        "azure_subscriptions": AzureSubscriptions,
+        "gcp_projects": GcpProjects
+    }
+
+    def test_api_search(self, api_object):
+        pass