main.yml

name: CI

on:
  pull_request:
  push:
    branches:
      - main

env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  MIX_ENV: test

jobs:
  lint:
    name: Lint

    runs-on: ubuntu-20.04

    strategy:
      fail-fast: true

    steps:
      - name: Clone the repository
        uses: actions/checkout@v3

      - name: Install OTP and Elixir
        uses: erlef/setup-beam@v1
        with:
          otp-version: "25.3"
          elixir-version: "1.15.4"

      - name: Cache dependencies
        id: cache-deps
        uses: actions/cache@v3
        with:
          path: |
            deps
            _build
          key: |
            ${{ runner.os }}-otp${{ matrix.otp }}-elixir${{ matrix.elixir }}-${{ hashFiles('**/mix.lock') }}
          restore-keys: |
            ${{ runner.os }}-otp${{ matrix.otp }}-elixir${{ matrix.elixir }}-

      - name: Install and compile dependencies
        if: steps.cache-deps.outputs.cache-hit != 'true'
        run: mix do deps.get + deps.compile

      - name: Check formatting
        run: mix format --check-formatted

      - name: Check no unused dependencies
        run: mix deps.unlock --check-unused
        if: ${{ steps.cache-deps.outputs.cache-hit != 'true' }}

      - name: Compile with --warnings-as-errors
        run: mix compile --warnings-as-errors --force

      - name: Cache Dialyzer's PLT
        uses: actions/cache@v3
        id: cache-plt
        with:
          path: priv/plts
          key: |
            ${{ runner.os }}-otp${{ matrix.otp }}-elixir${{ matrix.elixir }}-${{ hashFiles('**/mix.lock') }}
          restore-keys: |
            ${{ runner.os }}-otp${{ matrix.otp }}-elixir${{ matrix.elixir }}-

      # Create PLTs if no cache was found
      - name: Create PLTs
        if: steps.cache-plt.outputs.cache-hit != 'true'
        run: mix dialyzer --plt

      - name: Run Dialyzer
        run: mix dialyzer --format github

  test:
    name: >-
      Test (Elixir ${{ matrix.elixir }},
      OTP ${{ matrix.otp }},
      C* ${{ matrix.server_versions.cassandra }},
      Scylla ${{ matrix.server_versions.scylla }},
      Native protocol ${{ matrix.cassandra_native_protocol }})

    runs-on: ubuntu-20.04

    strategy:
      fail-fast: false

      matrix:
        otp:
          - "25.3"
        elixir:
          - "1.15.4"
        server_versions:
          - cassandra: "4.1"
            scylla: "5.1.6"
          - cassandra: "3"
            scylla: "4.6.3"
        cassandra_native_protocol:
          - "v3"
          - "v4"
        include:
          # Only C* 4.1+ supports native protocol v5.
          - otp: "25.3"
            elixir: "1.15.4"
            test_only_cassandra: true
            cassandra_version: "4.1"
            cassandra_native_protocol: "v4"

          # Oldest supported Elixir/OTP matrix. We support down to Erlang 21, but
          # rustler_precompiled (which we use for nimble_lz4, which we use for testing)
          # requires OTP 23+.
          - otp: "23.3"
            elixir: "1.11"
            test_only_cassandra: true
            cassandra_version: "3"
            cassandra_native_protocol: "v3"

    env:
      CASSANDRA_VERSION: ${{ matrix.server_versions.cassandra }}
      SCYLLA_VERSION: ${{ matrix.server_versions.scylla }}
      CASSANDRA_NATIVE_PROTOCOL: ${{ matrix.cassandra_native_protocol }}
      LOG_LEVEL: debug
      XANDRA_DEBUG: true

    steps:
      - name: Clone the repository
        uses: actions/checkout@v3

      - name: Start Docker and wait for it to be up
        run: |
          docker-compose up --detach --build
          ./test/docker/health-check-services.sh

      - name: Install Python (for ccm)
        uses: actions/setup-python@v4
        with:
          python-version: "3.9.16"

      - name: Install ccm
        run: pip3 install ccm

      - name: Install OpenJDK
        uses: actions/setup-java@v2
        with:
          distribution: "zulu"
          java-version: "11"

      - name: Install OTP and Elixir
        uses: erlef/setup-beam@v1
        with:
          otp-version: ${{ matrix.otp }}
          elixir-version: ${{ matrix.elixir }}

      - name: Cache dependencies
        id: cache-deps
        uses: actions/cache@v3
        with:
          path: |
            deps
            _build
          key: |
            ${{ runner.os }}-mix-otp${{ matrix.otp }}-elixir${{ matrix.elixir }}-${{ hashFiles('**/mix.lock') }}
          restore-keys:
            ${{ runner.os }}-mix-otp${{ matrix.otp }}-elixir${{ matrix.elixir }}-

      - name: Install and compile dependencies
        if: steps.cache-deps.outputs.cache-hit != 'true'
        run: mix do deps.get --only test, deps.compile

      # TODO: eventually figure out why we can't run encryption tests on CI.
      - name: Run tests for Cassandra and Scylla
        if: ${{ !matrix.test_only_cassandra }}
        run: mix test.all --trace --exclude encryption --exclude ccm

      - name: Run tests for Cassandra only
        if: ${{ matrix.test_only_cassandra }}
        run: mix test --trace --exclude encryption --exclude ccm

      - name: Dump Docker logs on failure
        uses: jwalton/gh-docker-logs@v1
        if: failure()