Skip to content

[v3-0-test] API handle slashes in variable keys (#50841) #50874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pierrejeambrun merged 1 commit into from
May 22, 2025
Merged

[v3-0-test] API handle slashes in variable keys (#50841) #50874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions airflow-core/src/airflow/api_fastapi/core_api/routes/public/variables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@


@variables_router.delete(
"/{variable_key}",
"/{variable_key:path}",
status_code=status.HTTP_204_NO_CONTENT,
responses=create_openapi_http_exception_doc([status.HTTP_404_NOT_FOUND]),
dependencies=[Depends(action_logging()), Depends(requires_access_variable("DELETE"))],
Expand All @@ -64,7 +64,7 @@ def delete_variable(


@variables_router.get(
"/{variable_key}",
"/{variable_key:path}",
responses=create_openapi_http_exception_doc([status.HTTP_404_NOT_FOUND]),
dependencies=[Depends(requires_access_variable("GET"))],
)
Expand Down Expand Up @@ -121,7 +121,7 @@ def get_variables(


@variables_router.patch(
"/{variable_key}",
"/{variable_key:path}",
responses=create_openapi_http_exception_doc(
[
status.HTTP_400_BAD_REQUEST,
Expand Down
105 changes: 91 additions & 14 deletions airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_variables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@
TEST_VARIABLE_VALUE3 = '{"password": "some_password"}'
TEST_VARIABLE_DESCRIPTION3 = "Some description for the variable"

TEST_VARIABLE_KEY4 = "test_variable_key/with_slashes"
TEST_VARIABLE_VALUE4 = "test_variable_value"
TEST_VARIABLE_DESCRIPTION4 = "Some description for the variable"


TEST_VARIABLE_SEARCH_KEY = "test_variable_search_key"
TEST_VARIABLE_SEARCH_VALUE = "random search value"
Expand Down Expand Up @@ -78,6 +82,13 @@ def _create_variables(session) -> None:
session=session,
)

Variable.set(
key=TEST_VARIABLE_KEY4,
value=TEST_VARIABLE_VALUE4,
description=TEST_VARIABLE_DESCRIPTION4,
session=session,
)

Variable.set(
key=TEST_VARIABLE_SEARCH_KEY,
value=TEST_VARIABLE_SEARCH_VALUE,
Expand All @@ -102,9 +113,11 @@ class TestDeleteVariable(TestVariableEndpoint):
def test_delete_should_respond_204(self, test_client, session):
self.create_variables()
variables = session.query(Variable).all()
assert len(variables) == 4
assert len(variables) == 5
response = test_client.delete(f"/variables/{TEST_VARIABLE_KEY}")
assert response.status_code == 204
response = test_client.delete(f"/variables/{TEST_VARIABLE_KEY4}")
assert response.status_code == 204
variables = session.query(Variable).all()
assert len(variables) == 3
check_last_log(session, dag_id=None, event="delete_variable", logical_date=None)
Expand Down Expand Up @@ -156,6 +169,15 @@ class TestGetVariable(TestVariableEndpoint):
"is_encrypted": True,
},
),
(
TEST_VARIABLE_KEY4,
{
"key": TEST_VARIABLE_KEY4,
"value": TEST_VARIABLE_VALUE4,
"description": TEST_VARIABLE_DESCRIPTION4,
"is_encrypted": True,
},
),
(
TEST_VARIABLE_SEARCH_KEY,
{
Expand Down Expand Up @@ -194,35 +216,75 @@ class TestGetVariables(TestVariableEndpoint):
"query_params, expected_total_entries, expected_keys",
[
# Filters
({}, 4, [TEST_VARIABLE_KEY, TEST_VARIABLE_KEY2, TEST_VARIABLE_KEY3, TEST_VARIABLE_SEARCH_KEY]),
({"limit": 1}, 4, [TEST_VARIABLE_KEY]),
({"limit": 1, "offset": 1}, 4, [TEST_VARIABLE_KEY2]),
(
{},
5,
[
TEST_VARIABLE_KEY,
TEST_VARIABLE_KEY2,
TEST_VARIABLE_KEY3,
TEST_VARIABLE_KEY4,
TEST_VARIABLE_SEARCH_KEY,
],
),
({"limit": 1}, 5, [TEST_VARIABLE_KEY]),
({"limit": 1, "offset": 1}, 5, [TEST_VARIABLE_KEY2]),
# Sort
(
{"order_by": "id"},
4,
[TEST_VARIABLE_KEY, TEST_VARIABLE_KEY2, TEST_VARIABLE_KEY3, TEST_VARIABLE_SEARCH_KEY],
5,
[
TEST_VARIABLE_KEY,
TEST_VARIABLE_KEY2,
TEST_VARIABLE_KEY3,
TEST_VARIABLE_KEY4,
TEST_VARIABLE_SEARCH_KEY,
],
),
(
{"order_by": "-id"},
4,
[TEST_VARIABLE_SEARCH_KEY, TEST_VARIABLE_KEY3, TEST_VARIABLE_KEY2, TEST_VARIABLE_KEY],
5,
[
TEST_VARIABLE_SEARCH_KEY,
TEST_VARIABLE_KEY4,
TEST_VARIABLE_KEY3,
TEST_VARIABLE_KEY2,
TEST_VARIABLE_KEY,
],
),
(
{"order_by": "key"},
4,
[TEST_VARIABLE_KEY3, TEST_VARIABLE_KEY2, TEST_VARIABLE_KEY, TEST_VARIABLE_SEARCH_KEY],
5,
[
TEST_VARIABLE_KEY3,
TEST_VARIABLE_KEY2,
TEST_VARIABLE_KEY,
TEST_VARIABLE_KEY4,
TEST_VARIABLE_SEARCH_KEY,
],
),
(
{"order_by": "-key"},
4,
[TEST_VARIABLE_SEARCH_KEY, TEST_VARIABLE_KEY, TEST_VARIABLE_KEY2, TEST_VARIABLE_KEY3],
5,
[
TEST_VARIABLE_SEARCH_KEY,
TEST_VARIABLE_KEY4,
TEST_VARIABLE_KEY,
TEST_VARIABLE_KEY2,
TEST_VARIABLE_KEY3,
],
),
# Search
(
{"variable_key_pattern": "~"},
4,
[TEST_VARIABLE_KEY, TEST_VARIABLE_KEY2, TEST_VARIABLE_KEY3, TEST_VARIABLE_SEARCH_KEY],
5,
[
TEST_VARIABLE_KEY,
TEST_VARIABLE_KEY2,
TEST_VARIABLE_KEY3,
TEST_VARIABLE_KEY4,
TEST_VARIABLE_SEARCH_KEY,
],
),
({"variable_key_pattern": "search"}, 1, [TEST_VARIABLE_SEARCH_KEY]),
],
Expand Down Expand Up @@ -282,6 +344,21 @@ class TestPatchVariable(TestVariableEndpoint):
"is_encrypted": True,
},
),
(
TEST_VARIABLE_KEY4,
{
"key": TEST_VARIABLE_KEY4,
"value": "The new value",
"description": "The new description",
},
{"update_mask": ["value"]},
{
"key": TEST_VARIABLE_KEY4,
"value": "The new value",
"description": TEST_VARIABLE_DESCRIPTION4,
"is_encrypted": True,
},
),
(
TEST_VARIABLE_KEY2,
{
Expand Down