mirror/github-octodns
1
0
Fork 0
mirror of https://github.com/github/octodns.git synced 2024-05-11 05:55:00 +00:00
Code Issues Releases Activity

Constellix provider full Dynamic support added

Browse Source
This commit is contained in:
apatserkovskyi
2021-09-02 00:01:44 +03:00
parent c55264e657
commit 52da08dfec
6 changed files with 1213 additions and 168 deletions
Download Patch File Download Diff File Expand all files Collapse all files

703
tests/test_octodns_provider_constellix.py
View File

@@ -42,17 +42,11 @@ class TestConstellixProvider(TestCase):
'value': 'aname.unit.tests.'
}))
expected.add_record(Record.new(expected, 'sub', {
'ttl': 1800,
'type': 'ALIAS',
'value': 'aname.unit.tests.'
}))
# Add a dynamic record
expected.add_record(Record.new(expected, 'www.dynamic', {
'ttl': 300,
'type': 'A',
'value': [
'values': [
'1.2.3.4',
'1.2.3.5'
],
@@ -79,6 +73,78 @@ class TestConstellixProvider(TestCase):
expected._remove_record(record)
break
expected_dynamic = Zone('unit.tests.', [])
source = YamlProvider('test', join(dirname(__file__), 'config'))
source.populate(expected_dynamic)
# Our test suite differs a bit, add our NS and remove the simple one
expected_dynamic.add_record(Record.new(expected_dynamic, 'under', {
'ttl': 3600,
'type': 'NS',
'values': [
'ns1.unit.tests.',
'ns2.unit.tests.',
]
}))
# Add some ALIAS records
expected_dynamic.add_record(Record.new(expected_dynamic, '', {
'ttl': 1800,
'type': 'ALIAS',
'value': 'aname.unit.tests.'
}))
# Add a dynamic record
expected_dynamic.add_record(Record.new(expected_dynamic, 'www.dynamic', {
'ttl': 300,
'type': 'A',
'values': [
'1.2.3.4',
'1.2.3.5'
],
'dynamic': {
'pools': {
'one': {
'fallback': 'two',
'values': [{
'value': '1.2.3.6',
'weight': 1
}, {
'value': '1.2.3.7',
'weight': 1
}],
},
'two': {
'values': [{
'value': '1.2.3.4',
'weight': 1
}, {
'value': '1.2.3.5',
'weight': 1
}],
},
},
'rules': [{
'geos': [
'AS',
'EU-ES',
'EU-UA',
'EU-SE',
'NA-CA-NL',
'OC'
],
'pool': 'one'
}, {
'pool': 'two',
}],
}
}))
for record in list(expected_dynamic.records):
if record.name == 'sub' and record._type == 'NS':
expected_dynamic._remove_record(record)
break
def test_populate(self):
provider = ConstellixProvider('test', 'api', 'secret')
@@ -126,24 +192,28 @@ class TestConstellixProvider(TestCase):
with requests_mock() as mock:
base = 'https://api.dns.constellix.com/v1'
with open('tests/fixtures/constellix-domains.json') as fh:
mock.get('{}{}'.format(base, '/domains'), text=fh.read())
mock.get('{}{}'.format(base, '/domains'),
text=fh.read())
with open('tests/fixtures/constellix-records.json') as fh:
mock.get('{}{}'.format(base, '/domains/123123/records'),
text=fh.read())
with open('tests/fixtures/constellix-pools.json') as fh:
mock.get('{}{}'.format(base, '/pools/A'),
text=fh.read())
with open('tests/fixtures/constellix-geofilters.json') as fh:
mock.get('{}{}'.format(base, '/geoFilters'),
text=fh.read())
zone = Zone('unit.tests.', [])
provider.populate(zone)
self.assertEquals(16, len(zone.records))
changes = self.expected.changes(zone, provider)
self.assertEquals(17, len(zone.records))
changes = self.expected_dynamic.changes(zone, provider)
self.assertEquals(0, len(changes))
# 2nd populate makes no network calls/all from cache
again = Zone('unit.tests.', [])
provider.populate(again)
self.assertEquals(16, len(again.records))
self.assertEquals(17, len(again.records))
# bust the cache
del provider._zone_records[zone.name]
@@ -225,7 +295,7 @@ class TestConstellixProvider(TestCase):
}),
])
self.assertEquals(21, provider._client._request.call_count)
self.assertEquals(22, provider._client._request.call_count)
provider._client._request.reset_mock()
@@ -262,6 +332,7 @@ class TestConstellixProvider(TestCase):
"id": 1808520,
"type": "A",
"name": "www.dynamic",
"geolocation": None,
"recordOption": "pools",
"ttl": 300,
"value": [],
@@ -289,8 +360,16 @@ class TestConstellixProvider(TestCase):
# Domain exists, we don't care about return
resp.json.side_effect = [
['{}'],
['{}'],
[], # no domains returned during populate
[{
'id': 123123,
'name': 'unit.tests'
}], # domain created in apply
[], # No pools returned during populate
[{
"id": 1808521,
"name": "unit.tests.:www.dynamic:A:one"
}] # pool created in apply
]
wanted = Zone('unit.tests.', [])
@@ -303,7 +382,7 @@ class TestConstellixProvider(TestCase):
wanted.add_record(Record.new(wanted, 'www.dynamic', {
'ttl': 300,
'type': 'A',
'value': [
'values': [
'1.2.3.4'
],
'dynamic': {
@@ -340,17 +419,393 @@ class TestConstellixProvider(TestCase):
'numReturn': 1,
'minAvailableFailover': 1,
'ttl': 300,
'id': 1808521,
'values': [{
"value": "1.2.3.4",
"weight": 1
}]
}],
'id': 1808521,
'geofilter': 1
}),
call('DELETE', '/domains/123123/records/A/11189897'),
call('DELETE', '/domains/123123/records/A/11189898'),
call('DELETE', '/domains/123123/records/ANAME/11189899'),
], any_order=True)
def test_apply_dunamic(self):
provider = ConstellixProvider('test', 'api', 'secret')
resp = Mock()
resp.json = Mock()
provider._client._request = Mock(return_value=resp)
# non-existent domain, create everything
resp.json.side_effect = [
[], # no domains returned during populate
[{
'id': 123123,
'name': 'unit.tests'
}], # domain created in apply
[], # No pools returned during populate
[{
"id": 1808521,
"name": "unit.tests.:www.dynamic:A:one"
}], # pool created in apply
[], # no geofilters returned during populate
[{
"id": 5303,
"name": "unit.tests.:www.dynamic:A:one",
"filterRulesLimit": 100,
"geoipContinents": ["AS", "OC"],
"geoipCountries": ["ES", "SE", "UA"],
"regions": [
{
"continentCode": "NA",
"countryCode": "CA",
"regionCode": "NL"
}
]
}], # geofilters created in applly
[{
"id": 1808520,
"name": "unit.tests.:www.dynamic:A:two",
}], # pool created in apply
{
'id': 123123,
'name': 'unit.tests',
'hasGeoIP': False
}, # domain listed for enabling geo
[] # enabling geo
]
plan = provider.plan(self.expected_dynamic)
# No root NS, no ignored, no excluded, no unsupported
n = len(self.expected_dynamic.records) - 8
self.assertEquals(n, len(plan.changes))
self.assertEquals(n, provider.apply(plan))
provider._client._request.assert_has_calls([
# get all domains to build the cache
call('GET', '/domains'),
# created the domain
call('POST', '/domains', data={'names': ['unit.tests']})
])
#
# Check we tried to get our pool
provider._client._request.assert_has_calls([
call('GET', '/pools/A'),
call('POST', '/pools/A', data={
'name': 'unit.tests.:www.dynamic:A:one',
'type': 'A',
'numReturn': 1,
'minAvailableFailover': 1,
'ttl': 300,
'values': [{
'value': '1.2.3.6',
'weight': 1
}, {
'value': '1.2.3.7',
'weight': 1}]
}),
call('GET', '/geoFilters'),
call('POST', '/geoFilters', data={
'filterRulesLimit': 100,
'name': 'unit.tests.:www.dynamic:A:one',
'geoipContinents': ['AS', 'OC'],
'geoipCountries': ['ES', 'SE', 'UA'],
'regions': [{
'continentCode': 'NA',
'countryCode': 'CA',
'regionCode': 'NL'}]
}),
call('POST', '/pools/A', data={
'name': 'unit.tests.:www.dynamic:A:two',
'type': 'A',
'numReturn': 1,
'minAvailableFailover': 1,
'ttl': 300,
'values': [{
'value': '1.2.3.4',
'weight': 1
}, {
'value': '1.2.3.5',
'weight': 1}]
})
])
# These two checks are broken up so that ordering doesn't break things.
# Python3 doesn't make the calls in a consistent order so different
# things follow the GET / on different runs
provider._client._request.assert_has_calls([
call('POST', '/domains/123123/records/SRV', data={
'roundRobin': [{
'priority': 10,
'weight': 20,
'value': 'foo-1.unit.tests.',
'port': 30
}, {
'priority': 12,
'weight': 20,
'value': 'foo-2.unit.tests.',
'port': 30
}],
'name': '_srv._tcp',
'ttl': 600,
}),
])
self.assertEquals(28, provider._client._request.call_count)
provider._client._request.reset_mock()
provider._client.records = Mock(return_value=[
{
'id': 11189897,
'type': 'A',
'name': 'www',
'ttl': 300,
'recordOption': 'roundRobin',
'value': [
'1.2.3.4',
'2.2.3.4',
]
}, {
'id': 11189898,
'type': 'A',
'name': 'ttl',
'ttl': 600,
'recordOption': 'roundRobin',
'value': [
'3.2.3.4'
]
}, {
'id': 11189899,
'type': 'ALIAS',
'name': 'alias',
'ttl': 600,
'recordOption': 'roundRobin',
'value': [{
'value': 'aname.unit.tests.'
}]
}, {
"id": 1808520,
"type": "A",
"name": "www.dynamic",
"geolocation": {
"geoipFilter": 1
},
"recordOption": "pools",
"ttl": 300,
"value": [],
"pools": [
1808521
]
}, {
"id": 1808521,
"type": "A",
"name": "www.dynamic",
"geolocation": {
"geoipFilter": 5303
},
"recordOption": "pools",
"ttl": 300,
"value": [],
"pools": [
1808522
]
}
])
provider._client.pools = Mock(return_value=[
{
"id": 1808521,
"name": "unit.tests.:www.dynamic:A:two",
"type": "A",
"values": [
{
"value": "1.2.3.4",
"weight": 1
},
{
"value": "1.2.3.5",
"weight": 1
}
]
},
{
"id": 1808522,
"name": "unit.tests.:www.dynamic:A:one",
"type": "A",
"values": [
{
"value": "1.2.3.6",
"weight": 1
},
{
"value": "1.2.3.7",
"weight": 1
}
]
}
])
provider._client.geofilters = Mock(return_value=[
{
"id": 5303,
"name": "unit.tests.:www.dynamic:A:one",
"filterRulesLimit": 100,
"geoipContinents": ["AS", "OC"],
"geoipCountries": ["ES", "SE", "UA"],
"regions": [
{
"continentCode": "NA",
"countryCode": "CA",
"regionCode": "NL"
}
]
}
])
# Domain exists, we don't care about return
resp.json.side_effect = [
[],
[],
[],
[],
{
'id': 123123,
'name': 'unit.tests',
'hasGeoIP': True
} # domain listed for enabling geo
]
wanted = Zone('unit.tests.', [])
wanted.add_record(Record.new(wanted, 'ttl', {
'ttl': 300,
'type': 'A',
'value': '3.2.3.4'
}))
wanted.add_record(Record.new(wanted, 'www.dynamic', {
'ttl': 300,
'type': 'A',
'values': [
'1.2.3.4'
],
'dynamic': {
'pools': {
'one': {
'fallback': 'two',
'values': [{
'value': '1.2.3.6',
'weight': 1
}, {
'value': '1.2.3.7',
'weight': 1
}],
},
'two': {
'values': [{
'value': '1.2.3.4',
'weight': 1
}],
},
},
'rules': [{
'geos': [
'AS',
'EU-ES',
'EU-UA',
'EU-SE',
'NA-CA-NL',
'OC'
],
'pool': 'one'
}, {
'pool': 'two',
}],
},
}))
plan = provider.plan(wanted)
self.assertEquals(4, len(plan.changes))
self.assertEquals(4, provider.apply(plan))
# recreate for update, and deletes for the 2 parts of the other
provider._client._request.assert_has_calls([
call('POST', '/domains/123123/records/A', data={
'roundRobin': [{
'value': '3.2.3.4'
}],
'name': 'ttl',
'ttl': 300
}),
call('DELETE', '/domains/123123/records/A/1808521'),
call('DELETE', '/geoFilters/5303'),
call('DELETE', '/pools/A/1808522'),
call('DELETE', '/domains/123123/records/A/1808520'),
call('DELETE', '/pools/A/1808521'),
call('DELETE', '/domains/123123/records/ANAME/11189899'),
call('PUT', '/pools/A/1808522', data={
'name': 'unit.tests.:www.dynamic:A:one',
'type': 'A',
'numReturn': 1,
'minAvailableFailover': 1,
'ttl': 300,
'values': [
{'value': '1.2.3.6', 'weight': 1},
{'value': '1.2.3.7', 'weight': 1}],
'id': 1808522,
'geofilter': 5303
}),
call('PUT', '/geoFilters/5303', data={
'filterRulesLimit': 100,
'name': 'unit.tests.:www.dynamic:A:one',
'geoipContinents': ['AS', 'OC'],
'geoipCountries': ['ES', 'SE', 'UA'],
'regions': [{
'continentCode': 'NA',
'countryCode': 'CA',
'regionCode': 'NL'}],
'id': 5303
}),
call('PUT', '/pools/A/1808521', data={
'name': 'unit.tests.:www.dynamic:A:two',
'type': 'A',
'numReturn': 1,
'minAvailableFailover': 1,
'ttl': 300,
'values': [{'value': '1.2.3.4', 'weight': 1}],
'id': 1808521,
'geofilter': 1
}),
call('GET', '/domains/123123'),
call('POST', '/domains/123123/records/A', data={
'name': 'www.dynamic',
'ttl': 300,
'pools': [1808522],
'recordOption': 'pools',
'geolocation': {
'geoipUserRegion': [5303]
}
}),
call('POST', '/domains/123123/records/A', data={
'name': 'www.dynamic',
'ttl': 300,
'pools': [1808522],
'recordOption': 'pools',
'geolocation': {
'geoipUserRegion': [5303]
}
})
], any_order=True)
def test_dynamic_record_failures(self):
provider = ConstellixProvider('test', 'api', 'secret')
@@ -367,6 +822,7 @@ class TestConstellixProvider(TestCase):
"id": 1808520,
"type": "A",
"name": "www.dynamic",
"geolocation": None,
"recordOption": "pools",
"ttl": 300,
"value": [],
@@ -388,6 +844,8 @@ class TestConstellixProvider(TestCase):
]
}])
provider._client.geofilters = Mock(return_value=[])
wanted = Zone('unit.tests.', [])
resp.json.side_effect = [
@@ -397,7 +855,7 @@ class TestConstellixProvider(TestCase):
wanted.add_record(Record.new(wanted, 'www.dynamic', {
'ttl': 300,
'type': 'A',
'value': [
'values': [
'1.2.3.4'
],
'dynamic': {
@@ -428,44 +886,133 @@ class TestConstellixProvider(TestCase):
"id": 1808520,
"type": "A",
"name": "www.dynamic",
"geolocation": {
"geoipFilter": 1
},
"recordOption": "pools",
"ttl": 300,
"value": [],
"pools": [
1808521
]
}, {
"id": 1808521,
"type": "A",
"name": "www.dynamic",
"geolocation": {
"geoipFilter": 5303
},
"recordOption": "pools",
"ttl": 300,
"value": [],
"pools": [
1808522
]
}
])
provider._client.pools = Mock(return_value=[{
"id": 1808521,
"name": "unit.tests.:www.dynamic:A:two",
"type": "A",
"values": [
{
"value": "1.2.3.4",
"weight": 1
}
]
}])
provider._client.pools = Mock(return_value=[
{
"id": 1808521,
"name": "unit.tests.:www.dynamic:A:two",
"type": "A",
"values": [
{
"value": "1.2.3.4",
"weight": 1
},
{
"value": "1.2.3.5",
"weight": 1
}
]
},
{
"id": 1808522,
"name": "unit.tests.:www.dynamic:A:one",
"type": "A",
"values": [
{
"value": "1.2.3.6",
"weight": 1
},
{
"value": "1.2.3.7",
"weight": 1
}
]
}
])
provider._client.geofilters = Mock(return_value=[
{
"id": 6303,
"name": "some.other",
"filterRulesLimit": 100,
"createdTs": "2021-08-19T14:47:47Z",
"modifiedTs": "2021-08-19T14:47:47Z",
"geoipContinents": ["AS", "OC"],
"geoipCountries": ["ES", "SE", "UA"],
"regions": [
{
"continentCode": "NA",
"countryCode": "CA",
"regionCode": "NL"
}
]
}, {
"id": 5303,
"name": "unit.tests.:www.dynamic:A:one",
"filterRulesLimit": 100,
"geoipContinents": ["AS", "OC"],
"geoipCountries": ["ES", "SE", "UA"],
"regions": [
{
"continentCode": "NA",
"countryCode": "CA",
"regionCode": "NL"
}
]
}
])
wanted = Zone('unit.tests.', [])
wanted.add_record(Record.new(wanted, 'www.dynamic', {
'ttl': 300,
'type': 'A',
'value': [
'values': [
'1.2.3.4'
],
'dynamic': {
'pools': {
'one': {
'fallback': 'two',
'values': [{
'value': '1.2.3.6',
'weight': 1
}, {
'value': '1.2.3.7',
'weight': 1
}],
},
'two': {
'values': [{
'value': '1.2.3.5'
'value': '1.2.3.4',
'weight': 1
}],
},
},
'rules': [{
'geos': [
'AS',
'EU-ES',
'EU-UA',
'EU-SE',
'OC'
],
'pool': 'one'
}, {
'pool': 'two',
}],
},
@@ -473,13 +1020,25 @@ class TestConstellixProvider(TestCase):
# Try an error we can handle
with requests_mock() as mock:
mock.get(ANY, status_code=200,
text='{}')
mock.get(
"https://api.dns.constellix.com/v1/domains",
status_code=200,
text='[{"id": 1234, "name": "unit.tests", "hasGeoIP": true}]')
mock.get(
"https://api.dns.constellix.com/v1/domains/1234",
status_code=200,
text='{"id": 1234, "name": "unit.tests", "hasGeoIP": true}')
mock.delete(ANY, status_code=200,
text='{}')
mock.put("https://api.dns.constellix.com/v1/pools/A/1808521",
status_code=400,
text='{"errors": [\"no changes to save\"]}')
mock.put("https://api.dns.constellix.com/v1/pools/A/1808522",
status_code=400,
text='{"errors": [\"no changes to save\"]}')
mock.put("https://api.dns.constellix.com/v1/geoFilters/5303",
status_code=400,
text='{"errors": [\"no changes to save\"]}')
mock.post(ANY, status_code=200,
text='[{"id": 1234}]')
@@ -487,13 +1046,87 @@ class TestConstellixProvider(TestCase):
self.assertEquals(1, len(plan.changes))
self.assertEquals(1, provider.apply(plan))
provider._client.geofilters = Mock(return_value=[
{
"id": 5303,
"name": "unit.tests.:www.dynamic:A:one",
"filterRulesLimit": 100,
"regions": [
{
"continentCode": "NA",
"countryCode": "CA",
"regionCode": "NL"
}
]
}
])
plan = provider.plan(wanted)
self.assertEquals(1, len(plan.changes))
self.assertEquals(1, provider.apply(plan))
provider._client.geofilters = Mock(return_value=[
{
"id": 5303,
"name": "unit.tests.:www.dynamic:A:one",
"filterRulesLimit": 100,
"geoipContinents": ["AS", "OC"],
}
])
plan = provider.plan(wanted)
self.assertEquals(1, len(plan.changes))
self.assertEquals(1, provider.apply(plan))
# Now what happens if an error happens that we can't handle
# geofilter case
with requests_mock() as mock:
mock.get(ANY, status_code=200,
text='{}')
mock.get(
"https://api.dns.constellix.com/v1/domains",
status_code=200,
text='[{"id": 1234, "name": "unit.tests", "hasGeoIP": true}]')
mock.get(
"https://api.dns.constellix.com/v1/domains/1234",
status_code=200,
text='{"id": 1234, "name": "unit.tests", "hasGeoIP": true}')
mock.delete(ANY, status_code=200,
text='{}')
mock.put("https://api.dns.constellix.com/v1/pools/A/1808521",
status_code=400,
text='{"errors": [\"no changes to save\"]}')
mock.put("https://api.dns.constellix.com/v1/pools/A/1808522",
status_code=400,
text='{"errors": [\"no changes to save\"]}')
mock.put("https://api.dns.constellix.com/v1/geoFilters/5303",
status_code=400,
text='{"errors": [\"generic error\"]}')
mock.post(ANY, status_code=200,
text='[{"id": 1234}]')
plan = provider.plan(wanted)
self.assertEquals(1, len(plan.changes))
with self.assertRaises(ConstellixClientBadRequest):
provider.apply(plan)
# Now what happens if an error happens that we can't handle
with requests_mock() as mock:
mock.get(
"https://api.dns.constellix.com/v1/domains",
status_code=200,
text='[{"id": 1234, "name": "unit.tests", "hasGeoIP": true}]')
mock.get(
"https://api.dns.constellix.com/v1/domains/1234",
status_code=200,
text='{"id": 1234, "name": "unit.tests", "hasGeoIP": true}')
mock.delete(ANY, status_code=200,
text='{}')
mock.put("https://api.dns.constellix.com/v1/pools/A/1808521",
status_code=400,
text='{"errors": [\"generic error\"]}')
mock.put("https://api.dns.constellix.com/v1/pools/A/1808522",
status_code=400,
text='{"errors": [\"generic error\"]}')
mock.put("https://api.dns.constellix.com/v1/geoFilters/5303",
status_code=400,
text='{"errors": [\"generic error\"]}')
mock.post(ANY, status_code=200,