Merge pull request #60 from ns1/feature/ddi-tagging-PLAT-803

PLAT-803/ Feature/ddi tagging

Author: Zach-Johnson

ns1/__init__.py

@@ -449,7 +449,14 @@ def loadScopeGroup(self, id, callback=None, errback=None):
         return scope_group.load(callback=callback, errback=errback)
 
     def createScopeGroup(
-        self, name, service_def_id, dhcp4, dhcp6, callback=None, errback=None
+        self,
+        name,
+        service_def_id,
+        dhcp4,
+        dhcp6,
+        callback=None,
+        errback=None,
+        **kwargs
     ):
         """
         Create a new Scope Group
@@ -467,7 +474,11 @@ def createScopeGroup(
         )
 
         return scope_group.create(
-            dhcp4=dhcp4, dhcp6=dhcp6, callback=callback, errback=errback
+            dhcp4=dhcp4,
+            dhcp6=dhcp6,
+            callback=callback,
+            errback=errback,
+            **kwargs
         )
 
     def createReservation(
@@ -478,14 +489,24 @@ def createReservation(
         dhcp_options=None,
         callback=None,
         errback=None,
+        **kwargs
     ):
+        """
+        Create a new Reservation
+        For the list of keywords available, see :attr:`ns1.rest.ipam.Reservation.INT_FIELDS` and :attr:`ns1.rest.ipam.Reservation.PASSTHRU_FIELDS`
+
+        :param int scopegroup_id: id of the scope group
+        :param int address_id: id of the address the reservation is associated with
+        :param str mac: mac address of the reservation
+        :param list options: dhcp options of the reservation
+        """
         import ns1.ipam
 
         reservation = ns1.ipam.Reservation(
             self.config, scopegroup_id, address_id, dhcp_options, mac
         )
 
-        return reservation.create(callback=callback, errback=errback)
+        return reservation.create(callback=callback, errback=errback, **kwargs)
 
     def loadReservation(
         self, scopegroup_id, address_id, callback=None, errback=None
@@ -505,14 +526,23 @@ def createScope(
         dhcp_options=None,
         callback=None,
         errback=None,
+        **kwargs
     ):
+        """
+        Create a new Scope
+        For the list of keywords available, see :attr:`ns1.rest.ipam.Scope.INT_FIELDS` and :attr:`ns1.rest.ipam.Scope.PASSTHRU_FIELDS`
+
+        :param int scopegroup_id: id of the scope group
+        :param int address_id: id of the address the scope is associated with
+        :param DHCPOptions options: DHCPOptions object that contains the settings for the scope
+        """
         import ns1.ipam
 
         scope = ns1.ipam.Scope(
             self.config, scopegroup_id, address_id, dhcp_options
         )
 
-        return scope.create(callback=callback, errback=errback)
+        return scope.create(callback=callback, errback=errback, **kwargs)
 
     def loadScope(
         self, scopegroup_id, address_id, callback=None, errback=None

ns1/ipam.py

@@ -46,19 +46,21 @@ class OptiondefException(Exception):
 
 
 class Network(object):
-    def __init__(self, config, name=None, id=None):
+    def __init__(self, config, name=None, id=None, tags=None):
         """
         Create a new high level Network object
 
         :param ns1.config.Config config: config object
         :param str name: network name
         :param int id: id of an existing Network
+        :param dict tags: tags of the network
         """
         self._rest = Networks(config)
         self.config = config
         self.name = name
         self.id = id
         self.report = {}
+        self.tags = tags
         self.data = None
 
     def __repr__(self):
@@ -88,6 +90,9 @@ def success(result, *args):
             self.name = result["name"]
             self.report = self._rest.report(self.id)
 
+            if "tags" in result:
+                self.tags = result["tags"]
+
             if callback:
                 return callback(self)
             else:
@@ -186,6 +191,7 @@ def __init__(
         network=None,
         scope_group=None,
         id=None,
+        tags=None,
     ):
         """
         Create a new high level Address object
