fix handle event tests

Author: hallvictoria

azure_functions_worker_v2/azure_functions_worker_v2/handle_event.py

@@ -52,7 +52,6 @@
 from .utils.validators import validate_script_file_name
 
 _metadata_result: Optional[List] = None
-_metadata_exception: Optional[Exception] = None
 _functions: MutableMapping[str, FunctionInfo] = Registry()
 _function_data_cache_enabled: bool = False
 _host: str = ""
@@ -62,7 +61,7 @@
 async def worker_init_request(request):
     logger.debug("V2 Library Worker: received WorkerInitRequest,"
                  "Version %s", VERSION)
-    global _host, protos, _function_data_cache_enabled, _metadata_exception
+    global _host, protos, _function_data_cache_enabled
     init_request = request.request.worker_init_request
     host_capabilities = init_request.capabilities
     _host = request.properties.get("host")
@@ -295,7 +294,7 @@ async def function_environment_reload_request(request):
     """
     logger.debug("V2 Library Worker: received WorkerEnvReloadRequest,"
                  "Version %s", VERSION)
-    global _host, protos, _metadata_exception
+    global _host, protos
     try:
 
         func_env_reload_request = \
@@ -376,31 +375,30 @@ def load_function_metadata(function_app_directory, caller_info):
     global protos, _metadata_result
     """
     This method is called to index the functions in the function app
