diff --git a/.gitignore b/.gitignore index ae216b5b..f48dda00 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,7 @@ # Community.crypt specific things /changelogs/.plugin-cache.yaml -/tests/integration/inventory/ +/tests/integration/inventory # Created by https://www.gitignore.io/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv diff --git a/.yamllint b/.yamllint new file mode 100644 index 00000000..a6707e29 --- /dev/null +++ b/.yamllint @@ -0,0 +1,53 @@ +--- +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: 2025 Felix Fontein + +extends: default + +ignore: | + /changelogs/ + +rules: + line-length: + max: 300 + level: error + document-start: + present: true + document-end: false + truthy: + level: error + allowed-values: + - 'true' + - 'false' + indentation: + spaces: 2 + indent-sequences: true + key-duplicates: enable + trailing-spaces: enable + new-line-at-end-of-file: disable + hyphens: + max-spaces-after: 1 + empty-lines: + max: 2 + max-start: 0 + max-end: 0 + commas: + max-spaces-before: 0 + min-spaces-after: 1 + max-spaces-after: 1 + colons: + max-spaces-before: 0 + max-spaces-after: 1 + brackets: + min-spaces-inside: 0 + max-spaces-inside: 0 + braces: + min-spaces-inside: 0 + max-spaces-inside: 1 + octal-values: + forbid-implicit-octal: true + forbid-explicit-octal: true + comments: + min-spaces-from-content: 1 + comments-indentation: false diff --git a/.yamllint-docs b/.yamllint-docs new file mode 100644 index 00000000..de8947d7 --- /dev/null +++ b/.yamllint-docs @@ -0,0 +1,54 @@ +--- +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: 2025 Felix Fontein + +extends: default + +ignore: | + /changelogs/ + +rules: + line-length: + max: 160 + level: error + document-start: + present: false + document-end: + present: false + truthy: + level: error + allowed-values: + - 'true' + - 'false' + indentation: + spaces: 2 + indent-sequences: true + key-duplicates: enable + trailing-spaces: enable + new-line-at-end-of-file: disable + hyphens: + max-spaces-after: 1 + empty-lines: + max: 2 + max-start: 0 + max-end: 0 + commas: + max-spaces-before: 0 + min-spaces-after: 1 + max-spaces-after: 1 + colons: + max-spaces-before: 0 + max-spaces-after: 1 + brackets: + min-spaces-inside: 0 + max-spaces-inside: 0 + braces: + min-spaces-inside: 0 + max-spaces-inside: 1 + octal-values: + forbid-implicit-octal: true + forbid-explicit-octal: true + comments: + min-spaces-from-content: 1 + comments-indentation: false diff --git a/.yamllint-examples b/.yamllint-examples new file mode 100644 index 00000000..062ac5aa --- /dev/null +++ b/.yamllint-examples @@ -0,0 +1,54 @@ +--- +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later +# SPDX-FileCopyrightText: 2025 Felix Fontein + +extends: default + +ignore: | + /changelogs/ + +rules: + line-length: + max: 160 + level: error + document-start: + present: true + document-end: + present: false + truthy: + level: error + allowed-values: + - 'true' + - 'false' + indentation: + spaces: 2 + indent-sequences: true + key-duplicates: enable + trailing-spaces: enable + new-line-at-end-of-file: disable + hyphens: + max-spaces-after: 1 + empty-lines: + max: 2 + max-start: 0 + max-end: 0 + commas: + max-spaces-before: 0 + min-spaces-after: 1 + max-spaces-after: 1 + colons: + max-spaces-before: 0 + max-spaces-after: 1 + brackets: + min-spaces-inside: 0 + max-spaces-inside: 0 + braces: + min-spaces-inside: 0 + max-spaces-inside: 1 + octal-values: + forbid-implicit-octal: true + forbid-explicit-octal: true + comments: + min-spaces-from-content: 1 + comments-indentation: false diff --git a/antsibull-nox.toml b/antsibull-nox.toml index ffffdd1a..731cf539 100644 --- a/antsibull-nox.toml +++ b/antsibull-nox.toml @@ -7,6 +7,17 @@ [sessions] +[sessions.lint] +run_isort = false +run_black = false +run_flake8 = false +run_pylint = false +run_yamllint = true +yamllint_config = ".yamllint" +yamllint_config_plugins = ".yamllint-docs" +yamllint_config_plugins_examples = ".yamllint-examples" +run_mypy = false + [sessions.docs_check] validate_collection_refs="all" diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt index 471c9d31..bbdd20bd 100644 --- a/tests/sanity/ignore-2.10.txt +++ b/tests/sanity/ignore-2.10.txt @@ -11,10 +11,14 @@ noxfile.py future-import-boilerplate noxfile.py metaclass-boilerplate plugins/modules/acme_account_info.py validate-modules:return-syntax-error plugins/modules/acme_certificate.py validate-modules:invalid-documentation +plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation plugins/modules/acme_certificate_order_create.py validate-modules:return-syntax-error +plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml plugins/modules/acme_certificate_order_info.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_validate.py validate-modules:return-syntax-error +plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml plugins/modules/acme_challenge_cert_helper.py validate-modules:return-syntax-error plugins/modules/ecs_certificate.py validate-modules:invalid-documentation plugins/modules/get_certificate.py validate-modules:invalid-documentation diff --git a/tests/sanity/ignore-2.11.txt b/tests/sanity/ignore-2.11.txt index 7f5d80da..a74e3911 100644 --- a/tests/sanity/ignore-2.11.txt +++ b/tests/sanity/ignore-2.11.txt @@ -10,10 +10,14 @@ noxfile.py future-import-boilerplate noxfile.py metaclass-boilerplate plugins/modules/acme_account_info.py validate-modules:return-syntax-error plugins/modules/acme_certificate.py validate-modules:invalid-documentation +plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation plugins/modules/acme_certificate_order_create.py validate-modules:return-syntax-error +plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml plugins/modules/acme_certificate_order_info.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_validate.py validate-modules:return-syntax-error +plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml plugins/modules/acme_challenge_cert_helper.py validate-modules:return-syntax-error plugins/modules/ecs_certificate.py validate-modules:invalid-documentation plugins/modules/get_certificate.py validate-modules:invalid-documentation diff --git a/tests/sanity/ignore-2.12.txt b/tests/sanity/ignore-2.12.txt index b7da8d66..d6398a38 100644 --- a/tests/sanity/ignore-2.12.txt +++ b/tests/sanity/ignore-2.12.txt @@ -1,10 +1,14 @@ .azure-pipelines/scripts/publish-codecov.py replace-urlopen plugins/modules/acme_account_info.py validate-modules:return-syntax-error plugins/modules/acme_certificate.py validate-modules:invalid-documentation +plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation plugins/modules/acme_certificate_order_create.py validate-modules:return-syntax-error +plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml plugins/modules/acme_certificate_order_info.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_validate.py validate-modules:return-syntax-error +plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml plugins/modules/acme_challenge_cert_helper.py validate-modules:return-syntax-error plugins/modules/ecs_certificate.py validate-modules:invalid-documentation plugins/modules/get_certificate.py validate-modules:invalid-documentation diff --git a/tests/sanity/ignore-2.13.txt b/tests/sanity/ignore-2.13.txt index 397ad66e..5280e613 100644 --- a/tests/sanity/ignore-2.13.txt +++ b/tests/sanity/ignore-2.13.txt @@ -1,7 +1,11 @@ .azure-pipelines/scripts/publish-codecov.py replace-urlopen plugins/lookup/gpg_fingerprint.py validate-modules:invalid-documentation plugins/modules/acme_certificate.py validate-modules:invalid-documentation +plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation +plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml plugins/modules/ecs_certificate.py validate-modules:invalid-documentation plugins/modules/get_certificate.py validate-modules:invalid-documentation plugins/modules/luks_device.py validate-modules:invalid-documentation diff --git a/tests/sanity/ignore-2.14.txt b/tests/sanity/ignore-2.14.txt index 397ad66e..5280e613 100644 --- a/tests/sanity/ignore-2.14.txt +++ b/tests/sanity/ignore-2.14.txt @@ -1,7 +1,11 @@ .azure-pipelines/scripts/publish-codecov.py replace-urlopen plugins/lookup/gpg_fingerprint.py validate-modules:invalid-documentation plugins/modules/acme_certificate.py validate-modules:invalid-documentation +plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation +plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml plugins/modules/ecs_certificate.py validate-modules:invalid-documentation plugins/modules/get_certificate.py validate-modules:invalid-documentation plugins/modules/luks_device.py validate-modules:invalid-documentation diff --git a/tests/sanity/ignore-2.15.txt b/tests/sanity/ignore-2.15.txt index 87da0412..b2fd37e1 100644 --- a/tests/sanity/ignore-2.15.txt +++ b/tests/sanity/ignore-2.15.txt @@ -1,6 +1,10 @@ .azure-pipelines/scripts/publish-codecov.py replace-urlopen plugins/modules/acme_certificate.py validate-modules:invalid-documentation +plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation +plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml plugins/modules/luks_device.py validate-modules:invalid-documentation tests/ee/roles/smoke/library/smoke_ipaddress.py shebang tests/ee/roles/smoke/library/smoke_pyyaml.py shebang diff --git a/tests/sanity/ignore-2.16.txt b/tests/sanity/ignore-2.16.txt index 16907c34..f2ff67d5 100644 --- a/tests/sanity/ignore-2.16.txt +++ b/tests/sanity/ignore-2.16.txt @@ -1,5 +1,9 @@ plugins/modules/acme_certificate.py validate-modules:invalid-documentation +plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation +plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml +plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml plugins/modules/luks_device.py validate-modules:invalid-documentation tests/ee/roles/smoke/library/smoke_ipaddress.py shebang tests/ee/roles/smoke/library/smoke_pyyaml.py shebang