Topic subscriber models

brewtils/models.py

@@ -37,6 +37,8 @@
     "Garden",
     "Operation",
     "Resolvable",
+    "TopicSubscribers",
+    "Subscriber",
 ]
 
 
@@ -1649,3 +1651,60 @@ def __repr__(self):
             self.storage,
             self.details,
         )
+
+
+class TopicSubscribers:
+    schema = "TopicSubscribersSchema"
+
+    def __init__(self, topic=None, subscribers=[]):
+        self.topic = topic
+        self.subscribers = subscribers
+
+    def __str__(self):
+        return "%s: %s" % (self.topic, [str(s) for s in self.subscribers])
+
+    def __repr__(self):
+        return "<Topic Subscribers: topic=%s, subscribers=%s>" % (
+            self.topic,
+            self.subscribers,
+        )
+
+
+class Subscriber:
+    schema = "SubscriberSchema"
+
+    def __init__(
+        self,
+        garden=None,
+        namespace=None,
+        system=None,
+        version=None,
+        instance=None,
+        command=None,
+    ):
+        self.garden = garden
+        self.namespace = namespace
+        self.system = system
+        self.version = version
+        self.instance = instance
+        self.command = command
+
+    def __str__(self):
+        return (
+            f"{self.garden}.{self.namespace}.{self.system}.{self.version}.{self.instance}."
+            f"{self.command}"
+        )
+
+    def __repr__(self):
+        return (
+            "<Subscriber: garden=%s, namespace=%s, system=%s, version=%s, instance=%s, "
+            "command=%s>"
+            % (
+                self.garden,
+                self.namespace,
+                self.system,
+                self.version,
+                self.instance,
+                self.command,
+            )
+        )

brewtils/schema_parser.py

@@ -50,6 +50,8 @@ class SchemaParser(object):
         "OperationSchema": brewtils.models.Operation,
         "RunnerSchema": brewtils.models.Runner,
         "ResolvableSchema": brewtils.models.Resolvable,
+        "SubscriberSchema": brewtils.models.Subscriber,
+        "TopicSubscribersSchema": brewtils.models.TopicSubscribers,
     }
 
     logger = logging.getLogger(__name__)

brewtils/schemas.py

@@ -46,6 +46,8 @@
     "RoleAssignmentDomainSchema",
     "GardenDomainIdentifierSchema",
     "SystemDomainIdentifierSchema",
+    "TopicSubscribersSchema",
+    "SubscriberSchema",
 ]
 
 # This will be updated after all the schema classes are defined
@@ -624,6 +626,20 @@ class RoleAssignmentSchema(BaseSchema):
     role = fields.Nested(RoleSchema())
 
 
+class SubscriberSchema(BaseSchema):
+    garden = fields.Str(allow_none=True)
+    namespace = fields.Str(allow_none=True)
+    system = fields.Str(allow_none=True)
+    version = fields.Str(allow_none=True)
+    instance = fields.Str(allow_none=True)
+    command = fields.Str(allow_none=True)
+
+
+class TopicSubscribersSchema(BaseSchema):
+    topic = fields.Str(allow_none=True)
+    subscribers = fields.List(fields.Nested(SubscriberSchema, allow_none=True))
+
+
 class UserSchema(BaseSchema):
     id = fields.Str()
     username = fields.Str()
@@ -671,6 +687,8 @@ class UserListSchema(BaseSchema):
         "Operation": OperationSchema,
         "Runner": RunnerSchema,
         "Resolvable": ResolvableSchema,
+        "Subscriber": SubscriberSchema,
+        "TopicSubscribers": TopicSubscribersSchema,
         # Compatibility for the Job trigger types
         "interval": IntervalTriggerSchema,
         "date": DateTriggerSchema,

brewtils/test/fixtures.py

@@ -30,6 +30,8 @@
     Resolvable,
     Runner,
     System,
+    Subscriber,
+    TopicSubscribers,
 )
 
 
@@ -903,3 +905,22 @@ def resolvable_chunk_dict():
 @pytest.fixture
 def bg_resolvable_chunk(resolvable_chunk_dict):
     return Resolvable(**resolvable_chunk_dict)
+
+
+@pytest.fixture
+def subscriber_dict():
+    """Subscribers as a dictionary."""
+    return {
+        "garden": "garden",
+        "namespace": "ns",
+        "system": "system",
+        "version": "1.0.0",
+        "instance": None,
+        "command": None,
+    }
+
+
+@pytest.fixture
+def topic_subscriber_dict(subscriber_dict):
+    """Topic subscribers as dict"""
+    return {"topic": "foo", "subscribers": [subscriber_dict]}

test/models_test.py

@@ -19,6 +19,8 @@
     RequestFile,
     RequestTemplate,
     LegacyRole,
+    Subscriber,
+    TopicSubscribers,
 )
 from pytest_lazyfixture import lazy_fixture
 
@@ -675,3 +677,34 @@ def test_repr(self, bg_resolvable):
             bg_resolvable.storage,
             bg_resolvable.details,
         )
+
+
+@pytest.fixture
+def subscriber1():
+    return Subscriber(
+        garden="g", namespace="n", system="s", version="v", instance="i", command="c"
+    )
+
+
+@pytest.fixture
+def topic_subscribers1(subscriber1):
+    return TopicSubscribers(topic="foo.*", subscribers=[subscriber1])
+
+
+class TestSubscriber(object):
+    def test_str(self, subscriber1):
+        assert "g.n.s.v.i.c" == str(subscriber1)
+
+    def test_repr(self, subscriber1):
+        assert "g" in repr(subscriber1)
+        assert "n" in repr(subscriber1)
+        assert "s" in repr(subscriber1)
+        assert "v" in repr(subscriber1)
+        assert "i" in repr(subscriber1)
+        assert "c" in repr(subscriber1)
+
+
+class TestTopicSubscribers:
+    def test_str(self, topic_subscribers1, subscriber1):
+        print(str(topic_subscribers1))
+        assert str(topic_subscribers1) == "foo.*: ['g.n.s.v.i.c']"