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)
171 skip('application returned code %i' % p.returncode)
184 'egl_gl': 'eglretrace',
185 'egl_gles1': 'eglretrace',
186 'egl_gles2': 'eglretrace',
187 'd3d9': 'd3dretrace',
194 if self.trace_file is None:
195 if self.ref_dump is not None:
199 name, ext = os.path.splitext(os.path.basename(name))
201 name, ext = os.path.splitext(os.path.basename(name))
202 self.trace_file = os.path.abspath(os.path.join(self.results, name + '.trace'))
203 if os.path.exists(self.trace_file):
204 os.remove(self.trace_file)
206 trace_dir = os.path.dirname(self.trace_file)
207 if not os.path.exists(trace_dir):
208 os.makedirs(trace_dir)
211 env = os.environ.copy()
214 options.apitrace, 'trace',
215 '--api', self.api_trace_map[self.api],
216 '--output', self.trace_file,
219 if self.max_frames is not None:
220 env['TRACE_FRAMES'] = str(self.max_frames)
222 p = popen(cmd, env=env, cwd=self.cwd)
225 if not os.path.exists(self.trace_file):
226 fail('no trace file generated\n')
228 def checkTrace(self):
229 cmd = [options.apitrace, 'dump', '--color=never', self.trace_file]
230 p = popen(cmd, stdout=subprocess.PIPE)
232 checker = TraceChecker(p.stdout, self.ref_dump, self.verbose)
235 if p.returncode != 0:
236 fail('`apitrace dump` returned code %i' % p.returncode)
238 self.doubleBuffer = checker.doubleBuffer
240 if self.api not in self.api_retrace_map:
243 for callNo, refImageFileName in checker.images:
244 self.checkImage(callNo, refImageFileName)
245 for callNo, refStateFileName in checker.states:
246 self.checkState(callNo, refStateFileName)
248 def checkImage(self, callNo, refImageFileName):
250 from PIL import Image
254 srcImage = self.getImage(callNo)
255 refImage = Image.open(refImageFileName)
257 from snapdiff import Comparer
258 comparer = Comparer(refImage, srcImage)
259 precision = comparer.precision(filter=True)
260 sys.stdout.write('precision of %f bits against %s\n' % (precision, refImageFileName))
261 if precision < self.threshold_precision:
262 prefix = '%s.%u' % (self.getNamePrefix(), callNo)
263 srcImageFileName = prefix + '.src.png'
264 srcImage.save(srcImageFileName)
265 diffImageFileName = prefix + '.diff.png'
266 comparer.write_diff(diffImageFileName)
267 fail('snapshot from call %u does not match %s' % (callNo, refImageFileName))
269 def checkState(self, callNo, refStateFileName):
270 srcState = self.getState(callNo)
271 refState = self.getRefState(refStateFileName)
273 from jsondiff import Comparer, Differ
274 comparer = Comparer(ignore_added = True)
275 match = comparer.visit(refState, srcState)
277 prefix = '%s.%u' % (self.getNamePrefix(), callNo)
278 srcStateFileName = prefix + '.src.json'
279 diffStateFileName = prefix + '.diff.json'
280 self.saveState(srcState, srcStateFileName)
281 #diffStateFile = open(diffStateFileName, 'wt')
282 diffStateFile = sys.stdout
283 differ = Differ(diffStateFile, ignore_added = True)
284 differ.visit(refState, srcState)
285 fail('state from call %u does not match %s' % (callNo, refStateFileName))
287 def getRefState(self, refStateFileName):
288 stream = open(refStateFileName, 'rt')
289 from jsondiff import load
291 self.adjustRefState(state)
294 def getNamePrefix(self):
295 name = os.path.basename(self.ref_dump)
297 index = name.index('.')
304 def saveState(self, state, filename):
305 s = json.dumps(state, sort_keys=True, indent=2)
306 open(filename, 'wt').write(s)
309 if self.api not in self.api_retrace_map:
314 if p.returncode != 0:
315 fail('retrace failed with code %i' % (p.returncode))
317 def getImage(self, callNo):
318 from PIL import Image
319 state = self.getState(callNo)
320 if self.doubleBuffer:
321 attachments = ['GL_BACK', 'GL_BACK_LEFT', 'GL_BACK_RIGHT', 'GL_COLOR_ATTACHMENT0']
323 attachments = ['GL_FRONT', 'GL_FRONT_LEFT', 'GL_FRONT_RIGHT', 'GL_COLOR_ATTACHMENT0']
324 imageObj = self.getFramebufferAttachment(state, attachments)
325 data = imageObj['__data__']
326 stream = StringIO(base64.b64decode(data))
327 im = Image.open(stream)
331 def getFramebufferAttachment(self, state, attachments):
332 framebufferObj = state['framebuffer']
333 for attachment in attachments:
335 attachmentObj = framebufferObj[attachment]
340 raise Exception("no attachment found")
342 def getState(self, callNo):
344 state = self.stateCache[callNo]
350 p = self._retrace(['-D', str(callNo)])
351 state = json.load(p.stdout, strict=False)
353 if p.returncode != 0:
354 fail('retrace returned code %i' % (p.returncode))
356 self.adjustSrcState(state)
358 self.stateCache[callNo] = state
362 def adjustSrcState(self, state):
363 # Do some adjustments on the obtained state to eliminate failures from
364 # bugs/issues outside of apitrace
367 parameters = state['parameters']
371 # On NVIDIA drivers glGetIntegerv(GL_INDEX_WRITEMASK) returns -1
372 self.replaceState(parameters, 'GL_INDEX_WRITEMASK', 255, -1)
375 if 'Gallium' in parameters['GL_RENDERER'].split():
376 # Gallium drivers have wrong defaults for draw/read buffer state
377 self.replaceState(parameters, 'GL_DRAW_BUFFER', 'GL_BACK_LEFT', 'GL_BACK')
378 self.replaceState(parameters, 'GL_DRAW_BUFFER0', 'GL_BACK_LEFT', 'GL_BACK')
379 self.replaceState(parameters, 'GL_READ_BUFFER', 'GL_BACK_LEFT', 'GL_BACK')
380 self.replaceState(parameters, 'GL_DRAW_BUFFER', 'GL_FRONT_LEFT', 'GL_FRONT')
381 self.replaceState(parameters, 'GL_DRAW_BUFFER0', 'GL_FRONT_LEFT', 'GL_FRONT')
382 self.replaceState(parameters, 'GL_READ_BUFFER', 'GL_FRONT_LEFT', 'GL_FRONT')
384 def adjustRefState(self, state):
385 # Do some adjustments on reference state to eliminate failures from
386 # bugs/issues outside of apitrace
389 parameters = state['parameters']
393 if platform.system() == 'Darwin':
394 # Mac OS X drivers fail on GL_COLOR_SUM
395 # XXX: investigate this
396 self.removeState(parameters, 'GL_COLOR_SUM')
398 def replaceState(self, obj, key, srcValue, dstValue):
404 if value == srcValue:
407 def removeState(self, obj, key):
413 def _retrace(self, args = None, stdout=subprocess.PIPE):
414 retrace = self.api_retrace_map[self.api]
415 cmd = [get_build_program(retrace)]
416 if self.doubleBuffer:
422 cmd += [self.trace_file]
423 return popen(cmd, stdout=stdout)
425 def createOptParser(self):
426 optparser = Driver.createOptParser(self)
428 optparser.add_option(
429 '-a', '--api', metavar='API',
430 type='string', dest='api', default='gl',
432 optparser.add_option(
433 '-R', '--results', metavar='PATH',
434 type='string', dest='results', default='.',
435 help='results directory [default=%default]')
436 optparser.add_option(
437 '--ref-dump', metavar='PATH',
438 type='string', dest='ref_dump', default=None,
439 help='reference dump')
446 (options, args) = self.parseOptions()
448 if not os.path.exists(options.results):
449 os.makedirs(options.results)
451 self.verbose = options.verbose
454 self.cwd = options.cwd
455 self.api = options.api
456 self.ref_dump = options.ref_dump
457 self.results = options.results
466 if __name__ == '__main__':