summaryrefslogtreecommitdiffstats
path: root/components/pm-subscription-handler/pmsh_service/mod/exit_handler.py
blob: 3d02375d6b0859886a25319866880b75952c799e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# ============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=====================================================

from mod import logger
from mod.subscription import AdministrativeState


class ExitHandler:
    """ Handles PMSH graceful exit when a SIGTERM signal is received.

    Args:
        periodic_tasks (List[PeriodicTask]): PeriodicTasks that needs to be cancelled.
        subscription_handler (SubscriptionHandler): The subscription handler instance.
    """

    shutdown_signal_received = False

    def __init__(self, *, periodic_tasks, subscription_handler):
        self.periodic_tasks = periodic_tasks
        self.subscription_handler = subscription_handler

    def __call__(self, sig_num, frame):
        logger.info('Graceful shutdown of PMSH initiated.')
        logger.debug(f'ExitHandler was called with signal number: {sig_num}.')
        current_sub = self.subscription_handler.current_sub
        if current_sub and current_sub.administrativeState == AdministrativeState.UNLOCKED.value:
            try:
                for thread in self.periodic_tasks:
                    logger.debug(f'Cancelling periodic task with thread name: {thread.name}.')
                    thread.cancel()
                current_sub.administrativeState = AdministrativeState.LOCKED.value
                current_sub.process_subscription(current_sub.get_network_functions(),
                                                 self.subscription_handler.mr_pub,
                                                 self.subscription_handler.app_conf)
            except Exception as e:
                logger.error(f'Failed to shut down PMSH application: {e}', exc_info=True)
        ExitHandler.shutdown_signal_received = True