Create @crossplatform_test decorator (#18997)

Currently the CircleCI windows builder uses a hardcoded list of tests.
Switch to using a decorator to discover these tests, to make it
easier to share the list.

Author: dschuff

.circleci/config.yml

@@ -649,48 +649,8 @@ jobs:
       - pip-install:
           python: "$EMSDK_PYTHON"
       - run-tests:
-          title: "other subset"
-          test_targets: "
-            core0.test_dylink_basics
-            core2.test_sse1
-            core2.test_ccall
-            core2.test_utf16
-            core2.test_em_asm_unicode
-            core2.test_em_js
-            core2.test_em_js_pthreads
-            core2.test_unicode_js_library
-            other.test_reproduce
-            other.test_stack_overflow
-            other.test_dlmalloc_modes
-            other.test_c_preprocessor
-            other.test_prejs_unicode
-            other.test_em_js_side_module
-            other.test_es5_transpile
-            other.test_emcc_cflags
-            other.test_stdin
-            other.test_bad_triple
-            other.test_closure_externs
-            other.test_binaryen_debug
-            other.test_js_optimizer*
-            other.test_output_to_nowhere
-            other.test_emcc_dev_null
-            other.test_cmake*
-            other.test_system_include_paths
-            other.test_emar_response_file
-            other.test_special_chars_in_arguments
-            other.test_toolchain_profiler
-            other.test_realpath_nodefs
-            other.test_response_file_encoding
-            other.test_libc_progname
-            other.test_realpath
-            other.test_embed_file_dup
-            other.test_dot_a_all_contents_invalid
-            other.test_emcc_print_search_dirs
-            other.test_emcc_print_file_name
-            other.test_minimal_runtime_export_all_modularize
-            other.test_pkg_config*
-            other.test_pthreads_flag
-            other.test_sdl2_config"
+          title: "crossplatform tests"
+          test_targets: "--crossplatform-only"
       - upload-test-results
       # Run a single websockify-based test to ensure it works on windows.
       - run-tests:

test/common.py

@@ -221,6 +221,11 @@ def decorated(self, *args, **kwargs):
   return decorated
 
 
+def crossplatform(f):
+  f.is_crossplatform_test = True
+  return f
+
+
 @contextlib.contextmanager
 def env_modify(updates):
   """A context manager that updates os.environ."""

test/runner.py

@@ -127,6 +127,21 @@ def get_all_tests(modules):
   return all_tests
 
 
+def get_crossplatform_tests(modules):
+  suites = ['core2', 'other'] # We don't need all versions of every test
+  crossplatform_tests = []
+  # Walk over the test suites and find the test functions with the
+  # is_crossplatform_test attribute applied by @crossplatform decorator
+  for m in modules:
+    for s in suites:
+      if hasattr(m, s):
+        testclass = getattr(m, s)
+        for funcname in dir(testclass):
+          if hasattr(getattr(testclass, funcname), 'is_crossplatform_test'):
+            crossplatform_tests.append(s + '.' + funcname)
+  return crossplatform_tests
+
+
 def tests_with_expanded_wildcards(args, all_tests):
   # Process wildcards, e.g. "browser.test_pthread_*" should expand to list all pthread tests
   new_args = []
@@ -353,6 +368,7 @@ def parse_args(args):
                       const=True, default=False)
   parser.add_argument('--force64', dest='force64', action='store_const',
                       const=True, default=None)
+  parser.add_argument('--crossplatform-only', action='store_true')
   return parser.parse_args()
 
 
@@ -426,9 +442,12 @@ def prepend_default(arg):
 
   modules = get_and_import_modules()
   all_tests = get_all_tests(modules)
