Handle graceful exit of PMSH1.0.2

Issue-ID: DCAEGEN2-1832
Change-Id: If0362e1927f7013d25f0cf23ade5ce9d2bdea8e3
Signed-off-by: emartin <ephraim.martin@est.tech>

2 files changed, 91 insertions, 14 deletions

diff --git a/components/pm-subscription-handler/tests/test_exit_handler.py b/components/pm-subscription-handler/tests/test_exit_handler.py
new file mode 100755
index 00000000..0cce1db9
--- /dev/null
+++ b/components/pm-subscription-handler/tests/test_exit_handler.py
@@ -0,0 +1,73 @@
+# ============LICENSE_START===================================================
+#  Copyright (C) 2020 Nordix Foundation.
+# ============================================================================
+# Licensed 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=====================================================
+import os
+import signal
+import threading
+import time
+from unittest import TestCase
+from unittest.mock import patch, Mock, MagicMock
+
+import pmsh_service_main
+from mod.exit_handler import ExitHandler
+from mod.pmsh_utils import PeriodicTask
+from mod.subscription import AdministrativeState
+
+
+class ExitHandlerTests(TestCase):
+
+    @patch('pmsh_service_main.ConfigHandler')
+    @patch('pmsh_service_main.create_app')
+    @patch('pmsh_service_main.db')
+    @patch('pmsh_service_main.aai.get_pmsh_subscription_data')
+    @patch('pmsh_service_main.AppConfig')
+    @patch('pmsh_service_main.Subscription')
+    @patch('pmsh_service_main.launch_api_server')
+    @patch('pmsh_service_main.SubscriptionHandler')
+    @patch.object(PeriodicTask, 'start')
+    @patch.object(PeriodicTask, 'cancel')
+    def test_terminate_signal_success(self, mock_task_cancel, mock_task_start, mock_sub_handler,
+                                      mock_launch_api_server, mock_sub, mock_app_conf, mock_aai,
+                                      mock_db, mock_app, mock_config_handler):
+        pid = os.getpid()
+        mock_aai.return_value = [Mock(), Mock()]
+        mock_db.get_app.return_value = Mock()
+
+        mock_sub.administrativeState = AdministrativeState.UNLOCKED.value
+        mock_sub.process_subscription = Mock()
+        mock_sub_handler_instance = MagicMock(execute=Mock(), current_sub=mock_sub)
+        mock_sub_handler.side_effect = [mock_sub_handler_instance]
+
+        def mock_api_server_run(param):
+            while mock_sub.administrativeState == AdministrativeState.UNLOCKED.value:
+                time.sleep(1)
+
+        mock_launch_api_server.side_effect = mock_api_server_run
+
+        def trigger_signal():
+            time.sleep(1)
+            os.kill(pid, signal.SIGTERM)
+
+        thread = threading.Thread(target=trigger_signal)
+        thread.start()
+
+        pmsh_service_main.main()
+
+        self.assertEqual(3, mock_task_cancel.call_count)
+        self.assertTrue(ExitHandler.shutdown_signal_received)
+        self.assertEqual(1, mock_sub.process_subscription.call_count)
+        self.assertEqual(mock_sub.administrativeState, AdministrativeState.LOCKED.value)
diff --git a/components/pm-subscription-handler/tests/test_subscription_handler.py b/components/pm-subscription-handler/tests/test_subscription_handler.py
index 0eed7c45..168d0366 100644
--- a/components/pm-subscription-handler/tests/test_subscription_handler.py
+++ b/components/pm-subscription-handler/tests/test_subscription_handler.py
@@ -15,14 +15,14 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 # ============LICENSE_END=====================================================
-import os
 import json
+import os
 from unittest import TestCase
 from unittest.mock import patch
 
-from mod.subscription_handler import SubscriptionHandler
-from mod.subscription import AdministrativeState
 from mod.network_function import NetworkFunction
+from mod.subscription import AdministrativeState
+from mod.subscription_handler import SubscriptionHandler
 
 
 class SubscriptionHandlerTest(TestCase):
@@ -30,19 +30,19 @@ class SubscriptionHandlerTest(TestCase):
     @patch('mod.create_app')
     @patch('mod.subscription.Subscription')
     @patch('mod.pmsh_utils._MrPub')
-    @patch('mod.pmsh_utils.PeriodicTask')
     @patch('mod.config_handler.ConfigHandler')
     @patch('mod.pmsh_utils.AppConfig')
