3 # Copyright (C) 2010-2012 CEA/DEN
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.
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.
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
20 In this file are implemented the methods
21 relative to the product notion of salomeTools
29 import src.debug as DBG
30 import src.versionMinorMajorPatch as VMMP
32 AVAILABLE_VCS = ['git', 'svn', 'cvs']
34 CONFIG_FILENAME = "sat-config-" # trace product depends version(s)
35 PRODUCT_FILENAME = "sat-product-" # trace product compile config
36 config_expression = "^config-\d+$"
38 def get_product_config(config, product_name, with_install_dir=True):
39 """Get the specific configuration of a product from the global configuration
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
50 # Get the version of the product from the application definition
51 version = config.APPLICATION.products[product_name]
53 # Define debug and dev modes
54 # Get the tag if a dictionary is given in APPLICATION.products for the
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
77 # special case for which only the product name is mentionned
78 if isinstance(version, bool):
79 version = config.APPLICATION.tag
81 if isinstance(version, src.pyconf.Mapping):
84 if not 'tag' in dic_version:
85 version = config.APPLICATION.tag
87 version = dic_version.tag
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
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
102 if 'dev' in dic_version:
103 dev = dic_version.dev
104 elif 'dev' in config.APPLICATION:
105 dev = config.APPLICATION.dev
108 if 'hpc' in dic_version:
109 hpc = dic_version.hpc
110 elif 'hpc' in config.APPLICATION:
111 hpc = config.APPLICATION.hpc
113 # Get the base if any
114 if 'base' in dic_version:
115 base = dic_version.base
117 # Get the section if any
118 if 'section' in dic_version:
119 section = dic_version.section
121 # this case occur when version is overwritten, cf sat # 8897
122 if isinstance(version, dict):
123 dic_version = version
124 # Get the version/tag
125 if not 'tag' in dic_version:
126 version = config.APPLICATION.tag
128 version = dic_version["tag"]
130 # Get the debug if any
131 if 'debug' in dic_version:
132 debug = dic_version["debug"]
133 elif 'debug' in config.APPLICATION:
134 debug = config.APPLICATION.debug
136 # Get the verbose if any
137 if 'verbose' in dic_version:
138 verbose = dic_version["verbose"]
139 elif 'verbose' in config.APPLICATION:
140 verbose = config.APPLICATION.verbose
143 if 'dev' in dic_version:
144 dev = dic_version["dev"]
145 elif 'dev' in config.APPLICATION:
146 dev = config.APPLICATION.dev
149 if 'hpc' in dic_version:
150 hpc = dic_version.hpc
151 elif 'hpc' in config.APPLICATION:
152 hpc = config.APPLICATION.hpc
154 # Get the base if any
155 if 'base' in dic_version:
156 base = dic_version["base"]
158 # Get the section if any
159 if 'section' in dic_version:
160 section = dic_version['section']
163 # substitute some character with _ in order to get the correct definition
164 # in config.PRODUCTS. This is done because the pyconf tool does not handle
165 # the . and - characters
166 for c in ".-": vv = vv.replace(c, "_")
169 if product_name in config.PRODUCTS:
170 # Search for the product description in the configuration
171 prod_info = get_product_section(config, product_name, vv, section)
173 # get salomeTool version
174 prod_info.sat_version = src.get_salometool_version(config)
176 # merge opt_depend in depend
177 if prod_info is not None and 'opt_depend' in prod_info:
178 for depend in prod_info.opt_depend:
179 if depend in config.APPLICATION.products:
180 prod_info.depend.append(depend,'')
183 # In case of a product get with a vcs,
184 # put the tag (equal to the version)
185 if prod_info is not None and prod_info.get_source in AVAILABLE_VCS:
187 if prod_info.get_source == 'git':
188 prod_info.git_info.tag = version
190 if prod_info.get_source == 'svn':
191 prod_info.svn_info.tag = version
193 if prod_info.get_source == 'cvs':
194 prod_info.cvs_info.tag = version
196 # In case of a fixed product,
197 # define the install_dir (equal to the version)
198 if prod_info is not None and \
199 (os.path.isdir(version) or version.startswith("/")):
200 # we consider a (fixed) path existing paths;
201 # or paths starting with '/' (the objective is to print a correct
202 # message to the user in case of non existing path.)
203 prod_info.install_dir = version
204 prod_info.get_source = "fixed"
206 # Check if the product is defined as native in the application
207 if prod_info is not None:
208 if version == "native":
209 prod_info.get_source = "native"
210 elif prod_info.get_source == "native":
211 msg = _("The product %(prod)s has version %(ver)s but is "
212 "declared as native in its definition" %
213 { 'prod': prod_info.name, 'ver': version})
214 raise src.SatException(msg)
216 # If there is no definition but the product is declared as native,
217 # construct a new definition containing only the get_source key
218 if prod_info is None and version == "native":
219 prod_info = src.pyconf.Config()
220 prod_info.name = product_name
221 prod_info.get_source = "native"
223 # If there is no definition but the product is fixed,
224 # construct a new definition containing only the product name
225 if prod_info is None and os.path.isdir(version):
226 prod_info = src.pyconf.Config()
227 prod_info.name = product_name
228 prod_info.get_source = "fixed"
229 prod_info.addMapping("environ", src.pyconf.Mapping(prod_info), "")
232 # If prod_info is still None, it means that there is no product definition
233 # in the config. The user has to provide it.
234 if prod_info is None:
235 prod_pyconf_path = src.find_file_in_lpath(product_name + ".pyconf",
236 config.PATHS.PRODUCTPATH)
237 if not prod_pyconf_path:
239 No definition found for the product %(1)s.
240 Please create a %(1)s.pyconf file somewhere in:
243 "2": PP.pformat(config.PATHS.PRODUCTPATH) }
246 No definition corresponding to the version %(1)s was found in the file:
248 Please add a section in it.""") % {"1" : vv, "2" : prod_pyconf_path}
249 raise src.SatException(msg)
251 # Set the debug, dev and version keys
252 prod_info.debug = debug
253 prod_info.verbose = verbose
256 prod_info.version = version
258 # Set the archive_info if the product is get in archive mode
259 if prod_info.get_source == "archive":
260 if not "archive_info" in prod_info:
261 prod_info.addMapping("archive_info",
262 src.pyconf.Mapping(prod_info),
264 if "archive_name" in prod_info.archive_info:
265 arch_name = prod_info.archive_info.archive_name
266 elif "archive_prefix" in prod_info.archive_info:
267 arch_name = prod_info.archive_info.archive_prefix + "-" + version + ".tar.gz"
270 arch_name = product_name + "-" + version + ".tar.gz"
272 arch_path = src.find_file_in_lpath(arch_name,
273 config.PATHS.ARCHIVEPATH)
275 # arch_path is not found. It may generate an error in sat source,
276 # unless the archive is found in ftp serveur
277 msg = _("Archive %(1)s for %(2)s not found in config.PATHS.ARCHIVEPATH") % \
278 {"1" : arch_name, "2" : prod_info.name}
279 DBG.tofix(msg, config.PATHS.ARCHIVEPATH)
280 prod_info.archive_info.archive_name = arch_name #without path
282 prod_info.archive_info.archive_name = arch_path
285 # If the product compiles with a script, check the script existence
286 # and if it is executable
287 if product_has_script(prod_info):
288 # Check the compil_script key existence
289 if "compil_script" not in prod_info:
291 No compilation script found for the product %s.
292 Please provide a 'compil_script' key in its definition.""") % product_name
293 raise src.SatException(msg)
295 # Get the path of the script file
296 # if windows supposed '.bat', if linux supposed '.sh'
297 # but user set extension script file in his pyconf as he wants, no obligation.
298 script = prod_info.compil_script
299 script_name = os.path.basename(script)
300 if script == script_name:
301 # Only a name is given. Search in the default directory
302 script_path = src.find_file_in_lpath(script_name, config.PATHS.PRODUCTPATH, "compil_scripts")
304 msg = _("Compilation script %s not found in") % script_name
305 DBG.tofix(msg, config.PATHS.PRODUCTPATH, True) # say where searched
306 script_path = "%s_(Not_Found_by_Sat!!)" % script_name
307 prod_info.compil_script = script_path
310 # Check that the script is executable
311 if os.path.exists(prod_info.compil_script) and not os.access(prod_info.compil_script, os.X_OK):
312 DBG.tofix("Compilation script file is not in 'execute mode'", prod_info.compil_script, True)
314 # Get the full paths of all the patches
315 if product_has_patches(prod_info):
318 for patch in prod_info.patches:
320 # If only a filename, then search for the patch in the PRODUCTPATH
321 if os.path.basename(patch_path) == patch_path:
322 # Search in the PRODUCTPATH/patches
323 patch_path = src.find_file_in_lpath(patch,
324 config.PATHS.PRODUCTPATH,
327 msg = _("Patch %(patch_name)s for %(prod_name)s not found:"
328 "\n" % {"patch_name" : patch,
329 "prod_name" : prod_info.name})
330 raise src.SatException(msg)
331 patches.append(patch_path)
333 DBG.tofix("problem in prod_info.patches", prod_info)
334 prod_info.patches = patches
336 # Get the full paths of the environment scripts
337 if product_has_env_script(prod_info):
338 env_script_path = prod_info.environ.env_script
339 # If only a filename, then search for the environment script
340 # in the PRODUCTPATH/env_scripts
341 if os.path.basename(env_script_path) == env_script_path:
342 # Search in the PRODUCTPATH/env_scripts
343 env_script_path = src.find_file_in_lpath(
344 prod_info.environ.env_script,
345 config.PATHS.PRODUCTPATH,
347 if not env_script_path:
348 msg = _("Environment script %(env_name)s for %(prod_name)s not "
349 "found.\n" % {"env_name" : env_script_path,
350 "prod_name" : prod_info.name})
351 raise src.SatException(msg)
353 prod_info.environ.env_script = env_script_path
356 # The variable with_install_dir is at false only for internal use
357 # of the function get_install_dir
359 # Save the install_dir key if there is any
360 if "install_dir" in prod_info and not "install_dir_save" in prod_info:
361 prod_info.install_dir_save = prod_info.install_dir
363 # if it is not the first time the install_dir is computed, it means
364 # that install_dir_save exists and it has to be taken into account.
365 if "install_dir_save" in prod_info:
366 prod_info.install_dir = prod_info.install_dir_save
368 # Set the install_dir key
369 prod_info.install_dir = get_install_dir(config, base, version, prod_info)
373 def get_product_section(config, product_name, version, section=None, verbose=False):
374 """Get the product description from the configuration
376 :param config Config: The global configuration
377 :param product_name str: The product name
378 :param version str: The version of the product as 'V8_4_0', or else.
379 :param section str: The searched section (if not None, the section is
381 :return: The product description
385 # if section is not None, try to get the corresponding section
386 aProd = config.PRODUCTS[product_name]
388 versionMMP = VMMP.MinorMajorPatch(version)
389 except: # example setuptools raise "minor in major_minor_patch is not integer: '0_6c11'"
391 DBG.write("get_product_section for product %s '%s' as version '%s'" % (product_name, version, versionMMP),
392 (section, aProd.keys()), verbose)
393 # DBG.write("yoo1", aProd, True)
395 if section not in aProd:
397 # returns specific information for the given version
398 prod_info = aProd[section]
399 prod_info.section = section
400 prod_info.from_file = aProd.from_file
403 # If it exists, get the information of the product_version
404 # ex: 'version_V6_6_0' as salome version classical syntax
405 if "version_" + version in aProd:
406 DBG.write("found section for version_" + version, "", verbose)
407 # returns specific information for the given version
408 prod_info = aProd["version_" + version]
409 prod_info.section = "version_" + version
410 prod_info.from_file = aProd.from_file
413 # Else, check if there is a description for multiple versions
414 l_section_names = aProd.keys()
415 l_section_ranges = []
417 for name in l_section_names:
418 # DBG.write("name", name,True)
419 aRange = VMMP.getRange_majorMinorPatch(name)
420 if aRange is not None:
421 DBG.write("found version range for section '%s'" % name, aRange, verbose)
422 l_section_ranges.append((name, aRange))
424 if versionMMP is not None and len(l_section_ranges) > 0:
425 for name, (vmin, vmax) in l_section_ranges:
426 if versionMMP >= vmin and versionMMP <= vmax:
427 tagged.append((name, [vmin, vmax]))
430 DBG.write("multiple version ranges tagged for '%s', fix it" % version,
431 PP.pformat(tagged), True)
433 if len(tagged) == 1: # ok
434 DBG.write("one version range tagged for '%s'" % version,
435 PP.pformat(tagged), verbose)
436 name, (vmin, vmax) = tagged[0]
437 prod_info = aProd[name]
438 prod_info.section = name
439 prod_info.from_file = aProd.from_file
442 # Else, get the standard informations
443 if "default" in aProd:
444 # returns the generic information (given version not found)
445 prod_info = aProd.default
446 DBG.write("default tagged for '%s'" % version, prod_info, verbose)
447 prod_info.section = "default"
448 prod_info.from_file = aProd.from_file
451 # if noting was found, return None
454 def get_install_dir(config, base, version, prod_info):
455 """Compute the installation directory of a given product
457 :param config Config: The global configuration
458 :param base str: This corresponds to the value given by user in its
459 application.pyconf for the specific product. If "yes", the
460 user wants the product to be in base. If "no", he wants the
461 product to be in the application workdir
462 :param version str: The version of the product
463 :param product_info Config: The configuration specific to
466 :return: The path of the product installation
471 # base : corresponds to what is specified in application pyconf (either from the global key, or from a product dict)
472 # prod_info.install_dir : corresponds to what is specified in product pyconf (usually "base" for prerequisites)
473 if (("install_dir" in prod_info and prod_info.install_dir == "base")
476 # what was declared in application has precedence over what was said in product pyconf
477 # no_base="yes" has precedence over base == "yes"
478 if (base == "no" or ("no_base" in config.APPLICATION
479 and config.APPLICATION.no_base == "yes")):
483 install_dir = get_base_install_dir(config, prod_info, version)
485 if "install_dir" not in prod_info or prod_info.install_dir == "base":
486 # Set it to the default value (in application directory)
487 if ( src.appli_test_property(config,"single_install_dir", "yes") and
488 src.product.product_test_property(prod_info,"single_install_dir", "yes")):
489 # when single_install_dir mode is activated in tha application
490 # we use config.INTERNAL.config.single_install_dir for products
491 # having single_install_dir property
492 install_dir = os.path.join(config.APPLICATION.workdir,
493 config.INTERNAL.config.install_dir,
494 config.INTERNAL.config.single_install_dir)
495 elif ( src.appli_test_property(config,"pip", "yes") and
496 src.product.product_test_property(prod_info,"pip", "yes") and
497 src.appli_test_property(config,"pip_install_dir", "python") ):
498 # when pip mode is activated in the application
499 # and product is pip, and pip_install_dir is set to python
500 # we assume python in installed in install_dir/Python
501 install_dir = os.path.join(config.APPLICATION.workdir,
502 config.INTERNAL.config.install_dir,
505 install_dir = os.path.join(config.APPLICATION.workdir,
506 config.INTERNAL.config.install_dir,
509 install_dir = prod_info.install_dir
513 def get_base_install_dir(config, prod_info, version):
514 """Compute the installation directory of a product in base
516 :param config Config: The global configuration
517 :param product_info Config: The configuration specific to
519 :param version str: The version of the product
520 :return: The path of the product installation
523 base_path = src.get_base_path(config)
524 prod_dir = os.path.join(base_path, prod_info.name + "-" + version)
525 if not os.path.exists(prod_dir):
526 return os.path.join(prod_dir, "config-1")
528 exists, install_dir = check_config_exists(config, prod_dir, prod_info)
532 # Find the first config-<i> directory that is available in the product
537 install_dir = os.path.join(prod_dir, "config-%i" % label)
538 if os.path.exists(install_dir):
545 def add_compile_config_file(p_info, config):
546 '''Execute the proper configuration command(s)
547 in the product build directory.
549 :param p_info Config: The specific config of the product
550 :param config Config: The global configuration
552 # Create the compile config
553 # DBG.write("add_compile_config_file", p_info, True)
554 res = src.pyconf.Config()
555 res.addMapping(p_info.name, src.pyconf.Mapping(res), "")
556 res[p_info.name]= p_info.version
558 for prod_name in p_info.depend:
559 if prod_name not in res:
560 res.addMapping(prod_name, src.pyconf.Mapping(res), "")
561 prod_dep_info = src.product.get_product_config(config, prod_name, False)
562 res[prod_name] = prod_dep_info.version
563 # Write it in the install directory of the product
564 # This file is for automatic reading/checking
565 # see check_config_exists method
566 afilename = CONFIG_FILENAME + p_info.name + ".pyconf"
567 aFile = os.path.join(p_info.install_dir, afilename)
568 with open(aFile, 'w') as f:
571 # this file is not mandatory, is for human eye reading
572 afilename = PRODUCT_FILENAME + p_info.name + ".pyconf"
573 aFile = os.path.join(p_info.install_dir, afilename)
575 with open(aFile, 'w') as f:
576 p_info.__save__(f, evaluated=True) # evaluated expressions mode
578 # sometime some information cannot be evaluated.
579 # for example, in the context of non VCS archives, information on git server is not available.
580 DBG.write("Warning : sat was not able to evaluate and write down some information in file %s" % aFile)
583 def check_config_exists(config, prod_dir, prod_info, verbose=False):
585 Verify that the installation directory of a product in a base exists.
586 Check all the config-<i>/sat-config.py files found for correspondence
587 with current config and prod_info depend-version-tags
589 :param config Config: The global configuration
590 :param prod_dir str: The product installation directory path
592 :param product_info Config: The configuration specific to
594 :return: True or false is the installation is found or not
595 and if it is found, the path of the found installation
596 :rtype: (boolean, str)
598 # check if the directories or files of the directory corresponds to the
599 # directory installation of the product
600 if os.path.isdir(prod_dir):
601 l_dir_and_files = os.listdir(prod_dir)
603 raise Exception("Inexisting directory '%s'" % prod_dir)
605 DBG.write("check_config_exists 000", (prod_dir, l_dir_and_files), verbose)
606 DBG.write("check_config_exists 111", prod_info, verbose)
608 for dir_or_file in l_dir_and_files:
609 oExpr = re.compile(config_expression)
610 if not(oExpr.search(dir_or_file)):
611 # in mode BASE, not config-<i>, not interesting
612 # DBG.write("not interesting", dir_or_file, True)
614 # check if there is the file sat-config.pyconf file in the installation
616 afilename = PRODUCT_FILENAME + p_info.name + ".pyconf"
617 config_file = os.path.join(prod_dir, dir_or_file, afilename)
618 DBG.write("check_config_exists 222", config_file, verbose)
619 if not os.path.exists(config_file):
622 # check if there is the config described in the file corresponds the
623 # dependencies of the product
624 config_corresponds = True
625 compile_cfg = src.pyconf.Config(config_file)
626 for prod_dep in prod_info.depend:
627 # if the dependency is not in the config,
628 # the config does not correspond
629 if prod_dep not in compile_cfg:
630 config_corresponds = False
633 prod_dep_info = get_product_config(config, prod_dep, False)
634 # If the version of the dependency does not correspond,
635 # the config does not correspond
636 if prod_dep_info.version != compile_cfg[prod_dep]:
637 config_corresponds = False
640 if config_corresponds:
641 for prod_name in compile_cfg:
642 # assume new compatibility with prod_name in sat-config.pyconf files
643 if prod_name == prod_info.name:
644 if prod_info.version == compile_cfg[prod_name]:
645 DBG.write("check_config_exists OK 333", compile_cfg, verbose)
647 else: # no correspondence with newer with prod_name sat-config.pyconf files
648 config_corresponds = False
651 # as old compatibility without prod_name sat-config.pyconf files
652 if prod_name not in prod_info.depend:
653 # here there is an unexpected depend in an old compilation
654 config_corresponds = False
657 if config_corresponds: # returns (and stops) at first correspondence found
658 DBG.write("check_config_exists OK 444", dir_or_file, verbose)
659 return True, os.path.join(prod_dir, dir_or_file)
661 # no correspondence found
666 def get_products_infos(lproducts, config):
667 """Get the specific configuration of a list of products
669 :param lproducts List: The list of product names
670 :param config Config: The global configuration
671 :return: the list of tuples
672 (product name, specific configuration of the product)
673 :rtype: [(str, Config)]
676 # Loop on product names
677 for prod in lproducts:
678 # Get the specific configuration of the product
679 prod_info = get_product_config(config, prod)
680 if prod_info is not None:
681 products_infos.append((prod, prod_info))
683 msg = _("The %s product has no definition in the configuration.") % prod
684 raise src.SatException(msg)
685 return products_infos
688 def get_products_list(options, cfg, logger):
690 method that gives the product list with their informations from
691 configuration regarding the passed options.
693 :param options Options: The Options instance that stores the commands arguments
694 :param cfg Config: The global configuration
695 :param logger Logger: The logger instance to use for the display and logging
696 :return: The list of (product name, product_informations).
699 # Get the products to be prepared, regarding the options
700 if options.products is None:
701 # No options, get all products sources
702 products = cfg.APPLICATION.products
704 # if option --products, check that all products of the command line
705 # are present in the application.
706 """products = options.products
708 if p not in cfg.APPLICATION.products:
709 raise src.SatException(_("Product %(product)s "
710 "not defined in application %(application)s") %
711 { 'product': p, 'application': cfg.VARS.application} )"""
713 products = src.getProductNames(cfg, options.products, logger)
715 # Construct the list of tuple containing
716 # the products name and their definition
717 resAll = src.product.get_products_infos(products, cfg)
719 # if the property option was passed, filter the list
720 if options.properties: # existing properties
724 prop, value = options.properties # for example 'is_SALOME_module', 'yes'
725 for p_name, p_info in resAll:
727 if p_info.properties[prop] == value:
728 res.append((p_name, p_info))
735 if len(ok) != len(resAll):
736 logger.trace("on properties %s\n products accepted:\n %s\n products rejected:\n %s\n" %
737 (options.properties, PP.pformat(sorted(ok)), PP.pformat(sorted(ko))))
739 logger.warning("properties %s\n seems useless with no products rejected" %
740 (options.properties))
742 res = resAll # not existing properties as all accepted
747 def get_product_dependencies(config, product_info):
749 Get recursively the list of products that are
750 in the product_info dependencies
752 :param config Config: The global configuration
753 :param product_info Config: The configuration specific to
755 :return: the list of products in dependence
758 if "depend" not in product_info or product_info.depend == []:
761 for prod in product_info.depend:
762 if prod == product_info.name:
766 prod_info = get_product_config(config, prod)
767 dep_prod = get_product_dependencies(config, prod_info)
768 for prod_in_dep in dep_prod:
769 if prod_in_dep not in res:
770 res.append(prod_in_dep)
773 def check_installation(config, product_info):
775 Verify if a product is well installed. Checks install directory presence
776 and some additional files if it is defined in the config
778 :param product_info Config: The configuration specific to
780 :return: True if it is well installed
783 if not product_compiles(product_info):
786 install_dir = product_info.install_dir
787 if ( (src.appli_test_property(config,"single_install_dir", "yes") and
788 src.product.product_test_property(product_info,"single_install_dir", "yes")) or
789 (src.appli_test_property(config,"pip", "yes") and
790 src.product.product_test_property(product_info,"pip", "yes") and
791 src.appli_test_property(config,"pip_install_dir", "python") ) ):
792 # if the product is installed in the single install dir, or in python (for pip managed products)
793 # we check the product file in state of the install directory.
794 filename = CONFIG_FILENAME + product_info.name + ".pyconf"
795 if not os.path.exists(os.path.join(install_dir, filename)):
798 if not os.path.exists(install_dir):
801 # check extra files if specified in present_files.install section
802 if ("present_files" in product_info and
803 "install" in product_info.present_files):
804 for file_relative_path in product_info.present_files.install:
805 file_path = os.path.join(install_dir, file_relative_path)
806 if not os.path.exists(file_path):
810 def check_source(product_info):
811 """Verify if a sources of product is preset. Checks source directory presence
813 :param product_info Config: The configuration specific to
815 :return: True if it is well installed
818 DBG.write("check_source product_info", product_info)
819 source_dir = product_info.source_dir
820 if not os.path.exists(source_dir):
822 if ("present_files" in product_info and
823 "source" in product_info.present_files):
824 for file_relative_path in product_info.present_files.source:
825 file_path = os.path.join(source_dir, file_relative_path)
826 if not os.path.exists(file_path):
830 def product_is_salome(product_info):
831 """Know if a product is a SALOME module
833 :param product_info Config: The configuration specific to
835 :return: True if the product is a SALOME module, else False
838 return ("properties" in product_info and
839 "is_SALOME_module" in product_info.properties and
840 product_info.properties.is_SALOME_module == "yes")
842 def product_is_fixed(product_info):
843 """Know if a product is fixed
845 :param product_info Config: The configuration specific to
847 :return: True if the product is fixed, else False
850 get_src = product_info.get_source
851 return get_src.lower() == 'fixed'
853 def product_is_native(product_info):
854 """Know if a product is native
856 :param product_info Config: The configuration specific to
858 :return: True if the product is native, else False
861 get_src = product_info.get_source
862 return get_src.lower() == 'native'
864 def product_is_dev(product_info):
865 """Know if a product is in dev mode
867 :param product_info Config: The configuration specific to
869 :return: True if the product is in dev mode, else False
872 dev = product_info.dev
873 res = (dev.lower() == 'yes')
874 DBG.write('product_is_dev %s' % product_info.name, res)
875 # if product_info.name == "XDATA": return True #test #10569
878 def product_is_hpc(product_info):
879 """Know if a product is in hpc mode
881 :param product_info Config: The configuration specific to
883 :return: True if the product is in hpc mode, else False
886 hpc = product_info.hpc
887 res = (hpc.lower() == 'yes')
890 def product_is_debug(product_info):
891 """Know if a product is in debug mode
893 :param product_info Config: The configuration specific to
895 :return: True if the product is in debug mode, else False
898 debug = product_info.debug
899 return debug.lower() == 'yes'
901 def product_is_verbose(product_info):
902 """Know if a product is in verbose mode
904 :param product_info Config: The configuration specific to
906 :return: True if the product is in verbose mode, else False
909 verbose = product_info.verbose
910 return verbose.lower() == 'yes'
912 def product_is_autotools(product_info):
913 """Know if a product is compiled using the autotools
915 :param product_info Config: The configuration specific to
917 :return: True if the product is autotools, else False
920 build_src = product_info.build_source
921 return build_src.lower() == 'autotools'
923 def product_is_cmake(product_info):
924 """Know if a product is compiled using the cmake
926 :param product_info Config: The configuration specific to
928 :return: True if the product is cmake, else False
931 build_src = product_info.build_source
932 return build_src.lower() == 'cmake'
934 def product_is_vcs(product_info):
935 """Know if a product is download using git, svn or cvs (not archive)
937 :param product_info Config: The configuration specific to
939 :return: True if the product is vcs, else False
942 return product_info.get_source in AVAILABLE_VCS
944 def product_is_smesh_plugin(product_info):
945 """Know if a product is a SMESH plugin
947 :param product_info Config: The configuration specific to
949 :return: True if the product is a SMESH plugin, else False
952 return ("properties" in product_info and
953 "smesh_plugin" in product_info.properties and
954 product_info.properties.smesh_plugin == "yes")
956 def product_is_cpp(product_info):
957 """Know if a product is cpp
959 :param product_info Config: The configuration specific to
961 :return: True if the product is a cpp, else False
964 return ("properties" in product_info and
965 "cpp" in product_info.properties and
966 product_info.properties.cpp == "yes")
968 def product_compiles(product_info):
970 Know if a product compiles or not
971 (some products do not have a compilation procedure)
973 :param product_info Config: The configuration specific to
975 :return: True if the product compiles, else False
978 return not("properties" in product_info and
979 "compilation" in product_info.properties and
980 product_info.properties.compilation == "no")
982 def product_has_script(product_info):
983 """Know if a product has a compilation script
985 :param product_info Config: The configuration specific to
987 :return: True if the product it has a compilation script, else False
990 if "build_source" not in product_info:
993 build_src = product_info.build_source
994 return build_src.lower() == 'script'
996 def product_has_env_script(product_info):
997 """Know if a product has an environment script
999 :param product_info Config: The configuration specific to
1001 :return: True if the product it has an environment script, else False
1004 return "environ" in product_info and "env_script" in product_info.environ
1006 def product_has_patches(product_info):
1007 """Know if a product has one or more patches
1009 :param product_info Config: The configuration specific to
1011 :return: True if the product has one or more patches
1014 res = ( "patches" in product_info and len(product_info.patches) > 0 )
1015 DBG.write('product_has_patches %s' % product_info.name, res)
1016 # if product_info.name == "XDATA": return True #test #10569
1019 def product_has_logo(product_info):
1020 """Know if a product has a logo (YACSGEN generate)
1022 :param product_info Config: The configuration specific to
1024 :return: The path of the logo if the product has a logo, else False
1027 if ("properties" in product_info and
1028 "logo" in product_info.properties):
1029 return product_info.properties.logo
1033 def product_has_licence(product_info, path):
1034 """Find out if a product has a licence
1036 :param product_info Config: The configuration specific to the product
1037 :param path Str: The path where to search for the licence
1038 :return: The name of the licence file (the complete path if it is found in the path, else the name, else False
1041 if ("properties" in product_info and
1042 "licence" in product_info.properties):
1043 licence_name = product_info.properties.licence
1045 # search for licence_name in path
1046 # a- consolidate the path into one signe string licence_path
1047 licence_path=path[0]
1048 for lpath in path[1:]:
1049 licence_path=licence_path+":"+lpath
1050 licence_path_list=licence_path.split(":")
1051 licence_fullname = src.find_file_in_lpath(licence_name, licence_path_list)
1052 if licence_fullname:
1053 return licence_fullname
1055 # if the search of licence in path failed, we return its name (not the full path)
1059 return False # product has no licence
1061 def product_has_salome_gui(product_info):
1062 """Know if a product has a SALOME gui
1064 :param product_info Config: The configuration specific to
1066 :return: True if the product has a SALOME gui, else False
1069 return ("properties" in product_info and
1070 "has_salome_gui" in product_info.properties and
1071 product_info.properties.has_salome_gui == "yes")
1073 def product_is_mpi(product_info):
1074 """Know if a product has openmpi in its dependencies
1076 :param product_info Config: The configuration specific to
1078 :return: True if the product has openmpi inits dependencies
1081 return "openmpi" in product_info.depend
1083 def product_is_generated(product_info):
1084 """Know if a product is generated (YACSGEN)
1086 :param product_info Config: The configuration specific to
1088 :return: True if the product is generated
1091 return ("properties" in product_info and
1092 "generate" in product_info.properties and
1093 product_info.properties.generate == "yes")
1095 def product_is_compile_time(product_info):
1096 """Know if a product is only used at compile time
1098 :param product_info Config: The configuration specific to
1100 :return: True if the product is only used at compile time
1103 return ("properties" in product_info and
1104 "compile_time" in product_info.properties and
1105 product_info.properties.compile_time == "yes")
1108 def product_test_property(product_info, property_name, property_value):
1109 """Generic function to test if a product has a property set to a value
1111 :param product_info Config: The configuration specific to
1113 :param property_name : The name of the property to check
1114 :param property_value : The value of the property to test
1115 :return: True if the product has the property and the property is set to property_value
1118 # first check if product has the property
1119 if not ("properties" in product_info and
1120 property_name in product_info.properties):
1123 # then check to the property is set to property_value
1124 eval_expression = 'product_info.properties.%s == "%s"' % (property_name,property_value)
1125 result = eval(eval_expression)
1130 def get_product_components(product_info):
1131 """Get the component list to generate with the product
1133 :param product_info Config: The configuration specific to
1135 :return: The list of names of the components
1139 if not product_is_generated(product_info):
1143 if "component_name" in product_info:
1144 compo_list = product_info.component_name
1146 if isinstance(compo_list, str):
1147 compo_list = [ compo_list ]
1150 def product_is_wheel(product_info):
1151 """ tells whether a product is a wheel
1153 :param product_info Config: The configuration specific to
1155 :return: True if the product has a wheel, else False
1158 return ("properties" in product_info and
1159 "is_wheel" in product_info.properties and
1160 product_info.properties.is_wheel == "yes")