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 if self.trace_file is None:
185 if self.ref_dump is not None:
189 name, ext = os.path.splitext(os.path.basename(name))
191 name, ext = os.path.splitext(os.path.basename(name))
192 self.trace_file = os.path.abspath(os.path.join(self.results, name + '.trace'))
193 if os.path.exists(self.trace_file):
194 os.remove(self.trace_file)
196 trace_dir = os.path.dirname(self.trace_file)
197 if not os.path.exists(trace_dir):
198 os.makedirs(trace_dir)
201 env = os.environ.copy()
204 options.apitrace, 'trace',
205 '--api', self.api_map[self.api],
206 '--output', self.trace_file,
209 if self.max_frames is not None:
210 env['TRACE_FRAMES'] = str(self.max_frames)
212 p = popen(cmd, env=env, cwd=self.cwd)
215 if not os.path.exists(self.trace_file):
216 fail('no trace file generated\n')
218 def checkTrace(self):
219 cmd = [options.apitrace, 'dump', '--color=never', self.trace_file]
220 p = popen(cmd, stdout=subprocess.PIPE)
222 checker = TraceChecker(p.stdout, self.ref_dump, self.verbose)
225 if p.returncode != 0:
226 fail('`apitrace dump` returned code %i' % p.returncode)
228 self.doubleBuffer = checker.doubleBuffer
230 for callNo, refImageFileName in checker.images:
231 self.checkImage(callNo, refImageFileName)
232 for callNo, refStateFileName in checker.states:
233 self.checkState(callNo, refStateFileName)
235 def checkImage(self, callNo, refImageFileName):
237 from PIL import Image
241 srcImage = self.getImage(callNo)
242 refImage = Image.open(refImageFileName)
244 from snapdiff import Comparer
245 comparer = Comparer(refImage, srcImage)
246 precision = comparer.precision(filter=True)
247 sys.stdout.write('precision of %f bits against %s\n' % (precision, refImageFileName))
248 if precision < self.threshold_precision:
249 prefix = '%s.%u' % (self.getNamePrefix(), callNo)
250 srcImageFileName = prefix + '.src.png'
251 srcImage.save(srcImageFileName)
252 diffImageFileName = prefix + '.diff.png'
253 comparer.write_diff(diffImageFileName)
254 fail('snapshot from call %u does not match %s' % (callNo, refImageFileName))
256 def checkState(self, callNo, refStateFileName):
257 srcState = self.getState(callNo)
258 refState = self.getRefState(refStateFileName)
260 from jsondiff import Comparer, Differ
261 comparer = Comparer(ignore_added = True)
262 match = comparer.visit(refState, srcState)
264 prefix = '%s.%u' % (self.getNamePrefix(), callNo)
265 srcStateFileName = prefix + '.src.json'
266 diffStateFileName = prefix + '.diff.json'
267 self.saveState(srcState, srcStateFileName)
268 #diffStateFile = open(diffStateFileName, 'wt')
269 diffStateFile = sys.stdout
270 differ = Differ(diffStateFile, ignore_added = True)
271 differ.visit(refState, srcState)
272 fail('state from call %u does not match %s' % (callNo, refStateFileName))
274 def getRefState(self, refStateFileName):
275 stream = open(refStateFileName, 'rt')
276 from jsondiff import load
278 self.adjustRefState(state)
281 def getNamePrefix(self):
282 name = os.path.basename(self.ref_dump)
284 index = name.index('.')
291 def saveState(self, state, filename):
292 s = json.dumps(state, sort_keys=True, indent=2)
293 open(filename, 'wt').write(s)
298 if p.returncode != 0:
299 fail('retrace failed with code %i' % (p.returncode))
301 def getImage(self, callNo):
302 from PIL import Image
303 state = self.getState(callNo)
304 if self.doubleBuffer:
305 attachments = ['GL_BACK', 'GL_BACK_LEFT', 'GL_BACK_RIGHT', 'GL_COLOR_ATTACHMENT0']
307 attachments = ['GL_FRONT', 'GL_FRONT_LEFT', 'GL_FRONT_RIGHT', 'GL_COLOR_ATTACHMENT0']
308 imageObj = self.getFramebufferAttachment(state, attachments)
309 data = imageObj['__data__']
310 stream = StringIO(base64.b64decode(data))
311 im = Image.open(stream)
315 def getFramebufferAttachment(self, state, attachments):
316 framebufferObj = state['framebuffer']
317 for attachment in attachments:
319 attachmentObj = framebufferObj[attachment]
324 raise Exception("no attachment found")
326 def getState(self, callNo):
328 state = self.stateCache[callNo]
334 p = self._retrace(['-D', str(callNo)])
335 state = json.load(p.stdout, strict=False)
337 if p.returncode != 0:
338 fail('retrace returned code %i' % (p.returncode))
340 self.adjustSrcState(state)
342 self.stateCache[callNo] = state
346 def adjustSrcState(self, state):
347 # Do some adjustments on the obtained state to eliminate failures from
348 # bugs/issues outside of apitrace
351 parameters = state['parameters']
355 # On NVIDIA drivers glGetIntegerv(GL_INDEX_WRITEMASK) returns -1
356 self.replaceState(parameters, 'GL_INDEX_WRITEMASK', 255, -1)
359 if 'Gallium' in parameters['GL_RENDERER'].split():
360 # Gallium drivers have wrong defaults for draw/read buffer state
361 self.replaceState(parameters, 'GL_DRAW_BUFFER', 'GL_BACK_LEFT', 'GL_BACK')
362 self.replaceState(parameters, 'GL_DRAW_BUFFER0', 'GL_BACK_LEFT', 'GL_BACK')
363 self.replaceState(parameters, 'GL_READ_BUFFER', 'GL_BACK_LEFT', 'GL_BACK')
364 self.replaceState(parameters, 'GL_DRAW_BUFFER', 'GL_FRONT_LEFT', 'GL_FRONT')
365 self.replaceState(parameters, 'GL_DRAW_BUFFER0', 'GL_FRONT_LEFT', 'GL_FRONT')
366 self.replaceState(parameters, 'GL_READ_BUFFER', 'GL_FRONT_LEFT', 'GL_FRONT')
368 def adjustRefState(self, state):
369 # Do some adjustments on reference state to eliminate failures from
370 # bugs/issues outside of apitrace
373 parameters = state['parameters']
377 if platform.system() == 'Darwin':
378 # Mac OS X drivers fail on GL_COLOR_SUM
379 # XXX: investigate this
380 self.removeState(parameters, 'GL_COLOR_SUM')
382 def replaceState(self, obj, key, srcValue, dstValue):
388 if value == srcValue:
391 def removeState(self, obj, key):
397 def _retrace(self, args = None, stdout=subprocess.PIPE):
398 retrace = self.api_map[self.api] + 'retrace'
399 cmd = [get_build_program(retrace)]
400 if self.doubleBuffer:
406 cmd += [self.trace_file]
407 return popen(cmd, stdout=stdout)
409 def createOptParser(self):
410 optparser = Driver.createOptParser(self)
412 optparser.add_option(
413 '-a', '--api', metavar='API',
414 type='string', dest='api', default='gl',
416 optparser.add_option(
417 '-R', '--results', metavar='PATH',
418 type='string', dest='results', default='.',
419 help='results directory [default=%default]')
420 optparser.add_option(
421 '--ref-dump', metavar='PATH',
422 type='string', dest='ref_dump', default=None,
423 help='reference dump')
430 (options, args) = self.parseOptions()
432 if not os.path.exists(options.results):
433 os.makedirs(options.results)
435 self.verbose = options.verbose
438 self.cwd = options.cwd
439 self.api = options.api
440 self.ref_dump = options.ref_dump
441 self.results = options.results
450 if __name__ == '__main__':