#
# 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 re
import sys

from glob import glob
from framework.core import testBinDir

#############################################################################
##### GTFTest: Execute a sub-test of the Khronos ES 2.0 Conformance suite.
#####
##### To use this, create a 'GTF' symlink in piglit/bin which points to the
##### Khronos 'GTF' executable.  Piglit will automatically add all .test
##### files into the 'gtf' category.
#############################################################################

if not os.path.exists(os.path.join(testBinDir, 'GTF')):
    sys.exit(0)

# Chase the piglit/bin/GTF symlink to find where the tests really live.
gtfroot = path.dirname(path.realpath(path.join(testBinDir, 'GTF')))

class GTFTest(ExecTest):
    pass_re = re.compile(r'(Regression|Conformance) PASSED all 1 tests')

    def __init__(self, testpath):
        ExecTest.__init__(self, [path.join(testBinDir, 'GTF'), '-width=113', '-height=47', '-seed=2', '-minfmt', '-run=' + testpath])

    def interpretResult(self, out, returncode, results):
        if self.pass_re.search(out) is not None:
            results['result'] = 'pass'
        else:
            results['result'] = 'fail'
        return out

# Populate a group with tests in the given directory:
#
# - Add new subgroups for subdirectories and recurse.
# - Add any .test files to the group.
def populateTests(group, directory):
    for entry in os.listdir(directory):
        pathname = path.join(directory, entry)

        if path.isdir(pathname):
            # Recurse into the subdirectory...
            subgroup = Group()
            populateTests(subgroup, pathname)
            group[entry] = subgroup

        elif entry[-5:] == '.test':
            name = entry[:-5]
            # Don't add example.test...it's not a real test.
            if name != 'example':
                group[name] = GTFTest(pathname)

# Create a new top-level 'gtf' category for all Khronos ES 2.0 tests
gtf = Group()
profile.tests['gtf'] = gtf

# Populate the group with all the .test files
for directory in glob(gtfroot + '/GL*'):
    category = path.basename(directory)
    gtf[category] = Group()
    populateTests(gtf[category], directory)