Merge pull request #378 from splitio/iff-e2e-tests

Added e2e tests

Author: chillaq

splitio/push/parser.py

@@ -419,7 +419,7 @@ def default_treatment(self):
     def __str__(self):
         """Return string representation."""
         return "SplitKill - changeNumber=%d, name=%s, defaultTreatment=%s" % \
-            (self.change_number, self.feature_flag, self.default_treatment)
+            (self.change_number, self.feature_flag_name, self.default_treatment)
 
 
 class SegmentChangeUpdate(BaseUpdate):

splitio/push/splitworker.py

@@ -8,6 +8,7 @@
 from enum import Enum
 
 from splitio.models.splits import from_raw
+from splitio.push.parser import UpdateType
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -63,16 +64,17 @@ def _run(self):
                 continue
             _LOGGER.debug('Processing feature flag update %d', event.change_number)
             try:
-                if event.compression is not None and event.previous_change_number == self._feature_flag_storage.get_change_number():
-                    try:
-                        self._feature_flag_storage.put(from_raw(json.loads(self._get_feature_flag_definition(event))))
-                        self._feature_flag_storage.set_change_number(event.change_number)
-                        continue
-                    except Exception as e:
-                        _LOGGER.error('Exception raised in updating feature flag')
-                        _LOGGER.debug(str(e))
-                        _LOGGER.debug('Exception information: ', exc_info=True)
-                        pass
+                if event.update_type == UpdateType.SPLIT_UPDATE:
+                    if event.compression is not None and event.previous_change_number == self._feature_flag_storage.get_change_number():
+                        try:
+                            self._feature_flag_storage.put(from_raw(json.loads(self._get_feature_flag_definition(event))))
+                            self._feature_flag_storage.set_change_number(event.change_number)
+                            continue
+                        except Exception as e:
+                            _LOGGER.error('Exception raised in updating feature flag')
+                            _LOGGER.debug(str(e))
+                            _LOGGER.debug('Exception information: ', exc_info=True)
+                            pass
                 self._handler(event.change_number)
             except Exception as e:  # pylint: disable=broad-except
                 _LOGGER.error('Exception raised in feature flag synchronization')

tests/client/test_localhost.py

@@ -72,7 +72,7 @@ def test_make_whitelist_condition(self):
     def test_parse_legacy_file(self):
         """Test that aprsing a legacy file works."""
         filename = os.path.join(os.path.dirname(__file__), 'files', 'file1.split')
-        splits = LocalSplitSynchronizer._read_splits_from_legacy_file(filename)
+        splits = LocalSplitSynchronizer._read_feature_flags_from_legacy_file(filename)
         assert len(splits) == 2
         for split in splits.values():
             assert isinstance(split, Split)
@@ -84,7 +84,7 @@ def test_parse_legacy_file(self):
     def test_parse_yaml_file(self):
         """Test that parsing a yaml file works."""
         filename = os.path.join(os.path.dirname(__file__), 'files', 'file2.yaml')
-        splits = LocalSplitSynchronizer._read_splits_from_yaml_file(filename)
+        splits = LocalSplitSynchronizer._read_feature_flags_from_yaml_file(filename)
         assert len(splits) == 4
         for split in splits.values():
             assert isinstance(split, Split)
@@ -116,44 +116,44 @@ def test_update_splits(self, mocker):
         parse_legacy.reset_mock()
         parse_yaml.reset_mock()
         sync = LocalSplitSynchronizer('something', storage_mock)
-        sync._read_splits_from_legacy_file = parse_legacy
-        sync._read_splits_from_yaml_file = parse_yaml
+        sync._read_feature_flags_from_legacy_file = parse_legacy
+        sync._read_feature_flags_from_yaml_file = parse_yaml
         sync.synchronize_splits()
         assert parse_legacy.mock_calls == [mocker.call('something')]
         assert parse_yaml.mock_calls == []
 
         parse_legacy.reset_mock()
         parse_yaml.reset_mock()
         sync = LocalSplitSynchronizer('something.yaml', storage_mock)
