airflow_ctl_tests.rst

Airflow Ctl (airflowctl) Tests

This document describes how to run tests for the Airflow Ctl (airflowctl) command-line tool.

Similar to other integration tests, the Airflow Ctl tests are run in the Breeze environment. The tests are using the Docker Compose and running a full working Airflow environment. These tests run on a scheduled basis in CI and can also be run locally using Breeze. We have them to ensure the airflowctl tool is working as expected and interacting with Airflow instances correctly. Airflow Ctl integration tests are located in the root directory of Apache Airflow project.

Note

The integration tests ensure that the airflowctl tool behaves as expected when interacting with Airflow instances. They validate the tool's functionality in a controlled environment, providing confidence in its reliability.

Running Airflow Ctl Tests with Breeze

Firstly, checkout the tag or branch you want to run the tests on. Then, you can run the tests using the following command:

breeze testing airflow-ctl-integration-test

Note

The above command runs the integration tests for airflowctl in the Breeze environment. Ensure that the correct tag or branch is checked out before executing the tests.