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