Merge branch 'master' of github.com:adferrand/dnsrobocert

adferrand · Sep 30, 2023 · e833085 · e833085
2 parents 1803040 + 60e8b00
commit e833085
Show file tree

Hide file tree

Showing 13 changed files with 719 additions and 368 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_create_environment:
+      - pip install poetry
+      - poetry config virtualenvs.create false
+    post_install:
+      - poetry install --no-root --only docs
+sphinx:
+  configuration: docs/conf.py
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## master - CURRENT
 
+## 3.24.2 - 18/09/2023
+### Modified
+* Fix TXT record cleanup actions
+
 ## 3.24.1 - 13/08/2023
 ### Modified
 * Fix compatibility issue with Python 3.8

diff --git a/README.rst b/README.rst
@@ -12,7 +12,7 @@
     :target: https://pypi.org/project/dnsrobocert/
 .. |docker| image:: https://img.shields.io/docker/pulls/adferrand/dnsrobocert
     :target: https://hub.docker.com/r/adferrand/dnsrobocert
-.. |ci| image:: https://img.shields.io/github/workflow/status/adferrand/dnsrobocert/main/master
+.. |ci| image:: https://img.shields.io/github/actions/workflow/status/adferrand/dnsrobocert/main.yml?branch=master
     :target: https://github.com/adferrand/dnsrobocert/actions/workflows/main.yml
 .. |coverage| image:: https://img.shields.io/codecov/c/github/adferrand/dnsrobocert/master
     :target: https://app.codecov.io/gh/adferrand/dnsrobocert/branch/master

diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/conf.py b/docs/conf.py
@@ -2,8 +2,8 @@
 
 import toml
 
-pyproject_toml = toml.load(join(dirname(dirname(abspath(__file__))), "pyproject.toml"))
-poetry_lock = toml.load(join(dirname(dirname(abspath(__file__))), "poetry.lock"))
+root_path = dirname(dirname(abspath(__file__)))
+pyproject_toml = toml.load(join(root_path, "pyproject.toml"))
 
 master_doc = "index"
 project = "DNSroboCert"
@@ -13,8 +13,11 @@
 
 extensions = [
     "sphinx.ext.intersphinx",
+    "sphinx_rtd_theme",
 ]
 
 intersphinx_mapping = {
-    'lexicon': ('https://dns-lexicon.readthedocs.io/en/latest', None),
+    "lexicon": ("https://dns-lexicon.readthedocs.io/en/latest", None),
 }
+
+html_theme = "sphinx_rtd_theme"
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,12 +5,13 @@
 .. |logo| image:: images/dnsrobocert.svg
     :alt: DNSroboCert
 
+.. include:: ../README.rst
+    :start-after: tag:intro-begin
+    :end-before: tag:intro-end
+
 .. toctree::
-   :caption: Table of Contents
-   :name: mastertoc
-   :maxdepth: 2
+   :hidden:
 
-   introduction
    user_guide
    configuration_reference
    providers_options

diff --git a/docs/introduction.rst b/docs/introduction.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "dnsrobocert"
-version = "3.24.1"
+version = "3.24.2"
 description = "A tool to manage your DNS-challenged TLS certificates"
 license = "MIT"
 keywords = [
@@ -62,11 +62,12 @@ coloredlogs = ">=14"
 colorama = ">=0"
 tldextract = ">=3"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 black = "*"
 flake8 = "*"
 flake8-pyproject = "*"
 mypy = "*"
+packaging= "*"
 pytest = "*"
 pytest-cov = "*"
 isort = "*"
@@ -76,6 +77,11 @@ types-pyOpenSSL = "*"
 types-requests = "*"
 types-setuptools = "*"
 
+[tool.poetry.group.docs.dependencies]
+sphinx = "*"
+sphinx_rtd_theme = "*"
+toml = "*"
+
 [tool.poetry.scripts]
 dnsrobocert = "dnsrobocert.core.main:main"
 

diff --git a/src/dnsrobocert/core/challenge.py b/src/dnsrobocert/core/challenge.py
@@ -52,9 +52,9 @@ def txt_challenge(
 
     with Client(ConfigResolver().with_dict(config_dict)) as operations:
         if action == "create":
-            operations.create_record("TXT", challenge_name, token)
+            operations.create_record(rtype="TXT", name=challenge_name, content=token)
         elif action == "delete":
-            operations.delete_record("TXT", challenge_name, token)
+            operations.delete_record(rtype="TXT", name=challenge_name, content=token)
 
 
 def check_one_challenge(challenge: str, token: str | None = None) -> bool:

diff --git a/test/unit_tests/hooks_test.py b/test/unit_tests/hooks_test.py
@@ -94,7 +94,7 @@ def test_auth_cli(client, fake_config):
     assert resolver.resolve("lexicon:dummy:auth_token") == "TOKEN"
 
     operations.create_record.assert_called_with(
-        "TXT", f"_acme-challenge.{LINEAGE}.", "VALIDATION"
+        rtype="TXT", name=f"_acme-challenge.{LINEAGE}.", content="VALIDATION"
     )
 
 
@@ -113,7 +113,7 @@ def test_cleanup_cli(client, fake_config):
     assert resolver.resolve("lexicon:dummy:auth_token") == "TOKEN"
 
     operations.delete_record.assert_called_with(
-        "TXT", f"_acme-challenge.{LINEAGE}.", "VALIDATION"
+        rtype="TXT", name=f"_acme-challenge.{LINEAGE}.", content="VALIDATION"
     )
 
 

diff --git a/utils/create_release.py b/utils/create_release.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 import datetime
 import subprocess
-from distutils.version import StrictVersion
+
+from packaging import version
 
 
 def main():
@@ -21,11 +22,14 @@ def main():
     print("Please insert new version:")
     new_version = str(input())
 
-    if StrictVersion(new_version) <= StrictVersion(current_version):
+    try:
+        parsed_new_version = version.parse(new_version)
+    except version.InvalidVersion:
+        raise RuntimeError(f"Error, invalid version provided: {new_version}")
+
+    if parsed_new_version <= version.parse(current_version):
         raise RuntimeError(
-            "Error new version is below current version: {0} < {1}".format(
-                new_version, current_version
-            )
+            f"Error new version is below current version: {new_version} < {current_version}"
         )
 
     try: