config.yml

version: 2.1

# The Linux jobs include hacks and flags that restricts parallelism, and re-try
# with less parallelism on failure.
#
# This is because CircleCI Linux jobs have 2 CPUs and 4GB RAM allocated via
# cgroups, but run on machines that advertise 36 CPUs and 68GB RAM. This means
# that most build tools will spawn 36 jobs and quickly choke to death. Even
# with just 4 jobs, 4GB may be too little, so we retry serially on failure.
#
# Comments saying "see top comment" refer to this.

orbs:
  win: circleci/windows@2.4.0
  android: circleci/android@1.0.3
  node: circleci/node@4.7.0

workflows:
  version: 2
  build:
    jobs:
      - android
      - linux
      - build-apple-runtime
      - test-macos
      - test-apple-runtime:
          requires:
            - build-apple-runtime
      - package-apple-runtime:
          requires:
            - test-macos
            - test-apple-runtime
      - windows
      - npm:
          requires:
            - android
            - linux
            - package-apple-runtime
            - windows
      - test-emscripten
      - test-linux
      - test-e2e:
          requires:
            - npm
      - test-e2e-intl

# Default settings for Apple jobs (apple-runtime, test-apple-runtime)
apple_defaults: &apple_defaults
  macos:
    xcode: 12.4.0
  working_directory: ~/hermes
  environment:
    - TERM: dumb
    - HERMES_WS_DIR: /tmp/hermes
    # Homebrew currently breaks while updating:
    # https://discuss.circleci.com/t/brew-install-fails-while-updating/32992
    - HOMEBREW_NO_AUTO_UPDATE: 1

