src/product.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 """\
  20 In this file are implemented the methods
  21 relative to the product notion of salomeTools
  22 """
  23
  24 import os
  25 import re
  26 import pprint as PP
  27
  28 import src
  29 import src.debug as DBG
  30 import src.versionMinorMajorPatch as VMMP
  31
  32 AVAILABLE_VCS = ['git', 'svn', 'cvs']
  33
  34 CONFIG_FILENAME = "sat-config.pyconf" # trace product depends version(s)
  35 PRODUCT_FILENAME = "sat-product.pyconf" # trace product compile config
  36 config_expression = "^config-\d+$"
  37
  38 def get_product_config(config, product_name, with_install_dir=True):
  39     """Get the specific configuration of a product from the global configuration
  40
  41     :param config Config: The global configuration
  42     :param product_name str: The name of the product
  43     :param with_install_dir boolean: If false, do not provide an install
  44                                      directory (at false only for internal use
  45                                      of the function check_config_exists)
  46     :return: the specific configuration of the product
  47     :rtype: Config
  48     """
  49
  50     # Get the version of the product from the application definition
  51     version = config.APPLICATION.products[product_name]
  52
  53     # Define debug and dev modes
  54     # Get the tag if a dictionary is given in APPLICATION.products for the
  55     # current product
  56     debug = 'no'
  57     dev = 'no'
  58     hpc = 'no'
  59     verbose = 'no'
  60     base = 'maybe'
  61     section = None
  62
  63     # if no version, then take the default one defined in the application
  64     if isinstance(version, bool) or isinstance(version, str):
  65         # in this case tag is mandatory, not debug, verbose, dev
  66         if 'debug' in config.APPLICATION:
  67             debug = config.APPLICATION.debug
  68         if 'verbose' in config.APPLICATION:
  69             verbose = config.APPLICATION.verbose
  70         if 'dev' in config.APPLICATION:
  71             dev = config.APPLICATION.dev
  72         if 'hpc' in config.APPLICATION:
  73             hpc = config.APPLICATION.hpc
  74
  75     # special case for which only the product name is mentionned
  76     if isinstance(version, bool):
  77         version = config.APPLICATION.tag
  78
  79     if isinstance(version, src.pyconf.Mapping):
  80         dic_version = version
  81         # Get the version/tag
  82         if not 'tag' in dic_version:
  83             version = config.APPLICATION.tag
  84         else:
  85             version = dic_version.tag
  86
  87         # Get the debug if any
  88         if 'debug' in dic_version:
  89             debug = dic_version.debug
  90         elif 'debug' in config.APPLICATION:
  91             debug = config.APPLICATION.debug
  92
  93         # Get the verbose if any
  94         if 'verbose' in dic_version:
  95             verbose = dic_version.verbose
  96         elif 'verbose' in config.APPLICATION:
  97             verbose = config.APPLICATION.verbose
  98
  99         # Get the dev if any
 100         if 'dev' in dic_version:
 101             dev = dic_version.dev
 102         elif 'dev' in config.APPLICATION:
 103             dev = config.APPLICATION.dev
 104
 105         # Get the hpc if any
 106         if 'hpc' in dic_version:
 107             hpc = dic_version.hpc
 108         elif 'hpc' in config.APPLICATION:
 109             hpc = config.APPLICATION.hpc
 110
 111         # Get the base if any
 112         if 'base' in dic_version:
 113             base = dic_version.base
 114
 115         # Get the section if any
 116         if 'section' in dic_version:
 117             section = dic_version.section
 118
 119     # this case occur when version is overwritten, cf sat # 8897
 120     if isinstance(version, dict):
 121         dic_version = version
 122         # Get the version/tag
 123         if not 'tag' in dic_version:
 124             version = config.APPLICATION.tag
 125         else:
 126             version = dic_version["tag"]
 127
 128         # Get the debug if any
 129         if 'debug' in dic_version:
 130             debug = dic_version["debug"]
 131         elif 'debug' in config.APPLICATION:
 132             debug = config.APPLICATION.debug
 133
 134         # Get the verbose if any
 135         if 'verbose' in dic_version:
 136             verbose = dic_version["verbose"]
 137         elif 'verbose' in config.APPLICATION:
 138             verbose = config.APPLICATION.verbose
 139
 140         # Get the dev if any
 141         if 'dev' in dic_version:
 142             dev = dic_version["dev"]
 143         elif 'dev' in config.APPLICATION:
 144             dev = config.APPLICATION.dev
 145
 146         # Get the hpc if any
 147         if 'hpc' in dic_version:
 148             hpc = dic_version.hpc
 149         elif 'hpc' in config.APPLICATION:
 150             hpc = config.APPLICATION.hpc
 151
 152         # Get the base if any
 153         if 'base' in dic_version:
 154             base = dic_version["base"]
 155
 156         # Get the section if any
 157         if 'section' in dic_version:
 158             section = dic_version['section']
 159
 160     vv = version
 161     # substitute some character with _ in order to get the correct definition
 162     # in config.PRODUCTS. This is done because the pyconf tool does not handle
 163     # the . and - characters
 164     for c in ".-": vv = vv.replace(c, "_")
 165
 166     prod_info = None
 167     if product_name in config.PRODUCTS:
 168         # Search for the product description in the configuration
 169         prod_info = get_product_section(config, product_name, vv, section)
 170
 171         # get salomeTool version
 172         prod_info.sat_version = src.get_salometool_version(config)
 173
 174         # merge opt_depend in depend
 175         if prod_info is not None and 'opt_depend' in prod_info:
 176             for depend in prod_info.opt_depend:
 177                 if depend in config.APPLICATION.products:
 178                     prod_info.depend.append(depend,'')
 179
 180
 181         # In case of a product get with a vcs,
 182         # put the tag (equal to the version)
 183         if prod_info is not None and prod_info.get_source in AVAILABLE_VCS:
 184
 185             if prod_info.get_source == 'git':
 186                 prod_info.git_info.tag = version
 187
 188             if prod_info.get_source == 'svn':
 189                 prod_info.svn_info.tag = version
 190
 191             if prod_info.get_source == 'cvs':
 192                 prod_info.cvs_info.tag = version
 193
 194         # In case of a fixed product,
 195         # define the install_dir (equal to the version)
 196         if prod_info is not None and \
 197            (os.path.isdir(version) or version.startswith("/")):
 198            # we consider a (fixed) path  existing paths;
 199            # or paths starting with '/' (the objective is to print a correct
 200            # message to the user in case of non existing path.)
 201             prod_info.install_dir = version
 202             prod_info.get_source = "fixed"
 203
 204         # Check if the product is defined as native in the application
 205         if prod_info is not None:
 206             if version == "native":
 207                 prod_info.get_source = "native"
 208             elif prod_info.get_source == "native":
 209                 msg = _("The product %(prod)s has version %(ver)s but is "
 210                         "declared as native in its definition" %
 211                         { 'prod': prod_info.name, 'ver': version})
 212                 raise src.SatException(msg)
 213
 214     # If there is no definition but the product is declared as native,
 215     # construct a new definition containing only the get_source key
 216     if prod_info is None and version == "native":
 217         prod_info = src.pyconf.Config()
 218         prod_info.name = product_name
 219         prod_info.get_source = "native"
 220
 221     # If there is no definition but the product is fixed,
 222     # construct a new definition containing only the product name
 223     if prod_info is None and os.path.isdir(version):
 224         prod_info = src.pyconf.Config()
 225         prod_info.name = product_name
 226         prod_info.get_source = "fixed"
 227         prod_info.addMapping("environ", src.pyconf.Mapping(prod_info), "")
 228
 229
 230     # If prod_info is still None, it means that there is no product definition
 231     # in the config. The user has to provide it.
 232     if prod_info is None:
 233         prod_pyconf_path = src.find_file_in_lpath(product_name + ".pyconf",
 234                                                   config.PATHS.PRODUCTPATH)
 235         if not prod_pyconf_path:
 236             msg = _("""\
 237 No definition found for the product %(1)s.
 238 Please create a %(1)s.pyconf file somewhere in:
 239   %(2)s""") % {
 240   "1": product_name,
 241   "2": PP.pformat(config.PATHS.PRODUCTPATH) }
 242         else:
 243             msg = _("""\
 244 No definition corresponding to the version %(1)s was found in the file:
 245   %(2)s.
 246 Please add a section in it.""") % {"1" : vv, "2" : prod_pyconf_path}
 247         raise src.SatException(msg)
 248
 249     # Set the debug, dev and version keys
 250     prod_info.debug = debug
 251     prod_info.verbose = verbose
 252     prod_info.dev = dev
 253     prod_info.hpc = hpc
 254     prod_info.version = version
 255
 256     # Set the archive_info if the product is get in archive mode
 257     if prod_info.get_source == "archive":
 258         if not "archive_info" in prod_info:
 259             prod_info.addMapping("archive_info",
 260                                  src.pyconf.Mapping(prod_info),
 261                                  "")
 262         if "archive_name" in prod_info.archive_info:
 263             arch_name = prod_info.archive_info.archive_name
 264         elif "archive_prefix" in prod_info.archive_info:
 265             arch_name = prod_info.archive_info.archive_prefix + "-" + version + ".tar.gz"
 266         else:
 267             # standard name
 268             arch_name = product_name + "-" + version + ".tar.gz"
 269
 270         arch_path = src.find_file_in_lpath(arch_name,
 271                                            config.PATHS.ARCHIVEPATH)
 272         if not arch_path:
 273             # arch_path is not found. It may generate an error in sat source,
 274             #                         unless the archive is found in ftp serveur
 275             msg = _("Archive %(1)s for %(2)s not found in config.PATHS.ARCHIVEPATH") % \
 276                    {"1" : arch_name, "2" : prod_info.name}
 277             DBG.tofix(msg, config.PATHS.ARCHIVEPATH)
 278             prod_info.archive_info.archive_name = arch_name #without path
 279         else:
 280             prod_info.archive_info.archive_name = arch_path
 281
 282
 283     # If the product compiles with a script, check the script existence
 284     # and if it is executable
 285     if product_has_script(prod_info):
 286         # Check the compil_script key existence
 287         if "compil_script" not in prod_info:
 288             msg = _("""\
 289 No compilation script found for the product %s.
 290 Please provide a 'compil_script' key in its definition.""") % product_name
 291             raise src.SatException(msg)
 292
 293         # Get the path of the script file
 294         # if windows supposed '.bat', if linux supposed '.sh'
 295         # but user set extension script file in his pyconf as he wants, no obligation.
 296         script = prod_info.compil_script
 297         script_name = os.path.basename(script)
 298         if script == script_name:
 299             # Only a name is given. Search in the default directory
 300             script_path = src.find_file_in_lpath(script_name, config.PATHS.PRODUCTPATH, "compil_scripts")
 301             if not script_path:
 302                 msg = _("Compilation script %s not found in") % script_name
 303                 DBG.tofix(msg, config.PATHS.PRODUCTPATH, True) # say where searched
 304                 script_path = "%s_(Not_Found_by_Sat!!)" % script_name
 305             prod_info.compil_script = script_path
 306
 307
 308         # Check that the script is executable
 309         if os.path.exists(prod_info.compil_script) and not os.access(prod_info.compil_script, os.X_OK):
 310             DBG.tofix("Compilation script  file is not in 'execute mode'", prod_info.compil_script, True)
 311
 312     # Get the full paths of all the patches
 313     if product_has_patches(prod_info):
 314         patches = []
 315         try:
 316           for patch in prod_info.patches:
 317               patch_path = patch
 318               # If only a filename, then search for the patch in the PRODUCTPATH
 319               if os.path.basename(patch_path) == patch_path:
 320                   # Search in the PRODUCTPATH/patches
 321                   patch_path = src.find_file_in_lpath(patch,
 322                                                       config.PATHS.PRODUCTPATH,
 323                                                       "patches")
 324                   if not patch_path:
 325                       msg = _("Patch %(patch_name)s for %(prod_name)s not found:"
 326                               "\n" % {"patch_name" : patch,
 327                                        "prod_name" : prod_info.name})
 328                       raise src.SatException(msg)
 329               patches.append(patch_path)
 330         except:
 331           DBG.tofix("problem in prod_info.patches", prod_info)
 332         prod_info.patches = patches
 333
 334     # Get the full paths of the environment scripts
 335     if product_has_env_script(prod_info):
 336         env_script_path = prod_info.environ.env_script
 337         # If only a filename, then search for the environment script
 338         # in the PRODUCTPATH/env_scripts
 339         if os.path.basename(env_script_path) == env_script_path:
 340             # Search in the PRODUCTPATH/env_scripts
 341             env_script_path = src.find_file_in_lpath(
 342                                             prod_info.environ.env_script,
 343                                             config.PATHS.PRODUCTPATH,
 344                                             "env_scripts")
 345             if not env_script_path:
 346                 msg = _("Environment script %(env_name)s for %(prod_name)s not "
 347                         "found.\n" % {"env_name" : env_script_path,
 348                                        "prod_name" : prod_info.name})
 349                 raise src.SatException(msg)
 350
 351         prod_info.environ.env_script = env_script_path
 352
 353     if with_install_dir:
 354         # The variable with_install_dir is at false only for internal use
 355         # of the function get_install_dir
 356
 357         # Save the install_dir key if there is any
 358         if "install_dir" in prod_info and not "install_dir_save" in prod_info:
 359             prod_info.install_dir_save = prod_info.install_dir
 360
 361         # if it is not the first time the install_dir is computed, it means
 362         # that install_dir_save exists and it has to be taken into account.
 363         if "install_dir_save" in prod_info:
 364             prod_info.install_dir = prod_info.install_dir_save
 365
 366         # Set the install_dir key
 367         prod_info.install_dir = get_install_dir(config, base, version, prod_info)
 368
 369     return prod_info
 370
 371 def get_product_section(config, product_name, version, section=None, verbose=False):
 372     """Get the product description from the configuration
 373
 374     :param config Config: The global configuration
 375     :param product_name str: The product name
 376     :param version str: The version of the product as 'V8_4_0', or else.
 377     :param section str: The searched section (if not None, the section is
 378                         explicitly given
 379     :return: The product description
 380     :rtype: Config
 381     """
 382
 383     # if section is not None, try to get the corresponding section
 384     aProd = config.PRODUCTS[product_name]
 385     try:
 386       versionMMP = VMMP.MinorMajorPatch(version)
 387     except: # example setuptools raise "minor in major_minor_patch is not integer: '0_6c11'"
 388       versionMMP = None
 389     DBG.write("get_product_section for product %s '%s' as version '%s'" % (product_name, version, versionMMP),
 390               (section, aProd.keys()), verbose)
 391     # DBG.write("yoo1", aProd, True)
 392     if section:
 393         if section not in aProd:
 394             return None
 395         # returns specific information for the given version
 396         prod_info = aProd[section]
 397         prod_info.section = section
 398         prod_info.from_file = aProd.from_file
 399         return prod_info
 400
 401     # If it exists, get the information of the product_version
 402     # ex: 'version_V6_6_0' as salome version classical syntax
 403     if "version_" + version in aProd:
 404         DBG.write("found section for version_" + version, "", verbose)
 405         # returns specific information for the given version
 406         prod_info = aProd["version_" + version]
 407         prod_info.section = "version_" + version
 408         prod_info.from_file = aProd.from_file
 409         return prod_info
 410
 411     # Else, check if there is a description for multiple versions
 412     l_section_names = aProd.keys()
 413     l_section_ranges = []
 414     tagged = []
 415     for name in l_section_names:
 416       # DBG.write("name", name,True)
 417       aRange = VMMP.getRange_majorMinorPatch(name)
 418       if aRange is not None:
 419         DBG.write("found version range for section '%s'" % name, aRange, verbose)
 420         l_section_ranges.append((name, aRange))
 421
 422     if versionMMP is not None and len(l_section_ranges) > 0:
 423       for name, (vmin, vmax) in l_section_ranges:
 424         if versionMMP >= vmin and versionMMP <= vmax:
 425           tagged.append((name, [vmin, vmax]))
 426
 427     if len(tagged) > 1:
 428       DBG.write("multiple version ranges tagged for '%s', fix it" % version,
 429                      PP.pformat(tagged), True)
 430       return None
 431     if len(tagged) == 1: # ok
 432       DBG.write("one version range tagged for '%s'" % version,
 433                    PP.pformat(tagged), verbose)
 434       name, (vmin, vmax) = tagged[0]
 435       prod_info = aProd[name]
 436       prod_info.section = name
 437       prod_info.from_file = aProd.from_file
 438       return prod_info
 439
 440     # Else, get the standard informations
 441     if "default" in aProd:
 442         # returns the generic information (given version not found)
 443         prod_info = aProd.default
 444         DBG.write("default tagged for '%s'" % version, prod_info, verbose)
 445         prod_info.section = "default"
 446         prod_info.from_file = aProd.from_file
 447         return prod_info
 448
 449     # if noting was found, return None
 450     return None
 451
 452 def get_install_dir(config, base, version, prod_info):
 453     """Compute the installation directory of a given product
 454
 455     :param config Config: The global configuration
 456     :param base str: This corresponds to the value given by user in its
 457                      application.pyconf for the specific product. If "yes", the
 458                      user wants the product to be in base. If "no", he wants the
 459                      product to be in the application workdir
 460     :param version str: The version of the product
 461     :param product_info Config: The configuration specific to
 462                                the product
 463
 464     :return: The path of the product installation
 465     :rtype: str
 466     """
 467     install_dir = ""
 468     in_base = False
 469     if (("install_dir" in prod_info and prod_info.install_dir == "base")
 470                                                             or base == "yes"):
 471         in_base = True
 472     if (base == "no" or ("no_base" in config.APPLICATION
 473                          and config.APPLICATION.no_base == "yes")):
 474         in_base = False
 475
 476     if in_base:
 477         install_dir = get_base_install_dir(config, prod_info, version)
 478     else:
 479         if "install_dir" not in prod_info or prod_info.install_dir == "base":
 480             # Set it to the default value (in application directory)
 481             install_dir = os.path.join(config.APPLICATION.workdir,
 482                                                 "INSTALL",
 483                                                 prod_info.name)
 484         else:
 485             install_dir = prod_info.install_dir
 486
 487     return install_dir
 488
 489 def get_base_install_dir(config, prod_info, version):
 490     """Compute the installation directory of a product in base
 491
 492     :param config Config: The global configuration
 493     :param product_info Config: The configuration specific to
 494                                the product
 495     :param version str: The version of the product
 496     :return: The path of the product installation
 497     :rtype: str
 498     """
 499     base_path = src.get_base_path(config)
 500     prod_dir = os.path.join(base_path, prod_info.name + "-" + version)
 501     if not os.path.exists(prod_dir):
 502         return os.path.join(prod_dir, "config-1")
 503
 504     exists, install_dir = check_config_exists(config, prod_dir, prod_info)
 505     if exists:
 506         return install_dir
 507
 508     # Find the first config-<i> directory that is available in the product
 509     # directory
 510     found = False
 511     label = 1
 512     while not found:
 513         install_dir = os.path.join(prod_dir, "config-%i" % label)
 514         if os.path.exists(install_dir):
 515             label+=1
 516         else:
 517             found = True
 518
 519     return install_dir
 520
 521 def add_compile_config_file(p_info, config):
 522     '''Execute the proper configuration command(s)
 523        in the product build directory.
 524
 525     :param p_info Config: The specific config of the product
 526     :param config Config: The global configuration
 527     '''
 528     # Create the compile config
 529     # DBG.write("add_compile_config_file", p_info, True)
 530     res = src.pyconf.Config()
 531     res.addMapping(p_info.name, src.pyconf.Mapping(res), "")
 532     res[p_info.name]= p_info.version
 533
 534     for prod_name in p_info.depend:
 535       if prod_name not in res:
 536         res.addMapping(prod_name, src.pyconf.Mapping(res), "")
 537       prod_dep_info = src.product.get_product_config(config, prod_name, False)
 538       res[prod_name] = prod_dep_info.version
 539     # Write it in the install directory of the product
 540     # This file is for automatic reading/checking
 541     # see check_config_exists method
 542     aFile = os.path.join(p_info.install_dir, CONFIG_FILENAME)
 543     with open(aFile, 'w') as f:
 544       res.__save__(f)
 545
 546     # this file is not mandatory, is for human eye reading
 547     aFile = os.path.join(p_info.install_dir, PRODUCT_FILENAME)
 548     try:
 549       with open(aFile, 'w') as f:
 550         p_info.__save__(f, evaluated=True) # evaluated expressions mode
 551     except:
 552       # sometime some information cannot be evaluated.
 553       # for example, in the context of non VCS archives, information on git server is not available.
 554       DBG.write("Warning : sat was not able to evaluate and write down some information in file %s" % aFile)
 555
 556
 557 def check_config_exists(config, prod_dir, prod_info, verbose=False):
 558     """\
 559     Verify that the installation directory of a product in a base exists.
 560     Check all the config-<i>/sat-config.py files found for correspondence
 561     with current config and prod_info depend-version-tags
 562
 563     :param config Config: The global configuration
 564     :param prod_dir str: The product installation directory path
 565                          (without config-<i>)
 566     :param product_info Config: The configuration specific to
 567                                the product
 568     :return: True or false is the installation is found or not
 569              and if it is found, the path of the found installation
 570     :rtype: (boolean, str)
 571     """
 572     # check if the directories or files of the directory corresponds to the
 573     # directory installation of the product
 574     if os.path.isdir(prod_dir):
 575       l_dir_and_files = os.listdir(prod_dir)
 576     else:
 577       raise Exception("Inexisting directory '%s'" % prod_dir)
 578
 579     DBG.write("check_config_exists 000",  (prod_dir, l_dir_and_files), verbose)
 580     DBG.write("check_config_exists 111",  prod_info, verbose)
 581
 582     for dir_or_file in l_dir_and_files:
 583         oExpr = re.compile(config_expression)
 584         if not(oExpr.search(dir_or_file)):
 585             # in mode BASE, not config-<i>, not interesting
 586             # DBG.write("not interesting", dir_or_file, True)
 587             continue
 588         # check if there is the file sat-config.pyconf file in the installation
 589         # directory
 590         config_file = os.path.join(prod_dir, dir_or_file, CONFIG_FILENAME)
 591         DBG.write("check_config_exists 222", config_file, verbose)
 592         if not os.path.exists(config_file):
 593             continue
 594
 595         # check if there is the config described in the file corresponds the
 596         # dependencies of the product
 597         config_corresponds = True
 598         compile_cfg = src.pyconf.Config(config_file)
 599         for prod_dep in prod_info.depend:
 600             # if the dependency is not in the config,
 601             # the config does not correspond
 602             if prod_dep not in compile_cfg:
 603                 config_corresponds = False
 604                 break
 605             else:
 606                 prod_dep_info = get_product_config(config, prod_dep, False)
 607                 # If the version of the dependency does not correspond,
 608                 # the config does not correspond
 609                 if prod_dep_info.version != compile_cfg[prod_dep]:
 610                     config_corresponds = False
 611                     break
 612
 613         if config_corresponds:
 614           for prod_name in compile_cfg:
 615             # assume new compatibility with prod_name in sat-config.pyconf files
 616             if prod_name == prod_info.name:
 617               if prod_info.version == compile_cfg[prod_name]:
 618                 DBG.write("check_config_exists OK 333", compile_cfg, verbose)
 619                 pass
 620               else: # no correspondence with newer with prod_name sat-config.pyconf files
 621                 config_corresponds = False
 622                 break
 623             else:
 624               # as old compatibility without prod_name sat-config.pyconf files
 625               if prod_name not in prod_info.depend:
 626                 # here there is an unexpected depend in an old compilation
 627                 config_corresponds = False
 628                 break
 629
 630         if config_corresponds: # returns (and stops) at first correspondence found
 631             DBG.write("check_config_exists OK 444", dir_or_file, verbose)
 632             return True, os.path.join(prod_dir, dir_or_file)
 633
 634     # no correspondence found
 635     return False, None
 636
 637
 638
 639 def get_products_infos(lproducts, config):
 640     """Get the specific configuration of a list of products
 641
 642     :param lproducts List: The list of product names
 643     :param config Config: The global configuration
 644     :return: the list of tuples
 645              (product name, specific configuration of the product)
 646     :rtype: [(str, Config)]
 647     """
 648     products_infos = []
 649     # Loop on product names
 650     for prod in lproducts:
 651         # Get the specific configuration of the product
 652         prod_info = get_product_config(config, prod)
 653         if prod_info is not None:
 654             products_infos.append((prod, prod_info))
 655         else:
 656             msg = _("The %s product has no definition in the configuration.") % prod
 657             raise src.SatException(msg)
 658     return products_infos
 659
 660
 661 def get_products_list(options, cfg, logger):
 662     """
 663     method that gives the product list with their informations from
 664     configuration regarding the passed options.
 665
 666     :param options Options: The Options instance that stores the commands arguments
 667     :param cfg Config: The global configuration
 668     :param logger Logger: The logger instance to use for the display and logging
 669     :return: The list of (product name, product_informations).
 670     :rtype: List
 671     """
 672     # Get the products to be prepared, regarding the options
 673     if options.products is None:
 674         # No options, get all products sources
 675         products = cfg.APPLICATION.products
 676     else:
 677         # if option --products, check that all products of the command line
 678         # are present in the application.
 679         """products = options.products
 680         for p in products:
 681             if p not in cfg.APPLICATION.products:
 682                 raise src.SatException(_("Product %(product)s "
 683                             "not defined in application %(application)s") %
 684                         { 'product': p, 'application': cfg.VARS.application} )"""
 685
 686         products = src.getProductNames(cfg, options.products, logger)
 687
 688     # Construct the list of tuple containing
 689     # the products name and their definition
 690     resAll = src.product.get_products_infos(products, cfg)
 691
 692     # if the property option was passed, filter the list
 693     if options.properties: # existing properties
 694       ok = []
 695       ko = []
 696       res =[]
 697       prop, value = options.properties # for example 'is_SALOME_module', 'yes'
 698       for p_name, p_info in resAll:
 699         try:
 700           if p_info.properties[prop] == value:
 701             res.append((p_name, p_info))
 702             ok.append(p_name)
 703           else:
 704             ko.append(p_name)
 705         except:
 706           ko.append(p_name)
 707
 708       if len(ok) != len(resAll):
 709         logger.trace("on properties %s\n products accepted:\n %s\n products rejected:\n %s\n" %
 710                        (options.properties, PP.pformat(sorted(ok)), PP.pformat(sorted(ko))))
 711       else:
 712         logger.warning("properties %s\n seems useless with no products rejected" %
 713                        (options.properties))
 714     else:
 715       res = resAll # not existing properties as all accepted
 716
 717     return res
 718
 719
 720 def get_product_dependencies(config, product_info):
 721     """\
 722     Get recursively the list of products that are
 723     in the product_info dependencies
 724
 725     :param config Config: The global configuration
 726     :param product_info Config: The configuration specific to
 727                                the product
 728     :return: the list of products in dependence
 729     :rtype: list
 730     """
 731     if "depend" not in product_info or product_info.depend == []:
 732         return []
 733     res = []
 734     for prod in product_info.depend:
 735         if prod == product_info.name:
 736             continue
 737         if prod not in res:
 738             res.append(prod)
 739         prod_info = get_product_config(config, prod)
 740         dep_prod = get_product_dependencies(config, prod_info)
 741         for prod_in_dep in dep_prod:
 742             if prod_in_dep not in res:
 743                 res.append(prod_in_dep)
 744     return res
 745
 746 def check_installation(product_info):
 747     """\
 748     Verify if a product is well installed. Checks install directory presence
 749     and some additional files if it is defined in the config
 750
 751     :param product_info Config: The configuration specific to
 752                                the product
 753     :return: True if it is well installed
 754     :rtype: boolean
 755     """
 756     if not product_compiles(product_info):
 757         return True
 758     install_dir = product_info.install_dir
 759     if not os.path.exists(install_dir):
 760         return False
 761     if ("present_files" in product_info and
 762         "install" in product_info.present_files):
 763         for file_relative_path in product_info.present_files.install:
 764             file_path = os.path.join(install_dir, file_relative_path)
 765             if not os.path.exists(file_path):
 766                 return False
 767     return True
 768
 769 def check_source(product_info):
 770     """Verify if a sources of product is preset. Checks source directory presence
 771
 772     :param product_info Config: The configuration specific to
 773                                the product
 774     :return: True if it is well installed
 775     :rtype: boolean
 776     """
 777     DBG.write("check_source product_info", product_info)
 778     source_dir = product_info.source_dir
 779     if not os.path.exists(source_dir):
 780         return False
 781     if ("present_files" in product_info and
 782         "source" in product_info.present_files):
 783         for file_relative_path in product_info.present_files.source:
 784             file_path = os.path.join(source_dir, file_relative_path)
 785             if not os.path.exists(file_path):
 786                 return False
 787     return True
 788
 789 def product_is_salome(product_info):
 790     """Know if a product is a SALOME module
 791
 792     :param product_info Config: The configuration specific to
 793                                the product
 794     :return: True if the product is a SALOME module, else False
 795     :rtype: boolean
 796     """
 797     return ("properties" in product_info and
 798             "is_SALOME_module" in product_info.properties and
 799             product_info.properties.is_SALOME_module == "yes")
 800
 801 def product_is_fixed(product_info):
 802     """Know if a product is fixed
 803
 804     :param product_info Config: The configuration specific to
 805                                the product
 806     :return: True if the product is fixed, else False
 807     :rtype: boolean
 808     """
 809     get_src = product_info.get_source
 810     return get_src.lower() == 'fixed'
 811
 812 def product_is_native(product_info):
 813     """Know if a product is native
 814
 815     :param product_info Config: The configuration specific to
 816                                the product
 817     :return: True if the product is native, else False
 818     :rtype: boolean
 819     """
 820     get_src = product_info.get_source
 821     return get_src.lower() == 'native'
 822
 823 def product_is_dev(product_info):
 824     """Know if a product is in dev mode
 825
 826     :param product_info Config: The configuration specific to
 827                                the product
 828     :return: True if the product is in dev mode, else False
 829     :rtype: boolean
 830     """
 831     dev = product_info.dev
 832     res = (dev.lower() == 'yes')
 833     DBG.write('product_is_dev %s' % product_info.name, res)
 834     # if product_info.name == "XDATA": return True #test #10569
 835     return res
 836
 837 def product_is_hpc(product_info):
 838     """Know if a product is in hpc mode
 839
 840     :param product_info Config: The configuration specific to
 841                                the product
 842     :return: True if the product is in hpc mode, else False
 843     :rtype: boolean
 844     """
 845     hpc = product_info.hpc
 846     res = (hpc.lower() == 'yes')
 847     return res
 848
 849 def product_is_debug(product_info):
 850     """Know if a product is in debug mode
 851
 852     :param product_info Config: The configuration specific to
 853                                the product
 854     :return: True if the product is in debug mode, else False
 855     :rtype: boolean
 856     """
 857     debug = product_info.debug
 858     return debug.lower() == 'yes'
 859
 860 def product_is_verbose(product_info):
 861     """Know if a product is in verbose mode
 862
 863     :param product_info Config: The configuration specific to
 864                                the product
 865     :return: True if the product is in verbose mode, else False
 866     :rtype: boolean
 867     """
 868     verbose = product_info.verbose
 869     return verbose.lower() == 'yes'
 870
 871 def product_is_autotools(product_info):
 872     """Know if a product is compiled using the autotools
 873
 874     :param product_info Config: The configuration specific to
 875                                the product
 876     :return: True if the product is autotools, else False
 877     :rtype: boolean
 878     """
 879     build_src = product_info.build_source
 880     return build_src.lower() == 'autotools'
 881
 882 def product_is_cmake(product_info):
 883     """Know if a product is compiled using the cmake
 884
 885     :param product_info Config: The configuration specific to
 886                                the product
 887     :return: True if the product is cmake, else False
 888     :rtype: boolean
 889     """
 890     build_src = product_info.build_source
 891     return build_src.lower() == 'cmake'
 892
 893 def product_is_vcs(product_info):
 894     """Know if a product is download using git, svn or cvs (not archive)
 895
 896     :param product_info Config: The configuration specific to
 897                                the product
 898     :return: True if the product is vcs, else False
 899     :rtype: boolean
 900     """
 901     return product_info.get_source in AVAILABLE_VCS
 902
 903 def product_is_smesh_plugin(product_info):
 904     """Know if a product is a SMESH plugin
 905
 906     :param product_info Config: The configuration specific to
 907                                the product
 908     :return: True if the product is a SMESH plugin, else False
 909     :rtype: boolean
 910     """
 911     return ("properties" in product_info and
 912             "smesh_plugin" in product_info.properties and
 913             product_info.properties.smesh_plugin == "yes")
 914
 915 def product_is_cpp(product_info):
 916     """Know if a product is cpp
 917
 918     :param product_info Config: The configuration specific to
 919                                the product
 920     :return: True if the product is a cpp, else False
 921     :rtype: boolean
 922     """
 923     return ("properties" in product_info and
 924             "cpp" in product_info.properties and
 925             product_info.properties.cpp == "yes")
 926
 927 def product_compiles(product_info):
 928     """\
 929     Know if a product compiles or not
 930     (some products do not have a compilation procedure)
 931
 932     :param product_info Config: The configuration specific to
 933                                the product
 934     :return: True if the product compiles, else False
 935     :rtype: boolean
 936     """
 937     return not("properties" in product_info and
 938             "compilation" in product_info.properties and
 939             product_info.properties.compilation == "no")
 940
 941 def product_has_script(product_info):
 942     """Know if a product has a compilation script
 943
 944     :param product_info Config: The configuration specific to
 945                                the product
 946     :return: True if the product it has a compilation script, else False
 947     :rtype: boolean
 948     """
 949     if "build_source" not in product_info:
 950         # Native case
 951         return False
 952     build_src = product_info.build_source
 953     return build_src.lower() == 'script'
 954
 955 def product_has_env_script(product_info):
 956     """Know if a product has an environment script
 957
 958     :param product_info Config: The configuration specific to
 959                                the product
 960     :return: True if the product it has an environment script, else False
 961     :rtype: boolean
 962     """
 963     return "environ" in product_info and "env_script" in product_info.environ
 964
 965 def product_has_patches(product_info):
 966     """Know if a product has one or more patches
 967
 968     :param product_info Config: The configuration specific to
 969                                the product
 970     :return: True if the product has one or more patches
 971     :rtype: boolean
 972     """
 973     res = ( "patches" in product_info and len(product_info.patches) > 0 )
 974     DBG.write('product_has_patches %s' % product_info.name, res)
 975     # if product_info.name == "XDATA": return True #test #10569
 976     return res
 977
 978 def product_has_logo(product_info):
 979     """Know if a product has a logo (YACSGEN generate)
 980
 981     :param product_info Config: The configuration specific to
 982                                the product
 983     :return: The path of the logo if the product has a logo, else False
 984     :rtype: Str
 985     """
 986     if ("properties" in product_info and
 987             "logo" in product_info.properties):
 988         return product_info.properties.logo
 989     else:
 990         return False
 991
 992 def product_has_licence(product_info, path):
 993     """Find out if a product has a licence
 994
 995     :param product_info Config: The configuration specific to the product
 996     :param path Str: The path where to search for the licence
 997     :return: The name of the licence file (the complete path if it is found in the path, else the name, else False
 998     :rtype: Str
 999     """
