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
46 from base_driver import *
49 class SrcTraceParser(tracematch.SrcTraceParser):
51 def __init__(self, stream):
52 tracematch.SrcTraceParser.__init__(self, stream)
55 def handleCall(self, callNo, functionName, args, ret):
56 tracematch.SrcTraceParser.handleCall(self, callNo, functionName, args, ret)
58 if functionName.find('SwapBuffers') != -1 or \
59 repr(args).find('kCGLPFADoubleBuffer') != -1:
63 class AppDriver(Driver):
78 threshold_precision = 12.0
85 '''Run the application standalone, skipping this test if it fails by
91 sys.stderr.write('Run application...\n')
93 p = popen(self.cmd, cwd=self.cwd)
96 skip('application returned code %i' % p.returncode)
99 sys.stderr.write('\n')
110 'd3d10_1': 'd3d10_1',
117 'egl_gl': 'eglretrace',
118 'egl_gles1': 'eglretrace',
119 'egl_gles2': 'eglretrace',
120 'd3d8': 'd3dretrace',
121 'd3d9': 'd3dretrace',
122 'd3d10': 'd3dretrace',
123 'd3d10_1': 'd3dretrace',
124 'd3d11': 'd3dretrace',
125 'd3d11_1': 'd3dretrace',
132 sys.stderr.write('Capturing trace...\n')
134 if self.trace_file is None:
135 if self.ref_dump is not None:
139 name, ext = os.path.splitext(os.path.basename(name))
141 name, ext = os.path.splitext(os.path.basename(name))
142 self.trace_file = os.path.abspath(os.path.join(self.results, name + '.trace'))
143 if os.path.exists(self.trace_file):
144 os.remove(self.trace_file)
146 trace_dir = os.path.dirname(self.trace_file)
147 if not os.path.exists(trace_dir):
148 os.makedirs(trace_dir)
151 env = os.environ.copy()
154 options.apitrace, 'trace',
155 '--api', self.api_trace_map[self.api],
156 '--output', self.trace_file,
159 if self.max_frames is not None:
160 env['TRACE_FRAMES'] = str(self.max_frames)
162 p = popen(cmd, env=env, cwd=self.cwd)
164 if p.returncode != 0:
165 fail('`apitrace trace` returned code %i' % p.returncode)
167 if not os.path.exists(self.trace_file):
168 fail('no trace file generated\n')
171 sys.stderr.write('\n')
173 def checkTrace(self):
174 sys.stderr.write('Comparing trace %s against %s...\n' % (self.trace_file, self.ref_dump))
176 cmd = [options.apitrace, 'dump', '--verbose', '--color=never', self.trace_file]
177 p = popen(cmd, stdout=subprocess.PIPE, universal_newlines=True)
179 srcParser = SrcTraceParser(p.stdout)
180 srcTrace = srcParser.parse()
181 self.doubleBuffer = srcParser.swapbuffers > 0
187 refParser = tracematch.RefTraceParser(self.ref_dump)
188 refTrace = refParser.parse()
191 mo = refTrace.match(srcTrace)
192 except tracematch.TraceMismatch, ex:
195 dirName, baseName = os.path.split(os.path.abspath(self.ref_dump))
196 prefix, _ = os.path.splitext(baseName)
198 fileNames = os.listdir(dirName)
199 for fileName in fileNames:
200 if fileName.startswith(prefix) and fileName != self.ref_dump:
201 rest = fileName[len(prefix):]
202 paramName, ext = os.path.splitext(rest)
203 if ext in ('.json', '.png'):
204 if paramName.isdigit():
205 callNo = int(paramName)
208 callNo = mo.params[paramName]
210 fail('could not find parameter %s for %s' % (paramName, fileName))
211 filePath = os.path.join(dirName, fileName)
213 images.append((callNo, filePath))
215 states.append((callNo, filePath))
217 if p.returncode != 0:
218 fail('`apitrace dump` returned code %i' % p.returncode)
221 sys.stderr.write('\n')
223 if self.api not in self.api_retrace_map:
226 for callNo, refImageFileName in images:
227 self.checkImage(callNo, refImageFileName)
228 for callNo, refStateFileName in states:
229 self.checkState(callNo, refStateFileName)
231 def checkImage(self, callNo, refImageFileName):
232 sys.stderr.write('Comparing snapshot from call %u against %s...\n' % (callNo, refImageFileName))
234 from PIL import Image
236 sys.stderr.write('warning: PIL not found, skipping image comparison\n');
239 srcImage = self.getImage(callNo)
240 refImage = Image.open(refImageFileName)
242 from snapdiff import Comparer
243 comparer = Comparer(refImage, srcImage)
244 precision = comparer.precision(filter=True)
245 sys.stdout.write('precision of %f bits against %s\n' % (precision, refImageFileName))
246 if precision < self.threshold_precision:
247 prefix = '%s.%u' % (self.getNamePrefix(), callNo)
248 srcImageFileName = prefix + '.src.png'
249 srcImage.save(srcImageFileName)
250 diffImageFileName = prefix + '.diff.png'
251 comparer.write_diff(diffImageFileName)
252 fail('snapshot from call %u does not match %s' % (callNo, refImageFileName))
255 sys.stderr.write('\n')
257 def checkState(self, callNo, refStateFileName):
258 sys.stderr.write('Comparing state dump from call %u against %s...\n' % (callNo, refStateFileName))
260 srcState = self.getState(callNo)
261 refState = self.getRefState(refStateFileName)
263 from jsondiff import Comparer, Differ
264 comparer = Comparer(ignore_added = True)
265 match = comparer.visit(refState, srcState)
267 prefix = '%s.%u' % (self.getNamePrefix(), callNo)
268 srcStateFileName = prefix + '.src.json'
269 diffStateFileName = prefix + '.diff.json'
270 self.saveState(srcState, srcStateFileName)
271 #diffStateFile = open(diffStateFileName, 'wt')
272 diffStateFile = sys.stdout
273 differ = Differ(diffStateFile, ignore_added = True)
274 differ.visit(refState, srcState)
275 fail('state from call %u does not match %s' % (callNo, refStateFileName))
278 sys.stderr.write('\n')
280 def getRefState(self, refStateFileName):
281 stream = open(refStateFileName, 'rt')
282 from jsondiff import load
284 self.adjustRefState(state)
287 def getNamePrefix(self):
288 name = os.path.basename(self.ref_dump)
290 index = name.index('.')
297 def saveState(self, state, filename):
298 s = json.dumps(state, sort_keys=True, indent=2)
299 open(filename, 'wt').write(s)
302 if self.api not in self.api_retrace_map:
305 sys.stderr.write('Retracing %s...\n' % (self.trace_file,))
309 if p.returncode != 0:
310 fail('retrace failed with code %i' % (p.returncode))
313 sys.stderr.write('\n')
315 def getImage(self, callNo):
316 from PIL import Image
317 state = self.getState(callNo)
318 if self.doubleBuffer:
319 attachments = ['GL_BACK', 'GL_BACK_LEFT', 'GL_BACK_RIGHT', 'GL_COLOR_ATTACHMENT0']
321 attachments = ['GL_FRONT', 'GL_FRONT_LEFT', 'GL_FRONT_RIGHT', 'GL_COLOR_ATTACHMENT0']
322 imageObj = self.getFramebufferAttachment(state, attachments)
323 data = imageObj['__data__']
324 stream = StringIO(base64.b64decode(data))
325 im = Image.open(stream)
328 def getFramebufferAttachment(self, state, attachments):
329 framebufferObj = state['framebuffer']
330 for attachment in attachments:
332 attachmentObj = framebufferObj[attachment]
337 raise Exception("no attachment found")
339 def getState(self, callNo):
341 state = self.stateCache[callNo]
347 p = self._retrace(['-D', str(callNo)])
348 state = json.load(p.stdout, strict=False)
350 if p.returncode != 0:
351 fail('retrace returned code %i' % (p.returncode))
353 self.adjustSrcState(state)
355 self.stateCache[callNo] = state
359 def adjustSrcState(self, state):
360 # Do some adjustments on the obtained state to eliminate failures from
361 # bugs/issues outside of apitrace
364 parameters = state['parameters']
368 # On NVIDIA drivers glGetIntegerv(GL_INDEX_WRITEMASK) returns 255
369 self.replaceState(parameters, 'GL_INDEX_WRITEMASK', 255, -1)
371 def adjustRefState(self, state):
372 # Do some adjustments on reference state to eliminate failures from
373 # bugs/issues outside of apitrace
376 parameters = state['parameters']
380 if platform.system() == 'Darwin':
381 # Mac OS X drivers fail on GL_COLOR_SUM
382 # XXX: investigate this
383 self.removeState(parameters, 'GL_COLOR_SUM')
385 def replaceState(self, obj, key, srcValue, dstValue):
391 if value == srcValue:
394 def removeState(self, obj, key):
400 def _retrace(self, args = None, stdout=subprocess.PIPE):
401 retrace = self.api_retrace_map[self.api]
402 #cmd = [get_build_program(retrace)]
403 cmd = [options.apitrace, 'retrace']
404 if self.doubleBuffer:
410 cmd += [self.trace_file]
411 return popen(cmd, stdout=stdout)
413 def createOptParser(self):
414 optparser = Driver.createOptParser(self)
416 optparser.add_option(
417 '-a', '--api', metavar='API',
418 type='string', dest='api', default='gl',
420 optparser.add_option(
421 '-R', '--results', metavar='PATH',
422 type='string', dest='results', default='.',
423 help='results directory [default=%default]')
424 optparser.add_option(
425 '--ref-dump', metavar='PATH',
426 type='string', dest='ref_dump', default=None,
427 help='reference dump')
434 (options, args) = self.parseOptions()
436 if not os.path.exists(options.results):
437 os.makedirs(options.results)
439 self.verbose = options.verbose
442 self.cwd = options.cwd
443 self.api = options.api
444 self.ref_dump = options.ref_dump
445 self.results = options.results
454 if __name__ == '__main__':