dns: Add common code for domain/host naming

DNS drivers share the need to manipulate host/domain names, so let's add
utility functions to the common Record and Zone classes to allow
redundant code scattered throughout the various drivers to be
consolidated into common and consistent implementations.

  * Record.name - no longer driver-dependent, now the host prefix or ""
  * Record.hostname - the complete host name, including domain part
  * Record.fqdn - the fully qualified domain name, including root dot

  * Zone.domain - no longer driver-dependent, now the unrooted domain
  * Zone.rooted() - format a (un)rooted domain as a rooted domain
  * Zone.rooted() - format a (un)rooted domain as an unrooted domain

Author: Aaron Sierra

libcloud/dns/base.py

@@ -60,7 +60,7 @@ def __init__(
         :type extra: ``dict``
         """
         self.id = str(id) if id else None
-        self.domain = domain
+        self.domain = self.unrooted(domain)
         self.type = type
         self.ttl = ttl or None
         self.driver = driver
@@ -104,6 +104,16 @@ def __repr__(self):
             self.driver.name,
         )
 
+    @staticmethod
+    def unrooted(domain):
+        """Return the provided domain as an unrooted domain"""
+        return domain.rstrip(".")
+
+    @staticmethod
+    def rooted(domain):
+        """Return the provided domain as an unrooted domain"""
+        return domain if domain.endswith(".") else f"{domain}."
+
     def prefix(self, subname):
         """
         Accept subordinate (or identity) names in multiple convenience formats.
@@ -211,7 +221,17 @@ def __init__(
         :type extra: ``dict``
         """
         self.id = str(id) if id else None
-        self.name = name
+
+        # Support callers that have:
+        #   1. used None, rather than the empty string to indicate apex/naked
+        #      records, while consistently setting the empty string.
+        #   2. used the full hostname (i.e. including domain), rather than the
+        #      bare prefix (i.e. excluding domain)
+        #   3. used the fully qualified domain name (i.e. including domain and
+        #      trailing dot), rather than the bare prefix.
+        #
+        self.name = "" if name is None else zone.prefix(name)
+
         self.type = type
         self.data = data
         self.zone = zone
@@ -252,6 +272,19 @@ def _get_numeric_id(self):
 
         return record_id
 
+    @property
+    def hostname(self):
+        """Return the complete hostname, including domain, for this record."""
+        return self.zone.hostname(self.name)
+
+    @property
+    def fqdn(self):
+        """
+        Return the traditional fully qualified domain name, including full-stop
+        trailing dot, for this record.
+        """
+        return self.zone.fqdn(self.name)
+
     def __repr__(self):
         # type: () -> str
         zone = self.zone.domain if self.zone.domain else self.zone.id

libcloud/dns/drivers/durabledns.py

@@ -293,7 +293,7 @@ def create_zone(self, domain, type="master", ttl=None, extra=None):
         params = {
             "apiuser": self.key,
             "apikey": self.secret,
-            "zonename": domain,
+            "zonename": Zone.rooted(domain),
             "ttl": ttl or DEFAULT_TTL,
         }
         params.update(extra)
@@ -312,7 +312,7 @@ def create_zone(self, domain, type="master", ttl=None, extra=None):
         req_data = skel % (
             self.key,
             self.secret,
-            domain,
+            Zone.rooted(domain),
             extra.get("ns"),
             extra.get("mbox"),
             extra.get("refresh"),
@@ -366,6 +366,7 @@ def create_record(self, name, zone, type, data, extra=None):
 
         :rtype: :class:`Record`
         """
+        name = zone.prefix(name)
         if extra is None:
             extra = RECORD_EXTRA_PARAMS_DEFAULT_VALUES
         else:
@@ -476,7 +477,7 @@ def update_zone(self, zone, domain, type="master", ttl=None, extra=None):
         params = {
             "apiuser": self.key,
             "apikey": self.secret,
-            "zonename": domain,
+            "zonename": Zone.rooted(domain),
             "ttl": ttl,
         }
         params.update(extra)
@@ -495,7 +496,7 @@ def update_zone(self, zone, domain, type="master", ttl=None, extra=None):
         req_data = skel % (
             self.key,
             self.secret,
-            domain,
+            Zone.rooted(domain),
             extra["ns"],
             extra["mbox"],
             extra["refresh"],
@@ -545,6 +546,7 @@ def update_record(self, record, name, type, data, extra=None):
         :rtype: :class:`Record`
         """
         zone = record.zone
+        name = zone.prefix(name)
         if extra is None:
             extra = record.extra
         else:

libcloud/dns/drivers/google.py

@@ -185,7 +185,7 @@ def create_zone(self, domain, type="master", ttl=None, extra=None):
             name = self._cleanup_domain(domain)
 
         data = {
-            "dnsName": domain,
+            "dnsName": Zone.rooted(domain),
             "name": name,
             "description": description,
         }
@@ -216,6 +216,7 @@ def create_record(self, name, zone, type, data, extra=None):
 
         :rtype: :class:`Record`
         """
+        name = zone.fqdn(name)
         ttl = data.get("ttl", 0)
         rrdatas = data.get("rrdatas", [])
 
@@ -253,7 +254,7 @@ def delete_record(self, record):
         data = {
             "deletions": [
                 {
-                    "name": record.name,
+                    "name": record.fqdn,
                     "type": record.type,
                     "rrdatas": record.data["rrdatas"],
                     "ttl": record.data["ttl"],

libcloud/dns/drivers/luadns.py

@@ -233,7 +233,7 @@ def create_record(self, name, zone, type, data, extra=None):
         :rtype: :class:`Record`
         """
         action = "/v1/zones/%s/records" % zone.id
-        to_post = {"name": name, "content": data, "type": type, "zone_id": int(zone.id)}
+        to_post = {"name": zone.fqdn(name), "content": data, "type": type, "zone_id": int(zone.id)}
         # ttl is required to create a record for luadns
         # pass it through extra like this: extra={'ttl':ttl}
         if extra is not None:

libcloud/dns/drivers/nsone.py

@@ -190,7 +190,7 @@ def delete_record(self, record):
 
         :return: Boolean
         """
-        action = "/v1/zones/{}/{}/{}".format(record.zone.domain, record.name, record.type)
+        action = "/v1/zones/{}/{}/{}".format(record.zone.domain, record.hostname, record.type)
         try:
             response = self.connection.request(action=action, method="DELETE")
         except NsOneException as e:

libcloud/dns/drivers/pointdns.py

@@ -280,7 +280,7 @@ def create_record(self, name, zone, type, data, extra=None):
 
         :rtype: :class:`Record`
         """
-        r_json = {"name": name, "data": data, "record_type": type}
+        r_json = {"name": zone.hostname(name), "data": data, "record_type": type}
         if extra is not None:
             r_json.update(extra)
         r_data = json.dumps({"zone_record": r_json})
@@ -354,7 +354,7 @@ def update_record(self, record, name, type, data, extra=None):
         :rtype: :class:`Record`
         """
         zone = record.zone
-        r_json = {"name": name, "data": data, "record_type": type}
+        r_json = {"name": zone.hostname(name), "data": data, "record_type": type}
         if extra is not None:
             r_json.update(extra)
         r_data = json.dumps({"zone_record": r_json})

libcloud/dns/drivers/powerdns.py

@@ -185,18 +185,19 @@ def create_record(self, name, zone, type, data, extra=None):
         if extra is None or extra.get("ttl", None) is None:
             raise ValueError("PowerDNS requires a ttl value for every record")
 
+        hostname = zone.hostname(name)
         if self._pdns_version() == 3:
             record = {
                 "content": data,
                 "disabled": False,
-                "name": name,
+                "name": hostname,
                 "ttl": extra["ttl"],
                 "type": type,
             }
             payload = {
                 "rrsets": [
                     {
-                        "name": name,
+                        "name": hostname,
                         "type": type,
                         "changetype": "REPLACE",
                         "records": [record],
@@ -212,7 +213,7 @@ def create_record(self, name, zone, type, data, extra=None):
             payload = {
                 "rrsets": [
                     {
-                        "name": name,
+                        "name": hostname,
                         "type": type,
                         "changetype": "REPLACE",
                         "ttl": extra["ttl"],
@@ -426,19 +427,20 @@ def update_record(self, record, name, type, data, extra=None):
         if extra is None or extra.get("ttl", None) is None:
             raise ValueError("PowerDNS requires a ttl value for every record")
 
+        hostname = record.zone.hostname(name)
         if self._pdns_version() == 3:
             updated_record = {
                 "content": data,
                 "disabled": False,
-                "name": name,
+                "name": hostname,
                 "ttl": extra["ttl"],
                 "type": type,
             }
             payload = {
                 "rrsets": [
-                    {"name": record.name, "type": record.type, "changetype": "DELETE"},
+                    {"name": record.hostname, "type": record.type, "changetype": "DELETE"},
                     {
-                        "name": name,
+                        "name": hostname,
                         "type": type,
                         "changetype": "REPLACE",
                         "records": [updated_record],
@@ -457,7 +459,7 @@ def update_record(self, record, name, type, data, extra=None):
             payload = {
                 "rrsets": [
                     {
-                        "name": name,
+                        "name": hostname,
                         "type": type,
                         "changetype": "REPLACE",
                         "ttl": extra["ttl"],

libcloud/dns/drivers/zonomi.py

@@ -176,10 +176,7 @@ def create_record(self, name, zone, type, data, extra=None):
         :rtype: :class:`Record`
         """
         action = "/app/dns/dyndns.jsp?"
-        if name:
-            record_name = name + "." + zone.domain
-        else:
-            record_name = zone.domain
+        record_name = zone.hostname(name)
         params = {"action": "SET", "name": record_name, "value": data, "type": type}
 
         if type == "MX" and extra is not None:
@@ -237,7 +234,7 @@ def delete_record(self, record):
         :rtype: Bool
         """
         action = "/app/dns/dyndns.jsp?"
-        params = {"action": "DELETE", "name": record.name, "type": record.type}
+        params = {"action": "DELETE", "name": record.hostname, "type": record.type}
         try:
             response = self.connection.request(action=action, params=params)
         except ZonomiException as e:
@@ -315,16 +312,11 @@ def _to_record(self, item, zone):
         else:
             ttl = None
         extra = {"ttl": ttl, "prio": item.get("prio")}
-        if len(item["name"]) > len(zone.domain):
-            full_domain = item["name"]
-            index = full_domain.index("." + zone.domain)
-            record_name = full_domain[:index]
-        else:
-            record_name = zone.domain
+        rname = item["name"]
         rtype = item["type"]
         record = Record(
-            id=self.to_default_id(zone, item["name"], rtype),
-            name=record_name,
+            id=self.to_default_id(zone, rname, rtype),
+            name=rname,
             data=item["content"],
             type=rtype,
             zone=zone,

libcloud/test/dns/test_base.py

@@ -82,6 +82,30 @@ def test_zone_helpers(self):
             self.assertEqual(zone.hostname(sub), "sub.example.com")
             self.assertEqual(zone.fqdn(sub), "sub.example.com.")
 
+    def test_record_init(self):
+        common = {
+            "id": None,
+            "name": None,
+            "type": RecordType.A,
+            "data": "0.0.0.0",
+            "zone": self.master_zone,
+            "driver": self.master_zone,
+        }
+
+        for apex in (None, "", "example.com", "example.com."):
+            common["name"] = apex
+            r1 = Record(**common)
+            self.assertEqual(r1.name, "")
+            self.assertEqual(r1.hostname, "example.com")
+            self.assertEqual(r1.fqdn, "example.com.")
+
+        for sub in ("sub", "sub.example.com", "sub.example.com."):
+            common["name"] = sub
+            r2 = Record(**common)
+            self.assertEqual(r2.name, "sub")
+            self.assertEqual(r2.hostname, "sub.example.com")
+            self.assertEqual(r2.fqdn, "sub.example.com.")
+
     def test_export_zone_to_bind_format_slave_should_throw(self):
         zone = Zone(id=1, domain="example.com", type="slave", ttl=900, driver=self.driver)
         self.assertRaises(ValueError, zone.export_to_bind_format)
@@ -157,7 +181,7 @@ def test_export_zone_to_bind_format_success(self):
     def test_get_numeric_id(self):
         values = MOCK_RECORDS_VALUES[0].copy()
         values["driver"] = self.driver
-        values["zone"] = None
+        values["zone"] = self.master_zone
         record = Record(**values)
 
         record.id = "abcd"

libcloud/test/dns/test_cloudflare.py

@@ -80,7 +80,7 @@ def test_get_record(self):
         self.assertEqual(sent.url, '/client/v4/zones/1234/dns_records/364797364')
 
         self.assertEqual(record.id, "364797364")
-        self.assertIsNone(record.name)
+        self.assertEqual(record.name, "")
         self.assertEqual(record.type, "A")
         self.assertEqual(record.data, "192.30.252.153")
 
@@ -104,7 +104,7 @@ def test_list_records(self):
 
         record = records[0]
         self.assertEqual(record.id, "364797364")
-        self.assertIsNone(record.name)
+        self.assertEqual(record.name, "")
         self.assertEqual(record.type, "A")
         self.assertEqual(record.data, "192.30.252.153")
         self.assertEqual(record.extra["priority"], None)
@@ -123,7 +123,7 @@ def test_list_records(self):
 
         record = [r for r in records if r.type == "MX"][0]
         self.assertEqual(record.id, "78526")
-        self.assertIsNone(record.name)
+        self.assertEqual(record.name, "")
         self.assertEqual(record.type, "MX")
         self.assertEqual(record.data, "aspmx3.googlemail.com")
         self.assertEqual(record.extra["priority"], 30)