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.'''
39 def popen(command, *args, **kwargs):
40 if kwargs.get('cwd', None) is not None:
41 sys.stdout.write('cd %s && ' % kwargs['cwd'])
43 for name, value in kwargs['env'].iteritems():
44 if value != os.environ.get(name, None):
45 sys.stdout.write('%s=%s ' % (name, value))
46 sys.stdout.write(' '.join(command) + '\n')
48 return subprocess.Popen(command, *args, **kwargs)
51 def _get_build_path(path):
52 if options.build is not None:
53 path = os.path.abspath(os.path.join(options.build, path))
54 if not os.path.exists(path):
55 sys.stderr.write('error: %s does not exist\n' % path)
66 def __init__(self, name, args, cwd=None, build=None, results = '.'):
71 self.results = results
73 if not os.path.exists(results):
79 p = popen(self.args, cwd=self.cwd)
82 self.skip('application returned code %i' % p.returncode)
85 if self.trace_file is None:
86 self.trace_file = os.path.abspath(os.path.join(self.results, self.name + '.trace'))
88 env = os.environ.copy()
90 system = platform.system()
91 if system == 'Windows':
93 self.skip('tracing not supported on Windows')
94 wrapper = _get_build_path('wrappers/opengl32.dll')
95 elif system == 'Darwin':
96 wrapper = _get_build_path('wrappers/OpenGL')
97 env['DYLD_LIBRARY_PATH'] = os.path.dirname(wrapper)
99 wrapper = _get_build_path('glxtrace.so')
100 env['LD_PRELOAD'] = wrapper
102 env['TRACE_FILE'] = self.trace_file
103 if self.max_frames is not None:
104 env['TRACE_FRAMES'] = str(self.max_frames)
106 p = popen(self.args, env=env, cwd=self.cwd)
109 if not os.path.exists(self.trace_file):
110 self.fail('no trace file generated\n')
112 call_re = re.compile(r'^([0-9]+) (\w+)\(')
116 cmd = [_get_build_path('tracedump'), '--color=never', self.trace_file]
117 p = popen(cmd, stdout=subprocess.PIPE)
123 if self.ref_dump is not None:
124 ref = open(self.ref_dump, 'rt')
125 ref_line = ref.readline().rstrip()
126 for line in p.stdout:
128 mo = self.call_re.match(line)
131 call_no = int(mo.group(1))
132 function_name = mo.group(2)
133 if function_name == 'glXSwapBuffers':
135 if function_name in ('glFlush', 'glFinish'):
137 src_line = line[mo.start(2):]
138 sys.stdout.write(src_line + '\n')
140 if src_line == ref_line:
141 ref_line = ref.readline().rstrip()
143 if p.returncode != 0:
144 self.fail('tracedump returned code %i' % p.returncode)
146 self.fail('missing call %' % ref_line)
156 ref_prefix = os.path.abspath(os.path.join(self.results, self.name + '.ref.'))
157 src_prefix = os.path.join(self.results, self.name + '.src.')
158 diff_prefix = os.path.join(self.results, self.name + '.diff.')
161 if not os.path.isfile(trace):
162 sys.stdout.write('SKIP (no trace)\n')
164 args = [_get_build_path('glretrace')]
171 args += ['-s', src_prefix]
173 p = popen(args, stdout=subprocess.PIPE)
174 image_re = re.compile(r'^Wrote (.*\.png)$')
176 for line in p.stdout:
178 mo = image_re.match(line)
181 if image.startswith(src_prefix):
182 image = image[len(src_prefix):]
185 if p.returncode != 0:
186 sys.stdout.write('FAIL (glretrace)\n')
190 ref_image = ref_prefix + image
191 src_image = src_prefix + image
192 diff_image = diff_prefix + image
194 if not os.path.isfile(ref_image):
196 assert os.path.isfile(src_image)
198 comparer = Comparer(ref_image, src_image)
199 match = comparer.ae()
200 sys.stdout.write('%s: %s bits\n' % (image, comparer.precision()))
202 comparer.write_diff(diff_image)
203 #report.add_snapshot(ref_image, src_image, diff_image)
204 sys.stdout.write('FAIL (snapshot)\n')
207 def fail(self, reason=None):
208 self._exit('FAIL', 1, reason)
210 def skip(self, reason=None):
211 self._exit('SKIP', 0, reason)
213 def pass_(self, reason=None):
214 self._exit('PASS', 0, reason)
216 def _exit(self, status, code, reason=None):
220 reason = ' (%s)' % reason
221 sys.stdout.write('%s%s\n' % (status, reason))
229 # Parse command line options
230 optparser = optparse.OptionParser(
231 usage='\n\t%prog [options] -- program [args] ...',
233 optparser.add_option(
234 '-B', '--build', metavar='PATH',
235 type='string', dest='build', default='..',
236 help='path to apitrace build')
237 optparser.add_option(
238 '-C', '--directory', metavar='PATH',
239 type='string', dest='cwd', default=None,
240 help='change to directory')
241 optparser.add_option(
242 '-R', '--results', metavar='PATH',
243 type='string', dest='results', default='.',
244 help='results directory [default=%default]')
245 optparser.add_option(
246 '--ref-dump', metavar='PATH',
247 type='string', dest='ref_dump', default=None,
248 help='reference dump')
250 (options, args) = optparser.parse_args(sys.argv[1:])
252 optparser.error('program must be specified')
255 name = os.path.basename(args[0]),
258 build = options.build,
259 results = options.results,
261 test.ref_dump = options.ref_dump
266 if __name__ == '__main__':