Back to Repositories

Testing Git SSH Key Secret Generation in Apache Airflow

This test suite validates the Git SSH key secret functionality in Apache Airflow’s Helm chart deployment. It ensures proper secret creation and encoding for Git synchronization operations in Kubernetes environments.

Test Coverage Overview

The test suite focuses on verifying the creation and configuration of Git SSH key secrets in Airflow’s Helm deployments.

Tests creation of SSH key secrets for Git sync operations
Validates proper secret naming conventions
Verifies correct base64 encoding of SSH keys
Ensures proper integration with Airflow’s Git sync functionality

Implementation Analysis

The testing approach utilizes Helm template rendering and JMESPath queries to validate secret configurations.

The implementation employs a fixture-based testing pattern with the render_chart utility, allowing for isolated testing of Helm template outputs. The tests verify both metadata and data fields of the generated Kubernetes secret resources.

Technical Details

Uses render_chart utility for Helm template testing
JMESPath for JSON/YAML path queries
Python unittest framework
Base64 encoding validation
Kubernetes secret resource testing

Best Practices Demonstrated

The test suite exemplifies several testing best practices for Kubernetes manifest validation.

Isolated template rendering for targeted testing
Explicit assertion of resource properties
Clear test case organization
Proper secret handling and encoding verification

apache/airflow

helm_tests/other/test_git_ssh_key_secret.py

            
# 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.
from __future__ import annotations

import jmespath

from tests.charts.helm_template_generator import render_chart


class TestGitSSHKeySecret:
    """Tests git-ssh secret."""

    def test_create_git_ssh_key_secret(self):
        docs = render_chart(
            values={
                "dags": {
                    "gitSync": {
                        "enabled": True,
                        "sshKey": "cm9tIGlzIHRoZSBraW5n",
                    },
                    "persistence": {"enabled": True},
                }
            },
            show_only=["templates/secrets/git-ssh-key-secret.yaml"],
        )

        assert jmespath.search("metadata.name", docs[0]) == "release-name-ssh-secret"
        assert jmespath.search("data.gitSshKey", docs[0]) == "Y205dElHbHpJSFJvWlNCcmFXNW4="