ci_levm.yaml

name: LEVM

on:
  push:
    branches: ["main"]
  pull_request:
    branches: ["**"]
    paths:
      - "crates/vm/levm/**"

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always
  RUST_VERSION: 1.81.0

jobs:
  ef-test:
    if: ${{ github.event_name != 'merge_group' }}
    name: EF Tests Check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Rustup toolchain install
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ env.RUST_VERSION }}

      - name: Caching
        uses: Swatinem/rust-cache@v2

      - name: Download EF Tests
        run: |
          cd crates/vm/levm
          make download-evm-ef-tests

      - name: Run tests
        run: |
          cd crates/vm/levm
          make run-evm-ef-tests-ci | tee test_result.txt

      - name: Show test summary -- full
        run: |
          cd crates/vm/levm && awk '/Summary: /,0' test_result.txt

      - name: Show test summary -- short
        run: |
          cd crates/vm/levm && awk '/Summary: /,/Frontier/' test_result.txt;

      - name: Check EF-TESTS status is 100%
        run: |
          cd crates/vm/levm
          if [ "$(awk '/Summary:/ {print $(NF)}' test_result.txt)" != "(100.00%)" ]; then
              echo "Percentage is not 100%."
              exit 1
          fi

  hive-report-creation:
    uses: ./.github/workflows/common_hive_reports.yaml
    with:
      evm: levm
      job_type: trigger

  # Check we don't have a regression against main
  hive-test:
    if: ${{ github.event_name != 'merge_group' }}
    name: Hive Tests Check
    needs: hive-report-creation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Download results (pr)
        uses: actions/download-artifact@v4
        with:
          name: results_levm_trigger.md

      - name: Rename result (1)
        run: cp results.md results_levm.md

      - name: Download results (main)
        uses: actions/download-artifact@v4
        with:
          name: results_levm_daily.md
        # If we don't have the file it will use the result(1) file
        continue-on-error: true

      - name: Rename result (2)
        run: cp results.md results_levm_daily.md

      - name: Create diff message
        run: |
          bash .github/scripts/hive_levm_revm_diff.sh results_levm_daily.md results_levm.md >> diff.md
          cat diff.md >> $GITHUB_STEP_SUMMARY

      - name: Check Regression
        run: |
          if grep -q "No differences found" diff.md; then
            echo "No regression found."
          elif ! grep -q "regression" diff.md; then
            echo "No regression found."
          else
            echo "Differences found."
            exit 1
          fi

  # The purpose of this job is to add it as a required check in GitHub so that we don't have to add every individual job as a required check
  all-tests:
    # "Integration Test" is a required check, don't change the name
    name: Integration Test
    runs-on: ubuntu-latest
    needs: [hive-test, ef-test]
    # Make sure this job runs even if the previous jobs failed or were skipped
    if: ${{ always() && needs.hive-test.result != 'skipped' && needs.ef-test.result != 'skipped' }}
    steps:
      - name: Check if any job failed
        run: |
          if [ "${{ needs.hive-test.result }}" != "success" ]; then
            echo "Job Hive Tests Check failed"
            exit 1
          fi

          if [ "${{ needs.ef-test.result }}" != "success" ]; then
            echo "Job EF Tests Check failed"
            exit 1
          fi

  test:
    # "Test" is a required check, don't change the name
    name: Test
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Rustup toolchain install
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ env.RUST_VERSION }}

      - name: Caching
        uses: Swatinem/rust-cache@v2

      - name: Run tests
        run: |
          cd crates/vm/levm
          make test
  bench:
    name: Benchmarks (LEVM vs REVM)
    runs-on: ubuntu-latest

    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Rustup toolchain install
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ env.RUST_VERSION }}

      - name: Set up cargo cache
        uses: Swatinem/rust-cache@v2

      - name: Install hyperfine
        uses: taiki-e/install-action@v2
        with:
          tool: hyperfine@1.16

      - name: Install solc
        uses: pontem-network/get-solc@master

      - name: Run benchmarks
        run: |
          cd crates/vm/levm
          make revm-comparison
  lint:
    # "Lint" is a required check, don't change the name
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Rustup toolchain install
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ env.RUST_VERSION }}
          components: rustfmt, clippy

      - name: Add Rust Cache
        uses: Swatinem/rust-cache@v2

      - name: Run cargo check
        run: |
          cd crates/vm/levm
          cargo check

      - name: Run cargo build
        run: |
          cd crates/vm/levm
          cargo build

      - name: Run cargo clippy
        run: |
          cd crates/vm/levm
          cargo clippy --all-targets --all-features -- -D warnings

      - name: Run cargo fmt
        run: |
          cd crates/vm/levm
          cargo fmt --all -- --check