build.yml

name: CI

on:
  pull_request:
  merge_group:
  push:

  # At 17 minutes past the hour every hour we do a run to prime the cache.
  # If nothing has changed, the commit SHA will cause a cache-probe hit and
  # this run will conclude the cache is already primed and exit quickly.
  schedule:
    - cron: '17 * * * *'

jobs:

  complete:
    if: always()
    needs: [fmt, cackle, cargo-deny, rust-check-git-rev-deps, build]
    runs-on: ubuntu-latest
    steps:
    - if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
      run: exit 1

  fmt:
    if: github.event_name != 'schedule'
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - run: rustup component add rustfmt
    - run: rustup update
    - run: cargo fmt --all --check

  cackle:
    if: github.event_name != 'schedule'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: cackle-rs/cackle-action@997327f77e59d9cda7b0b6217f0fbdbd3f3ca904
      - run: cargo acl -n test

  cargo-deny:
    if: github.event_name != 'schedule'
    runs-on: ubuntu-latest
    strategy:
      matrix:
        checks:
          - advisories
          - bans licenses sources
    # Prevent sudden announcement of a new advisory from failing ci:
    continue-on-error: ${{ matrix.checks == 'advisories' }}
    steps:
    - uses: actions/checkout@v3
    - uses: EmbarkStudios/cargo-deny-action@1e59595bed8fc55c969333d08d7817b36888f0c5
      with:
        command: check ${{ matrix.checks }}
        # leave arguments empty so we don't test --all-features
        # which will see conflicting env versions
        arguments:

  rust-check-git-rev-deps:
    if: github.event_name != 'schedule'
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: stellar/actions/rust-check-git-rev-deps@main

  build:
    runs-on: ubuntu-latest
    env:
      CACHED_PATHS: |
        ~/.ccache
        ~/.cargo/registry/index/
        ~/.cargo/registry/cache/
        ~/.cargo/git/db/
        ~/.cargo/target/
        src/rust/target/
    strategy:
      fail-fast: false
      matrix:
        toolchain: [ "gcc", "clang"]
        protocol: ["current", "next"]
        scenario: ["", "--check-test-tx-meta"]
    steps:
      - name: Fix kernel mmap rnd bits
        # Asan in llvm provided in ubuntu 22.04 is incompatible with
        # high-entropy ASLR in much newer kernels that GitHub runners are
        # using leading to random crashes: https://reviews.llvm.org/D148280
        run: sudo sysctl vm.mmap_rnd_bits=28

      # We start with as cheap as possible a cache probe to see if we have an exact hit on this
      # git commit ID (for a given OS/toolchain/protocol). If so we can skip all subsequent
      # steps: we already tested this exact SHA.
      #
      # Unfortunately due to the way github actions control flow works, we have to repeat the
      # step 'if' condition in each step, and cannot actually "exit early" and skip the job.
      # There are a lot of duplicate bug reports filed on this aspect of github actions, don't
      # bother filing another.
      - name: Probe Cache
        id: cache
        uses: actions/cache/restore@v3.3.1
        with:
          path: ${{ env.CACHED_PATHS }}
          key: ${{ runner.os }}-${{ matrix.toolchain }}-${{ matrix.protocol }}-${{ github.sha }}
          lookup-only: true

      # When we have a cache miss on the exact commit SHA, we restore from the prefix without it.
      # This will restore the most-recently-written cache (github does this date ordering itself).
      - name: Restore Cache
        if: steps.cache.outputs.cache-hit != 'true'
        uses: actions/cache/restore@v3.3.1
        with:
          path: ${{ env.CACHED_PATHS }}
          key: ${{ steps.cache.outputs.cache-primary-key }}
          restore-keys: |
            ${{ runner.os }}-${{ matrix.toolchain }}-${{ matrix.protocol }}

      - uses: actions/checkout@v3.5.2
        if: steps.cache.outputs.cache-hit != 'true'
        with:
           fetch-depth: 200
           submodules: true
      - name: install core packages
        if: steps.cache.outputs.cache-hit != 'true'
        run: |
          sudo apt-get update
          sudo apt-get -y install --no-install-recommends apt-utils dialog git iproute2 procps lsb-release
      - name: install tool chain
        if: steps.cache.outputs.cache-hit != 'true'
        run: |
          sudo apt-get -y install libstdc++-10-dev clang-format-12 ccache lldb
          if test "${{ matrix.toolchain }}" = "gcc" ; then
            sudo apt-get -y install cpp-10 gcc-10 g++-10
          else
            sudo apt-get -y install clang-12 llvm-12
          fi
      - name: install rustup components
        if: steps.cache.outputs.cache-hit != 'true'
        run: rustup component add rustfmt
      - name: install cargo-cache
        if: steps.cache.outputs.cache-hit != 'true'
        run: cargo install --locked cargo-cache --version 0.8.3
      - name: install cargo-sweep
        if: steps.cache.outputs.cache-hit != 'true'
        run: cargo install --locked cargo-sweep --version 0.7.0
      - name: install dependencies
        if: steps.cache.outputs.cache-hit != 'true'
        run: sudo apt-get -y install postgresql git build-essential pkg-config autoconf automake libtool bison flex libpq-dev parallel libunwind-dev sed perl
      - name: Build
        if: steps.cache.outputs.cache-hit != 'true'
        run: |
          if test "${{ matrix.toolchain }}" = "gcc" ; then
            export CC='gcc'
            export CXX='g++'
          else
            export CC='clang'
            export CXX='clang++'
          fi
          echo Build with $CC and $CXX
          ./ci-build.sh --use-temp-db --protocol ${{ matrix.protocol }} ${{ matrix.scenario }}

      # We only _save_ to the cache when we had a cache miss and are running on schedule, which
      # only happens on the default master branch. No other caches get saved.
      - uses: actions/cache/save@v3.3.1
        if: ${{ steps.cache.outputs.cache-hit != 'true' && github.event_name == 'schedule' }}
        with:
          path: ${{ env.CACHED_PATHS }}
          key: ${{ steps.cache.outputs.cache-primary-key }}