1000     if ("properties" in product_info and
1001             "licence" in product_info.properties):
1002         licence_name = product_info.properties.licence
1003         if len(path) > 0:
1004             # search for licence_name in path
1005             # a- consolidate the path into one signe string licence_path
1006             licence_path=path[0]
1007             for lpath in path[1:]:
1008                 licence_path=licence_path+":"+lpath
1009             licence_path_list=licence_path.split(":")
1010             licence_fullname = src.find_file_in_lpath(licence_name, licence_path_list)
1011             if licence_fullname:
1012                 return licence_fullname
1013
1014         # if the search of licence in path failed, we return its name (not the full path)
1015         return licence_name
1016
1017     else:
1018         return False  # product has no licence
1019
1020 def product_has_salome_gui(product_info):
1021     """Know if a product has a SALOME gui
1022
1023     :param product_info Config: The configuration specific to
1024                                the product
1025     :return: True if the product has a SALOME gui, else False
1026     :rtype: Boolean
1027     """
1028     return ("properties" in product_info and
1029             "has_salome_gui" in product_info.properties and
1030             product_info.properties.has_salome_gui == "yes")
1031
1032 def product_is_mpi(product_info):
1033     """Know if a product has openmpi in its dependencies
1034
1035     :param product_info Config: The configuration specific to
1036                                the product
1037     :return: True if the product has openmpi inits dependencies
1038     :rtype: boolean
1039     """
1040     return "openmpi" in product_info.depend
1041
1042 def product_is_generated(product_info):
1043     """Know if a product is generated (YACSGEN)
1044
1045     :param product_info Config: The configuration specific to
1046                                the product
1047     :return: True if the product is generated
1048     :rtype: boolean
1049     """
1050     return ("properties" in product_info and
1051             "generate" in product_info.properties and
1052             product_info.properties.generate == "yes")
1053
1054 def get_product_components(product_info):
1055     """Get the component list to generate with the product
1056
1057     :param product_info Config: The configuration specific to
1058                                the product
1059     :return: The list of names of the components
1060     :rtype: List
1061
1062     """
1063     if not product_is_generated(product_info):
1064         return []
1065
1066     compo_list = []
1067     if "component_name" in product_info:
1068         compo_list = product_info.component_name
1069
1070         if isinstance(compo_list, str):
1071             compo_list = [ compo_list ]
1072
1073     return compo_list