e2e-test.yml

name: Integration Tests

on:
  workflow_dispatch:
    inputs:
      run_aclp_logs_stream_tests:
        description: 'Set this parameter to "true" to run ACLP logs stream related test cases'
        required: false
        default: 'false'
        type: choice
        options:
          - 'true'
          - 'false'
      run_db_fork_tests:
        description: 'Set this parameter to "true" to run fork database related test cases'
        required: false
        default: 'false'
        type: choice
        options:
          - 'true'
          - 'false'
      run_db_tests:
        description: 'Set this parameter to "true" to run database related test cases'
        required: false
        default: 'false'
        type: choice
        options:
          - 'true'
          - 'false'
      test_suite:
        description: 'Enter specific test suite. E.g. domain, linode_client'
        required: false
      use_minimal_test_account:
        description: 'Indicate whether to use a minimal test account with limited resources for testing. Defaults to "false"'
        required: false
        default: 'false'
      sha:
        description: 'Specify commit hash to test. This value is mandatory to ensure the tests run against a specific commit'
        required: true
        default: ''
      python-version:
        description: 'Specify the Python version to use for running tests. Leave empty to use the default Python version configured in the environment'
        required: false
      run-eol-python-version:
        description: 'Indicates whether to run tests using an End-of-Life (EOL) Python version. Defaults to "false". Choose "true" to include tests for deprecated Python versions'
        required: false
        default: 'false'
        type: choice
        options:
          - 'true'
          - 'false'
      test_report_upload:
        description: 'Indicates whether to upload the test report to object storage. Defaults to "false"'
        type: choice
        required: false
        default: 'false'
        options:
          - 'true'
          - 'false'
  push:
    branches:
      - main
      - dev

env:
  DEFAULT_PYTHON_VERSION: "3.13"
  EOL_PYTHON_VERSION: "3.10"
  EXIT_STATUS: 0

