config.yml

version: 2.1

orbs:
  win: circleci/windows@1.0.0

executors:
  linux-node:
    docker:
      - image: circleci/node:stretch
  linux-python:
    docker:
      - image: cimg/python:3.10.7
  bionic:
    docker:
      - image: emscripten/emscripten-ci
    environment:
      LANG: "C.UTF-8"
      EMCC_CORES: "4"
      EMSDK_NOTTY: "1"
      EMTEST_WASI_SYSROOT: "~/wasi-sdk/wasi-sysroot"
      EMTEST_BUILD_VERBOSE: "2"
      EMTEST_DETECT_TEMPFILE_LEAKS: "1"
      # Currently pinned due to https://github.com/emscripten-core/emscripten/issues/17846
      V8_VERSION: "10.7.186"
  mac:
    environment:
      EMSDK_NOTTY: "1"
    macos:
      xcode: "13.4.1"

commands:
  download-chrome:
    description: "Download chrome"
    steps:
      - run:
          name: download chrome
          command: |
            # Using stable rather than beta until we can fix
            # https://github.com/emscripten-core/emscripten/issues/14369
            wget -O ~/chrome.deb https://dl.google.com/linux/direct/google-chrome-beta_current_amd64.deb
            # If that download link breaks, temporarily use this URL instead:
            # wget -O ~/chrome.deb https://storage.googleapis.com/webassembly/chrome/google-chrome-stable_current_amd64.deb
            dpkg -i ~/chrome.deb
  emsdk-env:
    description: "emsdk_env.sh"
    steps:
      - run:
          name: emsdk_env.sh
          command: |
            EMSDK_BASH=1 ~/emsdk/emsdk construct_env >> $BASH_ENV
            # In order make our external version of emscripten use the emsdk
            # config we need to explictly set EM_CONFIG here.
            echo "export EM_CONFIG=~/emsdk/.emscripten" >> $BASH_ENV
  npm-install:
    description: "npm ci"
    steps:
      - run: npm ci
  pip-install:
    description: "pip install"
    parameters:
      python:
        description: "Python executable to use"
        type: string
        default: python3
    steps:
      - run:
          name: pip install
          command: << parameters.python >> -m pip install -r requirements-dev.txt
  build:
    description: "Install emsdk"
    steps:
      - run:
          name: install emsdk
          command: |
            curl -# -L -o ~/emsdk-main.tar.gz https://github.com/emscripten-core/emsdk/archive/main.tar.gz
            tar -C ~ -xf ~/emsdk-main.tar.gz
            mv ~/emsdk-main ~/emsdk
            cd ~/emsdk
            ./emsdk update-tags
            ./emsdk install tot-upstream
            ./emsdk activate tot-upstream
            # Remove the emsdk version of emscripten to save space in the
            # persistent workspace and to avoid any confusion with the version
            # we are trying to test.
            rm -Rf emscripten
            echo "import os" >> .emscripten
            # We use an out-of-tree cache directory so it can be part of the
            # persisted workspace (see below).
            echo "CACHE = os.path.expanduser('~/cache')" >> .emscripten
            # test v8 with --wasm-staging which enables new features. we use v8
            # as a "bleeding edge" shell here, basically, with node being the
            # primary shell (which we run without any special flags)
            # Refer to commit 0bc3640 if we need to pin V8 version.
            echo "V8_ENGINE = [os.path.expanduser('~/.jsvu/v8-${V8_VERSION}'), '--wasm-staging']" >> .emscripten
            echo "JS_ENGINES = [NODE_JS]" >> .emscripten
            echo "if os.path.exists(V8_ENGINE[0]): JS_ENGINES.append(V8_ENGINE)" >> .emscripten
            echo "WASM_ENGINES = []" >> .emscripten
            test -f ~/vms/wasmtime && echo "WASMTIME = os.path.expanduser(os.path.join('~', 'vms', 'wasmtime')) ; WASM_ENGINES.append(WASMTIME)" >> .emscripten || true
            test -f ~/vms/wasmer && echo "WASMER = os.path.expanduser(os.path.join('~', 'vms', 'wasmer')) ; WASM_ENGINES.append(WASMER)" >> .emscripten || true
            test -d ~/wasi-sdk && cp -ar ~/wasi-sdk/lib/ ~/emsdk/upstream/lib/clang/16.0.0/
            cd -
            echo "final .emscripten:"
            cat ~/emsdk/.emscripten
      - emsdk-env
      - npm-install
      - run:
          name: clear cache
          command: |
            ./emcc --clear-cache
  build-libs:
    description: "Build all libraries, and freeze the cache"
    steps:
      - pip-install
      - run:
          name: embuilder build ALL
          command: |
            ./embuilder build ALL
            ./test/runner test_hello_world
      - run:
          name: embuilder (LTO)
          command: |
            ./embuilder build MINIMAL --lto
            ./test/runner test_hello_world
      - run:
          name: embuilder (WASM64)
          command: |
            ./embuilder build MINIMAL --wasm64
      - run:
          name: embuilder (PIC)
          command: |
            ./embuilder build MINIMAL_PIC --pic
            ./test/runner test_hello_world
      - run:
          name: embuilder (PIC+LTO)
          command: |
            ./embuilder build MINIMAL --pic --lto
            ./test/runner test_hello_world
  persist:
    description: "Persist the emsdk, libraries, and engines"
    steps:
      - persist_to_workspace:
          # Must be an absolute path, or relative path from working_directory
          root: ~/
          # Must be relative path from root
          paths:
            - emsdk/
            - cache/
            - vms/
            - wasi-sdk/
            - .jsvu/
  prepare-for-tests:
    description: "Setup emscripten tests"
    steps:
      - attach_workspace:
          # Must be absolute path or relative path from working_directory
          at: ~/
      - checkout
      - run:
          name: submodule update
          command: git submodule update --init
      - emsdk-env
      - npm-install
      - pip-install
      - run: apt-get install ninja-build
  run-tests:
    description: "Runs emscripten tests"
    parameters:
      test_targets:
        description: "Test suites to run"
        type: string
    steps:
      - run:
          name: run tests
          command: |
            ./test/runner << parameters.test_targets >>
            $EMSDK_PYTHON ./tools/check_clean.py
  freeze-cache:
    description: "Freeze emscripten cache"
    steps:
      - run:
          name: Add EM_FROZEN_CACHE to bash env
          command: echo "export EM_FROZEN_CACHE=1" >> $BASH_ENV
  run-tests-linux:
    description: "Runs emscripten tests"
    parameters:
      test_targets:
        description: "Test suites to run"
        type: string
      frozen_cache:
        description: "Run with cache frozen"
        type: boolean
        default: true
    steps:
      - prepare-for-tests
      - when:
          condition: << parameters.frozen_cache >>
          steps:
            - freeze-cache
      - run-tests:
          test_targets: << parameters.test_targets >>
  test-firefox:
    description: "Runs emscripten tests under firefox"
    steps:
      - prepare-for-tests
      - run:
          name: download firefox
          command: |
            wget -O ~/ff.tar.bz2 "https://download.mozilla.org/?product=firefox-devedition-latest-ssl&os=linux64&lang=en-US"
            tar -C ~ -xf ~/ff.tar.bz2
      - run:
          name: configure firefox
          command: |
            mkdir ~/tmp-firefox-profile/
            cat > ~/tmp-firefox-profile/user.js \<<EOF
            user_pref("gfx.offscreencanvas.enabled", true);
            user_pref("javascript.options.shared_memory", true);
            user_pref("dom.postMessage.sharedArrayBuffer.bypassCOOP_COEP.insecure.enabled", true);
            EOF
      - run:
          # browser.test_sdl2_mouse and/or SDL2 should be fixed. The case happens
          # to be failing here, and the root cause might be related with the
          # initial position of the mouse pointer relative to the canvas.
          # browser.test_html5_webgl_create_context is skipped because
          # anti-aliasing is not well supported.
          # browser.test_webgl_offscreen_canvas_in_pthread and
          # browser.test_webgl_offscreen_canvas_in_mainthread_after_pthread
          # are crashing Firefox (bugzil.la/1281796). The former case is
          # further blocked by issue #6897.
          name: run tests
          environment:
            GALLIUM_DRIVER: softpipe # TODO: use the default llvmpipe when it supports more extensions
            # TODO: Do GL testing when https://bugzil.la/1375585 (lack of WebGL
            #       support in headless mode) resolves
            EMTEST_LACKS_GRAPHICS_HARDWARE: "1"
            EMTEST_LACKS_SOUND_HARDWARE: "1"
            # OffscreenCanvas support is not yet done in Firefox.
            EMTEST_LACKS_OFFSCREEN_CANVAS: "1"
            EMTEST_DETECT_TEMPFILE_LEAKS: "0"
            DISPLAY: ":0"
          command: |
            export EMTEST_BROWSER="$HOME/firefox/firefox -headless -profile $HOME/tmp-firefox-profile/"
            # There are tests in the browser test suite that using libraries
            # that are not included by "./embuilder build ALL".  For example the
            # PIC version of libSDL which is used by test_sdl2_misc_main_module
            export EM_FROZEN_CACHE=""
            echo "-----"
            echo "Running browser tests"
            echo "-----"
            test/runner browser 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
            # posix and emrun suites are disabled because firefox errors on
            #  "Firefox is already running, but is not responding."
            # TODO: find out a way to shut down and restart firefox
  test-chrome:
    description: "Runs emscripten browser tests under chrome"
    steps:
      - prepare-for-tests
      - download-chrome
      - run:
          name: run tests
          environment:
            EMTEST_LACKS_SOUND_HARDWARE: "1"
            EMTEST_DETECT_TEMPFILE_LEAKS: "0"
            # --no-sandbox becasue we are running as root and chrome requires
            # this flag for now: https://crbug.com/638180
            CHROME_FLAGS_BASE: "--no-first-run -start-maximized --no-sandbox --use-gl=swiftshader --user-data-dir=/tmp/chrome-emscripten-profile --enable-experimental-web-platform-features"
            CHROME_FLAGS_HEADLESS: "--headless --remote-debugging-port=1234"
            CHROME_FLAGS_WASM: "--enable-features=WebAssembly --enable-features=SharedArrayBuffer --disable-features=WebAssemblyTrapHandler --js-flags=\"--experimental-wasm-threads --harmony-sharedarraybuffer\""
            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"
            # There are tests in the browser test suite that using libraries
            # that are not included by "./embuilder build ALL".  For example the
            # PIC version of libSDL which is used by test_sdl2_misc_main_module
            export EM_FROZEN_CACHE=""
            # skip test_zzz_zzz_4gb_fail as it OOMs on the current bot
            test/runner browser posixtest_browser.test_pthread_create_1_1 skip:browser.test_zzz_zzz_4gb_fail
            test/runner emrun
  test-sockets-chrome:
    description: "Runs emscripten sockets tests under chrome"
    steps:
      - prepare-for-tests
      - download-chrome
      - run:
          name: run sockets tests
          environment:
            EMTEST_LACKS_SOUND_HARDWARE: "1"
            EMTEST_DETECT_TEMPFILE_LEAKS: "0"
            # --no-sandbox becasue we are running as root and chrome requires
            # this flag for now: https://crbug.com/638180
            CHROME_FLAGS_BASE: "--no-first-run -start-maximized --no-sandbox --use-gl=swiftshader --user-data-dir=/tmp/chrome-emscripten-profile"
            CHROME_FLAGS_HEADLESS: "--headless --remote-debugging-port=1234"
            CHROME_FLAGS_WASM: "--enable-features=WebAssembly --enable-features=SharedArrayBuffer --disable-features=WebAssemblyTrapHandler --js-flags=\"--experimental-wasm-threads --harmony-sharedarraybuffer --no-wasm-disable-structured-cloning\""
            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"
            test/runner sockets

