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 '''Application test driver.'''
40 from cStringIO import StringIO
42 from StringIO import StringIO
45 from base_driver import *
50 def __init__(self, srcStream, refFileName, verbose=False):
51 self.srcStream = srcStream
52 self.refFileName = refFileName
54 self.refStream = open(refFileName, 'rt')
57 self.verbose = verbose
58 self.doubleBuffer = False
64 call_re = re.compile(r'^([0-9]+) (\w+)\(')
73 for line in self.srcStream:
76 sys.stdout.write(line + '\n')
77 mo = self.call_re.match(line)
79 self.callNo = int(mo.group(1))
80 function_name = mo.group(2)
81 if function_name.find('SwapBuffers') != -1 or \
82 line.find('kCGLPFADoubleBuffer') != -1:
84 if function_name in ('glFlush', 'glFinish'):
86 srcLine = line[mo.start(2):]
90 if srcLine == self.refLine:
94 srcLines.append(srcLine)
98 fail('missing call `%s` (found `%s`)' % (self.refLine, srcLines[0]))
100 fail('missing call %s' % self.refLine)
103 self.doubleBuffer = True
105 self.doubleBuffer = False
107 def consumeRefLine(self):
108 if not self.refStream:
113 line = self.refStream.readline()
117 if line.startswith('#'):
118 self.handlePragma(line)
123 def handlePragma(self, line):
124 pragma, rest = line.split(None, 1)
125 if pragma == '#image':
126 imageFileName = self.getAbsPath(rest)
127 self.images.append((self.callNo, imageFileName))
128 elif pragma == '#state':
129 stateFileName = self.getAbsPath(rest)
130 self.states.append((self.callNo, stateFileName))
134 def getAbsPath(self, path):
135 '''Get the absolute from a path relative to the reference filename'''
136 return os.path.abspath(os.path.join(os.path.dirname(self.refFileName), path))
140 class AppDriver(Driver):
155 threshold_precision = 12.0
158 Driver.__init__(self)
162 '''Run the application standalone, skipping this test if it fails by
168 p = popen(self.cmd, cwd=self.cwd)
170 if p.returncode != 0:
171 skip('application returned code %i' % p.returncode)
182 'd3d10_1': 'd3d10_1',
189 'egl_gl': 'eglretrace',
190 'egl_gles1': 'eglretrace',
191 'egl_gles2': 'eglretrace',
192 'd3d9': 'd3dretrace',
199 if self.trace_file is None:
200 if self.ref_dump is not None:
204 name, ext = os.path.splitext(os.path.basename(name))
206 name, ext = os.path.splitext(os.path.basename(name))
207 self.trace_file = os.path.abspath(os.path.join(self.results, name + '.trace'))
208 if os.path.exists(self.trace_file):
209 os.remove(self.trace_file)
211 trace_dir = os.path.dirname(self.trace_file)
212 if not os.path.exists(trace_dir):
213 os.makedirs(trace_dir)
216 env = os.environ.copy()
219 options.apitrace, 'trace',
220 '--api', self.api_trace_map[self.api],
221 '--output', self.trace_file,
224 if self.max_frames is not None:
225 env['TRACE_FRAMES'] = str(self.max_frames)
227 p = popen(cmd, env=env, cwd=self.cwd)
229 if p.returncode != 0:
230 fail('`apitrace trace` returned code %i' % p.returncode)
232 if not os.path.exists(self.trace_file):
233 fail('no trace file generated\n')
235 def checkTrace(self):
236 cmd = [options.apitrace, 'dump', '--color=never', self.trace_file]
237 p = popen(cmd, stdout=subprocess.PIPE)
239 checker = TraceChecker(p.stdout, self.ref_dump, self.verbose)
242 if p.returncode != 0:
243 fail('`apitrace dump` returned code %i' % p.returncode)
245 self.doubleBuffer = checker.doubleBuffer
247 if self.api not in self.api_retrace_map:
250 for callNo, refImageFileName in checker.images:
251 self.checkImage(callNo, refImageFileName)
252 for callNo, refStateFileName in checker.states:
253 self.checkState(callNo, refStateFileName)
255 def checkImage(self, callNo, refImageFileName):
257 from PIL import Image
261 srcImage = self.getImage(callNo)
262 refImage = Image.open(refImageFileName)
264 from snapdiff import Comparer
265 comparer = Comparer(refImage, srcImage)
266 precision = comparer.precision(filter=True)
267 sys.stdout.write('precision of %f bits against %s\n' % (precision, refImageFileName))
268 if precision < self.threshold_precision:
269 prefix = '%s.%u' % (self.getNamePrefix(), callNo)
270 srcImageFileName = prefix + '.src.png'
271 srcImage.save(srcImageFileName)
272 diffImageFileName = prefix + '.diff.png'
273 comparer.write_diff(diffImageFileName)
274 fail('snapshot from call %u does not match %s' % (callNo, refImageFileName))
276 def checkState(self, callNo, refStateFileName):
277 srcState = self.getState(callNo)
278 refState = self.getRefState(refStateFileName)
280 from jsondiff import Comparer, Differ
281 comparer = Comparer(ignore_added = True)
282 match = comparer.visit(refState, srcState)
284 prefix = '%s.%u' % (self.getNamePrefix(), callNo)
285 srcStateFileName = prefix + '.src.json'
286 diffStateFileName = prefix + '.diff.json'
287 self.saveState(srcState, srcStateFileName)
288 #diffStateFile = open(diffStateFileName, 'wt')
289 diffStateFile = sys.stdout
290 differ = Differ(diffStateFile, ignore_added = True)
291 differ.visit(refState, srcState)
292 fail('state from call %u does not match %s' % (callNo, refStateFileName))
294 def getRefState(self, refStateFileName):
295 stream = open(refStateFileName, 'rt')
296 from jsondiff import load
298 self.adjustRefState(state)
301 def getNamePrefix(self):
302 name = os.path.basename(self.ref_dump)
304 index = name.index('.')
311 def saveState(self, state, filename):
312 s = json.dumps(state, sort_keys=True, indent=2)
313 open(filename, 'wt').write(s)
316 if self.api not in self.api_retrace_map:
321 if p.returncode != 0:
322 fail('retrace failed with code %i' % (p.returncode))
324 def getImage(self, callNo):
325 from PIL import Image
326 state = self.getState(callNo)
327 if self.doubleBuffer:
328 attachments = ['GL_BACK', 'GL_BACK_LEFT', 'GL_BACK_RIGHT', 'GL_COLOR_ATTACHMENT0']
330 attachments = ['GL_FRONT', 'GL_FRONT_LEFT', 'GL_FRONT_RIGHT', 'GL_COLOR_ATTACHMENT0']
331 imageObj = self.getFramebufferAttachment(state, attachments)
332 data = imageObj['__data__']
333 stream = StringIO(base64.b64decode(data))
334 im = Image.open(stream)
338 def getFramebufferAttachment(self, state, attachments):
339 framebufferObj = state['framebuffer']
340 for attachment in attachments:
342 attachmentObj = framebufferObj[attachment]
347 raise Exception("no attachment found")
349 def getState(self, callNo):
351 state = self.stateCache[callNo]
357 p = self._retrace(['-D', str(callNo)])
358 state = json.load(p.stdout, strict=False)
360 if p.returncode != 0:
361 fail('retrace returned code %i' % (p.returncode))
363 self.adjustSrcState(state)
365 self.stateCache[callNo] = state
369 def adjustSrcState(self, state):
370 # Do some adjustments on the obtained state to eliminate failures from
371 # bugs/issues outside of apitrace
374 parameters = state['parameters']
378 # On NVIDIA drivers glGetIntegerv(GL_INDEX_WRITEMASK) returns 255
379 self.replaceState(parameters, 'GL_INDEX_WRITEMASK', 255, -1)
381 def adjustRefState(self, state):
382 # Do some adjustments on reference state to eliminate failures from
383 # bugs/issues outside of apitrace
386 parameters = state['parameters']
390 if platform.system() == 'Darwin':
391 # Mac OS X drivers fail on GL_COLOR_SUM
392 # XXX: investigate this
393 self.removeState(parameters, 'GL_COLOR_SUM')
395 def replaceState(self, obj, key, srcValue, dstValue):
401 if value == srcValue:
404 def removeState(self, obj, key):
410 def _retrace(self, args = None, stdout=subprocess.PIPE):
411 retrace = self.api_retrace_map[self.api]
412 cmd = [get_build_program(retrace)]
413 if self.doubleBuffer:
419 cmd += [self.trace_file]
420 return popen(cmd, stdout=stdout)
422 def createOptParser(self):
423 optparser = Driver.createOptParser(self)
425 optparser.add_option(
426 '-a', '--api', metavar='API',
427 type='string', dest='api', default='gl',
429 optparser.add_option(
430 '-R', '--results', metavar='PATH',
431 type='string', dest='results', default='.',
432 help='results directory [default=%default]')
433 optparser.add_option(
434 '--ref-dump', metavar='PATH',
435 type='string', dest='ref_dump', default=None,
436 help='reference dump')
443 (options, args) = self.parseOptions()
445 if not os.path.exists(options.results):
446 os.makedirs(options.results)
448 self.verbose = options.verbose
451 self.cwd = options.cwd
452 self.api = options.api
453 self.ref_dump = options.ref_dump
454 self.results = options.results
463 if __name__ == '__main__':