3 # Copyright (C) 2010-2012 CEA/DEN
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2.1 of the License.
10 # This library is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 '''This file is the main entry file to salomeTools
32 # get path to salomeTools sources
33 satdir = os.path.dirname(os.path.realpath(__file__))
34 cmdsdir = os.path.join(satdir, 'commands')
36 # Make the src package accessible from all code
37 sys.path.append(satdir)
38 sys.path.append(cmdsdir)
42 # load resources for internationalization
43 #es = gettext.translation('salomeTools', os.path.join(satdir, 'src', 'i18n'))
45 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))
47 # The possible hooks :
48 # pre is for hooks to be executed before commands
49 # post is for hooks to be executed after commands
53 def find_command_list(dirPath):
54 ''' Parse files in dirPath that end with .py : it gives commands list
56 :param dirPath str: The directory path where to search the commands
57 :return: cmd_list : the list containing the commands name
61 for item in os.listdir(dirPath):
62 if item.endswith('.py'):
63 cmd_list.append(item[:-len('.py')])
66 # The list of valid salomeTools commands
67 #lCommand = ['config', 'compile', 'prepare']
68 lCommand = find_command_list(cmdsdir)
70 # Define all possible option for salomeTools command : sat <option> <args>
71 parser = src.options.Options()
72 parser.add_option('h', 'help', 'boolean', 'help',
73 _("shows global help or help on a specific command."))
74 parser.add_option('o', 'overwrite', 'list', "overwrite",
75 _("overwrites a configuration parameters."))
76 parser.add_option('g', 'debug', 'boolean', 'debug_mode',
77 _("run salomeTools in debug mode."))
78 parser.add_option('v', 'verbose', 'int', "output_verbose_level",
79 _("change output verbose level (default is 3)."))
80 parser.add_option('b', 'batch', 'boolean', "batch",
81 _("batch mode (no question)."))
82 parser.add_option('t', 'all_in_terminal', 'boolean', "all_in_terminal",
83 _("All traces in the terminal (for example compilation logs)."))
84 parser.add_option('l', 'logs_paths_in_file', 'string', "logs_paths_in_file",
85 _("Put the command result and paths to log files in ."))
88 '''The main class that stores all the commands of salomeTools
90 def __init__(self, opt='', datadir=None):
93 :param opt str: The sat options
94 :param: datadir str : the directory that contain all the external
95 data (like software pyconf and software scripts)
97 # Read the salomeTools options (the list of possible options is
98 # at the beginning of this file)
100 (options, argus) = parser.parse_args(opt.split(' '))
101 except Exception as exc:
105 # initialization of class attributes
106 self.__dict__ = dict()
107 self.cfg = None # the config that will be read using pyconf module
109 self.options = options # the options passed to salomeTools
110 self.datadir = datadir # default value will be <salomeTools root>/data
111 # set the commands by calling the dedicated function
112 self._setCommands(cmdsdir)
114 # if the help option has been called, print help and exit
117 self.print_help(argus)
119 except Exception as exc:
123 def __getattr__(self, name):
124 ''' overwrite of __getattr__ function in order to display
125 a customized message in case of a wrong call
127 :param name str: The name of the attribute
129 if name in self.__dict__:
130 return self.__dict__[name]
132 raise AttributeError(name + _(" is not a valid command"))
134 def _setCommands(self, dirPath):
135 '''set class attributes corresponding to all commands that are
136 in the dirPath directory
138 :param dirPath str: The directory path containing the commands
140 # loop on the commands name
141 for nameCmd in lCommand:
143 # Exception for the jobs command that requires the paramiko module
144 if nameCmd == "jobs":
150 # load the module that has name nameCmd in dirPath
151 (file_, pathname, description) = imp.find_module(nameCmd, [dirPath])
152 module = imp.load_module(nameCmd, file_, pathname, description)
154 def run_command(args='', batch = False, verbose = -1, logger_add_link = None):
155 '''The function that will load the configuration (all pyconf)
156 and return the function run of the command corresponding to module
158 :param args str: The directory path containing the commands
160 # Make sure the internationalization is available
161 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))
163 # Get the arguments in a list and remove the empty elements
164 argv_0 = args.split(" ")
166 while "" in argv_0: argv_0.remove("")
168 # Format the argv list in order to prevent strings
169 # that contain a blank to be separated
173 if argv == [] or elem_old.startswith("-") or elem.startswith("-"):
176 argv[-1] += " " + elem
179 # if it is provided by the command line, get the application
181 if argv != [''] and argv[0][0] != "-":
182 appliToLoad = argv[0].rstrip('*')
185 # read the configuration from all the pyconf files
186 cfgManager = config.ConfigManager()
187 self.cfg = cfgManager.get_config(datadir=self.datadir,
188 application=appliToLoad,
189 options=self.options,
192 # Set the verbose mode if called
194 verbose_save = self.options.output_verbose_level
195 self.options.__setattr__("output_verbose_level", verbose)
197 # Set batch mode if called
199 batch_save = self.options.batch
200 self.options.__setattr__("batch", True)
203 if self.options.output_verbose_level is not None:
204 self.cfg.USER.output_verbose_level = self.options.output_verbose_level
205 if self.cfg.USER.output_verbose_level < 1:
206 self.cfg.USER.output_verbose_level = 0
207 silent = (self.cfg.USER.output_verbose_level == 0)
210 logger_command = src.logger.Logger(self.cfg,
211 silent_sysstd=silent,
212 all_in_terminal=self.options.all_in_terminal)
214 # Check that the path given by the logs_paths_in_file option
215 # is a file path that can be written
216 if self.options.logs_paths_in_file:
218 dir_file = os.path.dirname(self.options.logs_paths_in_file)
219 if not os.path.exists(dir_file):
220 os.makedirs(dir_file)
221 if os.path.exists(self.options.logs_paths_in_file):
222 os.remove(self.options.logs_paths_in_file)
223 file_test = open(self.options.logs_paths_in_file, "w")
225 except Exception as e:
226 msg = _("WARNING: the logs_paths_in_file option will "
227 "not be taken into account.\nHere is the error:")
228 logger_command.write("%s\n%s\n\n" % (src.printcolors.printcWarning(msg), str(e)))
229 self.options.logs_paths_in_file = None
233 # Execute the hooks (if there is any)
234 # and run method of the command
235 self.run_hook(__nameCmd__, C_PRE_HOOK, logger_command)
236 res = __module__.run(argv, self, logger_command)
237 self.run_hook(__nameCmd__, C_POST_HOOK, logger_command)
239 # set res if it is not set in the command
243 # come back in the original batch mode if
244 # batch argument was called
246 self.options.__setattr__("batch", batch_save)
248 # come back in the original verbose mode if
249 # verbose argument was called
251 self.options.__setattr__("output_verbose_level",
253 # put final attributes in xml log file
254 # (end time, total time, ...) and write it
255 launchedCommand = ' '.join([self.cfg.VARS.salometoolsway +
260 launchedCommand = launchedCommand.replace('"', "'")
262 # Add a link to the parent command
263 if logger_add_link is not None:
264 logger_add_link.add_link(logger_command.logFileName,
268 logger_add_link.l_logFiles += logger_command.l_logFiles
271 launchedCommand = ' '.join([self.cfg.VARS.salometoolsway +
276 launchedCommand = launchedCommand.replace('"', "'")
278 # Put the final attributes corresponding to end time and
279 # Write the file to the hard drive
280 logger_command.end_write(
281 {"launchedCommand" : launchedCommand})
285 # If the logs_paths_in_file was called, write the result
286 # and log files in the given file path
287 if self.options.logs_paths_in_file:
288 file_res = open(self.options.logs_paths_in_file, "w")
289 file_res.write(str(res) + "\n")
290 for i, filepath in enumerate(logger_command.l_logFiles):
291 file_res.write(filepath)
292 if i < len(logger_command.l_logFiles):
297 # Make sure that run_command will be redefined
298 # at each iteration of the loop
300 globals_up.update(run_command.__globals__)
301 globals_up.update({'__nameCmd__': nameCmd, '__module__' : module})
302 func = types.FunctionType(run_command.__code__,
304 run_command.__name__,
305 run_command.__defaults__,
306 run_command.__closure__)
308 # set the attribute corresponding to the command
309 self.__setattr__(nameCmd, func)
311 def run_hook(self, cmd_name, hook_type, logger):
312 '''Execute a hook file for a given command regarding the fact
315 :param cmd_name str: The the command on which execute the hook
316 :param hook_type str: pre or post
317 :param logger Logger: the logging instance to use for the prints
319 # The hooks must be defined in the application pyconf
320 # So, if there is no application, do not do anything
321 if not src.config_has_application(self.cfg):
324 # The hooks must be defined in the application pyconf in the
325 # APPLICATION section, hook : { command : 'script_path.py'}
326 if "hook" not in self.cfg.APPLICATION \
327 or cmd_name not in self.cfg.APPLICATION.hook:
330 # Get the hook_script path and verify that it exists
331 hook_script_path = self.cfg.APPLICATION.hook[cmd_name]
332 if not os.path.exists(hook_script_path):
333 raise src.SatException(_("Hook script not found: %s") %
336 # Try to execute the script, catch the exception if it fails
338 # import the module (in the sense of python)
339 pymodule = imp.load_source(cmd_name, hook_script_path)
341 # format a message to be printed at hook execution
342 msg = src.printcolors.printcWarning(_("Run hook script"))
343 msg = "%s: %s\n" % (msg,
344 src.printcolors.printcInfo(hook_script_path))
346 # run the function run_pre_hook if this function is called
347 # before the command, run_post_hook if it is called after
348 if hook_type == C_PRE_HOOK and "run_pre_hook" in dir(pymodule):
350 pymodule.run_pre_hook(self.cfg, logger)
351 elif hook_type == C_POST_HOOK and "run_post_hook" in dir(pymodule):
353 pymodule.run_post_hook(self.cfg, logger)
355 except Exception as exc:
356 msg = _("Unable to run hook script: %s") % hook_script_path
357 msg += "\n" + str(exc)
358 raise src.SatException(msg)
360 def print_help(self, opt):
361 '''Prints help for a command. Function called when "sat -h <command>"
363 :param argv str: the options passed (to get the command name)
365 # if no command as argument (sat -h)
371 # read the configuration from all the pyconf files
372 cfgManager = config.ConfigManager()
373 self.cfg = cfgManager.get_config(datadir=self.datadir)
375 # Check if this command exists
376 if not hasattr(self, command):
377 raise src.SatException(_("Command '%s' does not exist") % command)
379 # Print salomeTools version
383 module = self.get_module(command)
385 # print the description of the command that is done in the command file
386 if hasattr( module, "description" ) :
387 print(src.printcolors.printcHeader( _("Description:") ))
388 print(module.description() + '\n')
390 # print the description of the command options
391 if hasattr( module, "parser" ) :
392 module.parser.print_help()
394 def get_module(self, module):
395 '''Loads a command. Function called only by print_help
397 :param module str: the command to load
399 # Check if this command exists
400 if not hasattr(self, module):
401 raise src.SatException(_("Command '%s' does not exist") % module)
404 (file_, pathname, description) = imp.find_module(module, [cmdsdir])
405 module = imp.load_module(module, file_, pathname, description)
409 '''prints salomeTools version (in src/internal_config/salomeTools.pyconf)
412 cfgManager = config.ConfigManager()
413 cfg = cfgManager.get_config()
414 # print the key corresponding to salomeTools version
415 print(src.printcolors.printcHeader( _("Version: ") ) +
416 cfg.INTERNAL.sat_version + '\n')
420 '''prints salomeTools general help
422 :param options str: the options
426 print(src.printcolors.printcHeader( _("Usage: ") ) +
427 "sat [sat_options] <command> [product] [command_options]\n")
431 # display all the available commands.
432 print(src.printcolors.printcHeader(_("Available commands are:\n")))
433 for command in lCommand:
434 print(" - %s" % (command))
436 # Explain how to get the help for a specific command
437 print(src.printcolors.printcHeader(_("\nGetting the help for a specific"
438 " command: ")) + "sat --help <command>\n")
440 def write_exception(exc):
441 '''write exception in case of error in a command
443 :param exc exception: the exception to print
445 sys.stderr.write("\n***** ")
446 sys.stderr.write(src.printcolors.printcError("salomeTools ERROR:"))
447 sys.stderr.write("\n" + str(exc) + "\n")
449 # ###############################
450 # MAIN : terminal command usage #
451 # ###############################
452 if __name__ == "__main__":
453 # Initialize the code that will be returned by the terminal command
455 (options, args) = parser.parse_args(sys.argv[1:])
457 # no arguments : print general help
462 # instantiate the salomeTools class with correct options
463 sat = Sat(' '.join(sys.argv[1:]))
466 # get dynamically the command function to call
467 fun_command = sat.__getattr__(command)
468 # call the command with two cases : mode debug or not
469 if options.debug_mode:
470 # call classically the command and if it fails,
471 # show exception and stack (usual python mode)
472 code = fun_command(' '.join(args[1:]))
474 # catch exception in order to show less verbose but elegant message
476 code = fun_command(' '.join(args[1:]))
477 except Exception as exc:
481 # exit salomeTools with the right code (0 if no errors, else 1)
482 if code is None: code = 0