jobs:
  build-docs:
    executor: bionic
    steps:
      - checkout
      - pip-install
      - run: make -C site text
      - run: tools/maint/check_emcc_help_text.py
      - run: make -C site html
  flake8:
    executor: bionic
    steps:
      - checkout
      - pip-install
      - run: python3 -m flake8 --show-source --statistics
  mypy:
    executor: bionic
    steps:
      - checkout
      - pip-install
      - run: mypy
  eslint:
    executor: linux-node
    steps:
      - checkout
      - npm-install
      - run: |
          npm run lint
          npm run check
  test-sanity:
    executor: bionic
    steps:
      - run-tests-linux:
          frozen_cache: false
          test_targets: "sanity"
  build-linux:
    executor: bionic
    # xlarge has 4x the cores of the default medium, costs 4x as much, and runs
    # in about 1/2 the time, so it is not cost-effective (overall it is 2x the
    # cost for the same work), but given this blocks almost all the other jobs
    # we want it to finish asap
    resource_class: xlarge
    environment:
      EMCC_CORES: 16
    steps:
      - checkout
      - run:
          name: get wasmer
          command: |
            wget https://github.com/wasmerio/wasmer/releases/download/0.11.0/wasmer-linux-amd64.tar.gz
            tar -xf wasmer-linux-amd64.tar.gz
            mkdir ~/vms
            cp bin/wasmer ~/vms
      - run:
          name: get wasmtime
          command: |
            # use a pinned version due to https://github.com/bytecodealliance/wasmtime/issues/714
            export VERSION=v0.33.0
            wget https://github.com/bytecodealliance/wasmtime/releases/download/$VERSION/wasmtime-$VERSION-x86_64-linux.tar.xz
            tar -xf wasmtime-$VERSION-x86_64-linux.tar.xz
            cp wasmtime-$VERSION-x86_64-linux/wasmtime ~/vms
      - run:
          name: get wasi-sdk-sysroot
          command: |
            wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-11/libclang_rt.builtins-wasm32-wasi-11.0.tar.gz
            wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-11/wasi-sysroot-11.0.tar.gz
            mkdir ~/wasi-sdk
            tar xvf libclang_rt.builtins-wasm32-wasi-11.0.tar.gz -C ~/wasi-sdk
            tar xvf wasi-sysroot-11.0.tar.gz -C ~/wasi-sdk/
      - run:
          name: get v8
          command: |
            wget https://nodejs.org/dist/v12.13.0/node-v12.13.0-linux-x64.tar.xz
            tar -xf node-v12.13.0-linux-x64.tar.xz
            export PATH="`pwd`/node-v12.13.0-linux-x64/bin:${PATH}"
            npm install jsvu -g
            export PATH="${HOME}/.jsvu:${PATH}"
            jsvu --os=default --engines=v8 v8@${V8_VERSION}
      - build
      - build-libs
      - persist
  # Perhaps we don't need to run this suite with every commit. Consider moving this to FYI bot.
  test-posixtest:
    executor: bionic
    steps:
      - run-tests-linux:
          test_targets: "posixtest"
  test-core0:
    executor: bionic
    steps:
      - run-tests-linux:
          test_targets: "core0"
  test-core2:
    executor: bionic
    environment:
      EMTEST_BROWSER: "node"
    steps:
      - run-tests-linux:
          # also run a few asan tests.  Run these with frozen_cache disabled
          # since we don't pre-build all the asan libraries.
          frozen_cache: false
          test_targets: "
            asan.test_stat
            asan.test_float_builtins
            asan.test_embind*
            asan.test_abort_on_exceptions
            asan.test_ubsan_full_left_shift_fsanitize_integer
            asan.test_pthread*
            asan.test_dyncall_specific_minimal_runtime
            asan.test_async_hello
            asan.test_dlfcn_basic
            asan.test_async_hello_stack_switching
            lsan.test_stdio_locking
            lsan.test_dlfcn_basic
            lsan.test_pthread_create"
      - freeze-cache
      - run-tests:
          # also run a single test of EMTEST_BROWSER=node.
          # also run a corez test of dynamic linking + forced syslibs.
          test_targets: "
            core2
            browser.test_pthread_join
            corez.test_dylink_syslibs_all"
  test-core3:
    executor: bionic
    steps:
      - run-tests-linux:
          frozen_cache: false
          # also add a little select testing for wasm2js in -O3
          # also add a little select wasmfs testing
          test_targets: "
            lto2.test_dylink_syslibs_all
            core3
            core2g.test_externref
            corez.test_dylink_iostream
            core2ss.test_pthread_dylink
            core2ss.test_pthread_thread_local_storage
            core2s.test_dylink_syslibs_missing_assertions
            wasm2js3.test_memorygrowth_2
            other.test_unistd_fstatfs_wasmfs
            wasmfs.test_hello_world
            wasmfs.test_hello_world_standalone
            wasmfs.test_unistd_links*
            wasmfs.test_atexit_standalone
            wasmfs.test_emscripten_get_now
            wasmfs.test_dyncall_specific_minimal_runtime
            wasmfs.test_utime
            wasmfs.test_unistd_unlink
            wasmfs.test_unistd_access
            wasmfs.test_unistd_close
            wasmfs.test_unistd_truncate
            wasmfs.test_readdir
            wasmfs.test_unistd_pipe
            wasmfs.test_dlfcn_self
            wasmfs.test_dlfcn_unique_sig
            wasmfs.test_dylink_basics
            wasmfs.test_exit_status
            wasmfs.test_minimal_runtime_memorygrowth
            wasmfs.test_mmap_anon*
            wasmfs.test_getcwd_with_non_ascii_name
            wasmfs.test_stat
            wasmfs.test_fstatat
            wasmfs.test_unistd_links_memfs
            wasmfs.test_fcntl_open"
  test-wasm2js1:
    executor: bionic
    steps:
      - run-tests-linux:
          test_targets: "wasm2js1"
  test-wasm64:
    executor: bionic
    steps:
      - run-tests-linux:
          frozen_cache: false
          test_targets: "wasm64"
      - run-tests:
          test_targets: "wasm64l"
  test-latest-node:
    executor: linux-python
    steps:
      - checkout
      - run:
          name: submodule update
          command: git submodule update --init
      - pip-install
      - build
      - run:
          name: get node
          command: |
            cd $HOME
            wget https://nodejs.org/dist/v19.0.0/node-v19.0.0-linux-x64.tar.xz
            tar xf node-v19.0.0-linux-x64.tar.xz
            echo "export EM_JS_ENGINES=$HOME/node-v19.0.0-linux-x64/bin/node" >> $BASH_ENV
            echo "export EM_NODE_JS=$HOME/node-v19.0.0-linux-x64/bin/node" >> $BASH_ENV
            echo "export PATH=\"$HOME/node-v19.0.0-linux-x64/bin:\$PATH\"" >> $BASH_ENV
      - run-tests:
          # Run tests that on older versions of node would require flags, but
          # those flags should not be injected on newer versions.
          test_targets: "-v core2.test_pthread_create core2.test_i64_invoke_bigint"
  test-other:
    executor: bionic
    steps:
      - run-tests-linux:
          # some native-dependent tests fail because of the lack of native
          # headers on emsdk-bundled clang
          test_targets: "other skip:other.test_native_link_error_message"
  test-browser-chrome:
    executor: bionic
    steps:
      - test-chrome
  test-browser-firefox:
    executor: bionic
    steps:
      - test-firefox
  test-sockets-chrome:
    executor: bionic
    steps:
      - test-sockets-chrome
  # windows and mac do not have separate build and test jobs, as they only run
  # a limited set of tests; it is simpler and faster to do it all in one job.
  test-windows:
    executor:
      name: win/vs2019
      shell: bash.exe -eo pipefail
    environment:
      PYTHONUNBUFFERED: "1"
      EMSDK_NOTTY: "1"
      # clang can compile but not link in the current setup, see
      # https://github.com/emscripten-core/emscripten/pull/11382#pullrequestreview-428902638
      EMTEST_LACKS_NATIVE_CLANG: "1"
      EMTEST_SKIP_V8: "1"
    steps:
      - checkout
      - run:
          name: Install packages
          command: |
            choco install cmake.portable ninja pkgconfiglite
      - run:
          name: Add python to bash path
          command: echo "export PATH=\"$PATH:/c/Python27amd64/\"" >> $BASH_ENV
      - build
      # note we do *not* build all libraries and freeze the cache; as we run
      # only limited tests here, it's more efficient to build on demand
      - pip-install:
          python: "$EMSDK_PYTHON"
      - run-tests:
          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_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_pkg_config*"
      # Run a single websockify-based test to ensure it works on windows.
      - run-tests:
          test_targets: "sockets.test_nodejs_sockets_echo*"
  test-mac:
    executor: mac
    environment:
      EMTEST_SKIP_V8: "1"
    steps:
      - run:
          name: Install brew package dependencies
          environment:
            HOMEBREW_NO_AUTO_UPDATE: "1"
          command: |
            brew list cmake || brew install cmake
            brew list ninja || brew install ninja
            brew list python3 || brew install python3
            brew list pkg-config || brew install pkg-config
      - checkout
      - build
      # note we do *not* build all libraries and freeze the cache; as we run
      # only limited tests here, it's more efficient to build on demand
      - pip-install:
          python: "$EMSDK_PYTHON"
      - run-tests:
          # skip other.test_stack_switching_size as we do not currently install
          # d8 on mac
          test_targets: "
            other
            sockets.test_nodejs_sockets_echo*
            core0.test_lua
            core0.test_longjmp_standalone
            core2.test_sse1
            skip:other.test_native_link_error_message
            skip:other.test_stack_switching_size"

workflows:
  build-test:
    jobs:
      - flake8
      - mypy
      - eslint
      - build-docs
      - build-linux
      - test-sanity:
          requires:
            - build-linux
      - test-posixtest:
          requires:
            - build-linux
      - test-core0:
          requires:
            - build-linux
      - test-core2:
          requires:
            - build-linux
      - test-core3:
          requires:
            - build-linux
      - test-wasm64:
          requires:
            - build-linux
      - test-wasm2js1:
          requires:
            - build-linux
      - test-other:
          requires:
            - build-linux
      - test-browser-chrome:
          requires:
            - build-linux
      - test-browser-firefox:
          requires:
            - build-linux
      - test-sockets-chrome:
          requires:
            - build-linux
      - test-latest-node
      - test-windows
      - test-mac