cargo-llvm-cov.yml

name: Code Coverage
on:
  # schedule:
  #   - cron: '0 9 * * *' # UTC timing is every day at 1am PST
  workflow_dispatch:

env:
  CARGO_TERM_COLOR: always
  # Disable incremental compilation.
  #
  # Incremental compilation is useful as part of an edit-build-test-edit cycle,
  # as it lets the compiler avoid recompiling code that hasn't changed. However,
  # on CI, we're not making small edits; we're almost always building the entire
  # project from scratch. Thus, incremental compilation on CI actually
  # introduces *additional* overhead to support making future builds
  # faster...but no future builds will ever occur in any given CI environment.
  #
  # See https://matklad.github.io/2021/09/04/fast-rust-builds.html#ci-workflow
  # for details.
  CARGO_INCREMENTAL: 0
  # Allow more retries for network requests in cargo (downloading crates) and
  # rustup (installing toolchains). This should help to reduce flaky CI failures
  # from transient network timeouts or other issues.
  CARGO_NET_RETRY: 10
  RUSTUP_MAX_RETRIES: 10
  # Don't emit giant backtraces in the CI logs.
  RUST_BACKTRACE: short
  # RUSTFLAGS: -D warnings
  RUSTDOCFLAGS: -D warnings

jobs:
  cargo-llvm-cov:
    name: Generate code coverage
    runs-on: [ubuntu-ghcloud]
    timeout-minutes: 120
    env:
      CARGO_TERM_COLOR: always
    steps:
      - uses: actions/checkout@v4
      - uses: bmwill/rust-cache@v1

      - name: Install cargo-llvm-cov
        uses: taiki-e/install-action@cargo-llvm-cov
    
      - name: Install nextest
        uses: taiki-e/install-action@nextest

      - name: Set Swap Space
        uses: pierotofy/set-swap-space@master
        with:
          swap-size-gb: 256

      - name: Install Rust
        run: rustup update stable
        
      # - name: Run code coverage for nextest
      #   run: SUI_SKIP_SIMTESTS=1 cargo llvm-cov --ignore-run-fail --lcov --output-path lcov.info nextest

      # - name: Upload report to Codecov for nextest
      #   uses: codecov/codecov-action@v3
      #   with:
      #     files: lcov.info
      #     fail_ci_if_error: true

      - name: Run code coverage for simtest
        run: |
          ./scripts/simtest/install.sh
          CODECOV=1 ./scripts/simtest/cargo-simtest simtest

      - name: Upload report to Codecov for simtest
        uses: codecov/codecov-action@v3
        with:
          files: lcov.info
          fail_ci_if_error: true

  notify:
    name: Notify
    needs: [cargo-llvm-cov]
    runs-on: ubuntu-latest
    if: always() # always notify

    steps:
    - uses: technote-space/workflow-conclusion-action@v3

    - name: Checkout sui repo main branch
      uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b # pin@v3
    
    - name: Get sui commit
      env:
        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: |
        export sui_sha=$(git rev-parse HEAD)
        echo "sui_sha=${sui_sha}" >> $GITHUB_ENV

    - name: Get link to logs
      env:
        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: |
        gh_job_link=$(gh api -X GET 'repos/MystenLabs/sui/actions/runs/${{ github.run_id }}/jobs' --jq '.jobs.[0].html_url')
        echo "gh_job_link=${gh_job_link}" >> $GITHUB_ENV        

    - name: Post to slack
      uses: slackapi/slack-github-action@v1.24.0 # pin@v1.21.0
      env:
        SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
        SUI_SHA: ${{ env.sui_sha }}
        GH_JOB_LINK: ${{ env.gh_job_link }}
      with:
        channel-id: 'code-coverage'
        payload: |
          {
            "text": "*${{ github.workflow }}* workflow status: `${{ env.WORKFLOW_CONCLUSION }}`",
            "blocks": [
              {
                "type": "section",
                "text": {
                  "type": "mrkdwn",
                  "text": "*${{ github.workflow }}* workflow status: `${{ env.WORKFLOW_CONCLUSION }}`"
                }
              },
              {
                "type": "divider"
              },
              {
                "type": "section",
                "text": {
                  "type": "mrkdwn",
                  "text": "Sui commit: <https://github.com/MystenLabs/sui/commit/${{ env.SUI_SHA }}|${{ env.SUI_SHA }}> \nRun: <${{ env.GH_JOB_LINK }}|${{ github.run_id }}>"
                }
              },
              {
                "type": "divider"
              },
              {
                "type": "section",
                "text": {
                  "type": "mrkdwn",
                  "text": "@sui-core, Please look over the code coverage <https://app.codecov.io/github/MystenLabs/sui/tree/main|report> for the main branch"
                }
              }
            ]
          }