summaryrefslogtreecommitdiff
path: root/framework/exectest.py
blob: 244d7d99b8d96095f972300588ada342cbb72faf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# This permission notice shall be included in all copies or
# substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
# PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHOR(S) BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
# AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
# OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.

import os
import subprocess
import shlex
import types

from core import Test, testBinDir, TestResult

#############################################################################
##### Platform global variables
#############################################################################
if 'PIGLIT_PLATFORM' in os.environ:
    PIGLIT_PLATFORM = os.environ['PIGLIT_PLATFORM']
else:
    PIGLIT_PLATFORM = ''

#############################################################################
##### ExecTest: A shared base class for tests that simply run an executable.
#############################################################################

class ExecTest(Test):
	def __init__(self, command):
		Test.__init__(self)
		self.command = command
		self.split_command = os.path.split(self.command[0])[1]
		self.env = {}

		if isinstance(self.command, basestring):
			self.command = shlex.split(str(self.command))

		self.skip_test = self.check_for_skip_scenario(command)

	def interpretResult(self, out, returncode, results):
		raise NotImplementedError
		return out

	def run(self, valgrind):
		fullenv = os.environ.copy()
		for e in self.env:
			fullenv[e] = str(self.env[e])

		if self.command is not None:
			command = self.command

			if valgrind:
				command[:0] = ['valgrind', '--quiet', '--error-exitcode=1', '--tool=memcheck']

			i = 0
			while True:
				if self.skip_test:
					out = "PIGLIT: {'result': 'skip'}\n"
					err = ""
					returncode = None
				else:
					(out, err, returncode) = \
						self.get_command_result(command, fullenv)

				# https://bugzilla.gnome.org/show_bug.cgi?id=680214 is
				# affecting many developers.  If we catch it
				# happening, try just re-running the test.
				if out.find("Got spurious window resize") >= 0:
					i = i + 1
					if i >= 5:
						break
				else:
					break

			# proc.communicate() returns 8-bit strings, but we need
			# unicode strings.  In Python 2.x, this is because we
			# will eventually be serializing the strings as JSON,
			# and the JSON library expects unicode.  In Python 3.x,
			# this is because all string operations require
			# unicode.  So translate the strings into unicode,
			# assuming they are using UTF-8 encoding.
			#
			# If the subprocess output wasn't properly UTF-8
			# encoded, we don't want to raise an exception, so
			# translate the strings using 'replace' mode, which
			# replaces erroneous charcters with the Unicode
			# "replacement character" (a white question mark inside
			# a black diamond).
			out = out.decode('utf-8', 'replace')
			err = err.decode('utf-8', 'replace')

			results = TestResult()

			if self.skip_test:
				results['result'] = 'skip'
			else:
				results['result'] = 'fail'
				out = self.interpretResult(out, returncode, results)

			crash_codes = [
				# Unix: terminated by a signal
				-5,  # SIGTRAP
				-6,  # SIGABRT
				-8,  # SIGFPE  (Floating point exception)
				-10, # SIGUSR1
				-11, # SIGSEGV (Segmentation fault)
				# Windows:
				# EXCEPTION_ACCESS_VIOLATION (0xc0000005):
				-1073741819,
				# EXCEPTION_INT_DIVIDE_BY_ZERO (0xc0000094):
				-1073741676
			]

			if returncode in crash_codes:
				results['result'] = 'crash'
			elif returncode != 0:
				results['note'] = 'Returncode was {0}'.format(returncode)

			if valgrind:
				# If the underlying test failed, simply report
				# 'skip' for this valgrind test.
				if results['result'] != 'pass':
					results['result'] = 'skip'
				elif returncode == 0:
					# Test passes and is valgrind clean.
					results['result'] = 'pass'
				else:
					# Test passed but has valgrind errors.
					results['result'] = 'fail'

			env = ''
			for key in self.env:
				env = env + key + '="' + self.env[key] + '" '
			if env:
				results['environment'] = env

			results['info'] = "Returncode: {0}\n\nErrors:\n{1}\n\nOutput:\n{2}".format(returncode, err, out)
			results['returncode'] = returncode
			results['command'] = ' '.join(self.command)

			self.handleErr(results, err)

		else:
			results = TestResult()
			if 'result' not in results:
				results['result'] = 'skip'

		return results

	def check_for_skip_scenario(self, command):
		global PIGLIT_PLATFORM
		if PIGLIT_PLATFORM == 'gbm':
			if 'glean' == self.split_command:
				return True
			if self.split_command.startswith('glx-'):
				return True
		return False

	def get_command_result(self, command, fullenv):
		try:
			proc = subprocess.Popen(
				command,
				stdout=subprocess.PIPE,
				stderr=subprocess.PIPE,
				env=fullenv,
				universal_newlines=True
				)
			out, err = proc.communicate()
			returncode = proc.returncode
		except OSError as e:
			# Different sets of tests get built under
			# different build configurations.  If
			# a developer chooses to not build a test,
			# Piglit should not report that test as having
			# failed.
			if e.strerror == "No such file or directory":
				out = "PIGLIT: {'result': 'skip'}\n" \
				    + "Test executable not found.\n"
				err = ""
				returncode = None
			else:
				raise e
		return out, err, returncode

#############################################################################
##### PlainExecTest: Run a "native" piglit test executable
##### Expect one line prefixed PIGLIT: in the output, which contains a
##### result dictionary. The plain output is appended to this dictionary
#############################################################################
class PlainExecTest(ExecTest):
	def __init__(self, command):
		ExecTest.__init__(self, command)
		# Prepend testBinDir to the path.
		self.command[0] = testBinDir + self.command[0]

	def interpretResult(self, out, returncode, results):
		outlines = out.split('\n')
		outpiglit = map(lambda s: s[7:], filter(lambda s: s.startswith('PIGLIT:'), outlines))

		if len(outpiglit) > 0:
			try:
				results.update(eval(''.join(outpiglit), {}))
				out = '\n'.join(filter(lambda s: not s.startswith('PIGLIT:'), outlines))
			except:
				results['result'] = 'fail'
				results['note'] = 'Failed to parse result string'

		if 'result' not in results:
			results['result'] = 'fail'
		return out