-        sync._read_splits_from_legacy_file = parse_legacy
-        sync._read_splits_from_yaml_file = parse_yaml
+        sync._read_feature_flags_from_legacy_file = parse_legacy
+        sync._read_feature_flags_from_yaml_file = parse_yaml
         sync.synchronize_splits()
         assert parse_legacy.mock_calls == []
         assert parse_yaml.mock_calls == [mocker.call('something.yaml')]
 
         parse_legacy.reset_mock()
         parse_yaml.reset_mock()
         sync = LocalSplitSynchronizer('something.yml', storage_mock)
-        sync._read_splits_from_legacy_file = parse_legacy
-        sync._read_splits_from_yaml_file = parse_yaml
+        sync._read_feature_flags_from_legacy_file = parse_legacy
+        sync._read_feature_flags_from_yaml_file = parse_yaml
         sync.synchronize_splits()
         assert parse_legacy.mock_calls == []
         assert parse_yaml.mock_calls == [mocker.call('something.yml')]
 
         parse_legacy.reset_mock()
         parse_yaml.reset_mock()
         sync = LocalSplitSynchronizer('something.YAML', storage_mock)
-        sync._read_splits_from_legacy_file = parse_legacy
-        sync._read_splits_from_yaml_file = parse_yaml
+        sync._read_feature_flags_from_legacy_file = parse_legacy
+        sync._read_feature_flags_from_yaml_file = parse_yaml
         sync.synchronize_splits()
         assert parse_legacy.mock_calls == []
         assert parse_yaml.mock_calls == [mocker.call('something.YAML')]
 
         parse_legacy.reset_mock()
         parse_yaml.reset_mock()
         sync = LocalSplitSynchronizer('yaml', storage_mock)
-        sync._read_splits_from_legacy_file = parse_legacy
-        sync._read_splits_from_yaml_file = parse_yaml
+        sync._read_feature_flags_from_legacy_file = parse_legacy
+        sync._read_feature_flags_from_yaml_file = parse_yaml
         sync.synchronize_splits()
         assert parse_legacy.mock_calls == [mocker.call('yaml')]
         assert parse_yaml.mock_calls == []

tests/integration/test_client_e2e.py

@@ -965,7 +965,7 @@ def test_localhost_json_e2e(self):
 
         # Tests 1
         self.factory._storages['splits'].remove('SPLIT_1')
-        self.factory._sync_manager._synchronizer._split_synchronizers._split_sync._split_storage.set_change_number(-1)
+        self.factory._sync_manager._synchronizer._split_synchronizers._feature_flag_sync._feature_flag_storage.set_change_number(-1)
         self._update_temp_file(splits_json['splitChange1_1'])
         self._synchronize_now()
 
@@ -989,7 +989,7 @@ def test_localhost_json_e2e(self):
 
         # Tests 3
         self.factory._storages['splits'].remove('SPLIT_1')
-        self.factory._sync_manager._synchronizer._split_synchronizers._split_sync._split_storage.set_change_number(-1)
+        self.factory._sync_manager._synchronizer._split_synchronizers._feature_flag_sync._feature_flag_storage.set_change_number(-1)
         self._update_temp_file(splits_json['splitChange3_1'])
         self._synchronize_now()
 
@@ -1004,7 +1004,7 @@ def test_localhost_json_e2e(self):
 
         # Tests 4
         self.factory._storages['splits'].remove('SPLIT_2')
-        self.factory._sync_manager._synchronizer._split_synchronizers._split_sync._split_storage.set_change_number(-1)
+        self.factory._sync_manager._synchronizer._split_synchronizers._feature_flag_sync._feature_flag_storage.set_change_number(-1)
         self._update_temp_file(splits_json['splitChange4_1'])
         self._synchronize_now()
 
@@ -1029,7 +1029,7 @@ def test_localhost_json_e2e(self):
         # Tests 5
         self.factory._storages['splits'].remove('SPLIT_1')
         self.factory._storages['splits'].remove('SPLIT_2')
-        self.factory._sync_manager._synchronizer._split_synchronizers._split_sync._split_storage.set_change_number(-1)
+        self.factory._sync_manager._synchronizer._split_synchronizers._feature_flag_sync._feature_flag_storage.set_change_number(-1)
         self._update_temp_file(splits_json['splitChange5_1'])
         self._synchronize_now()
 
@@ -1044,7 +1044,7 @@ def test_localhost_json_e2e(self):
 
         # Tests 6
         self.factory._storages['splits'].remove('SPLIT_2')
