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

add Constellix Provider

This commit is contained in:
Adam Smith
2019-07-29 23:12:27 -07:00
parent 5db2f2e6f6
commit c0315d25ba
5 changed files with 1292 additions and 0 deletions

28
tests/fixtures/constellix-domains.json vendored Normal file
View File

@@ -0,0 +1,28 @@
[{
"id": 123123,
"name": "unit.tests",
"soa": {
"primaryNameserver": "ns11.constellix.com.",
"email": "dns.constellix.com.",
"ttl": 86400,
"serial": 2015010102,
"refresh": 43200,
"retry": 3600,
"expire": 1209600,
"negCache": 180
},
"createdTs": "2019-08-07T03:36:02Z",
"modifiedTs": "2019-08-07T03:36:02Z",
"typeId": 1,
"domainTags": [],
"folder": null,
"hasGtdRegions": false,
"hasGeoIP": false,
"nameserverGroup": 1,
"nameservers": ["ns11.constellix.com.", "ns21.constellix.com.", "ns31.constellix.com.", "ns41.constellix.net.", "ns51.constellix.net.", "ns61.constellix.net."],
"note": "",
"version": 0,
"status": "ACTIVE",
"tags": [],
"contactIds": []
}]

598
tests/fixtures/constellix-records.json vendored Normal file
View File

