Audit trail get_events tests

Henry Chan · henrylamchan · commit 29ac97f6be08 · 2020-07-22T19:50:07.000-04:00
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -41,17 +41,19 @@ def mock(*args, **kwargs):
 
 
 @pytest.fixture
-def capture_and_mock_requests(monkeypatch):
-    def inner():
-        captured_requests = []
+def capture_and_mock_request(monkeypatch):
+    def inner(method, response_dict, status_code):
+        request_args = []
+        request_kwargs = {}
 
-        def capture(*args, **kwargs):
-            captured_requests.append((args, kwargs))
-            return MockResponse({}, 200)
+        def capture_and_mock(*args, **kwargs):
+            request_args.extend(args)
+            request_kwargs.update(kwargs)
 
-        monkeypatch.setattr(requests, "get", capture)
-        monkeypatch.setattr(requests, "post", capture)
+            return MockResponse(response_dict, status_code)
 
-        return captured_requests
+        monkeypatch.setattr(requests, method, capture_and_mock)
+
+        return (request_args, request_kwargs)
 
     return inner
diff --git a/tests/test_audit_trail.py b/tests/test_audit_trail.py
@@ -23,17 +23,18 @@ def test_create_audit_trail_event_succeeds(self, mock_request_method):
             "actor_id": "user_12345",
             "target_name": "Ryota Yamasato",
             "target_id": "user_67890",
-            "occurred_at": datetime.utcnow().isoformat(),
+            "occurred_at": datetime.now().isoformat(),
             "metadata": {"a": "b"},
         }
         mock_response = Response()
         mock_response.status_code = 200
         mock_request_method("post", mock_response, 200)
-        response = self.audit_trail.create_event(event)
-        assert response.status_code == 200
+
+        result = self.audit_trail.create_event(event)
+        assert result == True
 
     def test_create_audit_trail_event_fails_with_long_metadata(self):
-        with pytest.raises(Exception, match=r"Number of metadata keys exceeds .*"):
+        with pytest.raises(ValueError, match=r"Number of metadata keys exceeds .*"):
             metadata = {str(num): num for num in range(51)}
             event = {
                 "group": "Terrace House",
@@ -48,3 +49,155 @@ def test_create_audit_trail_event_fails_with_long_metadata(self):
                 "metadata": metadata,
             }
             self.audit_trail.create_event(event)
