commands/compile.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
  21 import src
  22
  23 # Compatibility python 2/3 for input function
  24 # input stays input for python 3 and input = raw_input for python 2
  25 try:
  26     input = raw_input
  27 except NameError:
  28     pass
  29
  30 # Define all possible option for the compile command :  sat compile <options>
  31 parser = src.options.Options()
  32 parser.add_option('p', 'products', 'list2', 'products',
  33     _('products to configure. This option can be'
  34     ' passed several time to configure several products.'))
  35 parser.add_option('', 'with_fathers', 'boolean', 'fathers',
  36     _("build all necessary products to the given product (KERNEL is build before"
  37       " building GUI)."), False)
  38 parser.add_option('', 'with_children', 'boolean', 'children',
  39     _("build all products using the given product (all SMESH plugins are build "
  40       "after SMESH)."), False)
  41 parser.add_option('', 'clean_all', 'boolean', 'clean_all',
  42     _("clean BUILD dir and INSTALL dir before building product."), False)
  43 parser.add_option('', 'clean_install', 'boolean', 'clean_install',
  44     _("clean INSTALL dir before building product."), False)
  45 parser.add_option('', 'make_flags', 'string', 'makeflags',
  46     _("add extra options to the 'make' command."))
  47 parser.add_option('', 'show', 'boolean', 'no_compile',
  48     _("DO NOT COMPILE just show if products are installed or not."), False)
  49 parser.add_option('', 'stop_first_fail', 'boolean', 'stop_first_fail', _("Stop"
  50                     "s the command at first product compilation fail."), False)
  51
  52 def get_products_list(options, cfg, logger):
  53     '''method that gives the product list with their informations from
  54        configuration regarding the passed options.
  55
  56     :param options Options: The Options instance that stores the commands
  57                             arguments
  58     :param cfg Config: The global configuration
  59     :param logger Logger: The logger instance to use for the display and
  60                           logging
  61     :return: The list of (product name, product_informations).
  62     :rtype: List
  63     '''
  64     # Get the products to be prepared, regarding the options
  65     if options.products is None:
  66         # No options, get all products sources
  67         products = cfg.APPLICATION.products
  68     else:
  69         # if option --products, check that all products of the command line
  70         # are present in the application.
  71         products = options.products
  72         for p in products:
  73             if p not in cfg.APPLICATION.products:
  74                 raise src.SatException(_("Product %(product)s "
  75                             "not defined in application %(application)s") %
  76                         { 'product': p, 'application': cfg.VARS.application} )
  77
  78     # Construct the list of tuple containing
  79     # the products name and their definition
  80     products_infos = src.product.get_products_infos(products, cfg)
  81
  82     products_infos = [pi for pi in products_infos if not(
  83                                      src.product.product_is_native(pi[1]) or
  84                                      src.product.product_is_fixed(pi[1]))]
  85
  86     return products_infos
  87
  88 def get_children(config, p_name_p_info):
  89     l_res = []
  90     p_name, __ = p_name_p_info
  91     # Get all products of the application
  92     products = config.APPLICATION.products
  93     products_infos = src.product.get_products_infos(products, config)
  94     for p_name_potential_child, p_info_potential_child in products_infos:
  95         if ("depend" in p_info_potential_child and
  96                 p_name in p_info_potential_child.depend):
  97             l_res.append(p_name_potential_child)
  98     return l_res
  99
 100 def get_recursive_children(config, p_name_p_info, without_native_fixed=False):
 101     """ Get the recursive list of the product that depend on
 102         the product defined by prod_info
 103
 104     :param config Config: The global configuration
 105     :param prod_info Config: The specific config of the product
 106     :param without_native_fixed boolean: If true, do not include the fixed
 107                                          or native products in the result
 108     :return: The list of product_informations.
 109     :rtype: List
 110     """
 111     p_name, __ = p_name_p_info
 112     # Initialization of the resulting list
 113     l_children = []
 114
 115     # Get the direct children (not recursive)
 116     l_direct_children = get_children(config, p_name_p_info)
 117     # Minimal case : no child
 118     if l_direct_children == []:
 119         return []
 120     # Add the children and call the function to get the children of the
 121     # children
 122     for child_name in l_direct_children:
 123         l_children_name = [pn_pi[0] for pn_pi in l_children]
 124         if child_name not in l_children_name:
 125             if child_name not in config.APPLICATION.products:
 126                 msg = _("The product %(child_name)s that is in %(product_nam"
 127                         "e)s children is not present in application "
 128                         "%(appli_name)s" % {"child_name" : child_name,
 129                                     "product_name" : p_name.name,
 130                                     "appli_name" : config.VARS.application})
 131                 raise src.SatException(msg)
 132             prod_info_child = src.product.get_product_config(config,
 133                                                               child_name)
 134             pname_pinfo_child = (prod_info_child.name, prod_info_child)
 135             # Do not append the child if it is native or fixed and
 136             # the corresponding parameter is called
 137             if without_native_fixed:
 138                 if not(src.product.product_is_native(prod_info_child) or
 139                        src.product.product_is_fixed(prod_info_child)):
 140                     l_children.append(pname_pinfo_child)
 141             else:
 142                 l_children.append(pname_pinfo_child)
 143             # Get the children of the children
 144             l_grand_children = get_recursive_children(config,
 145                                 pname_pinfo_child,
 146                                 without_native_fixed = without_native_fixed)
 147             l_children += l_grand_children
 148     return l_children
 149
 150 def get_recursive_fathers(config, p_name_p_info, without_native_fixed=False):
 151     """ Get the recursive list of the dependencies of the product defined by
 152         prod_info
 153
 154     :param config Config: The global configuration
 155     :param prod_info Config: The specific config of the product
 156     :param without_native_fixed boolean: If true, do not include the fixed
 157                                          or native products in the result
 158     :return: The list of product_informations.
 159     :rtype: List
 160     """
 161     p_name, p_info = p_name_p_info
 162     # Initialization of the resulting list
 163     l_fathers = []
 164     # Minimal case : no dependencies
 165     if "depend" not in p_info or p_info.depend == []:
 166         return []
 167     # Add the dependencies and call the function to get the dependencies of the
 168     # dependencies
 169     for father_name in p_info.depend:
 170         l_fathers_name = [pn_pi[0] for pn_pi in l_fathers]
 171         if father_name not in l_fathers_name:
 172             if father_name not in config.APPLICATION.products:
 173                 msg = _("The product %(father_name)s that is in %(product_nam"
 174                         "e)s dependencies is not present in application "
 175                         "%(appli_name)s" % {"father_name" : father_name,
 176                                     "product_name" : p_name.name,
 177                                     "appli_name" : config.VARS.application})
 178                 raise src.SatException(msg)
 179             prod_info_father = src.product.get_product_config(config,
 180                                                               father_name)
 181             pname_pinfo_father = (prod_info_father.name, prod_info_father)
 182             # Do not append the father if it is native or fixed and
 183             # the corresponding parameter is called
 184             if without_native_fixed:
 185                 if not(src.product.product_is_native(prod_info_father) or
 186                        src.product.product_is_fixed(prod_info_father)):
 187                     l_fathers.append(pname_pinfo_father)
 188             else:
 189                 l_fathers.append(pname_pinfo_father)
 190             # Get the dependencies of the dependency
 191             l_grand_fathers = get_recursive_fathers(config,
 192                                 pname_pinfo_father,
 193                                 without_native_fixed = without_native_fixed)
 194             l_fathers += l_grand_fathers
 195     return l_fathers
 196
 197 def sort_products(config, p_infos):
 198     """ Sort the p_infos regarding the dependencies between the products
 199
 200     :param config Config: The global configuration
 201     :param p_infos list: List of (str, Config) => (product_name, product_info)
 202     """
 203     l_prod_sorted = deepcopy_list(p_infos)
 204     for prod in p_infos:
 205         l_fathers = get_recursive_fathers(config,
 206                                           prod,
 207                                           without_native_fixed=True)
 208         l_fathers = [father for father in l_fathers if father in p_infos]
 209         if l_fathers == []:
 210             continue
 211         for p_sorted in l_prod_sorted:
 212             if p_sorted in l_fathers:
 213                 l_fathers.remove(p_sorted)
 214             if l_fathers==[]:
 215                 l_prod_sorted.remove(prod)
 216                 l_prod_sorted.insert(l_prod_sorted.index(p_sorted)+1, prod)
 217                 break
 218
 219     return l_prod_sorted
 220
 221 def deepcopy_list(input_list):
 222     """ Do a deep copy of a list
 223
 224     :param input_list List: The list to copy
 225     :return: The copy of the list
 226     :rtype: List
 227     """
 228     res = []
 229     for elem in input_list:
 230         res.append(elem)
 231     return res
 232
 233 def extend_with_fathers(config, p_infos):
 234     p_infos_res = deepcopy_list(p_infos)
 235     for p_name_p_info in p_infos:
 236         fathers = get_recursive_fathers(config,
 237                                         p_name_p_info,
 238                                         without_native_fixed=True)
 239         for p_name_p_info_father in fathers:
 240             if p_name_p_info_father not in p_infos_res:
 241                 p_infos_res.append(p_name_p_info_father)
 242     return p_infos_res
 243
 244 def extend_with_children(config, p_infos):
 245     p_infos_res = deepcopy_list(p_infos)
 246     for p_name_p_info in p_infos:
 247         children = get_recursive_children(config,
 248                                         p_name_p_info,
 249                                         without_native_fixed=True)
 250         for p_name_p_info_child in children:
 251             if p_name_p_info_child not in p_infos_res:
 252                 p_infos_res.append(p_name_p_info_child)
 253     return p_infos_res
 254
 255 def check_dependencies(config, p_name_p_info):
 256     l_depends_not_installed = []
 257     fathers = get_recursive_fathers(config, p_name_p_info, without_native_fixed=True)
 258     for p_name_father, p_info_father in fathers:
 259         if not(src.product.check_installation(p_info_father)):
 260             l_depends_not_installed.append(p_name_father)
 261     return l_depends_not_installed
 262
 263 def log_step(logger, header, step):
 264     logger.write("\r%s%s" % (header, " " * 30), 3)
 265     logger.write("\r%s%s" % (header, step), 3)
 266     logger.write("\n==== %s \n" % src.printcolors.printcInfo(step), 4)
 267     logger.flush()
 268
 269 def log_res_step(logger, res):
 270     if res == 0:
 271         logger.write("%s \n" % src.printcolors.printcSuccess("OK"), 4)
 272         logger.flush()
 273     else:
 274         logger.write("%s \n" % src.printcolors.printcError("KO"), 4)
 275         logger.flush()
 276
 277 def compile_all_products(sat, config, options, products_infos, logger):
 278     '''Execute the proper configuration commands
 279        in each product build directory.
 280
 281     :param config Config: The global configuration
 282     :param products_info list: List of
 283                                  (str, Config) => (product_name, product_info)
 284     :param logger Logger: The logger instance to use for the display and logging
 285     :return: the number of failing commands.
 286     :rtype: int
 287     '''
 288     res = 0
 289     for p_name_info in products_infos:
 290
 291         p_name, p_info = p_name_info
 292
 293         # Logging
 294         logger.write("\n", 4, False)
 295         logger.write("################ ", 4)
 296         header = _("Compilation of %s") % src.printcolors.printcLabel(p_name)
 297         header += " %s " % ("." * (30 - len(p_name)))
 298         logger.write(header, 3)
 299         logger.write("\n", 4, False)
 300         logger.flush()
 301
 302         # Clean the build and the install directories
 303         # if the corresponding options was called
 304         if options.clean_all:
 305             log_step(logger, header, "CLEAN BUILD AND INSTALL")
 306             sat.clean(config.VARS.application +
 307                       " --products " + p_name +
 308                       " --build --install", batch=True, verbose=0)
 309
 310         # Clean the the install directory
 311         # if the corresponding option was called
 312         if options.clean_install and not options.clean_all:
 313             log_step(logger, header, "CLEAN INSTALL")
 314             sat.clean(config.VARS.application +
 315                       " --products " + p_name +
 316                       " --install", batch=True, verbose=0)
 317
 318         # Check if it was already successfully installed
 319         if src.product.check_installation(p_info):
 320             logger.write(_("Already installed\n"))
 321             continue
 322
 323         # If the show option was called, do not launch the compilation
 324         if options.no_compile:
 325             logger.write(_("Not installed\n"))
 326             continue
 327
 328         # Check if the dependencies are installed
 329         l_depends_not_installed = check_dependencies(config, p_name_info)
 330         if len(l_depends_not_installed) > 0:
 331             logger.write(src.printcolors.printcError(
 332                     _("ERROR : the following product(s) is(are) mandatory: ")))
 333             for prod_name in l_depends_not_installed:
 334                 logger.write(src.printcolors.printcError(prod_name + " "))
 335             logger.write("\n")
 336             continue
 337
 338         # Call the function to compile the product
 339         res_prod = compile_product(sat, p_name_info, config, options, logger, header)
 340         if res_prod != 0:
 341             res += 1
 342             if options.stop_first_fail:
 343                 break
 344
 345     return res
 346
 347 def compile_product(sat, p_name_info, config, options, logger, header):
 348     '''Execute the proper configuration command(s)
 349        in the product build directory.
 350
 351     :param p_name_info tuple: (str, Config) => (product_name, product_info)
 352     :param config Config: The global configuration
 353     :param logger Logger: The logger instance to use for the display
 354                           and logging
 355     :return: 1 if it fails, else 0.
 356     :rtype: int
 357     '''
 358
 359     p_name, p_info = p_name_info
 360
 361     # Execute "sat configure", "sat make" and "sat install"
 362     len_end_line = 30
 363     res = 0
 364
 365     # Logging and sat command call for configure step
 366     log_step(logger, header, "CONFIGURE")
 367     res_c = sat.configure(config.VARS.application + " --products " + p_name,
 368                           verbose = 0)
 369     log_res_step(logger, res_c)
 370     res += res_c
 371
 372     # Logging and sat command call for make step
 373     # Logging take account of the fact that the product has a compilation
 374     # script or not
 375     if src.product.product_has_script(p_info):
 376         # if the product has a compilation script,
 377         # it is executed during make step
 378         scrit_path_display = src.printcolors.printcLabel(p_info.compil_script)
 379         log_step(logger, header, "SCRIPT " + scrit_path_display)
 380         len_end_line = len(scrit_path_display)
 381     else:
 382         log_step(logger, header, "MAKE")
 383     make_arguments = config.VARS.application + " --products " + p_name
 384     # Get the make_flags option if there is any
 385     if options.makeflags:
 386         make_arguments += " --option -j" + options.makeflags
 387     res_c = sat.make(make_arguments,
 388                      verbose = 0)
 389     log_res_step(logger, res_c)
 390     res += res_c
 391
 392     # Logging and sat command call for make install step
 393     log_step(logger, header, "MAKE INSTALL")
 394     res_c = sat.makeinstall(config.VARS.application + " --products " + p_name,
 395                             verbose = 0)
 396     log_res_step(logger, res_c)
 397     res += res_c
 398
 399     # Log the result
 400     if res > 0:
 401         logger.write("\r%s%s" % (header, " " * len_end_line), 3)
 402         logger.write("\r" + header + src.printcolors.printcError("KO"))
 403         logger.write("\n==== %(KO)s in compile of %(name)s \n" %
 404             { "name" : p_name , "KO" : src.printcolors.printcInfo("ERROR")}, 4)
 405         logger.flush()
 406     else:
 407         logger.write("\r%s%s" % (header, " " * len_end_line), 3)
 408         logger.write("\r" + header + src.printcolors.printcSuccess("OK"))
 409         logger.write(_("\nINSTALL directory = %s" %
 410                        src.printcolors.printcInfo(p_info.install_dir)), 3)
 411         logger.write("\n==== %s \n" % src.printcolors.printcInfo("OK"), 4)
 412         logger.write("\n==== Compilation of %(name)s %(OK)s \n" %
 413             { "name" : p_name , "OK" : src.printcolors.printcInfo("OK")}, 4)
 414         logger.flush()
 415     logger.write("\n", 3, False)
 416
 417     return res
 418
 419 def description():
 420     '''method that is called when salomeTools is called with --help option.
 421
 422     :return: The text to display for the compile command description.
 423     :rtype: str
 424     '''
 425     return _("The compile command constructs the products of the application")
 426
 427 def run(args, runner, logger):
 428     '''method that is called when salomeTools is called with compile parameter.
 429     '''
 430
 431     # Parse the options
 432     (options, args) = parser.parse_args(args)
 433
 434     # Warn the user if he invoked the clean_all option
 435     # without --products option
 436     if (options.clean_all and
 437         options.products is None and
 438         not runner.options.batch):
 439         rep = input(_("You used --clean_all without specifying a product"
 440                           " are you sure you want to continue? [Yes/No] "))
 441         if rep.upper() != _("YES").upper():
 442             return 0
 443
 444     # check that the command has been called with an application
 445     src.check_config_has_application( runner.cfg )
 446
 447     # Get the list of products to treat
 448     products_infos = get_products_list(options, runner.cfg, logger)
 449
 450     if options.fathers:
 451         # Extend the list with all recursive dependencies of the given products
 452         products_infos = extend_with_fathers(runner.cfg, products_infos)
 453
 454     if options.children:
 455         # Extend the list with all products that use the given products
 456         products_infos = extend_with_children(runner.cfg, products_infos)
 457
 458     # Sort the list regarding the dependencies of the products
 459     products_infos = sort_products(runner.cfg, products_infos)
 460
 461     # Print some informations
 462     logger.write(_('Executing the compile command in the build '
 463                                 'directories of the application %s\n') %
 464                 src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
 465
 466     info = [
 467             (_("SOURCE directory"),
 468              os.path.join(runner.cfg.APPLICATION.workdir, 'SOURCES')),
 469             (_("BUILD directory"),
 470              os.path.join(runner.cfg.APPLICATION.workdir, 'BUILD'))
 471             ]
 472     src.print_info(logger, info)
 473
 474     # Call the function that will loop over all the products and execute
 475     # the right command(s)
 476     res = compile_all_products(runner, runner.cfg, options, products_infos, logger)
 477
 478     # Print the final state
 479     nb_products = len(products_infos)
 480     if res == 0:
 481         final_status = "OK"
 482     else:
 483         final_status = "KO"
 484
 485     logger.write(_("\nCompilation: %(status)s (%(valid_result)d/%(nb_products)d)\n") % \
 486         { 'status': src.printcolors.printc(final_status),
 487           'valid_result': nb_products - res,
 488           'nb_products': nb_products }, 1)
 489
 490     return res