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
116 elif 'base' in config.APPLICATION:
117 base = config.APPLICATION.base
119 # Get the section if any
120 if 'section' in dic_version:
121 section = dic_version.section
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
130 version = dic_version["tag"]
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
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
145 if 'dev' in dic_version:
146 dev = dic_version["dev"]
147 elif 'dev' in config.APPLICATION:
148 dev = config.APPLICATION.dev
151 if 'hpc' in dic_version:
152 hpc = dic_version.hpc
153 elif 'hpc' in config.APPLICATION:
154 hpc = config.APPLICATION.hpc
156 # Get the base if any
157 if 'base' in dic_version:
158 base = dic_version["base"]
160 # Get the section if any
161 if 'section' in dic_version:
162 section = dic_version['section']
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, "_")
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)
175 # get salomeTool version
176 prod_info.sat_version = src.get_salometool_version(config)
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,'')
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:
189 if prod_info.get_source == 'git':
190 prod_info.git_info.tag = version
192 if prod_info.get_source == 'svn':
193 prod_info.svn_info.tag = version
195 if prod_info.get_source == 'cvs':
196 prod_info.cvs_info.tag = version
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"
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)
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"
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), "")
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:
241 No definition found for the product %(1)s.
242 Please create a %(1)s.pyconf file somewhere in:
245 "2": PP.pformat(config.PATHS.PRODUCTPATH) }
248 No definition corresponding to the version %(1)s was found in the file:
250 Please add a section in it.""") % {"1" : vv, "2" : prod_pyconf_path}
251 raise src.SatException(msg)
253 # Set the debug, dev and version keys
254 prod_info.debug = debug
255 prod_info.verbose = verbose
258 prod_info.version = version
260 prod_info.base = base
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),
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"
274 arch_name = product_name + "-" + version + ".tar.gz"
276 arch_path = src.find_file_in_lpath(arch_name,
277 config.PATHS.ARCHIVEPATH)
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
283 prod_info.archive_info.archive_name = arch_path
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:
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)
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")
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
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)
315 # Get the full paths of all the patches
316 if product_has_patches(prod_info):
319 for patch in prod_info.patches:
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,
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)
334 DBG.tofix("problem in prod_info.patches", prod_info)
335 prod_info.patches = patches
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,
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)
354 prod_info.environ.env_script = env_script_path
357 # The variable with_install_dir is at false only for internal use
358 # of the function get_install_dir
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
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
369 # Set the install_dir key
370 prod_info.install_dir = get_install_dir(config, version, prod_info)
374 def get_product_section(config, product_name, version, section=None):
375 """Build the product description from the configuration
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
382 :return: The product description
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.
397 # in this (historic) mode the definition of the product is given by a full unique section
400 # decode version number
402 versionMMP = VMMP.MinorMajorPatch(version)
403 except: # example setuptools raise "minor in major_minor_patch is not integer: '0_6c11'"
406 # if a section is explicitely specified we select it
408 if section not in aProd:
410 # returns specific information for the given version
413 pi.from_file = aProd.from_file
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
423 # Else, check if there is a description for multiple versions
425 l_section_names = aProd.keys()
426 l_section_ranges = []
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))
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]))
439 DBG.write("multiple version ranges tagged for '%s', fix it" % version,
442 elif len(tagged) == 1: # ok
443 name, (vmin, vmax) = tagged[0]
446 pi.from_file = aProd.from_file
448 # Else, get the standard informations
449 elif "default" in aProd:
450 # returns the generic information (given version not found)
452 pi.section = "default"
453 pi.from_file = aProd.from_file
458 # If the definition is incremental, we take the default section
459 # and then complete it with other sections :
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
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]
480 #DBG.write("product info returned for product %s with version %s and section %s" %\
481 # (product_name, version, section), prod_info)
484 def get_install_dir(config, version, prod_info):
485 """Compute the installation directory of a given product
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
496 :return: The path of the product installation
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
508 # check desactivation of base at application level
509 if ( "base" in prod_info and prod_info.base == "no"):
513 install_dir = get_base_install_dir(config, prod_info, version)
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,
535 install_dir = os.path.join(config.APPLICATION.workdir,
536 config.INTERNAL.config.install_dir,
539 install_dir = prod_info.install_dir
543 def get_base_install_dir(config, prod_info, version):
544 """Compute the installation directory of a product in base
546 :param config Config: The global configuration
547 :param product_info Config: The configuration specific to
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
560 # get rid of / to avoid create subdirectories cf sat #18546
561 version_wslash=version.replace("/", "_")
563 if ( src.appli_test_property(config,"pip", "yes") and
564 src.product.product_test_property(prod_info,"pip", "yes") and
565 src.appli_test_property(config,"pip_install_dir", "python") ):
566 # when pip mode is activated in the application
567 # and product is pip, and pip_install_dir is set to python
568 python_info=get_product_config(config, "Python")
569 return python_info.install_dir
571 base_path = src.get_base_path(config)
572 if "base" in prod_info and prod_info.base != "no" and prod_info.base != "yes":
573 # we are in the case of a named base
574 prod_dir = os.path.join(base_path, "apps", prod_info.base, prod_info.name, version_wslash)
577 prod_dir = os.path.join(base_path, prod_info.name + "-" + version_wslash)
578 if not os.path.exists(prod_dir):
579 return os.path.join(prod_dir, "config-1")
581 exists, install_dir = check_config_exists(config, prod_dir, prod_info)
585 # Find the first config-<i> directory that is available in the product
590 install_dir = os.path.join(prod_dir, "config-%i" % label)
591 if os.path.exists(install_dir):
598 def add_compile_config_file(p_info, config):
599 '''Execute the proper configuration command(s)
600 in the product build directory.
602 :param p_info Config: The specific config of the product
603 :param config Config: The global configuration
605 # Create the compile config
606 # DBG.write("add_compile_config_file", p_info, True)
607 res = src.pyconf.Config()
608 res.addMapping(p_info.name, src.pyconf.Mapping(res), "")
609 res[p_info.name]= p_info.version
611 for prod_name in p_info.depend:
612 if prod_name not in res:
613 res.addMapping(prod_name, src.pyconf.Mapping(res), "")
614 prod_dep_info = src.product.get_product_config(config, prod_name, False)
615 res[prod_name] = prod_dep_info.version
616 # Write it in the install directory of the product
617 # This file is for automatic reading/checking
618 # see check_config_exists method
619 afilename = CONFIG_FILENAME + p_info.name + ".pyconf"
620 aFile = os.path.join(p_info.install_dir, afilename)
621 with open(aFile, 'w') as f:
624 # this file is not mandatory, is for human eye reading
625 afilename = PRODUCT_FILENAME + p_info.name + ".pyconf"
626 aFile = os.path.join(p_info.install_dir, afilename)
628 with open(aFile, 'w') as f:
629 p_info.__save__(f, evaluated=True) # evaluated expressions mode
631 # sometime some information cannot be evaluated.
632 # for example, in the context of non VCS archives, information on git server is not available.
633 DBG.write("Warning : sat was not able to evaluate and write down some information in file %s" % aFile)
636 def check_config_exists(config, prod_dir, prod_info, verbose=False):
638 Verify that the installation directory of a product in a base exists.
639 Check all the config-<i>/sat-config.py files found for correspondence
640 with current config and prod_info depend-version-tags
642 :param config Config: The global configuration
643 :param prod_dir str: The product installation directory path
645 :param product_info Config: The configuration specific to
647 :return: True or false is the installation is found or not
648 and if it is found, the path of the found installation
649 :rtype: (boolean, str)
651 # check if the directories or files of the directory corresponds to the
652 # directory installation of the product
653 if os.path.isdir(prod_dir):
654 l_dir_and_files = os.listdir(prod_dir)
656 raise Exception("Inexisting directory '%s'" % prod_dir)
658 DBG.write("check_config_exists 000", (prod_dir, l_dir_and_files), verbose)
659 DBG.write("check_config_exists 111", prod_info, verbose)
661 for dir_or_file in l_dir_and_files:
662 oExpr = re.compile(config_expression)
663 if not(oExpr.search(dir_or_file)):
664 # in mode BASE, not config-<i>, not interesting
665 # DBG.write("not interesting", dir_or_file, True)
667 # check if there is the file sat-config.pyconf file in the installation
669 afilename = CONFIG_FILENAME + prod_info.name + ".pyconf"
670 config_file = os.path.join(prod_dir, dir_or_file, afilename)
671 DBG.write("check_config_exists 222", config_file, verbose)
672 if not os.path.exists(config_file):
675 # check if there is the config described in the file corresponds the
676 # dependencies of the product
677 config_corresponds = True
678 compile_cfg = src.pyconf.Config(config_file)
679 for prod_dep in prod_info.depend:
680 # if the dependency is not in the config,
681 # the config does not correspond
682 if prod_dep not in compile_cfg:
683 config_corresponds = False
686 prod_dep_info = get_product_config(config, prod_dep, False)
687 # If the version of the dependency does not correspond,
688 # the config does not correspond
689 if prod_dep_info.version != compile_cfg[prod_dep]:
690 config_corresponds = False
693 if config_corresponds:
694 for prod_name in compile_cfg:
695 # assume new compatibility with prod_name in sat-config.pyconf files
696 if prod_name == prod_info.name:
697 if prod_info.version == compile_cfg[prod_name]:
698 DBG.write("check_config_exists OK 333", compile_cfg, verbose)
700 else: # no correspondence with newer with prod_name sat-config.pyconf files
701 config_corresponds = False
704 # as old compatibility without prod_name sat-config.pyconf files
705 if prod_name not in prod_info.depend:
706 # here there is an unexpected depend in an old compilation
707 config_corresponds = False
710 if config_corresponds: # returns (and stops) at first correspondence found
711 DBG.write("check_config_exists OK 444", dir_or_file, verbose)
712 return True, os.path.join(prod_dir, dir_or_file)
714 # no correspondence found
719 def get_products_infos(lproducts, config):
720 """Get the specific configuration of a list of products
722 :param lproducts List: The list of product names
723 :param config Config: The global configuration
724 :return: the list of tuples
725 (product name, specific configuration of the product)
726 :rtype: [(str, Config)]
729 # Loop on product names
730 for prod in lproducts:
731 # Get the specific configuration of the product
732 prod_info = get_product_config(config, prod)
733 if prod_info is not None:
734 products_infos.append((prod, prod_info))
736 msg = _("The %s product has no definition in the configuration.") % prod
737 raise src.SatException(msg)
738 return products_infos
741 def get_products_list(options, cfg, logger):
743 method that gives the product list with their informations from
744 configuration regarding the passed options.
746 :param options Options: The Options instance that stores the commands arguments
747 :param cfg Config: The global configuration
748 :param logger Logger: The logger instance to use for the display and logging
749 :return: The list of (product name, product_informations).
752 # Get the products to be prepared, regarding the options
753 if options.products is None:
754 # No options, get all products sources
755 products = cfg.APPLICATION.products
757 # if option --products, check that all products of the command line
758 # are present in the application.
759 """products = options.products
761 if p not in cfg.APPLICATION.products:
762 raise src.SatException(_("Product %(product)s "
763 "not defined in application %(application)s") %
764 { 'product': p, 'application': cfg.VARS.application} )"""
766 products = src.getProductNames(cfg, options.products, logger)
768 # Construct the list of tuple containing
769 # the products name and their definition
770 resAll = src.product.get_products_infos(products, cfg)
772 # if the property option was passed, filter the list
773 if options.properties: # existing properties
777 prop, value = options.properties # for example 'is_SALOME_module', 'yes'
778 for p_name, p_info in resAll:
780 if p_info.properties[prop] == value:
781 res.append((p_name, p_info))
788 if len(ok) != len(resAll):
789 logger.trace("on properties %s\n products accepted:\n %s\n products rejected:\n %s\n" %
790 (options.properties, PP.pformat(sorted(ok)), PP.pformat(sorted(ko))))
792 logger.warning("properties %s\n seems useless with no products rejected" %
793 (options.properties))
795 res = resAll # not existing properties as all accepted
800 def get_product_dependencies(config, product_info):
802 Get recursively the list of products that are
803 in the product_info dependencies
805 :param config Config: The global configuration
806 :param product_info Config: The configuration specific to
808 :return: the list of products in dependence
811 if "depend" not in product_info or product_info.depend == []:
814 for prod in product_info.depend:
815 if prod == product_info.name:
819 prod_info = get_product_config(config, prod)
820 dep_prod = get_product_dependencies(config, prod_info)
821 for prod_in_dep in dep_prod:
822 if prod_in_dep not in res:
823 res.append(prod_in_dep)
826 def check_installation(config, product_info):
828 Verify if a product is well installed. Checks install directory presence
829 and some additional files if it is defined in the config
831 :param product_info Config: The configuration specific to
833 :return: True if it is well installed
836 # don't check products that are not compiled
837 if not product_compiles(product_info):
840 if product_is_native(product_info):
841 # check a system product
842 check_cmd=src.system.get_pkg_check_cmd()
843 run_pkg,build_pkg=src.product.check_system_dep(check_cmd, product_info)
845 for pkg in build_pkg:
846 if "KO" in build_pkg[pkg]:
847 build_dep_ko.append(pkg)
849 # the product is not installed : display message and return error status
850 msg="Please install them with %s before compiling salome" % check_cmd[0]
851 print("\nmissing compile time dependencies : ")
852 for md in build_dep_ko:
859 install_dir = product_info.install_dir
860 if ( (src.appli_test_property(config,"single_install_dir", "yes") and
861 src.product.product_test_property(product_info,"single_install_dir", "yes")) or
862 (src.appli_test_property(config,"pip", "yes") and
863 src.product.product_test_property(product_info,"pip", "yes") and
864 src.appli_test_property(config,"pip_install_dir", "python") ) ):
865 # if the product is installed in the single install dir, or in python (for pip managed products)
866 # we check the product file in state of the install directory.
867 filename = CONFIG_FILENAME + product_info.name + ".pyconf"
868 if not os.path.exists(os.path.join(install_dir, filename)):
871 if not os.path.exists(install_dir):
874 # check extra files if specified in present_files.install section
875 if ("present_files" in product_info and
876 "install" in product_info.present_files):
877 for file_relative_path in product_info.present_files.install:
878 file_path = os.path.join(install_dir, file_relative_path)
879 if not os.path.exists(file_path):
883 def check_source(product_info):
884 """Verify if a sources of product is preset. Checks source directory presence
886 :param product_info Config: The configuration specific to
888 :return: True if it is well installed
891 source_dir = product_info.source_dir
892 if not os.path.exists(source_dir):
894 if ("present_files" in product_info and
895 "source" in product_info.present_files):
896 for file_relative_path in product_info.present_files.source:
897 file_path = os.path.join(source_dir, file_relative_path)
898 if not os.path.exists(file_path):
902 def product_is_salome(product_info):
903 """Know if a product is a SALOME module
905 :param product_info Config: The configuration specific to
907 :return: True if the product is a SALOME module, else False
910 return ("properties" in product_info and
911 "is_SALOME_module" in product_info.properties and
912 product_info.properties.is_SALOME_module == "yes")
914 def product_is_fixed(product_info):
915 """Know if a product is fixed
917 :param product_info Config: The configuration specific to
919 :return: True if the product is fixed, else False
922 get_src = product_info.get_source
923 return get_src.lower() == 'fixed'
925 def product_is_native(product_info):
926 """Know if a product is native
928 :param product_info Config: The configuration specific to
930 :return: True if the product is native, else False
933 get_src = product_info.get_source
934 return get_src.lower() == 'native'
936 def product_is_dev(product_info):
937 """Know if a product is in dev mode
939 :param product_info Config: The configuration specific to
941 :return: True if the product is in dev mode, else False
944 dev = product_info.dev
945 res = (dev.lower() == 'yes')
946 DBG.write('product_is_dev %s' % product_info.name, res)
947 # if product_info.name == "XDATA": return True #test #10569
950 def product_is_hpc(product_info):
951 """Know if a product is in hpc mode
953 :param product_info Config: The configuration specific to
955 :return: True if the product is in hpc mode, else False
958 hpc = product_info.hpc
959 res = (hpc.lower() == 'yes')
962 def product_is_debug(product_info):
963 """Know if a product is in debug mode
965 :param product_info Config: The configuration specific to
967 :return: True if the product is in debug mode, else False
970 debug = product_info.debug
971 return debug.lower() == 'yes'
973 def product_is_verbose(product_info):
974 """Know if a product is in verbose mode
976 :param product_info Config: The configuration specific to
978 :return: True if the product is in verbose mode, else False
981 verbose = product_info.verbose
982 return verbose.lower() == 'yes'
984 def product_is_autotools(product_info):
985 """Know if a product is compiled using the autotools
987 :param product_info Config: The configuration specific to
989 :return: True if the product is autotools, else False
992 build_src = product_info.build_source
993 return build_src.lower() == 'autotools'
995 def product_is_cmake(product_info):
996 """Know if a product is compiled using the cmake
998 :param product_info Config: The configuration specific to
1000 :return: True if the product is cmake, else False
1003 build_src = product_info.build_source
1004 return build_src.lower() == 'cmake'
1006 def product_is_vcs(product_info):
1007 """Know if a product is download using git, svn or cvs (not archive)
1009 :param product_info Config: The configuration specific to
1011 :return: True if the product is vcs, else False
1014 return product_info.get_source in AVAILABLE_VCS
1016 def product_is_smesh_plugin(product_info):
1017 """Know if a product is a SMESH plugin
1019 :param product_info Config: The configuration specific to
1021 :return: True if the product is a SMESH plugin, else False
1024 return ("properties" in product_info and
1025 "smesh_plugin" in product_info.properties and
1026 product_info.properties.smesh_plugin == "yes")
1028 def product_is_cpp(product_info):
1029 """Know if a product is cpp
1031 :param product_info Config: The configuration specific to
1033 :return: True if the product is a cpp, else False
1036 return ("properties" in product_info and
1037 "cpp" in product_info.properties and
1038 product_info.properties.cpp == "yes")
1040 def product_compiles(product_info):
1042 Know if a product compiles or not
1043 (some products do not have a compilation procedure)
1045 :param product_info Config: The configuration specific to
1047 :return: True if the product compiles, else False
1050 return not("properties" in product_info and
1051 "compilation" in product_info.properties and
1052 product_info.properties.compilation == "no")
1054 def product_has_script(product_info):
1055 """Know if a product has a compilation script
1057 :param product_info Config: The configuration specific to
1059 :return: True if the product it has a compilation script, else False
1062 if "build_source" not in product_info:
1065 build_src = product_info.build_source
1066 return build_src.lower() == 'script'
1068 def product_has_env_script(product_info):
1069 """Know if a product has an environment script
1071 :param product_info Config: The configuration specific to
1073 :return: True if the product it has an environment script, else False
1076 return "environ" in product_info and "env_script" in product_info.environ
1078 def product_has_patches(product_info):
1079 """Know if a product has one or more patches
1081 :param product_info Config: The configuration specific to
1083 :return: True if the product has one or more patches
1086 res = ( "patches" in product_info and len(product_info.patches) > 0 )
1089 def product_has_logo(product_info):
1090 """Know if a product has a logo (YACSGEN generate)
1092 :param product_info Config: The configuration specific to
1094 :return: The path of the logo if the product has a logo, else False
1097 if ("properties" in product_info and
1098 "logo" in product_info.properties):
1099 return product_info.properties.logo
1103 def product_has_licence(product_info, path):
1104 """Find out if a product has a licence
1106 :param product_info Config: The configuration specific to the product
1107 :param path Str: The path where to search for the licence
1108 :return: The name of the licence file (the complete path if it is found in the path, else the name, else False
1111 if ("properties" in product_info and
1112 "licence" in product_info.properties):
1113 licence_name = product_info.properties.licence
1115 # search for licence_name in path
1116 # a- consolidate the path into one signe string licence_path
1117 licence_path=path[0]
1118 for lpath in path[1:]:
1119 licence_path=licence_path+":"+lpath
1120 licence_path_list=licence_path.split(":")
1121 licence_fullname = src.find_file_in_lpath(licence_name, licence_path_list)
1122 if licence_fullname:
1123 return licence_fullname
1125 # if the search of licence in path failed, we return its name (not the full path)
1129 return False # product has no licence
1131 def product_has_salome_gui(product_info):
1132 """Know if a product has a SALOME gui
1134 :param product_info Config: The configuration specific to
1136 :return: True if the product has a SALOME gui, else False
1139 return ("properties" in product_info and
1140 "has_salome_gui" in product_info.properties and
1141 product_info.properties.has_salome_gui == "yes")
1143 def product_is_mpi(product_info):
1144 """Know if a product has openmpi in its dependencies
1146 :param product_info Config: The configuration specific to
1148 :return: True if the product has openmpi inits dependencies
1151 return "openmpi" in product_info.depend
1153 def product_is_generated(product_info):
1154 """Know if a product is generated (YACSGEN)
1156 :param product_info Config: The configuration specific to
1158 :return: True if the product is generated
1161 return ("properties" in product_info and
1162 "generate" in product_info.properties and
1163 product_info.properties.generate == "yes")
1165 def product_is_compile_time(product_info):
1166 """Know if a product is only used at compile time
1168 :param product_info Config: The configuration specific to
1170 :return: True if the product is only used at compile time
1173 return ("properties" in product_info and
1174 "compile_time" in product_info.properties and
1175 product_info.properties.compile_time == "yes")
1178 def product_test_property(product_info, property_name, property_value):
1179 """Generic function to test if a product has a property set to a value
1181 :param product_info Config: The configuration specific to
1183 :param property_name : The name of the property to check
1184 :param property_value : The value of the property to test
1185 :return: True if the product has the property and the property is set to property_value
1188 # first check if product has the property
1189 if not ("properties" in product_info and
1190 property_name in product_info.properties):
1193 # then check to the property is set to property_value
1194 eval_expression = 'product_info.properties.%s == "%s"' % (property_name,property_value)
1195 result = eval(eval_expression)
1198 def check_system_dep(check_cmd, product_info):
1199 """Search for system dependencies, check if installed
1200 :param check_cmd Config: The command to use for checking (rpm/apt)
1201 :param product_info Config: The configuration specific to the product
1202 :rtype: two dictionnaries for runtime and compile time dependencies with text status
1206 if "system_info" in product_info:
1207 if check_cmd[0]=="rpm":
1208 if "rpm" in product_info.system_info:
1209 for pkg in product_info.system_info.rpm:
1210 runtime_dep[pkg]=src.system.check_system_pkg(check_cmd,pkg)
1211 if "rpm_dev" in product_info.system_info:
1212 for pkg in product_info.system_info.rpm_dev:
1213 build_dep[pkg]=src.system.check_system_pkg(check_cmd,pkg)
1214 if check_cmd[0]=="apt":
1215 if "apt" in product_info.system_info:
1216 for pkg in product_info.system_info.apt:
1217 runtime_dep[pkg]=src.system.check_system_pkg(check_cmd,pkg)
1218 if "apt_dev" in product_info.system_info:
1219 for pkg in product_info.system_info.apt_dev:
1220 build_dep[pkg]=src.system.check_system_pkg(check_cmd,pkg)
1221 return runtime_dep,build_dep
1224 def get_product_components(product_info):
1225 """Get the component list to generate with the product
1227 :param product_info Config: The configuration specific to
1229 :return: The list of names of the components
1233 if not product_is_generated(product_info):
1237 if "component_name" in product_info:
1238 compo_list = product_info.component_name
1240 if isinstance(compo_list, str):
1241 compo_list = [ compo_list ]
1244 def product_is_wheel(product_info):
1245 """ tells whether a product is a wheel
1247 :param product_info Config: The configuration specific to
1249 :return: True if the product has a wheel, else False
1252 return ("properties" in product_info and
1253 "is_wheel" in product_info.properties and
1254 product_info.properties.is_wheel == "yes")