@@ -195,6 +201,7 @@ def __init__(
         :param str status: planned, assigned
         :param Network network: Network Object the address will be part of
         :param Scopegroup scope_group: Scopegroup Object that will be associated with the address
+        :param dict tags: tags of the address
         """
         self._rest = Addresses(config)
         self.config = config
@@ -206,6 +213,7 @@ def __init__(
         self.children = []
         self.report = {}
         self.data = None
+        self.tags = tags
 
     def __repr__(self):
         return "<Address address=%s>" % self.prefix
@@ -237,6 +245,10 @@ def success(result, *args):
             # self.scope_group = Scopegroup(config=self.config, id=result['scope_group_id']) NYI
             self.report = self._rest.report(self.id)
             children = self._rest.retrieve_children(self.id)
+
+            if "tags" in result:
+                self.tags = result["tags"]
+
             self.children = [
                 Address(self.config, id=child["id"])
                 for child in children
@@ -390,14 +402,17 @@ def success(result, *args):
 
 
 class Scopegroup(object):
-    def __init__(self, config, name=None, service_def_id=None, id=None):
+    def __init__(
+        self, config, name=None, service_def_id=None, id=None, tags=None
+    ):
         """
         Create a new high level Scopegroup object
 
         :param ns1.config.Config config: config object
         :param str name: Name of the scope group
         :param int service_group_id: id of the service group the scope group is associated with
         :param int id: id of the scope group
+        :param dict tags: tags of the scopegroup
         """
         self._rest = Scopegroups(config)
         self.config = config
@@ -407,6 +422,7 @@ def __init__(self, config, name=None, service_def_id=None, id=None):
         self.name = name
         self.dhcp_service_id = service_def_id
         self.data = None
+        self.tags = tags
 
     def __repr__(self):
         return "<Scopegroup scope_group=%s>" % self.name
@@ -436,6 +452,9 @@ def success(result, *args):
             self.dhcp6 = result["dhcpv6"]
             self.dhcp_service_id = result.get("dhcp_service_id")
 
+            if "tags" in result:
+                self.tags = result["tags"]
+
             if callback:
                 return callback(self)
             else:
@@ -480,7 +499,7 @@ def success(result, *args):
             self.id, callback=success, errback=errback, **kwargs
         )
 
-    def create(self, dhcp4, dhcp6, callback=None, errback=None):
+    def create(self, dhcp4, dhcp6, callback=None, errback=None, **kwargs):
         """
         :param DHCPOptions dhcp4: DHCPOptions object that contains the settings for dhcp4
         :param DHCPOptions dhcp6: DHCPOptions object that contains the settings for dhcp6
@@ -518,6 +537,7 @@ def success(result, *args):
             dhcp_service_id=self.dhcp_service_id,
             callback=success,
             errback=errback,
+            **kwargs
         )
 
     def reserve(
@@ -582,6 +602,7 @@ def __init__(
         reservation_id=None,
         options=None,
         mac=None,
+        tags=None,
     ):
         """
         Create a new high level Reservation object
@@ -592,6 +613,7 @@ def __init__(
         :param int reservation_id: id of the reservation
         :param list options: dhcp options of the reservation
         :param str mac: mac address of the reservation
+        :param dict tags: tags of the reservation
         """
         self._rest = Reservations(config)
         self.config = config
@@ -600,6 +622,7 @@ def __init__(
         self.address_id = address_id
         self.mac = mac
         self.data = None
+        self.tags = tags
 
         if options is None:
             options = DHCPOptions("dhcpv4", {})
@@ -642,6 +665,9 @@ def success(result, *args):
             self.mac = result["mac"]
             self.options = result["options"]
 
+            if "tags" in result:
+                self.tags = result["tags"]
+
             if callback:
                 return callback(self)
             else:
@@ -818,7 +844,13 @@ def success(result, *args):
 
 class Scope(object):
     def __init__(
-        self, config, scopegroup_id, address_id, scope_id=None, options=None
+        self,
+        config,
+        scopegroup_id,
+        address_id,
+        scope_id=None,
+        options=None,
+        tags=None,
     ):
         """
         Create a new high level Scope object
@@ -828,12 +860,14 @@ def __init__(
         :param int address_id: id of the address the scope is associated with
         :param int scope_id: id of the scope
         :param DHCPOptions options: DHCPOptions object that contains the settings for the scope
+        :param dict tags: tags of the scope
         """
         self._rest = Scopes(config)
         self.config = config
         self.scopegroup_id = scopegroup_id
         self.address_id = address_id
         self.id = scope_id
+        self.tags = tags
 
         if options is None:
             options = DHCPOptions("dhcpv4", {})
@@ -876,6 +910,9 @@ def success(result, *args):
             self.address_id = result["address_id"]
             self.options = result["options"]
 
+            if "tags" in result:
+                self.tags = result["tags"]
+
             if callback:
                 return callback(self)
             else:
@@ -919,6 +956,7 @@ def success(result, *args):
             self.options,
             callback=success,
             errback=errback,
+            **kwargs
         )
 
     def update(

ns1/rest/ipam.py

@@ -16,7 +16,7 @@ class Addresses(resource.BaseResource):
         " merged_address_id",
         "scope_group_id",
     ]
-    PASSTHRU_FIELDS = ["prefix", "status", "desc", "kvps", "tags", "reserve"]
+    PASSTHRU_FIELDS = ["prefix", "status", "desc", "tags", "reserve"]
     BOOL_FIELDS = ["parent"]
 
     def _buildBody(self, **kwargs):
@@ -149,7 +149,7 @@ def search(self, network_id, prefix, callback=None, errback=None):
 class Networks(resource.BaseResource):
     ROOT = "ipam/network"
     INT_FIELDS = ["network_id"]
-    PASSTHRU_FIELDS = ["rt", "name", "desc", "kvps", "tags"]
+    PASSTHRU_FIELDS = ["rt", "name", "desc", "tags"]
     BOOL_FIELDS = []
 
     def _buildBody(self, **kwargs):
@@ -218,7 +218,7 @@ def report(self, network_id, callback=None, errback=None):
 class Scopegroups(resource.BaseResource):
     ROOT = "dhcp/scopegroup"
     INT_FIELDS = ["id", "dhcp_service_id", "valid_lifetime_secs"]
-    PASSTHRU_FIELDS = ["dhcpv4", "dhcpv6", "name"]
+    PASSTHRU_FIELDS = ["dhcpv4", "dhcpv6", "name", "tags"]
     BOOL_FIELDS = ["enabled", "echo_client_id"]
 
     def _buildBody(self, **kwargs):
@@ -272,6 +272,13 @@ def retrieve(self, scope_group_id, callback=None, errback=None):
 
 class Scopes(resource.BaseResource):
     ROOT = "dhcp/scope"
+    INT_FIELDS = ["scope_group_id", "address_id", "valid_lifetime_secs"]
+    PASSTHRU_FIELDS = ["options", "tags"]
+
+    def _buildBody(self, **kwargs):
+        body = {}
+        self._buildStdBody(body, kwargs)
+        return body
 
     @classmethod
     def select_from_list(cls, result, scope_id):
@@ -281,13 +288,18 @@ def select_from_list(cls, result, scope_id):
         return None
 
     def create(
-        self, scopegroup_id, address_id, options, callback=None, errback=None
+        self,
+        scopegroup_id,
+        address_id,
+        options,
+        callback=None,
+        errback=None,
+        **kwargs
     ):
-        body = {
-            "address_id": address_id,
-            "scope_group_id": scopegroup_id,
-            "options": options,
-        }
+        kwargs["address_id"] = address_id
+        kwargs["scope_group_id"] = scopegroup_id
+        kwargs["options"] = options
+        body = self._buildBody(**kwargs)
 
         return self._make_request(
             "PUT",
@@ -305,10 +317,15 @@ def update(
         scopegroup_id=None,
         callback=None,
         errback=None,
+        **kwargs
     ):
-        body = {"address_id": address_id, "options": options}
+        kwargs["address_id"] = address_id
+        kwargs["options"] = options
+
         if scopegroup_id is not None:
-            body["scope_group_id"] = (scopegroup_id,)
+            kwargs["scope_group_id"] = scopegroup_id
+
+        body = self._buildBody(**kwargs)
 
         return self._make_request(
             "POST",
@@ -426,7 +443,7 @@ def retrieve(self, space, key, callback=None, errback=None):
 class Reservations(resource.BaseResource):
     ROOT = "dhcp/reservation"
     INT_FIELDS = ["scope_group_id", "address_id"]
-    PASSTHRU_FIELDS = ["mac", "options"]
+    PASSTHRU_FIELDS = ["mac", "options", "tags"]
     BOOL_FIELDS = ["dhcpv6"]
 
     def _buildBody(self, **kwargs):