forked from apache/airflow
-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
AIP-72: Add "Get Variable" endpoint for Execution API (apache#43832)
This commit introduces a new endpoint, `/execution/variable/{variable_key}`, in the Execution API to retrieve Variables details. Same as the Connections PR, it uses a placeholder `check_connection_access` function to validate task permissions for each request.
- Loading branch information
Showing
8 changed files
with
189 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
# 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 logging | ||
|
||
from fastapi import Depends, HTTPException, status | ||
from typing_extensions import Annotated | ||
|
||
from airflow.api_fastapi.common.router import AirflowRouter | ||
from airflow.api_fastapi.execution_api import datamodels | ||
from airflow.models.variable import Variable | ||
|
||
# TODO: Add dependency on JWT token | ||
router = AirflowRouter( | ||
responses={status.HTTP_404_NOT_FOUND: {"description": "Variable not found"}}, | ||
) | ||
|
||
log = logging.getLogger(__name__) | ||
|
||
|
||
def get_task_token() -> datamodels.TIToken: | ||
"""TODO: Placeholder for task identity authentication. This should be replaced with actual JWT decoding and validation.""" | ||
return datamodels.TIToken(ti_key="test_key") | ||
|
||
|
||
@router.get( | ||
"/{variable_key}", | ||
responses={ | ||
status.HTTP_401_UNAUTHORIZED: {"description": "Unauthorized"}, | ||
status.HTTP_403_FORBIDDEN: {"description": "Task does not have access to the variable"}, | ||
}, | ||
) | ||
def get_variable( | ||
variable_key: str, | ||
token: Annotated[datamodels.TIToken, Depends(get_task_token)], | ||
) -> datamodels.VariableResponse: | ||
"""Get an Airflow Variable.""" | ||
if not has_variable_access(variable_key, token): | ||
raise HTTPException( | ||
status_code=status.HTTP_403_FORBIDDEN, | ||
detail={ | ||
"reason": "access_denied", | ||
"message": f"Task does not have access to variable {variable_key}", | ||
}, | ||
) | ||
|
||
try: | ||
variable_value = Variable.get(variable_key) | ||
except KeyError: | ||
raise HTTPException( | ||
status.HTTP_404_NOT_FOUND, | ||
detail={ | ||
"reason": "not_found", | ||
"message": f"Variable with key '{variable_key}' not found", | ||
}, | ||
) | ||
|
||
return datamodels.VariableResponse(key=variable_key, value=variable_value) | ||
|
||
|
||
def has_variable_access(variable_key: str, token: datamodels.TIToken) -> bool: | ||
"""Check if the task has access to the variable.""" | ||
# TODO: Placeholder for actual implementation | ||
|
||
ti_key = token.ti_key | ||
log.debug( | ||
"Checking access for task instance with key '%s' to variable '%s'", | ||
ti_key, | ||
variable_key, | ||
) | ||
return True |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# 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 unittest import mock | ||
|
||
import pytest | ||
|
||
from airflow.models.variable import Variable | ||
|
||
pytestmark = pytest.mark.db_test | ||
|
||
|
||
class TestGetVariable: | ||
def test_variable_get_from_db(self, client, session): | ||
Variable.set(key="var1", value="value", session=session) | ||
session.commit() | ||
|
||
response = client.get("/execution/variables/var1") | ||
|
||
assert response.status_code == 200 | ||
assert response.json() == {"key": "var1", "value": "value"} | ||
|
||
# Remove connection | ||
Variable.delete(key="var1", session=session) | ||
session.commit() | ||
|
||
@mock.patch.dict( | ||
"os.environ", | ||
{"AIRFLOW_VAR_KEY1": "VALUE"}, | ||
) | ||
def test_variable_get_from_env_var(self, client, session): | ||
response = client.get("/execution/variables/key1") | ||
|
||
assert response.status_code == 200 | ||
assert response.json() == {"key": "key1", "value": "VALUE"} | ||
|
||
def test_variable_get_not_found(self, client): | ||
response = client.get("/execution/variables/non_existent_var") | ||
|
||
assert response.status_code == 404 | ||
assert response.json() == { | ||
"detail": { | ||
"message": "Variable with key 'non_existent_var' not found", | ||
"reason": "not_found", | ||
} | ||
} | ||
|
||
def test_variable_get_access_denied(self, client): | ||
with mock.patch( | ||
"airflow.api_fastapi.execution_api.routes.variables.has_variable_access", return_value=False | ||
): | ||
response = client.get("/execution/variables/key1") | ||
|
||
# Assert response status code and detail for access denied | ||
assert response.status_code == 403 | ||
assert response.json() == { | ||
"detail": { | ||
"reason": "access_denied", | ||
"message": "Task does not have access to variable key1", | ||
} | ||
} |