framework/test/deqp.py

   1 # coding=utf-8
   2 # Copyright 2014-2016, 2018-2019 Intel Corporation
   3 #
   4 # Permission is hereby granted, free of charge, to any person obtaining a copy
   5 # of this software and associated documentation files (the "Software"), to deal
   6 # in the Software without restriction, including without limitation the rights
   7 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8 # copies of the Software, and to permit persons to whom the Software is
   9 # furnished to do so, subject to the following conditions:
  10 #
  11 # The above copyright notice and this permission notice shall be included in
  12 # all copies or substantial portions of the Software.
  13 #
  14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20 # SOFTWARE.
  21
  22 import abc
  23 import os
  24 import subprocess
  25
  26 from framework import core, grouptools, exceptions
  27 from framework import options
  28 from framework.profile import TestProfile
  29 from framework.test.base import Test, is_crash_returncode, TestRunError
  30
  31 __all__ = [
  32     'DEQPBaseTest',
  33     'gen_caselist_txt',
  34     'iter_deqp_test_cases',
  35     'make_profile',
  36 ]
  37
  38
  39 _EXTRA_ARGS = core.get_option('PIGLIT_DEQP_EXTRA_ARGS',
  40                               ('deqp', 'extra_args'),
  41                               default='').split()
  42
  43
  44 def select_source(bin_, filename, mustpass, extra_args):
  45     """Return either the mustpass list or the generated list."""
  46     if options.OPTIONS.deqp_mustpass:
  47         return gen_mustpass_tests(mustpass)
  48     else:
  49         return iter_deqp_test_cases(
  50             gen_caselist_txt(bin_, filename, extra_args))
  51
  52
  53 def make_profile(test_list, test_class):
  54     """Create a TestProfile instance."""
  55     profile = TestProfile()
  56     for testname in test_list:
  57         # deqp uses '.' as the testgroup separator.
  58         piglit_name = testname.replace('.', grouptools.SEPARATOR)
  59         profile.test_list[piglit_name] = test_class(testname)
  60
  61     return profile
  62
  63
  64 def gen_mustpass_tests(mustpass):
  65     """Return a testlist from the mustpass list."""
  66     with open(mustpass, 'r') as f:
  67         for l in f:
  68             l = l.strip()
  69             if l:
  70                 yield l
  71
  72
  73 def gen_caselist_txt(bin_, caselist, extra_args):
  74     """Generate a caselist.txt and return its path.
  75
  76     Extra args should be a list of extra arguments to pass to deqp.
  77
  78     """
  79     # dEQP is stupid (2014-12-07):
  80     #   1. To generate the caselist file, dEQP requires that the process's
  81     #      current directory must be that same as that of the executable.
  82     #      Otherwise, it fails to find its data files.
  83     #   2. dEQP creates the caselist file in the process's current directory
  84     #      and provides no option to change its location.
  85     #   3. dEQP creates a GL context when generating the caselist. Therefore,
  86     #      the caselist must be generated on the test target rather than the
  87     #      build host. In other words, when the build host and test target
  88     #      differ then we cannot pre-generate the caselist on the build host:
  89     #      we must *dynamically* generate it during the testrun.
  90     basedir = os.path.dirname(bin_)
  91     caselist_path = os.path.join(basedir, caselist)
  92
  93     # TODO: need to catch some exceptions here...
  94     with open(os.devnull, 'w') as d:
  95         env = os.environ.copy()
  96         env['MESA_GL_VERSION_OVERRIDE'] = '4.6'
  97         env['MESA_GLES_VERSION_OVERRIDE'] = '3.2'
  98
  99         subprocess.check_call(
 100             [bin_, '--deqp-runmode=txt-caselist'] + extra_args, cwd=basedir,
 101             stdout=d, stderr=d, env=env)
 102     assert os.path.exists(caselist_path)
 103     return caselist_path
 104
 105
 106 def iter_deqp_test_cases(case_file):
 107     """Iterate over original dEQP testcase names."""
 108     with open(case_file, 'r') as caselist_file:
 109         for i, line in enumerate(caselist_file):
 110             if line.startswith('GROUP:'):
 111                 continue
 112             elif line.startswith('TEST:'):
 113                 yield line[len('TEST:'):].strip()
 114             else:
 115                 raise exceptions.PiglitFatalError(
 116                     'deqp: {}:{}: ill-formed line'.format(case_file, i))
 117
 118
 119 class DEQPBaseTest(Test, metaclass=abc.ABCMeta):
 120     __RESULT_MAP = {
 121         "Pass": "pass",
 122         "Fail": "fail",
 123         "QualityWarning": "warn",
 124         "InternalError": "fail",
 125         "Crash": "crash",
 126         "NotSupported": "skip",
 127         "ResourceError": "crash",
 128     }
 129
 130     @abc.abstractproperty
 131     def deqp_bin(self):
 132         """The path to the exectuable."""
 133
 134     @abc.abstractproperty
 135     def extra_args(self):
 136         """Extra arguments to be passed to the each test instance.
 137
 138         Needs to return a list, since self.command uses the '+' operator, which
 139         only works to join two lists together.
 140
 141         """
 142         return _EXTRA_ARGS
 143
 144     def __init__(self, case_name):
 145         command = [self.deqp_bin, '--deqp-case=' + case_name]
 146
 147         super(DEQPBaseTest, self).__init__(command)
 148
 149         # dEQP's working directory must be the same as that of the executable,
 150         # otherwise it cannot find its data files (2014-12-07).
 151         # This must be called after super or super will overwrite it
 152         self.cwd = os.path.dirname(self.deqp_bin)
 153
 154     @Test.command.getter
 155     def command(self):
 156         """Return the command plus any extra arguments."""
 157         command = super(DEQPBaseTest, self).command
 158         return command + self.extra_args
 159
 160     def __find_map(self):
 161         """Run over the lines and set the result."""
 162         # splitting this into a separate function allows us to return cleanly,
 163         # otherwise this requires some break/else/continue madness
 164         for line in self.result.out.split('\n'):
 165             line = line.lstrip()
 166             for k, v in self.__RESULT_MAP.items():
 167                 if line.startswith(k):
 168                     self.result.result = v
 169                     return
 170
 171     def interpret_result(self):
 172         if is_crash_returncode(self.result.returncode):
 173             self.result.result = 'crash'
 174         elif self.result.returncode != 0:
 175             self.result.result = 'fail'
 176         else:
 177             self.__find_map()
 178
 179         # We failed to parse the test output. Fallback to 'fail'.
 180         if self.result.result == 'notrun':
 181             self.result.result = 'fail'
 182
 183     def _run_command(self, *args, **kwargs):
 184         """Rerun the command if X11 connection failure happens."""
 185         for _ in range(5):
 186             super(DEQPBaseTest, self)._run_command(*args, **kwargs)
 187             x_err_msg = "FATAL ERROR: Failed to open display"
 188             if x_err_msg in self.result.err or x_err_msg in self.result.out:
 189                 continue
 190             return
 191
 192         raise TestRunError('Failed to connect to X server 5 times', 'fail')