Merge remote-tracking branch 'origin/main' into dynamic-zones

.github/workflows/modules.yml

@@ -37,7 +37,10 @@ jobs:
           - octodns/octodns-selectel
           - octodns/octodns-transip
           - octodns/octodns-ultra
-          - sukiyaki/octodns-netbox
+          # has been failing for a while now and afaict not related to octoDNS
+          # changes commenting out on 2023-07-30, will check on it again in at
+          # some point in the future and either re-enable or delete it.
+          #- sukiyaki/octodns-netbox
     steps:
       - uses: actions/checkout@master
       - name: Setup python

CHANGELOG.md

@@ -1,3 +1,19 @@
+## v1.0.0 - 2023-07-30 - The One
+
+1.0 marks a point at which we can formally deprecate things that will be
+going away with 2.0 more than specific functionality that has been added or
+having reached a notable level of stability (beyond what is normal.) It is also
+long (years) overdue.
+
+#### Noteworthy changes
+
+* `geo` records are deprecated.
+
+#### Stuff
+
+* Removal of a Python 3.7 specific import work-around now that it's no longer an
+  active/supported version. Also bumps required minimum version of Python 3.8
+
 ## v1.0.0.rc1 - 2023-07-20 - The last one before the 1s
 
 * Record and Zone validation now ensures there's no whitespace in names

octodns/__init__.py

@@ -1,3 +1,3 @@
 'OctoDNS: DNS as code - Tools for managing DNS across multiple providers'
 
-__VERSION__ = '1.0.0rc1'
+__VERSION__ = '1.0.0'

octodns/cmds/args.py

@@ -101,9 +101,3 @@ class ArgumentParser(_Base):
             # we still want plans to come out during quite so set the plan
             # logger output to info in case the PlanLogger is being used
             getLogger('Plan').setLevel(INFO)
-
-        # TODO: these should move out of octoDNS core...
-        # boto is noisy, set it to warn
-        getLogger('botocore').level = WARNING
-        # DynectSession is noisy too
-        getLogger('DynectSession').level = WARNING

octodns/manager.py

@@ -5,6 +5,8 @@
 from collections import deque
 from concurrent.futures import ThreadPoolExecutor
 from importlib import import_module
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as module_version
 from logging import getLogger
 from os import environ
 from sys import stdout
@@ -19,18 +21,6 @@ from .record import Record
 from .yaml import safe_load
 from .zone import Zone
 
-# TODO: this can go away once we no longer support python 3.7
-try:  # pragma: no cover
-    from importlib.metadata import PackageNotFoundError
-    from importlib.metadata import version as module_version
-except ModuleNotFoundError:  # pragma: no cover
-
-    class PackageNotFoundError(Exception):
-        pass
-
-    def module_version(*args, **kargs):
-        raise PackageNotFoundError('placeholder')
-
 
 class _AggregateTarget(object):
     id = 'aggregate'

octodns/provider/plan.py

@@ -79,7 +79,6 @@ class Plan(object):
         )
 
     def raise_if_unsafe(self):