-    def setUp(self, mock_app_conf, mock_config_handler, mock_aai_thread, mock_mr_pub,
+    @patch('mod.pmsh_utils.PeriodicTask')
+    def setUp(self, mock_aai_event_thread, mock_app_conf, mock_config_handler, mock_mr_pub,
               mock_sub, mock_app):
         with open(os.path.join(os.path.dirname(__file__), 'data/cbs_data_1.json'), 'r') as data:
             self.cbs_data_1 = json.load(data)
         self.mock_app = mock_app
         self.mock_sub = mock_sub
         self.mock_mr_pub = mock_mr_pub
-        self.mock_aai_thread = mock_aai_thread
         self.mock_config_handler = mock_config_handler
         self.mock_app_conf = mock_app_conf
+        self.mock_aai_event_thread = mock_aai_event_thread
         self.nf_1 = NetworkFunction(nf_name='pnf_1')
         self.nf_2 = NetworkFunction(nf_name='pnf_2')
         self.nfs = [self.nf_1, self.nf_2]
@@ -54,7 +54,8 @@ class SubscriptionHandlerTest(TestCase):
         self.mock_config_handler.get_config.return_value = self.cbs_data_1
         sub_handler = SubscriptionHandler(self.mock_config_handler,
                                           AdministrativeState.UNLOCKED.value, self.mock_mr_pub,
-                                          self.mock_aai_thread, self.mock_app, self.mock_app_conf)
+                                          self.mock_app, self.mock_app_conf,
+                                          self.mock_aai_event_thread)
         sub_handler.execute()
 
         mock_logger.assert_called_with('Administrative State did not change in the Config')
@@ -62,34 +63,36 @@ class SubscriptionHandlerTest(TestCase):
     @patch('mod.aai_client.get_pmsh_subscription_data')
     def test_execute_change_of_state_unlocked(self, mock_get_aai):
         mock_get_aai.return_value = self.mock_sub, self.nfs
-        self.mock_aai_thread.return_value.start.return_value = 'start_method'
+        self.mock_aai_event_thread.return_value.start.return_value = 'start_method'
         self.mock_config_handler.get_config.return_value = self.cbs_data_1
         sub_handler = SubscriptionHandler(self.mock_config_handler,
                                           AdministrativeState.LOCKED.value, self.mock_mr_pub,
-                                          self.mock_aai_thread, self.mock_app, self.mock_app_conf)
+                                          self.mock_app, self.mock_app_conf,
+                                          self.mock_aai_event_thread.return_value)
         sub_handler.execute()
 
         self.assertEqual(AdministrativeState.UNLOCKED.value, sub_handler.administrative_state)
         self.mock_sub.process_subscription.assert_called_with(self.nfs, self.mock_mr_pub,
                                                               self.mock_app_conf)
-        self.mock_aai_thread.start.assert_called()
+        self.mock_aai_event_thread.return_value.start.assert_called()
 
     @patch('mod.aai_client.get_pmsh_subscription_data')
     def test_execute_change_of_state_locked(self, mock_get_aai):
         mock_get_aai.return_value = self.mock_sub, self.nfs
-        self.mock_aai_thread.return_value.cancel.return_value = 'cancel_method'
+        self.mock_aai_event_thread.return_value.cancel.return_value = 'cancel_method'
         self.cbs_data_1['policy']['subscription']['administrativeState'] = \
             AdministrativeState.LOCKED.value
         self.mock_config_handler.get_config.return_value = self.cbs_data_1
         sub_handler = SubscriptionHandler(self.mock_config_handler,
                                           AdministrativeState.UNLOCKED.value, self.mock_mr_pub,
-                                          self.mock_aai_thread, self.mock_app, self.mock_app_conf)
+                                          self.mock_app, self.mock_app_conf,
+                                          self.mock_aai_event_thread.return_value)
         sub_handler.execute()
 
         self.assertEqual(AdministrativeState.LOCKED.value, sub_handler.administrative_state)
         self.mock_sub.process_subscription.assert_called_with(self.nfs, self.mock_mr_pub,
                                                               self.mock_app_conf)
-        self.mock_aai_thread.cancel.assert_called()
+        self.mock_aai_event_thread.return_value.cancel.assert_called()
 
     @patch('mod.pmsh_logging.debug')
     @patch('mod.aai_client.get_pmsh_subscription_data')
@@ -99,7 +102,8 @@ class SubscriptionHandlerTest(TestCase):
         self.mock_sub.process_subscription.side_effect = Exception
         sub_handler = SubscriptionHandler(self.mock_config_handler,
                                           AdministrativeState.LOCKED.value, self.mock_mr_pub,
-                                          self.mock_aai_thread, self.mock_app, self.mock_app_conf)
+                                          self.mock_app, self.mock_app_conf,
+                                          self.mock_aai_event_thread)
         sub_handler.execute()
 
         mock_logger.assert_called_with('Error occurred during the activation/deactivation process ')