CloudEvents equality override

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1]
+### Added
+- CloudEvent equality override ([#98])
+
 ## [1.0.0]
 ### Added
 - Added a user friendly CloudEvent class with data validation ([#36])
@@ -77,3 +81,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#36]: https://github.com/cloudevents/sdk-python/pull/36
 [#43]: https://github.com/cloudevents/sdk-python/pull/43
 [#47]: https://github.com/cloudevents/sdk-python/pull/47
+[#98]: https://github.com/cloudevents/sdk-python/pull/98

cloudevents/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.0"
+__version__ = "1.0.1"

cloudevents/http/event.py

@@ -68,6 +68,9 @@ def __init__(
                 f"Missing required keys: {required_set - attributes.keys()}"
             )
 
+    def __eq__(self, other):
+        return self.data == other.data and self._attributes == other._attributes
+
     # Data access is handled via `.data` member
     # Attribute access is managed via Mapping type
     def __getitem__(self, key):

cloudevents/tests/test_http_cloudevent_overrides.py

@@ -0,0 +1,71 @@
+import pytest
+
+from cloudevents.http import CloudEvent
+
+
+@pytest.mark.parametrize("specversion", ["0.3", "1.0"])
+def test_http_cloudevent_equality(specversion):
+    attributes = {
+        "source": "<source>",
+        "specversion": specversion,
+        "id": "my-id",
+        "time": "tomorrow",
+        "type": "tests.cloudevents.override",
+        "datacontenttype": "application/json",
+        "subject": "my-subject",
+    }
+    data = '{"name":"john"}'
+    event1 = CloudEvent(attributes, data)
+    event2 = CloudEvent(attributes, data)
+    assert event1 == event2
+    # Test different attributes
+    for key in attributes:
+        if key == "specversion":
+            continue
+        else:
+            attributes[key] = f"noise-{key}"
+        event3 = CloudEvent(attributes, data)
+        event2 = CloudEvent(attributes, data)
+        assert event2 == event3
+        assert event1 != event2 and event3 != event1
+
+    # Test different data
+    data = '{"name":"paul"}'
+    event3 = CloudEvent(attributes, data)
+    event2 = CloudEvent(attributes, data)
+    assert event2 == event3
+    assert event1 != event2 and event3 != event1
+
+
+@pytest.mark.parametrize("specversion", ["0.3", "1.0"])
+def test_http_cloudevent_mutates_equality(specversion):
+    attributes = {
+        "source": "<source>",
+        "specversion": specversion,
+        "id": "my-id",
+        "time": "tomorrow",
+        "type": "tests.cloudevents.override",
+        "datacontenttype": "application/json",
+        "subject": "my-subject",
+    }
+    data = '{"name":"john"}'
+    event1 = CloudEvent(attributes, data)
+    event2 = CloudEvent(attributes, data)
+    event3 = CloudEvent(attributes, data)
+
+    assert event1 == event2
+    # Test different attributes
+    for key in attributes:
+        if key == "specversion":
+            continue
+        else:
+            event2[key] = f"noise-{key}"
+            event3[key] = f"noise-{key}"
+        assert event2 == event3
+        assert event1 != event2 and event3 != event1
+
+    # Test different data
+    event2.data = '{"name":"paul"}'
+    event3.data = '{"name":"paul"}'
+    assert event2 == event3
+    assert event1 != event2 and event3 != event1