3 # Copyright (C) 2010-2012 CEA/DEN
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.
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.
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
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 can be'
30 ' passed several time to get the sources of several products.'))
32 def apply_patch(config, product_info, max_product_name_len, logger):
33 '''The method called to apply patches on a product
35 :param config Config: The global configuration
36 :param product_info Config: The configuration specific to
37 the product to be patched
38 :param logger Logger: The logger instance to use for the display and logging
39 :return: (True if it succeed, else False, message to display)
40 :rtype: (boolean, str)
43 # if the product is native, do not apply patch
44 if src.product.product_is_native(product_info):
46 logger.write('%s: ' % src.printcolors.printcLabel(product_info.name), 4)
47 logger.write(' ' * (max_product_name_len - len(product_info.name)), 4, False)
48 logger.write("\n", 4, False)
49 msg = _("The %s product is native. Do not apply "
50 "any patch.") % product_info.name
55 if not "patches" in product_info or len(product_info.patches) == 0:
57 logger.write('%s: ' % src.printcolors.printcLabel(product_info.name), 4)
58 logger.write(' ' * (max_product_name_len - len(product_info.name)), 4, False)
59 logger.write("\n", 4, False)
60 msg = _("No patch for the %s product") % product_info.name
66 logger.write('%s: ' % src.printcolors.printcLabel(product_info.name), 3)
67 logger.write(' ' * (max_product_name_len - len(product_info.name)), 3, False)
68 logger.write("\n", 4, False)
70 if not os.path.exists(product_info.source_dir):
71 msg = _("No sources found for the %s product\n") % product_info.name
72 logger.write(src.printcolors.printcWarning(msg), 1)
75 # At this point, there one or more patches and the source directory exists
78 # Loop on all the patches of the product
79 for patch in product_info.patches:
82 # Check the existence and apply the patch
83 if os.path.isfile(patch):
84 patch_cmd = "patch -p1 < %s" % patch
86 # Write the command in the terminal if verbose level is at 5
87 logger.write((" >%s\n" % patch_cmd),5)
89 # Write the command in the log file (can be seen using 'sat log')
90 logger.logTxtFile.write("\n >%s\n" % patch_cmd)
91 logger.logTxtFile.flush()
94 res_cmd = (subprocess.call(patch_cmd,
96 cwd=product_info.source_dir,
97 stdout=logger.logTxtFile,
98 stderr=subprocess.STDOUT) == 0)
102 src.printcolors.printcError(_("Not a valid patch: %s") % patch))
107 message = (_("Apply patch %s") %
108 src.printcolors.printcHighlight(patch))
110 message = src.printcolors.printcWarning(
111 _("Failed to apply patch %s") % patch)
113 if config.USER.output_verbose_level >= 3:
114 retcode.append(" %s" % message)
116 retcode.append("%s: %s" % (product_info.name, message))
119 retcode.extend(details)
121 res = not (False in res)
123 return res, "\n".join(retcode) + "\n"
126 '''method that is called when salomeTools is called with --help option.
128 :return: The text to display for the patch command description.
131 return _("The patch command apply the patches on the sources of "
132 "the application products if there is any.\n\nexample:\nsat "
133 "patch SALOME-master --products qt,boost")
135 def run(args, runner, logger):
136 '''method that is called when salomeTools is called with patch parameter.
139 (options, args) = parser.parse_args(args)
141 # check that the command has been called with an application
142 src.check_config_has_application( runner.cfg )
144 # Print some informations
145 logger.write('Patching sources of the application %s\n' %
146 src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
148 src.printcolors.print_value(logger, 'workdir',
149 runner.cfg.APPLICATION.workdir, 2)
150 logger.write("\n", 2, False)
152 # Get the products list with products informations regarding the options
153 products_infos = src.product.get_products_list(options, runner.cfg, logger)
155 # Get the maximum name length in order to format the terminal display
156 max_product_name_len = 1
157 if len(products_infos) > 0:
158 max_product_name_len = max(map(lambda l: len(l), products_infos[0])) + 4
160 # The loop on all the products on which to apply the patches
162 for __, product_info in products_infos:
164 return_code, patch_res = apply_patch(runner.cfg,
166 max_product_name_len,
168 logger.write(patch_res, 1, False)
172 # Display the results (how much passed, how much failed, etc...)
174 logger.write("\n", 2, False)
175 if good_result == len(products_infos):
176 status = src.OK_STATUS
177 res_count = "%d / %d" % (good_result, good_result)
179 status = src.KO_STATUS
180 res_count = "%d / %d" % (good_result, len(products_infos))
183 logger.write("Patching sources of the application:", 1)
184 logger.write(" " + src.printcolors.printc(status), 1, False)
185 logger.write(" (%s)\n" % res_count, 1, False)
187 return len(products_infos) - good_result