@@ -0,0 +1,598 @@
[{
"id": 1808529,
"type": "CAA",
"recordType": "caa",
"name": "",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 3600,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565149569216,
"value": [{
"flag": 0,
"tag": "issue",
"data": "ca.unit.tests",
"caaProviderId": 1,
"disableFlag": false
}],
"roundRobin": [{
"flag": 0,
"tag": "issue",
"data": "ca.unit.tests",
"caaProviderId": 1,
"disableFlag": false
}]
}, {
"id": 1808516,
"type": "A",
"recordType": "a",
"name": "",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 300,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565149623640,
"value": ["1.2.3.4", "1.2.3.5"],
"roundRobin": [{
"value": "1.2.3.4",
"disableFlag": false
}, {
"value": "1.2.3.5",
"disableFlag": false
}],
"geolocation": null,
"recordFailover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"failover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"roundRobinFailover": [],
"pools": [],
"poolsDetail": []
}, {
"id": 1808527,
"type": "SRV",
"recordType": "srv",
"name": "_srv._tcp",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 600,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565149714387,
"value": [{
"value": "foo-1.unit.tests.",
"priority": 10,
"weight": 20,
"port": 30,
"disableFlag": false
}, {
"value": "foo-2.unit.tests.",
"priority": 12,
"weight": 20,
"port": 30,
"disableFlag": false
}],
"roundRobin": [{
"value": "foo-1.unit.tests.",
"priority": 10,
"weight": 20,
"port": 30,
"disableFlag": false
}, {
"value": "foo-2.unit.tests.",
"priority": 12,
"weight": 20,
"port": 30,
"disableFlag": false
}]
}, {
"id": 1808515,
"type": "AAAA",
"recordType": "aaaa",
"name": "aaaa",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 600,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565149739464,
"value": ["2601:644:500:e210:62f8:1dff:feb8:947a"],
"roundRobin": [{
"value": "2601:644:500:e210:62f8:1dff:feb8:947a",
"disableFlag": false
}],
"geolocation": null,
"recordFailover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"failover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"pools": [],
"poolsDetail": [],
"roundRobinFailover": []
}, {
"id": 1808530,
"type": "ANAME",
"recordType": "aname",
"name": "",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 1800,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565150251379,
"value": [{
"value": "aname.unit.tests.",
"disableFlag": false
}],
"roundRobin": [{
"value": "aname.unit.tests.",
"disableFlag": false
}],
"geolocation": null,
"recordFailover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"failover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"pools": [],
"poolsDetail": []
}, {
"id": 1808521,
"type": "CNAME",
"recordType": "cname",
"name": "cname",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 300,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565152113825,
"value": "",
"roundRobin": [{
"value": "",
"disableFlag": false
}],
"recordFailover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": [{
"id": null,
"value": "",
"disableFlag": false,
"failedFlag": false,
"status": "N/A",
"sortOrder": 1,
"markedActive": false
}, {
"id": null,
"value": "",
"disableFlag": false,
"failedFlag": false,
"status": "N/A",
"sortOrder": 2,
"markedActive": false
}]
},
"failover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": [{
"id": null,
"value": "",
"disableFlag": false,
"failedFlag": false,
"status": "N/A",
"sortOrder": 1,
"markedActive": false
}, {
"id": null,
"value": "",
"disableFlag": false,
"failedFlag": false,
"status": "N/A",
"sortOrder": 2,
"markedActive": false
}]
},
"pools": [],
"poolsDetail": [],
"geolocation": null,
"host": ""
}, {
"id": 1808522,
"type": "CNAME",
"recordType": "cname",
"name": "included",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 3600,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565152119137,
"value": "",
"roundRobin": [{
"value": "",
"disableFlag": false
}],
"recordFailover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": [{
"id": null,
"value": "",
"disableFlag": false,
"failedFlag": false,
"status": "N/A",
"sortOrder": 1,
"markedActive": false
}, {
"id": null,
"value": "",
"disableFlag": false,
"failedFlag": false,
"status": "N/A",
"sortOrder": 2,
"markedActive": false
}]
},
"failover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": [{
"id": null,
"value": "",
"disableFlag": false,
"failedFlag": false,
"status": "N/A",
"sortOrder": 1,
"markedActive": false
}, {
"id": null,
"value": "",
"disableFlag": false,
"failedFlag": false,
"status": "N/A",
"sortOrder": 2,
"markedActive": false
}]
},
"pools": [],
"poolsDetail": [],
"geolocation": null,
"host": ""
}, {
"id": 1808523,
"type": "MX",
"recordType": "mx",
"name": "mx",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 300,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565149879856,
"value": [{
"value": "smtp-3.unit.tests.",
"level": 30,
"disableFlag": false
}, {
"value": "smtp-2.unit.tests.",
"level": 20,
"disableFlag": false
}, {
"value": "smtp-4.unit.tests.",
"level": 10,
"disableFlag": false
}, {
"value": "smtp-1.unit.tests.",
"level": 40,
"disableFlag": false
}],
"roundRobin": [{
"value": "smtp-3.unit.tests.",
"level": 30,
"disableFlag": false
}, {
"value": "smtp-2.unit.tests.",
"level": 20,
"disableFlag": false
}, {
"value": "smtp-4.unit.tests.",
"level": 10,
"disableFlag": false
}, {
"value": "smtp-1.unit.tests.",
"level": 40,
"disableFlag": false
}]
}, {
"id": 1808525,
"type": "PTR",
"recordType": "ptr",
"name": "ptr",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 300,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565150115139,
"value": [{
"value": "foo.bar.com.",
"disableFlag": false
}],
"roundRobin": [{
"value": "foo.bar.com.",
"disableFlag": false
}]
}, {
"id": 1808526,
"type": "SPF",
"recordType": "spf",
"name": "spf",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 600,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565149916132,
"value": [{
"value": "\"v=spf1 ip4:192.168.0.1/16-all\"",
"disableFlag": false
}],
"roundRobin": [{
"value": "\"v=spf1 ip4:192.168.0.1/16-all\"",
"disableFlag": false
}]
}, {
"id": 1808528,
"type": "TXT",
"recordType": "txt",
"name": "txt",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 600,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565149966915,
"value": [{
"value": "\"Bah bah black sheep\"",
"disableFlag": false
}, {
"value": "\"have you any wool.\"",
"disableFlag": false
}, {
"value": "\"v=DKIM1;k=rsa;s=email;h=sha256;p=A/kinda+of/long/string+with+numb3rs\"",
"disableFlag": false
}],
"roundRobin": [{
"value": "\"Bah bah black sheep\"",
"disableFlag": false
}, {
"value": "\"have you any wool.\"",
"disableFlag": false
}, {
"value": "\"v=DKIM1;k=rsa;s=email;h=sha256;p=A/kinda+of/long/string+with+numb3rs\"",
"disableFlag": false
}]
}, {
"id": 1808524,
"type": "NS",
"recordType": "ns",
"name": "under",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 3600,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565150062850,
"value": [{
"value": "ns1.unit.tests.",
"disableFlag": false
}, {
"value": "ns2",
"disableFlag": false
}],
"roundRobin": [{
"value": "ns1.unit.tests.",
"disableFlag": false
}, {
"value": "ns2",
"disableFlag": false
}]
}, {
"id": 1808531,
"type": "HTTPRedirection",
"recordType": "httpredirection",
"name": "unsupported",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 300,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565150348154,
"value": "https://redirect.unit.tests",
"roundRobin": [{
"value": "https://redirect.unit.tests"
}],
"title": "Unsupported Record",
"keywords": "unsupported",
"description": "unsupported record",
"hardlinkFlag": false,
"redirectTypeId": 1,
"url": "https://redirect.unit.tests"
}, {
"id": 1808519,
"type": "A",
"recordType": "a",
"name": "www",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 300,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565150079027,
"value": ["2.2.3.6"],
"roundRobin": [{
"value": "2.2.3.6",
"disableFlag": false
}],
"geolocation": null,
"recordFailover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"failover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"roundRobinFailover": [],
"pools": [],
"poolsDetail": []
}, {
"id": 1808603,
"type": "ANAME",
"recordType": "aname",
"name": "sub",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 1800,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565153387855,
"value": [{
"value": "aname.unit.tests.",
"disableFlag": false
}],
"roundRobin": [{
"value": "aname.unit.tests.",
"disableFlag": false
}],
"geolocation": null,
"recordFailover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"failover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"pools": [],
"poolsDetail": []
}, {
"id": 1808520,
"type": "A",
"recordType": "a",
"name": "www.sub",
"recordOption": "roundRobin",
"noAnswer": false,
"note": "",
"ttl": 300,
"gtdRegion": 1,
"parentId": 123123,
"parent": "domain",
"source": "Domain",
"modifiedTs": 1565150090588,
"value": ["2.2.3.6"],
"roundRobin": [{
"value": "2.2.3.6",
"disableFlag": false
}],
"geolocation": null,
"recordFailover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"failover": {
"disabled": false,
"failoverType": 1,
"failoverTypeStr": "Normal (always lowest level)",
"values": []
},
"roundRobinFailover": [],
"pools": [],
"poolsDetail": []
}]

