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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
#!%PYTHON_SHEBANG%
# coding: utf-8
# This script performs sanity checking on the documentation:
#
# 1. Man page consistency.
#
# a. man/charliecloud.7 exists.
#
# b. The correct files FOO in bin have:
#
# - doc/FOO.rst
# - doc/man/FOO.N
# - an entry under “See also” in charliecloud.7
#
# Where “N” is the appropriate man section number (e.g. 1 for
# executables). Currently, the “correct” files in bin are:
#
# - All executables
# - ch-completion.bash
#
# c. There aren’t any unexpcected .rst files, man files, or charliecloud.7
# “See also” entries.
#
# d. Synopsis in “FOO --help” (if applicable) matches FOO.rst and conf.py.
from __future__ import print_function
import glob
import re
import os
import subprocess
import sys
# Dict of documentation files. Executables are added in “main()”. Files that are
# not executables should be manually added here.
man_targets = {"charliecloud": {"synopsis": "",
"sec": 7},
"ch-completion.bash": {"synopsis": "Tab completion for the Charliecloud command line.",
"sec": 7}}
CH_BASE = os.path.abspath(os.path.dirname(__file__) + "/..")
if (not os.path.isfile("%s/bin/ch-run" % CH_BASE)):
print("not found: %s/bin/ch-run" % CH_BASE, file=sys.stderr)
sys.exit(1)
win = True
def main():
check_man()
if (win):
print("ok")
sys.exit(0)
else:
sys.exit(1)
# This is the function that actually performs the sanity check for the docs (see
# the comment at the top of this file).
def check_man():
global man_targets
# Add entries for executables to “man_targets”. “sec” is set to 1, “synopsis”
# is set using the executable’s “--help” option (see “help_get”). Note that
# this code assumes that a file is an executable if the execute bit for any
# permission group.
os.chdir(CH_BASE + "/bin")
for f in os.listdir("."):
if (os.path.isfile(f) and os.stat(f).st_mode & 0o111):
man_targets[f] = {"synopsis": help_get(f), "sec": 1}
# Check that all the expected .rst files are in doc/ and that no unexpected
# .rst files are present.
os.chdir(CH_BASE + "/doc")
man_rsts = set(glob.glob("ch*.rst"))
man_rsts_expected = { i + ".rst" for i in man_targets }
lose_lots("unexpected .rst", man_rsts - man_rsts_expected)
lose_lots("missing .rst", man_rsts_expected - man_rsts)
# Construct a dictionary of synopses from the .rst files in doc. We’ll
# compare these against the synopses in “man_targets”, which have either been
# entered manually (for non-executables), or obtained from the help message
# (for executables).
man_synopses = dict()
for man in man_targets:
m = re.search(r"^\s+(.+)$\n\n\n^Synopsis", open(man + ".rst").read(),
re.MULTILINE)
if (m is not None):
man_synopses[man] = m[1]
elif (man_targets[man]["synopsis"] == ""):
# No synopsis expected.
man_synopses[man] = ""
# Check for missing or unexpected synopses.
lose_lots("missing synopsis", set(man_targets) - set(man_synopses))
lose_lots("unexpected synopsis", set(man_synopses) - set(man_targets))
# Check for synopses that don’t match the expectation provided in
# “man_targets”.
lose_lots("bad synopsis in man page",
{ "%s: %s (expected: %s)" % (p, man_targets[p]["synopsis"], s)
for (p, s) in man_synopses.items()
if ( p in man_targets
and summary_unrest(s) != man_targets[p]["synopsis"])
and "deprecated" not in s.lower() })
# Check for “see also” entries in charliecloud.rst.
sees = { m[0] for m in re.finditer(r"ch-[a-z0-9-.]+\([1-8]\)",
open("charliecloud.rst").read()) }
sees_expected = { i + "(%d)" % (man_targets[i]["sec"]) for i in man_targets } - {"charliecloud(7)"}
lose_lots("unexpected see-also in charliecloud.rst", sees - sees_expected)
lose_lots("missing see-also in charliecloud.rst", sees_expected - sees)
# Check for consistency with “conf.py”
conf = {}
execfile("./conf.py", conf)
for (docname, name, desc, authors, section) in conf["man_pages"]:
if (docname != name):
lose("conf.py: startdocname != name: %s != %s" % (docname, name))
if (len(authors) != 0):
lose("conf.py: bad authors: %s: %s" % (name, authors))
if (name != "charliecloud"):
if (section != man_targets[name]["sec"]):
lose("conf.py: bad section: %s: %s != %d" % (name, section, man_targets[name]["sec"]))
if (name not in man_targets):
lose("conf.py: unexpected man page: %s" % name)
elif (desc + "." != man_targets[name]["synopsis"] and "deprecated" not in desc.lower()):
lose("conf.py: bad summary: %s: %s" % (name, desc))
# Check that all expected man pages are present, and *only* the expected man
# pages.
os.chdir(CH_BASE + "/doc/man")
mans = set(glob.glob("*.[1-8]"))
mans_expected = { i + ".%d" % (man_targets[i]["sec"]) for i in man_targets}
lose_lots("unexpected man", mans - mans_expected)
lose_lots("missing man", mans_expected - mans)
try:
execfile # Python 2
except NameError:
# Python 3; provide our own. See: https://stackoverflow.com/questions/436198
def execfile(path, globals_):
with open(path, "rb") as fp:
code = compile(fp.read(), path, "exec")
exec(code, globals_)
# Get an executable’s synopsis from its help message.
def help_get(prog):
if (not os.path.isfile(prog)):
lose("not a file: %s" % prog)
try:
out = subprocess.check_output(["./" + prog, "--help"],
universal_newlines=True,
stderr=subprocess.STDOUT)
except Exception as x:
lose("%s --help failed: %s" % (prog, str(x)))
return None
m = re.search(r"^(?:[Uu]sage:[^\n]+\n| +[^\n]+\n|\n)*([^\n]+)\n", out)
if (m is None):
lose("%s --help: no summary found" % prog)
return None
else:
return m[1]
def lose(msg):
print(msg)
global win
win = False
def lose_lots(prefix, losers):
for loser in losers:
lose("%s: %s" % (prefix, loser))
def summary_unrest(rest):
t = rest
t = t.replace(r":code:`", '"')
t = t.replace(r"`", '"')
return t
if (__name__ == "__main__"):
main()
|
