blob: 1570faa09ba9d2883eb652888307c1ebefebad35 [file] [log] [blame]
Michael Walsh7423c012016-10-04 10:27:21 -05001#!/usr/bin/env python
2
3r"""
4This module provides functions which are useful for running plug-ins.
5"""
6
7import sys
8import os
9import commands
10import glob
11
12import gen_print as gp
13import gen_misc as gm
14
15# Some help text that is common to more than one program.
16plug_in_dir_paths_help_text = \
17 'This is a colon-separated list of plug-in directory paths. If one' +\
18 ' of the entries in the list is a plain directory name (i.e. no' +\
19 ' path info), it will be taken to be a native plug-in. In that case,' +\
20 ' %(prog)s will search for the native plug-in in the "plug-ins"' +\
21 ' subdirectory of each path in the PATH environment variable until it' +\
22 ' is found. Also, integrated plug-ins will automatically be appended' +\
23 ' to your plug_in_dir_paths list. An integrated plug-in is any plug-in' +\
24 ' found using the PATH variable that contains a file named "integrated".'
25
26mch_class_help_text = \
27 'The class of machine that we are testing (e.g. "op" = "open power",' +\
28 ' "obmc" = "open bmc", etc).'
29
30PATH_LIST = gm.return_path_list()
31
32
33###############################################################################
34def get_plug_in_base_paths():
35
36 r"""
37 Get plug-in base paths and return them as a list.
38
39 This function searches the PATH_LIST (created from PATH environment
40 variable) for any paths that have a "plug_ins" subdirectory. All such
41 paths are considered plug_in_base paths.
42 """
43
44 global PATH_LIST
45
46 plug_in_base_path_list = []
47
48 for path in PATH_LIST:
49 candidate_plug_in_base_path = path + "plug_ins/"
50 if os.path.isdir(candidate_plug_in_base_path):
51 plug_in_base_path_list.append(candidate_plug_in_base_path)
52
53 return plug_in_base_path_list
54
55###############################################################################
56# Define global plug_in_base_path_list and call get_plug_in_base_paths to set
57# its value.
58plug_in_base_path_list = get_plug_in_base_paths()
59
60
61###############################################################################
62def find_plug_in_package(plug_in_name):
63
64 r"""
65 Find and return the normalized directory path of the specified plug in.
66 This is done by searching the global plug_in_base_path_list.
67
68 Description of arguments:
69 plug_in_name The unqualified name of the plug-in
70 package.
71 """
72
73 global plug_in_base_path_list
74 for plug_in_base_dir_path in plug_in_base_path_list:
75 candidate_plug_in_dir_path = os.path.normpath(plug_in_base_dir_path +
76 plug_in_name) + \
Michael Walsh6cd9cbe2017-06-30 16:59:36 -050077 os.sep
Michael Walsh7423c012016-10-04 10:27:21 -050078 if os.path.isdir(candidate_plug_in_dir_path):
79 return candidate_plug_in_dir_path
80
81 return ""
82
83###############################################################################
84
85
86###############################################################################
87def validate_plug_in_package(plug_in_dir_path,
88 mch_class="obmc"):
89
90 r"""
91 Validate the plug in package and return the normalized plug-in directory
92 path.
93
94 Description of arguments:
95 plug_in_dir_path The "relative" or absolute path to a plug
96 in package directory.
97 mch_class The class of machine that we are testing
98 (e.g. "op" = "open power", "obmc" = "open
99 bmc", etc).
100 """
101
102 gp.dprint_executing()
103
104 if os.path.isabs(plug_in_dir_path):
105 # plug_in_dir_path begins with a slash so it is an absolute path.
106 candidate_plug_in_dir_path = os.path.normpath(plug_in_dir_path) +\
Michael Walsh6cd9cbe2017-06-30 16:59:36 -0500107 os.sep
Michael Walsh7423c012016-10-04 10:27:21 -0500108 if not os.path.isdir(candidate_plug_in_dir_path):
109 gp.print_error_report("Plug-in directory path \"" +
110 plug_in_dir_path + "\" does not exist.\n")
111 exit(1)
112 else:
113 # The plug_in_dir_path is actually a simple name (e.g.
114 # "OBMC_Sample")...
115 candidate_plug_in_dir_path = find_plug_in_package(plug_in_dir_path)
116 if candidate_plug_in_dir_path == "":
117 global PATH_LIST
118 gp.print_error_report("Plug-in directory path \"" +
119 plug_in_dir_path + "\" could not be found" +
120 " in any of the following directories:\n" +
121 gp.sprint_var(PATH_LIST))
122 exit(1)
123 # Make sure that this plug-in supports us...
124 supports_file_path = candidate_plug_in_dir_path + "supports_" + mch_class
125 if not os.path.exists(supports_file_path):
126 gp.print_error_report("The following file path could not be" +
127 " found:\n" +
128 gp.sprint_varx("supports_file_path",
129 supports_file_path) +
130 "\nThis file is necessary to indicate that" +
131 " the given plug-in supports the class of" +
132 " machine we are testing, namely \"" +
133 mch_class + "\".\n")
134 exit(1)
135
136 return candidate_plug_in_dir_path
137
138###############################################################################
139
140
141###############################################################################
142def return_integrated_plug_ins(mch_class="obmc"):
143
144 r"""
145 Return a list of integrated plug-ins. Integrated plug-ins are plug-ins
146 which are selected without regard for whether the user has specified them.
147 In other words, they are "integrated" into the program suite. The
148 programmer designates a plug-in as integrated by putting a file named
149 "integrated" into the plug-in package directory.
150
151 Description of arguments:
152 mch_class The class of machine that we are testing
153 (e.g. "op" = "open power", "obmc" = "open
154 bmc", etc).
155 """
156
157 global plug_in_base_path_list
158
159 integrated_plug_ins_list = []
160
Michael Walsh6cd9cbe2017-06-30 16:59:36 -0500161 DEBUG_SKIP_INTEGRATED = int(os.getenv('DEBUG_SKIP_INTEGRATED', '0'))
162
163 if DEBUG_SKIP_INTEGRATED:
164 return integrated_plug_ins_list
165
Michael Walsh7423c012016-10-04 10:27:21 -0500166 for plug_in_base_path in plug_in_base_path_list:
167 # Get a list of all plug-in paths that support our mch_class.
168 mch_class_candidate_list = glob.glob(plug_in_base_path +
169 "*/supports_" + mch_class)
170 for candidate_path in mch_class_candidate_list:
171 integrated_plug_in_dir_path = os.path.dirname(candidate_path) +\
Michael Walsh6cd9cbe2017-06-30 16:59:36 -0500172 os.sep
Michael Walsh7423c012016-10-04 10:27:21 -0500173 integrated_file_path = integrated_plug_in_dir_path + "integrated"
174 if os.path.exists(integrated_file_path):
175 plug_in_name = \
176 os.path.basename(os.path.dirname(candidate_path))
177 if plug_in_name not in integrated_plug_ins_list:
178 # If this plug-in has not already been added to the list...
179 integrated_plug_ins_list.append(plug_in_name)
180
181 return integrated_plug_ins_list
182
183###############################################################################
184
185
186###############################################################################
187def return_plug_in_packages_list(plug_in_dir_paths,
188 mch_class="obmc"):
189
190 r"""
191 Return a list of plug-in packages given the plug_in_dir_paths string.
192 This function calls validate_plug_in_package so it will fail if
193 plug_in_dir_paths contains any invalid plug-ins.
194
195 Description of arguments:
196 plug_in_dir_path The "relative" or absolute path to a plug
197 in package directory.
198 mch_class The class of machine that we are testing
199 (e.g. "op" = "open power", "obmc" = "open
200 bmc", etc).
201 """
202
203 if plug_in_dir_paths != "":
204 plug_in_packages_list = plug_in_dir_paths.split(":")
205 else:
206 plug_in_packages_list = []
207
208 # Get a list of integrated plug-ins (w/o full path names).
209 integrated_plug_ins_list = return_integrated_plug_ins(mch_class)
210 # Put both lists together in plug_in_packages_list with no duplicates.
211 # NOTE: This won't catch duplicates if the caller specifies the full path
212 # name of a native plug-in but that should be rare enough.
213
214 plug_in_packages_list = plug_in_packages_list + integrated_plug_ins_list
215
216 plug_in_packages_list = \
217 list(set([validate_plug_in_package(path, mch_class)
218 for path in plug_in_packages_list]))
219
220 return plug_in_packages_list
221
222###############################################################################