pankajastro commented on code in PR #24038: URL: https://github.com/apache/airflow/pull/24038#discussion_r887615348
########## tests/providers/microsoft/azure/hooks/test_asb_message.py: ########## @@ -0,0 +1,164 @@ +# 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. + +import json +from unittest import mock + +import pytest +from azure.servicebus import ServiceBusClient, ServiceBusMessage, ServiceBusMessageBatch + +from airflow.models import Connection +from airflow.providers.microsoft.azure.hooks.asb_message import ServiceBusMessageHook + +MESSAGE = "Test Message" +MESSAGE_LIST = [MESSAGE + " " + str(n) for n in range(0, 10)] + + +class TestServiceBusMessageHook: + def setup_class(self) -> None: + self.queue_name: str = "test_queue" + self.conn_id: str = 'azure_service_bus_default' + self.connection_string = ( + "Endpoint=sb://test-service-bus-provider.servicebus.windows.net/;" + "SharedAccessKeyName=Test;SharedAccessKey=1234566acbc" + ) + self.client_id = "test_client_id" + self.secret_key = "test_client_secret" + self.conn = Connection( + conn_id='azure_service_bus_default', + conn_type='azure_service_bus', + login=self.client_id, + password=self.secret_key, + extra=json.dumps({'connection_string': self.connection_string}), + ) + + @mock.patch("airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.get_connection") + def test_get_service_bus_message_conn(self, mock_connection): + """ + Test get_conn() function and check whether the get_conn() function returns value + is instance of ServiceBusClient + """ + mock_connection.return_value = self.conn + hook = ServiceBusMessageHook(azure_service_bus_conn_id=self.conn_id) + assert isinstance(hook.get_conn(), ServiceBusClient) + + @mock.patch("airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.get_connection") + def test_get_conn_value_error(self, mock_connection): + """Test get_conn() function and check whether the get_conn() raise Value error""" + mock_connection.return_value = Connection( + conn_id='azure_service_bus_default', + conn_type='azure_service_bus', + login=self.client_id, + password=self.secret_key, + extra=json.dumps({"connection_string": "test connection"}), + ) + hook = ServiceBusMessageHook(azure_service_bus_conn_id=self.conn_id) + with pytest.raises(ValueError): + hook.get_conn() + + @pytest.mark.parametrize( + "mock_message, mock_batch_flag", + [ + (MESSAGE, True), + (MESSAGE, False), + (MESSAGE_LIST, True), + (MESSAGE_LIST, False), + ], + ) + @mock.patch( + 'airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.send_list_messages' + ) + @mock.patch( + 'airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.send_batch_message' + ) + @mock.patch('airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.get_conn') + def test_send_message( + self, mock_sb_client, mock_batch_message, mock_list_message, mock_message, mock_batch_flag + ): + """ + Test `send_message` hook function with batch flag and message passed as mocked params, + which can be string or list of string, mock the azure service bus `send_messages` function + """ + hook = ServiceBusMessageHook(azure_service_bus_conn_id="azure_service_bus_default") + hook.send_message( + queue_name=self.queue_name, messages=mock_message, batch_message_flag=mock_batch_flag + ) + if isinstance(mock_message, list): + if mock_batch_flag: + message = ServiceBusMessageBatch(mock_message) + else: + message = [ServiceBusMessage(msg) for msg in mock_message] + elif isinstance(mock_message, str): + if mock_batch_flag: + message = ServiceBusMessageBatch(mock_message) + else: + message = ServiceBusMessage(mock_message) + + expected_calls = [ + mock.call() + .__enter__() + .get_queue_sender(self.queue_name) + .__enter__() + .send_messages(message) + .__exit__() + ] + mock_sb_client.assert_has_calls(expected_calls, any_order=False) + + @mock.patch('airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.get_conn') + def test_send_message_exception(self, mock_sb_client): + """ + Test `send_message` functionality to raise AirflowException in Azure ServiceBusMessageHook + by passing queue name as None + """ + hook = ServiceBusMessageHook(azure_service_bus_conn_id=self.conn_id) + with pytest.raises(TypeError): + hook.send_message(queue_name=None, messages="", batch_message_flag=False) + + @mock.patch('azure.servicebus.ServiceBusMessage') + @mock.patch('airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.get_conn') + def test_receive_message(self, mock_sb_client, mock_service_bus_message): + """ + Test `receive_message` hook function and assert the function with mock value, + mock the azure service bus `receive_messages` function + """ + hook = ServiceBusMessageHook(azure_service_bus_conn_id=self.conn_id) + mock_sb_client.return_value.get_queue_receiver.return_value.receive_messages.return_value = [ + mock_service_bus_message + ] + hook.receive_message(self.queue_name) + expected_calls = [ + mock.call() + .__enter__() + .get_queue_receiver(self.queue_name) + .__enter__() + .receive_messages(max_message_count=30, max_wait_time=5) + .get_queue_receiver(self.queue_name) + .__exit__() + .mock_call() + .__exit__ + ] + mock_sb_client.assert_has_calls(expected_calls) + + @mock.patch('airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.get_conn') + def test_receive_message_exception(self, mock_sb_client): + """ + Test `receive_message` functionality to raise AirflowException in Azure ServiceBusMessageHook + by passing queue name as None Review Comment: nit: Delete extra starting space ########## tests/providers/microsoft/azure/hooks/test_asb_message.py: ########## @@ -0,0 +1,164 @@ +# 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. + +import json +from unittest import mock + +import pytest +from azure.servicebus import ServiceBusClient, ServiceBusMessage, ServiceBusMessageBatch + +from airflow.models import Connection +from airflow.providers.microsoft.azure.hooks.asb_message import ServiceBusMessageHook + +MESSAGE = "Test Message" +MESSAGE_LIST = [MESSAGE + " " + str(n) for n in range(0, 10)] + + +class TestServiceBusMessageHook: + def setup_class(self) -> None: + self.queue_name: str = "test_queue" + self.conn_id: str = 'azure_service_bus_default' + self.connection_string = ( + "Endpoint=sb://test-service-bus-provider.servicebus.windows.net/;" + "SharedAccessKeyName=Test;SharedAccessKey=1234566acbc" + ) + self.client_id = "test_client_id" + self.secret_key = "test_client_secret" + self.conn = Connection( + conn_id='azure_service_bus_default', + conn_type='azure_service_bus', + login=self.client_id, + password=self.secret_key, + extra=json.dumps({'connection_string': self.connection_string}), + ) + + @mock.patch("airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.get_connection") + def test_get_service_bus_message_conn(self, mock_connection): + """ + Test get_conn() function and check whether the get_conn() function returns value + is instance of ServiceBusClient + """ + mock_connection.return_value = self.conn + hook = ServiceBusMessageHook(azure_service_bus_conn_id=self.conn_id) + assert isinstance(hook.get_conn(), ServiceBusClient) + + @mock.patch("airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.get_connection") + def test_get_conn_value_error(self, mock_connection): + """Test get_conn() function and check whether the get_conn() raise Value error""" + mock_connection.return_value = Connection( + conn_id='azure_service_bus_default', + conn_type='azure_service_bus', + login=self.client_id, + password=self.secret_key, + extra=json.dumps({"connection_string": "test connection"}), + ) + hook = ServiceBusMessageHook(azure_service_bus_conn_id=self.conn_id) + with pytest.raises(ValueError): + hook.get_conn() + + @pytest.mark.parametrize( + "mock_message, mock_batch_flag", + [ + (MESSAGE, True), + (MESSAGE, False), + (MESSAGE_LIST, True), + (MESSAGE_LIST, False), + ], + ) + @mock.patch( + 'airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.send_list_messages' + ) + @mock.patch( + 'airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.send_batch_message' + ) + @mock.patch('airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.get_conn') + def test_send_message( + self, mock_sb_client, mock_batch_message, mock_list_message, mock_message, mock_batch_flag + ): + """ + Test `send_message` hook function with batch flag and message passed as mocked params, + which can be string or list of string, mock the azure service bus `send_messages` function + """ + hook = ServiceBusMessageHook(azure_service_bus_conn_id="azure_service_bus_default") + hook.send_message( + queue_name=self.queue_name, messages=mock_message, batch_message_flag=mock_batch_flag + ) + if isinstance(mock_message, list): + if mock_batch_flag: + message = ServiceBusMessageBatch(mock_message) + else: + message = [ServiceBusMessage(msg) for msg in mock_message] + elif isinstance(mock_message, str): + if mock_batch_flag: + message = ServiceBusMessageBatch(mock_message) + else: + message = ServiceBusMessage(mock_message) + + expected_calls = [ + mock.call() + .__enter__() + .get_queue_sender(self.queue_name) + .__enter__() + .send_messages(message) + .__exit__() + ] + mock_sb_client.assert_has_calls(expected_calls, any_order=False) + + @mock.patch('airflow.providers.microsoft.azure.hooks.asb_message.ServiceBusMessageHook.get_conn') + def test_send_message_exception(self, mock_sb_client): + """ + Test `send_message` functionality to raise AirflowException in Azure ServiceBusMessageHook + by passing queue name as None Review Comment: nit: Delete extra starting space -- 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]