+
+    def test_get_events_succeeds(self, mock_request_method):
+        event = {
+            "id": "evt_123",
+            "group": "Terrace House",
+            "location": "1.1.1.1",
+            "latitude": None,
+            "longitude": None,
+            "action": {
+                "id": "evt_action_123",
+                "name": "house.created",
+                "project_id": "project_123",
+            },
+            "type": "C",
+            "actor_name": "Daiki Miyagi",
+            "actor_id": "user_12345",
+            "target_name": "Ryota Yamasato",
+            "target_id": "user_67890",
+            "occurred_at": datetime.now().isoformat(),
+            "metadata": {"a": "b"},
+        }
+
+        response = {
+            "data": [event,],
+            "listMetadata": {"before": None, "after": None,},
+        }
+        mock_request_method("get", response, 200)
+
+        events, before, after = self.audit_trail.get_events()
+        assert events[0].to_dict() == event
+
+    def test_get_events_raises_valueerror_when_before_and_after_provided(self):
+        with pytest.raises(ValueError):
+            self.audit_trail.get_events(before="evt_123", after="evt_456")
+
+    def test_get_events_correctly_includes_occured_at_filter(
+        self, capture_and_mock_request
+    ):
+        event = {
+            "id": "evt_123",
+            "group": "Terrace House",
+            "location": "1.1.1.1",
+            "latitude": None,
+            "longitude": None,
+            "action": {
+                "id": "evt_action_123",
+                "name": "house.created",
+                "project_id": "project_123",
+            },
+            "type": "C",
+            "actor_name": "Daiki Miyagi",
+            "actor_id": "user_12345",
+            "target_name": "Ryota Yamasato",
+            "target_id": "user_67890",
+            "occurred_at": datetime.now().isoformat(),
+            "metadata": {"a": "b"},
+        }
+
+        response = {
+            "data": [event,],
+            "listMetadata": {"before": None, "after": None,},
+        }
+        request_args, request_kwargs = capture_and_mock_request("get", response, 200)
+
+        self.audit_trail.get_events(
+            occurred_at=datetime.now(),
+            occurred_at_gte=datetime.now(),
+            occurred_at_gt=datetime.now(),
+            occurred_at_lte=datetime.now,
+            occurred_at_lt=datetime.now(),
+        )
+
+        request_params = request_kwargs["params"]
+        assert "occurred_at" in request_params
+        assert "occurred_at_gte" not in request_params
+        assert "occurred_at_gt" not in request_params
+        assert "occurred_at_lte" not in request_params
+        assert "occurred_at_lt" not in request_params
+
+    def test_get_events_correctly_includes_occurred_at_gte(
+        self, capture_and_mock_request
+    ):
+        event = {
+            "id": "evt_123",
+            "group": "Terrace House",
+            "location": "1.1.1.1",
+            "latitude": None,
+            "longitude": None,
+            "action": {
+                "id": "evt_action_123",
+                "name": "house.created",
+                "project_id": "project_123",
+            },
+            "type": "C",
+            "actor_name": "Daiki Miyagi",
+            "actor_id": "user_12345",
+            "target_name": "Ryota Yamasato",
+            "target_id": "user_67890",
+            "occurred_at": datetime.now().isoformat(),
+            "metadata": {"a": "b"},
+        }
+
+        response = {
+            "data": [event,],
+            "listMetadata": {"before": None, "after": None,},
+        }
+        request_args, request_kwargs = capture_and_mock_request("get", response, 200)
+
+        self.audit_trail.get_events(
+            occurred_at_gte=datetime.now(), occurred_at_gt=datetime.now(),
+        )
+
+        request_params = request_kwargs["params"]
+        assert "occurred_at_gte" in request_params
+        assert "occurred_at_gt" not in request_params
+
+    def test_get_events_correctly_includes_occured_at_lte(
+        self, capture_and_mock_request
+    ):
+        event = {
+            "id": "evt_123",
+            "group": "Terrace House",
+            "location": "1.1.1.1",
+            "latitude": None,
+            "longitude": None,
+            "action": {
+                "id": "evt_action_123",
+                "name": "house.created",
+                "project_id": "project_123",
+            },
+            "type": "C",
+            "actor_name": "Daiki Miyagi",
+            "actor_id": "user_12345",
+            "target_name": "Ryota Yamasato",
+            "target_id": "user_67890",
+            "occurred_at": datetime.now().isoformat(),
+            "metadata": {"a": "b"},
+        }
+
+        response = {
+            "data": [event,],
+            "listMetadata": {"before": None, "after": None,},
+        }
+        request_args, request_kwargs = capture_and_mock_request("get", response, 200)
+
+        self.audit_trail.get_events(
+            occurred_at_lte=datetime.now, occurred_at_lt=datetime.now()
+        )
+
+        request_params = request_kwargs["params"]
+        assert "occurred_at_lte" in request_params
+        assert "occurred_at_lt" not in request_params
diff --git a/tests/utils/test_requests.py b/tests/utils/test_requests.py
@@ -74,14 +74,12 @@ def test_request_bad_body_raises_expected_exception_with_request_data(
             # This'll fail for sure here but... just using the nice error that'd come up
             assert ex.__class__ == ServerException
 
-    def test_request_includes_base_headers(self, capture_and_mock_requests):
-        requests = capture_and_mock_requests()
+    def test_request_includes_base_headers(self, capture_and_mock_request):
+        request_args, request_kwargs = capture_and_mock_request("get", {}, 200)
 
         RequestHelper().request("ok_place")
 
-        assert len(requests) == 1
-
         base_headers = set(BASE_HEADERS.items())
-        headers = set(requests[0][1]["headers"].items())
+        headers = set(request_kwargs["headers"].items())
 
         assert base_headers.issubset(headers)
diff --git a/workos/__init__.py b/workos/__init__.py
@@ -5,4 +5,4 @@
 
 api_key = os.getenv("WORKOS_API_KEY")
 project_id = os.getenv("WORKOS_PROJECT_ID")
-base_api_url = "http://localhost:7000/"
+base_api_url = "https://api.workos.com/"
diff --git a/workos/audit_trail.py b/workos/audit_trail.py
@@ -50,7 +50,7 @@ def create_event(self, event, idempotency_key=None):
             idempotency_key (str) - An idempotency key
 
         Returns:
-            dict: Response from WorkOS
+            boolean: Returns True
         """
         if len(event.get("metadata", {})) > METADATA_LIMIT:
             raise ValueError(
@@ -61,14 +61,16 @@ def create_event(self, event, idempotency_key=None):
             "idempotency-key": idempotency_key,
         }
 
-        return self.request_helper.request(
+        self.request_helper.request(
             EVENTS_PATH,
             method=REQUEST_METHOD_POST,
             params=event,
             headers=headers,
             token=workos.api_key,
         )
 
+        return True
+
     def get_events(
         self,
         before=None,
@@ -123,41 +125,41 @@ def get_events(
             "limit": limit,
         }
 
-        if group:
+        if group is not None:
             params["group"] = list(group)
 
-        if action:
+        if action is not None:
             params["action"] = list(action)
 
-        if action_type:
+        if action_type is not None:
             params["action_type"] = list(action_type)
 
-        if actor_name:
+        if actor_name is not None:
             params["actor_name"] = list(actor_name)
 
-        if actor_id:
+        if actor_id is not None:
             params["actor_id"] = list(actor_id)
 
-        if target_name:
+        if target_name is not None:
             params["target_name"] = list(target_name)
 
-        if target_id:
+        if target_id is not None:
             params["target_id"] = list(target_id)
 
-        if occurred_at:
+        if occurred_at is not None:
             params["occurred_at"] = occurred_at
         else:
-            if occurred_at_gte:
+            if occurred_at_gte is not None:
                 params["occurred_at_gte"] = occurred_at_gte
-            elif occurred_at_gt:
+            elif occurred_at_gt is not None:
                 params["occurred_at_gt"] = occurred_at_gt
 
-            if occurred_at_lte:
+            if occurred_at_lte is not None:
                 params["occurred_at_lte"] = occurred_at_lte
-            elif occurred_at_lt:
+            elif occurred_at_lt is not None:
                 params["occurred_at_lt"] = occurred_at_lt
 
-        if search:
+        if search is not None:
             params["search"] = search
 
         response = self.request_helper.request(
diff --git a/workos/resources/base.py b/workos/resources/base.py
@@ -1,22 +1,22 @@
 class WorkOSBaseResource(object):
     """Representation of a WorkOS Resource as returned through the API.
     
-  Attributes:
-      OBJECT_FIELDS (list): List of fields a Resource is comprised of.
-  """
+    Attributes:
+        OBJECT_FIELDS (list): List of fields a Resource is comprised of.
+    """
 
     OBJECT_FIELDS = []
 
     @classmethod
     def construct_from_response(cls, response):
         """Returns an instance of WorkOSBaseResource.
 
-    Args:
-        response (dict): Resource data from a WorkOS API response
+        Args:
+            response (dict): Resource data from a WorkOS API response
 
-    Returns:
-        WorkOSBaseResource: Instance of a WorkOSBaseResource with OBJECT_FIELDS fields set
-    """
+        Returns:
+            WorkOSBaseResource: Instance of a WorkOSBaseResource with OBJECT_FIELDS fields set
+        """
         obj = cls()
         for field in cls.OBJECT_FIELDS:
             setattr(obj, field, response[field])
@@ -25,10 +25,10 @@ def construct_from_response(cls, response):
 
     def to_dict(self):
         """Returns a dict representation of the WorkOSBaseResource.
-        
-    Returns:
-        dict: A dict representation of the WorkOSBaseResource
-    """
+            
+        Returns:
+            dict: A dict representation of the WorkOSBaseResource
+        """
         obj_dict = {}
         for field in self.OBJECT_FIELDS:
             obj_dict[field] = getattr(self, field, None)
