2 ##########################################################################
4 # Copyright 2011 Jose Fonseca
7 # Permission is hereby granted, free of charge, to any person obtaining a copy
8 # of this software and associated documentation files (the "Software"), to deal
9 # in the Software without restriction, including without limitation the rights
10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 # copies of the Software, and to permit persons to whom the Software is
12 # furnished to do so, subject to the following conditions:
14 # The above copyright notice and this permission notice shall be included in
15 # all copies or substantial portions of the Software.
17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 ##########################################################################/
27 '''Main test driver.'''
40 def popen(command, *args, **kwargs):
41 if kwargs.get('cwd', None) is not None:
42 sys.stdout.write('cd %s && ' % kwargs['cwd'])
44 for name, value in kwargs['env'].iteritems():
45 if value != os.environ.get(name, None):
46 sys.stdout.write('%s=%s ' % (name, value))
47 sys.stdout.write(' '.join(command) + '\n')
49 return subprocess.Popen(command, *args, **kwargs)
52 def _get_build_path(path):
53 if options.build is not None:
54 path = os.path.abspath(os.path.join(options.build, path))
55 if not os.path.exists(path):
56 sys.stderr.write('error: %s does not exist\n' % path)
60 def _get_build_program(program):
61 if platform.system() == 'Windows':
63 return _get_build_path(program)
72 def __init__(self, name, args, cwd=None, build=None, results = '.'):
77 self.results = results
79 if not os.path.exists(results):
85 p = popen(self.args, cwd=self.cwd)
88 self.skip('application returned code %i' % p.returncode)
91 if self.trace_file is None:
92 self.trace_file = os.path.abspath(os.path.join(self.results, self.name + '.trace'))
93 if os.path.exists(self.trace_file):
94 os.remove(self.trace_file)
96 trace_dir = os.path.dirname(self.trace_file)
97 if not os.path.exists(trace_dir):
98 os.makedirs(trace_dir)
101 env = os.environ.copy()
103 system = platform.system()
105 if system == 'Windows':
106 wrapper = _get_build_path('wrappers/opengl32.dll')
107 local_wrapper = os.path.join(os.path.dirname(self.args[0]), os.path.basename(wrapper))
108 shutil.copy(wrapper, local_wrapper)
109 env['TRACE_FILE'] = self.trace_file
111 apitrace = _get_build_program('apitrace')
114 '-o', self.trace_file,
117 if self.max_frames is not None:
118 env['TRACE_FRAMES'] = str(self.max_frames)
121 p = popen(cmd, env=env, cwd=self.cwd)
124 if local_wrapper is not None:
125 os.remove(local_wrapper)
127 if not os.path.exists(self.trace_file):
128 self.fail('no trace file generated\n')
130 call_re = re.compile(r'^([0-9]+) (\w+)\(')
134 cmd = [_get_build_program('apitrace'), 'dump', '--color=never', self.trace_file]
135 p = popen(cmd, stdout=subprocess.PIPE)
142 if self.ref_dump is not None:
143 ref = open(self.ref_dump, 'rt')
144 ref_line = ref.readline().rstrip()
145 for line in p.stdout:
147 mo = self.call_re.match(line)
150 call_no = int(mo.group(1))
151 function_name = mo.group(2)
152 if function_name == 'glXSwapBuffers':
154 if function_name in ('glFlush', 'glFinish'):
156 src_line = line[mo.start(2):]
158 if src_line == ref_line:
159 sys.stdout.write(src_line + '\n')
160 ref_line = ref.readline().rstrip()
163 src_lines.append(src_line)
166 if p.returncode != 0:
167 self.fail('`apitrace dump` returned code %i' % p.returncode)
170 self.fail('missing call `%s` (found `%s`)' % (ref_line, src_lines[0]))
172 self.fail('missing call %s' % ref_line)
182 ref_prefix = os.path.abspath(os.path.join(self.results, self.name + '.ref.'))
183 src_prefix = os.path.join(self.results, self.name + '.src.')
184 diff_prefix = os.path.join(self.results, self.name + '.diff.')
187 if not os.path.isfile(trace):
188 sys.stdout.write('SKIP (no trace)\n')
190 args = [_get_build_path('glretrace')]
197 args += ['-s', src_prefix]
199 p = popen(args, stdout=subprocess.PIPE)
200 image_re = re.compile(r'^Wrote (.*\.png)$')
202 for line in p.stdout:
204 mo = image_re.match(line)
207 if image.startswith(src_prefix):
208 image = image[len(src_prefix):]
211 if p.returncode != 0:
212 sys.stdout.write('FAIL (glretrace)\n')
216 ref_image = ref_prefix + image
217 src_image = src_prefix + image
218 diff_image = diff_prefix + image
220 if not os.path.isfile(ref_image):
222 assert os.path.isfile(src_image)
224 comparer = Comparer(ref_image, src_image)
225 match = comparer.ae()
226 sys.stdout.write('%s: %s bits\n' % (image, comparer.precision()))
228 comparer.write_diff(diff_image)
229 #report.add_snapshot(ref_image, src_image, diff_image)
230 sys.stdout.write('FAIL (snapshot)\n')
233 def fail(self, reason=None):
234 self._exit('FAIL', 1, reason)
236 def skip(self, reason=None):
237 self._exit('SKIP', 0, reason)
239 def pass_(self, reason=None):
240 self._exit('PASS', 0, reason)
242 def _exit(self, status, code, reason=None):
246 reason = ' (%s)' % reason
247 sys.stdout.write('%s%s\n' % (status, reason))
255 # Parse command line options
256 optparser = optparse.OptionParser(
257 usage='\n\t%prog [options] -- program [args] ...',
259 optparser.add_option(
260 '-B', '--build', metavar='PATH',
261 type='string', dest='build', default='..',
262 help='path to apitrace build')
263 optparser.add_option(
264 '-C', '--directory', metavar='PATH',
265 type='string', dest='cwd', default=None,
266 help='change to directory')
267 optparser.add_option(
268 '-R', '--results', metavar='PATH',
269 type='string', dest='results', default='.',
270 help='results directory [default=%default]')
271 optparser.add_option(
272 '--ref-dump', metavar='PATH',
273 type='string', dest='ref_dump', default=None,
274 help='reference dump')
276 (options, args) = optparser.parse_args(sys.argv[1:])
278 optparser.error('program must be specified')
281 name = os.path.basename(args[0]),
284 build = options.build,
285 results = options.results,
287 test.ref_dump = options.ref_dump
292 if __name__ == '__main__':