#!/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 patch command : sat patch <options>
parser = src.options.Options()
-parser.add_option('p', 'products', 'list2', 'products',
- _('Optional: products to get the sources. This option accepts a comma separated list.'))
+parser.add_option(
+ "p",
+ "products",
+ "list2",
+ "products",
+ _(
+ "Optional: products to get the sources. This option accepts a comma separated list."
+ ),
+)
+
def apply_patch(config, product_info, max_product_name_len, logger):
- '''The method called to apply patches on a product
+ """The method called to apply patches on a product
:param config Config: The global configuration
- :param product_info Config: The configuration specific to
+ :param product_info Config: The configuration specific to
the product to be patched
:param logger Logger: The logger instance to use for the display and logging
:return: (True if it succeed, else False, message to display)
:rtype: (boolean, str)
- '''
+ """
# if the product is native, do not apply patch
if src.product.product_is_native(product_info):
# display and log
- logger.write('%s: ' % src.printcolors.printcLabel(product_info.name), 4)
- logger.write(' ' * (max_product_name_len - len(product_info.name)), 4, False)
+ logger.write("%s: " % src.printcolors.printcLabel(product_info.name), 4)
+ logger.write(" " * (max_product_name_len - len(product_info.name)), 4, False)
logger.write("\n", 4, False)
- msg = _("The %s product is native. Do not apply "
- "any patch.") % product_info.name
+ msg = (
+ _("The %s product is native. Do not apply " "any patch.")
+ % product_info.name
+ )
logger.write(msg, 4)
logger.write("\n", 4)
- return True, ""
+ return True, ""
if not "patches" in product_info or len(product_info.patches) == 0:
# display and log
- logger.write('%s: ' % src.printcolors.printcLabel(product_info.name), 4)
- logger.write(' ' * (max_product_name_len - len(product_info.name)), 4, False)
+ logger.write("%s: " % src.printcolors.printcLabel(product_info.name), 4)
+ logger.write(" " * (max_product_name_len - len(product_info.name)), 4, False)
logger.write("\n", 4, False)
msg = _("No patch for the %s product") % product_info.name
logger.write(msg, 4)
return True, ""
else:
# display and log
- logger.write('%s: ' % src.printcolors.printcLabel(product_info.name), 3)
- logger.write(' ' * (max_product_name_len - len(product_info.name)), 3, False)
+ logger.write("%s: " % src.printcolors.printcLabel(product_info.name), 3)
+ logger.write(" " * (max_product_name_len - len(product_info.name)), 3, False)
logger.write("\n", 4, False)
if not os.path.exists(product_info.source_dir):
# Loop on all the patches of the product
for patch in product_info.patches:
details = []
-
+
# Check the existence and apply the patch
if os.path.isfile(patch):
patch_cmd = "patch -p1 < %s" % patch
-
+
# Write the command in the terminal if verbose level is at 5
- logger.write((" >%s\n" % patch_cmd),5)
-
+ logger.write((" >%s\n" % patch_cmd), 5)
+
# Write the command in the log file (can be seen using 'sat log')
logger.logTxtFile.write("\n >%s\n" % patch_cmd)
logger.logTxtFile.flush()
-
+
# Call the command
- res_cmd = (subprocess.call(patch_cmd,
- shell=True,
- cwd=product_info.source_dir,
- stdout=logger.logTxtFile,
- stderr=subprocess.STDOUT) == 0)
+ res_cmd = (
+ subprocess.call(
+ patch_cmd,
+ shell=True,
+ cwd=product_info.source_dir,
+ stdout=logger.logTxtFile,
+ stderr=subprocess.STDOUT,
+ )
+ == 0
+ )
else:
res_cmd = False
- details.append(" " +
- src.printcolors.printcError(_("Not a valid patch: %s") % patch))
+ details.append(
+ " " + src.printcolors.printcError(_("Not a valid patch: %s") % patch)
+ )
res.append(res_cmd)
-
+
if res_cmd:
- message = (_("Apply patch %s") %
- src.printcolors.printcHighlight(patch))
+ message = _("Apply patch %s") % src.printcolors.printcHighlight(patch)
else:
message = src.printcolors.printcWarning(
- _("Failed to apply patch %s") % patch)
+ _("Failed to apply patch %s") % patch
+ )
if config.USER.output_verbose_level >= 3:
retcode.append(" %s" % message)
else:
retcode.append("%s: %s" % (product_info.name, message))
-
+
if len(details) > 0:
retcode.extend(details)
res = not (False in res)
-
+
return res, "\n".join(retcode) + "\n"
+
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 patch command description.
:rtype: str
- '''
- return _("The patch command apply the patches on the sources of "
- "the application products if there is any.\n\nexample:\nsat "
- "patch SALOME-master --products qt,boost")
-
+ """
+ return _(
+ "The patch command apply the patches on the sources of "
+ "the application products if there is any.\n\nexample:\nsat "
+ "patch SALOME-master --products qt,boost"
+ )
+
+
def run(args, runner, logger):
- '''method that is called when salomeTools is called with patch parameter.
- '''
+ """method that is called when salomeTools is called with patch parameter."""
# Parse the options
(options, args) = parser.parse_args(args)
-
+
# check that the command has been called with an application
- src.check_config_has_application( runner.cfg )
+ src.check_config_has_application(runner.cfg)
# Print some informations
- logger.write('Patching sources of the application %s\n' %
- src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
+ logger.write(
+ "Patching sources of the application %s\n"
+ % src.printcolors.printcLabel(runner.cfg.VARS.application),
+ 1,
+ )
- src.printcolors.print_value(logger, 'workdir',
- runner.cfg.APPLICATION.workdir, 2)
+ src.printcolors.print_value(logger, "workdir", runner.cfg.APPLICATION.workdir, 2)
logger.write("\n", 2, False)
# Get the products list with products informations regarding the options
products_infos = src.product.get_products_list(options, runner.cfg, logger)
-
+
# Get the maximum name length in order to format the terminal display
max_product_name_len = 1
if len(products_infos) > 0:
max_product_name_len = max(map(lambda l: len(l), products_infos[0])) + 4
-
+
# The loop on all the products on which to apply the patches
good_result = 0
for __, product_info in products_infos:
# Apply the patch
- return_code, patch_res = apply_patch(runner.cfg,
- product_info,
- max_product_name_len,
- logger)
+ return_code, patch_res = apply_patch(
+ runner.cfg, product_info, max_product_name_len, logger
+ )
logger.write(patch_res, 1, False)
if return_code:
good_result += 1
-
+
# Display the results (how much passed, how much failed, etc...)
logger.write("\n", 2, False)
else:
status = src.KO_STATUS
res_count = "%d / %d" % (good_result, len(products_infos))
-
+
# write results
logger.write("Patching sources of the application:", 1)
logger.write(" " + src.printcolors.printc(status), 1, False)
logger.write(" (%s)\n" % res_count, 1, False)
-
+
return len(products_infos) - good_result
