/usr/lib/python3/dist-packages/restructuredtext_lint/test/test.py is in python3-restructuredtext-lint 0.12.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | import os
import subprocess
import sys
from unittest import TestCase
import yaml
import restructuredtext_lint
__dir__ = os.path.dirname(os.path.abspath(__file__))
valid_rst = os.path.join(__dir__, 'test_files', 'valid.rst')
invalid_rst = os.path.join(__dir__, 'test_files', 'invalid.rst')
rst_lint_path = os.path.join(__dir__, os.pardir, 'cli.py')
"""
# TODO: Implement this as a class (options) with a sugar function that lints a string against a set of options
An invalid rst file
when linted with the `fail_first` parameter
raises on the first error
"""
class TestRestructuredtextLint(TestCase):
def _load_file(self, filepath):
"""Load a file into memory"""
f = open(filepath)
file = f.read()
f.close()
return file
def _lint_file(self, *args, **kwargs):
"""Lint the file and preserve any errors"""
return restructuredtext_lint.lint(*args, **kwargs)
def test_passes_valid_rst(self):
"""A valid reStructuredText file will not raise any errors"""
content = self._load_file(valid_rst)
errors = self._lint_file(content)
self.assertEqual(errors, [])
def test_raises_on_invalid_rst(self):
"""A invalid reStructuredText file when linted raises errors"""
# Load and lint invalid file
content = self._load_file(invalid_rst)
actual_errors = self._lint_file(content, invalid_rst)
# Load in expected errors
expected_yaml = self._load_file(os.path.join(__dir__, 'test_files', 'invalid.yaml'))
expected_errors = yaml.load(expected_yaml)
# Assert errors against expected errors
self.assertEqual(len(actual_errors), len(expected_errors))
for i, error in enumerate(expected_errors):
self.assertEqual(actual_errors[i].line, expected_errors[i]['line'])
self.assertEqual(actual_errors[i].level, expected_errors[i]['level'])
self.assertEqual(actual_errors[i].type, expected_errors[i]['type'])
self.assertEqual(actual_errors[i].source, invalid_rst)
self.assertEqual(actual_errors[i].message, expected_errors[i]['message'])
def test_encoding_utf8(self):
"""A document with utf-8 characters is valid."""
filepath = os.path.join(__dir__, 'test_files', 'utf8.rst')
errors = restructuredtext_lint.lint_file(filepath, encoding='utf-8')
self.assertEqual(errors, [])
def test_second_heading_short_line_number(self):
"""A document with a short second heading raises errors that include a line number
This is a regression test for https://github.com/twolfson/restructuredtext-lint/issues/5
"""
filepath = os.path.join(__dir__, 'test_files', 'second_short_heading.rst')
errors = restructuredtext_lint.lint_file(filepath)
self.assertEqual(errors[0].line, 6)
self.assertEqual(errors[0].source, filepath)
def test_invalid_target(self):
"""A document with an invalid target name raises an error
This is a regression test for https://github.com/twolfson/restructuredtext-lint/issues/6
"""
filepath = os.path.join(__dir__, 'test_files', 'invalid_target.rst')
errors = restructuredtext_lint.lint_file(filepath)
self.assertIn('Unknown target name', errors[0].message)
def test_invalid_line_mismatch(self):
"""A document with an overline/underline mismatch raises an error
This is a regression test for https://github.com/twolfson/restructuredtext-lint/issues/7
"""
filepath = os.path.join(__dir__, 'test_files', 'invalid_line_mismatch.rst')
errors = restructuredtext_lint.lint_file(filepath)
self.assertIn('Title overline & underline mismatch', errors[0].message)
def test_invalid_link(self):
"""A document with a bad link raises an error
This is a regression test for https://github.com/twolfson/restructuredtext-lint/issues/12
"""
filepath = os.path.join(__dir__, 'test_files', 'invalid_link.rst')
errors = restructuredtext_lint.lint_file(filepath)
self.assertIn('Anonymous hyperlink mismatch: 1 references but 0 targets.', errors[0].message)
self.assertIn('Hyperlink target "hello" is not referenced.', errors[1].message)
class TestRestructuredtextLintCLI(TestCase):
""" Tests for 'rst-lint' CLI comand """
def test_rst_lint_filepaths_not_given(self):
"""The `rst-lint` command is available and prints error if no filepath was given."""
with self.assertRaises(subprocess.CalledProcessError):
# python ../cli.py
output = subprocess.check_output((sys.executable, rst_lint_path), stderr=subprocess.STDOUT)
self.assertIn('too few arguments', output)
def test_rst_lint_correct_file(self):
"""The `rst-lint` command prints out 'X is clean' if rst file is correct."""
# python ../cli.py test_files/valid.rst
raw_output = subprocess.check_output((sys.executable, rst_lint_path, valid_rst))
output = str(raw_output).splitlines()
self.assertIn('{filepath} is clean'.format(filepath=valid_rst), output[0])
self.assertEqual(len(output), 1)
def test_rst_lint_many_files(self):
"""The `rst-lint` command accepts many rst file paths and prints respective information for each of them."""
with self.assertRaises(subprocess.CalledProcessError) as e:
# python ../cli.py test_files/valid.rst invalid.rst
subprocess.check_output((sys.executable, rst_lint_path, valid_rst, invalid_rst))
output = str(e.exception.output)
# 'rst-lint' should exit with error code 1:
self.assertEqual(e.exception.returncode, 1)
# There should be a least one valid .rst file:
self.assertIn('is clean', output)
# There should be a least one invalid rst file:
self.assertIn('WARNING', output)
|