jobs:
  android:
    executor:
      name: android/android
      sdk-version: '28'
      variant: ndk
    environment:
      - HERMES_WS_DIR: /tmp/hermes
      - TERM: dumb
      - DEBIAN_FRONTEND: noninteractive
    steps:
      - checkout
      - run:
          name: Set up workspace and install dependencies
          command: |
            yes | sdkmanager "cmake;3.10.2.4988404" &
            mkdir -p "$HERMES_WS_DIR" "$HERMES_WS_DIR/output"
            ln -sf "$PWD" "$HERMES_WS_DIR/hermes"
            sudo apt-get update
            sudo apt-get install -y cmake ninja-build libicu-dev
            wait
            sudo cp /usr/bin/ninja /usr/bin/ninja.real
            # See top comment
            printf '%s\n' '#!/bin/sh' 'ninja.real -j4 "$@" || ninja.real -j1 "$@"' | sudo tee /usr/bin/ninja
            ln -sf /usr/bin/ninja /opt/android/sdk/cmake/3.10.2.4988404/bin/ninja
      - run:
          name: Build Hermes Compiler
          command: |
            cd "$HERMES_WS_DIR"
            hermes/utils/build/configure.py ./build
            # Build the Hermes compiler so that the cross compiler build can
            # access it to build the VM
            cmake --build ./build --target hermesc
      - run:
          name: Build Hermes for Android
          command: |
            export ANDROID_SDK="$ANDROID_HOME"
            export ANDROID_NDK="$ANDROID_HOME/ndk-bundle"
            cd "$HERMES_WS_DIR/hermes/android" && ./gradlew githubRelease
      - run:
          name: Copy artifacts
          command: |
            cd "$HERMES_WS_DIR"
            cp "build_android/distributions"/hermes-runtime-android-*.tar.gz "output"
      - run:
          name: Checksum artifacts
          command: |
            cd "$HERMES_WS_DIR/output"
            for file in *
            do
              sha256sum "$file" > "$file.sha256"
            done
      - store_artifacts:
          path: /tmp/hermes/output/
      - persist_to_workspace:
          root: /tmp/hermes/output/
          paths:
            - .

  linux:
    docker:
      - image: debian:stretch
    environment:
      - HERMES_WS_DIR: /tmp/hermes
      - TERM: dumb
      - DEBIAN_FRONTEND: noninteractive
    steps:
      - run:
          name: Install dependencies
          command: |
            apt-get update
            apt-get install -y \
                sudo git openssh-client cmake ninja-build python \
                build-essential libreadline-dev libicu-dev
      - checkout
      - run:
          name: Set up workspace
          command: |
            mkdir -p "$HERMES_WS_DIR" "$HERMES_WS_DIR/output"
            ln -sf "$PWD" "$HERMES_WS_DIR/hermes"
            sudo cp /usr/bin/ninja /usr/bin/ninja.real
            # See top comment
            printf '%s\n' '#!/bin/sh' 'ninja.real -j4 "$@" || ninja.real -j1 "$@"' | sudo tee /usr/bin/ninja
      - run:
          name: Build Hermes for Linux
          command: |
            cd "$HERMES_WS_DIR"
            hermes/utils/build/configure.py --static-link --distribute --cmake-flags="-DCMAKE_CXX_FLAGS=-s"
            cd build_release
            ninja github-cli-release
      - run:
          name: Copy artifacts
          command: |
            cd "$HERMES_WS_DIR"
            cp "build_release/github"/hermes-cli-*.tar.gz "output"
      - run:
          name: Checksum artifacts
          command: |
            cd "$HERMES_WS_DIR/output"
            for file in *
            do
              sha256sum "$file" > "$file.sha256"
            done
      - store_artifacts:
          path: /tmp/hermes/output/
      - persist_to_workspace:
          root: /tmp/hermes/output/
          paths:
            - .

  test-linux:
    # execution-time-limit.js and sampling-profiler.js segfault in statically
    # linked release mode, so this job is just a duplicate of the Linux job
    # that builds in dynamically linked debug mode
    docker:
      - image: debian:stretch
    environment:
      - HERMES_WS_DIR: /tmp/hermes
      - TERM: dumb
      - DEBIAN_FRONTEND: noninteractive
    steps:
      - run:
          name: Install dependencies
          command: |
            apt-get update
            apt-get install -y \
                sudo git openssh-client cmake ninja-build python \
                build-essential libreadline-dev libicu-dev zip python3
      - checkout
      - run:
          name: Set up workspace
          command: |
            mkdir -p "$HERMES_WS_DIR"
            ln -sf "$PWD" "$HERMES_WS_DIR/hermes"
            sudo cp /usr/bin/ninja /usr/bin/ninja.real
            # See top comment
            printf '%s\n' '#!/bin/sh' 'ninja.real -j4 "$@" || ninja.real -j1 "$@"' | sudo tee /usr/bin/ninja
      - run:
          name: Run Hermes regression tests
          command: |
            cd "$HERMES_WS_DIR"
            hermes/utils/build/configure.py
            cd build
            ninja
            ninja check-hermes

  test-apple-runtime:
    <<: *apple_defaults
    steps:
      - checkout
      - restore_cache:
          key: v4-repo-{{ .Environment.CIRCLE_SHA1 }}
      - run:
          name: Install dependencies
          command: |
            brew install cmake ninja
      - run:
          name: Build the test application
          command: |
            pod install
          working_directory: test/ApplePlatformsIntegrationTestApp
      - run:
          name: Test MacOS application
          command: |
            xcodebuild test \
              -workspace ApplePlatformsIntegrationTests.xcworkspace \
              -configuration Debug \
              -destination 'platform=macOS' \
              -scheme ApplePlatformsIntegrationMacTests
          working_directory: test/ApplePlatformsIntegrationTestApp
      - run:
          name: Test iPhone application
          command: |
            xcodebuild test \
              -workspace ApplePlatformsIntegrationTests.xcworkspace \
              -configuration Debug \
              -destination 'platform=iOS Simulator,name=iPhone 11' \
              -scheme ApplePlatformsIntegrationMobileTests
          working_directory: test/ApplePlatformsIntegrationTestApp

  build-apple-runtime:
    <<: *apple_defaults
    steps:
      - checkout
      # TODO: Use a better cache key to avoid rebuilding whole framework
      # when it is not necessary
      - restore_cache:
          key: v4-repo-{{ .Environment.CIRCLE_SHA1 }}
      - run:
          name: Set up workspace
          command: mkdir -p /tmp/hermes/output
      - run:
          name: Install dependencies
          command: |
            brew install cmake ninja
            sudo gem install cocoapods
      - run:
          name: Build the iOS frameworks
          command: ./utils/build-ios-framework.sh
      - run:
          name: Build the Mac frameworks
          command: ./utils/build-mac-framework.sh
      - save_cache:
          key: v4-repo-{{ .Environment.CIRCLE_SHA1 }}
          paths:
            - ~/hermes/build_iphoneos
            - ~/hermes/build_catalyst
            - ~/hermes/build_iphonesimulator
            - ~/hermes/build_macosx
            - ~/hermes/destroot

  package-apple-runtime:
    <<: *apple_defaults
    steps:
      - checkout
      - restore_cache:
          key: v4-repo-{{ .Environment.CIRCLE_SHA1 }}
      - run:
          name: Set up workspace
          command: mkdir -p /tmp/hermes/output
      - run:
          name: Install dependencies
          command: |
            brew install cmake ninja
            sudo gem install cocoapods
      - run:
          name: Package the framework
          command: |
            . ./utils/build-apple-framework.sh

            mkdir -p /tmp/cocoapods-package-root/destroot
            cp -R ./destroot /tmp/cocoapods-package-root
            cp hermes-engine.podspec LICENSE /tmp/cocoapods-package-root

            tar -C /tmp/cocoapods-package-root/ -czvf /tmp/hermes/output/hermes-runtime-darwin-v$(get_release_version).tar.gz .
      - run:
          name: Package the CLI
          command: |
            . ./utils/build-apple-framework.sh

            mkdir -p /tmp/hermes-cli-root
            cp -R ./destroot/bin/* /tmp/hermes-cli-root

            tar -C /tmp/hermes-cli-root/ -czvf /tmp/hermes/output/hermes-cli-darwin-v$(get_release_version).tar.gz .
      - run:
          name: Checksum artifacts
          command: |
            cd /tmp/hermes/output
            for file in *
            do
              shasum -a 256 "$file" > "$file.sha256"
            done
      - store_artifacts:
          path: /tmp/hermes/output/
      - persist_to_workspace:
          root: /tmp/hermes/output/
          paths:
            - .

  test-macos:
    # CheckedMalloc.Death fails in release mode, so build a debug version
    # TODO: Switch to `release` and reuse `build_macosx` from previous job
    <<: *apple_defaults
    steps:
      - checkout
      - run:
          name: Install dependencies
          command: |
            brew install cmake ninja
      - run:
          name: Set up workspace
          command: |
            mkdir -p "$HERMES_WS_DIR"
            ln -sf "$PWD" "$HERMES_WS_DIR/hermes"
      - run:
          name: Run MacOS regression tests in debug mode
          command: |
            cd "$HERMES_WS_DIR"
            hermes/utils/build/configure.py
            cmake --build ./build
            cmake --build ./build --target check-hermes

  windows:
    executor:
      name: win/default
      shell: powershell.exe
    environment:
      - HERMES_WS_DIR: 'C:\tmp\hermes'
      - ICU_URL: "https://github.com/unicode-org/icu/releases/download/release-64-2/icu4c-64_2-Win64-MSVC2017.zip"
      - MSBUILD_DIR: 'C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin'
      - CMAKE_DIR: 'C:\Program Files\CMake\bin'
    steps:
      - checkout

      - run:
          name: Set up workspace
          command: |
            New-Item -ItemType Directory $Env:HERMES_WS_DIR
            New-Item -ItemType Directory $Env:HERMES_WS_DIR\icu
            New-Item -ItemType Directory $Env:HERMES_WS_DIR\output
            New-Item -ItemType Directory $Env:HERMES_WS_DIR\deps
            New-Item -ItemType SymbolicLink -Target . -Path $Env:HERMES_WS_DIR -Name hermes

      - run:
          name: Download ICU
          command: |
            cd $Env:HERMES_WS_DIR\icu
            # If Invoke-WebRequest shows a progress bar, it will fail with
            #   Win32 internal error "Access is denied" 0x5 occurred [...]
            $progressPreference = 'silentlyContinue'
            Invoke-WebRequest -Uri "$Env:ICU_URL" -OutFile "icu.zip"
            Expand-Archive -Path "icu.zip" -DestinationPath "."

      - run:
          name: Install dependencies
          command: |
            choco install --no-progress cmake --version 3.14.7
            if (-not $?) { throw "Failed to install CMake" }
            choco install --no-progress python3
            if (-not $?) { throw "Failed to install Python" }

      - run:
          name: Assemble Windows runtime dependencies
          command: |
            cd $Env:HERMES_WS_DIR
            Copy-Item -Path "icu\bin64\icu*.dll" -Destination "deps"
            # Include MSVC++ 2015 redistributables
            Copy-Item -Path "c:\windows\system32\msvcp140.dll" -Destination "deps"
            Copy-Item -Path "c:\windows\system32\vcruntime140.dll" -Destination "deps"
            Copy-Item -Path "c:\windows\system32\vcruntime140_1.dll" -Destination "deps"

      - run:
          name: Build Hermes for Windows
          command: |
            $Env:PATH += ";$Env:CMAKE_DIR;$Env:MSBUILD_DIR"
            $Env:ICU_ROOT = "$Env:HERMES_WS_DIR\icu"
            cd $Env:HERMES_WS_DIR
            hermes\utils\build\configure.py --build-system='Visual Studio 16 2019' --cmake-flags="-DHERMES_ENABLE_WIN10_ICU_FALLBACK=OFF -DHERMES_GITHUB_RESOURCE_DIR=$Env:HERMES_WS_DIR\deps" --distribute
            if (-not $?) { throw "Failed to configure Hermes" }
            cd build_release
            cmake --build . --target github-cli-release --config Release
            if (-not $?) { throw "Failed to build Hermes" }

      - run:
          name: Copy artifacts
          command: |
            cd $Env:HERMES_WS_DIR
            Copy-Item -Path "build_release\github\hermes-cli-*.tar.gz" -Destination "output"

      - run:
          name: Checksum artifacts
          command: |
            cd $Env:HERMES_WS_DIR\output
            foreach($file in Get-ChildItem) {
              $hash = Get-FileHash -Path $file -Algorithm SHA256
              Write-Output ($hash.Hash + "  " + $file.Name) |
                  Out-File -Encoding ASCII -FilePath ($file.Name +".sha256")
            }

      - store_artifacts:
          path: c:\tmp\hermes\output

      - persist_to_workspace:
          root: c:\tmp\hermes\output
          paths:
            - .

  npm:
    docker:
      - image: cimg/node:lts
    environment:
      - YARN: yarnpkg
      - TERM: dumb
      - DEBIAN_FRONTEND: noninteractive
    steps:
      - run:
          name: Print versions
          command: |
            node --version
            yarn --version
      - run:
          name: Install certificates required to attach workspace
          command: |
            sudo apt-get update
            sudo apt-get install -y ca-certificates

      - attach_workspace:
          at: /tmp/hermes/input

      - run:
          name: Install dependencies and set up
          command: |
            mkdir -p /tmp/hermes/output

      - checkout

      - run:
          name: Build NPM
          command: |
            cd npm
            cp /tmp/hermes/input/* .
            $YARN install
            $YARN unpack-builds
            $YARN create-npms

      - run:
          name: Copy artifacts
          command: |
            cd npm
            cp *.tgz /tmp/hermes/output
            # Also copy the other packages for the sole purpose of not having
            # to visit multiple jobs pages to download all release artifacts
            cp /tmp/hermes/input/*.tar.gz /tmp/hermes/output

      - run:
          name: Checksum artifacts
          command: |
            cd /tmp/hermes/output
            for file in *
            do
              sha256sum "$file" > "$file.sha256"
            done

      - store_artifacts:
          path: /tmp/hermes/output

      - persist_to_workspace:
          root: /tmp/hermes/output
          paths:
            - .

  # test to build with emscripten, not run
  test-emscripten:
    docker:
      # emcc requires Python 3.7+
      - image: debian:buster
    environment:
      - HERMES_WS_DIR: /tmp/hermes
      - EMSDK: /tmp/emsdk
      - TERM: dumb
      - DEBIAN_FRONTEND: noninteractive
    steps:
      - run:
          name: Install dependencies
          command: |
            apt-get update
            apt-get install -y \
                sudo git openssh-client cmake ninja-build python \
                build-essential libreadline-dev libicu-dev zip python3 \
                curl
      - run:
          name: Setup Emscripten
          command: |
            set -x
            EMSDK_VERSION=2.0.9
            curl -sfLO "https://github.com/emscripten-core/emsdk/archive/$EMSDK_VERSION.tar.gz"
            tar -xf "$EMSDK_VERSION.tar.gz"
            mv "emsdk-$EMSDK_VERSION" "$EMSDK"
            rm "$EMSDK_VERSION.tar.gz"
            "$EMSDK/emsdk" install latest
            "$EMSDK/emsdk" activate latest
      - checkout
      - run:
          name: Set up workspace
          command: |
            mkdir -p "$HERMES_WS_DIR"
            ln -sf "$PWD" "$HERMES_WS_DIR/hermes"
            sudo cp /usr/bin/ninja /usr/bin/ninja.real
            # See top comment
            printf '%s\n' '#!/bin/sh' 'ninja.real -j4 "$@" || ninja.real -j1 "$@"' | sudo tee /usr/bin/ninja
      - run:
          name: Build Hermes Compiler
          command: |
            cd "$HERMES_WS_DIR"
            hermes/utils/build/configure.py ./build_host_hermesc
            # Build the Hermes compiler so that the cross compiler build can
            # access it to build the VM
            cmake --build ./build_host_hermesc --target hermesc
      - run:
          name: Build Hermes with Emscripten
          command: |
            set -x
            cd "$HERMES_WS_DIR"
            source "$EMSDK/emsdk_env.sh"
            "$EMSDK"/upstream/emscripten/emcc --version

            cmake ./hermes \
                -Bembuild \
                -GNinja \
                -DCMAKE_BUILD_TYPE=Release  \
                -DCMAKE_EXE_LINKER_FLAGS="-s NODERAWFS=1 -s WASM=1 -s ALLOW_MEMORY_GROWTH=1 -s LLD_REPORT_UNDEFINED=1" \
                -DCMAKE_TOOLCHAIN_FILE="$EMSDK/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake" \
                -DIMPORT_HERMESC="$PWD/build_host_hermesc/ImportHermesc.cmake"
            cmake --build ./embuild --target hermes
            cmake --build ./embuild --target hermesc
            cmake --build ./embuild --target emhermesc
            EMHERMESC="$PWD/embuild/bin/emhermesc.js" node ./hermes/tools/emhermesc/test.js
  test-e2e:
    executor:
      name: android/android-machine
    working_directory: /home/circleci
    steps:
      - attach_workspace:
          at: /tmp/input
      - node/install:
          install-yarn: true
          lts: true
      - run:
          name: Prepare RNTester
          command: |
            git clone https://github.com/facebook/react-native
            cd react-native
            yarn install
            npm install /tmp/input/hermes-engine-v*.tgz
            echo "console.log('Using Hermes: ' + (global.HermesInternal != null));" >> packages/rn-tester/js/RNTesterApp.android.js
      - android/start-emulator-and-run-tests:
          post-emulator-launch-assemble-command: ''
          run-tests-working-directory: react-native
          run-logcat: true
          test-command: >-
            ./gradlew -PreactNativeArchitectures=x86 :packages:rn-tester:android:app:installHermesRelease
            && adb shell am start com.facebook.react.uiapp/.RNTesterActivity
            && timeout 30s adb logcat -e "Using Hermes: true" -m 1

  test-e2e-intl:
    executor:
      name: android/android-machine
    working_directory: /home/circleci
    environment:
      HERMES_WS_DIR: /home/circleci
    steps:
      - checkout:
          path: hermes
      - run:
          name: Setup dependencies
          command: |
            (yes | sdkmanager "cmake;3.10.2.4988404" --verbose) || true
            # Check out test262 at a pinned revision to reduce flakiness
            git clone https://github.com/tc39/test262
            cd test262
            git checkout 19da3ca0757248f7595ee09d532bb83dd438f2b5
      - run:
          name: Build Hermes Compiler
          command: |
            hermes/utils/build/configure.py --build-system="Unix Makefiles" --build-type=MinSizeRel ./build
            cmake --build ./build -j 4 --target hermesc
      - android/start-emulator-and-run-tests:
          post-emulator-launch-assemble-command: ''
          run-tests-working-directory: hermes/android
          run-logcat: true
          additional-emulator-args: -timezone Europe/Paris
          test-command: ./gradlew :intltest:prepareTests && ./gradlew -Pabis=x86 :intltest:connectedAndroidTest