-  tests = tests_with_expanded_wildcards(tests, all_tests)
-  tests = skip_requested_tests(tests, modules)
-  tests = args_for_random_tests(tests, modules)
+  if options.crossplatform_only:
+    tests = get_crossplatform_tests(modules)
+  else:
+    tests = tests_with_expanded_wildcards(tests, all_tests)
+    tests = skip_requested_tests(tests, modules)
+    tests = args_for_random_tests(tests, modules)
   suites, unmatched_tests = load_test_suites(tests, modules)
   if unmatched_tests:
     print('ERROR: could not find the following tests: ' + ' '.join(unmatched_tests))

test/test_core.py

@@ -27,7 +27,7 @@
 from common import RunnerCore, path_from_root, requires_native_clang, test_file, create_file
 from common import skip_if, needs_dylink, no_windows, no_mac, is_slow_test, parameterized
 from common import env_modify, with_env_modify, disabled, node_pthreads, also_with_wasm_bigint
-from common import read_file, read_binary, requires_v8, requires_node, compiler_for
+from common import read_file, read_binary, requires_v8, requires_node, compiler_for, crossplatform
 from common import NON_ZERO, WEBIDL_BINDER, EMBUILDER, PYTHON
 import clang_native
 
@@ -2294,6 +2294,7 @@ def test_main_thread_async_em_asm(self, args, force_c=False):
   def test_main_thread_em_asm_signatures(self):
     self.do_core_test('test_em_asm_signatures.cpp', assert_returncode=NON_ZERO)
 
+  @crossplatform
   def test_em_asm_unicode(self):
     self.do_core_test('test_em_asm_unicode.cpp')
     self.do_core_test('test_em_asm_unicode.cpp', force_c=True)
@@ -2334,6 +2335,7 @@ def test_em_asm_side_module(self):
     'dylink': (['-sMAIN_MODULE=2'], False),
     'dylink_c': (['-sMAIN_MODULE=2'], True),
   })
+  @crossplatform
   def test_em_js(self, args, force_c):
     if '-sMAIN_MODULE=2' in args:
       self.check_dylink()
@@ -4273,6 +4275,7 @@ def do_basic_dylink_test(self, **kwargs):
     ''', 'other says 11.', 'int sidey();', force_c=True, **kwargs)
 
   @needs_dylink
+  @crossplatform
   def test_dylink_basics(self):
     self.do_basic_dylink_test(need_reverse=False)
     self.verify_in_strict_mode('main.js')
@@ -5905,6 +5908,7 @@ def test_utf32(self):
     self.do_runf(test_file('utf32.cpp'), 'OK.')
     self.do_runf(test_file('utf32.cpp'), 'OK.', args=['-fshort-wchar'])
 
+  @crossplatform
   def test_utf16(self):
     self.set_setting('EXPORTED_RUNTIME_METHODS', ['writeAsciiToMemory', 'UTF16ToString', 'stringToUTF16'])
     self.do_runf(test_file('core/test_utf16.cpp'), 'OK.')
@@ -6457,6 +6461,7 @@ def test_js_libraries(self):
     self.do_runf('main.cpp', 'hello from lib!\n*32*\n')
 
   @with_env_modify({'LC_ALL': 'latin-1', 'PYTHONUTF8': '0', 'PYTHONCOERCECLOCALE': '0'})
+  @crossplatform
   def test_unicode_js_library(self):
     create_file('main.c', '''
       #include <stdio.h>
@@ -6736,6 +6741,7 @@ def test_neon_wasm_simd(self):
 
   # Tests invoking the SIMD API via x86 SSE1 xmmintrin.h header (_mm_x() functions)
   @wasm_simd
+  @crossplatform
   @requires_native_clang
   @no_safe_heap('has unaligned 64-bit operations in wasm')
   @no_ubsan('test contains UB')
@@ -7169,6 +7175,7 @@ def test_wasm2c_sandboxing(self, mode):
 
   ### Integration tests
 
+  @crossplatform
   def test_ccall(self):
     self.emcc_args.append('-Wno-return-stack-address')
     self.set_setting('EXPORTED_RUNTIME_METHODS', ['ccall', 'cwrap', 'STACK_SIZE'])