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
21 # Define all possible option for log command : sat log <options>
22 parser = src.options.Options()
23 parser.add_option('p', 'product', 'list2', 'products',
24 _('products to prepare. This option can be'
25 ' passed several time to prepare several products.'))
26 parser.add_option('', 'no_sample', 'boolean', 'no_sample',
27 _("do not prepare sample products."))
28 parser.add_option('f', 'force', 'boolean', 'force',
29 _("force to prepare the products in development mode."))
31 def get_products_list(options, cfg, logger):
32 '''method that gives the product list with their informations from
33 configuration regarding the passed options.
35 :param options Options: The Options instance that stores the commands
37 :param config Config: The global configuration
38 :param logger Logger: The logger instance to use for the display and logging
39 :return: The list of (product name, product_informations).
42 # Get the products to be prepared, regarding the options
43 if options.products is None:
44 # No options, get all products sources
45 products = cfg.APPLICATION.products
47 # if option --products, check that all products of the command line
48 # are present in the application.
49 products = options.products
51 if p not in cfg.APPLICATION.products:
52 raise src.SatException(_("Product %(product)s "
53 "not defined in application %(application)s") %
54 { 'product': p, 'application': cfg.VARS.application} )
56 # Construct the list of tuple containing
57 # the products name and their definition
58 products_infos = src.product.get_products_infos(products, cfg)
60 # if the --no_sample option is invoked, suppress the sample products from
64 lproducts_sample = [p for p in products_infos if src.product.product_is_sample(p[1])]
66 products_infos = [p for p in products_infos if p not in lproducts_sample]
68 if len(lproducts_sample) > 0:
69 msg = "Ignoring the following sample products:\n"
70 logger.write(src.printcolors.printcWarning(_(msg)), 1)
71 for i, product in enumerate(lproducts_sample):
73 if i+1 == len(lproducts_sample):
76 logger.write(product[0] + end_text, 1)
81 '''method that is called when salomeTools is called with --help option.
83 :return: The text to display for the prepare command description.
86 return _("The prepare command apply the patches on the sources of "
87 "the application products if there is any")
89 def run(args, runner, logger):
90 '''method that is called when salomeTools is called with prepare parameter.
94 (options, args) = parser.parse_args(args)
96 # check that the command has been called with an application
97 src.check_config_has_application( runner.cfg )
99 products_infos = get_products_list(options, runner.cfg, logger)
101 ##################################
104 # Construct the option to pass to the source command
105 args_appli = runner.cfg.VARS.application + ' '
107 args_product_opt = '--product '
109 for p_name in options.products:
110 args_product_opt += ',' + p_name
112 for p_name, __ in products_infos:
113 args_product_opt += ',' + p_name
115 if args_product_opt == '--product ':
116 args_product_opt = ''
119 if options.no_sample:
120 args_sample = ' --no_sample'
122 args_source = args_appli + args_product_opt + args_sample
125 args_source += ' --force'
127 # Call the source command that gets the source
128 msg = src.printcolors.printcHeader(
129 _('Get the sources of the desired products\n'))
131 res_source = runner.source(args_source)
134 ##################################
136 msg = src.printcolors.printcHeader(
137 _('\nApply the patches to the sources of the products\n'))
140 # Construct the option to pass to the patch command
141 if ("dev_products" in runner.cfg.APPLICATION and
142 runner.cfg.APPLICATION.dev_products is not []):
144 dev_products = runner.cfg.APPLICATION.dev_products
145 ldev_products = [p for p in products_infos if p[0] in dev_products]
147 if len(ldev_products) > 0:
148 msg = _("Ignoring the following products "
149 "in development mode\n")
150 logger.write(src.printcolors.printcWarning(msg), 1)
151 for i, (product_name, __) in enumerate(ldev_products):
152 args_product_opt.replace(',' + product_name, '')
154 if i+1 == len(ldev_products):
157 logger.write(product_name + end_text, 1)
159 msg = _("Use the --force_patch option to apply the patches anyway\n")
160 logger.write(src.printcolors.printcWarning(msg), 1)
163 args_patch = args_appli + args_product_opt + args_sample
165 # Call the source command that gets the source
166 res_patch = runner.patch(args_patch)
168 return res_source + res_patch