/usr/bin/testasciidoc is in asciidoc 8.6.9-3.
This file is owned by root:root, with mode 0o755.
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 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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 | #! /usr/bin/python
USAGE = '''Usage: testasciidoc [OPTIONS] COMMAND
Run AsciiDoc conformance tests specified in configuration FILE.
Commands:
list List tests
run [NUMBER] [BACKEND] Execute tests
update [NUMBER] [BACKEND] Regenerate and update test data
Options:
-f, --conf-file=CONF_FILE
Use configuration file CONF_FILE (default configuration file is
/etc/asciidoc/testasciidoc.conf)
--force
Update all test data overwriting existing data'''
__version__ = '0.1.1'
__copyright__ = 'Copyright (C) 2009 Stuart Rackham'
import os, sys, re, difflib
sys.path.append('/usr/share/asciidoc/')
if sys.platform[:4] == 'java':
# Jython cStringIO is more compatible with CPython StringIO.
import cStringIO as StringIO
else:
import StringIO
import asciidocapi
BACKENDS = ('html4','xhtml11','docbook','html5') # Default backends.
BACKEND_EXT = {'html4':'.html', 'xhtml11':'.html', 'docbook':'.xml',
'slidy':'.html','html5':'.html'}
def iif(condition, iftrue, iffalse=None):
"""
Immediate if c.f. ternary ?: operator.
False value defaults to '' if the true value is a string.
False value defaults to 0 if the true value is a number.
"""
if iffalse is None:
if isinstance(iftrue, basestring):
iffalse = ''
if type(iftrue) in (int, float):
iffalse = 0
if condition:
return iftrue
else:
return iffalse
def message(msg=''):
print >>sys.stderr, msg
def strip_end(lines):
"""
Strip blank strings from the end of list of strings.
"""
for i in range(len(lines)-1,-1,-1):
if not lines[i]:
del lines[i]
else:
break
def normalize_data(lines):
"""
Strip comments and trailing blank strings from lines.
"""
result = [ s for s in lines if not s.startswith('#') ]
strip_end(result)
return result
class AsciiDocTest(object):
def __init__(self):
self.number = None # Test number (1..).
self.name = '' # Optional test name.
self.title = '' # Optional test name.
self.description = [] # List of lines followoing title.
self.source = None # AsciiDoc test source file name.
self.options = []
self.attributes = {}
self.backends = BACKENDS
self.datadir = None # Where output files are stored.
self.disabled = False
def backend_filename(self, backend):
"""
Return the path name of the backend output file that is generated from
the test name and output file type.
"""
return '%s-%s%s' % (
os.path.normpath(os.path.join(self.datadir, self.name)),
backend,
BACKEND_EXT[backend])
def parse(self, lines, confdir, datadir):
"""
Parse conf file test section from list of text lines.
"""
self.__init__()
self.confdir = confdir
self.datadir = datadir
lines = Lines(lines)
while not lines.eol():
l = lines.read_until(r'^%')
if l:
if not l[0].startswith('%'):
if l[0][0] == '!':
self.disabled = True
self.title = l[0][1:]
else:
self.title = l[0]
self.description = l[1:]
continue
reo = re.match(r'^%\s*(?P<directive>[\w_-]+)', l[0])
if not reo:
raise (ValueError, 'illegal directive: %s' % l[0])
directive = reo.groupdict()['directive']
data = normalize_data(l[1:])
if directive == 'source':
if data:
self.source = os.path.normpath(os.path.join(
self.confdir, os.path.normpath(data[0])))
elif directive == 'options':
self.options = eval(' '.join(data))
for i,v in enumerate(self.options):
if isinstance(v, basestring):
self.options[i] = (v,None)
elif directive == 'attributes':
self.attributes = eval(' '.join(data))
elif directive == 'backends':
self.backends = eval(' '.join(data))
elif directive == 'name':
self.name = data[0].strip()
else:
raise (ValueError, 'illegal directive: %s' % l[0])
if not self.title:
self.title = self.source
if not self.name:
self.name = os.path.basename(os.path.splitext(self.source)[0])
def is_missing(self, backend):
"""
Returns True if there is no output test data file for backend.
"""
return not os.path.isfile(self.backend_filename(backend))
def is_missing_or_outdated(self, backend):
"""
Returns True if the output test data file is missing or out of date.
"""
return self.is_missing(backend) or (
os.path.getmtime(self.source)
> os.path.getmtime(self.backend_filename(backend)))
def get_expected(self, backend):
"""
Return expected test data output for backend.
"""
f = open(self.backend_filename(backend))
try:
result = f.readlines()
# Strip line terminators.
result = [ s.rstrip() for s in result ]
finally:
f.close()
return result
def generate_expected(self, backend):
"""
Generate and return test data output for backend.
"""
asciidoc = asciidocapi.AsciiDocAPI()
asciidoc.options.values = self.options
asciidoc.attributes = self.attributes
infile = self.source
outfile = StringIO.StringIO()
asciidoc.execute(infile, outfile, backend)
return outfile.getvalue().splitlines()
def update_expected(self, backend):
"""
Generate and write backend data.
"""
lines = self.generate_expected(backend)
if not os.path.isdir(self.datadir):
print('CREATING: %s' % self.datadir)
os.mkdir(self.datadir)
f = open(self.backend_filename(backend),'w+')
try:
print('WRITING: %s' % f.name)
f.writelines([ s + os.linesep for s in lines])
finally:
f.close()
def update(self, backend=None, force=False):
"""
Regenerate and update expected test data outputs.
"""
if backend is None:
backends = self.backends
else:
backends = [backend]
for backend in backends:
if force or self.is_missing_or_outdated(backend):
self.update_expected(backend)
def run(self, backend=None):
"""
Execute test.
Return True if test passes.
"""
if backend is None:
backends = self.backends
else:
backends = [backend]
result = True # Assume success.
self.passed = self.failed = self.skipped = 0
print('%d: %s' % (self.number, self.title))
if self.source and os.path.isfile(self.source):
print('SOURCE: asciidoc: %s' % self.source)
for backend in backends:
fromfile = self.backend_filename(backend)
if not self.is_missing(backend):
expected = self.get_expected(backend)
strip_end(expected)
got = self.generate_expected(backend)
strip_end(got)
lines = []
for line in difflib.unified_diff(got, expected, n=0):
lines.append(line)
if lines:
result = False
self.failed +=1
lines = lines[3:]
print('FAILED: %s: %s' % (backend, fromfile))
message('+++ %s' % fromfile)
message('--- got')
for line in lines:
message(line)
message()
else:
self.passed += 1
print('PASSED: %s: %s' % (backend, fromfile))
else:
self.skipped += 1
print('SKIPPED: %s: %s' % (backend, fromfile))
else:
self.skipped += len(backends)
if self.source:
msg = 'MISSING: %s' % self.source
else:
msg = 'NO ASCIIDOC SOURCE FILE SPECIFIED'
print(msg)
print('')
return result
class AsciiDocTests(object):
def __init__(self, conffile):
"""
Parse configuration file.
"""
self.conffile = os.path.normpath(conffile)
# All file names are relative to configuration file directory.
self.confdir = os.path.dirname(self.conffile)
self.datadir = self.confdir # Default expected files directory.
self.tests = [] # List of parsed AsciiDocTest objects.
self.globals = {}
f = open(self.conffile)
try:
lines = Lines(f.readlines())
finally:
f.close()
first = True
while not lines.eol():
s = lines.read_until(r'^%+$')
s = [ l for l in s if l] # Drop blank lines.
# Must be at least one non-blank line in addition to delimiter.
if len(s) > 1:
# Optional globals precede all tests.
if first and re.match(r'^%\s*globals$',s[0]):
self.globals = eval(' '.join(normalize_data(s[1:])))
if 'datadir' in self.globals:
self.datadir = os.path.join(
self.confdir,
os.path.normpath(self.globals['datadir']))
else:
test = AsciiDocTest()
test.parse(s[1:], self.confdir, self.datadir)
self.tests.append(test)
test.number = len(self.tests)
first = False
def run(self, number=None, backend=None):
"""
Run all tests.
If number is specified run test number (1..).
"""
self.passed = self.failed = self.skipped = 0
for test in self.tests:
if (not test.disabled or number) and (not number or number == test.number) and (not backend or backend in test.backends):
test.run(backend)
self.passed += test.passed
self.failed += test.failed
self.skipped += test.skipped
if self.passed > 0:
print('TOTAL PASSED: %s' % self.passed)
if self.failed > 0:
print('TOTAL FAILED: %s' % self.failed)
if self.skipped > 0:
print('TOTAL SKIPPED: %s' % self.skipped)
def update(self, number=None, backend=None, force=False):
"""
Regenerate expected test data and update configuratio file.
"""
for test in self.tests:
if (not test.disabled or number) and (not number or number == test.number):
test.update(backend, force=force)
def list(self):
"""
Lists tests to stdout.
"""
for test in self.tests:
print '%d: %s%s' % (test.number, iif(test.disabled,'!'), test.title)
class Lines(list):
"""
A list of strings.
Adds eol() and read_until() to list type.
"""
def __init__(self, lines):
super(Lines, self).__init__()
self.extend([s.rstrip() for s in lines])
self.pos = 0
def eol(self):
return self.pos >= len(self)
def read_until(self, regexp):
"""
Return a list of lines from current position up until the next line
matching regexp.
Advance position to matching line.
"""
result = []
if not self.eol():
result.append(self[self.pos])
self.pos += 1
while not self.eol():
if re.match(regexp, self[self.pos]):
break
result.append(self[self.pos])
self.pos += 1
return result
def usage(msg=None):
if msg:
message(msg + '\n')
message(USAGE)
if __name__ == '__main__':
# Process command line options.
import getopt
try:
opts,args = getopt.getopt(sys.argv[1:], 'f:', ['force'])
except getopt.GetoptError:
usage('illegal command options')
sys.exit(1)
if len(args) == 0:
usage()
sys.exit(1)
conffile = '/etc/asciidoc/testasciidoc.conf'
force = False
for o,v in opts:
if o == '--force':
force = True
if o in ('-f','--conf-file'):
conffile = v
if not os.path.isfile(conffile):
message('missing CONF_FILE: %s' % conffile)
sys.exit(1)
tests = AsciiDocTests(conffile)
cmd = args[0]
number = None
backend = None
for arg in args[1:3]:
try:
number = int(arg)
except ValueError:
backend = arg
if backend and backend not in BACKENDS:
message('illegal BACKEND: %s' % backend)
sys.exit(1)
if number is not None and number not in range(1, len(tests.tests)+1):
message('illegal test NUMBER: %d' % number)
sys.exit(1)
if cmd == 'run':
tests.run(number, backend)
if tests.failed:
exit(1)
elif cmd == 'update':
tests.update(number, backend, force=force)
elif cmd == 'list':
tests.list()
else:
usage('illegal COMMAND: %s' % cmd)
|