# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
import re
+import os
+import pprint as PP
import src
+import src.debug as DBG
+
# Define all possible option for prepare command : sat prepare <options>
parser = src.options.Options()
parser.add_option('p', 'products', 'list2', 'products',
- _('products to prepare. This option can be'
- ' passed several time to prepare several products.'))
-parser.add_option('f', 'force', 'boolean', 'force',
- _("force to prepare the products in development mode."))
-parser.add_option('f', 'force_patch', 'boolean', 'force_patch',
- _("force to apply patch to the products in development mode."))
-
-def get_products_list(options, cfg, logger):
- '''method that gives the product list with their informations from
- configuration regarding the passed options.
+ _('Optional: products to prepare. This option accepts a comma separated list.'))
+parser.add_option('f', 'force', 'boolean', 'force',
+ _("Optional: force to prepare the products in development mode."))
+parser.add_option('', 'force_patch', 'boolean', 'force_patch',
+ _("Optional: force to apply patch to the products in development mode."))
+parser.add_option('c', 'complete', 'boolean', 'complete',
+ _("Optional: completion mode, only prepare products not present in SOURCES dir."),
+ False)
+
+
+def find_products_already_prepared(l_products):
+ '''function that returns the list of products that have an existing source
+ directory.
- :param options Options: The Options instance that stores the commands
- arguments
- :param config Config: The global configuration
- :param logger Logger: The logger instance to use for the display and logging
- :return: The list of (product name, product_informations).
+ :param l_products List: The list of products to check
+ :return: The list of product configurations that have an existing source
+ directory.
:rtype: List
'''
- # Get the products to be prepared, regarding the options
- if options.products is None:
- # No options, get all products sources
- products = cfg.APPLICATION.products
- else:
- # if option --products, check that all products of the command line
- # are present in the application.
- products = options.products
- for p in products:
- if p not in cfg.APPLICATION.products:
- raise src.SatException(_("Product %(product)s "
- "not defined in application %(application)s") %
- { 'product': p, 'application': cfg.VARS.application} )
-
- # Construct the list of tuple containing
- # the products name and their definition
- products_infos = src.product.get_products_infos(products, cfg)
-
- return products_infos
+ l_res = []
+ for p_name_p_cfg in l_products:
+ __, prod_cfg = p_name_p_cfg
+ if "source_dir" in prod_cfg and os.path.exists(prod_cfg.source_dir):
+ l_res.append(p_name_p_cfg)
+ return l_res
-def remove_products(arguments, l_products_info, logger):
- '''method that removes the products in l_products_info from arguments list.
+def find_products_with_patchs(l_products):
+ '''function that returns the list of products that have one or more patches.
- :param arguments str: The arguments from which to remove products
- :param l_products_info list: List of
- (str, Config) => (product_name, product_info)
- :param logger Logger: The logger instance to use for the display and logging
- :return: The updated arguments.
- :rtype: str
+ :param l_products List: The list of products to check
+ :return: The list of product configurations that have one or more patches.
+ :rtype: List
'''
- args = arguments
- for i, (product_name, __) in enumerate(l_products_info):
- args = args.replace(',' + product_name, '')
- end_text = ', '
- if i+1 == len(l_products_info):
- end_text = '\n'
- logger.write(product_name + end_text, 1)
- return args
+ l_res = []
+ for p_name_p_cfg in l_products:
+ __, prod_cfg = p_name_p_cfg
+ l_patchs = src.get_cfg_param(prod_cfg, "patches", [])
+ if len(l_patchs)>0:
+ l_res.append(p_name_p_cfg)
+ return l_res
def description():
'''method that is called when salomeTools is called with --help option.
:rtype: str
'''
return _("The prepare command gets the sources of "
- "the application products and apply the patches if there is any.")
+ "the application products and apply the patches if there is any."
+ "\n\nexample:\nsat prepare SALOME-master --products KERNEL,GUI")
def run(args, runner, logger):
'''method that is called when salomeTools is called with prepare parameter.
# check that the command has been called with an application
src.check_config_has_application( runner.cfg )
- products_infos = get_products_list(options, runner.cfg, logger)
+ products_infos = src.product.get_products_list(options, runner.cfg, logger)
# Construct the arguments to pass to the clean, source and patch commands
- args_appli = runner.cfg.VARS.application + ' '
- args_product_opt = '--products '
+ args_appli = runner.cfg.VARS.application + " " # useful whitespace
if options.products:
- for p_name in options.products:
- args_product_opt += ',' + p_name
- else:
- for p_name, __ in products_infos:
- args_product_opt += ',' + p_name
+ listProd = list(options.products)
+ else: # no product interpeted as all products
+ listProd = [name for name, tmp in products_infos]
+
+ if options.complete:
+ # remove products that are already prepared 'completion mode)
+ pi_already_prepared=find_products_already_prepared(products_infos)
+ l_already_prepared = [i for i, tmp in pi_already_prepared]
+ newList, removedList = removeInList(listProd, l_already_prepared)
+ listProd = newList
+ if len(newList) == 0 and len(removedList) > 0 :
+ msg = "\nAll the products are already installed, do nothing!\n"
+ logger.write(src.printcolors.printcWarning(msg), 1)
+ return 0
+ if len(removedList) > 0 :
+ msg = "\nList of already prepared products that are skipped : %s\n" % ",".join(removedList)
+ logger.write(msg, 3)
+
+
+ args_product_opt = '--products ' + ",".join(listProd)
+ do_source = (len(listProd) > 0)
+
ldev_products = [p for p in products_infos if src.product.product_is_dev(p[1])]
- args_product_opt_clean = args_product_opt
+ newList = listProd # default
if not options.force and len(ldev_products) > 0:
- msg = _("Do not get the source of the following products "
- "in development mode\nUse the --force option to"
- " overwrite it.\n")
- logger.write(src.printcolors.printcWarning(msg), 1)
- args_product_opt_clean = remove_products(args_product_opt_clean,
- ldev_products,
- logger)
- logger.write("\n", 1)
+ l_products_not_getted = find_products_already_prepared(ldev_products)
+ listNot = [i for i, tmp in l_products_not_getted]
+ newList, removedList = removeInList(listProd, listNot)
+ if len(removedList) > 0:
+ msg = _("""\
+Do not get the source of the following products in development mode.
+Use the --force option to overwrite it.
+""")
+ msg += "\n%s\n" % ",".join(removedList)
+ logger.write(src.printcolors.printcWarning(msg), 1)
+ args_product_opt_clean = '--products ' + ",".join(newList)
+ do_clean = (len(newList) > 0)
- args_product_opt_patch = args_product_opt
+ newList = listProd # default
if not options.force_patch and len(ldev_products) > 0:
- msg = _("do not patch the following products "
- "in development mode\nUse the --force_patch option to"
- " overwrite it.\n")
- logger.write(src.printcolors.printcWarning(msg), 1)
- args_product_opt_patch = remove_products(args_product_opt_patch,
- ldev_products,
- logger)
- logger.write("\n", 1)
-
+ l_products_with_patchs = find_products_with_patchs(ldev_products)
+ listNot = [i for i, tmp in l_products_with_patchs]
+ newList, removedList = removeInList(listProd, listNot)
+ if len(removedList) > 0:
+ msg = _("""\
+Do not patch the following products in development mode.
+Use the --force_patch option to overwrite it.
+""")
+ msg += "\n%s\n" % ",".join(removedList)
+ logger.write(src.printcolors.printcWarning(msg), 1)
+
+ args_product_opt_patch = '--products ' + ",".join(newList)
+ do_patch = (len(newList) > 0)
+
# Construct the final commands arguments
args_clean = args_appli + args_product_opt_clean + " --sources"
args_source = args_appli + args_product_opt
args_patch = args_appli + args_product_opt_patch
-
- # If there is no more any product in the command arguments,
- # do not call the concerned command
- oExpr = re.compile("^--products *$")
- do_clean = not(oExpr.search(args_product_opt_clean))
- do_source = not(oExpr.search(args_product_opt))
- do_patch = not(oExpr.search(args_product_opt_patch))
-
-
- # Initialize the results to a failing status
- res_clean = 1
- res_source = 1
- res_patch = 1
+
+ # Initialize the results to a running status
+ res_clean = 0
+ res_source = 0
+ res_patch = 0
# Call the commands using the API
if do_clean:
msg = _("Clean the source directories ...")
logger.write(msg, 3)
logger.flush()
- res_clean, __ = runner.clean(args_clean, batch=True, verbose = 0,
- logger_add_link = logger)
+ res_clean = runner.clean(args_clean, batch=True, verbose = 0, logger_add_link = logger)
if res_clean == 0:
logger.write('%s\n' % src.printcolors.printc(src.OK_STATUS), 3)
else:
if do_source:
msg = _("Get the sources of the products ...")
logger.write(msg, 5)
- res_source, __ = runner.source(args_source,
- logger_add_link = logger)
+ res_source = runner.source(args_source, logger_add_link = logger)
if res_source == 0:
logger.write('%s\n' % src.printcolors.printc(src.OK_STATUS), 5)
else:
if do_patch:
msg = _("Patch the product sources (if any) ...")
logger.write(msg, 5)
- res_patch, __ = runner.patch(args_patch,
- logger_add_link = logger)
+ res_patch = runner.patch(args_patch, logger_add_link = logger)
if res_patch == 0:
logger.write('%s\n' % src.printcolors.printc(src.OK_STATUS), 5)
else:
logger.write('%s\n' % src.printcolors.printc(src.KO_STATUS), 5)
- return res_clean + res_source + res_patch
\ No newline at end of file
+ return res_clean + res_source + res_patch
+
+
+def removeInList(aList, removeList):
+ """Removes elements of removeList list from aList
+
+ :param aList: (list) The list from which to remove elements
+ :param removeList: (list) The list which contains elements to remove
+ :return: (list, list) (list with elements removed, list of elements removed)
+ """
+ res1 = [i for i in aList if i not in removeList]
+ res2 = [i for i in aList if i in removeList]
+ return (res1, res2)
+
+
