Added missing files and build instructions

1 files changed, 201 insertions, 0 deletions

diff --git a/testing/runtests.py b/testing/runtests.py
new file mode 100644
index 0000000..d0e18dc
--- /dev/null
+++ b/testing/runtests.py
@@ -0,0 +1,201 @@
+#!/usr/bin/python
+
+from __future__ import print_function
+import argparse, glob, itertools, re, shutil, os, sys
+
+config_reg = re.compile('.*\/\/\s*(?P<name>\S+):\s*(?P<value>.*)$')
+
+class Tester:
+	def __init__(self,args,test):
+		self.args      = args
+		self.test      = test
+		self.update    = args.updateref
+		self.config    = self.get_config()
+		self.test_name = '[%s]: %s' % (self.test,self.config['objective'][0])
+		self.test_id   = self.test.split('_')[0]
+		if self.update:
+			self.test_out = self.args.inputdir+'/'+self.test_id
+		else:
+			self.test_out = self.args.outputdir+'/test_output_'+self.test_id
+		self.prepare_test()
+
+	def compare_ok(self,got_file,expected_file,name):
+		if not os.path.isfile(got_file):
+			return (True,'%s absent' % got_file)
+		elif not os.path.isfile(expected_file):
+			return (True,'%s absent' % expected_file)
+		else:
+			diff = os.popen('diff -u %s %s' % (got_file,expected_file)).read()
+			if diff:
+				return (True,'Difference between generated output and reference:\n%s' % diff)
+		return (False,'')
+
+	def get_config(self):
+		config = {}
+		with open(self.args.inputdir+'/'+self.test,'r') as f:
+			for line in f.readlines():
+				m = config_reg.match(line)
+				if m:
+					key   = m.group('name')
+					value = m.group('value')
+					if (key=='config'):
+						value = value.replace('$INPUTDIR',self.args.inputdir)
+					#print('key=%s value=%s' % (key,value))
+					if key in config:
+						config[key].append(value)
+					else:
+						config[key] = [value]
+		return config
+
+	def prepare_test(self):
+		# prepare test environment
+		shutil.rmtree(self.test_out,ignore_errors=True)
+		os.mkdir(self.test_out)
+		shutil.copy(self.args.inputdir+'/Doxyfile',self.test_out)
+		with open(self.test_out+'/Doxyfile','a') as f:
+			print('INPUT=%s/%s' % (self.args.inputdir,self.test), file=f)
+			print('STRIP_FROM_PATH=%s' % self.args.inputdir, file=f)
+			print('XML_OUTPUT=%s/out' % self.test_out, file=f)
+			print('EXAMPLE_PATH=%s' % self.args.inputdir, file=f)
+			if 'config' in self.config:
+				for option in self.config['config']:
+					print(option, file=f)
+
+		if 'check' not in self.config or not self.config['check']:
+			print('Test doesn\'t specify any files to check')
+			sys.exit(1)
+
+		# run doxygen
+		if os.system('%s %s/Doxyfile 2>/dev/null' % (self.args.doxygen,self.test_out))!=0:
+			print('Error: failed to run %s on %s/Doxyfile' % (self.args.doxygen,self.test_out));
+			sys.exit(1)
+
+	# update the reference data for this test
+	def update_test(self,testmgr):
+		print('Updating reference for %s' % self.test_name)
+
+		if 'check' in self.config:
+			for check in self.config['check']:
+				check_file='%s/out/%s' % (self.test_out,check)
+				# check if the file we need to check is actually generated
+				if not os.path.isfile(check_file):
+					print('Non-existing file %s after \'check:\' statement' % check_file)
+					return
+				# convert output to canonical form
+				data = os.popen('%s --format --noblanks --nowarning %s' % (self.args.xmllint,check_file)).read()
+				if data:
+					# strip version
+					data = re.sub(r'xsd" version="[0-9.-]+"','xsd" version=""',data).rstrip('\n')
+				else:
+					print('Failed to run %s on the doxygen output file %s' % (self.args.xmllint,self.test_out))
+					return
+				out_file='%s/%s' % (self.test_out,check)
+				with open(out_file,'w') as f:
+					print(data,file=f)
+		shutil.rmtree(self.test_out+'/out',ignore_errors=True)
+		os.remove(self.test_out+'/Doxyfile')
+
+	# check the relevant files of a doxygen run with the reference material
+	def perform_test(self,testmgr):
+		# look for files to check against the reference
+		if 'check' in self.config:
+			for check in self.config['check']:
+				check_file='%s/out/%s' % (self.test_out,check)
+				# check if the file we need to check is actually generated
+				if not os.path.isfile(check_file):
+					testmgr.ok(False,self.test_name,msg='Non-existing file %s after \'check:\' statement' % check_file)
+					return
+				# convert output to canonical form
+				data = os.popen('%s --format --noblanks --nowarning %s' % (self.args.xmllint,check_file)).read()
+				if data:
+					# strip version
+					data = re.sub(r'xsd" version="[0-9.-]+"','xsd" version=""',data).rstrip('\n')
+				else:
+					testmgr.ok(False,self.test_name,msg='Failed to run %s on the doxygen output file %s' % (self.args.xmllint,self.test_out))
+					return
+				out_file='%s/%s' % (self.test_out,check)
+				with open(out_file,'w') as f:
+					print(data,file=f)
+				ref_file='%s/%s/%s' % (self.args.inputdir,self.test_id,check)
+				(failed,msg) = self.compare_ok(out_file,ref_file,self.test_name)
+				if failed:
+					testmgr.ok(False,self.test_name,msg)
+					return
+		shutil.rmtree(self.test_out,ignore_errors=True)
+		testmgr.ok(True,self.test_name)
+
+	def run(self,testmgr):
+		if self.update:
+			self.update_test(testmgr)
+		else:
+			self.perform_test(testmgr)
+
+class TestManager:
+	def __init__(self,args,tests):
+		self.args  = args
+		self.tests = tests
+		self.num_tests = len(tests)
+		self.count=1
+		self.passed=0
+		print('1..%d' % self.num_tests)
+
+	def ok(self,result,test_name,msg='Ok'):
+		if result:
+			print('ok %s - %s' % (self.count,test_name))
+			self.passed = self.passed + 1
+		else:
+			print('not ok %s - %s' % (self.count,test_name))
+			print('-------------------------------------')
+			print(msg)
+			print('-------------------------------------')
+		self.count = self.count + 1
+
+	def result(self):
+		if self.passed==self.num_tests:
+			print('All tests passed!')
+		else:
+			print('%d out of %s tests failed' % (self.num_tests-self.passed,self.num_tests))
+		return 0 if self.passed==self.num_tests else 1
+
+	def perform_tests(self):
+		for test in self.tests:
+			tester = Tester(self.args,test)
+			tester.run(self)
+		return 0 if self.args.updateref else self.result()
+
+def main():
+	# argument handling
+	parser = argparse.ArgumentParser(description='run doxygen tests')
+	parser.add_argument('--updateref',help='update the reference data for a test',action="store_true")
+	parser.add_argument('--doxygen',nargs='?',default='doxygen',help='path/name of the doxygen executable')
+	parser.add_argument('--xmllint',nargs='?',default='xmllint',help='path/name of the xmllint executable')
+	parser.add_argument('--id',nargs='+',dest='ids',action='append',type=int,help='id of the test to perform')
+	parser.add_argument('--all',help='perform all tests',action="store_true")
+	parser.add_argument('--inputdir',nargs='?',default='.',help='input directory containing the tests')
+	parser.add_argument('--outputdir',nargs='?',default='.',help='output directory to write the doxygen output to')
+	args = parser.parse_args()
+
+    # sanity check
+	if (not args.updateref is None) and (args.ids is None) and (args.all is None):
+		parser.error('--updateref requires either --id or --all')
+
+	starting_directory = os.getcwd()
+	os.chdir(args.inputdir)
+    # find the tests to run
+	if args.ids: # test ids are given by user
+		tests = []
+		for id in list(itertools.chain.from_iterable(args.ids)):
+			tests.append(glob.glob('%s_*'%id))
+			tests.append(glob.glob('0%s_*'%id))
+			tests.append(glob.glob('00%s_*'%id))
+		tests = list(itertools.chain.from_iterable(tests))
+	else: # find all tests
+		tests = glob.glob('[0-9][0-9][0-9]_*')
+	os.chdir(starting_directory)
+
+	# create test manager to run the tests
+	testManager = TestManager(args,tests)
+	sys.exit(testManager.perform_tests())
+
+if __name__ == '__main__':
+	main()