Bump version 0.3.6 → 0.3.7

Signed-off-by: Ivan Schaller <ivan@schaller.sh>

.gitea/workflows/build_release.yml

@@ -1,4 +1,4 @@
-name: build and publish
+name: build pypackage and create release
 
 on:
   push:
@@ -9,16 +9,55 @@ on:
     branches: [main, master]
 
 jobs:
-  release-pypackage:
+  release-github:
-    uses: actions/workflows/.gitea/workflows/release_pypackage.yml@master
+    runs-on: ubuntu-latest
+    env:
+      HATCH_INDEX_REPO: main
+      HATCH_INDEX_USER: __token__
+      HATCH_INDEX_AUTH: ${{ secrets.PACKAGE_TOKEN }}
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v4
         with:
-      repository: main
+          fetch-depth: 0
-    secrets:
-      username: __token__
-      token: ${{ secrets.PACKAGE_TOKEN }}
-      gh-token: ${{ secrets.GH_TOKEN }}
 
-  update-changelog:
+      - uses: actions/setup-python@v5
-    uses: actions/workflows/.gitea/workflows/update_changelog.yml@master
         with:
-      branch: main
+          python-version: "3.11"
+
+      - name: setup go
+        uses: actions/setup-go@v4
+        with:
+          go-version: ">=1.20"
+
+      - name: install hatc  h
+        run: pip install -U hatch hatchling
+
+      - name: build package
+        run: hatch build --clean
+
+      - name: install auto-changelog
+        run: npm install auto-changelog
+
+      - name: generate changelog
+        run: >-
+          npx auto-changelog -t keepachangelog
+          --commit-limit 50 --backfill-limit 50
+          --ignore-commit-pattern '[Bb]ump version|[Uu]pdate changelog|[Mm]erge pull request'
+
+      - name: get release notes
+        id: release-notes
+        uses: olofvndrhr/releasenote-gen@v1
+
+      - name: publish package
+        if: gitea.event_name != 'pull_request'
+        run: hatch publish --yes --no-prompt
+
+      - name: create gitea release
+        uses: https://gitea.com/actions/release-action@main
+        if: gitea.event_name != 'pull_request'
+        with:
+          title: ${{ gitea.ref_name }}
+          body: ${{ steps.release-notes.outputs.releasenotes }}
+          files: |-
+            dist/**

.gitea/workflows/check_code.yml

@@ -9,6 +9,23 @@ on:
 
 jobs:
   check-code:
-    uses: actions/workflows/.gitea/workflows/check_python_hatch.yml@master
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v5
         with:
-      run-tests: true
+          python-version: "3.11"
+
+      - name: install hatch
+        run: pip install -U hatch
+
+      - name: test codestyle
+        run: hatch run lint:style
+
+      - name: test typing
+        run: hatch run lint:typing
+
+      - name: run tests
+        run: hatch run default:test

.github/workflows/build_release.yml

@@ -1,4 +1,4 @@
-name: build and release
+name: build pypackage and create release
 
 on:
   push:
@@ -17,7 +17,7 @@ jobs:
       HATCH_INDEX_AUTH: ${{ secrets.PACKAGE_TOKEN }}
     steps:
       - name: checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -25,12 +25,18 @@ jobs:
         with:
           python-version: "3.11"
 
+      - name: install hatch
+        run: pip install -U hatch hatchling
+
+      - name: build package
+        run: hatch build --clean
+
       - name: install auto-changelog
-        run: npm install -g auto-changelog
+        run: npm install auto-changelog
 
       - name: generate changelog
         run: >-
-          auto-changelog -t keepachangelog
+          npx auto-changelog -t keepachangelog
           --commit-limit 50 --backfill-limit 50
           --ignore-commit-pattern '[Bb]ump version|[Uu]pdate changelog|[Mm]erge pull request'
 
@@ -38,12 +44,6 @@ jobs:
         id: release-notes
         uses: olofvndrhr/releasenote-gen@v1
 
-      - name: install hatch
-        run: pip install -U hatch hatchling
-
-      - name: build package
-        run: hatch build --clean
-
       - name: create github release
         uses: ncipollo/release-action@v1
         if: github.event_name != 'pull_request'

.tool-versions

@@ -1,2 +1 @@
-just 1.16.0
+just 1.25.2
-lefthook 1.4.6

CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+## [v0.3.5](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/compare/v0.3.4...v0.3.5) - 2024-03-04
+
+### Commits
+
+- add new tests [`a8ecfab`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/a8ecfab93096cd3201efcb06a65bc86a2444611a)
+- fix typo in method call and add function for semicolons [`afe1826`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/afe182628a7b2fc784dc48bebaf9978c85d682d2)
+- update ci files for github [`6b06cad`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/6b06cada38751648b9365fd27b850aa2b6d250a8)
+- unescape the changeset before comparison to live records to have an accurate changeset. fixes changes for txt records [`4fe8be6`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/4fe8be62918b5bea821f4f88a151918899b61e91)
+- rollback changes to semicolon escaping [`91ba03a`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/91ba03af7f5f53a7f3b5218f0f4a905eebcdb914)
+- revert: change from repr to string in changeset [`8d29b5e`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/8d29b5e639b25bb57b43e9e85bbe78e51d70b493)
+- update logging [`ff1a47c`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/ff1a47cf8cda21695fb4e30910dd92d0f9cb8b63)
+- update test cases [`f38a103`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/f38a1036b79b9779a8480c2d1f79132370b83bb4)
+- change from repr to string in changeset [`696d2a2`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/696d2a2532eef05fee95cddff627c9b09736ae52)
+- only unescape txt and spf records [`78448d2`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/78448d2bde85fda1718c64e6cd8983b4fcb20fe0)
+- fix semicolon escaping [`6e624a7`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/6e624a79a75051295d1863f9af7e907d44a9b307)
+- fix tests [`2e468c8`](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/commit/2e468c85699808ed9ba2edb35a6cc39591869346)
+
 ## [v0.3.4](https://git.44net.ch/olofvndrhr/octodns-netbox-dns/compare/v0.3.3...v0.3.4) - 2024-02-29
 
 ### Commits

dev/Dockerfile

@@ -1,6 +1,6 @@
-FROM lscr.io/linuxserver/netbox:3.7.3
+FROM lscr.io/linuxserver/netbox:4.0.8
 
 RUN pip install -U \
     wheel \
     setuptools \
-    netbox-plugin-dns
+    netbox-plugin-dns==1.0.4

dev/configuration.py

@@ -14,7 +14,7 @@ PLUGINS_CONFIG = {
         "zone_nameservers": ["ns1.example.com", "ns2.example.com"],
         "zone_soa_mname": "ns1.example.com",
         "zone_soa_rname": "admin.example.com",
-        "tolerate_underscores_in_hostnames": False,
+        "tolerate_underscores_in_labels": False,
         "tolerate_leading_underscore_types": [
             "TXT",
             "SRV",

dev/sync2.yml

@@ -0,0 +1,43 @@
+manager:
+  max_workers: 1
+  plan_outputs:
+    html:
+      class: octodns.provider.plan.PlanMarkdown
+processors:
+  spf:
+    class: octodns_spf.SpfDnsLookupProcessor
+  no-root-ns:
+    class: octodns.processor.filter.IgnoreRootNsFilter
+  min-max-ttl:
+    class: octodns.processor.restrict.TtlRestrictionFilter
+    allowed_ttls:
+      - 60
+      - 300
+      - 600
+      - 900
+      - 1800
+      - 3600
+      - 7200
+      - 10800
+providers:
+  config:
+    class: octodns.provider.yaml.YamlProvider
+    directory: ./zones
+    default_ttl: 3600
+    enforce_order: true
+    populate_should_replace: false
+  netbox:
+    class: octodns_netbox_dns.NetBoxDNSProvider
+    url: http://localhost:8000
+    token: 1ca8f8de1d651b0859052dc5e6a0858fd1e43e3d # change token for netbox
+    view: false
+    replace_duplicates: false
+    make_absolute: true
+zones:
+  "*":
+    sources:
+      - config
+    processors:
+      - spf
+    targets:
+      - netbox

justfile

@@ -19,7 +19,6 @@ show_system_info:
 
 setup:
     asdf install
-    lefthook install
 
 create_venv:
     @echo "creating venv"
@@ -77,5 +76,8 @@ sync *args:
 dump *args:
     hatch -v run default:dump {{ args }}
 
+dump2 *args:
+    hatch -v run default:dump2 {{ args }}
+
 validate *args:
     hatch -v run default:validate {{ args }}

lefthook.yml

@@ -1,14 +0,0 @@
-colors: true
-no_tty: false
-
-pre-commit:
-  commands:
-    01_ruff_check:
-      stage_fixed: true
-      glob: "*.py"
-      run: ruff check --fix-only --exit-zero --silent {all_files}
-
-    02_ruff_format:
-      stage_fixed: true
-      glob: "*.py"
-      run: ruff format {all_files}

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["hatchling>=1.18", "hatch-regex-commit>=0.0.3"]
+requires = ["hatchling>=1.24", "hatch-regex-commit>=0.0.3"]
 build-backend = "hatchling.build"
 
 [project]
@@ -11,7 +11,7 @@ requires-python = ">=3.11"
 dynamic = ["version"]
 authors = [
     { name = "Jeffrey C. Ollie", email = "" },
-    { name = "Ivan Schaller", email = "ivan@schaller.sh" }
+    { name = "Ivan Schaller", email = "ivan@schaller.sh" },
 ]
 classifiers = [
     "License :: OSI Approved :: MIT License",
@@ -19,10 +19,7 @@ classifiers = [
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3.11",
 ]
-dependencies = [
+dependencies = ["pynetbox>=7.2.0", "dnspython>=2.4.2"]
-    "pynetbox>=7.2.0",
-    "dnspython>=2.4.2",
-]
 
 [project.urls]
 Homepage = "https://github.com/olofvndrhr/octodns-netbox-dns"
@@ -48,9 +45,9 @@ packages = ["src/octodns_netbox_dns"]
 [tool.hatch.envs.default]
 python = "3.11"
 dependencies = [
-    "pytest==7.4.4",
+    "pytest==8.2.2",
-    "coverage==7.4.2",
+    "coverage==7.5.3",
-    "octodns==1.5.0",
+    "octodns==1.9.1",
     "octodns-spf==0.0.2",
 ]
 
@@ -61,28 +58,23 @@ cov-report = ["- coverage combine", "coverage report", "coverage xml"]
 cov = ["test-cov", "cov-report"]
 
 sync = ["cd dev && octodns-sync --debug --config-file sync.yml --force {args}"]
-dump = ["cd dev && octodns-dump --debug --config-file sync.yml --output-dir output {args} '*' netbox"]
+dump = [
+    "cd dev && octodns-dump --debug --config-file sync.yml --output-dir output {args} '*' netbox",
+]
+dump2 = [
+    "cd dev && octodns-dump --debug --config-file sync2.yml --output-dir output {args} '*' netbox",
+]
 validate = ["cd dev && octodns-validate --debug --config-file sync.yml {args}"]
 
 [tool.hatch.envs.lint]
 python = "3.11"
 detached = true
-dependencies = [
+dependencies = ["mypy==1.10.0", "ruff==0.4.8"]
-    "mypy==1.8.0",
-    "ruff==0.2.2",
-]
 
 [tool.hatch.envs.lint.scripts]
 typing = "mypy --non-interactive --install-types {args:src/octodns_netbox_dns}"
-style = [
+style = ["ruff check --diff {args:.}", "ruff format --check --diff {args:.}"]
-    "ruff check --diff {args:.}",
+fmt = ["ruff check --fix {args:.}", "ruff format {args:.}", "style"]
-    "ruff format --check --diff {args:.}"
-]
-fmt = [
-    "ruff check --fix {args:.}",
-    "ruff format {args:.}",
-    "style"
-]
 all = ["style", "typing"]
 
 ###
@@ -112,7 +104,7 @@ exclude = [
     "dist",
     "node_modules",
     "venv",
-    "dev"
+    "dev",
 ]
 
 [tool.ruff.lint]
@@ -143,8 +135,18 @@ select = [
     "W",
     "YTT",
 ]
-ignore-init-module-imports = true
+ignore = [
-ignore = ["E501", "D103", "D100", "D102", "PLR2004", "D403", "ISC001", "FBT001", "FBT002", "FBT003"]
+    "E501",
+    "D103",
+    "D100",
+    "D102",
+    "PLR2004",
+    "D403",
+    "ISC001",
+    "FBT001",
+    "FBT002",
+    "FBT003",
+]
 unfixable = ["F401"]
 
 [tool.ruff.format]
@@ -231,7 +233,10 @@ parallel = true
 omit = ["src/octodns_netbox_dns/__about__.py"]
 
 [tool.coverage.paths]
-octodns_netbox_dns = ["src/octodns_netbox_dns", "*/octodns-netbox-dns/src/octodns_netbox_dns"]
+octodns_netbox_dns = [
+    "src/octodns_netbox_dns",
+    "*/octodns-netbox-dns/src/octodns_netbox_dns",
+]
 tests = ["tests", "*/octodns-netbox-dns/tests"]
 
 [tool.coverage.report]