-    directory and save the results in function_metadata_result or
-    function_metadata_exception in case of an exception.
+    directory and save the results in function_metadata_result.
+
+    If an exception occurs during the indexing, it will be caught
+    in the worker_init_request and returned as a failure
+    status result.
     """
-    try:
-        script_file_name = get_app_setting(
-            setting=PYTHON_SCRIPT_FILE_NAME,
-            default_value=PYTHON_SCRIPT_FILE_NAME_DEFAULT)
-
-        logger.debug(
-            'Received load_function_metadata request from %s, '
-            'script_file_name: %s',
-            caller_info, script_file_name)
-
-        validate_script_file_name(script_file_name)
-        function_path = os.path.join(function_app_directory,
-                                     script_file_name)
-
-        # For V1, the function path will not exist and
-        # return None.
-        global _metadata_result
-        _metadata_result = (index_functions(function_path, function_app_directory)) \
-            if os.path.exists(function_path) else None
-    except Exception as ex:
-        global _metadata_exception
-        _metadata_exception = ex
+    script_file_name = get_app_setting(
+        setting=PYTHON_SCRIPT_FILE_NAME,
+        default_value=PYTHON_SCRIPT_FILE_NAME_DEFAULT)
+
+    logger.debug(
+        'Received load_function_metadata request from %s, '
+        'script_file_name: %s',
+        caller_info, script_file_name)
+
+    validate_script_file_name(script_file_name)
+    function_path = os.path.join(function_app_directory,
+                                 script_file_name)
+
+    # For V1, the function path will not exist and
+    # return None.
+    global _metadata_result
+    _metadata_result = (index_functions(function_path, function_app_directory)) \
+        if os.path.exists(function_path) else None
 
 
 def index_functions(function_path: str, function_dir: str):

azure_functions_worker_v2/tests/unittests/test_handle_event.py

@@ -20,14 +20,16 @@
 
 
 class TestHandleEvent(testutils.AsyncTestCase):
-    async def test_worker_init_request(self):
+    @patch("azure_functions_worker_v2.handle_event.index_function_app")
+    async def test_worker_init_request(self, mock_index_function_app):
         worker_request = WorkerRequest(name='worker_init_request',
                                        request=Request(FunctionRequest(
                                            'hello',
                                            BASIC_FUNCTION_DIRECTORY)),
                                        properties={'host': '123',
                                                    'protos': test_protos})
         result = await worker_init_request(worker_request)
+        mock_index_function_app.assert_called_once()
         self.assertEqual(result.capabilities, {'WorkerStatus': 'true',
                                                'RpcHttpBodyOnly': 'true',
                                                'SharedMemoryDataTransfer': 'true',
@@ -44,16 +46,19 @@ async def test_worker_init_request(self):
            return_value=True)
     @patch("azure_functions_worker_v2.handle_event.initialize_http_server",
            return_value="http://mock_address")
+    @patch("azure_functions_worker_v2.handle_event.index_function_app")
     async def test_worker_init_request_with_streaming(self,
                                                       mock_http_v2_enabled,
-                                                      mock_initialize_http_server):
+                                                      mock_initialize_http_server,
+                                                      mock_index_function_app):
         worker_request = WorkerRequest(name='worker_init_request',
                                        request=Request(FunctionRequest(
                                            'hello',
                                            STREAMING_FUNCTION_DIRECTORY)),
                                        properties={'host': '123',
                                                    'protos': test_protos})
         result = await worker_init_request(worker_request)
+        mock_index_function_app.assert_called_once()
         self.assertEqual(result.capabilities, {'WorkerStatus': 'true',
                                                'RpcHttpBodyOnly': 'true',
                                                'SharedMemoryDataTransfer': 'true',
@@ -71,14 +76,18 @@ async def test_worker_init_request_with_streaming(self,
     @patch("azure_functions_worker_v2.handle_event"
            ".otel_manager.get_azure_monitor_available",
            return_value=True)
-    async def test_worker_init_request_with_otel(self, mock_otel_enabled):
+    @patch("azure_functions_worker_v2.handle_event.index_function_app")
+    async def test_worker_init_request_with_otel(self,
+                                                 mock_otel_enabled,
+                                                 mock_index_function_app):
         worker_request = WorkerRequest(name='worker_init_request',
                                        request=Request(FunctionRequest(
                                            'hello',
                                            BASIC_FUNCTION_DIRECTORY)),
                                        properties={'host': '123',
                                                    'protos': test_protos})
         result = await worker_init_request(worker_request)
+        mock_index_function_app.assert_called_once()
         self.assertEqual(result.capabilities, {'WorkerStatus': 'true',
                                                'RpcHttpBodyOnly': 'true',
                                                'SharedMemoryDataTransfer': 'true',
@@ -93,8 +102,7 @@ async def test_worker_init_request_with_otel(self, mock_otel_enabled):
         self.assertEqual(result.result.status, 1)
 
     async def test_worker_init_request_with_exception(self):
-        # Even if an exception happens during indexing,
-        # we still return the WorkerInitResponse
+        # If an exception happens during indexing, we return failure
         worker_request = WorkerRequest(name='worker_init_request',
                                        request=Request(FunctionRequest(
                                            'hello',
@@ -112,23 +120,16 @@ async def test_worker_init_request_with_exception(self):
         self.assertIsNotNone(result.worker_metadata.runtime_version)
         self.assertIsNotNone(result.worker_metadata.worker_version)
         self.assertIsNotNone(result.worker_metadata.worker_bitness)
-        self.assertEqual(result.result.status, 1)
+        self.assertEqual(result.result.status, 0)
 
     async def test_functions_metadata_request(self):
+        # We always succeed in metadata request - exceptions are raised
+        # in init
         handle_event.protos = test_protos
-        handle_event._metadata_exception = None
         metadata_result = await functions_metadata_request(None)
         self.assertEqual(metadata_result.result.status, 1)
 
-    async def test_functions_metadata_request_with_exception(self):
-        handle_event.protos = test_protos
-        handle_event._metadata_exception = Exception
-        metadata_result = await functions_metadata_request(None)
-        self.assertEqual(metadata_result.result.status, 0)
-        handle_event._metadata_exception = None
-
-    @patch("azure_functions_worker_v2.loader.index_function_app",
-           return_value=True)
+    @patch("azure_functions_worker_v2.handle_event.index_function_app")
     async def test_function_environment_reload_request(self, mock_index_function_app):
         worker_request = WorkerRequest(name='function_environment_reload_request',
                                        request=Request(FunctionRequest(
@@ -138,6 +139,7 @@ async def test_function_environment_reload_request(self, mock_index_function_app
                                                    'protos': test_protos})
         handle_event.protos = test_protos
         result = await function_environment_reload_request(worker_request)
+        mock_index_function_app.assert_called_once()
         self.assertEqual(result.capabilities, {})
         self.assertEqual(result.worker_metadata.runtime_name, "python")
         self.assertIsNotNone(result.worker_metadata.runtime_version)
@@ -149,10 +151,12 @@ async def test_function_environment_reload_request(self, mock_index_function_app
            return_value=True)
     @patch("azure_functions_worker_v2.handle_event.initialize_http_server",
            return_value="http://mock_address")
+    @patch("azure_functions_worker_v2.handle_event.index_function_app")
     async def test_function_environment_reload_request_with_streaming(
             self,
             mock_http_v2_enabled,
-            mock_initialize_http_server):
+            mock_initialize_http_server,
+            mock_index_function_app):
         handle_event.protos = test_protos
         worker_request = WorkerRequest(name='function_environment_reload_request',
                                        request=Request(FunctionRequest(
@@ -161,6 +165,7 @@ async def test_function_environment_reload_request_with_streaming(
                                        properties={'host': '123',
                                                    'protos': test_protos})
         result = await function_environment_reload_request(worker_request)
+        mock_index_function_app.assert_called_once()
         self.assertEqual(result.capabilities, {'HttpUri': 'http://mock_address',
                                                'RequiresRouteParameters': 'true'})
         self.assertEqual(result.worker_metadata.runtime_name, "python")
@@ -172,8 +177,11 @@ async def test_function_environment_reload_request_with_streaming(
     @patch("azure_functions_worker_v2.handle_event"
            ".otel_manager.get_azure_monitor_available",
            return_value=True)
-    async def test_function_environment_reload_request_with_otel(self,
-                                                                 mock_otel_enabled):
+    @patch("azure_functions_worker_v2.handle_event.index_function_app")
+    async def test_function_environment_reload_request_with_otel(
+            self,
+            mock_otel_enabled,
+            mock_index_function_app):
         handle_event.protos = test_protos
         worker_request = WorkerRequest(name='function_environment_reload_request',
                                        request=Request(FunctionRequest(
@@ -182,6 +190,7 @@ async def test_function_environment_reload_request_with_otel(self,
                                        properties={'host': '123',
                                                    'protos': test_protos})
         result = await function_environment_reload_request(worker_request)
+        mock_index_function_app.assert_called_once()
         self.assertEqual(result.capabilities, {'WorkerOpenTelemetryEnabled': 'true'})
         self.assertEqual(result.worker_metadata.runtime_name, "python")
         self.assertIsNotNone(result.worker_metadata.runtime_version)
@@ -190,8 +199,7 @@ async def test_function_environment_reload_request_with_otel(self,
         self.assertEqual(result.result.status, 1)
 
     async def test_function_environment_reload_request_with_exception(self):
-        # Even if an exception happens during indexing,
-        # we still return success
+        # If an exception happens during indexing, the worker reports failure
         handle_event.protos = test_protos
         worker_request = WorkerRequest(name='function_environment_reload_request',
                                        request=Request(FunctionRequest(
@@ -200,9 +208,4 @@ async def test_function_environment_reload_request_with_exception(self):
                                        properties={'host': '123',
                                                    'protos': test_protos})
         result = await function_environment_reload_request(worker_request)
-        self.assertEqual(result.capabilities, {})
-        self.assertEqual(result.worker_metadata.runtime_name, "python")
-        self.assertIsNotNone(result.worker_metadata.runtime_version)
-        self.assertIsNotNone(result.worker_metadata.worker_version)
-        self.assertIsNotNone(result.worker_metadata.worker_bitness)
-        self.assertEqual(result.result.status, 1)
+        self.assertEqual(result.result.status, 0)