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,
 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             for item in l_grand_fathers:
 195                 if item not in l_fathers:
 196                     l_fathers.append(item)
 197     return l_fathers
 198
 199 def sort_products(config, p_infos):
 200     """ Sort the p_infos regarding the dependencies between the products
 201
 202     :param config Config: The global configuration
 203     :param p_infos list: List of (str, Config) => (product_name, product_info)
 204     """
 205     l_prod_sorted = src.deepcopy_list(p_infos)
 206     for prod in p_infos:
 207         l_fathers = get_recursive_fathers(config,
 208                                           prod,
 209                                           without_native_fixed=True)
 210         l_fathers = [father for father in l_fathers if father in p_infos]
 211         if l_fathers == []:
 212             continue
 213         for p_sorted in l_prod_sorted:
 214             if p_sorted in l_fathers:
 215                 l_fathers.remove(p_sorted)
 216             if l_fathers==[]:
 217                 l_prod_sorted.remove(prod)
 218                 l_prod_sorted.insert(l_prod_sorted.index(p_sorted)+1, prod)
 219                 break
 220
 221     return l_prod_sorted
 222
 223 def extend_with_fathers(config, p_infos):
 224     p_infos_res = src.deepcopy_list(p_infos)
 225     for p_name_p_info in p_infos:
 226         fathers = get_recursive_fathers(config,
 227                                         p_name_p_info,
 228                                         without_native_fixed=True)
 229         for p_name_p_info_father in fathers:
 230             if p_name_p_info_father not in p_infos_res:
 231                 p_infos_res.append(p_name_p_info_father)
 232     return p_infos_res
 233
 234 def extend_with_children(config, p_infos):
 235     p_infos_res = src.deepcopy_list(p_infos)
 236     for p_name_p_info in p_infos:
 237         children = get_recursive_children(config,
 238                                         p_name_p_info,
 239                                         without_native_fixed=True)
 240         for p_name_p_info_child in children:
 241             if p_name_p_info_child not in p_infos_res:
 242                 p_infos_res.append(p_name_p_info_child)
 243     return p_infos_res
 244
 245 def check_dependencies(config, p_name_p_info):
 246     l_depends_not_installed = []
 247     fathers = get_recursive_fathers(config, p_name_p_info, without_native_fixed=True)
 248     for p_name_father, p_info_father in fathers:
 249         if not(src.product.check_installation(p_info_father)):
 250             l_depends_not_installed.append(p_name_father)
 251     return l_depends_not_installed
 252
 253 def log_step(logger, header, step):
 254     logger.write("\r%s%s" % (header, " " * 30), 3)
 255     logger.write("\r%s%s" % (header, step), 3)
 256     logger.write("\n==== %s \n" % src.printcolors.printcInfo(step), 4)
 257     logger.flush()
 258
 259 def log_res_step(logger, res):
 260     if res == 0:
 261         logger.write("%s \n" % src.printcolors.printcSuccess("OK"), 4)
 262         logger.flush()
 263     else:
 264         logger.write("%s \n" % src.printcolors.printcError("KO"), 4)
 265         logger.flush()
 266
 267 def compile_all_products(sat, config, options, products_infos, logger):
 268     '''Execute the proper configuration commands
 269        in each product build directory.
 270
 271     :param config Config: The global configuration
 272     :param products_info list: List of
 273                                  (str, Config) => (product_name, product_info)
 274     :param logger Logger: The logger instance to use for the display and logging
 275     :return: the number of failing commands.
 276     :rtype: int
 277     '''
 278     res = 0
 279     for p_name_info in products_infos:
 280
 281         p_name, p_info = p_name_info
 282
 283         # Logging
 284         len_end_line = 30
 285         logger.write("\n", 4, False)
 286         logger.write("################ ", 4)
 287         header = _("Compilation of %s") % src.printcolors.printcLabel(p_name)
 288         header += " %s " % ("." * (len_end_line - len(p_name)))
 289         logger.write(header, 3)
 290         logger.write("\n", 4, False)
 291         logger.flush()
 292
 293         # Clean the build and the install directories
 294         # if the corresponding options was called
 295         if options.clean_all:
 296             log_step(logger, header, "CLEAN BUILD AND INSTALL")
 297             sat.clean(config.VARS.application +
 298                       " --products " + p_name +
 299                       " --build --install", batch=True, verbose=0)
 300
 301         # Clean the the install directory
 302         # if the corresponding option was called
 303         if options.clean_install and not options.clean_all:
 304             log_step(logger, header, "CLEAN INSTALL")
 305             sat.clean(config.VARS.application +
 306                       " --products " + p_name +
 307                       " --install", batch=True, verbose=0)
 308
 309         # Check if it was already successfully installed
 310         if src.product.check_installation(p_info):
 311             logger.write(_("Already installed\n"))
 312             continue
 313
 314         # If the show option was called, do not launch the compilation
 315         if options.no_compile:
 316             logger.write(_("Not installed\n"))
 317             continue
 318
 319         # Check if the dependencies are installed
 320         l_depends_not_installed = check_dependencies(config, p_name_info)
 321         if len(l_depends_not_installed) > 0:
 322             logger.write(src.printcolors.printcError(
 323                     _("ERROR : the following product(s) is(are) mandatory: ")))
 324             for prod_name in l_depends_not_installed:
 325                 logger.write(src.printcolors.printcError(prod_name + " "))
 326             logger.write("\n")
 327             continue
 328
 329         # Call the function to compile the product
 330         res_prod, len_end_line, error_step = compile_product(sat,
 331                                                              p_name_info,
 332                                                              config,
 333                                                              options,
 334                                                              logger,
 335                                                              header,
 336                                                              len_end_line)
 337
 338         if res_prod != 0:
 339             # Clean the install directory if there is any
 340             sat.clean(config.VARS.application +
 341                       " --products " + p_name +
 342                       " --install", batch=True, verbose=0)
 343             res += 1
 344
 345         # Log the result
 346         if res_prod > 0:
 347             logger.write("\r%s%s" % (header, " " * len_end_line), 3)
 348             logger.write("\r" + header + src.printcolors.printcError("KO ") + error_step)
 349             logger.write("\n==== %(KO)s in compile of %(name)s \n" %
 350                 { "name" : p_name , "KO" : src.printcolors.printcInfo("ERROR")}, 4)
 351             logger.flush()
 352         else:
 353             logger.write("\r%s%s" % (header, " " * len_end_line), 3)
 354             logger.write("\r" + header + src.printcolors.printcSuccess("OK"))
 355             logger.write(_("\nINSTALL directory = %s" %
 356                            src.printcolors.printcInfo(p_info.install_dir)), 3)
 357             logger.write("\n==== %s \n" % src.printcolors.printcInfo("OK"), 4)
 358             logger.write("\n==== Compilation of %(name)s %(OK)s \n" %
 359                 { "name" : p_name , "OK" : src.printcolors.printcInfo("OK")}, 4)
 360             logger.flush()
 361         logger.write("\n", 3, False)
 362
 363
 364         if res_prod != 0 and options.stop_first_fail:
 365             break
 366
 367     return res
 368
 369 def compile_product(sat, p_name_info, config, options, logger, header, len_end):
 370     '''Execute the proper configuration command(s)
 371        in the product build directory.
 372
 373     :param p_name_info tuple: (str, Config) => (product_name, product_info)
 374     :param config Config: The global configuration
 375     :param logger Logger: The logger instance to use for the display
 376                           and logging
 377     :return: 1 if it fails, else 0.
 378     :rtype: int
 379     '''
 380
 381     p_name, p_info = p_name_info
 382
 383     # Execute "sat configure", "sat make" and "sat install"
 384     res = 0
 385     error_step = ""
 386
 387     # Logging and sat command call for configure step
 388     len_end_line = len_end
 389     log_step(logger, header, "CONFIGURE")
 390     res_c = sat.configure(config.VARS.application + " --products " + p_name,
 391                           verbose = 0,
 392                           logger_add_link = logger)
 393     log_res_step(logger, res_c)
 394     res += res_c
 395
 396     if res_c > 0:
 397         error_step = "CONFIGURE"
 398     else:
 399         # Logging and sat command call for make step
 400         # Logging take account of the fact that the product has a compilation
 401         # script or not
 402         if src.product.product_has_script(p_info):
 403             # if the product has a compilation script,
 404             # it is executed during make step
 405             scrit_path_display = src.printcolors.printcLabel(
 406                                                         p_info.compil_script)
 407             log_step(logger, header, "SCRIPT " + scrit_path_display)
 408             len_end_line = len(scrit_path_display)
 409         else:
 410             log_step(logger, header, "MAKE")
 411         make_arguments = config.VARS.application + " --products " + p_name
 412         # Get the make_flags option if there is any
 413         if options.makeflags:
 414             make_arguments += " --option -j" + options.makeflags
 415         res_m = sat.make(make_arguments,
 416                          verbose = 0,
 417                          logger_add_link = logger)
 418         log_res_step(logger, res_m)
 419         res += res_m
 420
 421         if res_m > 0:
 422             error_step = "MAKE"
 423         else:
 424             # Logging and sat command call for make install step
 425             log_step(logger, header, "MAKE INSTALL")
 426             res_mi = sat.makeinstall(config.VARS.application +
 427                                      " --products " +
 428                                      p_name,
 429                                     verbose = 0,
 430                                     logger_add_link = logger)
 431
 432             log_res_step(logger, res_mi)
 433             res += res_mi
 434
 435             if res_mi > 0:
 436                 error_step = "MAKE INSTALL"
 437
 438     # Add the config file corresponding to the dependencies/versions of the
 439     # product that have been successfully compiled
 440     if res==0:
 441         logger.write(_("Add the config file in installation directory\n"), 5)
 442         add_compile_config_file(p_info, config)
 443
 444     return res, len_end_line, error_step
 445
 446 def add_compile_config_file(p_info, config):
 447     '''Execute the proper configuration command(s)
 448        in the product build directory.
 449
 450     :param p_info Config: The specific config of the product
 451     :param config Config: The global configuration
 452     '''
 453     # Create the compile config
 454     compile_cfg = src.pyconf.Config()
 455     for prod_name in p_info.depend:
 456         if prod_name not in compile_cfg:
 457             compile_cfg.addMapping(prod_name,
 458                                    src.pyconf.Mapping(compile_cfg),
 459                                    "")
 460         prod_dep_info = src.product.get_product_config(config, prod_name, False)
 461         compile_cfg[prod_name] = prod_dep_info.version
 462     # Write it in the install directory of the product
 463     compile_cfg_path = os.path.join(p_info.install_dir, src.CONFIG_FILENAME)
 464     f = open(compile_cfg_path, 'w')
 465     compile_cfg.__save__(f)
 466     f.close()
 467
 468 def description():
 469     '''method that is called when salomeTools is called with --help option.
 470
 471     :return: The text to display for the compile command description.
 472     :rtype: str
 473     '''
 474     return _("The compile command constructs the products of the application")
 475
 476 def run(args, runner, logger):
 477     '''method that is called when salomeTools is called with compile parameter.
 478     '''
 479
 480     # Parse the options
 481     (options, args) = parser.parse_args(args)
 482
 483     # Warn the user if he invoked the clean_all option
 484     # without --products option
 485     if (options.clean_all and
 486         options.products is None and
 487         not runner.options.batch):
 488         rep = input(_("You used --clean_all without specifying a product"
 489                           " are you sure you want to continue? [Yes/No] "))
 490         if rep.upper() != _("YES").upper():
 491             return 0
 492
 493     # check that the command has been called with an application
 494     src.check_config_has_application( runner.cfg )
 495
 496     # Get the list of products to treat
 497     products_infos = get_products_list(options, runner.cfg, logger)
 498
 499     if options.fathers:
 500         # Extend the list with all recursive dependencies of the given products
 501         products_infos = extend_with_fathers(runner.cfg, products_infos)
 502
 503     if options.children:
 504         # Extend the list with all products that use the given products
 505         products_infos = extend_with_children(runner.cfg, products_infos)
 506
 507     # Sort the list regarding the dependencies of the products
 508     products_infos = sort_products(runner.cfg, products_infos)
 509
 510     # Print some informations
 511     logger.write(_('Executing the compile commands in the build '
 512                                 'directories of the products of '
 513                                 'the application %s\n') %
 514                 src.printcolors.printcLabel(runner.cfg.VARS.application), 1)
 515
 516     info = [
 517             (_("SOURCE directory"),
 518              os.path.join(runner.cfg.APPLICATION.workdir, 'SOURCES')),
 519             (_("BUILD directory"),
 520              os.path.join(runner.cfg.APPLICATION.workdir, 'BUILD'))
 521             ]
 522     src.print_info(logger, info)
 523
 524     # Call the function that will loop over all the products and execute
 525     # the right command(s)
 526     res = compile_all_products(runner, runner.cfg, options, products_infos, logger)
 527
 528     # Print the final state
 529     nb_products = len(products_infos)
 530     if res == 0:
 531         final_status = "OK"
 532     else:
 533         final_status = "KO"
 534
 535     logger.write(_("\nCompilation: %(status)s (%(valid_result)d/%(nb_products)d)\n") % \
 536         { 'status': src.printcolors.printc(final_status),
 537           'valid_result': nb_products - res,
 538           'nb_products': nb_products }, 1)
 539
 540     code = res
 541     if code != 0:
 542         code = 1
 543     return code