-        # TODO: what is safe really?
         if (
             self.existing
             and len(self.existing.records) >= self.MIN_EXISTING_RECORDS

octodns/record/geo.py

@@ -141,6 +141,9 @@ class _GeoMixin(ValuesMixin):
         reasons = super().validate(name, fqdn, data)
         try:
             geo = dict(data['geo'])
+            cls.log.warning(
+                'NOTICE: `geo` record support is deprecated and should be migrated to `dynamic` records'
+            )
             for code, values in geo.items():
                 reasons.extend(GeoValue._validate_geo(code))
                 reasons.extend(cls._value_type.validate(values, cls._type))

octodns/zone.py

@@ -161,8 +161,12 @@ class Zone(object):
 
         self._records[record.name].discard(record)
 
-    # TODO: delete this
-    _remove_record = remove_record
+    # TODO: delete this at v2.0.0rc0
+    def _remove_record(self, record):
+        self.log.warning(
+            '_remove_record: method has been deprecated, used remove_record instead'
+        )
+        return self.remove_record(record)
 
     def changes(self, desired, target):
         self.log.debug('changes: zone=%s, target=%s', self, target)

setup.py

@@ -99,7 +99,7 @@ setup(
     long_description_content_type='text/markdown',
     name='octodns',
     packages=find_packages(),
-    python_requires='>=3.6',
+    python_requires='>=3.8',
     tests_require=tests_require,
     url='https://github.com/octodns/octodns',
     version=version(),

tests/test_octodns_provider_yaml.py

@@ -139,32 +139,31 @@ class TestYamlProvider(TestCase):
             with open(dynamic_yaml_file) as fh:
                 data = safe_load(fh.read())
 
-                # make sure new dynamic records made the trip
+                # make sure dynamic records made the trip
                 dyna = data.pop('a')
                 self.assertTrue('values' in dyna)
-                # self.assertTrue('dynamic' in dyna)
-                # TODO:
+                self.assertTrue('dynamic' in dyna)
 
-                # make sure new dynamic records made the trip
+                # make sure dynamic records made the trip
                 dyna = data.pop('aaaa')
                 self.assertTrue('values' in dyna)
-                # self.assertTrue('dynamic' in dyna)
+                self.assertTrue('dynamic' in dyna)
 
                 dyna = data.pop('cname')
                 self.assertTrue('value' in dyna)
-                # self.assertTrue('dynamic' in dyna)
+                self.assertTrue('dynamic' in dyna)
 
                 dyna = data.pop('real-ish-a')
                 self.assertTrue('values' in dyna)
-                # self.assertTrue('dynamic' in dyna)
+                self.assertTrue('dynamic' in dyna)
 
                 dyna = data.pop('simple-weighted')
                 self.assertTrue('value' in dyna)
-                # self.assertTrue('dynamic' in dyna)
+                self.assertTrue('dynamic' in dyna)
 
                 dyna = data.pop('pool-only-in-fallback')
                 self.assertTrue('value' in dyna)
-                # self.assertTrue('dynamic' in dyna)
+                self.assertTrue('dynamic' in dyna)
 
                 # make sure nothing is left
                 self.assertEqual([], list(data.keys()))

tests/test_octodns_record_geo.py

@@ -213,15 +213,22 @@ class TestRecordGeoCodes(TestCase):
         self.assertTrue(c >= b)
 
     def test_validation(self):
-        Record.new(
-            self.zone,
-            '',
-            {
-                'geo': {'NA': ['1.2.3.5'], 'NA-US': ['1.2.3.5', '1.2.3.6']},
-                'type': 'A',
-                'ttl': 600,
-                'value': '1.2.3.4',
-            },
+        with self.assertLogs('Record', level='WARNING') as cm:
+            Record.new(
+                self.zone,
+                '',
+                {
+                    'geo': {'NA': ['1.2.3.5'], 'NA-US': ['1.2.3.5', '1.2.3.6']},
+                    'type': 'A',
+                    'ttl': 600,
+                    'value': '1.2.3.4',
+                },
+            )
+        self.assertEqual(
+            [
+                'WARNING:Record:NOTICE: `geo` record support is deprecated and should be migrated to `dynamic` records'
+            ],
+            cm.output,
         )
 
         # invalid ip address

tests/test_octodns_zone.py

@@ -125,7 +125,7 @@ class TestZone(TestCase):
         # add a record, delete a record -> [Delete, Create]
         c = ARecord(before, 'c', {'ttl': 42, 'value': '1.1.1.1'})
         after.add_record(c)
-        after._remove_record(b)
+        after.remove_record(b)
         self.assertEqual(after.records, set([a, c]))
         changes = before.changes(after, target)
         self.assertEqual(2, len(changes))
@@ -154,6 +154,14 @@ class TestZone(TestCase):
         self.assertFalse(changed.changes(update.new, target))
         update.__repr__()
 
+    def test_deprecated__remove_record(self):
+        zone = Zone('unit.tests.', [])
+        a = ARecord(zone, 'a', {'ttl': 42, 'value': '1.1.1.1'})
+        zone.add_record(a)
+        self.assertEqual({a}, zone.records)
+        zone._remove_record(a)
+        self.assertEqual(set(), zone.records)
+
     def test_unsupporting(self):
         class NoAaaaProvider(object):
             id = 'no-aaaa'