Skip to content

Fix broken/renamed internal API method #41070

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
jscheffl merged 2 commits into from
Jul 27, 2024
Merged

Fix broken/renamed internal API method #41070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9f0417
Fix broken/renamed internal API method
jscheffl Jul 27, 2024
9169735
Add pytest to check method_map can be created
jscheffl Jul 27, 2024
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
2 changes: 1 addition & 1 deletion airflow/api_internal/endpoints/rpc_api_endpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ def initialize_method_map() -> dict[str, Callable]:
DagRun.fetch_task_instances,
DagRun.get_previous_dagrun,
DagRun.get_previous_scheduled_dagrun,
DagRun.get_task_instances,
DagRun.fetch_task_instance,
DagRun._get_log_template,
DagRun._get_task_instances,
RenderedTaskInstanceFields._update_runtime_evaluated_template_fields,
SerializedDagModel.get_serialized_dag,
SerializedDagModel.remove_deleted_dags,
Expand Down
26 changes: 17 additions & 9 deletions tests/api_internal/endpoints/test_rpc_api_endpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def equals(a, b) -> bool:

@pytest.mark.skipif(not _ENABLE_AIP_44, reason="AIP-44 is disabled")
class TestRpcApiEndpoint:
@pytest.fixture(autouse=True)
@pytest.fixture
def setup_attrs(self, minimal_app_for_internal_api: Flask) -> Generator:
self.app = minimal_app_for_internal_api
self.client = self.app.test_client() # type:ignore
Expand All @@ -93,6 +93,12 @@ def signer(self) -> JWTSigner:
audience="api",
)

def test_initialize_method_map(self):
from airflow.api_internal.endpoints.rpc_api_endpoint import initialize_method_map

method_map = initialize_method_map()
assert len(method_map) > 70

@pytest.mark.parametrize(
"input_params, method_result, result_cmp_func, method_params",
[
Expand All @@ -119,7 +125,9 @@ def signer(self) -> JWTSigner:
),
],
)
def test_method(self, input_params, method_result, result_cmp_func, method_params, signer: JWTSigner):
def test_method(
self, input_params, method_result, result_cmp_func, method_params, setup_attrs, signer: JWTSigner
):
mock_test_method.return_value = method_result
headers = {
"Content-Type": "application/json",
Expand All @@ -146,7 +154,7 @@ def test_method(self, input_params, method_result, result_cmp_func, method_param

mock_test_method.assert_called_once_with(**method_params, session=mock.ANY)

def test_method_with_exception(self, signer: JWTSigner):
def test_method_with_exception(self, setup_attrs, signer: JWTSigner):
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
Expand All @@ -160,7 +168,7 @@ def test_method_with_exception(self, signer: JWTSigner):
assert response.data, b"Error executing method: test_method."
mock_test_method.assert_called_once()

def test_unknown_method(self, signer: JWTSigner):
def test_unknown_method(self, setup_attrs, signer: JWTSigner):
UNKNOWN_METHOD = "i-bet-it-does-not-exist"
headers = {
"Content-Type": "application/json",
Expand All @@ -174,7 +182,7 @@ def test_unknown_method(self, signer: JWTSigner):
assert response.data.startswith(b"Unrecognized method: i-bet-it-does-not-exist.")
mock_test_method.assert_not_called()

def test_invalid_jsonrpc(self, signer: JWTSigner):
def test_invalid_jsonrpc(self, setup_attrs, signer: JWTSigner):
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
Expand All @@ -187,7 +195,7 @@ def test_invalid_jsonrpc(self, signer: JWTSigner):
assert response.data.startswith(b"Expected jsonrpc 2.0 request.")
mock_test_method.assert_not_called()

def test_missing_token(self):
def test_missing_token(self, setup_attrs):
mock_test_method.return_value = None

input_data = {
Expand All @@ -202,7 +210,7 @@ def test_missing_token(self):
data=json.dumps(input_data),
)

def test_invalid_token(self, signer: JWTSigner):
def test_invalid_token(self, setup_attrs, signer: JWTSigner):
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
Expand All @@ -215,7 +223,7 @@ def test_invalid_token(self, signer: JWTSigner):
):
self.client.post("/internal_api/v1/rpcapi", headers=headers, data=json.dumps(data))

def test_missing_accept(self, signer: JWTSigner):
def test_missing_accept(self, setup_attrs, signer: JWTSigner):
headers = {
"Content-Type": "application/json",
"Authorization": signer.generate_signed_token({"method": "WRONG_METHOD_NAME"}),
Expand All @@ -225,7 +233,7 @@ def test_missing_accept(self, signer: JWTSigner):
with pytest.raises(PermissionDenied, match="Expected Accept: application/json"):
self.client.post("/internal_api/v1/rpcapi", headers=headers, data=json.dumps(data))

def test_wrong_accept(self, signer: JWTSigner):
def test_wrong_accept(self, setup_attrs, signer: JWTSigner):
headers = {
"Content-Type": "application/json",
"Accept": "application/html",
Expand Down