ruby/.github/workflows/zjit-ubuntu.yml

name: ZJIT Ubuntu
on:
  push:
    branches:
      - master
    paths-ignore:
      - 'doc/**'
      - '**/man/*'
      - '**.md'
      - '**.rdoc'
      - '**/.document'
      - '.*.yml'
  pull_request:
    types:
      - opened
      - synchronize
      - reopened
    # Do not use paths-ignore for required status checks
    # https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/troubleshooting-required-status-checks#handling-skipped-but-required-checks
  merge_group:

concurrency:
  group: ${{ github.workflow }} / ${{ startsWith(github.event_name, 'pull') && github.ref_name || github.sha }}
  cancel-in-progress: ${{ startsWith(github.event_name, 'pull') }}

permissions:
  contents: read

jobs:
  make:
    strategy:
      fail-fast: false
      matrix:
        include:
          - test_task: 'zjit-bindgen'
            hint: 'To fix: use patch in logs'
            configure: '--enable-zjit=dev --with-gcc=clang-14'
            libclang_path: '/usr/lib/llvm-14/lib/libclang.so.1'

          - test_task: 'zjit-check'
            configure: '--enable-yjit --enable-zjit=dev'
            rust_version: '1.85.0'

          - test_task: 'zjit-test-all'
            configure: '--enable-zjit=dev'
            testopts: '--seed=18140'

          - test_task: 'btest'
            configure: '--enable-zjit=dev'

    env:
      GITPULLOPTIONS: --no-tags origin ${{ github.ref }}
      RUN_OPTS: ${{ matrix.zjit_opts }}
      YJIT_BENCH_OPTS: ${{ matrix.yjit_bench_opts }}
      SPECOPTS: ${{ matrix.specopts }}
      TESTOPTS: ${{ matrix.testopts }}
      RUBY_DEBUG: ci
      BUNDLE_JOBS: 8 # for yjit-bench
      RUST_BACKTRACE: 1

    runs-on: ubuntu-22.04

    if: >-
      ${{!(false
      || contains(github.event.head_commit.message, '[DOC]')
      || contains(github.event.pull_request.title, '[DOC]')
      || contains(github.event.pull_request.labels.*.name, 'Documentation')
      || (github.event_name == 'push' && github.event.pull_request.user.login == 'dependabot[bot]')
      )}}

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          sparse-checkout-cone-mode: false
          sparse-checkout: /.github

      - uses: ./.github/actions/setup/ubuntu

      - uses: ruby/setup-ruby@a9bfc2ecf3dd40734a9418f89a7e9d484c32b990 # v1.248.0
        with:
          ruby-version: '3.1'
          bundler: none

      - uses: taiki-e/install-action@v2
        with:
          tool: nextest@0.9
        if: ${{ matrix.test_task == 'zjit-check' }}


      - uses: ./.github/actions/setup/directories
        with:
          srcdir: src
          builddir: build
          makeup: true
          dummy-files: ${{ matrix.test_task == 'check' }}
          # Set fetch-depth: 10 so that Launchable can receive commits information.
          fetch-depth: 10

      - name: Install Rust
        if: ${{ matrix.rust_version }}
        run: |
          rustup install ${{ matrix.rust_version }} --profile minimal
          rustup default ${{ matrix.rust_version }}

      - name: Install rustfmt
        if: ${{ matrix.test_task == 'zjit-bindgen' }}
        run: rustup component add rustfmt

      - name: Run configure
        run: ../src/configure -C --disable-install-doc --prefix=$(pwd)/install ${{ matrix.configure }}

      - run: make incs

      - run: make prepare-gems
        if: ${{ matrix.test_task == 'test-bundled-gems' }}

      - run: make

      - name: Verify that --zjit-dump-disasm works
        run: |
          ./miniruby --zjit-call-threshold=1 --zjit-dump-disasm -e0 | \
          wc -l | \
          ruby -ne 'raise "Disassembly seems broken in dev build (output has too few lines)" unless $_.to_i > 10'
        if: ${{ contains(matrix.configure, 'jit=dev') }}

      # Check that the binary was built with ZJIT
      - name: Check ZJIT enabled
        run: ./miniruby --zjit -v | grep "+ZJIT"
        if: ${{ matrix.configure != '--disable-zjit' }}

      - name: btest
        run: |
          RUST_BACKTRACE=1 ruby --disable=gems ../src/bootstraptest/runner.rb --ruby="./miniruby -I../src/lib -I. -I.ext/common --zjit-call-threshold=1" \
          ../src/bootstraptest/test_attr.rb \
          ../src/bootstraptest/test_autoload.rb \
          ../src/bootstraptest/test_block.rb \
          ../src/bootstraptest/test_class.rb \
          ../src/bootstraptest/test_constant_cache.rb \
          ../src/bootstraptest/test_env.rb \
          ../src/bootstraptest/test_env.rb \
          ../src/bootstraptest/test_exception.rb \
          ../src/bootstraptest/test_fiber.rb \
          ../src/bootstraptest/test_finalizer.rb \
          ../src/bootstraptest/test_flip.rb \
          ../src/bootstraptest/test_flow.rb \
          ../src/bootstraptest/test_fork.rb \
          ../src/bootstraptest/test_gc.rb \
          ../src/bootstraptest/test_insns.rb \
          ../src/bootstraptest/test_io.rb \
          ../src/bootstraptest/test_jump.rb \
          ../src/bootstraptest/test_literal.rb \
          ../src/bootstraptest/test_literal_suffix.rb \
          ../src/bootstraptest/test_load.rb \
          ../src/bootstraptest/test_marshal.rb \
          ../src/bootstraptest/test_massign.rb \
          ../src/bootstraptest/test_method.rb \
          ../src/bootstraptest/test_objectspace.rb \
          ../src/bootstraptest/test_proc.rb \
          ../src/bootstraptest/test_ractor.rb \
          ../src/bootstraptest/test_string.rb \
          ../src/bootstraptest/test_struct.rb \
          ../src/bootstraptest/test_syntax.rb \
          ../src/bootstraptest/test_thread.rb \
          ../src/bootstraptest/test_yjit_30k_ifelse.rb \
          ../src/bootstraptest/test_yjit_30k_methods.rb \
          ../src/bootstraptest/test_yjit_rust_port.rb
        # ../src/bootstraptest/test_yjit.rb \
        if: ${{ matrix.test_task == 'btest' }}

      - name: make ${{ matrix.test_task }}
        run: >-
          make -s ${{ matrix.test_task }} ${TESTS:+TESTS="$TESTS"}
          RUN_OPTS="$RUN_OPTS" MSPECOPT=--debug SPECOPTS="$SPECOPTS"
          TESTOPTS="$TESTOPTS"
          ZJIT_BINDGEN_DIFF_OPTS="$ZJIT_BINDGEN_DIFF_OPTS"
        timeout-minutes: 90
        env:
          RUBY_TESTOPTS: '-q --tty=no'
          TEST_BUNDLED_GEMS_ALLOW_FAILURES: ''
          PRECHECK_BUNDLED_GEMS: 'no'
          SYNTAX_SUGGEST_TIMEOUT: '5'
          ZJIT_BINDGEN_DIFF_OPTS: '--exit-code'
          LIBCLANG_PATH: ${{ matrix.libclang_path }}
          TESTS: ${{ matrix.tests }}
        continue-on-error: ${{ matrix.continue-on-test_task || false }}
        if: ${{ matrix.test_task != 'btest' }}

  result:
    if: ${{ always() }}
    name: ${{ github.workflow }} result
    runs-on: ubuntu-22.04
    needs: [make]
    steps:
      - name: ${{ github.workflow }} jobs have failed
        run: exit 1
        working-directory:
        if: ${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') }}

defaults:
  run:
    working-directory: build