initial commit

.devcontainer/devcontainer.json

@@ -0,0 +1,24 @@
+{
+ "name": "ansible-dev-container-codespaces",
+ "image": "ghcr.io/ansible/community-ansible-dev-tools:latest",
+ "containerUser": "podman",
+ "runArgs": [
+ "--security-opt",
+ "seccomp=unconfined",
+ "--security-opt",
+ "label=disable",
+ "--cap-add=SYS_ADMIN",
+ "--cap-add=SYS_RESOURCE",
+ "--device",
+ "/dev/fuse",
+ "--security-opt",
+ "apparmor=unconfined",
+ "--hostname=ansible-dev-container"
+ ],
+ "updateRemoteUserUID": true,
+ "customizations": {
+ "vscode": {
+ "extensions": ["redhat.ansible"]
+ }
+ }
+}

.devcontainer/docker/devcontainer.json

@@ -0,0 +1,24 @@
+{
+ "name": "ansible-dev-container-docker",
+ "image": "ghcr.io/ansible/community-ansible-dev-tools:latest",
+ "containerUser": "podman",
+ "runArgs": [
+ "--security-opt",
+ "seccomp=unconfined",
+ "--security-opt",
+ "label=disable",
+ "--cap-add=SYS_ADMIN",
+ "--cap-add=SYS_RESOURCE",
+ "--device",
+ "/dev/fuse",
+ "--security-opt",
+ "apparmor=unconfined",
+ "--hostname=ansible-dev-container"
+ ],
+ "updateRemoteUserUID": true,
+ "customizations": {
+ "vscode": {
+ "extensions": ["redhat.ansible"]
+ }
+ }
+}

.devcontainer/podman/devcontainer.json

@@ -0,0 +1,25 @@
+{
+ "name": "ansible-dev-container-podman",
+ "image": "ghcr.io/ansible/community-ansible-dev-tools:latest",
+ "containerUser": "podman",
+ "runArgs": [
+ "--security-opt",
+ "seccomp=unconfined",
+ "--security-opt",
+ "label=disable",
+ "--cap-add=SYS_ADMIN",
+ "--cap-add=SYS_RESOURCE",
+ "--device",
+ "/dev/fuse",
+ "--security-opt",
+ "apparmor=unconfined",
+ "--userns=keep-id:uid=1000,gid=1000",
+ "--hostname=ansible-dev-container"
+ ],
+ "updateRemoteUserUID": true,
+ "customizations": {
+ "vscode": {
+ "extensions": ["redhat.ansible"]
+ }
+ }
+}

.github/workflows/release.yml

@@ -0,0 +1,14 @@
+---
+name: Release rh.abc
+
+on: # yamllint disable-line rule:truthy
+ release:
+ types: [published]
+
+jobs:
+ release_automation_hub:
+ uses: ansible/ansible-content-actions/.github/workflows/release_galaxy.yaml@main
+ with:
+ environment: release
+ secrets:
+ ansible_galaxy_api_key: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}

.github/workflows/tests.yml

@@ -0,0 +1,52 @@
+---
+name: "CI"
+
+concurrency:
+ group: ${{ github.head_ref || github.run_id }}
+ cancel-in-progress: true
+
+on: # yamllint disable-line rule:truthy
+ pull_request:
+ branches: [main]
+ workflow_dispatch:
+ schedule:
+ - cron: '0 0 * * *'
+
+jobs:
+ changelog:
+ uses: ansible/ansible-content-actions/.github/workflows/changelog.yaml@main
+ if: github.event_name == 'pull_request'
+ build-import:
+ uses: ansible/ansible-content-actions/.github/workflows/build_import.yaml@main
+ ansible-lint:
+ uses: ansible/ansible-content-actions/.github/workflows/ansible_lint.yaml@main
+ sanity:
+ uses: ansible/ansible-content-actions/.github/workflows/sanity.yaml@main
+ unit-galaxy:
+ uses: ansible/ansible-content-actions/.github/workflows/unit.yaml@main
+ unit-source:
+ uses: ansible-network/github_actions/.github/workflows/unit_source.yml@main
+ with:
+ collection_pre_install: >-
+ git+https://github.com/ansible-collections/ansible.utils.git
+ git+https://github.com/ansible-collections/ansible.netcommon.git
+ all_green:
+ if: ${{ always() }}
+ needs:
+ - changelog
+ - build-import
+ - sanity
+ - unit-galaxy
+ - unit-source
+ - ansible-lint
+ runs-on: ubuntu-latest
+ steps:
+ - run: >-
+ python -c "assert 'failure' not in
+ set([
+ '${{ needs.changelog.result }}',
+ '${{ needs.sanity.result }}',
+ '${{ needs.unit-galaxy.result }}'
+ '${{ needs.ansible-lint.result }}'
+ '${{ needs.unit-source.result }}'
+ ])"

.gitignore

@@ -0,0 +1,161 @@
+# https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+# 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/
+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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+# For a library or package, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# poetry
+# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+# This is especially recommended for binary packages to ensure reproducibility, and is more
+# commonly ignored for libraries.
+# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+# in version control.
+# https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+# and can be added to the global gitignore or merged into this file. For a more nuclear
+# option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.isort.cfg

@@ -0,0 +1,6 @@
+[settings]
+known_first_party=ansible_collections.rh.abc
+line_length=100
+lines_after_imports=2
+lines_between_types=1
+profile=black

.pre-commit-config.yaml

@@ -0,0 +1,50 @@
+---
+repos:
+ - repo: https://github.com/ansible-network/collection_prep
+ rev: 1.1.1
+ hooks:
+ - id: update-docs
+
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v4.4.0
+ hooks:
+ - id: check-merge-conflict
+ - id: check-symlinks
+ - id: debug-statements
+ - id: end-of-file-fixer
+ - id: no-commit-to-branch
+ args: [--branch, main]
+ - id: trailing-whitespace
+
+ - repo: https://github.com/asottile/add-trailing-comma
+ rev: v3.0.0
+ hooks:
+ - id: add-trailing-comma
+
+ - repo: https://github.com/pre-commit/mirrors-prettier
+ rev: "v3.0.0"
+ hooks:
+ - id: prettier
+ entry: env CI=1 bash -c "prettier --list-different . || ec=$? && prettier --loglevel=error --write . && exit $ec"
+ pass_filenames: false
+ args: []
+ additional_dependencies:
+ - prettier
+ - prettier-plugin-toml
+
+ - repo: https://github.com/PyCQA/isort
+ rev: 5.12.0
+ hooks:
+ - id: isort
+ name: Sort import statements using isort
+ args: ["--filter-files"]
+
+ - repo: https://github.com/psf/black
+ rev: 23.7.0
+ hooks:
+ - id: black
+
+ - repo: https://github.com/pycqa/flake8
+ rev: 7.0.0
+ hooks:
+ - id: flake8

.prettierignore

@@ -0,0 +1,19 @@
+# files we don't want prettier to ever to look into
+.*/
+coverage/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# A linked collection directory created by pytest-ansible-units
+collections/
+
+tests/output/
+
+README.md

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+ "recommendations": ["redhat.ansible"]
+}

CHANGELOG.rst

@@ -0,0 +1,6 @@
+This should be updated by antsibull-changelog. Do not edit this manually!
+
+See https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.rst for
+information on how to use antsibull-changelog.
+
+Check out ``changelogs/config.yaml`` for its configuration. You need to change at least the ``title`` field in there.

CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Community Code of Conduct
+
+Please see the official [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).