View File

@@ -0,0 +1,218 @@
#
#
#
from __future__ import absolute_import, division, print_function, \
unicode_literals
from mock import Mock, call
from os.path import dirname, join
from requests import HTTPError
from requests_mock import ANY, mock as requests_mock
from unittest import TestCase
from octodns.record import Record
from octodns.provider.constellix import ConstellixClientNotFound, \
ConstellixProvider
from octodns.provider.yaml import YamlProvider
from octodns.zone import Zone
import json
class TestConstellixProvider(TestCase):
expected = Zone('unit.tests.', [])
source = YamlProvider('test', join(dirname(__file__), 'config'))
source.populate(expected)
# Our test suite differs a bit, add our NS and remove the simple one
expected.add_record(Record.new(expected, 'under', {
'ttl': 3600,
'type': 'NS',
'values': [
'ns1.unit.tests.',
'ns2.unit.tests.',
]
}))
# Add some ALIAS records
expected.add_record(Record.new(expected, '', {
'ttl': 1800,
'type': 'ALIAS',
'value': 'aname.unit.tests.'
}))
expected.add_record(Record.new(expected, 'sub', {
'ttl': 1800,
'type': 'ALIAS',
'value': 'aname.unit.tests.'
}))
for record in list(expected.records):
if record.name == 'sub' and record._type == 'NS':
expected._remove_record(record)
break
def test_populate(self):
provider = ConstellixProvider('test', 'api', 'secret')
# Bad auth
with requests_mock() as mock:
mock.get(ANY, status_code=401,
text='{"errors": ["Unable to authenticate token"]}')
with self.assertRaises(Exception) as ctx:
zone = Zone('unit.tests.', [])
provider.populate(zone)
self.assertEquals('Unauthorized', ctx.exception.message)
# Bad request
with requests_mock() as mock:
mock.get(ANY, status_code=400,
text='{"errors": ["\\"unittests\\" is not '
'a valid domain name"]}')
with self.assertRaises(Exception) as ctx:
zone = Zone('unit.tests.', [])
provider.populate(zone)
self.assertEquals('\n - "unittests" is not a valid domain name',
ctx.exception.message)
# General error
with requests_mock() as mock:
mock.get(ANY, status_code=502, text='Things caught fire')
with self.assertRaises(HTTPError) as ctx:
zone = Zone('unit.tests.', [])
provider.populate(zone)
self.assertEquals(502, ctx.exception.response.status_code)
# Non-existent zone doesn't populate anything
with requests_mock() as mock:
mock.get(ANY, status_code=404,
text='<html><head></head><body></body></html>')
zone = Zone('unit.tests.', [])
provider.populate(zone)
self.assertEquals(set(), zone.records)
# No diffs == no changes
with requests_mock() as mock:
base = 'https://api.dns.constellix.com/v1/domains'
with open('tests/fixtures/constellix-domains.json') as fh:
mock.get('{}{}'.format(base, '/'), text=fh.read())
with open('tests/fixtures/constellix-records.json') as fh:
mock.get('{}{}'.format(base, '/123123/records'),
text=fh.read())
zone = Zone('unit.tests.', [])
provider.populate(zone)
self.assertEquals(15, len(zone.records))
changes = self.expected.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(15, len(again.records))
# bust the cache
del provider._zone_records[zone.name]
def test_apply(self):
provider = ConstellixProvider('test', 'api', 'secret')
resp = Mock()
resp.json = Mock()
provider._client._request = Mock(return_value=resp)
with open('tests/fixtures/constellix-domains.json') as fh:
domains = json.load(fh)
# non-existent domain, create everything
resp.json.side_effect = [
ConstellixClientNotFound, # no zone in populate
ConstellixClientNotFound, # no domain during apply
domains
]
plan = provider.plan(self.expected)
# No root NS, no ignored, no excluded, no unsupported
n = len(self.expected.records) - 5
self.assertEquals(n, len(plan.changes))
self.assertEquals(n, provider.apply(plan))
provider._client._request.assert_has_calls([
# created the domain
call('POST', '/', data={'names': ['unit.tests']}),
# get all domains to build the cache
call('GET', '/'),
call('POST', '/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(20, provider._client._request.call_count)
provider._client._request.reset_mock()
provider._client.records = Mock(return_value=[
{
'id': 11189897,
'type': 'A',
'name': 'www',
'ttl': 300,
'value': [
'1.2.3.4',
'2.2.3.4',
]
}, {
'id': 11189898,
'type': 'A',
'name': 'ttl',
'ttl': 600,
'value': [
'3.2.3.4'
]
}
])
# Domain exists, we don't care about return
resp.json.side_effect = ['{}']
wanted = Zone('unit.tests.', [])
wanted.add_record(Record.new(wanted, 'ttl', {
'ttl': 300,
'type': 'A',
'value': '3.2.3.4'
}))
plan = provider.plan(wanted)
self.assertEquals(2, len(plan.changes))
self.assertEquals(2, provider.apply(plan))
# recreate for update, and deletes for the 2 parts of the other
provider._client._request.assert_has_calls([
call('POST', '/123123/records/A', data={
'roundRobin': [{
'value': '3.2.3.4'
}],
'name': 'ttl',
'ttl': 300
}),
call('DELETE', '/123123/records/A/11189897'),
call('DELETE', '/123123/records/A/11189898')
], any_order=True)