Limit rstcheck sanity test to ansible-core. (#73391)

changelogs/fragments/ansible-test-rstcheck-core-only.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - ansible-test - The ``rstcheck`` sanity test is no longer used for collections, but continues to be used for ansible-core.

test/lib/ansible_test/_data/requirements/sanity.rstcheck.txt

@@ -1 +0,0 @@
-rstcheck

test/lib/ansible_test/_data/sanity/rstcheck/ignore-substitutions.txt

@@ -1,5 +0,0 @@
-version
-release
-today
-br
-_

test/lib/ansible_test/_internal/sanity/rstcheck.py

@@ -1,95 +0,0 @@
-"""Sanity test using rstcheck."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
-
-import os
-
-from .. import types as t
-
-from ..sanity import (
-    SanitySingleVersion,
-    SanityMessage,
-    SanityFailure,
-    SanitySuccess,
-    SANITY_ROOT,
-)
-
-from ..target import (
-    TestTarget,
-)
-
-from ..util import (
-    SubprocessError,
-    parse_to_list_of_dict,
-    read_lines_without_comments,
-    find_python,
-)
-
-from ..util_common import (
-    run_command,
-)
-
-from ..config import (
-    SanityConfig,
-)
-
-
-class RstcheckTest(SanitySingleVersion):
-    """Sanity test using rstcheck."""
-    def filter_targets(self, targets):  # type: (t.List[TestTarget]) -> t.List[TestTarget]
-        """Return the given list of test targets, filtered to include only those relevant for the test."""
-        return [target for target in targets if os.path.splitext(target.path)[1] in ('.rst',)]
-
-    def test(self, args, targets, python_version):
-        """
-        :type args: SanityConfig
-        :type targets: SanityTargets
-        :type python_version: str
-        :rtype: TestResult
-        """
-        ignore_file = os.path.join(SANITY_ROOT, 'rstcheck', 'ignore-substitutions.txt')
-        ignore_substitutions = sorted(set(read_lines_without_comments(ignore_file, remove_blank_lines=True)))
-
-        settings = self.load_processor(args)
-
-        paths = [target.path for target in targets.include]
-
-        cmd = [
-            find_python(python_version),
-            '-m', 'rstcheck',
-            '--report', 'warning',
-            '--ignore-substitutions', ','.join(ignore_substitutions),
-        ] + paths
-
-        try:
-            stdout, stderr = run_command(args, cmd, capture=True)
-            status = 0
-        except SubprocessError as ex:
-            stdout = ex.stdout
-            stderr = ex.stderr
-            status = ex.status
-
-        if stdout:
-            raise SubprocessError(cmd=cmd, status=status, stderr=stderr, stdout=stdout)
-
-        if args.explain:
-            return SanitySuccess(self.name)
-
-        pattern = r'^(?P<path>[^:]*):(?P<line>[0-9]+): \((?P<level>INFO|WARNING|ERROR|SEVERE)/[0-4]\) (?P<message>.*)$'
-
-        results = parse_to_list_of_dict(pattern, stderr)
-
-        results = [SanityMessage(
-            message=r['message'],
-            path=r['path'],
-            line=int(r['line']),
-            column=0,
-            level=r['level'],
-        ) for r in results]
-
-        settings.process_errors(results, paths)
-
-        if results:
-            return SanityFailure(self.name, messages=results)
-
-        return SanitySuccess(self.name)

test/sanity/code-smell/rstcheck.json

@@ -0,0 +1,6 @@
+{
+    "output": "path-line-column-message",
+    "extensions": [
+        ".rst"
+    ]
+}

test/sanity/code-smell/rstcheck.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+"""Sanity test using rstcheck and sphinx."""
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import re
+import subprocess
+import sys
+
+
+def main():
+    paths = sys.argv[1:] or sys.stdin.read().splitlines()
+
+    encoding = 'utf-8'
+
+    ignore_substitutions = (
+        'br',
+    )
+
+    cmd = [
+        sys.executable,
+        '-m', 'rstcheck',
+        '--report', 'warning',
+        '--ignore-substitutions', ','.join(ignore_substitutions),
+    ] + paths
+
+    process = subprocess.run(cmd,
+                             stdin=subprocess.DEVNULL,
+                             stdout=subprocess.PIPE,
+                             stderr=subprocess.PIPE,
+                             )
+
+    if process.stdout:
+        raise Exception(process.stdout)
+
+    pattern = re.compile(r'^(?P<path>[^:]*):(?P<line>[0-9]+): \((?P<level>INFO|WARNING|ERROR|SEVERE)/[0-4]\) (?P<message>.*)$')
+
+    results = parse_to_list_of_dict(pattern, process.stderr.decode(encoding))
+
+    for result in results:
+        print('%s:%s:%s: %s' % (result['path'], result['line'], 0, result['message']))
+
+
+def parse_to_list_of_dict(pattern, value):
+    matched = []
+    unmatched = []
+
+    for line in value.splitlines():
+        match = re.search(pattern, line)
+
+        if match:
+            matched.append(match.groupdict())
+        else:
+            unmatched.append(line)
+
+    if unmatched:
+        raise Exception('Pattern "%s" did not match values:\n%s' % (pattern, '\n'.join(unmatched)))
+
+    return matched
+
+
+if __name__ == '__main__':
+    main()

test/sanity/code-smell/rstcheck.requirements.txt

@@ -0,0 +1,2 @@
+rstcheck
+sphinx  # required for full functionality