saltext.gandi 0.1.0__tar.gz

saltext_gandi-0.1.0/.codecov.yml

@@ -0,0 +1,25 @@
+---
+coverage:
+  status:
+    project:
+      default: false
+      app:
+        informational: true
+        paths:
+          - src/
+      tests:
+        informational: true
+        paths:
+          - tests/
+    patch:
+      default: false
+      app:
+        informational: true
+        paths:
+          - src/
+      tests:
+        informational: true
+        paths:
+          - tests/
+github_checks:
+  annotations: false

saltext_gandi-0.1.0/.copier-answers.yml

@@ -0,0 +1,33 @@
+# Autogenerated. Do not edit this by hand, use `copier update`.
+---
+_commit: 0.10.0
+_src_path: https://github.com/salt-extensions/salt-extension-copier
+author: Gary T. Giesen
+author_email: ggiesen@giesen.me
+coc_contact: ggiesen@giesen.me
+copyright_begin: 2026
+docs_url: https://ggiesen.gitlab.io/saltext-gandi/
+integration_name: Gandi
+license: other
+license_classifier: 'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)'
+loaders:
+  - module
+  - runner
+  - state
+max_salt_version: '3008'
+no_saltext_namespace: false
+os_support:
+  - Linux
+  - macOS
+  - Windows
+package_name: gandi
+project_name: gandi
+python_requires: '3.10'
+relax_pylint: false
+salt_version: '3006'
+source_url: https://gitlab.com/ggiesen/saltext-gandi
+ssh_fixtures: false
+summary: Salt Extension for interacting with the Gandi.net API
+test_containers: false
+tracker_url: https://gitlab.com/ggiesen/saltext-gandi/-/issues
+url: https://gitlab.com/ggiesen/saltext-gandi

saltext_gandi-0.1.0/.coveragerc

