[sanitizer] Use COMPILER_RT_EMULATOR with gtests

[morehouse]

LGTM

[delcypher]

@vitalybuka Thanks for tackling this. I've always wanted to have our unit tests be runnable on targets that aren't the host. This looks like the first step towards that.

[delcypher]

The approach looks good but I'd like to see us type check the new run_under parameter.

llvm/utils/lit/lit/formats/googletest.py

26

It looks like we require self.run_under to be a list but we never check that it is one. We should check the type here and fail if it's wrong with litConfig.fatal_error().

It looks like

if emulator:
  emulator = shlex.split(emulator)

currently ensures we pass in a list but this is not very obvious because at first I thought we were passing in a string.

159

If self.run_under isn't a list then it'll cause problems here.

[delcypher]

@vitalybuka Damn looks like you landed the patch while I was in the middle of writing a review. Could you make the fix I requested as a follow up patch?

[vitalybuka]

In D100998#2709448, @delcypher wrote:

@vitalybuka Damn looks like you landed the patch while I was in the middle of writing a review. Could you make the fix I requested as a follow up patch?

sure, sorry, I didn't noticed comments.
I even can revert if there is serious issues.

[delcypher]

In D100998#2709526, @vitalybuka wrote:

In D100998#2709448, @delcypher wrote:

@vitalybuka Damn looks like you landed the patch while I was in the middle of writing a review. Could you make the fix I requested as a follow up patch?

sure, sorry, I didn't noticed comments.
I even can revert if there is serious issues.

@vitalybuka No problem. No need to revert. I don't think the patch will break anything that exists today but I would like to make sure the new run_under parameter gets typed checked so that it's easier for people to adopt it. Please create a follow up patch and add myself and @yln as reviewers.

[vitalybuka]

I reverted as I'd like also to see which bots it brakes, but it landed with another commit which seriously broke clang compilation, so I may miss something in the noise.

[vitalybuka]

type check

[vitalybuka]

fix python3

[vitalybuka]

make type check actually work

[vitalybuka]

Fix argument instead of failing with error

[vitalybuka]

llvm/utils/lit/lit/formats/googletest.py

159

Having that it's trivial to fix the argument we can just do that instead of raising fatal error.

compiler-rt/unittests/lit.common.unit.cfg.py

 # -*- Python -*-
 
 # Configuration file for 'lit' test runner.
 # This file contains common config setup rules for unit tests in various
 # compiler-rt testsuites.
 
 import os
 
 import lit.formats
 
+import shlex
+
+# Copied from libcxx's config.py
+def get_lit_conf(name, default=None):
+    # Allow overriding on the command line using --param=<name>=<val>
+    val = lit_config.params.get(name, None)
+    if val is None:
+        val = getattr(config, name, None)
+        if val is None:
+            val = default
+    return val
+
+emulator = get_lit_conf('emulator', None)
+if emulator:
+  emulator = shlex.split(emulator)
+
 # Setup test format
 llvm_build_mode = getattr(config, "llvm_build_mode", "Debug")
-config.test_format = lit.formats.GoogleTest(llvm_build_mode, "Test")
+config.test_format = lit.formats.GoogleTest(llvm_build_mode, "Test", emulator)
 
 # Setup test suffixes.
 config.suffixes = []
 
 # Tweak PATH to include llvm tools dir.
 llvm_tools_dir = config.llvm_tools_dir
 if (not llvm_tools_dir) or (not os.path.exists(llvm_tools_dir)):
   lit_config.fatal("Invalid llvm_tools_dir config attribute: %r" % llvm_tools_dir)

compiler-rt/unittests/lit.common.unit.configured.in

 @LIT_SITE_CFG_IN_HEADER@
 
 # Generic config options for all compiler-rt unit tests.
 config.target_triple = "@TARGET_TRIPLE@"
 config.llvm_src_root = "@LLVM_MAIN_SRC_DIR@"
 config.llvm_obj_root = "@LLVM_BINARY_DIR@"
 config.llvm_tools_dir = "@LLVM_TOOLS_DIR@"
 config.compiler_rt_src_root = "@COMPILER_RT_SOURCE_DIR@"
 config.compiler_rt_libdir = "@COMPILER_RT_RESOLVED_LIBRARY_OUTPUT_DIR@"
 config.llvm_build_mode = "@LLVM_BUILD_MODE@"
 config.host_arch = "@HOST_ARCH@"
 config.host_os = "@HOST_OS@"
 config.llvm_lib_dir = "@LLVM_LIBRARY_DIR@"
 config.gwp_asan = @COMPILER_RT_HAS_GWP_ASAN_PYBOOL@
