Back to Repositories

Testing Kubernetes ResourceQuota Configuration in Apache Airflow

This test suite validates Kubernetes ResourceQuota configurations in Apache Airflow’s Helm charts. It ensures proper resource allocation and limitations for various Kubernetes objects when deploying Airflow using Helm.

Test Coverage Overview

The test suite covers critical aspects of ResourceQuota management in Kubernetes deployments.

Key areas tested include:
  • Custom quota configurations for various Kubernetes resources
  • Default behavior validation when quotas are not specified
  • Verification of specific resource limits for configmaps, pods, secrets, and services

Implementation Analysis

The testing approach utilizes Helm template rendering to validate ResourceQuota configurations.

The implementation employs the render_chart utility to generate and verify Kubernetes manifests, with JMESPath queries for precise manifest validation. Tests verify both explicit quota settings and default behaviors.

Technical Details

Key technical components include:
  • Helm template generator for manifest creation
  • JMESPath for JSON/YAML parsing and validation
  • Python test framework for assertion-based testing
  • ResourceQuota Kubernetes object specifications

Best Practices Demonstrated

The test suite exemplifies several testing best practices in Helm chart validation.

Notable practices include:
  • Isolation of template rendering for focused testing
  • Explicit verification of both positive and negative cases
  • Clear separation of test scenarios
  • Efficient use of template rendering utilities

apache/airflow

helm_tests/other/test_resource_quota.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 TestResourceQuota:
    """Tests resource quota."""

    def test_resource_quota_template(self):
        docs = render_chart(
            values={
                "quotas": {
                    "configmaps": "10",
                    "persistentvolumeclaims": "4",
                    "pods": "4",
                    "replicationcontrollers": "20",
                    "secrets": "10",
                    "services": "10",
                }
            },
            show_only=["templates/resourcequota.yaml"],
        )
        assert jmespath.search("kind", docs[0]) == "ResourceQuota"
        assert jmespath.search("spec.hard.replicationcontrollers", docs[0]) == "20"

    def test_resource_quota_are_not_added_by_default(self):
        docs = render_chart(
            show_only=["templates/resourcequota.yaml"],
        )
        assert docs == []