fix: List events can receive a name to filter

Signed-off-by: Federico Barcelona <[email protected]>

Author: tembleking

sdcclient/_common.py

@@ -392,11 +392,12 @@ def post_event(self, name, description=None, severity=None, event_filter=None, t
                             verify=self.ssl_verify)
         return self._request_result(res)
 
-    def get_events(self, category=None, direction='before', status=None, limit=100, pivot=None):
+    def get_events(self, name=None, category=None, direction='before', status=None, limit=100, pivot=None):
         '''**Description**
             Returns the list of Sysdig Monitor events.
 
         **Arguments**
+            - **name**: filter events by name. Default: None.
             - **category**: filter events by category. Default: ['alert', 'custom', 'docker', 'containerd', 'kubernetes'].
             - **direction**: orders the list of events. Valid values: "before", "after". Default: "before".
             - **status**: status of the event as list. Default: ['triggered', 'resolved', 'acknowledged', 'unacknowledged']
@@ -416,18 +417,18 @@ def get_events(self, category=None, direction='before', status=None, limit=100,
 
         for c in category:
             if c not in valid_categories:
-                return (False, "Invalid category '{}'".format(c))
+                return False, "Invalid category '{}'".format(c)
 
         valid_status = ["triggered", "resolved", "acknowledged", "unacknowledged"]
         if status is None:
             status = valid_status
 
         for s in status:
             if s not in valid_status:
-                return (False, "Invalid status '{}'".format(s))
+                return False, "Invalid status '{}'".format(s)
 
         if direction not in ["before", "after"]:
-            return (False, "Invalid direction '{}', must be either 'before' or 'after'".format(direction))
+            return False, "Invalid direction '{}', must be either 'before' or 'after'".format(direction)
 
         options = {
             'alertStatus': status,
@@ -438,6 +439,7 @@ def get_events(self, category=None, direction='before', status=None, limit=100,
             'include_total': 'true',
             'limit': str(limit),
             'pivot': pivot,
+            'filter': name,
         }
         params = {k: v for k, v in options.items() if v is not None}
         res = requests.get(self.url + '/api/v2/events/', headers=self.hdrs, params=params, verify=self.ssl_verify)

specs/_common/event_spec.py

@@ -69,4 +69,19 @@
             ok, res = self.client.get_events(direction="incorrect_direction")
 
             expect(ok).to(be_false)
-            expect(res).to(equal("Invalid direction 'incorrect_direction', must be either 'before' or 'after'"))
+            expect(res).to(equal("Invalid direction 'incorrect_direction', must be either 'before' or 'after'"))
+
+        with it("is able to retrieve events by name"):
+            ok, res = self.client.get_events(name="Container")
+
+            expect(ok).to(be_true)
+            expect(res).to(have_key("events"))
+            expect(res["events"]).to(contain(have_key("name")))
+            expect(res["events"][0]["name"]).to(contain("Container"))
+
+        with it("retrieves an empty list when the name provided is not found"):
+            ok, res = self.client.get_events(name="RandomUnexistingEvent")
+
+            expect(ok).to(be_true)
+            expect(res).to(have_key("events"))
+            expect(res["events"]).to(be_empty)