]> SALOME platform Git repositories - tools/sat.git/blob - salomeTools.py
Salome HOME
Do not clean the build directory after a successful compilation
[tools/sat.git] / salomeTools.py
1 #!/usr/bin/env python
2 #-*- coding:utf-8 -*-
3 #  Copyright (C) 2010-2012  CEA/DEN
4 #
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.
9 #
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.
14 #
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
18
19 '''This file is the main entry file to salomeTools
20 '''
21
22 # python imports
23 import os
24 import sys
25 import tempfile
26 import imp
27 import types
28 import gettext
29
30 # salomeTools imports
31 import src
32
33 # get path to salomeTools sources
34 satdir  = os.path.dirname(os.path.realpath(__file__))
35 cmdsdir = os.path.join(satdir, 'commands')
36
37 # Make the src package accessible from all code
38 sys.path.append(satdir)
39 sys.path.append(cmdsdir)
40
41 import config
42
43 # load resources for internationalization
44 #es = gettext.translation('salomeTools', os.path.join(satdir, 'src', 'i18n'))
45 #es.install()
46 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))
47
48 # The possible hooks : 
49 # pre is for hooks to be executed before commands
50 # post is for hooks to be executed after commands
51 C_PRE_HOOK = "pre"
52 C_POST_HOOK = "post"
53
54 def find_command_list(dirPath):
55     ''' Parse files in dirPath that end with .py : it gives commands list
56     
57     :param dirPath str: The directory path where to search the commands
58     :return: cmd_list : the list containing the commands name 
59     :rtype: list
60     '''
61     cmd_list = []
62     for item in os.listdir(dirPath):
63         if item.endswith('.py'):
64             cmd_list.append(item[:-len('.py')])
65     return cmd_list
66
67 # The list of valid salomeTools commands
68 #lCommand = ['config', 'compile', 'prepare']
69 lCommand = find_command_list(cmdsdir)
70
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 ."))
87
88 class Sat(object):
89     '''The main class that stores all the commands of salomeTools
90     '''
91     def __init__(self, opt='', datadir=None):
92         '''Initialization
93         
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)
97         '''
98         # Read the salomeTools options (the list of possible options is 
99         # at the beginning of this file)
100         try:
101             (options, argus) = parser.parse_args(opt.split(' '))
102         except Exception as exc:
103             write_exception(exc)
104             sys.exit(-1)
105
106         # initialization of class attributes       
107         self.__dict__ = dict()
108         self.cfg = None # the config that will be read using pyconf module
109         self.arguments = opt
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)
114         
115         # if the help option has been called, print help and exit
116         if options.help:
117             try:
118                 self.print_help(argus)
119                 sys.exit(0)
120             except Exception as exc:
121                 write_exception(exc)
122                 sys.exit(1)
123
124     def __getattr__(self, name):
125         ''' overwrite of __getattr__ function in order to display 
126             a customized message in case of a wrong call
127         
128         :param name str: The name of the attribute 
129         '''
130         if name in self.__dict__:
131             return self.__dict__[name]
132         else:
133             raise AttributeError(name + _(" is not a valid command"))
134     
135     def _setCommands(self, dirPath):
136         '''set class attributes corresponding to all commands that are 
137            in the dirPath directory
138         
139         :param dirPath str: The directory path containing the commands 
140         '''
141         # loop on the commands name
142         for nameCmd in lCommand:
143             
144             # Exception for the jobs command that requires the paramiko module
145             if nameCmd == "jobs":
146                 try:
147                     saveout = sys.stderr
148                     ff = tempfile.TemporaryFile()
149                     sys.stderr = ff
150                     import paramiko
151                     sys.stderr = saveout
152                 except:
153                     sys.stderr = saveout
154                     continue
155
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)
159             
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
163                 
164                 :param args str: The directory path containing the commands 
165                 '''
166                 # Make sure the internationalization is available
167                 gettext.install('salomeTools', os.path.join(satdir, 'src', 'i18n'))
168                 
169                 # Get the arguments in a list and remove the empty elements
170                 argv_0 = args.split(" ")
171                 if argv_0 != ['']:
172                     while "" in argv_0: argv_0.remove("")
173                 
174                 # Format the argv list in order to prevent strings 
175                 # that contain a blank to be separated
176                 argv = []
177                 elem_old = ""
178                 for elem in argv_0:
179                     if argv == [] or elem_old.startswith("-") or elem.startswith("-"):
180                         argv.append(elem)
181                     else:
182                         argv[-1] += " " + elem
183                     elem_old = elem
184                            
185                 # if it is provided by the command line, get the application
186                 appliToLoad = None
187                 if argv != [''] and argv[0][0] != "-":
188                     appliToLoad = argv[0].rstrip('*')
189                     argv = argv[1:]
190    
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, 
196                                                  command=__nameCmd__)
197                 
198                 # Set the verbose mode if called
199                 if verbose > -1:
200                     verbose_save = self.options.output_verbose_level
201                     self.options.__setattr__("output_verbose_level", verbose)    
202
203                 # Set batch mode if called
204                 if batch:
205                     batch_save = self.options.batch
206                     self.options.__setattr__("batch", True)
207
208                 # set output level
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)
214
215                 # create log file
216                 micro_command = False
217                 if logger_add_link:
218                     micro_command = True
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)
223                 
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 and not micro_command:
227                     try:
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")
236                         file_test.close()
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" % (
241                                              src.printcolors.printcWarning(msg),
242                                              str(e)))
243                         self.options.logs_paths_in_file = None
244                 
245                 try:
246                     res = None
247                     # Execute the hooks (if there is any) 
248                     # and run method of the command
249                     self.run_hook(__nameCmd__, C_PRE_HOOK, logger_command)
250                     res = __module__.run(argv, self, logger_command)
251                     self.run_hook(__nameCmd__, C_POST_HOOK, logger_command)
252                     
253                     # set res if it is not set in the command
254                     if res is None:
255                         res = 0
256                     
257                     # come back in the original batch mode if 
258                     # batch argument was called
259                     if batch:
260                         self.options.__setattr__("batch", batch_save)
261
262                     # come back in the original verbose mode if 
263                     # verbose argument was called                        
264                     if verbose > -1:
265                         self.options.__setattr__("output_verbose_level", 
266                                                  verbose_save)
267                     # put final attributes in xml log file 
268                     # (end time, total time, ...) and write it
269                     launchedCommand = ' '.join([self.cfg.VARS.salometoolsway +
270                                                 os.path.sep +
271                                                 'sat',
272                                                 __nameCmd__, 
273                                                 args])
274                     launchedCommand = launchedCommand.replace('"', "'")
275                     
276                     # Add a link to the parent command      
277                     if logger_add_link is not None:
278                         logger_add_link.add_link(logger_command.logFileName,
279                                                  __nameCmd__,
280                                                  res,
281                                                  launchedCommand)
282                         logger_add_link.l_logFiles += logger_command.l_logFiles
283
284                 finally:
285                     launchedCommand = ' '.join([self.cfg.VARS.salometoolsway +
286                                                 os.path.sep +
287                                                 'sat',
288                                                 __nameCmd__, 
289                                                 args])
290                     launchedCommand = launchedCommand.replace('"', "'")
291                     
292                     # Put the final attributes corresponding to end time and
293                     # Write the file to the hard drive
294                     logger_command.end_write(
295                                         {"launchedCommand" : launchedCommand})
296                     
297                     if res != 0:
298                         res = 1
299                     # If the logs_paths_in_file was called, write the result
300                     # and log files in the given file path
301                     if self.options.logs_paths_in_file and not micro_command:
302                         file_res = open(self.options.logs_paths_in_file, "w")
303                         file_res.write(str(res) + "\n")
304                         for i, filepath in enumerate(logger_command.l_logFiles):
305                             file_res.write(filepath)
306                             if i < len(logger_command.l_logFiles):
307                                 file_res.write("\n")
308                                 file_res.flush()
309                 
310                 return res
311
312             # Make sure that run_command will be redefined 
313             # at each iteration of the loop
314             globals_up = {}
315             globals_up.update(run_command.__globals__)
316             globals_up.update({'__nameCmd__': nameCmd, '__module__' : module})
317             func = types.FunctionType(run_command.__code__,
318                                       globals_up,
319                                       run_command.__name__,
320                                       run_command.__defaults__,
321                                       run_command.__closure__)
322
323             # set the attribute corresponding to the command
324             self.__setattr__(nameCmd, func)
325
326     def run_hook(self, cmd_name, hook_type, logger):
327         '''Execute a hook file for a given command regarding the fact 
328            it is pre or post
329         
330         :param cmd_name str: The the command on which execute the hook
331         :param hook_type str: pre or post
332         :param logger Logger: the logging instance to use for the prints
333         '''
334         # The hooks must be defined in the application pyconf
335         # So, if there is no application, do not do anything
336         if not src.config_has_application(self.cfg):
337             return
338
339         # The hooks must be defined in the application pyconf in the
340         # APPLICATION section, hook : { command : 'script_path.py'}
341         if "hook" not in self.cfg.APPLICATION \
342                     or cmd_name not in self.cfg.APPLICATION.hook:
343             return
344
345         # Get the hook_script path and verify that it exists
346         hook_script_path = self.cfg.APPLICATION.hook[cmd_name]
347         if not os.path.exists(hook_script_path):
348             raise src.SatException(_("Hook script not found: %s") % 
349                                    hook_script_path)
350         
351         # Try to execute the script, catch the exception if it fails
352         try:
353             # import the module (in the sense of python)
354             pymodule = imp.load_source(cmd_name, hook_script_path)
355             
356             # format a message to be printed at hook execution
357             msg = src.printcolors.printcWarning(_("Run hook script"))
358             msg = "%s: %s\n" % (msg, 
359                                 src.printcolors.printcInfo(hook_script_path))
360             
361             # run the function run_pre_hook if this function is called 
362             # before the command, run_post_hook if it is called after
363             if hook_type == C_PRE_HOOK and "run_pre_hook" in dir(pymodule):
364                 logger.write(msg, 1)
365                 pymodule.run_pre_hook(self.cfg, logger)
366             elif hook_type == C_POST_HOOK and "run_post_hook" in dir(pymodule):
367                 logger.write(msg, 1)
368                 pymodule.run_post_hook(self.cfg, logger)
369
370         except Exception as exc:
371             msg = _("Unable to run hook script: %s") % hook_script_path
372             msg += "\n" + str(exc)
373             raise src.SatException(msg)
374
375     def print_help(self, opt):
376         '''Prints help for a command. Function called when "sat -h <command>"
377         
378         :param argv str: the options passed (to get the command name)
379         '''
380         # if no command as argument (sat -h)
381         if len(opt)==0:
382             print_help()
383             return
384         # get command name
385         command = opt[0]
386         # read the configuration from all the pyconf files
387         cfgManager = config.ConfigManager()
388         self.cfg = cfgManager.get_config(datadir=self.datadir)
389
390         # Check if this command exists
391         if not hasattr(self, command):
392             raise src.SatException(_("Command '%s' does not exist") % command)
393         
394         # Print salomeTools version
395         print_version()
396         
397         # load the module
398         module = self.get_module(command)
399
400         # print the description of the command that is done in the command file
401         if hasattr( module, "description" ) :
402             print(src.printcolors.printcHeader( _("Description:") ))
403             print(module.description() + '\n')
404
405         # print the description of the command options
406         if hasattr( module, "parser" ) :
407             module.parser.print_help()
408
409     def get_module(self, module):
410         '''Loads a command. Function called only by print_help
411         
412         :param module str: the command to load
413         '''
414         # Check if this command exists
415         if not hasattr(self, module):
416             raise src.SatException(_("Command '%s' does not exist") % module)
417
418         # load the module
419         (file_, pathname, description) = imp.find_module(module, [cmdsdir])
420         module = imp.load_module(module, file_, pathname, description)
421         return module
422  
423 def print_version():
424     '''prints salomeTools version (in src/internal_config/salomeTools.pyconf)
425     '''
426     # read the config 
427     cfgManager = config.ConfigManager()
428     cfg = cfgManager.get_config()
429     # print the key corresponding to salomeTools version
430     print(src.printcolors.printcHeader( _("Version: ") ) + 
431           cfg.INTERNAL.sat_version + '\n')
432
433
434 def print_help():
435     '''prints salomeTools general help
436     
437     :param options str: the options
438     '''
439     print_version()
440     
441     print(src.printcolors.printcHeader( _("Usage: ") ) + 
442           "sat [sat_options] <command> [product] [command_options]\n")
443
444     parser.print_help()
445
446     # display all the available commands.
447     print(src.printcolors.printcHeader(_("Available commands are:\n")))
448     for command in lCommand:
449         print(" - %s" % (command))
450         
451     # Explain how to get the help for a specific command
452     print(src.printcolors.printcHeader(_("\nGetting the help for a specific"
453                                     " command: ")) + "sat --help <command>\n")
454
455 def write_exception(exc):
456     '''write exception in case of error in a command
457     
458     :param exc exception: the exception to print
459     '''
460     sys.stderr.write("\n***** ")
461     sys.stderr.write(src.printcolors.printcError("salomeTools ERROR:"))
462     sys.stderr.write("\n" + str(exc) + "\n")
463
464 # ###############################
465 # MAIN : terminal command usage #
466 # ###############################
467 if __name__ == "__main__":  
468     # Initialize the code that will be returned by the terminal command 
469     code = 0
470     (options, args) = parser.parse_args(sys.argv[1:])
471     
472     # no arguments : print general help
473     if len(args) == 0:
474         print_help()
475         sys.exit(0)
476     
477     # instantiate the salomeTools class with correct options
478     sat = Sat(' '.join(sys.argv[1:]))
479     # the command called
480     command = args[0]
481     # get dynamically the command function to call
482     fun_command = sat.__getattr__(command)
483     # call the command with two cases : mode debug or not
484     if options.debug_mode:
485         # call classically the command and if it fails, 
486         # show exception and stack (usual python mode)
487         code = fun_command(' '.join(args[1:]))
488     else:
489         # catch exception in order to show less verbose but elegant message
490         try:
491             code = fun_command(' '.join(args[1:]))
492         except Exception as exc:
493             code = 1
494             write_exception(exc)
495     
496     # exit salomeTools with the right code (0 if no errors, else 1)
497     if code is None: code = 0
498     sys.exit(code)
499