test: Unittest for event (#18)

###Summary

inline doc for event module
unit test for event module

###Checklist
* [x]Does your PR title have the correct title format?
* Does your PR have a breaking change?: no

Author: bohan-amplitude

.github/pull_request_template.md

@@ -1,5 +1,5 @@
 <!---
-Thanks for contributing to the Amplitude Java SDK! 🎉
+Thanks for contributing to the Amplitude Python SDK! 🐍
 
 Please fill out the following sections to help us quickly review your pull request.
 --->

src/amplitude/__init__.py

@@ -1,5 +1,9 @@
+"""The official Amplitude Python SDK"""
+
+
 from amplitude.client import Amplitude
-from amplitude.event import BaseEvent, EventOptions, Identify, Revenue, IdentifyEvent, GroupIdentifyEvent, RevenueEvent
+from amplitude.event import BaseEvent, EventOptions, Identify, Revenue, IdentifyEvent, \
+    GroupIdentifyEvent, RevenueEvent, Plan
 from amplitude.config import Config
 from amplitude.constants import PluginType
 from amplitude.plugin import EventPlugin, DestinationPlugin

src/amplitude/client.py

@@ -23,7 +23,7 @@ class Amplitude:
     Attributes:
         configuration (amplitude.config.Config): the configuration of client instance
 
-    Methods
+    Methods:
         track(event): Process and send event
         identify(identify_obj, event_properties, event_options): Send an identify event to update user properties
         group_identify(group_type, group_name, identify_obj, event_options, event_properties, user_properties): Send
@@ -110,7 +110,7 @@ def revenue(self, revenue_obj: Revenue, event_options: EventOptions):
                 like user_id.
         """
         if not revenue_obj.is_valid():
-            self.configuration.logger.error("Missing price for revenue event")
+            self.configuration.logger.error("Invalid price for revenue event")
         else:
             event = revenue_obj.to_revenue_event()
             event.load_event_options(event_options)

src/amplitude/config.py

@@ -12,7 +12,7 @@ def __init__(self, api_key: str = None,
                  flush_queue_size: int = constants.FLUSH_QUEUE_SIZE,
                  flush_interval_millis: int = constants.FLUSH_INTERVAL_MILLIS,
                  flush_max_retries: int = constants.FLUSH_MAX_RETRIES,
-                 logger=logging.getLogger(__name__),
+                 logger=logging.getLogger(constants.LOGGER_NAME),
                  min_id_length: Optional[int] = None,
                  callback: Optional[Callable[[BaseEvent, int, Optional[str]], None]] = None,
                  server_zone: str = constants.DEFAULT_ZONE,

src/amplitude/constants.py

@@ -17,6 +17,7 @@
         HTTP_V2: "https://api2.amplitude.com/2/httpapi"
     }
 }
+LOGGER_NAME = "amplitude"
 
 IDENTIFY_EVENT = "$identify"
 GROUP_IDENTIFY_EVENT = "$groupidentify"

src/amplitude/event.py

@@ -4,6 +4,7 @@
 
 from amplitude.constants import PluginType
 from amplitude.exception import InvalidEventError
+from amplitude.constants import LOGGER_NAME
 
 
 class Timeline:
@@ -25,7 +26,7 @@ def __init__(self, configuration=None):
     def logger(self):
         if self.configuration:
             return self.configuration.logger
-        return logging.getLogger(__name__)
+        return logging.getLogger(LOGGER_NAME)
 
     def setup(self, client):
         self.configuration = client.configuration

src/amplitude/timeline.py

@@ -3,7 +3,7 @@
 
 from amplitude import constants
 
-logger = logging.getLogger(__name__)
+logger = logging.getLogger(constants.LOGGER_NAME)
 
 
 def current_milliseconds() -> int:
@@ -15,7 +15,7 @@ def truncate(obj):
         if not obj:
             return {}
         if len(obj) > constants.MAX_PROPERTY_KEYS:
-            logger.error(f"Too many properties: {obj}")
+            logger.error(f"Too many properties. {constants.MAX_PROPERTY_KEYS} maximum.")
             return {}
         for key, value in obj.items():
             obj[key] = truncate(value)

src/amplitude/utils.py

@@ -17,7 +17,7 @@ def setUp(self) -> None:
     def tearDown(self) -> None:
         self.client.shutdown()
 
-    def test_track_success(self):
+    def test_amplitude_client_track_success(self):
         post_method = MagicMock()
         HttpClient.post = post_method
         res = Response(HttpStatus.SUCCESS)
@@ -40,7 +40,7 @@ def callback_func(event, code, message=None):
                 self.assertEqual(25, len(events))
                 post_method.assert_called()
 
-    def test_track_invalid_api_key(self):
+    def test_amplitude_client_track_invalid_api_key_log_error(self):
         post_method = MagicMock()
         HttpClient.post = post_method
         res = Response(HttpStatus.INVALID_REQUEST)
@@ -57,7 +57,7 @@ def test_track_invalid_api_key(self):
                     post_method.assert_called_once()
                     self.assertEqual(["ERROR:test:Invalid API Key"], cm.output)
 
-    def test_track_invalid(self):
+    def test_amplitude_client_track_invalid_response_then_success_response(self):
         post_method = MagicMock()
         HttpClient.post = post_method
         invalid_res = Response(HttpStatus.INVALID_REQUEST)
@@ -97,7 +97,7 @@ def callback_func(event, code, message=None):
                 self.assertEqual([(1, 0), (2, 0), (5, 0), (6, 0), (8, 0),
                                   (0, 1), (3, 1), (4, 1), (7, 1), (9, 1)], events)
 
-    def test_identify(self):
+    def test_amplitude_client_identify_invalid_log_error_then_success(self):
         post_method = MagicMock()
         HttpClient.post = post_method
         res = Response(HttpStatus.SUCCESS)
@@ -118,14 +118,19 @@ def callback_func(event, code, message=None):
                 self.client.configuration.use_batch = use_batch
                 identify_obj = Identify()
                 self.assertFalse(identify_obj.is_valid())
+                with self.assertLogs("test", "ERROR") as cm:
+                    self.client.configuration.logger = logging.getLogger("test")
+                    self.client.identify(identify_obj,
+                                         EventOptions(user_id="test_user_id", device_id="test_device_id"))
+                    self.assertEqual(["ERROR:test:Empty identify properties"], cm.output)
                 identify_obj.set("birth_date", "4-1-2022")
                 self.assertTrue(identify_obj.is_valid())
                 self.assertEqual({"$set": {"birth_date": "4-1-2022"}}, identify_obj.user_properties)
                 self.client.identify(identify_obj, EventOptions(user_id="test_user_id", device_id="test_device_id"))
                 self.client.flush()
                 post_method.assert_called_once()
 
-    def test_group_identify(self):
+    def test_amplitude_client_group_identify_invalid_log_error_then_success(self):
         post_method = MagicMock()
         HttpClient.post = post_method
         res = Response(HttpStatus.SUCCESS)
@@ -147,6 +152,11 @@ def callback_func(event, code, message=None):
                 self.client.configuration.use_batch = use_batch
                 identify_obj = Identify()
                 self.assertFalse(identify_obj.is_valid())
+                with self.assertLogs("test", "ERROR") as cm:
+                    self.client.configuration.logger = logging.getLogger("test")
+                    self.client.group_identify("Sports", "Football", identify_obj,
+                                               EventOptions(user_id="test_user_id", device_id="test_device_id"))
+                    self.assertEqual(["ERROR:test:Empty group identify properties"], cm.output)
                 identify_obj.set("team_name", "Super Power")
                 self.assertTrue(identify_obj.is_valid())
                 self.assertEqual({"$set": {"team_name": "Super Power"}}, identify_obj.user_properties)
@@ -155,7 +165,32 @@ def callback_func(event, code, message=None):
                 self.client.flush()
                 post_method.assert_called_once()
 
-    def test_revenue(self):
+    def test_amplitude_set_group_success(self):
+        post_method = MagicMock()
+        HttpClient.post = post_method
+        res = Response(HttpStatus.SUCCESS)
+        post_method.return_value = res
+
+        def callback_func(event, code, message=None):
+            self.assertEqual(200, code)
+            self.assertTrue(isinstance(event, IdentifyEvent))
+            self.assertTrue("user_properties" in event)
+            self.assertEqual("$identify", event["event_type"])
+            self.assertEqual("test_user_id", event["user_id"])
+            self.assertEqual("test_device_id", event["device_id"])
+            self.assertEqual({"$set": {"type": ["test_group", "test_group_2"]}}, event.user_properties)
+
+        self.client.configuration.callback = callback_func
+        for use_batch in (True, False):
+            with self.subTest(use_batch=use_batch):
+                post_method.reset_mock()
+                self.client.configuration.use_batch = use_batch
+                self.client.set_group("type", ["test_group", "test_group_2"],
+                                      EventOptions(user_id="test_user_id", device_id="test_device_id"))
+                self.client.flush()
+                post_method.assert_called_once()
+
+    def test_amplitude_client_revenue_invalid_log_error_then_success(self):
         post_method = MagicMock()
         HttpClient.post = post_method
         res = Response(HttpStatus.SUCCESS)
@@ -169,7 +204,7 @@ def callback_func(event, code, message=None):
             self.assertEqual("test_user_id", event["user_id"])
             self.assertEqual("test_device_id", event["device_id"])
             self.assertEqual({'$price': 60.2, '$productId': 'P63', '$quantity': 3, '$receipt': 'A0001',
-                              '$receiptSig': '0001A', '$revenue': None, '$revenueType': None, 'other_property': 'test'},
+                              '$receiptSig': '0001A', 'other_property': 'test'},
                              event["event_properties"])
 
         self.client.configuration.callback = callback_func
@@ -179,14 +214,18 @@ def callback_func(event, code, message=None):
                 self.client.configuration.use_batch = use_batch
                 revenue_obj = Revenue(price="abc", quantity=3, product_id="P63", properties={"other_property": "test"})
                 self.assertFalse(revenue_obj.is_valid())
+                with self.assertLogs("test", "ERROR") as cm:
+                    self.client.configuration.logger = logging.getLogger("test")
+                    self.client.revenue(revenue_obj, EventOptions(user_id="test_user_id", device_id="test_device_id"))
+                    self.assertEqual(["ERROR:test:Invalid price for revenue event"], cm.output)
                 revenue_obj.price = 60.2
                 self.assertTrue(revenue_obj.is_valid())
                 revenue_obj.set_receipt("A0001", "0001A")
                 self.client.revenue(revenue_obj, EventOptions(user_id="test_user_id", device_id="test_device_id"))
                 self.client.flush()
                 post_method.assert_called_once()
 
-    def test_flush(self):
+    def test_amplitude_client_flush_success(self):
         post_method = MagicMock()
         HttpClient.post = post_method
         res = Response(HttpStatus.SUCCESS)
@@ -210,7 +249,7 @@ def callback_func(event, code, message=None):
                 self.client.flush()
                 post_method.assert_called_once()
 
-    def test_add_remove(self):
+    def test_amplitude_add_remove_plugins_success(self):
         timeline = self.client._Amplitude__timeline
         before_plugin = EventPlugin(PluginType.BEFORE)
         enrich_plugin = EventPlugin(plugin_type=PluginType.ENRICHMENT)