From 341b5bb2347c30344662675936b90b325efe5520 Mon Sep 17 00:00:00 2001
From: Vijay Venkatesh Kumar <vv770d@att.com>
Date: Thu, 17 Nov 2022 14:51:38 -0500
Subject: Heartbeat code refactoring

code optimization & test improvement

Issue-ID: DCAEGEN2-2953
Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com>
Change-Id: I99229d966c13ad666ac994ab5a582aeeaa306639
Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com>
---
 miss_htbt_service/mod/htbt_exit.py | 89 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)
 create mode 100644 miss_htbt_service/mod/htbt_exit.py

(limited to 'miss_htbt_service/mod/htbt_exit.py')

diff --git a/miss_htbt_service/mod/htbt_exit.py b/miss_htbt_service/mod/htbt_exit.py
new file mode 100644
index 0000000..3779e15
--- /dev/null
+++ b/miss_htbt_service/mod/htbt_exit.py
@@ -0,0 +1,89 @@
+# ============LICENSE_START=======================================================
+# Copyright (c) 2017-2023 AT&T Intellectual Property. All rights reserved.
+# Copyright (c) 2019 Pantheon.tech. All rights reserved.
+# Copyright (c) 2020 Deutsche Telekom. All rights reserved.
+# ================================================================================
+# 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.
+# ============LICENSE_END=========================================================
+
+"""
+htbt_exit is responsible for removing any existing runtime PID
+file, and exiting with the provided (param 1) exit code
+"""
+
+__docformat__ = "restructuredtext"
+
+import sys
+import os
+from mod.htbt_runtime_pid import rm_pid
+
+prog_name = os.path.basename(__file__)
+
+
+# # # # # # # # # # # # #
+# fx: cleanup_and_exit
+#      - remove pid file
+#      - exit with supplied return code
+# # # # # # # # # # # # #
+def cleanup_and_exit(_loc_exit_code, _pid_file_name):
+    """
+    Remove existing PID file, and exit with provided exit code
+    :Parameters:
+      _loc_exit_code
+        value to return to calling shell upon exit
+      _pid_file_name
+        name of file that contains current process ID (for
+        removal)
+    :Exceptions:
+      none
+    :Keywords:
+      runtime PID exit
+    :Variables:
+      _num_params
+        number of parameters passed to module
+    """
+
+    # _num_params = len(locals())
+
+    if _pid_file_name is not None:
+        rm_pid(_pid_file_name)
+    sys.exit(_loc_exit_code)
+
+
+# # # # # # # # # # # # #
+# fx: cleanup_and_exit
+#      - remove pid file
+#      - exit with supplied return code
+# # # # # # # # # # # # #
+def cleanup(_loc_exit_code, _pid_file_name):
+    """
+    Remove existing PID file, and exit with provided exit code
+    :Parameters:
+      _loc_exit_code
+        value to return to calling shell upon exit
+      _pid_file_name
+        name of file that contains current process ID (for
+        removal)
+    :Exceptions:
+      none
+    :Keywords:
+      runtime PID exit
+    :Variables:
+      _num_params
+        number of parameters passed to module
+    """
+
+    # _num_params = len(locals())
+
+    if _pid_file_name is not None:
+        rm_pid(_pid_file_name)
-- 
cgit 1.2.3-korg