-        self.factory._sync_manager._synchronizer._split_synchronizers._split_sync._split_storage.set_change_number(-1)
+        self.factory._sync_manager._synchronizer._split_synchronizers._feature_flag_sync._feature_flag_storage.set_change_number(-1)
         self._update_temp_file(splits_json['splitChange6_1'])
         self._synchronize_now()
 
@@ -1073,8 +1073,8 @@ def _update_temp_file(self, json_body):
 
     def _synchronize_now(self):
         filename = os.path.join(os.path.dirname(__file__), 'files', 'split_changes_temp.json')
-        self.factory._sync_manager._synchronizer._split_synchronizers._split_sync._filename = filename
-        self.factory._sync_manager._synchronizer._split_synchronizers._split_sync.synchronize_splits()
+        self.factory._sync_manager._synchronizer._split_synchronizers._feature_flag_sync._filename = filename
+        self.factory._sync_manager._synchronizer._split_synchronizers._feature_flag_sync.synchronize_splits()
 
     def test_incorrect_file_e2e(self):
         """Test initialize factory with a incorrect file name."""

tests/integration/test_streaming_e2e.py

@@ -4,6 +4,9 @@
 import threading
 import time
 import json
+import base64
+import pytest
+
 from queue import Queue
 from splitio.client.factory import get_factory
 from tests.helpers.mockserver import SSEMockServer, SplitMockServer
@@ -106,6 +109,21 @@ def test_happiness(self):
         assert factory.client().get_treatment('pindon', 'split2') == 'off'
         assert factory.client().get_treatment('maldo', 'split2') == 'on'
 
+        # test if changeNumber is missing
+#        split_changes = make_split_fast_change_event(4)
+#        data = json.loads(split_changes['data'])
+#        inner_data = json.loads(data['data'])
+#        inner_data['changeNumber'] = None
+#        data['data'] = json.dumps(inner_data)
+#        split_changes['data'] = json.dumps(data)
+#        sse_server.publish(split_changes)
+#        time.sleep(1)
+#        assert factory.client().get_treatment('maldo', 'split1') == 'off'
+
+        sse_server.publish(make_split_fast_change_event(4))
+        time.sleep(1)
+        assert factory.client().get_treatment('maldo', 'split1') == 'on'
+
         # Validate the SSE request
         sse_request = sse_requests.get()
         assert sse_request.method == 'GET'
@@ -1233,6 +1251,32 @@ def make_split_change_event(change_number):
         })
     }
 
+def make_split_fast_change_event(change_number):
+    """Make a split change event."""
+    json1 = make_simple_split('split1', 1, True, False, 'off', 'user', True)
+    str1 = json.dumps(json1)
+    byt1 = bytes(str1, encoding='utf-8')
+    compressed = base64.b64encode(byt1)
+    final = compressed.decode('utf-8')
+
+    return {
+        'event': 'message',
+        'data': json.dumps({
+            'id':'TVUsxaabHs:0:0',
+            'clientId':'pri:MzM0ODI1MTkxMw==',
+            'timestamp': change_number-1,
+            'encoding':'json',
+            'channel':'MTYyMTcxOTQ4Mw==_MjA4MzczNDU1Mg==_splits',
+            'data': json.dumps({
+                'type': 'SPLIT_UPDATE',
+                'changeNumber': change_number,
+                'pcn': 3,
+                'c': 0,
+                'd': final
+            })
+        })
+    }
+
 def make_split_kill_event(name, default_treatment, change_number):
     """Make a split change event."""
     return {

tests/push/test_manager.py

@@ -137,7 +137,7 @@ def test_auth_apiexception(self, mocker):
     def test_split_change(self, mocker):
         """Test update-type messages are properly forwarded to the processor."""
         sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
-        update_message = SplitChangeUpdate('chan', 123, 456)
+        update_message = SplitChangeUpdate('chan', 123, 456, None, None, None)
         parse_event_mock = mocker.Mock(spec=parse_incoming_event)
         parse_event_mock.return_value = update_message
         mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)

tests/push/test_split_worker.py

