AlejandroMorgante commented on code in PR #68479: URL: https://github.com/apache/airflow/pull/68479#discussion_r3447448088
########## providers/google/tests/unit/google/cloud/hooks/vertex_ai/test_agent_engine.py: ########## @@ -0,0 +1,260 @@ +# +# 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.providers.google.cloud.hooks.vertex_ai.agent_engine import AgentEngineHook + +from unit.google.cloud.utils.base_gcp_mock import mock_base_gcp_hook_default_project_id + +BASE_STRING = "airflow.providers.google.common.hooks.base_google.{}" +AGENT_ENGINE_STRING = "airflow.providers.google.cloud.hooks.vertex_ai.agent_engine.{}" + +TEST_GCP_CONN_ID = "test-gcp-conn-id" +GCP_PROJECT = "test-project" +GCP_LOCATION = "us-central1" +AGENT_ENGINE_ID = "123" +AGENT_ENGINE_NAME = "projects/test-project/locations/us-central1/reasoningEngines/123" +OPERATION_NAME = "projects/test-project/locations/us-central1/operations/delete-123" +QUERY_OPERATION_NAME = "projects/test-project/locations/us-central1/operations/query-123" +CONFIG = {"display_name": "test-agent-engine"} +QUERY_CONFIG = {"query": "hello", "output_gcs_uri": "gs://test-bucket/query-output/"} +CHECK_QUERY_CONFIG = {"retrieve_result": True} + + +class TestAgentEngineHookWithDefaultProjectId: + def setup_method(self): + with mock.patch( + BASE_STRING.format("GoogleBaseHook.__init__"), new=mock_base_gcp_hook_default_project_id + ): + self.hook = AgentEngineHook(gcp_conn_id=TEST_GCP_CONN_ID) + + @mock.patch(AGENT_ENGINE_STRING.format("Client"), autospec=True) + def test_get_agent_engine_client(self, mock_client): + self.hook.get_credentials = mock.Mock(return_value=mock.sentinel.credentials, spec=()) + + result = self.hook.get_agent_engine_client(project_id=GCP_PROJECT, location=GCP_LOCATION) + + mock_client.assert_called_once_with( + project=GCP_PROJECT, + location=GCP_LOCATION, + credentials=mock.sentinel.credentials, + ) + assert result == mock_client.return_value.agent_engines + + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.get_agent_engine_client"), autospec=True) + def test_create_agent_engine(self, mock_get_client): + result = self.hook.create_agent_engine( + project_id=GCP_PROJECT, + location=GCP_LOCATION, + config=CONFIG, + ) + + mock_get_client.assert_called_once_with(self.hook, project_id=GCP_PROJECT, location=GCP_LOCATION) + mock_get_client.return_value.create.assert_called_once_with( + agent=None, + config=CONFIG, + ) + assert result == mock_get_client.return_value.create.return_value + + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.get_agent_engine_client"), autospec=True) + def test_get_agent_engine(self, mock_get_client): + result = self.hook.get_agent_engine( + project_id=GCP_PROJECT, + location=GCP_LOCATION, + agent_engine_id=AGENT_ENGINE_ID, + ) + + mock_get_client.return_value.get.assert_called_once_with(name=AGENT_ENGINE_NAME) + assert result == mock_get_client.return_value.get.return_value + + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.get_agent_engine_client"), autospec=True) + def test_query_agent_engine(self, mock_get_client): + result = self.hook.query_agent_engine( + project_id=GCP_PROJECT, + location=GCP_LOCATION, + agent_engine_id=AGENT_ENGINE_ID, + config=QUERY_CONFIG, + ) + + mock_get_client.return_value.run_query_job.assert_called_once_with( + name=AGENT_ENGINE_NAME, + config=QUERY_CONFIG, + ) + assert result == mock_get_client.return_value.run_query_job.return_value + + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.get_agent_engine_client"), autospec=True) + def test_check_query_agent_engine_job(self, mock_get_client): + result = self.hook.check_query_agent_engine_job( + project_id=GCP_PROJECT, + location=GCP_LOCATION, + operation_name=QUERY_OPERATION_NAME, + config=CHECK_QUERY_CONFIG, + ) + + mock_get_client.return_value.check_query_job.assert_called_once_with( + name=QUERY_OPERATION_NAME, + config=CHECK_QUERY_CONFIG, + ) + assert result == mock_get_client.return_value.check_query_job.return_value + + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.check_query_agent_engine_job"), autospec=True) + def test_wait_for_query_agent_engine_job_returns_when_successful(self, mock_check_query_job): + mock_check_query_job.return_value.status = "SUCCESS" + + result = self.hook.wait_for_query_agent_engine_job( + project_id=GCP_PROJECT, + location=GCP_LOCATION, + operation_name=QUERY_OPERATION_NAME, + config=CHECK_QUERY_CONFIG, + ) + + mock_check_query_job.assert_called_once_with( + self.hook, + project_id=GCP_PROJECT, + location=GCP_LOCATION, + operation_name=QUERY_OPERATION_NAME, + config=CHECK_QUERY_CONFIG, + ) + assert result == mock_check_query_job.return_value + + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.check_query_agent_engine_job"), autospec=True) + def test_wait_for_query_agent_engine_job_raises_on_failed_status(self, mock_check_query_job): + mock_check_query_job.return_value.status = "FAILED" + + with pytest.raises(RuntimeError, match="Agent Engine query job .* failed"): + self.hook.wait_for_query_agent_engine_job( + project_id=GCP_PROJECT, + location=GCP_LOCATION, + operation_name=QUERY_OPERATION_NAME, + config=CHECK_QUERY_CONFIG, + ) + + @mock.patch(AGENT_ENGINE_STRING.format("time.sleep"), autospec=True) + @mock.patch(AGENT_ENGINE_STRING.format("time.monotonic"), autospec=True) + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.check_query_agent_engine_job"), autospec=True) + def test_wait_for_query_agent_engine_job_times_out( + self, mock_check_query_job, mock_monotonic, mock_sleep + ): + mock_check_query_job.return_value.status = "RUNNING" + mock_monotonic.side_effect = [1, 3] + + with pytest.raises(TimeoutError, match="Timed out waiting for Agent Engine query job"): + self.hook.wait_for_query_agent_engine_job( + project_id=GCP_PROJECT, + location=GCP_LOCATION, + operation_name=QUERY_OPERATION_NAME, + config=CHECK_QUERY_CONFIG, + timeout=1, + ) + + mock_sleep.assert_not_called() + + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.get_agent_engine_client"), autospec=True) + def test_update_agent_engine(self, mock_get_client): + result = self.hook.update_agent_engine( + project_id=GCP_PROJECT, + location=GCP_LOCATION, + agent_engine_id=AGENT_ENGINE_ID, + config=CONFIG, + ) + + mock_get_client.return_value.update.assert_called_once_with( + name=AGENT_ENGINE_NAME, + agent=None, + config=CONFIG, + ) + assert result == mock_get_client.return_value.update.return_value + + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.get_agent_engine_client"), autospec=True) + def test_delete_agent_engine(self, mock_get_client): + result = self.hook.delete_agent_engine( + project_id=GCP_PROJECT, + location=GCP_LOCATION, + agent_engine_id=AGENT_ENGINE_ID, + force=True, + config=CONFIG, + ) + + mock_get_client.return_value.delete.assert_called_once_with( + name=AGENT_ENGINE_NAME, + force=True, + config=CONFIG, + ) + assert result == mock_get_client.return_value.delete.return_value + + @mock.patch(AGENT_ENGINE_STRING.format("google.auth.transport.requests.AuthorizedSession"), autospec=True) + def test_get_agent_engine_operation(self, mock_session): + self.hook.get_credentials = mock.Mock(return_value=mock.sentinel.credentials, spec=()) + mock_session.return_value.get.return_value.json.return_value = {"name": OPERATION_NAME, "done": True} + + result = self.hook.get_agent_engine_operation( + location=GCP_LOCATION, + operation_name=OPERATION_NAME, + ) + + mock_session.assert_called_once_with(mock.sentinel.credentials) + mock_session.return_value.get.assert_called_once_with( + f"https://{GCP_LOCATION}-aiplatform.googleapis.com/v1beta1/{OPERATION_NAME}"; + ) + mock_session.return_value.get.return_value.raise_for_status.assert_called_once_with() + assert result == {"name": OPERATION_NAME, "done": True} + + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.get_agent_engine_operation"), autospec=True) + def test_wait_for_agent_engine_operation_returns_when_done(self, mock_get_operation): + mock_get_operation.return_value = {"name": OPERATION_NAME, "done": True} + + self.hook.wait_for_agent_engine_operation( + location=GCP_LOCATION, + operation_name=OPERATION_NAME, + ) + + mock_get_operation.assert_called_once_with( + self.hook, + location=GCP_LOCATION, + operation_name=OPERATION_NAME, + ) + + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.get_agent_engine_operation"), autospec=True) + def test_wait_for_agent_engine_operation_raises_on_error(self, mock_get_operation): + mock_get_operation.return_value = {"name": OPERATION_NAME, "done": True, "error": {"message": "boom"}} + + with pytest.raises(RuntimeError, match="Agent Engine operation .* failed"): + self.hook.wait_for_agent_engine_operation( + location=GCP_LOCATION, + operation_name=OPERATION_NAME, + ) + + @mock.patch(AGENT_ENGINE_STRING.format("time.sleep"), autospec=True) + @mock.patch(AGENT_ENGINE_STRING.format("time.monotonic"), autospec=True) + @mock.patch(AGENT_ENGINE_STRING.format("AgentEngineHook.get_agent_engine_operation"), autospec=True) + def test_wait_for_agent_engine_operation_times_out(self, mock_get_operation, mock_monotonic, mock_sleep): + mock_get_operation.return_value = {"name": OPERATION_NAME, "done": False} + mock_monotonic.side_effect = [1, 3] + + with pytest.raises(TimeoutError, match="Timed out waiting for Agent Engine operation"): + self.hook.wait_for_agent_engine_operation( + location=GCP_LOCATION, + operation_name=OPERATION_NAME, + timeout=1, + ) + + mock_sleep.assert_not_called() Review Comment: Added a polling test for `wait_for_agent_engine_operation`. It now covers two in-progress operation responses followed by a completed one, and asserts the operation is checked three times and sleeps twice with the configured poll interval -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
