fix: add tests and fix docstrings

Author: mariajgrimaldi

openedx_events/tests/test_tooling.py

@@ -0,0 +1,58 @@
+"""This file contains all test for the tooling.py file.
+
+Classes:
+    EventsToolingTest: Test events tooling.
+"""
+
+from django.test import TestCase
+from mock import Mock
+
+
+class OpenEdxPublicSignalTest(TestCase):
+    """
+    Test cases for Open edX events base class.
+    """
+
+    def test_get_signal_metadata(self):
+        """
+        This methods tests getting generated metadata for an event.
+
+        Expected behavior:
+            Returns the metadata containing information about the event.
+        """
+
+    def test_event_instantiation_exception(self):
+        """
+        This method tests when an event is instantiated without event_type or
+        event data.
+
+        Expected behavior:
+            An InstantiationException exception is raised.
+        """
+
+    def test_send_event_successfully(self):
+        """
+        This method tests the process of sending an event.
+
+        Expected behavior:
+            The event is sent as a django signal.
+        """
+
+    def test_invalid_sender(self):
+        """
+        This method tests sending an event with invalid setup on the sender
+        side.
+
+        Expected behavior:
+            An SenderValidationException exception is raised.
+        """
+
+    def test_send_event_with_django(self):
+        """
+        This method tests sending an event using the `send` built-in Django
+        method.
+
+        Expected behavior:
+            A warning is showed advicing to use Open edX events custom
+            send_signal method.
+        """

openedx_events/tooling.py

@@ -24,6 +24,9 @@ def __init__(self, event_type=None, data=None, minor_version="0.0"):
         self.minor_version = minor_version
         super().__init__()
 
+    def __repr__(self):
+        return "OpenEdxPublicSignal: {event_type}".format(self.event_type)
+
     def get_signal_metadata(self):
         """Used to set signal extra metadata when an event is triggered.
 
@@ -34,23 +37,27 @@ def get_signal_metadata(self):
         """
 
         def get_current_time():
-            """Helper function used to get timestamp when the event ocurred.
+            """
+            Helper function used to get timestamp when the event ocurred.
             """
             return str(datetime.utcnow().isoformat())  + "Z"
 
         def get_source():
-            """Helper function used to get logical source of an event.
+            """
+            Helper function used to get logical source of an event.
             """
             return "openedx/{service}/web".format(service=getattr(settings, 'SERVICE_VARIANT', ''))
 
         def get_source_host():
-            """Helper function used to get physical source of the event.
+            """
+            Helper function used to get physical source of the event.
             """
             current_request = crum.get_current_request()
             return current_request.get_host() if current_request else None
 
         def get_spec_version():
-            """Helper function used to get the version of specification which
+            """
+            Helper function used to get the version of specification which
             Open edX events library uses.
             """
             return openedx_events.__version__
@@ -65,7 +72,8 @@ def get_spec_version():
         }
 
     def send_event(self, **kwargs):
-        """Send method for Open edX signals.
+        """
+        Custom send method for Open edX signals.
 
         Sends signals using Django signals send method making argument
         validation in the process.
@@ -83,7 +91,8 @@ def send_event(self, **kwargs):
         """
 
         def validate_sender():
-            """Helper method used to validate what the sender uses as arguments.
+            """
+            Helper method used to validate what the sender uses as arguments.
             """
             if len(kwargs.keys()) !=  len(self.data.keys()):
                 raise SenderValidationException()
@@ -99,17 +108,12 @@ def validate_sender():
         super().send(sender, **kwargs)
 
     def send(self, sender, **kwargs):  # pylint: disable=unused-argument
-        """Override method used to advice the sender to use our custom method.
+        """
+        Override method used to advice the sender to use our custom method.
 
         Example usage:
 
         Arguments:
             sender:
-
-        Keyword arguments:
-
-        Returns:
-
-        Exceptions raised:
         """
         warnings.warn("Please, use 'send_event' when triggering an Open edX event.")