feat: Add get_event by ID method to Events client v1 and v2 (#188)

* feat: Add get_event by ID method to Events client v1 and v2
* fix: Solve linting problems
* fix(ci): Update custom fixture rules file

Author: tembleking

sdcclient/monitor/_events_v1.py

@@ -36,6 +36,27 @@ def get_events(self, from_s=None, to_s=None, last_s=None):
         res = self.http.get(self.url + '/api/events/', headers=self.hdrs, params=params, verify=self.ssl_verify)
         return self._request_result(res)
 
+    def get_event(self, id):
+        """
+        Retrieve an event using the ID
+        Args:
+            id(str): ID of the event to retrieve
+
+        Returns:
+            A tuple where the first parameter indicates if the call was successful,
+            and the second parameter holds either the error as string, or the event matching this ID.
+
+        Examples:
+            >>> from sdcclient.monitor import EventsClientV1
+            >>> client = EventsClientV1(token=SECURE_TOKEN)
+            >>> ok, res = client.get_event(id='2343214984')
+            >>> if ok:
+            >>>     print(res["event"])
+        """
+        url = f'{self.url}/api/events/{id}'
+        res = self.http.get(url, headers=self.hdrs, verify=self.ssl_verify)
+        return self._request_result(res)
+
     def post_event(self, name, description=None, severity=None, event_filter=None, tags=None):
         '''**Description**
             Send an event to Sysdig Monitor. The events you post are available in the Events tab in the Sysdig Monitor UI and can be overlied to charts.

sdcclient/monitor/_events_v2.py

@@ -79,6 +79,28 @@ def get_events(self, name=None, category=None, direction='before', status=None,
         res = self.http.get(self.url + '/api/v2/events/', headers=self.hdrs, params=params, verify=self.ssl_verify)
         return self._request_result(res)
 
+    def get_event(self, id):
+        """
+        Retrieve an event using the ID
+        Args:
+            id(str): ID of the event to retrieve
+
+        Returns:
+            A tuple where the first parameter indicates if the call was successful,
+            and the second parameter holds either the error as string, or the event matching this ID.
+
+        Examples:
+            >>> from sdcclient.monitor import EventsClientV2
+            >>> client = EventsClientV2(token=SECURE_TOKEN)
+            >>> ok, res = client.get_event(id='2343214984')
+            >>> if ok:
+            >>>     print(res["event"])
+        """
+
+        url = f'{self.url}/api/v2/events/{id}'
+        res = self.http.get(url, headers=self.hdrs, verify=self.ssl_verify)
+        return self._request_result(res)
+
     def delete_event(self, event):
         '''**Description**
             Deletes an event.

specs/monitor/events_v1_spec.py

@@ -1,7 +1,7 @@
 import os
 import time
 
-from expects import expect, have_key, contain, have_keys, be_empty
+from expects import expect, have_key, contain, have_keys, be_empty, equal
 from mamba import it, before, description
 
 from sdcclient.monitor import EventsClientV1
@@ -18,6 +18,19 @@
                                       description="This event was created in a CI pipeline for the Python SDK library")
         expect(call).to(be_successful_api_call)
 
+    with it("is able to retrieve an event by ID"):
+        ok, res = self.client.post_event(name=self.event_name,
+                                         description="This event was created in a CI pipeline for the Python SDK library")
+        expect((ok, res)).to(be_successful_api_call)
+
+        event = res["event"]
+        event_id = event["id"]
+
+        ok, res = self.client.get_event(id=event_id)
+        expect((ok, res)).to(be_successful_api_call)
+
+        expect(res["event"]).to(equal(event))
+
     with it("is able to list the events happened without any filter"):
         time.sleep(3)  # Wait for the event to appear in the feed
         ok, res = self.client.get_events()

specs/monitor/events_v2_spec.py

@@ -32,6 +32,19 @@
         expect(res).to(have_key("events"))
         expect(res["events"]).to(contain(have_key("scope", equal("host.hostName = 'ci'"))))
 
+    with it("is able to retrieve an event by ID"):
+        ok, res = self.client.post_event(name=self.event_name,
+                                         description="This event was created in a CI pipeline for the Python SDK library")
+        expect((ok, res)).to(be_successful_api_call)
+
+        event = res["event"]
+        event_id = event["id"]
+
+        ok, res = self.client.get_event(id=event_id)
+        expect((ok, res)).to(be_successful_api_call)
+
+        expect(res["event"]).to(equal(event))
+
     with it("is able to list the events happened without any filter"):
         time.sleep(3)  # Wait for the event to appear in the feed
         ok, res = self.client.get_events()