Merge pull request #41 from sideshowdave7/feature/name_uuid_generation

Add name:uuid generation, add tests for it

11 files changed, 44 insertions, 28 deletions

diff --git a/eventmq/jobmanager.py b/eventmq/jobmanager.py
index 78a89e1..dbf930c 100644
--- a/eventmq/jobmanager.py
+++ b/eventmq/jobmanager.py
@@ -81,7 +81,8 @@ class JobManager(HeartbeatMixin, EMQPService):
 
         #: Define the name of this JobManager instance. Useful to know when
         #: referring to the logs.
-        self.name = conf.NAME or generate_device_name()
+        self.name = generate_device_name(conf.NAME)
+
         logger.info('Initializing JobManager {}...'.format(self.name))
 
         if not skip_signal:
@@ -96,7 +97,7 @@ class JobManager(HeartbeatMixin, EMQPService):
         #: then telling the router that it is READY. The reply will be the unit
         #: of work.
         # Despite the name, jobs are received on this socket
-        self.frontend = Sender(name=self.name)
+        self.frontend = Sender(name=conf.NAME)
 
         self.poller = Poller()
 
diff --git a/eventmq/publisher.py b/eventmq/publisher.py
index 0e8f9b3..7b5c1fb 100644
--- a/eventmq/publisher.py
+++ b/eventmq/publisher.py
@@ -29,14 +29,15 @@ logger = logging.getLogger(__name__)
 
 class Publisher(object):
     """
-        name (str): Name of this socket
+        name (str): Named prefix of this socket
         zcontext (:class:`zmq.Context`): socket context
         zsocket (:class:`zmq.Socket`):
     """
 
     def __init__(self, *args, **kwargs):
         self.zcontext = kwargs.get('context', zmq.Context.instance())
-        self.name = kwargs.get('name', generate_device_name())
+
+        self.name = generate_device_name(kwargs.pop('name', None))
 
         self.zsocket = kwargs.get('socket', self.zcontext.socket(zmq.PUB))
         self.zsocket.setsockopt(zmq.IDENTITY, self.name)
diff --git a/eventmq/router.py b/eventmq/router.py
index 2b27026..eceb080 100644
--- a/eventmq/router.py
+++ b/eventmq/router.py
@@ -64,7 +64,8 @@ class Router(HeartbeatMixin):
 
         super(Router, self).__init__(*args, **kwargs)  # Creates _meta
 
-        self.name = conf.NAME or generate_device_name()
+        self.name = generate_device_name(conf.NAME)
+
         logger.info('Initializing Router %s...' % self.name)
 
         self.poller = poller.Poller()
diff --git a/eventmq/scheduler.py b/eventmq/scheduler.py
index ea0fdc3..799ae20 100644
--- a/eventmq/scheduler.py
+++ b/eventmq/scheduler.py
@@ -74,8 +74,10 @@ class Scheduler(HeartbeatMixin, EMQPService):
         logger.info('Initializing Scheduler...')
 
         super(Scheduler, self).__init__(*args, **kwargs)
-        self.name = conf.NAME or generate_device_name()
-        self.frontend = Sender()
+
+        self.name = generate_device_name(conf.NAME)
+
+        self.frontend = Sender(conf.NAME)
         self._redis_server = None
 
         # contains dict of 4-item lists representing cron jobs key of this