+config.emulator = "@COMPILER_RT_EMULATOR@"
 
 # LLVM tools dir and build mode can be passed in lit parameters,
 # so try to apply substitution.
 try:
   config.llvm_tools_dir = config.llvm_tools_dir % lit_config.params
   config.compiler_rt_libdir = config.compiler_rt_libdir % lit_config.params
   config.llvm_build_mode = config.llvm_build_mode % lit_config.params
 except KeyError as e:
   key, = e.args
   lit_config.fatal("unable to find %r parameter, use '--param=%s=VALUE'" % (key, key))
 
 # Setup attributes common for all compiler-rt unit tests.
 lit_config.load_config(config, "@COMPILER_RT_SOURCE_DIR@/unittests/lit.common.unit.cfg.py")

llvm/utils/lit/lit/formats/googletest.py

+#!/usr/bin/env python3
+
 from __future__ import absolute_import
 import os
 import subprocess
 import sys
 
 import lit.Test
 import lit.TestRunner
 import lit.util
 from .base import TestFormat
 
 kIsWindows = sys.platform in ['win32', 'cygwin']
 
 class GoogleTest(TestFormat):
-    def __init__(self, test_sub_dirs, test_suffix):
+    def __init__(self, test_sub_dirs, test_suffix, run_under = []):
         self.test_sub_dirs = str(test_sub_dirs).split(';')
 
         # On Windows, assume tests will also end in '.exe'.
         exe_suffix = str(test_suffix)
         if kIsWindows:
             exe_suffix += '.exe'
 
         # Also check for .py files for testing purposes.
         self.test_suffixes = {exe_suffix, test_suffix + '.py'}
+        self.run_under = run_under
 
     def getGTestTests(self, path, litConfig, localConfig):
         """getGTestTests(path) - [name]
 
         Return the tests available in gtest executable.
 
         Args:
           path: String path to a gtest executable
           litConfig: LitConfig instance
           localConfig: TestingConfig instance"""
 
-        list_test_cmd = self.maybeAddPythonToCmd([path, '--gtest_list_tests'])
+        list_test_cmd = self.prepareCmd([path, '--gtest_list_tests'], litConfig)
 
         try:
             output = subprocess.check_output(list_test_cmd,
                                              env=localConfig.environment)
         except subprocess.CalledProcessError as exc:
             litConfig.warning(
                 "unable to discover google-tests in %r: %s. Process output: %s"
                 % (path, sys.exc_info()[1], exc.output))
def execute(self, test, litConfig):
         testPath,testName = os.path.split(test.getSourcePath())
         while not os.path.exists(testPath):
             # Handle GTest parametrized and typed tests, whose name includes
             # some '/'s.
             testPath, namePrefix = os.path.split(testPath)
             testName = namePrefix + '/' + testName
 
         cmd = [testPath, '--gtest_filter=' + testName]
-        cmd = self.maybeAddPythonToCmd(cmd)
+        cmd = self.prepareCmd(cmd, litConfig)
         if litConfig.useValgrind:
             cmd = litConfig.valgrindArgs + cmd
 
         if litConfig.noExecute:
             return lit.Test.PASS, ''
 
         try:
             out, err, exitCode = lit.util.executeCommand(
def execute(self, test, litConfig):
         passing_test_line = '[  PASSED  ] 1 test.'
         if passing_test_line not in out:
             msg = ('Unable to find %r in gtest output:\n\n%s%s' %
                    (passing_test_line, out, err))
             return lit.Test.UNRESOLVED, msg
 
         return lit.Test.PASS,''
 
-    def maybeAddPythonToCmd(self, cmd):
-        """Insert the python exe into the command if cmd[0] ends in .py
+    def prepareCmd(self, cmd, litConfig):
+        """Insert interpreter if needed.
 
+        It inserts the python exe into the command if cmd[0] ends in .py or caller
+        specified run_under.
         We cannot rely on the system to interpret shebang lines for us on
         Windows, so add the python executable to the command if this is a .py
         script.
         """
         if cmd[0].endswith('.py'):
-            return [sys.executable] + cmd
+            cmd = [sys.executable] + cmd
+        if self.run_under:
+            if not (isinstance(self.run_under, list) and
+                    all(isinstance(s, str) for s in self.run_under)):
+                litConfig.fatal('run_under must be a list of strings')
+            cmd = self.run_under + cmd
         return cmd