From 6f0a12ae01a6fb0f0368264bcf48f8cc9089658d Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Mon, 2 Oct 2017 14:16:29 +0200 Subject: [PATCH 01/12] Add .idea (intelliJ) files to gitignore. --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index c45a684..1bca124 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,4 @@ output/ tmp/ build/ config/ +.idea/ \ No newline at end of file From ed783b5ff2899828d2480a63cecf55ed04a9e6e7 Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Mon, 2 Oct 2017 14:17:09 +0200 Subject: [PATCH 02/12] Add proposed google cloud provider. Proposed google cloud provider for #23 --- octodns/provider/googlecloud.py | 363 ++++++++++++++++++ requirements.txt | 1 + script/test | 1 + tests/test_octodns_provider_googlecloud.py | 421 +++++++++++++++++++++ 4 files changed, 786 insertions(+) create mode 100644 octodns/provider/googlecloud.py create mode 100644 tests/test_octodns_provider_googlecloud.py diff --git a/octodns/provider/googlecloud.py b/octodns/provider/googlecloud.py new file mode 100644 index 0000000..dff11fc --- /dev/null +++ b/octodns/provider/googlecloud.py @@ -0,0 +1,363 @@ +# +# +# + +from __future__ import absolute_import, division, print_function, \ + unicode_literals + +import re +import shlex +import time +from logging import getLogger + +from google.cloud import dns + +from .base import BaseProvider +from ..record import Record + + +class _GoogleCloudRecordSetMaker(object): + """Wrapper to make google cloud client resource record sets from OctoDNS + Records. + + googlecloud.py: + class: octodns.provider.googlecloud._GoogleCloudRecordSetMaker + An _GoogleCloudRecordSetMaker creates google cloued client resource + records which can be used to update the Google Cloud DNS zones. + """ + + def __init__(self, gcloud_zone, record): + self.gcloud_zone = gcloud_zone + self.record = record + + self._record_set_func = getattr( + self, '_record_set_from_{}'.format(record._type)) + + def get_record_set(self): + return self._record_set_func(self.record) + + def _record_set_from_A(self, record): + return self.gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, record.values) + + _record_set_from_AAAA = _record_set_from_A + + def _record_set_from_CAA(self, record): + return self.gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, [ + '{flags} {tag} {value}'.format(**record.data['value'])]) + + def _record_set_from_CNAME(self, record): + return self.gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, [record.value]) + + def _record_set_from_MX(self, record): + return self.gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, [ + '{preference} {exchange}'.format(**v.data) + for v in record.values]) + + def _record_set_from_NAPTR(self, record): + return self.gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, [ + '{order} {preference} "{flags}" "{service}" ' + '"{regexp}" {replacement}' + .format(**v.data) for v in record.values]) + + _record_set_from_NS = _record_set_from_A + + _record_set_from_PTR = _record_set_from_CNAME + + _record_set_from_SPF = _record_set_from_A + + def _record_set_from_SRV(self, record): + return self.gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, [ + '{priority} {weight} {port} {target}' + .format(**v.data) for v in record.values]) + + def _record_set_from_TXT(self, record): + if 'values' in record.data: + val = record.data['values'] + else: + val = [record.data['value']] + + return self.gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, val) + + +class GoogleCloudProvider(BaseProvider): + """ + Google Cloud DNS provider + + google_cloud: + class: octodns.provider.googlecloud.GoogleCloudProvider + # Credentials file for a service_account or other account can be + # specified with the GOOGLE_APPLICATION_CREDENTIALS environment + # variable. (https://console.cloud.google.com/apis/credentials) + # + # The project to work on (not required) + # project: foobar + """ + + SUPPORTS = set(('A', 'AAAA', 'CAA', 'CNAME', 'MX', 'NAPTR', + 'NS', 'PTR', 'SPF', 'SRV', 'TXT')) + SUPPORTS_GEO = False + + def __init__(self, id, project=None, *args, **kwargs): + + # Logger + self.log = getLogger('GoogleCloudProvider[{}]'.format(id)) + self.id = id + + super(GoogleCloudProvider, self).__init__(id, *args, **kwargs) + self.gcloud_client = dns.Client(project=project) + + def _apply(self, plan): + """Required function of manager.py to actually apply a record change. + + :param plan: Contains the zones and changes to be made + :type plan: octodns.provider.base.Plan + + :type return: void + """ + desired = plan.desired + changes = plan.changes + + self.log.debug('_apply: zone=%s, len(changes)=%d', desired.name, + len(changes)) + + # Get gcloud zone, or create one if none existed before. + gcloud_zone = self._get_gcloud_zone(desired.name, create=True) + + gcloud_changes = gcloud_zone.changes() + + for change in changes: + class_name = change.__class__.__name__ + if class_name in 'Create': + gcloud_changes.add_record_set( + self._record_to_record_set(gcloud_zone, change.record)) + elif class_name == 'Delete': + gcloud_changes.delete_record_set( + self._record_to_record_set(gcloud_zone, change.record)) + elif class_name == 'Update': + gcloud_changes.delete_record_set( + self._record_to_record_set(gcloud_zone, change.existing)) + gcloud_changes.add_record_set( + self._record_to_record_set(gcloud_zone, change.new)) + else: + raise RuntimeError('Change type "{}" for change "{!s}" ' + 'is none of "Create", "Delete" or "Update' + .format(class_name, change)) + + gcloud_changes.create() + i = 1 + while gcloud_changes.status != 'done': + self.log.debug("Waiting for changes to complete") + time.sleep(i) + gcloud_changes.reload() + if i < 30: + i += 2 + + def _create_gcloud_zone(self, dns_name): + """Creates a google cloud ManagedZone with dns_name, and zone named + derived from it. calls .create() method and returns it. + + :param dns_name: fqdn of zone to create + :type dns_name: str + + :type return: new google.cloud.dns.ManagedZone + """ + # Zone name must begin with a letter, end with a letter or digit, + # and only contain lowercase letters, digits or dashes + zone_name = re.sub("[^a-z0-9-]", "", + dns_name[:-1].replace('.', "-")) + # make sure that the end result did not end up wo leading letter + if re.match('[^a-z]', zone_name[0]): + # I cannot think of a situation where a zone name derived from + # a domain name would'nt start with leading letter and thereby + # violate the constraint, however if such a situation is + # encountered, add a leading "a" here. + zone_name = "a%s" % zone_name + + gcloud_zone = self.gcloud_client.zone( + name=zone_name, + dns_name=dns_name + ) + gcloud_zone.create(client=self.gcloud_client) + + self.log.info("Created zone %s. Fqdn %s." % + (zone_name, dns_name)) + + return gcloud_zone + + def _get_gcloud_records(self, gcloud_zone, page_token=None): + """ Generator function which yields ResourceRecordSet for the managed + gcloud zone, until there are no more records to pull. + + :param gcloud_zone: zone to pull records from + :type gcloud_zone: google.cloud.dns.ManagedZone + :param page_token: page token for the page to get + + :return: a resource record set + :type return: google.cloud.dns.ResourceRecordSet + """ + gcloud_iterator = gcloud_zone.list_resource_record_sets( + page_token=page_token) + for gcloud_record in gcloud_iterator: + yield gcloud_record + # This is to get results which may be on a "paged" page. + # (if more than max_results) entries. + if gcloud_iterator.next_page_token: + for gcloud_record in self._get_gcloud_records( + gcloud_zone, gcloud_iterator.next_page_token): + # yield from is in python 3 only. + yield gcloud_record + + def _get_gcloud_zone(self, dns_name, page_token=None, create=False): + """Return the ManagedZone which has has the matching dns_name, or + None if no such zone exist, unless create=True, then create a new + one and return it. + + :param dns_name: fqdn of dns name for zone to get. + :type dns_name: str + :param page_token: page token for the page to get + :type page_token: str + :param create: if true, create ManagedZone if it does not exist + already + + :type return: new google.cloud.dns.ManagedZone + """ + # Find the google name for the incoming zone + gcloud_zones = self.gcloud_client.list_zones(page_token=page_token) + for gcloud_zone in gcloud_zones: + if gcloud_zone.dns_name == dns_name: + return gcloud_zone + else: + # Zone not found. Check if there are more results which could be + # retrieved by checking "next_page_token". + if gcloud_zones.next_page_token: + return self._get_gcloud_zone(dns_name, + gcloud_zones.next_page_token) + else: + # Nothing found, either return None or else create zone and + # return that one (if create=True) + self.log.debug('_get_gcloud_zone: zone name=%s, ' + 'was not found by %s.', + dns_name, self.gcloud_client) + if create: + return self._create_gcloud_zone(dns_name) + + @staticmethod + def _record_to_record_set(gcloud_zone, record): + """create google.cloud.dns.ResourceRecordSet from ocdodns.Record + + :param record: a record object + :type record: ocdodns.Record + :param gcloud_zone: a google gcloud zone + :type gcloud_zone: google.cloud.dns.ManagedZone + :type return: google.cloud.dns.ResourceRecordSet + """ + grm = _GoogleCloudRecordSetMaker(gcloud_zone, record) + + return grm.get_record_set() + + def populate(self, zone, target=False, lenient=False): + """Required function of manager.py to collect records from zone. + + :param zone: A dns zone + :type zone: octodns.zone.Zone + :param target: Unused. + :type target: bool + :param lenient: Unused. Check octodns.manager for usage. + :type lenient: bool + + :type return: void + """ + + self.log.debug('populate: name=%s, target=%s, lenient=%s', zone.name, + target, lenient) + before = len(zone.records) + + gcloud_zone = self._get_gcloud_zone(zone.name) + + _records = set() + if gcloud_zone: + for gcloud_record in self._get_gcloud_records(gcloud_zone): + if gcloud_record.record_type.upper() in self.SUPPORTS: + _records.add(gcloud_record) + for gcloud_record in _records: + record_name = gcloud_record.name + if record_name.endswith(zone.name): + # google cloud always return fqdn. Make relative record + # here. "root" records will then get the '' record_name, + # which is also the way dyn likes it. + record_name = record_name[:-(len(zone.name) + 1)] + typ = gcloud_record.record_type.upper() + data = getattr(self, '_data_for_{}'.format(typ)) + data = data(gcloud_record) + data['type'] = typ + data['ttl'] = gcloud_record.ttl + self.log.debug('populate: adding record {} records: {!s}' + .format(record_name, data)) + record = Record.new(zone, record_name, data, source=self) + zone.add_record(record) + + self.log.info('populate: found %s records', len(zone.records) - before) + + def _data_for_A(self, gcloud_record): + return { + 'values': gcloud_record.rrdatas + } + + _data_for_AAAA = _data_for_A + + def _data_for_CAA(self, gcloud_record): + return { + 'values': [{ + 'flags': v[0], + 'tag': v[1], + 'value': v[2]} + for v in [shlex.split(g) for g in gcloud_record.rrdatas]]} + + def _data_for_CNAME(self, gcloud_record): + return { + 'value': gcloud_record.rrdatas[0] + } + + def _data_for_MX(self, gcloud_record): + return {'values': [{ + "preference": v[0], + "exchange": v[1]} + for v in [shlex.split(g) for g in gcloud_record.rrdatas]]} + + def _data_for_NAPTR(self, gcloud_record): + return {'values': [{ + 'order': v[0], + 'preference': v[1], + 'flags': v[2], + 'service': v[3], + 'regexp': v[4], + 'replacement': v[5]} + for v in [shlex.split(g) for g in gcloud_record.rrdatas]]} + + _data_for_NS = _data_for_A + + _data_for_PTR = _data_for_CNAME + + _data_for_SPF = _data_for_A + + def _data_for_SRV(self, gcloud_record): + return {'values': [{ + 'priority': v[0], + 'weight': v[1], + 'port': v[2], + 'target': v[3]} + for v in [shlex.split(g) for g in gcloud_record.rrdatas]]} + + def _data_for_TXT(self, gcloud_record): + if len(gcloud_record.rrdatas) > 1: + return { + 'values': gcloud_record.rrdatas} + return { + 'value': gcloud_record.rrdatas[0]} diff --git a/requirements.txt b/requirements.txt index a7d1d94..80fbe1e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -9,6 +9,7 @@ dnspython==1.15.0 docutils==0.14 dyn==1.8.0 futures==3.1.1 +google-cloud==0.27.0 incf.countryutils==1.0 ipaddress==1.0.18 jmespath==0.9.3 diff --git a/script/test b/script/test index 3ee6e9c..41edfd8 100755 --- a/script/test +++ b/script/test @@ -24,5 +24,6 @@ export DNSIMPLE_TOKEN= export DYN_CUSTOMER= export DYN_PASSWORD= export DYN_USERNAME= +export GOOGLE_APPLICATION_CREDENTIALS= nosetests "$@" diff --git a/tests/test_octodns_provider_googlecloud.py b/tests/test_octodns_provider_googlecloud.py new file mode 100644 index 0000000..568ac4f --- /dev/null +++ b/tests/test_octodns_provider_googlecloud.py @@ -0,0 +1,421 @@ +# +# +# + +from __future__ import absolute_import, division, print_function, \ + unicode_literals + +from octodns.record import Create, Delete, Update, Record +from octodns.provider.googlecloud import GoogleCloudProvider, \ + _GoogleCloudRecordSetMaker + +from octodns.zone import Zone +from octodns.provider.base import Plan + +from unittest import TestCase +from mock import Mock, patch, PropertyMock + +zone = Zone(name='unit.tests.', sub_zones=[]) +octo_records = [] +octo_records.append(Record.new(zone, '', { + 'ttl': 0, + 'type': 'A', + 'values': ['1.2.3.4', '10.10.10.10']})) +octo_records.append(Record.new(zone, 'a', { + 'ttl': 1, + 'type': 'A', + 'values': ['1.2.3.4', '1.1.1.1']})) +octo_records.append(Record.new(zone, 'aa', { + 'ttl': 9001, + 'type': 'A', + 'values': ['1.2.4.3']})) +octo_records.append(Record.new(zone, 'aaa', { + 'ttl': 2, + 'type': 'A', + 'values': ['1.1.1.3']})) +octo_records.append(Record.new(zone, 'cname', { + 'ttl': 3, + 'type': 'CNAME', + 'value': 'a.unit.tests.'})) +octo_records.append(Record.new(zone, 'mx1', { + 'ttl': 3, + 'type': 'MX', + 'values': [{ + 'priority': 10, + 'value': 'mx1.unit.tests.', + }, { + 'priority': 20, + 'value': 'mx2.unit.tests.', + }]})) +octo_records.append(Record.new(zone, 'mx2', { + 'ttl': 3, + 'type': 'MX', + 'values': [{ + 'priority': 10, + 'value': 'mx1.unit.tests.', + }]})) +octo_records.append(Record.new(zone, '', { + 'ttl': 4, + 'type': 'NS', + 'values': ['ns1.unit.tests.', 'ns2.unit.tests.']})) +octo_records.append(Record.new(zone, 'foo', { + 'ttl': 5, + 'type': 'NS', + 'value': 'ns1.unit.tests.'})) +octo_records.append(Record.new(zone, '_srv._tcp', { + 'ttl': 6, + 'type': 'SRV', + 'values': [{ + 'priority': 10, + 'weight': 20, + 'port': 30, + 'target': 'foo-1.unit.tests.', + }, { + 'priority': 12, + 'weight': 30, + 'port': 30, + 'target': 'foo-2.unit.tests.', + }]})) +octo_records.append(Record.new(zone, '_srv2._tcp', { + 'ttl': 7, + 'type': 'SRV', + 'values': [{ + 'priority': 12, + 'weight': 17, + 'port': 1, + 'target': 'srvfoo.unit.tests.', + }]})) +octo_records.append(Record.new(zone, 'txt1', { + 'ttl': 8, + 'type': 'TXT', + 'value': 'txt singleton test'})) +octo_records.append(Record.new(zone, 'txt2', { + 'ttl': 9, + 'type': 'TXT', + 'values': ['txt multiple test', 'txt multiple test 2']})) +octo_records.append(Record.new(zone, 'naptr', { + 'ttl': 9, + 'type': 'NAPTR', + 'values': [{ + 'order': 100, + 'preference': 10, + 'flags': 'S', + 'service': 'SIP+D2U', + 'regexp': "!^.*$!sip:customer-service@unit.tests!", + 'replacement': '_sip._udp.unit.tests.' + }]})) +octo_records.append(Record.new(zone, 'caa', { + 'ttl': 9, + 'type': 'CAA', + 'value': { + 'flags': 0, + 'tag': 'issue', + 'value': 'ca.unit.tests', + }})) +for record in octo_records: + zone.add_record(record) + +# This is the format which the google API likes. +resource_record_sets = [ + ('unit.tests.', u'A', 0, [u'1.2.3.4', u'10.10.10.10']), + (u'a.unit.tests.', u'A', 1, [u'1.1.1.1', u'1.2.3.4']), + (u'aa.unit.tests.', u'A', 9001, [u'1.2.4.3']), + (u'aaa.unit.tests.', u'A', 2, [u'1.1.1.3']), + (u'cname.unit.tests.', u'CNAME', 3, [u'a.unit.tests.']), + (u'mx1.unit.tests.', u'MX', 3, + [u'10 mx1.unit.tests.', u'20 mx2.unit.tests.']), + (u'mx2.unit.tests.', u'MX', 3, [u'10 mx1.unit.tests.']), + ('unit.tests.', u'NS', 4, [u'ns1.unit.tests.', u'ns2.unit.tests.']), + (u'foo.unit.tests.', u'NS', 5, [u'ns1.unit.tests.']), + (u'_srv._tcp.unit.tests.', u'SRV', 6, + [u'10 20 30 foo-1.unit.tests.', u'12 30 30 foo-2.unit.tests.']), + (u'_srv2._tcp.unit.tests.', u'SRV', 7, [u'12 17 1 srvfoo.unit.tests.']), + (u'txt1.unit.tests.', u'TXT', 8, [u'txt singleton test']), + (u'txt2.unit.tests.', u'TXT', 9, + [u'txt multiple test', u'txt multiple test 2']), + (u'naptr.unit.tests.', u'NAPTR', 9, [ + u'100 10 "S" "SIP+D2U" "!^.*$!sip:customer-service@unit.tests!"' + u' _sip._udp.unit.tests.']), + (u'caa.unit.tests.', u'CAA', 9, [u'0 issue ca.unit.tests']) +] + + +class DummyResourceRecordSet: + def __init__(self, record_name, record_type, ttl, rrdatas): + self.name = record_name + self.record_type = record_type + self.ttl = ttl + self.rrdatas = rrdatas + + def __eq__(self, other): + try: + return self.name == other.name \ + and self.record_type == other.record_type \ + and self.ttl == other.ttl \ + and sorted(self.rrdatas) == sorted(other.rrdatas) + except: + return False + + def __repr__(self): + return "{} {} {} {!s}"\ + .format(self.name, self.record_type, self.ttl, self.rrdatas) + + def __hash__(self): + return hash(repr(self)) + + +class DummyGoogleCloudZone: + def __init__(self, dns_name): + self.dns_name = dns_name + + def resource_record_set(self, *args): + return DummyResourceRecordSet(*args) + + def list_resource_record_sets(self, *args): + pass + + +class DummyIterator: + """Returns a mock DummyIterator object to use in testing. + This is because API calls for google cloud DNS, if paged, contains a + "next_page_token", which can be used to grab a subsequent + iterator with more results. + + :type return: DummyIterator + """ + def __init__(self, list_of_stuff, page_token=None): + self.iterable = iter(list_of_stuff) + self.next_page_token = page_token + + def __iter__(self): + return self + + def next(self): + return self.iterable.next() + + +class TestGoogleCloudRecordSetMaker(TestCase): + def test_get_record_set(self): + mz = DummyGoogleCloudZone('unit.tests.') + record_sets = [] + for record in octo_records: + mm = _GoogleCloudRecordSetMaker(mz, record) + record_sets.append(mm.get_record_set()) + + self.assertEqual( + len(octo_records), + len(record_sets)) + + +class TestGoogleCloudProvider(TestCase): + @patch('octodns.provider.googlecloud.dns') + def _get_provider(*args): + '''Returns a mock GoogleCloudProvider object to use in testing. + + :type return: GoogleCloudProvider + ''' + return GoogleCloudProvider(id=1, project="mock") + + @patch('octodns.provider.googlecloud.time.sleep') + @patch('octodns.provider.googlecloud.dns') + def test__apply(self, *_): + class DummyDesired: + def __init__(self, name, changes): + self.name = name + self.changes = changes + + apply_z = Zone("unit.tests.", []) + create_r = Record.new(apply_z, '', { + 'ttl': 0, + 'type': 'A', + 'values': ['1.2.3.4', '10.10.10.10']}) + delete_r = Record.new(apply_z, 'a', { + 'ttl': 1, + 'type': 'A', + 'values': ['1.2.3.4', '1.1.1.1']}) + update_existing_r = Record.new(apply_z, 'aa', { + 'ttl': 9001, + 'type': 'A', + 'values': ['1.2.4.3']}) + update_new_r = Record.new(apply_z, 'aa', { + 'ttl': 666, + 'type': 'A', + 'values': ['1.4.3.2']}) + + gcloud_zone_mock = DummyGoogleCloudZone("unit.tests.") + status_mock = Mock() + return_values_for_status = iter( + ['', '', '', '', '', '', '', '', '', '', '', '', '', '', '', + '', '', '', 'done']) + type(status_mock).status = PropertyMock( + side_effect=return_values_for_status.next) + gcloud_zone_mock.changes = Mock(return_value=status_mock) + + provider = self._get_provider() + provider.gcloud_client = Mock() + provider._get_gcloud_zone = Mock( + return_value=gcloud_zone_mock) + desired = Mock() + desired.name = Mock(return_value="unit.tests.") + changes = [] + changes.append(Create(create_r)) + changes.append(Delete(delete_r)) + changes.append(Update(existing=update_existing_r, new=update_new_r)) + + provider.apply(Plan( + existing=[update_existing_r, delete_r], + desired=desired, + changes=changes + )) + + calls_mock = gcloud_zone_mock.changes.return_value + mocked_calls = [] + for mock_call in calls_mock.add_record_set.mock_calls: + mocked_calls.append(mock_call[1][0]) + + self.assertEqual(mocked_calls, [ + DummyResourceRecordSet( + 'unit.tests.', 'A', 0, ['1.2.3.4', '10.10.10.10']), + DummyResourceRecordSet( + 'aa.unit.tests.', 'A', 666, ['1.4.3.2']) + ]) + + mocked_calls2 = [] + for mock_call in calls_mock.delete_record_set.mock_calls: + mocked_calls2.append(mock_call[1][0]) + + self.assertEqual(mocked_calls2, [ + DummyResourceRecordSet( + 'a.unit.tests.', 'A', 1, ['1.2.3.4', '1.1.1.1']), + DummyResourceRecordSet( + 'aa.unit.tests.', 'A', 9001, ['1.2.4.3']) + ]) + + unsupported_change = Mock() + unsupported_change.__len__ = Mock(return_value=1) + mock_plan = Mock() + type(mock_plan).desired = PropertyMock(return_value=DummyDesired( + "dummy name", [])) + type(mock_plan).changes = [unsupported_change] + + with self.assertRaises(RuntimeError): + provider.apply(mock_plan) + + def test__record_to_record_set(self): + provider = self._get_provider() + gcloud_zone = DummyGoogleCloudZone('unit.tests.') + for record in octo_records: + self.assertIsNotNone(provider._record_to_record_set( + gcloud_zone, record)) + + def test__get_gcloud_client(self): + provider = self._get_provider() + + self.assertIsInstance(provider, GoogleCloudProvider) + + @patch('octodns.provider.googlecloud.dns') + def test_populate(self, _): + def _get_mock_zones(page_token=None): + if not page_token: + return DummyIterator([ + DummyGoogleCloudZone('example.com.'), + DummyGoogleCloudZone('example2.com.'), + ], page_token="DUMMY_PAGE_TOKEN") + + return DummyIterator([ + google_cloud_zone + ]) + + def _get_mock_record_sets(page_token=None): + if not page_token: + return DummyIterator( + [DummyResourceRecordSet(*v) for v in + resource_record_sets[:5]], page_token="DUMMY_PAGE_TOKEN") + return DummyIterator( + [DummyResourceRecordSet(*v) for v in resource_record_sets[5:]]) + + google_cloud_zone = DummyGoogleCloudZone('unit.tests.') + + provider = self._get_provider() + provider.gcloud_client.list_zones = Mock(side_effect=_get_mock_zones) + google_cloud_zone.list_resource_record_sets = Mock( + side_effect=_get_mock_record_sets) + + self.assertEqual(provider._get_gcloud_zone("unit.tests.").dns_name, + "unit.tests.") + + test_zone = Zone('unit.tests.', []) + provider.populate(test_zone) + + # test_zone gets fed the same records as zone does, except it's in + # the format returned by google API, so after populate they should look + # excactly the same. + self.assertEqual(test_zone.records, zone.records) + + test_zone2 = Zone('nonexistant.zone.', []) + provider.populate(test_zone2, False, False) + + self.assertEqual(len(test_zone2.records), 0, + msg="Zone should not get records from wrong domain") + + provider.SUPPORTS = set() + test_zone3 = Zone('unit.tests.', []) + provider.populate(test_zone3) + self.assertEqual(len(test_zone3.records), 0) + + @patch('octodns.provider.googlecloud.dns') + def test_populate_corner_cases(self, _): + provider = self._get_provider() + test_zone = Zone('unit.tests.', []) + not_same_fqdn = DummyResourceRecordSet( + 'unit.tests.gr', u'A', 0, [u'1.2.3.4']), + + provider._get_gcloud_records = Mock( + side_effect=[not_same_fqdn]) + provider._get_gcloud_zone = Mock(return_value=DummyGoogleCloudZone( + dns_name="unit.tests.")) + + provider.populate(test_zone) + + self.assertEqual(len(test_zone.records), 1) + + self.assertEqual(test_zone.records.pop().fqdn, + u'unit.tests.gr.unit.tests.') + + def test__get_gcloud_zone(self): + provider = self._get_provider() + + provider.gcloud_client = Mock() + provider.gcloud_client.list_zones = Mock( + return_value=DummyIterator([])) + + self.assertIsNone(provider._get_gcloud_zone("nonexistant.xone"), + msg="Check that nonexistant zones return None when" + "there's no create=True flag") + + def test__create_zone(self): + provider = self._get_provider() + + provider.gcloud_client = Mock() + provider.gcloud_client.list_zones = Mock( + return_value=DummyIterator([])) + + mock_zone = provider._get_gcloud_zone( + 'nonexistant.zone.mock', create=True) + + mock_zone.create.assert_called() + provider.gcloud_client.zone.assert_called() + provider.gcloud_client.zone.assert_called_once_with( + dns_name=u'nonexistant.zone.mock', name=u'nonexistant-zone-moc') + + def test__create_zone_with_numbers_in_name(self): + provider = self._get_provider() + + provider.gcloud_client = Mock() + provider.gcloud_client.list_zones = Mock( + return_value=DummyIterator([])) + + provider._get_gcloud_zone( + '111.', create=True) + provider.gcloud_client.zone.assert_called_once_with( + dns_name=u'111.', name=u'a111') From f082d5798f10a9f68b90acccc408ef8617b6e5fb Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Tue, 3 Oct 2017 09:12:02 +0200 Subject: [PATCH 03/12] Revert "Add .idea (intelliJ) files to gitignore." This reverts commit 5a3d844559f1d1514a171f1fa38d80a27a096ce9. --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index 1bca124..c45a684 100644 --- a/.gitignore +++ b/.gitignore @@ -11,4 +11,3 @@ output/ tmp/ build/ config/ -.idea/ \ No newline at end of file From 2a3690e8778a4bbaf5d84891a4cea23f38b68e61 Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Tue, 3 Oct 2017 11:12:25 +0200 Subject: [PATCH 04/12] Add auth config opts to googlecloud provider Also make _data_for_SPF and _data_for_TXT the same method. --- octodns/provider/googlecloud.py | 32 +++++++++++++++------- tests/test_octodns_provider_googlecloud.py | 13 ++++++++- 2 files changed, 34 insertions(+), 11 deletions(-) diff --git a/octodns/provider/googlecloud.py b/octodns/provider/googlecloud.py index dff11fc..8aa8c99 100644 --- a/octodns/provider/googlecloud.py +++ b/octodns/provider/googlecloud.py @@ -96,22 +96,34 @@ class GoogleCloudProvider(BaseProvider): # specified with the GOOGLE_APPLICATION_CREDENTIALS environment # variable. (https://console.cloud.google.com/apis/credentials) # - # The project to work on (not required) + # The project to work on (not required) # project: foobar + # + # The File with the google credentials (not required). If used, the + # "project" parameter needs to be set, else it will fall back to the + # "default credentials" + # credentials_file: ~/google_cloud_credentials_file.json + # """ SUPPORTS = set(('A', 'AAAA', 'CAA', 'CNAME', 'MX', 'NAPTR', 'NS', 'PTR', 'SPF', 'SRV', 'TXT')) SUPPORTS_GEO = False - def __init__(self, id, project=None, *args, **kwargs): + def __init__(self, id, project=None, credentials_file=None, + *args, **kwargs): + + if credentials_file: + self.gcloud_client = dns.Client.from_service_account_json( + credentials_file, project=project) + else: + self.gcloud_client = dns.Client(project=project) # Logger self.log = getLogger('GoogleCloudProvider[{}]'.format(id)) self.id = id super(GoogleCloudProvider, self).__init__(id, *args, **kwargs) - self.gcloud_client = dns.Client(project=project) def _apply(self, plan): """Required function of manager.py to actually apply a record change. @@ -345,7 +357,12 @@ class GoogleCloudProvider(BaseProvider): _data_for_PTR = _data_for_CNAME - _data_for_SPF = _data_for_A + def _data_for_SPF(self, gcloud_record): + if len(gcloud_record.rrdatas) > 1: + return { + 'values': gcloud_record.rrdatas} + return { + 'value': gcloud_record.rrdatas[0]} def _data_for_SRV(self, gcloud_record): return {'values': [{ @@ -355,9 +372,4 @@ class GoogleCloudProvider(BaseProvider): 'target': v[3]} for v in [shlex.split(g) for g in gcloud_record.rrdatas]]} - def _data_for_TXT(self, gcloud_record): - if len(gcloud_record.rrdatas) > 1: - return { - 'values': gcloud_record.rrdatas} - return { - 'value': gcloud_record.rrdatas[0]} + _data_for_TXT = _data_for_SPF diff --git a/tests/test_octodns_provider_googlecloud.py b/tests/test_octodns_provider_googlecloud.py index 568ac4f..c7b93e3 100644 --- a/tests/test_octodns_provider_googlecloud.py +++ b/tests/test_octodns_provider_googlecloud.py @@ -10,7 +10,7 @@ from octodns.provider.googlecloud import GoogleCloudProvider, \ _GoogleCloudRecordSetMaker from octodns.zone import Zone -from octodns.provider.base import Plan +from octodns.provider.base import Plan, BaseProvider from unittest import TestCase from mock import Mock, patch, PropertyMock @@ -216,6 +216,17 @@ class TestGoogleCloudProvider(TestCase): ''' return GoogleCloudProvider(id=1, project="mock") + @patch('octodns.provider.googlecloud.time.sleep') + @patch('octodns.provider.googlecloud.dns') + def test___init__(self, *_): + self.assertIsInstance(GoogleCloudProvider(id=1, + credentials_file="test", + project="unit test"), + BaseProvider) + + self.assertIsInstance(GoogleCloudProvider(id=1), + BaseProvider) + @patch('octodns.provider.googlecloud.time.sleep') @patch('octodns.provider.googlecloud.dns') def test__apply(self, *_): From 8230700ad17ebe9f8fcaf80212bec9a424d5f1ec Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Tue, 3 Oct 2017 13:25:36 +0200 Subject: [PATCH 05/12] Consolidate googlecloud provider to single class remove _GoogleCloudRecordSetMaker into the GoogleCloudProvider, and consolidate methods. --- octodns/provider/googlecloud.py | 144 ++++++++------------- tests/test_octodns_provider_googlecloud.py | 38 +++--- 2 files changed, 72 insertions(+), 110 deletions(-) diff --git a/octodns/provider/googlecloud.py b/octodns/provider/googlecloud.py index 8aa8c99..0f20587 100644 --- a/octodns/provider/googlecloud.py +++ b/octodns/provider/googlecloud.py @@ -16,76 +16,6 @@ from .base import BaseProvider from ..record import Record -class _GoogleCloudRecordSetMaker(object): - """Wrapper to make google cloud client resource record sets from OctoDNS - Records. - - googlecloud.py: - class: octodns.provider.googlecloud._GoogleCloudRecordSetMaker - An _GoogleCloudRecordSetMaker creates google cloued client resource - records which can be used to update the Google Cloud DNS zones. - """ - - def __init__(self, gcloud_zone, record): - self.gcloud_zone = gcloud_zone - self.record = record - - self._record_set_func = getattr( - self, '_record_set_from_{}'.format(record._type)) - - def get_record_set(self): - return self._record_set_func(self.record) - - def _record_set_from_A(self, record): - return self.gcloud_zone.resource_record_set( - record.fqdn, record._type, record.ttl, record.values) - - _record_set_from_AAAA = _record_set_from_A - - def _record_set_from_CAA(self, record): - return self.gcloud_zone.resource_record_set( - record.fqdn, record._type, record.ttl, [ - '{flags} {tag} {value}'.format(**record.data['value'])]) - - def _record_set_from_CNAME(self, record): - return self.gcloud_zone.resource_record_set( - record.fqdn, record._type, record.ttl, [record.value]) - - def _record_set_from_MX(self, record): - return self.gcloud_zone.resource_record_set( - record.fqdn, record._type, record.ttl, [ - '{preference} {exchange}'.format(**v.data) - for v in record.values]) - - def _record_set_from_NAPTR(self, record): - return self.gcloud_zone.resource_record_set( - record.fqdn, record._type, record.ttl, [ - '{order} {preference} "{flags}" "{service}" ' - '"{regexp}" {replacement}' - .format(**v.data) for v in record.values]) - - _record_set_from_NS = _record_set_from_A - - _record_set_from_PTR = _record_set_from_CNAME - - _record_set_from_SPF = _record_set_from_A - - def _record_set_from_SRV(self, record): - return self.gcloud_zone.resource_record_set( - record.fqdn, record._type, record.ttl, [ - '{priority} {weight} {port} {target}' - .format(**v.data) for v in record.values]) - - def _record_set_from_TXT(self, record): - if 'values' in record.data: - val = record.data['values'] - else: - val = [record.data['value']] - - return self.gcloud_zone.resource_record_set( - record.fqdn, record._type, record.ttl, val) - - class GoogleCloudProvider(BaseProvider): """ Google Cloud DNS provider @@ -146,17 +76,20 @@ class GoogleCloudProvider(BaseProvider): for change in changes: class_name = change.__class__.__name__ + _rrset_func = getattr( + self, '_rrset_for_{}'.format(change.record._type)) + if class_name in 'Create': gcloud_changes.add_record_set( - self._record_to_record_set(gcloud_zone, change.record)) + _rrset_func(gcloud_zone, change.record)) elif class_name == 'Delete': gcloud_changes.delete_record_set( - self._record_to_record_set(gcloud_zone, change.record)) + _rrset_func(gcloud_zone, change.record)) elif class_name == 'Update': gcloud_changes.delete_record_set( - self._record_to_record_set(gcloud_zone, change.existing)) + _rrset_func(gcloud_zone, change.existing)) gcloud_changes.add_record_set( - self._record_to_record_set(gcloud_zone, change.new)) + _rrset_func(gcloud_zone, change.new)) else: raise RuntimeError('Change type "{}" for change "{!s}" ' 'is none of "Create", "Delete" or "Update' @@ -260,20 +193,6 @@ class GoogleCloudProvider(BaseProvider): if create: return self._create_gcloud_zone(dns_name) - @staticmethod - def _record_to_record_set(gcloud_zone, record): - """create google.cloud.dns.ResourceRecordSet from ocdodns.Record - - :param record: a record object - :type record: ocdodns.Record - :param gcloud_zone: a google gcloud zone - :type gcloud_zone: google.cloud.dns.ManagedZone - :type return: google.cloud.dns.ResourceRecordSet - """ - grm = _GoogleCloudRecordSetMaker(gcloud_zone, record) - - return grm.get_record_set() - def populate(self, zone, target=False, lenient=False): """Required function of manager.py to collect records from zone. @@ -373,3 +292,52 @@ class GoogleCloudProvider(BaseProvider): for v in [shlex.split(g) for g in gcloud_record.rrdatas]]} _data_for_TXT = _data_for_SPF + + def _rrset_for_A(self, gcloud_zone, record): + return gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, record.values) + + _rrset_for_AAAA = _rrset_for_A + + def _rrset_for_CAA(self, gcloud_zone, record): + return gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, [ + '{flags} {tag} {value}'.format(**record.data['value'])]) + + def _rrset_for_CNAME(self, gcloud_zone, record): + return gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, [record.value]) + + def _rrset_for_MX(self, gcloud_zone, record): + return gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, [ + '{preference} {exchange}'.format(**v.data) + for v in record.values]) + + def _rrset_for_NAPTR(self, gcloud_zone, record): + return gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, [ + '{order} {preference} "{flags}" "{service}" ' + '"{regexp}" {replacement}' + .format(**v.data) for v in record.values]) + + _rrset_for_NS = _rrset_for_A + + _rrset_for_PTR = _rrset_for_CNAME + + def _rrset_for_SPF(self, gcloud_zone, record): + if 'values' in record.data: + val = record.data['values'] + else: + val = [record.data['value']] + + return gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, val) + + def _rrset_for_SRV(self, gcloud_zone, record): + return gcloud_zone.resource_record_set( + record.fqdn, record._type, record.ttl, [ + '{priority} {weight} {port} {target}' + .format(**v.data) for v in record.values]) + + _rrset_for_TXT = _rrset_for_SPF diff --git a/tests/test_octodns_provider_googlecloud.py b/tests/test_octodns_provider_googlecloud.py index c7b93e3..76eedba 100644 --- a/tests/test_octodns_provider_googlecloud.py +++ b/tests/test_octodns_provider_googlecloud.py @@ -6,8 +6,7 @@ from __future__ import absolute_import, division, print_function, \ unicode_literals from octodns.record import Create, Delete, Update, Record -from octodns.provider.googlecloud import GoogleCloudProvider, \ - _GoogleCloudRecordSetMaker +from octodns.provider.googlecloud import GoogleCloudProvider from octodns.zone import Zone from octodns.provider.base import Plan, BaseProvider @@ -194,19 +193,6 @@ class DummyIterator: return self.iterable.next() -class TestGoogleCloudRecordSetMaker(TestCase): - def test_get_record_set(self): - mz = DummyGoogleCloudZone('unit.tests.') - record_sets = [] - for record in octo_records: - mm = _GoogleCloudRecordSetMaker(mz, record) - record_sets.append(mm.get_record_set()) - - self.assertEqual( - len(octo_records), - len(record_sets)) - - class TestGoogleCloudProvider(TestCase): @patch('octodns.provider.googlecloud.dns') def _get_provider(*args): @@ -304,6 +290,10 @@ class TestGoogleCloudProvider(TestCase): unsupported_change = Mock() unsupported_change.__len__ = Mock(return_value=1) + type_mock = Mock() + type_mock._type = "A" + unsupported_change.record = type_mock + mock_plan = Mock() type(mock_plan).desired = PropertyMock(return_value=DummyDesired( "dummy name", [])) @@ -312,13 +302,6 @@ class TestGoogleCloudProvider(TestCase): with self.assertRaises(RuntimeError): provider.apply(mock_plan) - def test__record_to_record_set(self): - provider = self._get_provider() - gcloud_zone = DummyGoogleCloudZone('unit.tests.') - for record in octo_records: - self.assertIsNotNone(provider._record_to_record_set( - gcloud_zone, record)) - def test__get_gcloud_client(self): provider = self._get_provider() @@ -404,6 +387,17 @@ class TestGoogleCloudProvider(TestCase): msg="Check that nonexistant zones return None when" "there's no create=True flag") + def test__get_rrsets(self): + provider = self._get_provider() + dummy_gcloud_zone = DummyGoogleCloudZone("unit.tests") + for octo_record in octo_records: + _rrset_func = getattr( + provider, '_rrset_for_{}'.format(octo_record._type)) + self.assertEqual( + _rrset_func(dummy_gcloud_zone, octo_record).record_type, + octo_record._type + ) + def test__create_zone(self): provider = self._get_provider() From aabab630030ba7ad17ff705b4e89d082c9b0f413 Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Sat, 7 Oct 2017 16:13:11 +0200 Subject: [PATCH 06/12] Refactor GoogleCloudProvider * in _rrset_for_X functions, use values instead of data attribute. * Small typo fixes and removals of redundant steps etc. * Unset GOOGLE_APPLICATION_CREDENTIALS in coverage script. --- octodns/provider/googlecloud.py | 34 ++++++++++------------ script/coverage | 1 + tests/test_octodns_provider_googlecloud.py | 12 ++++++-- 3 files changed, 26 insertions(+), 21 deletions(-) diff --git a/octodns/provider/googlecloud.py b/octodns/provider/googlecloud.py index 0f20587..103c3f5 100644 --- a/octodns/provider/googlecloud.py +++ b/octodns/provider/googlecloud.py @@ -79,7 +79,7 @@ class GoogleCloudProvider(BaseProvider): _rrset_func = getattr( self, '_rrset_for_{}'.format(change.record._type)) - if class_name in 'Create': + if class_name == 'Create': gcloud_changes.add_record_set( _rrset_func(gcloud_zone, change.record)) elif class_name == 'Delete': @@ -212,17 +212,16 @@ class GoogleCloudProvider(BaseProvider): gcloud_zone = self._get_gcloud_zone(zone.name) - _records = set() if gcloud_zone: for gcloud_record in self._get_gcloud_records(gcloud_zone): - if gcloud_record.record_type.upper() in self.SUPPORTS: - _records.add(gcloud_record) - for gcloud_record in _records: + if gcloud_record.record_type.upper() not in self.SUPPORTS: + continue + record_name = gcloud_record.name if record_name.endswith(zone.name): # google cloud always return fqdn. Make relative record # here. "root" records will then get the '' record_name, - # which is also the way dyn likes it. + # which is also the way octodns likes it. record_name = record_name[:-(len(zone.name) + 1)] typ = gcloud_record.record_type.upper() data = getattr(self, '_data_for_{}'.format(typ)) @@ -302,7 +301,8 @@ class GoogleCloudProvider(BaseProvider): def _rrset_for_CAA(self, gcloud_zone, record): return gcloud_zone.resource_record_set( record.fqdn, record._type, record.ttl, [ - '{flags} {tag} {value}'.format(**record.data['value'])]) + '{} {} {}'.format(v.flags, v.tag, v.value) + for v in record.values]) def _rrset_for_CNAME(self, gcloud_zone, record): return gcloud_zone.resource_record_set( @@ -311,33 +311,29 @@ class GoogleCloudProvider(BaseProvider): def _rrset_for_MX(self, gcloud_zone, record): return gcloud_zone.resource_record_set( record.fqdn, record._type, record.ttl, [ - '{preference} {exchange}'.format(**v.data) + '{} {}'.format(v.preference, v.exchange) for v in record.values]) def _rrset_for_NAPTR(self, gcloud_zone, record): return gcloud_zone.resource_record_set( record.fqdn, record._type, record.ttl, [ - '{order} {preference} "{flags}" "{service}" ' - '"{regexp}" {replacement}' - .format(**v.data) for v in record.values]) + '{} {} "{}" "{}" "{}" {}'.format( + v.order, v.preference, v.flags, v.service, + v.regexp, v.replacement) for v in record.values]) _rrset_for_NS = _rrset_for_A _rrset_for_PTR = _rrset_for_CNAME def _rrset_for_SPF(self, gcloud_zone, record): - if 'values' in record.data: - val = record.data['values'] - else: - val = [record.data['value']] - return gcloud_zone.resource_record_set( - record.fqdn, record._type, record.ttl, val) + record.fqdn, record._type, record.ttl, record.values) def _rrset_for_SRV(self, gcloud_zone, record): return gcloud_zone.resource_record_set( record.fqdn, record._type, record.ttl, [ - '{priority} {weight} {port} {target}' - .format(**v.data) for v in record.values]) + '{} {} {} {}' + .format(v.priority, v.weight, v.port, v.target) + for v in record.values]) _rrset_for_TXT = _rrset_for_SPF diff --git a/script/coverage b/script/coverage index ca5d693..228a772 100755 --- a/script/coverage +++ b/script/coverage @@ -24,6 +24,7 @@ export DNSIMPLE_TOKEN= export DYN_CUSTOMER= export DYN_PASSWORD= export DYN_USERNAME= +export GOOGLE_APPLICATION_CREDENTIALS= coverage run --branch --source=octodns `which nosetests` --with-xunit "$@" coverage html diff --git a/tests/test_octodns_provider_googlecloud.py b/tests/test_octodns_provider_googlecloud.py index 76eedba..b498d4c 100644 --- a/tests/test_octodns_provider_googlecloud.py +++ b/tests/test_octodns_provider_googlecloud.py @@ -313,8 +313,11 @@ class TestGoogleCloudProvider(TestCase): if not page_token: return DummyIterator([ DummyGoogleCloudZone('example.com.'), + ], page_token="MOCK_PAGE_TOKEN") + elif page_token == "MOCK_PAGE_TOKEN": + return DummyIterator([ DummyGoogleCloudZone('example2.com.'), - ], page_token="DUMMY_PAGE_TOKEN") + ], page_token="MOCK_PAGE_TOKEN2") return DummyIterator([ google_cloud_zone @@ -324,7 +327,12 @@ class TestGoogleCloudProvider(TestCase): if not page_token: return DummyIterator( [DummyResourceRecordSet(*v) for v in - resource_record_sets[:5]], page_token="DUMMY_PAGE_TOKEN") + resource_record_sets[:3]], page_token="MOCK_PAGE_TOKEN") + elif page_token == "MOCK_PAGE_TOKEN": + + return DummyIterator( + [DummyResourceRecordSet(*v) for v in + resource_record_sets[3:5]], page_token="MOCK_PAGE_TOKEN2") return DummyIterator( [DummyResourceRecordSet(*v) for v in resource_record_sets[5:]]) From 4b878b844660b85f9cd1a9cc364850060cb3ec3d Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Sat, 7 Oct 2017 19:31:23 +0200 Subject: [PATCH 07/12] Cache encountered zones in GoogleCloudProvider Cache googleclouds zones so that populate dont have to list all each time called. --- octodns/provider/googlecloud.py | 76 +++++++++++----------- tests/test_octodns_provider_googlecloud.py | 46 ++++++++----- 2 files changed, 68 insertions(+), 54 deletions(-) diff --git a/octodns/provider/googlecloud.py b/octodns/provider/googlecloud.py index 103c3f5..fb85744 100644 --- a/octodns/provider/googlecloud.py +++ b/octodns/provider/googlecloud.py @@ -53,6 +53,8 @@ class GoogleCloudProvider(BaseProvider): self.log = getLogger('GoogleCloudProvider[{}]'.format(id)) self.id = id + self._gcloud_zones = {} + super(GoogleCloudProvider, self).__init__(id, *args, **kwargs) def _apply(self, plan): @@ -70,7 +72,10 @@ class GoogleCloudProvider(BaseProvider): len(changes)) # Get gcloud zone, or create one if none existed before. - gcloud_zone = self._get_gcloud_zone(desired.name, create=True) + if desired.name not in self.gcloud_zones: + gcloud_zone = self._create_gcloud_zone(desired.name) + else: + gcloud_zone = self.gcloud_zones.get(desired.name) gcloud_changes = gcloud_zone.changes() @@ -117,13 +122,19 @@ class GoogleCloudProvider(BaseProvider): # and only contain lowercase letters, digits or dashes zone_name = re.sub("[^a-z0-9-]", "", dns_name[:-1].replace('.', "-")) - # make sure that the end result did not end up wo leading letter - if re.match('[^a-z]', zone_name[0]): - # I cannot think of a situation where a zone name derived from - # a domain name would'nt start with leading letter and thereby - # violate the constraint, however if such a situation is - # encountered, add a leading "a" here. - zone_name = "a%s" % zone_name + + # Check if there is another zone in google cloud which has the same + # name as the new one + while zone_name in [z.name for z in self.gcloud_zones.values()]: + # If there is a zone in google cloud alredy, then try suffixing the + # name with a -i where i is a number which keeps increasing until + # a free name has been reached. + m = re.match("^(.+)-([0-9]+$)", zone_name) + if m: + i = int(m.group(2)) + 1 + zone_name = "{}-{!s}".format(m.group(1), i) + else: + zone_name += "-2" gcloud_zone = self.gcloud_client.zone( name=zone_name, @@ -131,6 +142,9 @@ class GoogleCloudProvider(BaseProvider): ) gcloud_zone.create(client=self.gcloud_client) + # add this new zone to the list of zones. + self._gcloud_zones[gcloud_zone.dns_name] = gcloud_zone + self.log.info("Created zone %s. Fqdn %s." % (zone_name, dns_name)) @@ -159,39 +173,25 @@ class GoogleCloudProvider(BaseProvider): # yield from is in python 3 only. yield gcloud_record - def _get_gcloud_zone(self, dns_name, page_token=None, create=False): - """Return the ManagedZone which has has the matching dns_name, or - None if no such zone exist, unless create=True, then create a new - one and return it. + def _get_cloud_zones(self, page_token=None): + """Load all ManagedZones into the self._gcloud_zones dict which is + mapped with the dns_name as key. - :param dns_name: fqdn of dns name for zone to get. - :type dns_name: str - :param page_token: page token for the page to get - :type page_token: str - :param create: if true, create ManagedZone if it does not exist - already - - :type return: new google.cloud.dns.ManagedZone + :return: void """ - # Find the google name for the incoming zone + gcloud_zones = self.gcloud_client.list_zones(page_token=page_token) for gcloud_zone in gcloud_zones: - if gcloud_zone.dns_name == dns_name: - return gcloud_zone - else: - # Zone not found. Check if there are more results which could be - # retrieved by checking "next_page_token". - if gcloud_zones.next_page_token: - return self._get_gcloud_zone(dns_name, - gcloud_zones.next_page_token) - else: - # Nothing found, either return None or else create zone and - # return that one (if create=True) - self.log.debug('_get_gcloud_zone: zone name=%s, ' - 'was not found by %s.', - dns_name, self.gcloud_client) - if create: - return self._create_gcloud_zone(dns_name) + self._gcloud_zones[gcloud_zone.dns_name] = gcloud_zone + + if gcloud_zones.next_page_token: + self._get_cloud_zones(gcloud_zones.next_page_token) + + @property + def gcloud_zones(self): + if not self._gcloud_zones: + self._get_cloud_zones() + return self._gcloud_zones def populate(self, zone, target=False, lenient=False): """Required function of manager.py to collect records from zone. @@ -210,7 +210,7 @@ class GoogleCloudProvider(BaseProvider): target, lenient) before = len(zone.records) - gcloud_zone = self._get_gcloud_zone(zone.name) + gcloud_zone = self.gcloud_zones.get(zone.name) if gcloud_zone: for gcloud_record in self._get_gcloud_records(gcloud_zone): diff --git a/tests/test_octodns_provider_googlecloud.py b/tests/test_octodns_provider_googlecloud.py index b498d4c..fa667cc 100644 --- a/tests/test_octodns_provider_googlecloud.py +++ b/tests/test_octodns_provider_googlecloud.py @@ -164,8 +164,9 @@ class DummyResourceRecordSet: class DummyGoogleCloudZone: - def __init__(self, dns_name): + def __init__(self, dns_name, name=""): self.dns_name = dns_name + self.name = name def resource_record_set(self, *args): return DummyResourceRecordSet(*args) @@ -173,6 +174,9 @@ class DummyGoogleCloudZone: def list_resource_record_sets(self, *args): pass + def create(self, *args, **kwargs): + pass + class DummyIterator: """Returns a mock DummyIterator object to use in testing. @@ -239,7 +243,7 @@ class TestGoogleCloudProvider(TestCase): 'type': 'A', 'values': ['1.4.3.2']}) - gcloud_zone_mock = DummyGoogleCloudZone("unit.tests.") + gcloud_zone_mock = DummyGoogleCloudZone("unit.tests.", "unit-tests") status_mock = Mock() return_values_for_status = iter( ['', '', '', '', '', '', '', '', '', '', '', '', '', '', '', @@ -250,10 +254,9 @@ class TestGoogleCloudProvider(TestCase): provider = self._get_provider() provider.gcloud_client = Mock() - provider._get_gcloud_zone = Mock( - return_value=gcloud_zone_mock) + provider._gcloud_zones = {"unit.tests.": gcloud_zone_mock} desired = Mock() - desired.name = Mock(return_value="unit.tests.") + desired.name = "unit.tests." changes = [] changes.append(Create(create_r)) changes.append(Delete(delete_r)) @@ -343,7 +346,7 @@ class TestGoogleCloudProvider(TestCase): google_cloud_zone.list_resource_record_sets = Mock( side_effect=_get_mock_record_sets) - self.assertEqual(provider._get_gcloud_zone("unit.tests.").dns_name, + self.assertEqual(provider.gcloud_zones.get("unit.tests.").dns_name, "unit.tests.") test_zone = Zone('unit.tests.', []) @@ -374,8 +377,8 @@ class TestGoogleCloudProvider(TestCase): provider._get_gcloud_records = Mock( side_effect=[not_same_fqdn]) - provider._get_gcloud_zone = Mock(return_value=DummyGoogleCloudZone( - dns_name="unit.tests.")) + provider._gcloud_zones = { + "unit.tests.": DummyGoogleCloudZone("unit.tests.", "unit-tests")} provider.populate(test_zone) @@ -391,7 +394,7 @@ class TestGoogleCloudProvider(TestCase): provider.gcloud_client.list_zones = Mock( return_value=DummyIterator([])) - self.assertIsNone(provider._get_gcloud_zone("nonexistant.xone"), + self.assertIsNone(provider.gcloud_zones.get("nonexistant.xone"), msg="Check that nonexistant zones return None when" "there's no create=True flag") @@ -413,22 +416,33 @@ class TestGoogleCloudProvider(TestCase): provider.gcloud_client.list_zones = Mock( return_value=DummyIterator([])) - mock_zone = provider._get_gcloud_zone( - 'nonexistant.zone.mock', create=True) + mock_zone = provider._create_gcloud_zone("nonexistant.zone.mock") mock_zone.create.assert_called() provider.gcloud_client.zone.assert_called() provider.gcloud_client.zone.assert_called_once_with( dns_name=u'nonexistant.zone.mock', name=u'nonexistant-zone-moc') - def test__create_zone_with_numbers_in_name(self): + def test__create_zone_with_duplicate_names(self): + + def _create_dummy_zone(name, dns_name): + return DummyGoogleCloudZone(name=name, dns_name=dns_name) + provider = self._get_provider() provider.gcloud_client = Mock() + provider.gcloud_client.zone = Mock(side_effect=_create_dummy_zone) provider.gcloud_client.list_zones = Mock( return_value=DummyIterator([])) - provider._get_gcloud_zone( - '111.', create=True) - provider.gcloud_client.zone.assert_called_once_with( - dns_name=u'111.', name=u'a111') + _gcloud_zones = { + 'unit-tests': DummyGoogleCloudZone("a.unit-tests.", "unit-tests") + } + + provider._gcloud_zones = _gcloud_zones + + test_zone_1 = provider._create_gcloud_zone("unit.tests.") + self.assertEqual(test_zone_1.name, "unit-tests-2") + + test_zone_2 = provider._create_gcloud_zone("unit.tests.") + self.assertEqual(test_zone_2.name, "unit-tests-3") From e9d90bda2bd11ec740c73162c5af268183ea76fe Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Sat, 7 Oct 2017 20:46:35 +0200 Subject: [PATCH 08/12] Add timeout logic to googlecloud provider --- octodns/provider/googlecloud.py | 21 +++++++++++++++------ tests/test_octodns_provider_googlecloud.py | 13 ++++++++++--- 2 files changed, 25 insertions(+), 9 deletions(-) diff --git a/octodns/provider/googlecloud.py b/octodns/provider/googlecloud.py index fb85744..e339c74 100644 --- a/octodns/provider/googlecloud.py +++ b/octodns/provider/googlecloud.py @@ -40,6 +40,8 @@ class GoogleCloudProvider(BaseProvider): 'NS', 'PTR', 'SPF', 'SRV', 'TXT')) SUPPORTS_GEO = False + CHANGE_LOOP_WAIT = 5 + def __init__(self, id, project=None, credentials_file=None, *args, **kwargs): @@ -101,13 +103,20 @@ class GoogleCloudProvider(BaseProvider): .format(class_name, change)) gcloud_changes.create() - i = 1 - while gcloud_changes.status != 'done': - self.log.debug("Waiting for changes to complete") - time.sleep(i) + + for i in range(120): gcloud_changes.reload() - if i < 30: - i += 2 + self.log.debug("Waiting for changes to complete") + # https://cloud.google.com/dns/api/v1/changes#resource + # status can be one of either "pending" or "done" + if gcloud_changes.status != 'pending': + break + self.log.debug("Waiting for changes to complete") + time.sleep(self.CHANGE_LOOP_WAIT) + + if gcloud_changes.status != 'done': + raise RuntimeError("Timeout reached after {} seconds".format( + i * self.CHANGE_LOOP_WAIT)) def _create_gcloud_zone(self, dns_name): """Creates a google cloud ManagedZone with dns_name, and zone named diff --git a/tests/test_octodns_provider_googlecloud.py b/tests/test_octodns_provider_googlecloud.py index fa667cc..c2e976c 100644 --- a/tests/test_octodns_provider_googlecloud.py +++ b/tests/test_octodns_provider_googlecloud.py @@ -206,7 +206,6 @@ class TestGoogleCloudProvider(TestCase): ''' return GoogleCloudProvider(id=1, project="mock") - @patch('octodns.provider.googlecloud.time.sleep') @patch('octodns.provider.googlecloud.dns') def test___init__(self, *_): self.assertIsInstance(GoogleCloudProvider(id=1, @@ -246,8 +245,7 @@ class TestGoogleCloudProvider(TestCase): gcloud_zone_mock = DummyGoogleCloudZone("unit.tests.", "unit-tests") status_mock = Mock() return_values_for_status = iter( - ['', '', '', '', '', '', '', '', '', '', '', '', '', '', '', - '', '', '', 'done']) + ["pending"] * 11 + ['done', 'done']) type(status_mock).status = PropertyMock( side_effect=return_values_for_status.next) gcloud_zone_mock.changes = Mock(return_value=status_mock) @@ -291,6 +289,15 @@ class TestGoogleCloudProvider(TestCase): 'aa.unit.tests.', 'A', 9001, ['1.2.4.3']) ]) + type(status_mock).status = "pending" + + with self.assertRaises(RuntimeError): + provider.apply(Plan( + existing=[update_existing_r, delete_r], + desired=desired, + changes=changes + )) + unsupported_change = Mock() unsupported_change.__len__ = Mock(return_value=1) type_mock = Mock() From ea1871a326d04243b6f632daa588e3bf15384e8f Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Sat, 7 Oct 2017 20:50:49 +0200 Subject: [PATCH 09/12] Add GoogleCloudProvider to README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index afe92ac..a910b5b 100644 --- a/README.md +++ b/README.md @@ -153,6 +153,7 @@ The above command pulled the existing data out of Route53 and placed the results | [CloudflareProvider](/octodns/provider/cloudflare.py) | A, AAAA, CAA, CNAME, MX, NS, SPF, TXT | No | CAA tags restricted | | [DnsimpleProvider](/octodns/provider/dnsimple.py) | All | No | CAA tags restricted | | [DynProvider](/octodns/provider/dyn.py) | All | Yes | | +| [GoogleCloudProvider](/octodns/provider/googlecloud.py) | A, AAAA, CAA, CNAME, MX, NAPTR, NS, PTR, SPF, SRV, TXT | No | | | [Ns1Provider](/octodns/provider/ns1.py) | All | No | | | [OVH](/octodns/provider/ovh.py) | A, AAAA, CNAME, MX, NAPTR, NS, PTR, SPF, SRV, SSHFP, TXT | No | | | [PowerDnsProvider](/octodns/provider/powerdns.py) | All | No | | From f50db5e02b54c8c54aaedee6411d9f94b495aec6 Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Mon, 9 Oct 2017 20:03:01 +0200 Subject: [PATCH 10/12] Use chunked_values in GoogleCloudProvider --- octodns/provider/googlecloud.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/octodns/provider/googlecloud.py b/octodns/provider/googlecloud.py index e339c74..c544d63 100644 --- a/octodns/provider/googlecloud.py +++ b/octodns/provider/googlecloud.py @@ -336,7 +336,7 @@ class GoogleCloudProvider(BaseProvider): def _rrset_for_SPF(self, gcloud_zone, record): return gcloud_zone.resource_record_set( - record.fqdn, record._type, record.ttl, record.values) + record.fqdn, record._type, record.ttl, record.chunked_values) def _rrset_for_SRV(self, gcloud_zone, record): return gcloud_zone.resource_record_set( From f45ff51062ef5377c4c9b01edb0098e5dc0a78eb Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Sat, 14 Oct 2017 08:06:06 +0200 Subject: [PATCH 11/12] Fix various logging lines in GoogleCloudProvider. --- octodns/provider/googlecloud.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/octodns/provider/googlecloud.py b/octodns/provider/googlecloud.py index c544d63..370c750 100644 --- a/octodns/provider/googlecloud.py +++ b/octodns/provider/googlecloud.py @@ -106,7 +106,6 @@ class GoogleCloudProvider(BaseProvider): for i in range(120): gcloud_changes.reload() - self.log.debug("Waiting for changes to complete") # https://cloud.google.com/dns/api/v1/changes#resource # status can be one of either "pending" or "done" if gcloud_changes.status != 'pending': @@ -154,8 +153,7 @@ class GoogleCloudProvider(BaseProvider): # add this new zone to the list of zones. self._gcloud_zones[gcloud_zone.dns_name] = gcloud_zone - self.log.info("Created zone %s. Fqdn %s." % - (zone_name, dns_name)) + self.log.info("Created zone {}. Fqdn {}.".format(zone_name, dns_name)) return gcloud_zone From 7958618f63a3ecf541a228061b901ba6b02e34d9 Mon Sep 17 00:00:00 2001 From: Petter Hassberg Date: Sat, 14 Oct 2017 19:32:24 +0200 Subject: [PATCH 12/12] Use uuid4 for zone name in GoogleCloudProvider use uuid4().hex to ensure unique zone_name generation and thereby streamline with the other providers. --- octodns/provider/googlecloud.py | 19 +++------------- tests/test_octodns_provider_googlecloud.py | 26 ---------------------- 2 files changed, 3 insertions(+), 42 deletions(-) diff --git a/octodns/provider/googlecloud.py b/octodns/provider/googlecloud.py index 370c750..6ca0794 100644 --- a/octodns/provider/googlecloud.py +++ b/octodns/provider/googlecloud.py @@ -5,10 +5,10 @@ from __future__ import absolute_import, division, print_function, \ unicode_literals -import re import shlex import time from logging import getLogger +from uuid import uuid4 from google.cloud import dns @@ -128,21 +128,8 @@ class GoogleCloudProvider(BaseProvider): """ # Zone name must begin with a letter, end with a letter or digit, # and only contain lowercase letters, digits or dashes - zone_name = re.sub("[^a-z0-9-]", "", - dns_name[:-1].replace('.', "-")) - - # Check if there is another zone in google cloud which has the same - # name as the new one - while zone_name in [z.name for z in self.gcloud_zones.values()]: - # If there is a zone in google cloud alredy, then try suffixing the - # name with a -i where i is a number which keeps increasing until - # a free name has been reached. - m = re.match("^(.+)-([0-9]+$)", zone_name) - if m: - i = int(m.group(2)) + 1 - zone_name = "{}-{!s}".format(m.group(1), i) - else: - zone_name += "-2" + zone_name = '{}-{}'.format( + dns_name[:-1].replace('.', '-'), uuid4().hex) gcloud_zone = self.gcloud_client.zone( name=zone_name, diff --git a/tests/test_octodns_provider_googlecloud.py b/tests/test_octodns_provider_googlecloud.py index c2e976c..adc2112 100644 --- a/tests/test_octodns_provider_googlecloud.py +++ b/tests/test_octodns_provider_googlecloud.py @@ -427,29 +427,3 @@ class TestGoogleCloudProvider(TestCase): mock_zone.create.assert_called() provider.gcloud_client.zone.assert_called() - provider.gcloud_client.zone.assert_called_once_with( - dns_name=u'nonexistant.zone.mock', name=u'nonexistant-zone-moc') - - def test__create_zone_with_duplicate_names(self): - - def _create_dummy_zone(name, dns_name): - return DummyGoogleCloudZone(name=name, dns_name=dns_name) - - provider = self._get_provider() - - provider.gcloud_client = Mock() - provider.gcloud_client.zone = Mock(side_effect=_create_dummy_zone) - provider.gcloud_client.list_zones = Mock( - return_value=DummyIterator([])) - - _gcloud_zones = { - 'unit-tests': DummyGoogleCloudZone("a.unit-tests.", "unit-tests") - } - - provider._gcloud_zones = _gcloud_zones - - test_zone_1 = provider._create_gcloud_zone("unit.tests.") - self.assertEqual(test_zone_1.name, "unit-tests-2") - - test_zone_2 = provider._create_gcloud_zone("unit.tests.") - self.assertEqual(test_zone_2.name, "unit-tests-3")