kind.yml

name: Kind
on:
  pull_request:
    branches:
    - main
    - release-*
    - feature/*
  push:
    branches:
    - main
    - release-*
    - feature/*

env:
  KIND_VERSION: v0.18.0

jobs:
  check-changes:
    name: Check whether tests need to be run based on diff
    runs-on: [ubuntu-latest]
    steps:
    - uses: actions/checkout@v3
      with:
        fetch-depth: 0
    - uses: antrea-io/has-changes@v2
      id: check_diff
      with:
        paths-ignore: docs/* ci/jenkins/* *.md hack/.notableofcontents plugins/*
    outputs:
      has_changes: ${{ steps.check_diff.outputs.has_changes }}

  build-antrea-coverage-image:
    name: Build Antrea image to be used for Kind e2e tests
    needs: check-changes
    if: ${{ needs.check-changes.outputs.has_changes == 'yes' }}
    runs-on: [ubuntu-latest]
    steps:
    - uses: actions/checkout@v3
    - name: Build Antrea Docker image with code coverage support
      run: |
        ./hack/build-antrea-linux-all.sh --pull --coverage
    - name: Save Antrea image to tarball
      run:  docker save -o antrea-ubuntu.tar antrea/antrea-ubuntu-coverage:latest
    - name: Upload Antrea image for subsequent jobs
      uses: actions/upload-artifact@v3
      with:
        name: antrea-ubuntu-cov
        path: antrea-ubuntu.tar
        retention-days: 1 # minimum value, in case artifact deletion by 'artifact-cleanup' job fails

  build-flow-aggregator-coverage-image:
    name: Build Flow Aggregator image to be used for Kind e2e tests
    needs: check-changes
    if: ${{ needs.check-changes.outputs.has_changes == 'yes' }}
    runs-on: [ ubuntu-latest ]
    steps:
    - uses: actions/checkout@v3
    - run: make flow-aggregator-ubuntu-coverage
    - name: Save Flow Aggregator image to tarball
      run: docker save -o flow-aggregator.tar antrea/flow-aggregator-coverage:latest
    - name: Upload Flow Aggregator image for subsequent jobs
      uses: actions/upload-artifact@v3
      with:
        name: flow-aggregator-cov
        path: flow-aggregator.tar
        retention-days: 1 # minimum value, in case artifact deletion by 'artifact-cleanup' job fails

  test-e2e-encap:
    name: E2e tests on a Kind cluster on Linux
    needs: [build-antrea-coverage-image]
    runs-on: [ubuntu-latest]
    steps:
    - name: Free disk space
      # https://github.com/actions/virtual-environments/issues/709
      run: |
        sudo apt-get clean
        df -h
    - uses: actions/checkout@v3
    - uses: actions/setup-go@v4
      with:
        go-version-file: 'go.mod'
    - name: Download Antrea image from previous job
      uses: actions/download-artifact@v3
      with:
        name: antrea-ubuntu-cov
    - name: Load Antrea image
      run: |
        docker load -i antrea-ubuntu.tar
    - name: Install Kind
      run: |
        curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
        chmod +x ./kind
        sudo mv kind /usr/local/bin
    - name: Run e2e tests
      run: |
        mkdir log
        mkdir test-e2e-encap-coverage
        ANTREA_LOG_DIR=$PWD/log ANTREA_COV_DIR=$PWD/test-e2e-encap-coverage ./ci/kind/test-e2e-kind.sh --encap-mode encap --coverage
    - name: Tar coverage files
      run: tar -czf test-e2e-encap-coverage.tar.gz test-e2e-encap-coverage
    - name: Upload coverage for test-e2e-encap-coverage
      uses: actions/upload-artifact@v3
      with:
        name: test-e2e-encap-coverage
        path: test-e2e-encap-coverage.tar.gz
        retention-days: 30
    - name: Codecov
      uses: codecov/codecov-action@v3
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        file: '*.cov.out*'
        flags: kind-e2e-tests
        name: codecov-test-e2e-encap
        directory: test-e2e-encap-coverage
        fail_ci_if_error: ${{ github.event_name == 'push' }}
    - name: Tar log files
      if: ${{ failure() }}
      run: tar -czf log.tar.gz log
    - name: Upload test log
      uses: actions/upload-artifact@v3
      if: ${{ failure() }}
      with:
        name: e2e-kind-encap.tar.gz
        path: log.tar.gz
        retention-days: 30

  test-e2e-encap-non-default:
    # NodeIPAM=true cannot run with proxyAll enabled due to https://github.com/antrea-io/antrea/issues/5022.
    name: E2e tests on a Kind cluster on Linux with non default values (AntreaProxy=false, NodeIPAM=true)
    needs: [build-antrea-coverage-image]
    runs-on: [ubuntu-latest]
    steps:
    - name: Free disk space
      # https://github.com/actions/virtual-environments/issues/709
      run: |
        sudo apt-get clean
        df -h
    - uses: actions/checkout@v3
    - uses: actions/setup-go@v4
      with:
        go-version-file: 'go.mod'
    - name: Download Antrea image from previous job
      uses: actions/download-artifact@v3
      with:
        name: antrea-ubuntu-cov
    - name: Load Antrea image
      run: |
        docker load -i antrea-ubuntu.tar
    - name: Install Kind
      run: |
        curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
        chmod +x ./kind
        sudo mv kind /usr/local/bin
    - name: Run e2e tests
      run: |
        mkdir log
        mkdir test-e2e-encap-non-default-coverage
        ANTREA_LOG_DIR=$PWD/log ANTREA_COV_DIR=$PWD/test-e2e-encap-non-default-coverage ./ci/kind/test-e2e-kind.sh --encap-mode encap --feature-gates AntreaProxy=false --node-ipam --coverage
    - name: Tar coverage files
      run: tar -czf test-e2e-encap-non-default-coverage.tar.gz test-e2e-encap-non-default-coverage
    - name: Upload coverage for test-e2e-encap-non-default-coverage
      uses: actions/upload-artifact@v3
      with:
        name: test-e2e-encap-non-default-coverage
        path: test-e2e-encap-non-default-coverage.tar.gz
        retention-days: 30
    - name: Codecov
      uses: codecov/codecov-action@v3
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        file: '*.cov.out*'
        flags: kind-e2e-tests
        name: codecov-test-e2e-encap-non-default
        directory: test-e2e-encap-non-default-coverage
        fail_ci_if_error: ${{ github.event_name == 'push' }}
    - name: Tar log files
      if: ${{ failure() }}
      run: tar -czf log.tar.gz log
    - name: Upload test log
      uses: actions/upload-artifact@v3
      if: ${{ failure() }}
      with:
        name: e2e-kind-encap-non-default.tar.gz
        path: log.tar.gz
        retention-days: 30

  test-e2e-encap-all-features-enabled:
    name: E2e tests on a Kind cluster on Linux with all features enabled
    needs: [build-antrea-coverage-image]
    runs-on: [ubuntu-latest]
    steps:
      - name: Free disk space
        # https://github.com/actions/virtual-environments/issues/709
        run: |
          sudo apt-get clean
          df -h
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v4
        with:
          go-version-file: 'go.mod'
      - name: Download Antrea image from previous job
        uses: actions/download-artifact@v3
        with:
          name: antrea-ubuntu-cov
      - name: Load Antrea image
        run: |
          docker load -i antrea-ubuntu.tar
      - name: Install Kind
        run: |
          curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
          chmod +x ./kind
          sudo mv kind /usr/local/bin
      - name: Run e2e tests
        run: |
          mkdir log
          mkdir test-e2e-encap-all-features-enabled-coverage
          # FlowExporter requires the FlowAggregator, so we keep it disabled.
          ANTREA_LOG_DIR=$PWD/log ANTREA_COV_DIR=$PWD/test-e2e-encap-all-features-enabled-coverage ./ci/kind/test-e2e-kind.sh --encap-mode encap --coverage --feature-gates AllAlpha=true,AllBeta=true,FlowExporter=false --proxy-all --multicast
      - name: Tar coverage files
        run: tar -czf test-e2e-encap-all-features-enabled-coverage.tar.gz test-e2e-encap-all-features-enabled-coverage
      - name: Upload coverage for test-e2e-encap-all-features-enabled-coverage
        uses: actions/upload-artifact@v3
        with:
          name: test-e2e-encap-all-features-enabled-coverage
          path: test-e2e-encap-all-features-enabled-coverage.tar.gz
          retention-days: 30
      - name: Codecov
        uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          file: '*.cov.out*'
          flags: kind-e2e-tests
          name: codecov-test-e2e-encap-all-features-enabled
          directory: test-e2e-encap-all-features-enabled-coverage
          fail_ci_if_error: ${{ github.event_name == 'push' }}
      - name: Tar log files
        if: ${{ failure() }}
        run: tar -czf log.tar.gz log
      - name: Upload test log
        uses: actions/upload-artifact@v3
        if: ${{ failure() }}
        with:
          name: e2e-kind-encap-all-features-enabled.tar.gz
          path: log.tar.gz
          retention-days: 30

  test-e2e-noencap:
    name: E2e tests on a Kind cluster on Linux (noEncap)
    needs: [build-antrea-coverage-image]
    runs-on: [ubuntu-latest]
    steps:
    - name: Free disk space
      # https://github.com/actions/virtual-environments/issues/709
      run: |
        sudo apt-get clean
        df -h
    - uses: actions/checkout@v3
    - uses: actions/setup-go@v4
      with:
        go-version-file: 'go.mod'
    - name: Download Antrea image from previous job
      uses: actions/download-artifact@v3
      with:
        name: antrea-ubuntu-cov
    - name: Load Antrea image
      run: |
        docker load -i antrea-ubuntu.tar
    - name: Install Kind
      run: |
        curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
        chmod +x ./kind
        sudo mv kind /usr/local/bin
    - name: Run e2e tests
      run: |
        mkdir log
        mkdir test-e2e-noencap-coverage
        ANTREA_LOG_DIR=$PWD/log ANTREA_COV_DIR=$PWD/test-e2e-noencap-coverage ./ci/kind/test-e2e-kind.sh --encap-mode noEncap --coverage --skip mode-irrelevant
    - name: Tar coverage files
      run: tar -czf test-e2e-noencap-coverage.tar.gz test-e2e-noencap-coverage
    - name: Upload coverage for test-e2e-noencap-coverage
      uses: actions/upload-artifact@v3
      with:
        name: test-e2e-noencap-coverage
        path: test-e2e-noencap-coverage.tar.gz
        retention-days: 30
    - name: Codecov
      uses: codecov/codecov-action@v3
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        file: '*.cov.out*'
        flags: kind-e2e-tests
        name: codecov-test-e2e-noencap
        directory: test-e2e-noencap-coverage
        fail_ci_if_error: ${{ github.event_name == 'push' }}
    - name: Tar log files
      if: ${{ failure() }}
      run: tar -czf log.tar.gz log
    - name: Upload test log
      uses: actions/upload-artifact@v3
      if: ${{ failure() }}
      with:
        name: e2e-kind-noencap.tar.gz
        path: log.tar.gz
        retention-days: 30

  test-e2e-hybrid:
    name: E2e tests on a Kind cluster on Linux (hybrid)
    needs: [build-antrea-coverage-image]
    runs-on: [ubuntu-latest]
    steps:
    - name: Free disk space
      # https://github.com/actions/virtual-environments/issues/709
      run: |
        sudo apt-get clean
        df -h
    - uses: actions/checkout@v3
    - uses: actions/setup-go@v4
      with:
        go-version-file: 'go.mod'
    - name: Download Antrea image from previous job
      uses: actions/download-artifact@v3
      with:
        name: antrea-ubuntu-cov
    - name: Load Antrea image
      run: |
        docker load -i antrea-ubuntu.tar
    - name: Install Kind
      run: |
        curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
        chmod +x ./kind
        sudo mv kind /usr/local/bin
    - name: Run e2e tests
      run: |
        mkdir log
        mkdir test-e2e-hybrid-coverage
        ANTREA_LOG_DIR=$PWD/log ANTREA_COV_DIR=$PWD/test-e2e-hybrid-coverage ./ci/kind/test-e2e-kind.sh --encap-mode hybrid --coverage --skip mode-irrelevant
    - name: Tar coverage files
      run: tar -czf test-e2e-hybrid-coverage.tar.gz test-e2e-hybrid-coverage
    - name: Upload coverage for test-e2e-hybrid-coverage
      uses: actions/upload-artifact@v3
      with:
        name: test-e2e-hybrid-coverage
        path: test-e2e-hybrid-coverage.tar.gz
        retention-days: 30
    - name: Codecov
      uses: codecov/codecov-action@v3
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
        file: '*.cov.out*'
        flags: kind-e2e-tests
        name: codecov-test-e2e-hybrid
        directory: test-e2e-hybrid-coverage
        fail_ci_if_error: ${{ github.event_name == 'push' }}
    - name: Tar log files
      if: ${{ failure() }}
      run: tar -czf log.tar.gz log
    - name: Upload test log
      uses: actions/upload-artifact@v3
      if: ${{ failure() }}
      with:
        name: e2e-kind-hybrid.tar.gz
        path: log.tar.gz
        retention-days: 30

  test-e2e-flow-visibility:
    name: E2e tests on a Kind cluster on Linux for Flow Visibility
    needs: [build-antrea-coverage-image, build-flow-aggregator-coverage-image]
    runs-on: [ubuntu-latest]
    steps:
      - name: Free disk space
        # https://github.com/actions/virtual-environments/issues/709
        run: |
          sudo apt-get clean
          df -h
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v4
        with:
          go-version-file: 'go.mod'
      - name: Download Antrea image from previous job
        uses: actions/download-artifact@v3
        with:
          name: antrea-ubuntu-cov
      - name: Load Antrea image
        run: |
          docker load -i antrea-ubuntu.tar
      - name: Download Flow Aggregator image from previous job
        uses: actions/download-artifact@v3
        with:
          name: flow-aggregator-cov
      - name: Load Flow Aggregator image
        run: |
          docker load -i flow-aggregator.tar
      - name: Install Kind
        run: |
          curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
          chmod +x ./kind
          sudo mv kind /usr/local/bin
      - name: Run e2e tests
        run: |
          mkdir log
          mkdir test-e2e-fa-coverage
          ANTREA_LOG_DIR=$PWD/log ANTREA_COV_DIR=$PWD/test-e2e-fa-coverage ./ci/kind/test-e2e-kind.sh --encap-mode encap --coverage --flow-visibility
      - name: Tar coverage files
        run: tar -czf test-e2e-fa-coverage.tar.gz test-e2e-fa-coverage
      - name: Upload coverage for test-e2e-fa-coverage
        uses: actions/upload-artifact@v3
        with:
          name: test-e2e-fa-coverage
          path: test-e2e-fa-coverage.tar.gz
          retention-days: 30
      - name: Codecov
        uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          file: '*.cov.out*'
          flags: kind-e2e-tests
          name: codecov-test-e2e-fa
          directory: test-e2e-fa-coverage
          fail_ci_if_error: ${{ github.event_name == 'push' }}
      - name: Tar log files
        if: ${{ failure() }}
        run: tar -czf log.tar.gz log
      - name: Upload test log
        uses: actions/upload-artifact@v3
        if: ${{ failure() }}
        with:
          name: e2e-kind-fa.tar.gz
          path: log.tar.gz
          retention-days: 30

  test-upgrade-from-N-1:
    name: Upgrade from Antrea version N-1
    needs: build-antrea-coverage-image
    runs-on: [ubuntu-latest]
    steps:
      - name: Free disk space
        # https://github.com/actions/virtual-environments/issues/709
        run: |
          sudo apt-get clean
          df -h
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v4
        with:
          go-version-file: 'go.mod'
      - name: Download Antrea image from previous job
        uses: actions/download-artifact@v3
        with:
          name: antrea-ubuntu-cov
      - name: Load Antrea image
        run: |
          docker load -i antrea-ubuntu.tar
          docker tag antrea/antrea-ubuntu-coverage:latest antrea/antrea-ubuntu:latest
      - name: Install Kind
        run: |
          curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
          chmod +x ./kind
          sudo mv kind /usr/local/bin
      - name: Run test
        run: |
          mkdir log
          ANTREA_LOG_DIR=$PWD/log ./ci/kind/test-upgrade-antrea.sh --from-version-n-minus 1
      - name: Tar log files
        if: ${{ failure() }}
        run: tar -czf log.tar.gz log
      - name: Upload test log
        uses: actions/upload-artifact@v3
        if: ${{ failure() }}
        with:
          name: upgrade-from-antrea-version-n-1.tar.gz
          path: log.tar.gz
          retention-days: 30

  test-upgrade-from-N-2:
    name: Upgrade from Antrea version N-2
    needs: build-antrea-coverage-image
    runs-on: [ubuntu-latest]
    steps:
      - name: Free disk space
        # https://github.com/actions/virtual-environments/issues/709
        run: |
          sudo apt-get clean
          df -h
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v4
        with:
          go-version-file: 'go.mod'
      - name: Download Antrea image from previous job
        uses: actions/download-artifact@v3
        with:
          name: antrea-ubuntu-cov
      - name: Load Antrea image
        run: |
          docker load -i antrea-ubuntu.tar
          docker tag antrea/antrea-ubuntu-coverage:latest antrea/antrea-ubuntu:latest
      - name: Install Kind
        run: |
          curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
          chmod +x ./kind
          sudo mv kind /usr/local/bin
      - name: Run test
        run: |
          mkdir log
          ANTREA_LOG_DIR=$PWD/log ./ci/kind/test-upgrade-antrea.sh --from-version-n-minus 2
      - name: Tar log files
        if: ${{ failure() }}
        run: tar -czf log.tar.gz log
      - name: Upload test log
        uses: actions/upload-artifact@v3
        if: ${{ failure() }}
        with:
          name: upgrade-from-antrea-version-n-2.tar.gz
          path: log.tar.gz
          retention-days: 30

  test-compatible-N-1:
    name: API compatible with client version N-1
    needs: build-antrea-coverage-image
    runs-on: [ubuntu-latest]
    steps:
      - name: Free disk space
        # https://github.com/actions/virtual-environments/issues/709
        run: |
          sudo apt-get clean
          df -h
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v4
        with:
          go-version-file: 'go.mod'
      - name: Download Antrea image from previous job
        uses: actions/download-artifact@v3
        with:
          name: antrea-ubuntu-cov
      - name: Load Antrea image
        run: |
          docker load -i antrea-ubuntu.tar
          docker tag antrea/antrea-ubuntu-coverage:latest antrea/antrea-ubuntu:latest
      - name: Install Kind
        run: |
          curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
          chmod +x ./kind
          sudo mv kind /usr/local/bin
      - name: Run test
        run: |
          mkdir log
          ANTREA_LOG_DIR=$PWD/log ./ci/kind/test-upgrade-antrea.sh --from-version-n-minus 1 --controller-only
      - name: Tar log files
        if: ${{ failure() }}
        run: tar -czf log.tar.gz log
      - name: Upload test log
        uses: actions/upload-artifact@v3
        if: ${{ failure() }}
        with:
          name: api-compatible-with-client-version-n-1.tar.gz
          path: log.tar.gz
          retention-days: 30

  test-compatible-N-2:
    name: API compatible with client version N-2
    needs: build-antrea-coverage-image
    runs-on: [ubuntu-latest]
    steps:
      - name: Free disk space
        # https://github.com/actions/virtual-environments/issues/709
        run: |
          sudo apt-get clean
          df -h
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v4
        with:
          go-version-file: 'go.mod'
      - name: Download Antrea image from previous job
        uses: actions/download-artifact@v3
        with:
          name: antrea-ubuntu-cov
      - name: Load Antrea image
        run: |
          docker load -i antrea-ubuntu.tar
          docker tag antrea/antrea-ubuntu-coverage:latest antrea/antrea-ubuntu:latest
      - name: Install Kind
        run: |
          curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
          chmod +x ./kind
          sudo mv kind /usr/local/bin
      - name: Run test
        run: |
          mkdir log
          ANTREA_LOG_DIR=$PWD/log ./ci/kind/test-upgrade-antrea.sh --from-version-n-minus 2 --controller-only
      - name: Tar log files
        if: ${{ failure() }}
        run: tar -czf log.tar.gz log
      - name: Upload test log
        uses: actions/upload-artifact@v3
        if: ${{ failure() }}
        with:
          name: api-compatible-with-client-version-n-2.tar.gz
          path: log.tar.gz
          retention-days: 30

  validate-prometheus-metrics-doc:
    name: Validate metrics in Prometheus document match running deployment's
    needs: build-antrea-coverage-image
    runs-on: [ubuntu-latest]
    steps:
      - name: Free disk space
        # https://github.com/actions/virtual-environments/issues/709
        run: |
          sudo apt-get clean
          df -h
      - uses: actions/checkout@v3
      - name: Download Antrea image from previous job
        uses: actions/download-artifact@v3
        with:
          name: antrea-ubuntu-cov
      - name: Load Antrea image
        run: |
          docker load -i antrea-ubuntu.tar
          docker tag antrea/antrea-ubuntu-coverage:latest antrea/antrea-ubuntu:latest
      - name: Install Kind
        run: |
          curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-$(uname)-amd64
          chmod +x ./kind
          sudo mv kind /usr/local/bin
      - name: Validate document
        run: |
          ./ci/kind/validate-metrics-doc.sh

  # Runs after all other jobs in the workflow succeed and deletes Antrea Docker images uploaded as temporary
  # artifacts. It uses a third-party, MIT-licensed action (geekyeggo/delete-artifact). While Github
  # exposes an API for deleting artifacts, they do not support an official delete-artifact action
  # yet.
  artifact-cleanup:
    name: Delete uploaded images
    needs:
    - build-antrea-coverage-image
    - build-flow-aggregator-coverage-image
    - test-e2e-encap
    - test-e2e-encap-non-default
    - test-e2e-encap-all-features-enabled
    - test-e2e-noencap
    - test-e2e-hybrid
    - test-upgrade-from-N-1
    - test-upgrade-from-N-2
    - test-compatible-N-1
    - test-compatible-N-2
    - validate-prometheus-metrics-doc
    - test-e2e-flow-visibility
    runs-on: [ubuntu-latest]
    steps:
    - name: Delete antrea-ubuntu-cov
      if: ${{ needs.build-antrea-coverage-image.result == 'success' }}
      uses: geekyeggo/delete-artifact@v2
      with:
        name: antrea-ubuntu-cov
    - name: Delete flow-aggregator
      if: ${{ needs.build-flow-aggregator-coverage-image.result == 'success' }}
      uses: geekyeggo/delete-artifact@v2
      with:
        name: flow-aggregator-cov
        failOnError: false