add a header to the log command

[tools/sat.git] / commands / log.py

diff --git a/commands/log.py b/commands/log.py
index 8c07f14c196feace2d3e59c9f2dc3d639d71b9dc..12a87ee34bb71c6eb2f079d76c95c38c950c9c08 100644 (file)
--- a/commands/log.py
+++ b/commands/log.py
@@ -1,9 +1,25 @@
 #!/usr/bin/env python
 #-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2012  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 
 import os
 import shutil
 import re
+import glob
 
 # Compatibility python 2/3 for input function
 # input stays input for python 3 and input = raw_input for python 2
@@ -49,6 +65,11 @@ def get_last_log_file(logDir, notShownCommands):
     return os.path.join(logDir, last[0])
 
 def remove_log_file(filePath, logger):
+    '''if it exists, print a warning and remove the input file
+    
+    :param filePath: the path of the file to delete
+    :param logger Logger: the logger instance to use for the print 
+    '''
     if os.path.exists(filePath):
         logger.write(src.printcolors.printcWarning("Removing ")
                      + filePath + "\n", 5)
@@ -118,10 +139,14 @@ def run(args, runner, logger):
     (options, args) = parser.parse_args(args)
 
     # get the log directory. 
-    # If there is an application, it is in cfg.APPLICATION.out_dir, 
-    # else in user directory
-    logDir = runner.cfg.SITE.log.logDir
-
+    logDir = runner.cfg.SITE.log.log_dir
+    
+    # Print a header
+    nb_files_log_dir = len(glob.glob(os.path.join(logDir, "*")))
+    info = [("log directory", logDir), 
+            ("number of log files", nb_files_log_dir)]
+    src.print_info(logger, info)
+    
     # If the clean options is invoked, 
     # do nothing but deleting the concerned files.
     if options.clean:
@@ -143,7 +168,8 @@ def run(args, runner, logger):
                             'OUT', 
                             os.path.basename(filePath)[:-len('.xml')] + '.txt')
             remove_log_file(txtFilePath, logger)
-            # remove also the corresponding pyconf file in OUT directory
+            # remove also the corresponding pyconf (do not exist 2016-06) 
+            # file in OUT directory
             pyconfFilePath = os.path.join(os.path.dirname(filePath), 
                             'OUT', 
                             os.path.basename(filePath)[:-len('.xml')] + '.pyconf')
@@ -155,10 +181,24 @@ def run(args, runner, logger):
         return 0 
 
     # determine the commands to show in the hat log
-    notShownCommands = runner.cfg.INTERNAL.log.notShownCommands
+    notShownCommands = runner.cfg.INTERNAL.log.not_shown_commands
     if options.full:
         notShownCommands = []
 
+    # Find the stylesheets Directory and files
+    xslDir = os.path.join(runner.cfg.VARS.srcDir, 'xsl')
+    xslCommand = os.path.join(xslDir, "command.xsl")
+    xslHat = os.path.join(xslDir, "hat.xsl")
+    xsltest = os.path.join(xslDir, "test.xsl")
+    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)
+
     # If the last option is invoked, just, show the last log file
     if options.last:
         lastLogFilePath = get_last_log_file(logDir, notShownCommands)        
@@ -206,21 +246,9 @@ def run(args, runner, logger):
         
         return 0
                     
-    
-    # Find the stylesheets Directory and files
-    xslDir = os.path.join(runner.cfg.VARS.srcDir, 'xsl')
-    xslCommand = os.path.join(xslDir, "command.xsl")
-    xslHat = os.path.join(xslDir, "hat.xsl")
-    imgLogo = os.path.join(xslDir, "LOGO-SAT.png")
-    
-    # copy the stylesheets in the log directory
-    shutil.copy2(xslCommand, logDir)
-    shutil.copy2(xslHat, logDir)
-    shutil.copy2(imgLogo, logDir)
-
     # Create or update the hat xml that gives access to all the commands log files
     xmlHatFilePath = os.path.join(logDir, 'hat.xml')
-    src.logger.update_hat_xml(runner.cfg.SITE.log.logDir, 
+    src.logger.update_hat_xml(runner.cfg.SITE.log.log_dir, 
                               application = runner.cfg.VARS.application, 
                               notShownCommands = notShownCommands)