From f33530dd61417bc11ba01dd3fa33fd6cc866f1cb Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Fri, 28 May 2021 06:49:01 +0200 Subject: [PATCH] Add extra docs tests (#2663) (#2665) * Add extra docs tests. * Linting. * Fix copy'n'paste error. (cherry picked from commit 14f13904d63dcffab2069b5be69ebe46a2945fef) Co-authored-by: Felix Fontein --- tests/sanity/extra/extra-docs.json | 10 ++++++++++ tests/sanity/extra/extra-docs.py | 23 +++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 tests/sanity/extra/extra-docs.json create mode 100755 tests/sanity/extra/extra-docs.py diff --git a/tests/sanity/extra/extra-docs.json b/tests/sanity/extra/extra-docs.json new file mode 100644 index 0000000000..a62ef37e63 --- /dev/null +++ b/tests/sanity/extra/extra-docs.json @@ -0,0 +1,10 @@ +{ + "include_symlinks": false, + "prefixes": [ + "docs/docsite/" + ], + "output": "path-line-column-message", + "requirements": [ + "antsibull" + ] +} diff --git a/tests/sanity/extra/extra-docs.py b/tests/sanity/extra/extra-docs.py new file mode 100755 index 0000000000..f4b7f59d3c --- /dev/null +++ b/tests/sanity/extra/extra-docs.py @@ -0,0 +1,23 @@ +#!/usr/bin/env python +# Copyright (c) Ansible Project +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +"""Check extra collection docs with antsibull-lint.""" +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import os +import sys +import subprocess + + +def main(): + """Main entry point.""" + if not os.path.isdir(os.path.join('docs', 'docsite')): + return + p = subprocess.run(['antsibull-lint', 'collection-docs', '.'], check=False) + if p.returncode not in (0, 3): + print('{0}:0:0: unexpected return code {1}'.format(sys.argv[0], p.returncode)) + + +if __name__ == '__main__': + main()