#!/usr/bin/env python
-#-*- coding:utf-8 -*-
+# -*- coding:utf-8 -*-
# Copyright (C) 2010-2012 CEA/DEN
#
# This library is free software; you can redistribute it and/or
# Define all possible option for the make command : sat make <options>
parser = src.options.Options()
-parser.add_option('j', 'jobs_config', 'string', 'jobs_cfg',
- _('Mandatory: The name of the config file that contains'
- ' the jobs configuration'))
-parser.add_option('', 'name', 'string', 'job',
- _('Mandatory: The job name from which to execute commands.'), "")
+parser.add_option(
+ "j",
+ "jobs_config",
+ "string",
+ "jobs_cfg",
+ _("Mandatory: The name of the config file that contains" " the jobs configuration"),
+)
+parser.add_option(
+ "",
+ "name",
+ "string",
+ "job",
+ _("Mandatory: The job name from which to execute commands."),
+ "",
+)
+
def description():
- '''method that is called when salomeTools is called with --help option.
-
+ """method that is called when salomeTools is called with --help option.
+
:return: The text to display for the job command description.
:rtype: str
- '''
- return _("""\
+ """
+ return _(
+ """\
The job command executes the commands of the job defined in the jobs configuration file
example:
>> sat job --jobs_config my_jobs --name my_job
-""")
-
+"""
+ )
+
+
def run(args, runner, logger):
- '''method that is called when salomeTools is called with job parameter.
- '''
-
+ """method that is called when salomeTools is called with job parameter."""
+
# Parse the options
(options, args) = parser.parse_args(args)
-
+
l_cfg_dir = runner.cfg.PATHS.JOBPATH
-
+
# Make sure the jobs_config option has been called
if not options.jobs_cfg:
- message = _("The option --jobs_config is required\n")
+ message = _("The option --jobs_config is required\n")
logger.write(src.printcolors.printcError(message))
return 1
-
+
# Make sure the name option has been called
if not options.job:
- message = _("The option --name is required\n")
+ message = _("The option --name is required\n")
logger.write(src.printcolors.printcError(message))
return 1
-
+
# Find the file in the directories
found = False
for cfg_dir in l_cfg_dir:
file_jobs_cfg = os.path.join(cfg_dir, options.jobs_cfg)
- if not file_jobs_cfg.endswith('.pyconf'):
- file_jobs_cfg += '.pyconf'
-
+ if not file_jobs_cfg.endswith(".pyconf"):
+ file_jobs_cfg += ".pyconf"
+
if not os.path.exists(file_jobs_cfg):
continue
else:
found = True
break
-
+
if not found:
- msg = _("The file configuration %(name_file)s was not found."
- "\nUse the --list option to get the possible files.")
+ msg = _(
+ "The file configuration %(name_file)s was not found."
+ "\nUse the --list option to get the possible files."
+ )
src.printcolors.printcError(msg)
return 1
-
+
info = [
- (_("Platform"), runner.cfg.VARS.dist),
- (_("File containing the jobs configuration"), file_jobs_cfg)
+ (_("Platform"), runner.cfg.VARS.dist),
+ (_("File containing the jobs configuration"), file_jobs_cfg),
]
src.print_info(logger, info)
-
+
# Read the config that is in the file
config_jobs = src.read_config_from_a_file(file_jobs_cfg)
-
+
# Find the job and its commands
found = False
for job in config_jobs.jobs:
found = True
break
if not found:
- msg = _("Impossible to find the job \"%(job_name)s\" in "
- "%(jobs_config_file)s" % {"job_name" : options.job,
- "jobs_config_file" : file_jobs_cfg})
+ msg = _(
+ 'Impossible to find the job "%(job_name)s" in '
+ "%(jobs_config_file)s"
+ % {"job_name": options.job, "jobs_config_file": file_jobs_cfg}
+ )
logger.write(src.printcolors.printcError(msg) + "\n")
return 1
-
+
# Find the maximum length of the commands in order to format the display
len_max_command = max([len(cmd) for cmd in commands])
-
+
# Loop over the commands and execute it
res = 0
nb_pass = 0
for command in commands:
specific_option = False
# Determine if it is a sat command or a shell command
- cmd_exe = command.split(" ")[0] # first part
+ cmd_exe = command.split(" ")[0] # first part
if cmd_exe == "sat":
# use the salomeTools parser to get the options of the command
sat_parser = src.salomeTools.parser
- input_parser = src.remove_item_from_list(command.split(' ')[1:], "")
+ input_parser = src.remove_item_from_list(command.split(" ")[1:], "")
(options, argus) = sat_parser.parse_args(input_parser)
# Verify if there is a changed option
for attr in dir(options):
sat_command_name = "shell"
end_cmd = ["--command", command]
# Do not change the options if no option was called in the command
- if not(specific_option):
+ if not (specific_option):
options = None
# Get dynamically the command function to call
sat_command = runner.__getattr__(sat_command_name)
- logger.write("Executing " +
- src.printcolors.printcLabel(command) + " ", 3)
+ logger.write("Executing " + src.printcolors.printcLabel(command) + " ", 3)
logger.write("." * (len_max_command - len(command)) + " ", 3)
logger.flush()
-
+
error = ""
stack = ""
# Execute the command
- code = sat_command(end_cmd,
- options = options,
- batch = True,
- verbose = 0,
- logger_add_link = logger)
-
+ code = sat_command(
+ end_cmd, options=options, batch=True, verbose=0, logger_add_link=logger
+ )
+
# Print the status of the command
if code == 0:
nb_pass += 1
- logger.write('%s\n' % src.printcolors.printc(src.OK_STATUS), 3)
+ logger.write("%s\n" % src.printcolors.printc(src.OK_STATUS), 3)
else:
if sat_command_name != "test":
res = 1
- logger.write('%s %s\n' % (src.printcolors.printc(src.KO_STATUS),
- error), 3)
+ logger.write("%s %s\n" % (src.printcolors.printc(src.KO_STATUS), error), 3)
if len(stack) > 0:
- logger.write('stack: %s\n' % stack, 3)
-
+ logger.write("stack: %s\n" % stack, 3)
+
# Print the final state
if res == 0:
final_status = "OK"
else:
final_status = "KO"
-
- logger.write(_("\nCommands: %(status)s (%(valid_result)d/%(nb_products)d)\n") % \
- { 'status': src.printcolors.printc(final_status),
- 'valid_result': nb_pass,
- 'nb_products': len(commands) }, 3)
-
- return res
\ No newline at end of file
+
+ logger.write(
+ _("\nCommands: %(status)s (%(valid_result)d/%(nb_products)d)\n")
+ % {
+ "status": src.printcolors.printc(final_status),
+ "valid_result": nb_pass,
+ "nb_products": len(commands),
+ },
+ 3,
+ )
+
+ return res
