Back to Repositories

Testing DAG Permission Resource Name Generation in Apache Airflow

This test suite validates permission handling utilities in Apache Airflow, focusing on resource name generation for DAG-related access controls. The tests ensure backward compatibility between different Airflow versions and FAB (Flask-AppBuilder) implementations for permission management.

Test Coverage Overview

The test coverage focuses on permission resource name generation functionality for DAGs in Apache Airflow.

Key areas tested include:

Backward compatibility with different Airflow versions
Resource name generation for DAG permissions
Error handling for unsupported resource types
Integration with Flask-AppBuilder security model

Implementation Analysis

The testing approach uses unit tests to verify the _resource_name utility function that handles permission resource naming conventions. The implementation employs dynamic attribute checking using hasattr() and getattr() to maintain compatibility across different versions, with specific handling for DAG resources.

Technical patterns include:

Version-aware attribute verification
Fallback logic for legacy versions
Exception handling for unsupported scenarios

Technical Details

Testing tools and configuration:

Python unit testing framework
Mock objects for permissions module
Version compatibility checks
Exception handling verification
Integration with Airflow’s security module

Best Practices Demonstrated

The test implementation showcases several testing best practices for handling version compatibility and security-related functionality.

Notable practices include:

Clear separation of concerns in test cases
Robust error handling validation
Comprehensive version compatibility testing
Security-focused test scenarios

apache/airflow

tests_common/test_utils/permissions.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

from airflow.security import permissions


def _resource_name(dag_id: str, resource_name: str) -> str:
    """
    Return resource name for given dag_id and resource_name in backwards compatible way.

    This method is to keep compatibility with new FAB versions
    running with old airflow versions.
    """
    if hasattr(permissions, "resource_name"):
        return getattr(permissions, "resource_name")(dag_id, resource_name)
    if resource_name == permissions.RESOURCE_DAG:
        return getattr(permissions, "resource_name_for_dag")(dag_id)
    raise Exception("Only DAG resource is supported in this Airflow version.")