Add launcher script for tests/runner.py (#13494)

This ensures we use the same version of python that is used
by emscripten and emsdk.

See emscripten-core/emsdk#706

Author: sbc100

.circleci/config.yml

@@ -16,11 +16,9 @@ executors:
       EMCC_CORES: "4"
       EMSDK_NOTTY: "1"
       EMTEST_WASI_SYSROOT: "~/wasi-sdk/wasi-sysroot"
-      PYTHON_BIN: "python3"
   mac:
     environment:
       EMSDK_NOTTY: "1"
-      PYTHON_BIN: "python3"
     macos:
       xcode: "12.2.0"
 
@@ -74,30 +72,30 @@ commands:
       - run:
           name: clear cache
           command: |
-            $PYTHON_BIN ./emcc.py --clear-cache
+            ./emcc --clear-cache
   build-libs-and-freeze:
     description: "Build all libraries, and freeze the cache"
     steps:
       - run:
           name: embuilder build ALL
           command: |
-            $PYTHON_BIN ./embuilder.py build ALL
-            $PYTHON_BIN tests/runner.py test_hello_world
+            ./embuilder build ALL
+            ./tests/runner test_hello_world
       - run:
           name: embuilder (LTO)
           command: |
-            $PYTHON_BIN ./embuilder.py build MINIMAL --lto
-            $PYTHON_BIN tests/runner.py test_hello_world
+            ./embuilder build MINIMAL --lto
+            ./tests/runner test_hello_world
       - run:
           name: embuilder (PIC)
           command: |
-            $PYTHON_BIN ./embuilder.py build SYSTEM --pic
-            $PYTHON_BIN tests/runner.py test_hello_world
+            ./embuilder build SYSTEM --pic
+            ./tests/runner test_hello_world
       - run:
           name: embuilder (PIC+LTO)
           command: |
-            $PYTHON_BIN ./embuilder.py build MINIMAL --pic --lto
-            $PYTHON_BIN tests/runner.py test_hello_world
+            ./embuilder build MINIMAL --pic --lto
+            ./tests/runner test_hello_world
       - run:
           name: freeze cache
           command: |
@@ -134,8 +132,8 @@ commands:
       - run:
           name: run tests
           command: |
-            $PYTHON_BIN tests/runner.py << parameters.test_targets >>
-            $PYTHON_BIN tools/check_clean.py
+            ./tests/runner << parameters.test_targets >>
+            $EMSDK_PYTHON ./tools/check_clean.py
   run-tests-mac:
     description: "Runs emscripten tests"
     parameters:
@@ -157,8 +155,8 @@ commands:
       - run:
           name: run tests
           command: |
-            python3 tests/runner.py << parameters.test_targets >>
-            tools/check_clean.py
+            ./tests/runner << parameters.test_targets >>
+            $EMSDK_PYTHON ./tools/check_clean.py
   test-firefox:
     description: "Runs emscripten tests under firefox"
     steps:
@@ -259,8 +257,8 @@ commands:
             EXTRA_AUTOSTART=$TMPDIR/autostart startx /usr/bin/openbox-session -- $DISPLAY -config ~/.config/X11/xorg.conf -nolisten tcp &
             cat $TMPDIR/fifo > /dev/null # wait until $EXTRA_AUTOSTART is spawned, which indicates the end of Openbox initialization
             rm -r $TMPDIR
-            python3 tests/runner.py browser posixtest_browser.test_pthread_create_1_1 skip:browser.test_sdl2_mouse skip:browser.test_html5_webgl_create_context skip:browser.test_webgl_offscreen_canvas_in_pthread skip:browser.test_webgl_offscreen_canvas_in_mainthread_after_pthread skip:browser.test_glut_glutget
-            python3 tests/runner.py emrun
+            tests/runner browser posixtest_browser.test_pthread_create_1_1 skip:browser.test_sdl2_mouse skip:browser.test_html5_webgl_create_context skip:browser.test_webgl_offscreen_canvas_in_pthread skip:browser.test_webgl_offscreen_canvas_in_mainthread_after_pthread skip:browser.test_glut_glutget
+            tests/runner emrun
             openbox --exit
             wait || true # wait for startx to shutdown cleanly, or not
   test-chrome:
@@ -294,8 +292,8 @@ commands:
           command: |
             export EMTEST_BROWSER="/usr/bin/google-chrome $CHROME_FLAGS_BASE $CHROME_FLAGS_HEADLESS $CHROME_FLAGS_WASM $CHROME_FLAGS_NOCACHE"
             # skip test_zzz_zzz_4gb_fail as it OOMs on the current bot
-            python3 tests/runner.py browser posixtest_browser.test_pthread_create_1_1 skip:browser.test_zzz_zzz_4gb_fail
-            python3 tests/runner.py emrun
+            tests/runner browser posixtest_browser.test_pthread_create_1_1 skip:browser.test_zzz_zzz_4gb_fail
+            tests/runner emrun
   test-sockets-chrome:
     description: "Runs emscripten sockets tests under chrome"
     steps:
@@ -323,7 +321,7 @@ commands:
             CHROME_FLAGS_NOCACHE: "--disk-cache-dir=/dev/null --disk-cache-size=1 --media-cache-size=1 --disable-application-cache --incognito"
           command: |
             export EMTEST_BROWSER="/usr/bin/google-chrome $CHROME_FLAGS_BASE $CHROME_FLAGS_HEADLESS $CHROME_FLAGS_WASM $CHROME_FLAGS_NOCACHE"
-            python3 tests/runner.py sockets
+            tests/runner sockets
 
 jobs:
   build-docs:
@@ -446,9 +444,6 @@ jobs:
       name: win/vs2019
       shell: bash.exe -eo pipefail
     environment:
-      # on windows the python binary is always called python.exe and never
-      # python3.exe
-      PYTHON_BIN: "python"
       PYTHONUNBUFFERED: "1"
       EMSDK_NOTTY: "1"
       # clang can compile but not link in the current setup, see

site/source/docs/getting_started/test-suite.rst

@@ -18,30 +18,30 @@ how best to do that.
 Running tests
 =============
 
-Run the test suite runner (`tests/runner.py <https://github.com/emscripten-core/emscripten/blob/master/tests/runner.py>`_) with no arguments to see the help message:
+Run the test suite runner (`tests/runner <https://github.com/emscripten-core/emscripten/blob/master/tests/runner.py>`_) with no arguments to see the help message:
 
 .. code-block:: bash
 
-    python tests/runner.py
+    tests/runner
 
 The tests are divided into *modes*. You can run either an entire mode or an individual test, or use wildcards to run some tests in some modes. For example:
 
 .. code-block:: bash
 
   # run one test (in the default mode)
-  python tests/runner.py test_loop
+  tests/runner test_loop
 
   # run one test in a specific mode (here, asm.js -O2)
-  python tests/runner.py asm2.test_loop
+  tests/runner asm2.test_loop
 
   # run a test in a bunch of modes (here, all asm.js modes)
-  python tests/runner.py asm*.test_loop
+  tests/runner asm*.test_loop
 
   # run a bunch of tests in one mode (here, all i64 tests in wasm -O3)
-  python tests/runner.py wasm3.test_*i64*
+  tests/runner wasm3.test_*i64*
 
   # run all tests in a specific mode (here, asm.js -O1)
-  python tests/runner.py asm1
+  tests/runner asm1
 
 The *core* test modes (defined at the bottom of `tests/test_core.py <https://github.com/emscripten-core/emscripten/blob/master/tests/test_core.py>`_) let you run a specific test in either asm.js or wasm, and with different optimization flags. There are also non-core test modes, that run tests in more special manner (in particular, in those tests it is not possible to say "run the test with a different optimization flag" - that is what the core tests are for). The non-core test modes include
 
@@ -57,13 +57,13 @@ The wildcards we mentioned above work for non-core test modes too, for example:
 .. code-block:: bash
 
   # run one browser test
-  python tests/runner.py browser.test_sdl_image
+  tests/runner browser.test_sdl_image
 
   # run all SDL2 browser tests
-  python tests/runner.py browser.test_sdl2*
+  tests/runner browser.test_sdl2*
 
   # run all browser tests
-  python tests/runner.py browser
+  tests/runner browser
 
 Skipping Tests
 ==============
@@ -72,13 +72,13 @@ An individual test can be skipped by passing the "skip:" prefix. E.g.
 
 .. code-block:: bash
 
-  python tests/runner.py other skip:other.test_cmake
+  tests/runner other skip:other.test_cmake
 
 Wildcards can also be passed in skip, so
 
 .. code-block:: bash
 
-  python tests/runner.py browser skip:browser.test_pthread_*
+  tests/runner browser skip:browser.test_pthread_*
 
 will run the whole browser suite except for all the pthread tests in it.
 
@@ -89,7 +89,7 @@ You can run a random subset of the test suite, using something like
 
 .. code-block:: bash
 
-    python tests/runner.py random100
+    tests/runner random100
 
 Replace ``100`` with another number as you prefer. This will run that number of random tests, and tell you the statistical likelihood of almost all the test suite passing assuming those tests do. This works just like election surveys do - given a small sample, we can predict fairly well that so-and-so percent of the public will vote for candidate A. In our case, the "candidates" are pass or fail, and we can predict how much of the test suite will pass given that sample. Assuming the sample tests all pass, we can say with high likelihood that most of the test suite will in fact pass. (Of course, this is no guarantee, and even a single test failure is serious, however, this gives a quick estimate that your patch does not cause significant and obvious breakage.)
 
@@ -102,23 +102,23 @@ When you want to run the entire test suite locally, these are currently the impo
 .. code-block:: bash
 
   # Run all core wasm tests
-  python tests/runner.py wasm*
+  tests/runner wasm*
 
   # Run "other" test suite
-  python tests/runner.py other
+  tests/runner other
 
   # Run "browser" test suite - this requires a web browser
-  python tests/runner.py browser
+  tests/runner browser
 
   # Run "sockets" test suite - this requires a web browser too
-  python tests/runner.py sockets
+  tests/runner sockets
 
   # Run "sanity" test suite - this tests setting up emscripten during
   # first run, etc., and so it modifies your .emscripten file temporarily.
-  python tests/runner.py sanity
+  tests/runner sanity
 
   # Optionally, also run benchmarks to check for regressions
-  python tests/runner.py benchmark
+  tests/runner benchmark
 
 .. _benchmarking:
 
@@ -137,16 +137,16 @@ To run the benchmark suite, do:
 .. code-block:: bash
 
   # Run all benchmarks
-  python tests/runner.py benchmark
+  tests/runner benchmark
 
 As with all the test suites, you can also run a specific benchmark:
 
 .. code-block:: bash
 
   # Run one specific benchmark
-  python tests/runner.py benchmark.test_skinning
+  tests/runner benchmark.test_skinning
 
-Usually you will want to customize the python in `tests/test_benchmark.py` to
+Usually you will want to customize the in `tests/test_benchmark.py` to
 run the benchmarks you want (there is currently no external config file). Things
 you may want to modify include:
 
@@ -167,14 +167,14 @@ Setting the :ref:`debugging-EMCC_DEBUG` is useful for debugging tests, as it emi
 
   # On Windows, use "set" to set and un-set the EMCC_DEBUG environment variable:
   set EMCC_DEBUG=1
-  python tests/runner.py test_hello_world
+  tests/runner test_hello_world
   set EMCC_DEBUG=0
 
   # On Linux, you can do this all in one line
-  EMCC_DEBUG=1 python tests/runner.py test_hello_world
+  EMCC_DEBUG=1 tests/runner test_hello_world
 
   # EMCC_DEBUG=2 generates additional debug information.
-  EMCC_DEBUG=2 python tests/runner.py test_hello_world
+  EMCC_DEBUG=2 tests/runner test_hello_world
 
 
 You can also specify ``EMTEST_SAVE_DIR=1`` in the environment to save the

src/library_sdl.js

@@ -7,7 +7,7 @@
 //"use strict";
 
 // See browser tests for examples (tests/runner.py, search for sdl_). Run with
-//    python tests/runner.py browser
+//    tests/runnery browser
 
 // Notes:
 //  SDL_VIDEORESIZE: This is sent when the canvas is resized. Note that the user

tests/runner

@@ -0,0 +1,29 @@
+#!/bin/sh
+# Copyright 2020 The Emscripten Authors.  All rights reserved.
+# Emscripten is available under two separate licenses, the MIT license and the
+# University of Illinois/NCSA Open Source License.  Both these licenses can be
+# found in the LICENSE file.
+#
+# Entry point for running python scripts on UNIX systems.
+#
+# To modify this file, edit `tools/run_python.sh` and then run
+# `tools/create_entry_points.py`
+
+if [ -z "$PYTHON" ]; then
+  PYTHON=$EMSDK_PYTHON
+fi
+
+if [ -z "$PYTHON" ]; then
+  PYTHON=$(which python3 2> /dev/null)
+fi
+
+if [ -z "$PYTHON" ]; then
+  PYTHON=$(which python 2> /dev/null)
+fi
+
+if [ -z "$PYTHON" ]; then
+  echo 'unable to find python in $PATH'
+  exit 1
+fi
+
+exec "$PYTHON" "$0.py" "$@"

tests/runner.bat

@@ -0,0 +1,11 @@
+:: Entry point for running python scripts on windows systems.
+:: To modify this file, edit `tools/run_python.bat` and then run
+:: `tools/create_entry_points.py`
+
+@setlocal
+@set EM_PY=%EMSDK_PYTHON%
+@if "%EM_PY%"=="" (
+  set EM_PY=python
+)
+
+@"%EM_PY%" "%~dp0\%~n0.py" %*

tests/runner.py

@@ -7,7 +7,7 @@
 """This is the Emscripten test runner. To run some tests, specify which tests
 you want, for example
 
-  python3 tests/runner.py asm1.test_hello_world
+  tests/runner asm1.test_hello_world
 
 There are many options for which tests to run and how to run them. For details,
 see

tests/test_browser.py

@@ -2467,7 +2467,7 @@ def test_cpuprofiler_memoryprofiler(self):
     self.btest('hello_world_gles.c', expected='0', args=['-DLONGTEST=1', '-DTEST_MEMORYPROFILER_ALLOCATIONS_MAP=1', '-O2', '--cpuprofiler', '--memoryprofiler', '-lGL', '-lglut', '-DANIMATE'])
 
   def test_uuid(self):
-    # Run with ./runner.py browser.test_uuid
+    # Run with ./runner browser.test_uuid
     # We run this test in Node/SPIDERMONKEY and browser environments because we try to make use of
     # high quality crypto random number generators such as crypto.getRandomValues or randomBytes (if available).
 

tests/test_core.py

@@ -16,7 +16,7 @@
 from functools import wraps
 
 if __name__ == '__main__':
-  raise Exception('do not run this file directly; do something like: tests/runner.py')
+  raise Exception('do not run this file directly; do something like: tests/runner')
 
 from tools.shared import try_delete, PIPE
 from tools.shared import PYTHON, EMCC, EMAR

tests/test_other.py

@@ -26,7 +26,7 @@
 from subprocess import PIPE, STDOUT
 
 if __name__ == '__main__':
-  raise Exception('do not run this file directly; do something like: tests/runner.py other')
+  raise Exception('do not run this file directly; do something like: tests/runner other')
 
 from tools.shared import try_delete, config
 from tools.shared import EMCC, EMXX, EMAR, EMRANLIB, PYTHON, FILE_PACKAGER, WINDOWS, EM_BUILD_VERBOSE
@@ -2472,7 +2472,6 @@ def test_demangle_malloc_infinite_loop_crash(self):
   def test_module_exports_with_closure(self):
     # This test checks that module.export is retained when JavaScript is minified by compiling with --closure 1
     # This is important as if module.export is not present the Module object will not be visible to node.js
-    # Run with ./runner.py other.test_module_exports_with_closure
 
     # First make sure test.js isn't present.
     self.clear()

tests/test_sanity.py

@@ -15,14 +15,14 @@
 from runner import RunnerCore, path_from_root, env_modify
 from runner import create_test_file, ensure_dir, make_executable
 from tools.config import config_file, EM_CONFIG
-from tools.shared import PYTHON, EMCC
+from tools.shared import EMCC
 from tools.shared import CANONICAL_TEMP_DIR
 from tools.shared import try_delete, config
 from tools.shared import EXPECTED_LLVM_VERSION, Cache
 from tools import shared, system_libs, utils
 
 SANITY_FILE = shared.Cache.get_path('sanity.txt')
-commands = [[EMCC], [PYTHON, path_from_root('tests', 'runner.py'), 'blahblah']]
+commands = [[EMCC], [path_from_root('tests', 'runner'), 'blahblah']]
 
 
 def restore():