jobs:
  integration-tests:
    runs-on: ubuntu-latest
    steps:
      - name: Clone Repository with SHA
        if: ${{ inputs.sha != '' }}
        uses: actions/checkout@v7
        with:
          fetch-depth: 0
          submodules: 'recursive'
          ref: ${{ inputs.sha }}

      - name: Clone Repository without SHA
        if: ${{ inputs.sha == '' }}
        uses: actions/checkout@v7
        with:
          fetch-depth: 0
          submodules: 'recursive'

      - name: Setup Python
        uses: actions/setup-python@v7
        with:
          python-version: ${{ inputs.run-eol-python-version == 'true' && env.EOL_PYTHON_VERSION || inputs.python-version || env.DEFAULT_PYTHON_VERSION }}

      - name: Install Python deps
        run: pip install -U setuptools wheel boto3 certifi

      - name: Install Python SDK
        run: make dev-install
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Set LINODE_TOKEN
        run: |
          echo "LINODE_TOKEN=${{ secrets[inputs.use_minimal_test_account == 'true' && 'MINIMAL_LINODE_TOKEN' || 'LINODE_TOKEN'] }}" >> $GITHUB_ENV

      - name: Run Integration tests
        run: |
          timestamp=$(date +'%Y%m%d%H%M')
          report_filename="${timestamp}_sdk_test_report.xml"
          make test-int RUN_DB_FORK_TESTS="$RUN_DB_FORK_TESTS" RUN_DB_TESTS="$RUN_DB_TESTS" RUN_ACLP_LOGS_STREAM_TESTS="$RUN_ACLP_LOGS_STREAM_TESTS" TEST_SUITE="$TEST_SUITE" TEST_ARGS="--junitxml=${report_filename}"
        env:
          LINODE_TOKEN: ${{ env.LINODE_TOKEN }}
          RUN_DB_FORK_TESTS: ${{ github.event.inputs.run_db_fork_tests }}
          RUN_DB_TESTS: ${{ github.event.inputs.run_db_tests }}
          RUN_ACLP_LOGS_STREAM_TESTS: ${{ github.event.inputs.run_aclp_logs_stream_tests }}
          TEST_SUITE: ${{ github.event.inputs.test_suite }}

      - name: Upload Test Report as Artifact
        if: always()
        uses: actions/upload-artifact@v7
        with:
          name: test-report-file
          if-no-files-found: ignore
          path: '*.xml'
          retention-days: 1

  apply-calico-rules:
    runs-on: ubuntu-latest
    needs: [integration-tests]
    if: ${{ success() || failure() }}

    steps:
      - name: Checkout code
        uses: actions/checkout@v7
        with:
          fetch-depth: 0
          submodules: 'recursive'

      - name: Set LINODE_TOKEN
        run: |
          echo "LINODE_TOKEN=${{ secrets[inputs.use_minimal_test_account == 'true' && 'MINIMAL_LINODE_TOKEN' || 'LINODE_TOKEN'] }}" >> $GITHUB_ENV

      - name: Download kubectl and calicoctl for LKE clusters
        run: |
          curl -LO "https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl"
          curl -LO "https://github.com/projectcalico/calico/releases/download/v3.25.0/calicoctl-linux-amd64"
          chmod +x calicoctl-linux-amd64 kubectl
          mv calicoctl-linux-amd64 /usr/local/bin/calicoctl
          mv kubectl /usr/local/bin/kubectl

      - name: Apply Calico Rules to LKE
        run: |
          cd e2e_scripts/cloud_security_scripts/lke_calico_rules/ && ./lke_calico_rules_e2e.sh
        env:
          LINODE_TOKEN: ${{ env.LINODE_TOKEN }}

  add-fw-to-remaining-instances:
    runs-on: ubuntu-latest
    needs: [integration-tests]
    if: ${{ success() || failure() }}

    steps:
      - name: Set up Python
        uses: actions/setup-python@v7
        with:
          python-version: '3.x'

      - name: Install Linode CLI
        run: |
          pip install linode-cli

      - name: Set LINODE_TOKEN
        run: |
          echo "LINODE_TOKEN=${{ secrets[inputs.use_minimal_test_account == 'true' && 'MINIMAL_LINODE_TOKEN' || 'LINODE_TOKEN'] }}" >> $GITHUB_ENV

      - name: Create Firewall and Attach to Instances
        run: |
          FIREWALL_ID=$(linode-cli firewalls create --label "e2e-fw-$(date +%s)" --rules.inbound_policy "DROP" --rules.outbound_policy "ACCEPT" --text --format=id --no-headers)
          echo "Created Firewall with ID: $FIREWALL_ID"
          
          for instance_id in $(linode-cli linodes list --format "id" --text --no-header); do
            echo "Attaching firewall to instance: $instance_id"
            if linode-cli firewalls device-create "$FIREWALL_ID" --id "$instance_id" --type linode; then
              echo "Firewall attached to instance $instance_id successfully."
            else
              echo "An error occurred while attaching firewall to instance $instance_id. Skipping..."
            fi
          done
        env:
          LINODE_CLI_TOKEN: ${{ env.LINODE_TOKEN }}

  process-upload-report:
    runs-on: ubuntu-latest
    needs: [integration-tests]
    # Run even if integration tests fail on main repository AND push event OR test_report_upload is true in case of manual run
    if: always() && github.repository == 'linode/linode_api4-python' && (github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && inputs.test_report_upload == 'true'))
    outputs:
      summary: ${{ steps.set-test-summary.outputs.summary }}

    steps:
      - name: Checkout code
        uses: actions/checkout@v7
        with:
          fetch-depth: 0
          submodules: 'recursive'

      - name: Download test report
        uses: actions/download-artifact@v8
        with:
          name: test-report-file

      - name: Set up Python
        uses: actions/setup-python@v7
        with:
          python-version: '3.x'

      - name: Install Python dependencies
        run: pip3 install requests wheel boto3==1.35.99

      - name: Set release version env
        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV

      - name: Add variables and upload test results
        if: always()
        run: |
          filename=$(ls | grep -E '^[0-9]{12}_sdk_test_report\.xml$') 
          python3 e2e_scripts/tod_scripts/xml_to_obj_storage/scripts/add_gha_info_to_xml.py \
          --branch_name "${GITHUB_REF#refs/*/}" \
          --gha_run_id "$GITHUB_RUN_ID" \
          --gha_run_number "$GITHUB_RUN_NUMBER" \
          --xmlfile "${filename}"
          sync
          python3 e2e_scripts/tod_scripts/xml_to_obj_storage/scripts/xml_to_obj.py "${filename}"
        env:
          LINODE_CLI_OBJ_ACCESS_KEY: ${{ secrets.LINODE_CLI_OBJ_ACCESS_KEY }}
          LINODE_CLI_OBJ_SECRET_KEY: ${{ secrets.LINODE_CLI_OBJ_SECRET_KEY }}

      - name: Generate test summary and save to output
        id: set-test-summary
        run: |
          filename=$(ls | grep -E '^[0-9]{12}_sdk_test_report\.xml$') 
          test_output=$(python3 e2e_scripts/tod_scripts/generate_test_summary.py "${filename}")
          {
            echo 'summary<<EOF'
            echo "$test_output"
            echo EOF
          } >> "$GITHUB_OUTPUT"

  notify-slack:
    runs-on: ubuntu-latest
    needs: [integration-tests, process-upload-report]
    if: ${{ (success() || failure()) }} # Run even if integration tests fail and only on main repository
    steps:
      - name: Notify Slack
        id: main_message
        uses: slackapi/slack-github-action@v4
        with:
          method: chat.postMessage
          token: ${{ secrets.SLACK_BOT_TOKEN }}
          payload: |
            channel: ${{ secrets.SLACK_CHANNEL_ID }}
            blocks:
              - type: section
                text:
                  type: mrkdwn
                  text: ":rocket: *${{ github.workflow }} Completed in: ${{ github.repository }}* ${{ needs.integration-tests.result == 'success' && ':white_check_mark:' || ':failed:' }}"
              - type: divider
              - type: section
                fields:
                  - type: mrkdwn
                    text: "*Build Result:*\n${{ needs.integration-tests.result == 'success' && ':large_green_circle: Build Passed' || ':red_circle: Build Failed' }}"
                  - type: mrkdwn
                    text: "*Branch:*\n`${{ github.ref_name }}`"
              - type: section
                fields:
                  - type: mrkdwn
                    text: "*Commit Hash:*\n<${{ github.server_url }}/${{ github.repository }}/commit/${{ github.sha }}|${{ github.sha }}>"
                  - type: mrkdwn
                    text: "*Run URL:*\n<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|View Run Details>"
              - type: divider
              - type: context
                elements:
                  - type: mrkdwn
                    text: "Triggered by: :bust_in_silhouette: `${{ github.actor }}`"

      - name: Test summary thread
        if: success()
        uses: slackapi/slack-github-action@v4
        with:
          method: chat.postMessage
          token: ${{ secrets.SLACK_BOT_TOKEN }}
          payload: |
            channel: ${{ secrets.SLACK_CHANNEL_ID }}
            thread_ts: "${{ steps.main_message.outputs.ts }}"
            text: "${{ needs.process-upload-report.outputs.summary }}"