src/octodns_netbox_dns/__about__.py

@@ -1 +1 @@
-__version__ = "0.3.4"
+__version__ = "0.3.7"

src/octodns_netbox_dns/__init__.py

@@ -75,14 +75,18 @@ class NetBoxDNSProvider(octodns.provider.base.BaseProvider):
         self.make_absolute = make_absolute
         self.disable_ptr = disable_ptr
 
-    def _make_absolute(self, value: str) -> str:
+    def _make_absolute(self, value: str, force: bool = False) -> str:
         """return dns name with trailing dot to make it absolute
 
         @param value: dns record value
+        @param force: when `True`, disregard configuration option `make_absolute`
 
         @return: absolute dns record value
         """
-        if not self.make_absolute or value.endswith("."):
+        if value.endswith("."):
+            return value
+
+        if not (self.make_absolute or force):
             return value
 
         absolute_value = value + "."
@@ -430,3 +434,14 @@ class NetBoxDNSProvider(octodns.provider.base.BaseProvider):
                             value=record,
                             disable_ptr=self.disable_ptr,
                         )
+
+    def list_zones(self) -> list[str]:
+        """get all zones from netbox
+
+        @return: a list with all active zones
+        """
+        query_params = {"status": "active", **self.nb_view}
+        zones = self.api.plugins.netbox_dns.zones.filter(**query_params)
+        absolute_zones = [self._make_absolute(z.name, True) for z in zones]
+
+        return sorted(absolute_zones)

tests/test_make_absolute.py

@@ -11,7 +11,7 @@ DEFAULT_CONFIG = {
 }
 
 
-def test1():
+def test_absolute():
     nbdns = NetBoxDNSProvider(**DEFAULT_CONFIG)
     rcd = "example.com"
     absolute = nbdns._make_absolute(rcd)
@@ -19,9 +19,27 @@ def test1():
     assert absolute == "example.com."
 
 
-def test2():
+def test_noop():
     nbdns = NetBoxDNSProvider(**DEFAULT_CONFIG)
     rcd = "example.com."
     absolute = nbdns._make_absolute(rcd)
 
     assert absolute == "example.com."
+
+
+def test_disabled():
+    args = {**DEFAULT_CONFIG, "make_absolute": False}
+    nbdns = NetBoxDNSProvider(**args)
+    rcd = "example.com"
+    relative = nbdns._make_absolute(rcd, force=False)
+
+    assert relative == "example.com"
+
+
+def test_force():
+    args = {**DEFAULT_CONFIG, "make_absolute": False}
+    nbdns = NetBoxDNSProvider(**args)
+    rcd = "example.com"
+    absolute = nbdns._make_absolute(rcd, force=True)
+
+    assert absolute == "example.com."