diff --git a/eventmq/sender.py b/eventmq/sender.py
index f0cc09c..4396e7f 100644
--- a/eventmq/sender.py
+++ b/eventmq/sender.py
@@ -18,13 +18,12 @@
 The sender is responsible for sending messages
 """
 import logging
-import sys
-import uuid
 
 import zmq
 
 from . import constants, exceptions
 from .utils.classes import ZMQReceiveMixin, ZMQSendMixin
+from .utils.devices import generate_device_name
 
 logger = logging.getLogger(__name__)
 
@@ -61,7 +60,8 @@ class Sender(ZMQSendMixin, ZMQReceiveMixin):
         # rebuilding it later.
         self.zsocket = None
 
-        self.name = kwargs.pop('name', str(uuid.uuid4()))
+        # Immutable name that was specified at construction time
+        self.conf_name = kwargs.pop('name', None)
 
         self.rebuild(*args, **kwargs)
 
@@ -138,10 +138,8 @@ class Sender(ZMQSendMixin, ZMQReceiveMixin):
             self.zsocket.close()
 
         self.zsocket = kwargs.pop('socket', self.zcontext.socket(zmq.DEALER))
-        if sys.version[0] == '2':
-            self.zsocket.setsockopt(zmq.IDENTITY, self.name)
-        else:
-            self.zsocket.setsockopt_string(zmq.IDENTITY, str(self.name))
+        self.name = generate_device_name(self.conf_name)
+        self.zsocket.setsockopt(zmq.IDENTITY, self.name)
 
         self.status = constants.STATUS.ready
 
diff --git a/eventmq/settings.py b/eventmq/settings.py
index 18ec306..a25e953 100644
--- a/eventmq/settings.py
+++ b/eventmq/settings.py
@@ -132,8 +132,8 @@ _CONFIG_DEFS = {
             'long-arg': '--name',
             'short-arg': '-n',
             'type': str,
-            'help': "A unique ame to give this node. If one isn't provided a "
-                    "random uuid will be generated",
+            'help': "A unique name to give this node. If one isn't provided a "
+                    "random uuid will be generated in its place",
         },
     },
     'router': {
diff --git a/eventmq/tests/test_jobmanager.py b/eventmq/tests/test_jobmanager.py
index 4da2a6e..a19dfd7 100644
--- a/eventmq/tests/test_jobmanager.py
+++ b/eventmq/tests/test_jobmanager.py
@@ -23,20 +23,26 @@ ADDR = 'inproc://pour_the_rice_in_the_thing'
 
 
 class TestCase(unittest.TestCase):
-    def test__setup(self):
+    @mock.patch('uuid.uuid4')
+    def test__setup(self, name_mock):
+        name_mock.return_value = 'some_uuid'
         override_settings = {
             'NAME': 'RuckusBringer'
         }
         jm = jobmanager.JobManager(override_settings=override_settings)
-        self.assertEqual(jm.name, 'RuckusBringer')
+        self.assertEqual(jm.name.decode('ascii'), 'RuckusBringer:some_uuid')
 
         self.assertFalse(jm.awaiting_startup_ack)
         self.assertEqual(jm.status, constants.STATUS.ready)
 
 # EMQP Tests
-    def test_reset(self):
+    @mock.patch('uuid.uuid4')
+    def test_reset(self, name_mock):
+        name_mock.return_value = 'some_uuid'
         jm = jobmanager.JobManager()
 
+        self.assertEqual(jm.name.decode('ascii'), 'some_uuid')
+
         self.assertFalse(jm.awaiting_startup_ack)
         self.assertEqual(jm.status, constants.STATUS.ready)
 
diff --git a/eventmq/tests/test_scheduler.py b/eventmq/tests/test_scheduler.py
index ab0b51f..dc96b09 100644
--- a/eventmq/tests/test_scheduler.py
+++ b/eventmq/tests/test_scheduler.py
@@ -16,16 +16,20 @@
 import json
 import unittest
 
+import mock
+
 from .. import constants, scheduler
 
 
 class TestCase(unittest.TestCase):
-    def test__setup(self):
+    @mock.patch('uuid.uuid4')
+    def test__setup(self, name_mock):
+        name_mock.return_value = 'some_uuid'
         override_settings = {
             'NAME': 'RuckasBringer'
         }
         sched = scheduler.Scheduler(override_settings=override_settings)
-        self.assertEqual(sched.name, 'RuckasBringer')
+        self.assertEqual(sched.name.decode('ascii'), 'RuckasBringer:some_uuid')
 
         self.assertFalse(sched.awaiting_startup_ack)
         self.assertEqual(sched.status, constants.STATUS.ready)
diff --git a/eventmq/tests/test_sender.py b/eventmq/tests/test_sender.py
index f292696..f1a9984 100644
--- a/eventmq/tests/test_sender.py
+++ b/eventmq/tests/test_sender.py
@@ -35,7 +35,8 @@ class TestCase(unittest.TestCase):
 
         self.assert_(socket.poll() != 0)
         msg = socket.recv_multipart()
-        self.assertEqual(msg[0].decode('ascii'), self.sender.name)
+        self.assertEqual(msg[0].decode('ascii'),
+                         self.sender.name.decode('ascii'))
         self.assertEqual(msg[1], b'')
         self.assertEqual(msg[2], b'1')
         self.assertEqual(msg[3], b'Hello!')
diff --git a/eventmq/tests/test_utils.py b/eventmq/tests/test_utils.py
index 96d8c0f..45eba50 100644
--- a/eventmq/tests/test_utils.py
+++ b/eventmq/tests/test_utils.py
@@ -142,7 +142,7 @@ class TestCase(unittest.TestCase):
 
     def test_emqDeque(self):
 
-        full = random.randint(1, 100)
+        full = random.randint(2, 100)
         pfull = random.randint(1, full-1)
 
         q = classes.EMQdeque(full=full,
diff --git a/eventmq/utils/devices.py b/eventmq/utils/devices.py
index db7a655..7fbb028 100644
--- a/eventmq/utils/devices.py
+++ b/eventmq/utils/devices.py
@@ -26,11 +26,13 @@ def generate_device_name(prefix=None):
     Args:
         prefix (str): Prefix the id with this string.
 
-    Returns (str) An ascii encoded string that can be used as an IDENTITY for a
-        ZMQ socket.
+    Returns (str/bytes) An ascii encoded string that can be used as an IDENTITY
+        for a ZMQ socket.  In python3 this returns a `bytes`, python2 a 'str
     """
     import uuid
-    ret = str(uuid.uuid4()).encode('ascii')
+    ret = str(uuid.uuid4())
+
     if prefix:
-        ret = prefix + ret
-    return ret
+        ret = "{}:{}".format(prefix, ret)
+
+    return ret.encode('ascii')