ci.yml

################################################################################
#  Licensed to the Apache Software Foundation (ASF) under one
#  or more contributor license agreements.  See the NOTICE file
#  distributed with this work for additional information
#  regarding copyright ownership.  The ASF licenses this file
#  to you under the Apache License, Version 2.0 (the
#  "License"); you may not use this file except in compliance
#  with the License.  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
# limitations under the License.
################################################################################

# We need to specify repo related information here since Apache INFRA doesn't differentiate
# between several workflows with the same names while preparing a report for GHA usage
# https://infra-reports.apache.org/#ghactions
name: Flink Kubernetes Operator CI

on:
  push:
    branches:
      - main
      - release-*
  pull_request:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref_name }}
  cancel-in-progress: true

env:
  HELM_CHART_DIR: helm
  FLINK_OPERATOR_CHART: flink-kubernetes-operator

jobs:
  helm_lint_test:
    runs-on: ubuntu-latest

    name: Helm Lint Test

    steps:
      - name: Determine branch name
        id: get_branch
        run: |
          BRANCH=""
          if [ "${{ github.event_name }}" == "push" ]; then
            BRANCH=${{ github.ref_name }}
          elif [ "${{ github.event_name }}" == "pull_request" ]; then
            BRANCH=${{ github.base_ref }}
          fi
          echo "BRANCH=$BRANCH" >> "$GITHUB_OUTPUT"

      - name: Checkout source code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Helm
        uses: azure/setup-helm@1a275c3b69536ee54be43f2070a358922e12c8d4
        with:
          version: v3.17.3

      - name: Install Helm unittest plugin
        run: helm plugin install https://github.com/helm-unittest/helm-unittest.git --version 0.8.1

      - name: Run Helm unittest
        run: helm unittest ${{ env.HELM_CHART_DIR }}/${{ env.FLINK_OPERATOR_CHART }} --file "tests/**/*_test.yaml" --strict --debug

      - name: Set up chart-testing
        run: |
          CT_VERSION=3.14.0
          curl -sSLo /tmp/chart-testing.tar.gz "https://github.com/helm/chart-testing/releases/download/v${CT_VERSION}/chart-testing_${CT_VERSION}_linux_amd64.tar.gz"
          mkdir -p /tmp/ct
          tar -xzf /tmp/chart-testing.tar.gz -C /tmp/ct
          sudo mv /tmp/ct/ct /usr/local/bin/ct
          sudo mv /tmp/ct/etc /etc/ct
          pip install yamale yamllint

      - name: Run chart-testing (list-changed)
        id: list-changed
        env:
          BRANCH: ${{ steps.get_branch.outputs.BRANCH }}
        run: |
          changed=$(ct list-changed --target-branch $BRANCH --chart-dirs ${{ env.HELM_CHART_DIR }})
          if [[ -n "$changed" ]]; then
            echo "changed=true" >> "$GITHUB_OUTPUT"
          fi

      - name: Run Helm lint
        if: steps.list-changed.outputs.changed == 'true'
        run: |
          helm lint ${{ env.HELM_CHART_DIR }}/${{ env.FLINK_OPERATOR_CHART }} --strict --debug

      - name: Run chart-testing (lint)
        if: steps.list-changed.outputs.changed == 'true'
        env:
          BRANCH: ${{ steps.get_branch.outputs.BRANCH }}
        run: ct lint --target-branch $BRANCH --chart-dirs ${{ env.HELM_CHART_DIR }} --check-version-increment=false --validate-maintainers=false

  test_ci:
    runs-on: ubuntu-latest
    name: maven build
    strategy:
      matrix:
        java-version: [ 17, 21 ]
    steps:
      - uses: actions/checkout@v4
      - name: Set up JDK ${{ matrix.java-version }}
        uses: actions/setup-java@v4
        with:
          java-version: ${{ matrix.java-version }}
          distribution: 'temurin'
          cache: 'maven'
      - name: Build with Maven
        run: |
          mvn -B clean install javadoc:javadoc -Pgenerate-docs
          if [[ $(git diff HEAD | wc -l) -gt 0 ]]; then
            echo "Please generate the java doc via 'mvn clean install -DskipTests -Pgenerate-docs' again"
            exit 1
          fi
      - name: Tests in flink-kubernetes-operator
        run: |
          cd flink-kubernetes-operator
          mvn -B verify -Dit.skip=false
          cd ..
      - name: Tests in flink-kubernetes-webhook
        run: |
          cd flink-kubernetes-webhook
          mvn -B verify -Dit.skip=false
          cd ..
      - name: Tests in flink-autoscaler-plugin-jdbc
        run: |
          cd flink-autoscaler-plugin-jdbc
          mvn -B verify -Dit.skip=false
          cd ..
  e2e_smoke_test:
    name: Smoke test
    strategy:
      matrix:
        http-client: [ "okhttp", "jdk", "jetty", "vertx" ]
        java-version: [ "17", "21" ]
    uses: ./.github/workflows/e2e.yaml
    with:
      java-version: ${{ matrix.java-version }}
      flink-version: "v1_20"
      http-client: ${{ matrix.http-client }}
      test: test_application_operations.sh
  java_runtimes:
    name: Java runtimes smoke test
    needs: e2e_smoke_test
    strategy:
      matrix:
        http-client: [ "okhttp" ]
        java-version: [ "17"]
        flink-version:
          - "v2_2"
          - "v2_1"
          - "v2_0"
          - "v1_20"
    uses: ./.github/workflows/e2e.yaml
    with:
      java-version: ${{ matrix.java-version }}
      flink-version: ${{ matrix.flink-version }}
      http-client: ${{ matrix.http-client }}
      test: test_application_operations.sh
      append-java-version: true
  e2e_namespace_tests:
    name: Alternative namespace tests
    needs: e2e_smoke_test
    strategy:
      matrix:
        flink-version:
          - "v2_2"
          - "v2_1"
          - "v2_0"
          - "v1_20"
        mode:
         - "native"
         - "standalone"
        test:
          - test_application_operations.sh
          - test_multi_sessionjob.sh
          - test_autoscaler.sh
          - test_dynamic_config.sh
          - test_dynamic_flink_conf.sh
        exclude:
          - mode: standalone
            test: test_autoscaler.sh
          - mode: standalone
            test: test_dynamic_config.sh
          - mode: standalone
            test: test_dynamic_flink_conf.sh

    uses: ./.github/workflows/e2e.yaml
    with:
      java-version: 17
      flink-version: ${{ matrix.flink-version }}
      test: ${{ matrix.test }}
      namespace: "flink"
      create-namespace: true
      mode: ${{ matrix.mode }}
  e2e_ci:
    needs: e2e_smoke_test
    strategy:
      matrix:
        flink-version:
          - "v2_2"
          - "v2_1"
          - "v2_0"
          - "v1_20"
        mode:
          - "native"
          - "standalone"
        test:
          - test_application_kubernetes_ha.sh
          - test_application_operations.sh
          - test_dynamic_config.sh
          - test_dynamic_flink_conf.sh
          - test_sessionjob_kubernetes_ha.sh
          - test_sessionjob_operations.sh
          - test_autoscaler.sh
          - test_flink_operator_ha.sh
          - test_snapshot.sh
          - test_batch_job.sh
        exclude:
          - mode: standalone
            test: test_autoscaler.sh
    uses: ./.github/workflows/e2e.yaml
    with:
      java-version: 17
      flink-version: ${{ matrix.flink-version }}
      test: ${{ matrix.test }}
      mode: ${{ matrix.mode }}
  e2e_logging:
    name: Logging framework tests
    needs: e2e_smoke_test
    strategy:
      matrix:
        flink-version:
          - "v2_2"
          - "v2_1"
          - "v2_0"
          - "v1_20"
        mode:
          - "native"
          - "standalone"
        test:
          - test_logback_logging.sh
    uses: ./.github/workflows/e2e.yaml
    with:
      java-version: 17
      flink-version: ${{ matrix.flink-version }}
      test: ${{ matrix.test }}
      mode: ${{ matrix.mode }}