e2e.yml

name: End-to-end Tests
on: pull_request
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true
jobs:
  diff:
    runs-on: ubuntu-latest
    outputs:
      isWallet: ${{ (steps.turbo.outputs.packages && contains(fromJson(steps.turbo.outputs.packages), 'sui-wallet')) }}
      isExplorer: ${{ (steps.turbo.outputs.packages && contains(fromJson(steps.turbo.outputs.packages), 'sui-explorer')) }}
      isTypescriptSDK: ${{ (steps.turbo.outputs.packages && contains(fromJson(steps.turbo.outputs.packages), '@mysten/sui.js')) }}
      isRust: ${{ steps.diff.outputs.isRust }}
    steps:
      - uses: actions/checkout@7dd9e2a3dc350cf687eb1b2a4fadfee8c8e49675 # pin@v3
      - name: Detect Changes (turbo)
        uses: "./.github/actions/turbo-diffs"
        id: turbo
      - name: Detect Changes (diff)
        uses: "./.github/actions/diffs"
        id: diff

  # Run e2e test against localnet built on the main branch
  localnet:
    name: Localnet
    needs: diff
    if: needs.diff.outputs.isExplorer == 'true' || needs.diff.outputs.isTypescriptSDK == 'true' || needs.diff.outputs.isWallet == 'true' || needs.diff.outputs.isRust == 'true'
    runs-on: ubuntu-ghcloud
    steps:
      - uses: actions/checkout@7dd9e2a3dc350cf687eb1b2a4fadfee8c8e49675 # pin@v3
      # Disabled for now as it makes test runs take longer
      # - uses: bmwill/rust-cache@v1 # Fork of 'Swatinem/rust-cache' which allows caching additional paths
      - uses: pnpm/action-setup@v2.4.0
        with:
          version: 8
      - run: cargo build --bin sui-test-validator --bin sui --profile dev
      - name: Install Nodejs
        uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # pin@v3
        with:
          node-version: "18"
          cache: "pnpm"
      - name: Install dependencies
        run: pnpm install --frozen-lockfile
      - name: Install Playwright Browsers
        run: pnpm explorer playwright install --with-deps chromium

      - name: Set env
        run: |
          echo "VITE_SUI_BIN=$PWD/target/debug/sui" >> $GITHUB_ENV
          echo "E2E_RUN_LOCAL_NET_CMD=(RUST_LOG=info RUST_BACKTRACE=1 $(echo $PWD/target/debug/sui-test-validator))" >> $GITHUB_ENV

      - name: Run TS SDK e2e tests
        if: ${{ needs.diff.outputs.isTypescriptSDK == 'true' || needs.diff.outputs.isRust == 'true'}}
        run: pnpm dlx concurrently --kill-others --success command-1 "$E2E_RUN_LOCAL_NET_CMD" 'pnpm sdk test:e2e'

      - name: Run Explorer e2e tests
        # need to run Explorer e2e when its upstream(TS SDK and Rust) or itself is changed
        if: ${{ needs.diff.outputs.isTypescriptSDK == 'true' || needs.diff.outputs.isExplorer == 'true' || needs.diff.outputs.isRust == 'true'}}
        run: pnpm explorer playwright test
      - uses: actions/upload-artifact@v3
        if: always()
        with:
          name: playwright-report-explorer
          path: apps/explorer/playwright-report/
          retention-days: 30

      - name: Run Local net
        run: cargo run --bin sui-test-validator -- --epoch-duration-ms 10000 &
      - name: Set Wallet env
        run: echo "API_ENV=local" > "$PWD/apps/wallet/configs/environment/.env"
      - name: Build Wallet
        # need to run Wallet e2e when its upstream(TS SDK and Rust) or itself is changed
        if: ${{ needs.diff.outputs.isWallet == 'true' || needs.diff.outputs.isRust == 'true' || needs.diff.outputs.isTypescriptSDK == 'true'}}
        run: pnpm wallet build:dev
      - name: Run Wallet e2e tests
        if: ${{ needs.diff.outputs.isWallet == 'true' || needs.diff.outputs.isRust == 'true' || needs.diff.outputs.isTypescriptSDK == 'true'}}
        run: xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- pnpm wallet playwright test
      - uses: actions/upload-artifact@v3
        if: always()
        with:
          name: playwright-report-wallet
          path: apps/wallet/playwright-report/
          retention-days: 30

  # Run e2e test against localnet built on the devnet branch for backward compatibility check
  local_devnet_branch:
    name: Local Network Built on devnet branch
    needs: diff
    # TODO: add wallet e2e to the `if` condition when available
    if: needs.diff.outputs.isExplorer == 'true' || needs.diff.outputs.isTypescriptSDK == 'true'
    runs-on: ubuntu-ghcloud
    steps:
      - uses: actions/checkout@7dd9e2a3dc350cf687eb1b2a4fadfee8c8e49675 # pin@v3
      - name: Run E2E Test Runner with devnet branch
        uses: "./.github/actions/ts-e2e"
        with:
          ref: devnet

  # Run e2e test against localnet built on the Testnet branch for backward compatibility check
  local_testnet_branch:
    name: Local Network Built on testnet branch
    needs: diff
    # TODO: add wallet e2e to the `if` condition when available
    if: needs.diff.outputs.isExplorer == 'true' || needs.diff.outputs.isTypescriptSDK == 'true'
    runs-on: ubuntu-ghcloud
    steps:
      - uses: actions/checkout@7dd9e2a3dc350cf687eb1b2a4fadfee8c8e49675 # pin@v3
      - name: Run E2E Test Runner with testnet branch
        uses: "./.github/actions/ts-e2e"
        with:
          ref: testnet