@@ -0,0 +1,44 @@
+[run]
+branch = True
+cover_pylib = False
+relative_files = True
+parallel = True
+concurrency = multiprocessing
+
+omit =
+  .nox/*
+  setup.py
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_also =
+    # Don't complain about missing debug-only code:
+    def __repr__
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if False:
+    if __name__ == .__main__.:
+    if TYPE_CHECKING:
+    @(abc\.)?abstractmethod
+
+    # Add markers which exclude statements in between.
+    # Requires coverage>=7.6.0.
+    no cover: start(?s:.)*?no cover: stop
+
+omit =
+  .nox/*
+  setup.py
+
+ignore_errors = True
+
+[paths]
+source =
+  saltext/gandi
+  src/saltext/gandi
+testsuite =
+  tests/

saltext_gandi-0.1.0/.envrc.example

@@ -0,0 +1,7 @@
+layout_saltext() {
+    VIRTUAL_ENV="$(python3 tools/initialize.py --print-venv)"
+    PATH_add "$VIRTUAL_ENV/bin"
+    export VIRTUAL_ENV
+}
+
+layout_saltext

saltext_gandi-0.1.0/.gitignore

@@ -0,0 +1,136 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+!.envrc.example
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Ignore the setuptools_scm auto-generated version module
+src/saltext/gandi/version.py
+
+# Ignore CI generated artifacts
+artifacts/

saltext_gandi-0.1.0/.gitlab/issue_templates/Bug.md

@@ -0,0 +1,16 @@
+## Description
+
+
+## Setup
+(Salt version, extension version, master vs minion, which Gandi API, production
+or sandbox)
+
+## Steps to reproduce
+
+
+## Expected vs actual
+
+
+## Trace-ID
+(If the failure came back from the Gandi API, the error message includes a
+`Trace-ID`. Paste it here -- Gandi support can look the request up by it.)

saltext_gandi-0.1.0/.gitlab/issue_templates/Feature.md

@@ -0,0 +1,4 @@
+## What
+
+
+## Why

saltext_gandi-0.1.0/.gitlab/merge_request_templates/Default.md

@@ -0,0 +1,7 @@
+## What does this MR do?
+
+
+## Related issues
+
+
+## Tests

saltext_gandi-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,199 @@
+# GitLab CI for saltext-gandi.
+#
+# The salt-extension-copier template ships CI as GitHub Actions, which do not
+# run on GitLab. This pipeline reproduces that matrix natively on GitLab:
+# pre-commit lint, a nox test matrix across Salt/Python, a docs build, and
+# GitLab Pages. Salt version is selected through the noxfile's SALT_REQUIREMENT
+# environment variable (see noxfile.py).
+#
+# The matrix covers the two Salt majors upstream currently marks as supported
+# LTS releases (3006 and 3008). 3007 is deliberately omitted: the copier
+# template's own support data marks it `supported: false`. Python bounds per
+# Salt major come from that same data -- 3006 tops out at 3.11, 3008 goes
+# further, so the matrix is not a full cross product.
+
+stages:
+  - lint
+  - test
+  - docs
+  - publish
+
+variables:
+  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+
+# No `cache:` here on purpose. The self-hosted runner has no [runners.cache]
+# backend configured, so declaring one only produces
+# "ERROR: Could not create cache adapter" on every job. Artifacts are unaffected;
+# they go through GitLab.
+
+.py-base:
+  before_script:
+    - python -m pip install --upgrade pip nox
+
+pre-commit:
+  stage: lint
+  image: python:3.10
+  before_script:
+    - python -m pip install --upgrade pip pre-commit
+  script:
+    - pre-commit run --all-files --show-diff-on-failure --color always
+
+.tests:
+  stage: test
+  extends: .py-base
+  # Unit and functional only. The integration tests talk to Gandi's sandbox and
+  # need credentials, so they get their own job that runs on a schedule.
+  script:
+    - nox --force-color -e tests-3 -- tests/unit tests/functional -vv --showlocals
+  coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
+  artifacts:
+    when: always
+    reports:
+      junit: artifacts/junit-report.xml
+    paths:
+      - artifacts/
+    expire_in: 2 weeks
+
+tests-salt3006-py3.10:
+  extends: .tests
+  image: python:3.10
+  variables:
+    SALT_REQUIREMENT: "salt>=3006,<3007"
+tests-salt3006-py3.11:
+  extends: .tests
+  image: python:3.11
+  variables:
+    SALT_REQUIREMENT: "salt>=3006,<3007"
+tests-salt3008-py3.10:
+  extends: .tests
+  image: python:3.10
+  variables:
+    SALT_REQUIREMENT: "salt>=3008"
+tests-salt3008-py3.12:
+  extends: .tests
+  image: python:3.12
+  variables:
+    SALT_REQUIREMENT: "salt>=3008"
+
+# Check the endpoint table in src/saltext/gandi/utils/resources.py against
+# Gandi's live documentation.
+#
+# Gandi publishes no OpenAPI or RAML document, so there is nothing to diff
+# schemas against. What the docs do carry is a complete, machine-readable
+# endpoint index: every operation gets an HTML anchor id of the form
+# `#get-v5-livedns-domains-fqdn-records`. tools/verify_endpoints.py scrapes
+# those and diffs them against the resource table, which catches endpoints
+# added or withdrawn upstream.
+#
+# It cannot catch field-level drift -- that only surfaces at runtime, or in the
+# sandbox integration job below.
+#
+# Scheduled rather than per-push: it depends on api.gandi.net being up, and a
+# docs outage should not fail an unrelated merge request.
+verify-endpoints:
+  stage: test
+  extends: .py-base
+  image: python:3.10
+  script:
+    - nox --force-color -e verify-endpoints
+  artifacts:
+    when: always
+    paths:
+      - endpoints-report.txt
+    expire_in: 2 weeks
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "schedule"'
+    - when: manual
+      allow_failure: true
+
+# Integration tests against Gandi's sandbox (api.sandbox.gandi.net).
+#
+# Sandbox accounts are separate from production ones and are created at
+# admin.sandbox.gandi.net; the token below is a sandbox personal access token,
+# stored as a masked, protected CI variable. Nothing here can touch production:
+# the profile hardcodes the sandbox base URL, and the job fails fast if
+# GANDI_SANDBOX_TOKEN is unset rather than silently falling back.
+#
+# Scheduled only. These tests create and destroy real objects in the sandbox,
+# and running them on every merge request would both slow the pipeline down and
+# make the sandbox account's state depend on pipeline concurrency.
+integration-sandbox:
+  stage: test
+  extends: .py-base
+  image: python:3.10
+  script:
+    - test -n "$GANDI_SANDBOX_TOKEN" || { echo "GANDI_SANDBOX_TOKEN is not set"; exit 1; }
+    - nox --force-color -e tests-3 -- tests/integration --run-destructive -vv
+  artifacts:
+    when: always
+    reports:
+      junit: artifacts/junit-report.xml
+    paths:
+      - artifacts/
+    expire_in: 2 weeks
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "schedule"'
+    - when: manual
+      allow_failure: true
+
+.docs-base:
+  image: python:3.10
+  # sphinxcontrib-spelling wraps the enchant C library, which is not in the
+  # python images. Without it Sphinx aborts loading the extension.
+  before_script:
+    - apt-get update -qq
+    - apt-get install -y -qq libenchant-2-2 hunspell-en-us
+    - python -m pip install --upgrade pip nox
+
+docs:
+  stage: docs
+  extends: .docs-base
+  script:
+    - nox --force-color -e docs
+  artifacts:
+    paths:
+      - docs/_build/html
+    expire_in: 2 weeks
+
+pages:
+  stage: docs
+  extends: .docs-base
+  script:
+    - nox --force-color -e docs
+    - mv docs/_build/html public
+  artifacts:
+    paths:
+      - public
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+# Publish to PyPI via Trusted Publishing (OIDC, no stored token).
+#
+# This is deliberately a MANUAL, tag-only job: nothing is published without an
+# operator clicking "run", so tagging a release does not auto-fire an upload.
+# It relies on a PyPI trusted publisher configured for this project with:
+#   namespace ggiesen / repo saltext-gandi / pipeline .gitlab-ci.yml /
+#   environment "release"
+# The ``environment: release`` below MUST match that PyPI configuration, and the
+# ``aud: pypi`` id_token is what twine exchanges for a short-lived PyPI token.
+publish:
+  stage: publish
+  image: python:3.12
+  variables:
+    # setuptools_scm needs the full history and the tag object to derive a clean
+    # release version; the default shallow clone can yield a "+local" version.
+    GIT_DEPTH: "0"
+  id_tokens:
+    PYPI_ID_TOKEN:
+      aud: pypi
+  environment: release
+  before_script:
+    - python -m pip install --upgrade build twine
+  script:
+    - python -m build
+    - twine check dist/*
+    # No credentials passed: twine uses the PYPI_ID_TOKEN trusted-publishing flow.
+    - twine upload dist/*
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v\d+\.\d+/'
+      when: manual

saltext_gandi-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,150 @@
+---
+minimum_pre_commit_version: 2.4.0
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 3e8a8703264a2f4a69428a0aa4dcb512790b2c8c  # v6.0.0
+    hooks:
+      - id: check-merge-conflict   # Check for files that contain merge conflict strings.
+        args: [--assume-in-merge]
+      - id: trailing-whitespace    # Trim trailing whitespace.
+        args: [--markdown-linebreak-ext=md]
+      - id: mixed-line-ending      # Ensure files use UNIX-style newlines only.
+        args: [--fix=lf]
+      - id: end-of-file-fixer      # Ensure files end with a newline.
+      - id: check-ast              # Check whether files parse as valid Python.
+
+  # ----- Formatting ---------------------------------------------------------------------------->
+  - repo: https://github.com/saltstack/pre-commit-remove-import-headers
+    rev: e79f595c0df31b8cb152c53993ce7c3c64f07cd4  # 1.1.0
+    hooks:
+      - id: remove-import-headers
+
+  - repo: local
+    hooks:
+      - id: check-cli-examples
+        name: Check CLI examples on execution modules
+        entry: python .pre-commit-hooks/check-cli-examples.py
+        language: python
+        files: ^src/saltext/gandi/modules/.*\.py$
+
+  - repo: local
+    hooks:
+      - id: check-gitlab-ci
+        name: Check .gitlab-ci.yml references resolve
+        entry: python .pre-commit-hooks/check-gitlab-ci.py
+        language: python
+        # `language: system` would rely on a `python` on PATH, which is not
+        # guaranteed -- pre-commit invoked from the venv does not put one there.
+        additional_dependencies:
+          - PyYAML
+        files: ^\.gitlab-ci\.yml$
+        pass_filenames: false
+
+      - id: check-docs
+        name: Check rST doc files exist for modules/states
+        entry: python .pre-commit-hooks/make-autodocs.py
+        language: python
+        pass_filenames: false
+
+  - repo: https://github.com/saltstack/salt-rewrite
+    # Automatically rewrite code with known rules
+    rev: 2401c0faef69b6b846c719d611bcfe358234d5d1  # 2.5.2
+    hooks:
+      - id: salt-rewrite
+        alias: rewrite-docstrings
+        name: Salt extensions docstrings auto-fixes
+        files: ^src/saltext/gandi/.*\.py$
+        args: [--silent]
+
+  - repo: https://github.com/saltstack/salt-rewrite
+    # Automatically rewrite code with known rules
+    rev: 2401c0faef69b6b846c719d611bcfe358234d5d1  # 2.5.2
+    hooks:
+      - id: salt-rewrite
+        alias: rewrite-tests
+        name: Rewrite the test suite
+        files: ^tests/.*\.py$
+        args: [--silent, -E, fix_docstrings]
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: 75992aaa40730136014f34227e0135f63fc951b4  # v3.21.2
+    hooks:
+      - id: pyupgrade
+        name: Rewrite Code to be Py3.10+
+        args: [
+          --py310-plus,
+        ]
+        exclude: src/saltext/gandi/version.py
+
+  - repo: https://github.com/PyCQA/isort
+    rev: a333737ed43df02b18e6c95477ea1b285b3de15a  # 8.0.1
+    hooks:
+      - id: isort
+        args: [
+          --py 310,
+        ]
+        exclude: src/saltext/gandi/(__init__|version).py
+
+  - repo: https://github.com/psf/black
+    rev: 87928e6d6761a4a6d22250e1fee5601b3998086e  # 26.5.1
+    hooks:
+      - id: black
+        args: [-l 100]
+        exclude: src/saltext/gandi/version.py
+
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: fda77690955e9b63c6687d8806bafd56a526e45f  # 1.20.0
+    hooks:
+      - id: blacken-docs
+        args: [--skip-errors]
+        files: ^(docs/.*\.rst|src/saltext/gandi/.*\.py)$
+        additional_dependencies:
+          - black==26.5.1
+  # <---- Formatting -----------------------------------------------------------------------------
+
+  # ----- Security ------------------------------------------------------------------------------>
+  - repo: https://github.com/PyCQA/bandit
+    rev: 92ae8b82fb422a639f0ed8d99e96cea769594e08  # 1.9.4
+    hooks:
+      - id: bandit
+        alias: bandit-salt
+        name: Run bandit against the code base
+        args: [--silent, -lll, --skip, B701]
+        exclude: src/saltext/gandi/version.py
+
+  - repo: https://github.com/PyCQA/bandit
+    rev: 92ae8b82fb422a639f0ed8d99e96cea769594e08  # 1.9.4
+    hooks:
+      - id: bandit
+        alias: bandit-tests
+        name: Run bandit against the test suite
+        args: [--silent, -lll, --skip, B701]
+        files: ^tests/.*
+  # <---- Security -------------------------------------------------------------------------------
+
+  # ----- Code Analysis ------------------------------------------------------------------------->
+
+  - repo: local
+    hooks:
+      - id: nox
+        alias: lint-src
+        name: Lint Source Code
+        language: python
+        entry: nox -e lint-code-pre-commit --
+        files: ^((setup|noxfile)|src/.*)\.py$
+        require_serial: true
+        additional_dependencies:
+          - nox==2026.4.10
+          - uv==0.11.26  # Makes this hook much faster
+
+      - id: nox
+        alias: lint-tests
+        name: Lint Tests
+        language: python
+        entry: nox -e lint-tests-pre-commit --
+        files: ^tests/.*\.py$
+        require_serial: true
+        additional_dependencies:
+          - nox==2026.4.10
+          - uv==0.11.26  # Makes this hook much faster
+  # <---- Code Analysis --------------------------------------------------------------------------

saltext_gandi-0.1.0/.pre-commit-hooks/check-cli-examples.py

@@ -0,0 +1,64 @@
+import ast
+import pathlib
+import re
+import sys
+
+CODE_ROOT = pathlib.Path(__file__).resolve().parent.parent
+EXECUTION_MODULES_PATH = CODE_ROOT / "src" / "saltext" / "gandi" / "modules"
+
+
+def check_cli_examples(files):
+    """
+    Check that every function on every execution module provides a CLI example
+    """
+    errors = 0
+    for file in files:
+        path = pathlib.Path(file).resolve()
+        try:
+            relpath = path.relative_to(EXECUTION_MODULES_PATH)
+            if str(relpath.parent) != ".":
+                # We don't want to check nested packages
+                continue
+        except ValueError:
+            # We're only interested in execution modules
+            continue
+        module = ast.parse(path.read_text(), filename=str(path))
+        for funcdef in [node for node in module.body if isinstance(node, ast.FunctionDef)]:
+            if funcdef.name.startswith("_"):
+                # We're not interested in internal functions
+                continue
+
+            docstring = ast.get_docstring(funcdef, clean=False)
+            if not docstring:
+                errors += 1
+                print(
+                    "The function {!r} on '{}' does not have a docstring".format(
+                        funcdef.name,
+                        path.relative_to(CODE_ROOT),
+                    ),
+                    file=sys.stderr,
+                )
+                continue
+
+            if _check_cli_example_present(docstring) is False:
+                errors += 1
+                print(
+                    "The function {!r} on '{}' does not have a 'CLI Example:' in it's docstring".format(
+                        funcdef.name,
+                        path.relative_to(CODE_ROOT),
+                    ),
+                    file=sys.stderr,
+                )
+                continue
+    sys.exit(errors)
+
+
+CLI_EXAMPLE_PRESENT_RE = re.compile(r"CLI Example(?:s)?:")
+
+
+def _check_cli_example_present(docstring):
+    return CLI_EXAMPLE_PRESENT_RE.search(docstring) is not None
+
+
+if __name__ == "__main__":
+    check_cli_examples(sys.argv[1:])