Skip to content

Fix Unpin rstcheck #2383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 38 additions & 52 deletions tests/checkers/rstcheck.py
Original file line number Diff line number Diff line change
@@ -1,63 +1,49 @@
"""Sanity test using rstcheck and sphinx."""
"""Sanity test using rstcheck-core and sphinx."""
from __future__ import annotations

import re
import subprocess
from rstcheck_core.runner import RstcheckMainRunner
from rstcheck_core.config import RstcheckConfig
import pathlib
import sys


def main():
paths = sys.argv[1:] or sys.stdin.read().splitlines()

encoding = 'utf-8'

ignore_substitutions = (
'br',
# Read input paths from CLI arguments or stdin
if sys.argv[1:]:
raw_paths = sys.argv[1:]
else:
raw_paths = sys.stdin.read().splitlines()

# Convert to pathlib.Path objects
paths = [pathlib.Path(p) for p in raw_paths]

# Handle case where no paths are provided
if not paths:
print("No files or directories provided for checking.", file=sys.stderr)
sys.exit(1)

# Define the configuration for rstcheck
config = RstcheckConfig(
ignore_roles=[
"ansplugin", "ansopt", "ansretval", "ansval", "ansenvvar", "ansenvvarref"
],
ignore_substitutions=["br"],
report_level="warning", # Adjust report level as needed: "info", "warning", "error", "severe", "none"
recursive=True, # Set to True to check directories recursively
)

cmd = [
sys.executable,
'-c', 'import rstcheck; rstcheck.main();',
'--report', 'warning',
'--ignore-roles', 'ansplugin,ansopt,ansretval,ansval,ansenvvar,ansenvvarref',
'--ignore-substitutions', ','.join(ignore_substitutions),
] + paths

process = subprocess.run(cmd,
stdin=subprocess.DEVNULL,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
check=False,
)

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

# Initialize the runner
runner = RstcheckMainRunner(
check_paths=paths,
rstcheck_config=config,
overwrite_config=True,
)

# Run the checks
exit_code = runner.run()

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One problem with runner.run() is that it prints messages in a slightly different format. First, it prints a general success/failure message that's not of the expected format. Then, it uses the format FILE:LINE: MSG instead of FILE:LINE:COL: MSG.

It might be better to simply run runner.check() and handle what runner.print_result() does here.

# Exit with the appropriate code
sys.exit(exit_code)

if __name__ == '__main__':
main()
1 change: 1 addition & 0 deletions tests/requirements.in
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ sphinx-notfound-page # extension used for the custom 404 page (cowsay)
sphinx-ansible-theme # extension used for the custom docs theme
sphinx-rtd-theme
rstcheck
rstcheck-core
sphinx-copybutton
jinja2 # used by hacking/build_library/build_ansible/command_plugins/generate_man.py and dump_keywords.py
pyyaml # used by ansible-core
Expand Down
4 changes: 4 additions & 0 deletions tests/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ docutils==0.18.1
# antsibull-docs
# antsibull-docutils
# rstcheck
# rstcheck-core
# sphinx
# sphinx-rtd-theme
frozenlist==1.5.0
Expand Down Expand Up @@ -112,6 +113,7 @@ pydantic==2.10.5
# via
# antsibull-core
# antsibull-docs
# rstcheck-core
pydantic-core==2.27.2
# via pydantic
pygments==2.19.1
Expand All @@ -138,6 +140,8 @@ rstcheck==5.0.0
# -r tests/requirements.in
# antsibull-changelog
# antsibull-docs
rstcheck-core==1.2.1
# via -r tests/requirements.in
semantic-version==2.10.0
# via
# antsibull-changelog
Expand Down
Loading