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
|
#!/usr/bin/python
# Copyright (C) 2019 Jelmer Vernooij
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Tests for readme parsing."""
import os
import platform
from unittest import TestCase, TestSuite
from upstream_ontologist.readme import (
description_from_readme_md,
description_from_readme_rst,
description_from_readme_plain,
)
class ReadmeTestCase(TestCase):
def __init__(self, path):
super().__init__()
self.path = path
def setUp(self):
super().setUp()
self.maxDiff = None
def runTest(self):
readme_md = None
readme_rst = None
readme_plain = None
description = None
for entry in os.scandir(self.path):
if entry.name.endswith('~'):
continue
base, ext = os.path.splitext(entry.name)
if entry.name == 'description':
with open(entry.path) as f:
description = f.read()
elif base == "README":
if ext == '.md':
with open(entry.path) as f:
readme_md = f.read()
elif ext == '.rst':
with open(entry.path) as f:
readme_rst = f.read()
elif ext == '':
with open(entry.path) as f:
readme_plain = f.read()
else:
raise NotImplementedError(ext)
else:
raise NotImplementedError(ext)
if readme_md is not None:
try:
import markdown # noqa: F401
except ModuleNotFoundError:
self.skipTest(
'Skipping README.md tests, markdown not available')
actual_description, unused_md = description_from_readme_md(
readme_md)
self.assertEqual(actual_description, description)
if readme_rst is not None:
if platform.python_implementation() == "PyPy":
self.skipTest('Skipping README.rst tests on pypy')
try:
import docutils # noqa: F401
except ModuleNotFoundError:
self.skipTest(
'Skipping README.rst tests, docutils not available')
actual_description, unused_rst = description_from_readme_rst(
readme_rst)
self.assertEqual(actual_description, description)
if readme_plain is not None:
actual_description, unused_rst = description_from_readme_plain(
readme_plain)
self.assertEqual(actual_description, description)
def test_suite():
suite = TestSuite()
for entry in os.scandir(os.path.join(os.path.dirname(__file__), 'readme_data')):
suite.addTest(ReadmeTestCase(entry.path))
return suite
|
