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
33 # get path to salomeTools sources
34 satdir = os.path.dirname(os.path.realpath(__file__))
35 cmdsdir = os.path.join(satdir, 'commands')
37 # Make the src package accessible from all code
38 sys.path.append(satdir)
39 sys.path.append(cmdsdir)
43 # load resources for internationalization
44 #es = gettext.translation('salomeTools', os.path.join(satdir, 'src', 'i18n'))
46 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))
48 # The possible hooks :
49 # pre is for hooks to be executed before commands
50 # post is for hooks to be executed after commands
54 def find_command_list(dirPath):
55 ''' Parse files in dirPath that end with .py : it gives commands list
57 :param dirPath str: The directory path where to search the commands
58 :return: cmd_list : the list containing the commands name
62 for item in os.listdir(dirPath):
63 if item.endswith('.py'):
64 cmd_list.append(item[:-len('.py')])
67 # The list of valid salomeTools commands
68 #lCommand = ['config', 'compile', 'prepare']
69 lCommand = find_command_list(cmdsdir)
71 # Define all possible option for salomeTools command : sat <option> <args>
72 parser = src.options.Options()
73 parser.add_option('h', 'help', 'boolean', 'help',
74 _("shows global help or help on a specific command."))
75 parser.add_option('o', 'overwrite', 'list', "overwrite",
76 _("overwrites a configuration parameters."))
77 parser.add_option('g', 'debug', 'boolean', 'debug_mode',
78 _("run salomeTools in debug mode."))
79 parser.add_option('v', 'verbose', 'int', "output_verbose_level",
80 _("change output verbose level (default is 3)."))
81 parser.add_option('b', 'batch', 'boolean', "batch",
82 _("batch mode (no question)."))
83 parser.add_option('t', 'all_in_terminal', 'boolean', "all_in_terminal",
84 _("All traces in the terminal (for example compilation logs)."))
85 parser.add_option('l', 'logs_paths_in_file', 'string', "logs_paths_in_file",
86 _("Put the command result and paths to log files in ."))
89 '''The main class that stores all the commands of salomeTools
91 def __init__(self, opt='', datadir=None):
94 :param opt str: The sat options
95 :param: datadir str : the directory that contain all the external
96 data (like software pyconf and software scripts)
98 # Read the salomeTools options (the list of possible options is
99 # at the beginning of this file)
101 (options, argus) = parser.parse_args(opt.split(' '))
102 except Exception as exc:
106 # initialization of class attributes
107 self.__dict__ = dict()
108 self.cfg = None # the config that will be read using pyconf module
110 self.options = options # the options passed to salomeTools
111 self.datadir = datadir # default value will be <salomeTools root>/data
112 # set the commands by calling the dedicated function
113 self._setCommands(cmdsdir)
115 # if the help option has been called, print help and exit
118 self.print_help(argus)
120 except Exception as exc:
124 def __getattr__(self, name):
125 ''' overwrite of __getattr__ function in order to display
126 a customized message in case of a wrong call
128 :param name str: The name of the attribute
130 if name in self.__dict__:
131 return self.__dict__[name]
133 raise AttributeError(name + _(" is not a valid command"))
135 def _setCommands(self, dirPath):
136 '''set class attributes corresponding to all commands that are
137 in the dirPath directory
139 :param dirPath str: The directory path containing the commands
141 # loop on the commands name
142 for nameCmd in lCommand:
144 # Exception for the jobs command that requires the paramiko module
145 if nameCmd == "jobs":
148 ff = tempfile.TemporaryFile()
156 # load the module that has name nameCmd in dirPath
157 (file_, pathname, description) = imp.find_module(nameCmd, [dirPath])
158 module = imp.load_module(nameCmd, file_, pathname, description)
160 def run_command(args='', batch = False, verbose = -1, logger_add_link = None):
161 '''The function that will load the configuration (all pyconf)
162 and return the function run of the command corresponding to module
164 :param args str: The directory path containing the commands
166 # Make sure the internationalization is available
167 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))
169 # Get the arguments in a list and remove the empty elements
170 argv_0 = args.split(" ")
172 while "" in argv_0: argv_0.remove("")
174 # Format the argv list in order to prevent strings
175 # that contain a blank to be separated
179 if argv == [] or elem_old.startswith("-") or elem.startswith("-"):
182 argv[-1] += " " + elem
185 # if it is provided by the command line, get the application
187 if argv != [''] and argv[0][0] != "-":
188 appliToLoad = argv[0].rstrip('*')
191 # read the configuration from all the pyconf files
192 cfgManager = config.ConfigManager()
193 self.cfg = cfgManager.get_config(datadir=self.datadir,
194 application=appliToLoad,
195 options=self.options,
198 # Set the verbose mode if called
200 verbose_save = self.options.output_verbose_level
201 self.options.__setattr__("output_verbose_level", verbose)
203 # Set batch mode if called
205 batch_save = self.options.batch
206 self.options.__setattr__("batch", True)
209 if self.options.output_verbose_level is not None:
210 self.cfg.USER.output_verbose_level = self.options.output_verbose_level
211 if self.cfg.USER.output_verbose_level < 1:
212 self.cfg.USER.output_verbose_level = 0
213 silent = (self.cfg.USER.output_verbose_level == 0)
216 micro_command = False
219 logger_command = src.logger.Logger(self.cfg,
220 silent_sysstd=silent,
221 all_in_terminal=self.options.all_in_terminal,
222 micro_command=micro_command)
224 # Check that the path given by the logs_paths_in_file option
225 # is a file path that can be written
226 if self.options.logs_paths_in_file:
228 self.options.logs_paths_in_file = os.path.abspath(
229 self.options.logs_paths_in_file)
230 dir_file = os.path.dirname(self.options.logs_paths_in_file)
231 if not os.path.exists(dir_file):
232 os.makedirs(dir_file)
233 if os.path.exists(self.options.logs_paths_in_file):
234 os.remove(self.options.logs_paths_in_file)
235 file_test = open(self.options.logs_paths_in_file, "w")
237 except Exception as e:
238 msg = _("WARNING: the logs_paths_in_file option will "
239 "not be taken into account.\nHere is the error:")
240 logger_command.write("%s\n%s\n\n" % (src.printcolors.printcWarning(msg), str(e)))
241 self.options.logs_paths_in_file = None
245 # Execute the hooks (if there is any)
246 # and run method of the command
247 self.run_hook(__nameCmd__, C_PRE_HOOK, logger_command)
248 res = __module__.run(argv, self, logger_command)
249 self.run_hook(__nameCmd__, C_POST_HOOK, logger_command)
251 # set res if it is not set in the command
255 # come back in the original batch mode if
256 # batch argument was called
258 self.options.__setattr__("batch", batch_save)
260 # come back in the original verbose mode if
261 # verbose argument was called
263 self.options.__setattr__("output_verbose_level",
265 # put final attributes in xml log file
266 # (end time, total time, ...) and write it
267 launchedCommand = ' '.join([self.cfg.VARS.salometoolsway +
272 launchedCommand = launchedCommand.replace('"', "'")
274 # Add a link to the parent command
275 if logger_add_link is not None:
276 logger_add_link.add_link(logger_command.logFileName,
280 logger_add_link.l_logFiles += logger_command.l_logFiles
283 launchedCommand = ' '.join([self.cfg.VARS.salometoolsway +
288 launchedCommand = launchedCommand.replace('"', "'")
290 # Put the final attributes corresponding to end time and
291 # Write the file to the hard drive
292 logger_command.end_write(
293 {"launchedCommand" : launchedCommand})
297 # If the logs_paths_in_file was called, write the result
298 # and log files in the given file path
299 if self.options.logs_paths_in_file:
300 file_res = open(self.options.logs_paths_in_file, "w")
301 file_res.write(str(res) + "\n")
302 for i, filepath in enumerate(logger_command.l_logFiles):
303 file_res.write(filepath)
304 if i < len(logger_command.l_logFiles):
309 # Make sure that run_command will be redefined
310 # at each iteration of the loop
312 globals_up.update(run_command.__globals__)
313 globals_up.update({'__nameCmd__': nameCmd, '__module__' : module})
314 func = types.FunctionType(run_command.__code__,
316 run_command.__name__,
317 run_command.__defaults__,
318 run_command.__closure__)
320 # set the attribute corresponding to the command
321 self.__setattr__(nameCmd, func)
323 def run_hook(self, cmd_name, hook_type, logger):
324 '''Execute a hook file for a given command regarding the fact
327 :param cmd_name str: The the command on which execute the hook
328 :param hook_type str: pre or post
329 :param logger Logger: the logging instance to use for the prints
331 # The hooks must be defined in the application pyconf
332 # So, if there is no application, do not do anything
333 if not src.config_has_application(self.cfg):
336 # The hooks must be defined in the application pyconf in the
337 # APPLICATION section, hook : { command : 'script_path.py'}
338 if "hook" not in self.cfg.APPLICATION \
339 or cmd_name not in self.cfg.APPLICATION.hook:
342 # Get the hook_script path and verify that it exists
343 hook_script_path = self.cfg.APPLICATION.hook[cmd_name]
344 if not os.path.exists(hook_script_path):
345 raise src.SatException(_("Hook script not found: %s") %
348 # Try to execute the script, catch the exception if it fails
350 # import the module (in the sense of python)
351 pymodule = imp.load_source(cmd_name, hook_script_path)
353 # format a message to be printed at hook execution
354 msg = src.printcolors.printcWarning(_("Run hook script"))
355 msg = "%s: %s\n" % (msg,
356 src.printcolors.printcInfo(hook_script_path))
358 # run the function run_pre_hook if this function is called
359 # before the command, run_post_hook if it is called after
360 if hook_type == C_PRE_HOOK and "run_pre_hook" in dir(pymodule):
362 pymodule.run_pre_hook(self.cfg, logger)
363 elif hook_type == C_POST_HOOK and "run_post_hook" in dir(pymodule):
365 pymodule.run_post_hook(self.cfg, logger)
367 except Exception as exc:
368 msg = _("Unable to run hook script: %s") % hook_script_path
369 msg += "\n" + str(exc)
370 raise src.SatException(msg)
372 def print_help(self, opt):
373 '''Prints help for a command. Function called when "sat -h <command>"
375 :param argv str: the options passed (to get the command name)
377 # if no command as argument (sat -h)
383 # read the configuration from all the pyconf files
384 cfgManager = config.ConfigManager()
385 self.cfg = cfgManager.get_config(datadir=self.datadir)
387 # Check if this command exists
388 if not hasattr(self, command):
389 raise src.SatException(_("Command '%s' does not exist") % command)
391 # Print salomeTools version
395 module = self.get_module(command)
397 # print the description of the command that is done in the command file
398 if hasattr( module, "description" ) :
399 print(src.printcolors.printcHeader( _("Description:") ))
400 print(module.description() + '\n')
402 # print the description of the command options
403 if hasattr( module, "parser" ) :
404 module.parser.print_help()
406 def get_module(self, module):
407 '''Loads a command. Function called only by print_help
409 :param module str: the command to load
411 # Check if this command exists
412 if not hasattr(self, module):
413 raise src.SatException(_("Command '%s' does not exist") % module)
416 (file_, pathname, description) = imp.find_module(module, [cmdsdir])
417 module = imp.load_module(module, file_, pathname, description)
421 '''prints salomeTools version (in src/internal_config/salomeTools.pyconf)
424 cfgManager = config.ConfigManager()
425 cfg = cfgManager.get_config()
426 # print the key corresponding to salomeTools version
427 print(src.printcolors.printcHeader( _("Version: ") ) +
428 cfg.INTERNAL.sat_version + '\n')
432 '''prints salomeTools general help
434 :param options str: the options
438 print(src.printcolors.printcHeader( _("Usage: ") ) +
439 "sat [sat_options] <command> [product] [command_options]\n")
443 # display all the available commands.
444 print(src.printcolors.printcHeader(_("Available commands are:\n")))
445 for command in lCommand:
446 print(" - %s" % (command))
448 # Explain how to get the help for a specific command
449 print(src.printcolors.printcHeader(_("\nGetting the help for a specific"
450 " command: ")) + "sat --help <command>\n")
452 def write_exception(exc):
453 '''write exception in case of error in a command
455 :param exc exception: the exception to print
457 sys.stderr.write("\n***** ")
458 sys.stderr.write(src.printcolors.printcError("salomeTools ERROR:"))
459 sys.stderr.write("\n" + str(exc) + "\n")
461 # ###############################
462 # MAIN : terminal command usage #
463 # ###############################
464 if __name__ == "__main__":
465 # Initialize the code that will be returned by the terminal command
467 (options, args) = parser.parse_args(sys.argv[1:])
469 # no arguments : print general help
474 # instantiate the salomeTools class with correct options
475 sat = Sat(' '.join(sys.argv[1:]))
478 # get dynamically the command function to call
479 fun_command = sat.__getattr__(command)
480 # call the command with two cases : mode debug or not
481 if options.debug_mode:
482 # call classically the command and if it fails,
483 # show exception and stack (usual python mode)
484 code = fun_command(' '.join(args[1:]))
486 # catch exception in order to show less verbose but elegant message
488 code = fun_command(' '.join(args[1:]))
489 except Exception as exc:
493 # exit salomeTools with the right code (0 if no errors, else 1)
494 if code is None: code = 0