src/tex2lyx/test/runtests.py

   1 #! /usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 # file src/tex2lyx/test/runtests.py
   5 # This file is part of LyX, the document processor.
   6 # Licence details can be found in the file COPYING.
   7
   8 # author Georg Baum
   9
  10 # Full author contact details are available in file CREDITS
  11
  12 # This script is a very basic test suite runner for tex2lyx
  13 # The defaults for optional command line arguments are tailored to the
  14 # standard use case of testing without special build settings like a version
  15 # suffix, since I don't know how to transport command line arguments through
  16 # the autotools "make check" mechanism.
  17
  18 import os, string, sys, time, difflib, filecmp, subprocess, re
  19
  20 def usage(prog_name):
  21   return "Usage: %s [uselyx2lyx] [<tex2lyx binary> [[<script dir>] [[<output dir>] [testfile]]]]" % prog_name
  22
  23
  24 def main(argv):
  25     # Parse and manipulate the command line arguments.
  26     skipcount = 0
  27     uselyx2lyx = False
  28     if len(argv) > 1:
  29         if argv[1] == "uselyx2lyx":
  30             uselyx2lyx = True
  31             skipcount = 1
  32     if len(argv) >= 3+skipcount:
  33         sys.path.append(os.path.join(sys.argv[2+skipcount]))
  34     else:
  35         sys.path.append(os.path.join(os.path.dirname(sys.argv[0]), '../../../lib/scripts'))
  36
  37     from lyxpreview_tools import error
  38
  39     if len(argv) < 2+skipcount:
  40         tex2lyx = './tex2lyx'
  41     elif len(argv) <= 5+skipcount:
  42         tex2lyx = argv[1+skipcount]
  43     else:
  44         error(usage(argv[0]))
  45
  46     suffixre = re.search(r'\d+\.\d+$', tex2lyx)
  47     if suffixre:
  48         suffix = suffixre.group()
  49     else:
  50         suffix = ""
  51     lyx = os.path.join(os.path.dirname(tex2lyx), "lyx" + suffix)
  52     inputdir = os.path.dirname(argv[0])
  53     if len(argv) >= 4+skipcount:
  54         outputdir = sys.argv[3+skipcount]
  55     else:
  56 #        outputdir = inputdir
  57         outputdir = os.path.join(os.path.dirname(tex2lyx), "test")
  58
  59     if len(argv) >= 5+skipcount:
  60         files = [sys.argv[4+skipcount]]
  61     else:
  62         files = ['test.ltx', 'test-structure.tex', 'test-insets.tex', \
  63              'test-modules.tex', 'box-color-size-space-align.tex', \
  64              'CJK.tex', 'CJKutf8.tex', 'XeTeX-polyglossia.tex']
  65
  66     errors = []
  67     overwrite = (outputdir == inputdir)
  68     for f in files:
  69         (base, ext) = os.path.splitext(f)
  70         texfile = os.path.join(inputdir, f)
  71         if overwrite:
  72             # we are updating the test references, so use roundtrip to allow
  73             # for checking the LyX export as well.
  74             cmd = '%s -roundtrip -f %s' % (tex2lyx, texfile)
  75         else:
  76             lyxfile = os.path.join(outputdir, base + ".lyx")
  77             cmd = '%s -roundtrip -copyfiles -f %s %s' % (tex2lyx, texfile, lyxfile)
  78         proc = subprocess.Popen(cmd, shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
  79         proc.wait()
  80         err = proc.returncode
  81         errorstring = proc.stderr.read()
  82         if not errorstring is None:
  83             print errorstring
  84         if err != 0:
  85             errors.append(f)
  86         elif not overwrite:
  87             lyxfile1 = getlyxinput(lyx,
  88                         os.path.join(inputdir, base + ".lyx.lyx"),
  89                         os.path.join(outputdir, base + ".lyx1.lyx") , uselyx2lyx)
  90             if lyxfile1 is None:
  91                 errors.append(f)
  92             else:
  93                 lyxfile2 = getlyxinput(lyx,
  94                           os.path.join(outputdir, base + ".lyx"),
  95                           os.path.join(outputdir, base + ".lyx2.lyx"), uselyx2lyx)
  96                 if lyxfile2 is None:
  97                     errors.append(f)
  98                 elif not filecmp.cmp(lyxfile1, lyxfile2, False):
  99                     t1 = time.ctime(os.path.getmtime(lyxfile1))
 100                     t2 = time.ctime(os.path.getmtime(lyxfile2))
 101                     f1 = open(lyxfile1, 'r')
 102                     f2 = open(lyxfile2, 'r')
 103                     lines1 = f1.readlines()
 104                     lines2 = f2.readlines()
 105                     diff = difflib.unified_diff(lines1, lines2, lyxfile1, lyxfile2, t1, t2)
 106                     f1.close()
 107                     f2.close()
 108                     sys.stdout.writelines(diff)
 109                     errors.append(f)
 110
 111     if len(errors) > 0:
 112         error('Converting the following files failed: %s' % ', '.join(errors))
 113
 114 def getlyxinput(lyx, lyxfx, lyxf, uselyx2lyx):
 115     if uselyx2lyx:
 116         cmd = '%s -E lyx %s %s' % (lyx, lyxf, lyxfx)
 117         sys.stdout.writelines(cmd)
 118         if os.system(cmd) != 0:
 119             return None
 120         return lyxf
 121     else:
 122         return lyxfx
 123
 124 if __name__ == "__main__":
 125     main(sys.argv)
 126