android/scripts/gen_android_cts_xml.py

#-------------------------------------------------------------------------
# drawElements Quality Program utilities
# --------------------------------------
#
# Copyright 2015 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
#-------------------------------------------------------------------------

import argparse
import string

class ModuleTemplate:
	def __init__(self, friendlyName, packageName, appPackageName, version):
		self.friendlyName = friendlyName
		self.packageName = packageName
		self.appPackageName = appPackageName
		self.version = version

class GLESVersion:
	def __init__(self, majorVersion, minorVersion):
		self.majorVersion = majorVersion
		self.minorVersion = minorVersion

	def getCTSEncodedGLESVersion(self):
		return (self.majorVersion << 16) | (self.minorVersion)

class EGLVersion:
	def getCTSEncodedGLESVersion(self):
		return None

MODULE_TEMPLATES = [
	ModuleTemplate("egl",		"dEQP-EGL",		"com.drawelements.deqp.egl",	EGLVersion()),
	ModuleTemplate("gles2",		"dEQP-GLES2",	"com.drawelements.deqp.gles2",	GLESVersion(2, 0)),
	ModuleTemplate("gles3",		"dEQP-GLES3",	"com.drawelements.deqp.gles3",	GLESVersion(3, 0)),
	ModuleTemplate("gles31",	"dEQP-GLES31",	"com.drawelements.deqp.gles31",	GLESVersion(3, 1)),
]

class TestGroup:
	def __init__(self, name, parent = None):
		self.parent = parent
		self.name = name
		self.testGroups = []
		self.testCases = []

		if parent:
			assert not parent.hasGroup(name)
			parent.testGroups.append(self)

	def getName (self):
		return self.name

	def getPath (self):
		if self.parent:
			return self.parent.getPath() + "." + self.name
		else:
			return self.name

	def hasGroup(self, groupName):
		for group in self.testGroups:
			if group.getName() == groupName:
				return True
		return False

	def getGroup(self, groupName):
		for group in self.testGroups:
			if group.getName() == groupName:
				return group
		assert False

	def hasTest(self, testName):
		for test in self.testCases:
			if test.getName() == testName:
				return True
		return False

	def getTest(self, testName):
		for test in self.testCases:
			if test.getName() == testName:
				return test
		assert False

	def hasTestCases(self):
		return len(self.testCases) != 0

	def hasTestGroups(self):
		return len(self.testGroups) != 0

	def getTestCases(self):
		return self.testCases

	def getTestGroups(self):
		return self.testGroups

class TestCase:
	def __init__(self, name, parent):
		self.name = name
		self.parent = parent

		assert not parent.hasTest(name)
		self.parent.testCases.append(self)

	def getPath (self):
		return self.parent.getPath() + "." + self.name

	def getName(self):
		return self.name

def addTestToHierarchy(rootGroup, path):
	pathComponents = string.split(path, ".")
	currentGroup = rootGroup

	assert pathComponents[0] == rootGroup.getName()

	for i in range(1, len(pathComponents)):
		component = pathComponents[i]

		if i == len(pathComponents) - 1:
			TestCase(component, currentGroup)
		else:
			if currentGroup.hasGroup(component):
				currentGroup = currentGroup.getGroup(component)
			else:
				currentGroup = TestGroup(component, parent=currentGroup)

def loadTestHierarchy (input, packageName):
	line = input.readline()
	rootGroup = None

	if line.startswith(packageName + "."):
		groupName	= packageName
		rootGroup	= TestGroup(groupName)
	else:
		print(line)
		assert False

	for line in input:
		addTestToHierarchy(rootGroup, line.strip());

	return rootGroup

def writeAndroidCTSTest(test, output):
	output.write('<Test name="%s" />\n' % test.getName())

def writeAndroidCTSTestCase(group, output):
	assert group.hasTestCases()
	assert not group.hasTestGroups()

	output.write('<TestCase name="%s">\n' % group.getName())

	for testCase in group.getTestCases():
		writeAndroidCTSTest(testCase, output)

	output.write('</TestCase>\n')

def writeAndroidCTSTestSuite(group, output):
	if group.getName() == "performance":
		return;

	output.write('<TestSuite name="%s">\n' % group.getName())

	for childGroup in group.getTestGroups():
		if group.getName() == "performance":
			continue;

		if childGroup.hasTestCases():
			assert not childGroup.hasTestGroups()
			writeAndroidCTSTestCase(childGroup, output)
		elif childGroup.hasTestGroups():
			writeAndroidCTSTestSuite(childGroup, output)
		# \note Skips groups without testcases or child groups

	output.write('</TestSuite>\n')

def writeAndroidCTSFile(rootGroup, output, name, appPackageName, optionalAttrs):
	optAttrsStr = ""

	for k in optionalAttrs.keys():
		optAttrsStr += " " + k + "=\"" + str(optionalAttrs[k]) + "\""

	output.write('<?xml version="1.0" encoding="UTF-8"?>\n')
	output.write('<TestPackage name="%s" appPackageName="%s" testType="deqpTest" xmlns:deqp="http://drawelements.com/deqp"%s>\n' % (name, appPackageName, optAttrsStr))

	writeAndroidCTSTestSuite(rootGroup, output)

	output.write('</TestPackage>\n')

def getTemplateNames():
	return [template.friendlyName for template in MODULE_TEMPLATES]

def getTemplateByName(name):
	matching = [template for template in MODULE_TEMPLATES if template.friendlyName == name]

	assert len(matching) == 1
	return matching[0]

if __name__ == "__main__":
	parser = argparse.ArgumentParser()
	parser.add_argument('input',                              type=argparse.FileType('r'),    help="Input file containing dEQP test names.")
	parser.add_argument('output',                             type=argparse.FileType('w'),    help="Output file for Android CTS test file.")
	parser.add_argument('--module',       dest="module",      type=str,                       required=True, help="Name of the test module", choices=getTemplateNames())

	args = parser.parse_args()

	moduleTemplate = getTemplateByName(args.module)

	optAttrs = {};
	if moduleTemplate.version.getCTSEncodedGLESVersion():
		optAttrs["deqp:glesVersion"] = moduleTemplate.version.getCTSEncodedGLESVersion()

	rootGroup = loadTestHierarchy(args.input, moduleTemplate.packageName)
	writeAndroidCTSFile(rootGroup, args.output, name=moduleTemplate.packageName, appPackageName=moduleTemplate.appPackageName, optionalAttrs=optAttrs)