]> SALOME platform Git repositories - tools/sat.git/blobdiff - commands/log.py
Salome HOME
decode pip version
[tools/sat.git] / commands / log.py
index 20f975bd561926ffb404569b071e5bf1a036e1f2..22a788570fc8fa85895c4ea82891a55e1b865ba6 100644 (file)
@@ -34,20 +34,18 @@ import src
 
 # Define all possible option for log command :  sat log <options>
 parser = src.options.Options()
-parser.add_option('t', 'terminal', 'boolean', 'terminal', "Optional: "
-                  "Terminal log.")
-parser.add_option('l', 'last', 'boolean', 'last', "Show the log of the last "
-                  "Optional: launched command.")
-parser.add_option('', 'last_terminal', 'boolean', 'last_terminal', "Show the "
-                  "log of the last compilations"
-                  "Optional: launched command.")
-parser.add_option('f', 'full', 'boolean', 'full', "Optional: Show the logs of "
-                  "ALL the launched commands.")
-parser.add_option('c', 'clean', 'int', 'clean', "Optional: Erase the n most "
-                  "ancient log files.")
-parser.add_option('n', 'no_browser', 'boolean', 'no_browser', "Optional: Do not"
-                  " launch the browser at the end of the command. Only update "
-                  "the hat file.")
+parser.add_option('t', 'terminal', 'boolean', 'terminal',
+                  "Optional: Show the log (in terminal) of a command, with user choice.")
+parser.add_option('l', 'last', 'boolean', 'last',
+                  "Optional: Show the log (in browser) of the last launched command.")
+parser.add_option('', 'last_compile', 'boolean', 'last_compile',
+                  "Optional: Show the log (in terminal) of the last compilation for all products.")
+parser.add_option('f', 'full', 'boolean', 'full',
+                  "Optional: Show the logs of ALL the launched commands.")
+parser.add_option('c', 'clean', 'int', 'clean',
+                  "Erase the n most ancient log files.")
+parser.add_option('n', 'no_browser', 'boolean', 'no_browser',
+                  "Optional: Do not launch the browser at the end of the command. Only update the hat file.")
 
 def get_last_log_file(logDir, notShownCommands):
     '''Used in case of last option. Get the last log command file path.
@@ -114,6 +112,7 @@ def print_log_command_in_terminal(filePath, logger):
 def show_last_logs(logger, config, log_dirs):
     """Show last compilation logs"""
     log_dir = os.path.join(config.APPLICATION.workdir, 'LOGS')
+    sorted_log_dirs = sorted(log_dirs)
     # list the logs
     nb = len(log_dirs)
     nb_cols = 4
@@ -122,7 +121,7 @@ def show_last_logs(logger, config, log_dirs):
         for i in range(0, nb_cols):
             k = index + i * col_size
             if k < nb:
-                l = log_dirs[k]
+                l = sorted_log_dirs[k]
                 str_indice = src.printcolors.printcLabel("%2d" % (k+1))
                 log_name = l
                 logger.write("%s: %-30s" % (str_indice, log_name), 1, False)
@@ -133,19 +132,19 @@ def show_last_logs(logger, config, log_dirs):
     while (x < 0):
         x = ask_value(nb)
         if x > 0:
-            product_log_dir = os.path.join(log_dir, log_dirs[x-1])
+            product_log_dir = os.path.join(log_dir, sorted_log_dirs[x-1])
             show_product_last_logs(logger, config, product_log_dir)
 
 def show_product_last_logs(logger, config, product_log_dir):
     """Show last compilation logs of a product"""
-    files = os.listdir(product_log_dir)
     # sort the files chronologically
     l_time_file = []
     for file_n in os.listdir(product_log_dir):
         my_stat = os.stat(os.path.join(product_log_dir, file_n))
         l_time_file.append(
               (datetime.datetime.fromtimestamp(my_stat[stat.ST_MTIME]), file_n))
-        
+    
+    # display the available logs
     for i, (__, file_name) in enumerate(sorted(l_time_file)):
         str_indice = src.printcolors.printcLabel("%2d" % (i+1))
         opt = []
@@ -159,9 +158,10 @@ def show_product_last_logs(logger, config, product_log_dir):
     # loop till exit
     x = -1
     while (x < 0):
-        x = ask_value(len(files))
+        x = ask_value(len(l_time_file))
         if x > 0:
-            log_file_path = os.path.join(product_log_dir, files[x-1])
+            (__, file_name) =  sorted(l_time_file)[x-1]
+            log_file_path = os.path.join(product_log_dir, file_name)
             src.system.show_in_editor(config.USER.editor, log_file_path, logger)
         
 def ask_value(nb):
@@ -192,8 +192,12 @@ def description():
     :return: The text to display for the log command description.
     :rtype: str
     '''
