Require config.uuid when creating PubNub instance (#110)

Author: seba-aln

.pubnub.yml

@@ -1,5 +1,5 @@
 name: python
-version: 5.5.0
+version: 6.0.0
 schema: 1
 scm: github.com/pubnub/python
 sdks:
@@ -18,7 +18,7 @@ sdks:
         distributions:
           - distribution-type: library
             distribution-repository: package
-            package-name: pubnub-5.5.0
+            package-name: pubnub-6.0.0
             location: https://pypi.org/project/pubnub/
             supported-platforms:
               supported-operating-systems:
@@ -97,8 +97,8 @@ sdks:
           -
             distribution-type: library
             distribution-repository: git release
-            package-name: pubnub-5.5.0
-            location: https://github.com/pubnub/python/releases/download/v5.5.0/pubnub-5.5.0.tar.gz
+            package-name: pubnub-6.0.0
+            location: https://github.com/pubnub/python/releases/download/v6.0.0/pubnub-6.0.0.tar.gz
             supported-platforms:
               supported-operating-systems:
                 Linux:
@@ -169,6 +169,11 @@ sdks:
                 license-url: https://github.com/aio-libs/aiohttp/blob/master/LICENSE.txt
                 is-required: Required
 changelog:
+  - date: 2022-01-13
+    version: v6.0.0
+    changes:
+      - type: improvement
+        text: "BREAKING CHANGES: uuid is required parameter while creating an instance of PubNub."
   - date: 2021-12-16
     version: v5.5.0
     changes:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v6.0.0
+January 13 2022
+
+#### Modified
+- BREAKING CHANGES: uuid is required parameter while creating an instance of PubNub.
+
 ## v5.5.0
 December 16 2021
 

pubnub/pnconfiguration.py

@@ -1,5 +1,4 @@
 from .enums import PNHeartbeatNotificationOptions, PNReconnectionPolicy
-from . import utils
 
 
 class PNConfiguration(object):
@@ -8,7 +7,7 @@ class PNConfiguration(object):
 
     def __init__(self):
         # TODO: add validation
-        self.uuid = None
+        self._uuid = None
         self.origin = "ps.pndsn.com"
         self.ssl = True
         self.non_subscribe_request_timeout = 10
@@ -36,10 +35,10 @@ def __init__(self):
         self._heartbeat_interval = PNConfiguration.DEFAULT_HEARTBEAT_INTERVAL
 
     def validate(self):
-        assert self.uuid is None or isinstance(self.uuid, str)
+        PNConfiguration.validate_not_empty_string(self.uuid)
 
-        if not self.uuid:
-            self.uuid = utils.uuid()
+    def validate_not_empty_string(value: str):
+        assert value and isinstance(value, str) and value.strip() != "", "UUID missing or invalid type"
 
     def scheme(self):
         if self.ssl:
@@ -97,3 +96,12 @@ def heartbeat_interval(self):
 
         # TODO: set log level
         # TODO: set log level
+
+    @property
+    def uuid(self):
+        return self._uuid
+
+    @uuid.setter
+    def uuid(self, uuid):
+        PNConfiguration.validate_not_empty_string(uuid)
+        self._uuid = uuid

pubnub/pubnub_core.py

@@ -65,7 +65,7 @@
 
 class PubNubCore:
     """A base class for PubNub Python API implementations"""
-    SDK_VERSION = "5.5.0"
+    SDK_VERSION = "6.0.0"
     SDK_NAME = "PubNub-Python"
 
     TIMESTAMP_DIVIDER = 1000

requirements-dev.txt

@@ -3,7 +3,7 @@ pytest-cov
 pycryptodomex
 flake8
 pytest
-pytest-asyncio
+pytest-asyncio==0.16.0
 aiohttp
 requests
 cbor2

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='pubnub',
-    version='5.5.0',
+    version='6.0.0',
     description='PubNub Real-time push service in the cloud',
     author='PubNub',
     author_email='[email protected]',

tests/functional/test_fire.py

@@ -1,12 +1,12 @@
 from pubnub.pubnub import PubNub
-from pubnub.pnconfiguration import PNConfiguration
 from pubnub.endpoints.pubsub.fire import Fire
-from tests.helper import url_encode
+from tests.helper import url_encode, pnconf_copy
 import json
 
+pnconf = pnconf_copy()
 
-SUB_KEY = 'sub'
-PUB_KEY = 'pub'
+SUB_KEY = pnconf.subscribe_key
+PUB_KEY = pnconf.publish_key
 CHAN = 'chan'
 MSG = 'x'
 MSG_ENCODED = url_encode(MSG)
@@ -15,11 +15,8 @@
 
 
 def test_fire():
-    config = PNConfiguration()
-    config.subscribe_key = SUB_KEY
-    config.publish_key = PUB_KEY
-    config.auth_key = AUTH
-    fire = PubNub(config).fire()
+    pnconf.auth_key = AUTH
+    fire = PubNub(pnconf).fire()
 
     fire.channel(CHAN).message(MSG)
     assert fire.build_path() == Fire.FIRE_GET_PATH % (PUB_KEY, SUB_KEY, CHAN, 0, MSG_ENCODED)

tests/functional/test_message_count.py

@@ -1,19 +1,16 @@
 import pytest
 
 from pubnub.pubnub import PubNub
-from pubnub.pnconfiguration import PNConfiguration
 from pubnub.endpoints.message_count import MessageCount
 from pubnub.exceptions import PubNubException
+from tests.helper import pnconf
 
-
-SUB_KEY = 'bla'
+SUB_KEY = pnconf.subscribe_key
 
 
 @pytest.fixture
 def mc():
-    config = PNConfiguration()
-    config.subscribe_key = SUB_KEY
-    return PubNub(config).message_counts()
+    return PubNub(pnconf).message_counts()
 
 
 def test_single_channel(mc):

tests/functional/test_signal.py

@@ -1,26 +1,23 @@
 import pytest
 
 from pubnub.pubnub import PubNub
-from pubnub.pnconfiguration import PNConfiguration
 from pubnub.exceptions import PubNubException
 from pubnub.endpoints.signal import Signal
-from tests.helper import url_encode
+from tests.helper import url_encode, pnconf_copy
 
-
-SUB_KEY = 'sub'
-PUB_KEY = 'pub'
+pnconf = pnconf_copy()
+SUB_KEY = pnconf.subscribe_key
+PUB_KEY = pnconf.publish_key
 CHAN = 'chan'
 MSG = 'x'
 MSG_ENCODED = url_encode(MSG)
 AUTH = 'auth'
+UUID = 'uuid'
 
 
 def test_signal():
-    config = PNConfiguration()
-    config.subscribe_key = SUB_KEY
-    config.publish_key = PUB_KEY
-    config.auth_key = AUTH
-    signal = PubNub(config).signal()
+    pnconf.auth_key = AUTH
+    signal = PubNub(pnconf).signal()
 
     with pytest.raises(PubNubException):
         signal.validate_params()

tests/helper.py

@@ -40,6 +40,7 @@
 
 pub_key_mock = "pub-c-mock-key"
 sub_key_mock = "sub-c-mock-key"
+uuid_mock = "uuid-mock"
 
 pub_key_pam = "pub-c-98863562-19a6-4760-bf0b-d537d1f5c582"
 sub_key_pam = "sub-c-7ba2ac4c-4836-11e6-85a4-0619f8945a4f"
@@ -49,55 +50,66 @@
 pnconf.publish_key = pub_key
 pnconf.subscribe_key = sub_key
 pnconf.enable_subscribe = False
+pnconf.uuid = uuid_mock
 
 pnconf_sub = PNConfiguration()
 pnconf_sub.publish_key = pub_key
 pnconf_sub.subscribe_key = sub_key
+pnconf_sub.uuid = uuid_mock
 
 pnconf_enc = PNConfiguration()
 pnconf_enc.publish_key = pub_key
 pnconf_enc.subscribe_key = sub_key
 pnconf_enc.cipher_key = "testKey"
 pnconf_enc.enable_subscribe = False
+pnconf_enc.uuid = uuid_mock
 
 pnconf_enc_sub = PNConfiguration()
 pnconf_enc_sub.publish_key = pub_key
 pnconf_enc_sub.subscribe_key = sub_key
 pnconf_enc_sub.cipher_key = "testKey"
+pnconf_enc_sub.uuid = uuid_mock
 
 pnconf_pam = PNConfiguration()
 pnconf_pam.publish_key = pub_key_pam
 pnconf_pam.subscribe_key = sub_key_pam
 pnconf_pam.secret_key = sec_key_pam
 pnconf_pam.enable_subscribe = False
+pnconf_pam.uuid = uuid_mock
 
 
 pnconf_pam_stub = PNConfiguration()
 pnconf_pam_stub.publish_key = "pub-stub"
 pnconf_pam_stub.subscribe_key = "sub-c-stub"
 pnconf_pam_stub.secret_key = "sec-c-stub"
+pnconf_pam_stub.uuid = uuid_mock
 
 pnconf_ssl = PNConfiguration()
 pnconf_ssl.publish_key = pub_key
 pnconf_ssl.subscribe_key = sub_key
 pnconf_ssl.ssl = True
+pnconf_ssl.uuid = uuid_mock
 
 message_count_config = PNConfiguration()
 message_count_config.publish_key = 'demo-36'
 message_count_config.subscribe_key = 'demo-36'
 message_count_config.origin = 'balancer1g.bronze.aws-pdx-1.ps.pn'
+message_count_config.uuid = uuid_mock
 
-objects_config = PNConfiguration()
-objects_config.publish_key = 'demo'
-objects_config.subscribe_key = 'demo'
+pnconf_demo = PNConfiguration()
+pnconf_demo.publish_key = 'demo'
+pnconf_demo.subscribe_key = 'demo'
+pnconf_demo.uuid = uuid_mock
 
 file_upload_config = PNConfiguration()
 file_upload_config.publish_key = pub_key_mock
 file_upload_config.subscribe_key = sub_key_mock
+file_upload_config.uuid = uuid_mock
 
 mocked_config = PNConfiguration()
 mocked_config.publish_key = pub_key_mock
 mocked_config.subscribe_key = sub_key_mock
+mocked_config.uuid = uuid_mock
 
 hardcoded_iv_config = PNConfiguration()
 hardcoded_iv_config.use_random_initialization_vector = False
@@ -154,8 +166,8 @@ def pnconf_mc_copy():
     return copy(message_count_config)
 
 
-def pnconf_obj_copy():
-    return copy(objects_config)
+def pnconf_demo_copy():
+    return copy(pnconf_demo)
 
 
 sdk_name = "Python-UnitTest"