@@ -118,4 +118,47 @@ def put(feature_flag):
         self._feature_flag = None
         q.put(SplitChangeUpdate('some', 'SPLIT_UPDATE', 123456790, 2345,  'H4sIAAkVZWQC/8WST0+DQBDFv0qzZ0ig/BF6a2xjGismUk2MaZopzOKmy9Isy0EbvrtDwbY2Xo233Tdv5se85cCMBs5FtvrYYwIlsglratTMYiKns+chcAgc24UwsF0Xczt2cm5z8Jw8DmPH9wPyqr5zKyTITb2XwpA4TJ5KWWVgRKXYxHWcX/QUkVi264W+68bjaGyxupdCJ4i9KPI9UgyYpibI9Ha1eJnT/J2QsnNxkDVaLEcOjTQrjWBKVIasFefky95BFZg05Zb2mrhh5I9vgsiL44BAIIuKTeiQVYqLotHHLyLOoT1quRjub4fztQuLxj89LpePzytClGCyd9R3umr21ErOcitUh2PTZHY29HN2+JGixMxUujNfvMB3+u2pY1AXySad3z3Mk46msACDp8W7jhly4uUpFt3qD33vDAx0gLpXkx+P1GusbdcE24M2F4uaywwVEWvxSa1Oa13Vjvn2RXradm0xCVuUVBJqNCBGV0DrX4OcLpeb+/lreh3jH8Uw/JQj3UhkxPgCCurdEnADAAA=', 1))
         time.sleep(0.1)
-        assert self._feature_flag.name == 'bilal_split'
+        assert self._feature_flag.name == 'bilal_split'
+
+    def test_edge_cases(self, mocker):
+        q = queue.Queue()
+        split_worker = SplitWorker(handler_sync, q, mocker.Mock())
+        global change_number_received
+        split_worker.start()
+
+        def get_change_number():
+            return 2345
+
+        def put(feature_flag):
+            self._feature_flag = feature_flag
+
+        split_worker._feature_flag_storage.get_change_number = get_change_number
+        split_worker._feature_flag_storage.put = put
+
+        # should Not call the handler
+        self._feature_flag = None
+        change_number_received = 0
+        q.put(SplitChangeUpdate('some', 'SPLIT_UPDATE', 123456, 2345, "/2X9I7+N8R/FcPmUd76zjH7X/w4AAP//90glTw==", 2))
+        time.sleep(0.1)
+        assert self._feature_flag == None
+
+        # should Not call the handler
+        self._feature_flag = None
+        change_number_received = 0
+        q.put(SplitChangeUpdate('some', 'SPLIT_UPDATE', 123456, 2345, "/2X9I7+N8R/FcPmUd76zjH7X/w4AAP//90glTw==", 4))
+        time.sleep(0.1)
+        assert self._feature_flag == None
+
+        # should Not call the handler
+        self._feature_flag = None
+        change_number_received = 0
+        q.put(SplitChangeUpdate('some', 'SPLIT_UPDATE', 123456, None,  'eJzEUtFq20AQ/JUwz2c4WZZr3ZupTQh1FKjcQinGrKU95cjpZE6nh9To34ssJ3FNX0sfd3Zm53b2TgietDbF9vXIGdUMha5lDwFTQiGOmTQlchLRPJlEEZeTVJZ6oimWZTpP5WyWQMCNyoOxZPft0ZoA8TZ5aW1TUDCNg4qk/AueM5dQkyiez6IonS6mAu0IzWWSxovFLBZoA4WuhcLy8/bh+xoCL8bagaXJtixQsqbOhq1nCjW7AIVGawgUz+Qqzrr6wB4qmi9m00/JIk7TZCpAtmqgpgJF47SpOn9+UQt16s9YaS71z9NHOYQFha9Pm83Tty0EagrFM/t733RHqIFZH4wb7LDMVh+Ecc4Lv+ZsuQiNH8hXF3hLv39XXNCHbJ+v7x/X2eDmuKLA74sPihVr47jMuRpWfxy1Kwo0GLQjmv1xpBFD3+96gSP5cLVouM7QQaA1vxhK9uKmd853bEZS9jsBSwe2UDDu7mJxd2Mo/muQy81m/2X9I7+N8R/FcPmUd76zjH7X/w4AAP//90glTw==', 2))
+        time.sleep(0.1)
+        assert self._feature_flag == None
+
+        # should Not call the handler
+        self._feature_flag = None
+        change_number_received = 0
+        q.put(SplitChangeUpdate('some', 'SPLIT_UPDATE', 123456, 2345, None, 1))
+        time.sleep(0.1)
+        assert self._feature_flag == None