import shutil
import re
import glob
+import datetime
+import stat
# Compatibility python 2/3 for input function
# input stays input for python 3 and input = raw_input for python 2
# 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('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('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_terminal', 'boolean', 'last_terminal',
+ "Optional: Show the log (in terminal) of the last 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',
+ "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.
last = (_, 0)
for fileName in os.listdir(logDir):
# YYYYMMDD_HHMMSS_namecmd.xml
- sExpr = src.logger.logCommandFileExpression
+ sExpr = src.logger.log_macro_command_file_expression
oExpr = re.compile(sExpr)
if oExpr.search(fileName):
# get date and hour and format it
date_hour_cmd = fileName.split('_')
datehour = date_hour_cmd[0] + date_hour_cmd[1]
- cmd = date_hour_cmd[2][:-len('.xml')]
+ cmd = date_hour_cmd[2]
if cmd in notShownCommands:
continue
if int(datehour) > last[1]:
logger.write(command_traces, 1)
logger.write("\n", 1)
+def show_last_logs(logger, config, log_dirs):
+ """Show last compilation logs"""
+ log_dir = os.path.join(config.APPLICATION.workdir, 'LOGS')
+ # list the logs
+ nb = len(log_dirs)
+ nb_cols = 4
+ col_size = (nb / nb_cols) + 1
+ for index in range(0, col_size):
+ for i in range(0, nb_cols):
+ k = index + i * col_size
+ if k < nb:
+ l = log_dirs[k]
+ str_indice = src.printcolors.printcLabel("%2d" % (k+1))
+ log_name = l
+ logger.write("%s: %-30s" % (str_indice, log_name), 1, False)
+ logger.write("\n", 1, False)
+
+ # loop till exit
+ x = -1
+ while (x < 0):
+ x = ask_value(nb)
+ if x > 0:
+ product_log_dir = os.path.join(log_dir, 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"""
+ # 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 = []
+ my_stat = os.stat(os.path.join(product_log_dir, file_name))
+ opt.append(str(datetime.datetime.fromtimestamp(my_stat[stat.ST_MTIME])))
+
+ opt.append("(%8.2f)" % (my_stat[stat.ST_SIZE] / 1024.0))
+ logger.write(" %-35s" % " ".join(opt), 1, False)
+ logger.write("%s: %-30s\n" % (str_indice, file_name), 1, False)
+
+ # loop till exit
+ x = -1
+ while (x < 0):
+ x = ask_value(len(l_time_file))
+ if x > 0:
+ (__, 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):
'''Ask for an int n. 0<n<nb
: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.
# 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),
nbClean = options.clean
# get the list of files to remove
lLogs = src.logger.list_log_file(logDir,
- src.logger.logCommandFileExpression)
+ src.logger.log_all_command_file_expression)
nbLogFiles = len(lLogs)
# Delete all if the invoked number is bigger than the number of log files
if nbClean > nbLogFiles:
return 0
# determine the commands to show in the hat log
- notShownCommands = runner.cfg.INTERNAL.log.not_shown_commands
+ notShownCommands = list(runner.cfg.INTERNAL.log.not_shown_commands)
if options.full:
notShownCommands = []
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:
+ 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)
+ lastLogFilePath = get_last_log_file(logDir,
+ notShownCommands + ["config"])
if options.terminal:
# Show the log corresponding to the selected command call
print_log_command_in_terminal(lastLogFilePath, logger)
# Parse the log directory in order to find
# all the files corresponding to the commands
lLogs = src.logger.list_log_file(logDir,
- src.logger.logCommandFileExpression)
+ src.logger.log_macro_command_file_expression)
lLogsFiltered = []
- for filePath, __, date, __, hour, cmd in lLogs:
- showLog, cmdAppli = src.logger.show_command_log(filePath, cmd,
+ for filePath, __, date, __, hour, cmd, __ in lLogs:
+ showLog, cmdAppli, __ = src.logger.show_command_log(filePath, cmd,
runner.cfg.VARS.application, notShownCommands)
if showLog:
lLogsFiltered.append((filePath, date, hour, cmd, cmdAppli))
# 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
- 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
+ if not options.no_browser:
+ logger.write(_("\nOpening the hat log file %s\n" % xmlHatFilePath), 3)
+ src.system.show_in_editor(runner.cfg.USER.browser, xmlHatFilePath, logger)
+ else:
+ logger.write("\nHat log File is %s\n" % xmlHatFilePath, 3)
+ return 0