-    return _("Gives access to the logs produced by the salomeTools commands.\n"
-             "\nexample:\nsat log")    
+    return _("""\
+The log command gives access to the logs produced by the salomeTools commands.
+
+example:
+>> sat log
+""")
 
 def run(args, runner, logger):
     '''method that is called when salomeTools is called with log parameter.
@@ -201,9 +205,9 @@ def run(args, runner, logger):
     # Parse the options
     (options, args) = parser.parse_args(args)
 
-    # get the log directory. 
-    logDir = runner.cfg.USER.log_dir
-    
+    # get the log directory.
+    logDir = src.get_log_path(runner.cfg)
+
     # Print a header
     nb_files_log_dir = len(glob.glob(os.path.join(logDir, "*")))
     info = [("log directory", logDir), 
@@ -256,23 +260,31 @@ def run(args, runner, logger):
     imgLogo = os.path.join(xslDir, "LOGO-SAT.png")
     
     # copy the stylesheets in the log directory
-    shutil.copy2(xslCommand, logDir)
-    shutil.copy2(xslHat, logDir)
-    src.ensure_path_exists(os.path.join(logDir, "TEST"))
-    shutil.copy2(xsltest, os.path.join(logDir, "TEST"))
-    shutil.copy2(imgLogo, logDir)
+    # OP We use copy instead of copy2 to update the creation date
+    #    So we can clean the LOGS directories easily
+    try:
+      src.ensure_path_exists(logDir)
+      shutil.copy(xslCommand, logDir)
+      shutil.copy(xslHat, logDir)
+      src.ensure_path_exists(os.path.join(logDir, "TEST"))
+      shutil.copy(xsltest, os.path.join(logDir, "TEST"))
+      shutil.copy(imgLogo, logDir)
+    except:
+      # we are here  if an user make sat log in jenkins LOGS without write rights
+      # Make a warning and do nothing
+      logger.warning("problem for writing in directory '%s', may be not owner." % logDir)
 
     # If the last option is invoked, just, show the last log file
-    if options.last_terminal:
-        log_dirs = os.listdir(os.path.join(runner.cfg.APPLICATION.workdir,
-                                           'LOGS'))
+    if options.last_compile:
+        src.check_config_has_application(runner.cfg)
+        log_dirs = os.listdir(os.path.join(runner.cfg.APPLICATION.workdir, 'LOGS'))
         show_last_logs(logger, runner.cfg, log_dirs)
         return 0
 
     # If the last option is invoked, just, show the last log file
     if options.last:
         lastLogFilePath = get_last_log_file(logDir,
-                                            notShownCommands + ["config"])        
+                                            notShownCommands + ["config"])
         if options.terminal:
             # Show the log corresponding to the selected command call
             print_log_command_in_terminal(lastLogFilePath, logger)
@@ -320,14 +332,22 @@ def run(args, runner, logger):
     # Create or update the hat xml that gives access to all the commands log files
     logger.write(_("Generating the hat log file (can be long) ... "), 3)
     xmlHatFilePath = os.path.join(logDir, 'hat.xml')
-    src.logger.update_hat_xml(runner.cfg.USER.log_dir, 
+    try:
+      src.logger.update_hat_xml(logDir,
                               application = runner.cfg.VARS.application, 
                               notShownCommands = notShownCommands)
-    logger.write(src.printcolors.printc("OK"), 3)
+
+      logger.write(src.printcolors.printc("OK"), 3)
+    except:
+      logger.write(src.printcolors.printc("KO"), 3)
+      logger.write(" problem update hat.xml", 3)
+
     logger.write("\n", 3)
     
     # open the hat xml in the user editor
     if not options.no_browser:
-        logger.write(_("\nOpening the log file\n"), 3)
-        src.system.show_in_editor(runner.cfg.USER.browser, xmlHatFilePath, logger)
-    return 0
\ No newline at end of file
+        logger.write(_("\nOpening the hat log file %s\n" % xmlHatFilePath), 3)
+        src.system.show_in_webbrowser(runner.cfg.USER.browser, xmlHatFilePath, logger)
+    else:
+        logger.write("\nHat log File is %s\n" % xmlHatFilePath, 3)
+    return 0