commands/patch.py

   1 #!/usr/bin/env python
   2 #-*- coding:utf-8 -*-
   3 #  Copyright (C) 2010-2012  CEA/DEN
   4 #
   5 #  This library is free software; you can redistribute it and/or
   6 #  modify it under the terms of the GNU Lesser General Public
   7 #  License as published by the Free Software Foundation; either
   8 #  version 2.1 of the License.
   9 #
  10 #  This library is distributed in the hope that it will be useful,
  11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 #  Lesser General Public License for more details.
  14 #
  15 #  You should have received a copy of the GNU Lesser General Public
  16 #  License along with this library; if not, write to the Free Software
  17 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18
  19 import os
  20 import subprocess
  21 import re
  22
  23 import src
  24 import prepare
  25
  26 # Define all possible option for patch command :  sat patch <options>
  27 parser = src.options.Options()
  28 parser.add_option('p', 'products', 'list2', 'products',
  29     _('Optional: products to get the sources. This option accepts a comma separated list.'))
  30
  31 def apply_patch(config, product_info, max_product_name_len, logger):
  32     '''The method called to apply patches on a product
  33
  34     :param config Config: The global configuration
  35     :param product_info Config: The configuration specific to
  36                                the product to be patched
  37     :param logger Logger: The logger instance to use for the display and logging
  38     :return: (True if it succeed, else False, message to display)
  39     :rtype: (boolean, str)
  40     '''
  41
  42     # if the product is native, do not apply patch
  43     if src.product.product_is_native(product_info):
  44         # display and log
  45         logger.write('%s: ' % src.printcolors.printcLabel(product_info.name), 4)
  46         logger.write(' ' * (max_product_name_len - len(product_info.name)), 4, False)
  47         logger.write("\n", 4, False)
  48         msg = _("The %s product is native. Do not apply "
  49                 "any patch.") % product_info.name
  50         logger.write(msg, 4)
  51         logger.write("\n", 4)
  52         return True, ""
  53
  54     if not "patches" in product_info or len(product_info.patches) == 0:
  55         # display and log
  56         logger.write('%s: ' % src.printcolors.printcLabel(product_info.name), 4)
  57         logger.write(' ' * (max_product_name_len - len(product_info.name)), 4, False)
  58         logger.write("\n", 4, False)
  59         msg = _("No patch for the %s product") % product_info.name
  60         logger.write(msg, 4)
  61         logger.write("\n", 4)
  62         return True, ""
  63     else:
  64         # display and log
  65         logger.write('%s: ' % src.printcolors.printcLabel(product_info.name), 3)
  66         logger.write(' ' * (max_product_name_len - len(product_info.name)), 3, False)
  67         logger.write("\n", 4, False)
  68
  69     if not os.path.exists(product_info.source_dir):
  70         msg = _("No sources found for the %s product\n") % product_info.name
  71         logger.write(src.printcolors.printcWarning(msg), 1)
  72         return False, ""
  73
  74     # At this point, there one or more patches and the source directory exists
  75     retcode = []
  76     res = []
  77     # Loop on all the patches of the product
  78     for patch in product_info.patches:
  79         details = []
  80
  81         # Check the existence and apply the patch
  82         if os.path.isfile(patch):
  83             patch_cmd = "patch -p1 < %s" % patch
  84
  85             # Write the command in the terminal if verbose level is at 5
  86             logger.write(("    >%s\n" % patch_cmd),5)
  87
  88             # Write the command in the log file (can be seen using 'sat log')
  89             logger.logTxtFile.write("\n    >%s\n" % patch_cmd)
  90             logger.logTxtFile.flush()
  91
  92             # Call the command
  93             res_cmd = (subprocess.call(patch_cmd,
  94                                    shell=True,
  95                                    cwd=product_info.source_dir,
  96                                    stdout=logger.logTxtFile,
  97                                    stderr=subprocess.STDOUT) == 0)
  98         else:
  99             res_cmd = False
 100             details.append("  " +
 101                 src.printcolors.printcError(_("Not a valid patch: %s") % patch))
 102
 103         res.append(res_cmd)
 104
 105         if res_cmd:
 106             message = (_("Apply patch %s") %
 107                        src.printcolors.printcHighlight(patch))
 108         else:
 109             message = src.printcolors.printcWarning(
 110                                         _("Failed to apply patch %s") % patch)
 111
 112         if config.USER.output_verbose_level >= 3:
 113             retcode.append("  %s" % message)
 114         else:
 115             retcode.append("%s: %s" % (product_info.name, message))
 116
 117         if len(details) > 0:
 118             retcode.extend(details)
 119
 120     res = not (False in res)
 121
 122     return res, "\n".join(retcode) + "\n"
 123
 124 def description():
 125     '''method that is called when salomeTools is called with --help option.
 126
 127     :return: The text to display for the patch command description.
 128     :rtype: str
 129     '''
 130     return _("The patch command apply the patches on the sources of "
 131              "the application products if there is any.\n\nexample:\nsat "
 132              "patch SALOME-master --products qt,boost")
 133
 134 def run(args, runner, logger):
 135     '''method that is called when salomeTools is called with patch parameter.
 136     '''
 137     # Parse the options
 138     (options, args) = parser.parse_args(args)
 139
 140     # check that the command has been called with an application
 141     src.check_config_has_application( runner.cfg )
 142
 143     # Print some informations
 144     logger.write('Patching sources of the application %s\n' %
 145                 src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
 146
 147     src.printcolors.print_value(logger, 'workdir',
 148                                 runner.cfg.APPLICATION.workdir, 2)
 149     logger.write("\n", 2, False)
 150
 151     # Get the products list with products informations regarding the options
 152     products_infos = src.product.get_products_list(options, runner.cfg, logger)
 153
 154     # Get the maximum name length in order to format the terminal display
 155     max_product_name_len = 1
 156     if len(products_infos) > 0:
 157         max_product_name_len = max(map(lambda l: len(l), products_infos[0])) + 4
 158
 159     # The loop on all the products on which to apply the patches
 160     good_result = 0
 161     for __, product_info in products_infos:
 162         # Apply the patch
 163         return_code, patch_res = apply_patch(runner.cfg,
 164                                              product_info,
 165                                              max_product_name_len,
 166                                              logger)
 167         logger.write(patch_res, 1, False)
 168         if return_code:
 169             good_result += 1
 170
 171     # Display the results (how much passed, how much failed, etc...)
 172
 173     logger.write("\n", 2, False)
 174     if good_result == len(products_infos):
 175         status = src.OK_STATUS
 176         res_count = "%d / %d" % (good_result, good_result)
 177     else:
 178         status = src.KO_STATUS
 179         res_count = "%d / %d" % (good_result, len(products_infos))
 180
 181     # write results
 182     logger.write("Patching sources of the application:", 1)
 183     logger.write(" " + src.printcolors.printc(status), 1, False)
 184     logger.write(" (%s)\n" % res_count, 1, False)
 185
 186     return len(products_infos) - good_result