blob: e352d55e720ecbe1aefef6c5479d181abc1a71c2 [file] [log] [blame]
George Keishinge7e91712021-09-03 11:28:44 -05001#!/usr/bin/env python3
Michael Walsh21791602018-03-23 16:45:00 -05002
3r"""
4See help text for details (--help or -h option)..
5
6Example properties file content:
7quiet=n
8test_mode=y
9pos=file1 file2 file3
10
11Example call:
12
13prop_call.py --prop_file_name=prop_file my_program
14
15The result is that the following command will be run:
16my_program --test_mode=y --quiet=n file1 file2 file3
17"""
18
George Keishinge635ddc2022-12-08 07:38:02 -060019import sys
20import os
Sridevi Ramesh47375aa2022-12-08 05:05:31 -060021
22save_path_0 = sys.path[0]
23del sys.path[0]
24
George Keishing09679892022-12-08 08:21:52 -060025from gen_arg import * # NOQA
26from gen_print import * # NOQA
27from gen_valid import * # NOQA
28from gen_misc import * # NOQA
29from gen_cmd import * # NOQA
George Keishing37c58c82022-12-08 07:42:54 -060030
Michael Walsh21791602018-03-23 16:45:00 -050031# Restore sys.path[0].
32sys.path.insert(0, save_path_0)
33
34
35parser = argparse.ArgumentParser(
George Keishinge635ddc2022-12-08 07:38:02 -060036 usage='%(prog)s [OPTIONS]',
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -050037 description="%(prog)s will call a program using parameters retrieved"
38 + " from the given properties file.",
Michael Walsh21791602018-03-23 16:45:00 -050039 formatter_class=argparse.ArgumentDefaultsHelpFormatter,
George Keishinge635ddc2022-12-08 07:38:02 -060040 prefix_chars='-+')
Michael Walsh21791602018-03-23 16:45:00 -050041
42parser.add_argument(
George Keishinge635ddc2022-12-08 07:38:02 -060043 '--prop_dir_path',
Michael Walsh21791602018-03-23 16:45:00 -050044 default=os.environ.get("PROP_DIR_PATH", os.getcwd()),
George Keishinge635ddc2022-12-08 07:38:02 -060045 help='The path to the directory that contains the properties file.'
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -050046 + ' The default value is environment variable "PROP_DIR_PATH", if'
George Keishinge635ddc2022-12-08 07:38:02 -060047 + ' set. Otherwise, it is the current working directory.')
Michael Walsh21791602018-03-23 16:45:00 -050048
49parser.add_argument(
George Keishinge635ddc2022-12-08 07:38:02 -060050 '--prop_file_name',
51 help='The path to a properties file that contains the parameters to'
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -050052 + ' pass to the program. If the properties file has a ".properties"'
George Keishinge635ddc2022-12-08 07:38:02 -060053 + ' extension, the caller need not specify the extension. The format'
54 + ' of each line in the properties file should be as follows:'
55 + ' <parm_name=parm_value>. Do not quote the parm value. To specify'
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -050056 + ' positional parms, use a parm name of "pos". For example: pos=this'
George Keishinge635ddc2022-12-08 07:38:02 -060057 ' value')
Michael Walsh21791602018-03-23 16:45:00 -050058
George Keishinge635ddc2022-12-08 07:38:02 -060059parser.add_argument(
60 'program_name',
61 help='The name of the program to be run.')
Michael Walsh21791602018-03-23 16:45:00 -050062
63# Populate stock_list with options we want.
64stock_list = [("test_mode", 0), ("quiet", 1), ("debug", 0)]
65
66
George Keishinge635ddc2022-12-08 07:38:02 -060067def exit_function(signal_number=0,
68 frame=None):
Michael Walsh21791602018-03-23 16:45:00 -050069 r"""
Michael Walsh410b1782019-10-22 15:56:18 -050070 Execute whenever the program ends normally or with the signals that we catch (i.e. TERM, INT).
Michael Walsh21791602018-03-23 16:45:00 -050071 """
72
73 dprint_executing()
74 dprint_var(signal_number)
75
76 qprint_pgm_footer()
77
78
George Keishinge635ddc2022-12-08 07:38:02 -060079def signal_handler(signal_number,
80 frame):
Michael Walsh21791602018-03-23 16:45:00 -050081 r"""
Michael Walsh410b1782019-10-22 15:56:18 -050082 Handle signals. Without a function to catch a SIGTERM or SIGINT, our program would terminate immediately
83 with return code 143 and without calling our exit_function.
Michael Walsh21791602018-03-23 16:45:00 -050084 """
85
Michael Walsh410b1782019-10-22 15:56:18 -050086 # Our convention is to set up exit_function with atexit.register() so there is no need to explicitly
87 # call exit_function from here.
Michael Walsh21791602018-03-23 16:45:00 -050088
89 dprint_executing()
90
Michael Walsh410b1782019-10-22 15:56:18 -050091 # Calling exit prevents us from returning to the code that was running when we received the signal.
Michael Walsh21791602018-03-23 16:45:00 -050092 exit(0)
93
94
95def validate_parms():
Michael Walsh21791602018-03-23 16:45:00 -050096 r"""
Michael Walsh410b1782019-10-22 15:56:18 -050097 Validate program parameters, etc. Return True or False (i.e. pass/fail) accordingly.
Michael Walsh21791602018-03-23 16:45:00 -050098 """
99
100 global prop_dir_path
101 global prop_file_path
102
103 if not valid_dir_path(prop_dir_path):
104 return False
105 prop_dir_path = add_trailing_slash(prop_dir_path)
106
107 if not valid_value(prop_file_name):
108 return False
109
110 prop_file_path = prop_dir_path + prop_file_name
111
112 # If properties file is not found, try adding ".properties" extension.
113 if not os.path.isfile(prop_file_path):
114 alt_prop_file_path = prop_file_path + ".properties"
115 if os.path.isfile(alt_prop_file_path):
116 prop_file_path = alt_prop_file_path
117
118 if not valid_file_path(prop_file_path):
119 return False
120
121 if not valid_value(program_name):
122 return False
123
124 gen_post_validation(exit_function, signal_handler)
125
126 return True
127
128
129def main():
George Keishinge635ddc2022-12-08 07:38:02 -0600130
Michael Walsh21791602018-03-23 16:45:00 -0500131 if not gen_get_options(parser, stock_list):
132 return False
133
134 if not validate_parms():
135 return False
136
137 qprint_pgm_header()
138
139 # Get the parameters from the properties file.
140 properties = my_parm_file(prop_file_path)
141 # The parms (including program name) need to go into a list.
142 parms = [program_name]
143 for key, value in properties.items():
144 if key == "pos":
145 # Process positional parm(s).
146 parms.extend(value.split())
147 else:
148 parms.append("--" + key + "=" + escape_bash_quotes(value))
149
150 # parm_string is only created for display in non-quiet mode.
151 parm_string = " ".join(parms[1:])
152 cmd_buf = program_name + " " + parm_string
153 qprint_issuing(cmd_buf)
154 if not test_mode:
155 os.execvp(program_name, parms)
156
157 return True
158
159
160# Main
161
162if not main():
163 exit(1)