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
18 '''In this file are implemented the methods
19 relative to the product notion of salomeTools
27 AVAILABLE_VCS = ['git', 'svn', 'cvs']
28 config_expression = "^config-\d+$"
29 VERSION_DELIMITER = "_to_"
31 def get_product_config(config, product_name, with_install_dir=True):
32 '''Get the specific configuration of a product from the global configuration
34 :param config Config: The global configuration
35 :param product_name str: The name of the product
36 :param with_install_dir boolean: If false, do not provide an install
37 directory (at false only for internal use
38 of the function check_config_exists)
39 :return: the specific configuration of the product
43 # Get the version of the product from the application definition
44 version = config.APPLICATION.products[product_name]
45 # if no version, then take the default one defined in the application
46 if isinstance(version, bool):
47 version = config.APPLICATION.tag
49 # Define debug and dev modes
50 # Get the tag if a dictionary is given in APPLICATION.products for the
56 if isinstance(version, src.pyconf.Mapping):
59 if not 'tag' in dic_version:
60 version = config.APPLICATION.tag
62 version = dic_version.tag
64 # Get the debug if any
65 if 'debug' in dic_version:
66 debug = dic_version.debug
69 if 'dev' in dic_version:
73 if 'base' in dic_version:
74 base = dic_version.base
76 # Get the section if any
77 if 'section' in dic_version:
78 section = dic_version.section
81 # substitute some character with _ in order to get the correct definition
82 # in config.PRODUCTS. This is done because the pyconf tool does not handle
83 # the . and - characters
84 for c in ".-": vv = vv.replace(c, "_")
87 if product_name in config.PRODUCTS:
88 # Search for the product description in the configuration
89 prod_info = get_product_section(config, product_name, vv, section)
91 # merge opt_depend in depend
92 if prod_info is not None and 'opt_depend' in prod_info:
93 for depend in prod_info.opt_depend:
94 if depend in config.APPLICATION.products:
95 prod_info.depend.append(depend,'')
97 # In case of a product get with a vcs,
98 # put the tag (equal to the version)
99 if prod_info is not None and prod_info.get_source in AVAILABLE_VCS:
101 if prod_info.get_source == 'git':
102 prod_info.git_info.tag = version
104 if prod_info.get_source == 'svn':
105 prod_info.svn_info.tag = version
107 if prod_info.get_source == 'cvs':
108 prod_info.cvs_info.tag = version
110 # In case of a fixed product,
111 # define the install_dir (equal to the version)
112 if prod_info is not None and os.path.isdir(version):
113 prod_info.install_dir = version
114 prod_info.get_source = "fixed"
116 # Check if the product is defined as native in the application
117 if prod_info is not None:
118 if version == "native":
119 prod_info.get_source = "native"
120 elif prod_info.get_source == "native":
121 msg = _("The product %(prod)s has version %(ver)s but is "
122 "declared as native in its definition" %
123 { 'prod': prod_info.name, 'ver': version})
124 raise src.SatException(msg)
126 # If there is no definition but the product is declared as native,
127 # construct a new definition containing only the get_source key
128 if prod_info is None and version == "native":
129 prod_info = src.pyconf.Config()
130 prod_info.name = product_name
131 prod_info.get_source = "native"
133 # If there is no definition but the product is fixed,
134 # construct a new definition containing only the product name
135 if prod_info is None and os.path.isdir(version):
136 prod_info = src.pyconf.Config()
137 prod_info.name = product_name
138 prod_info.get_source = "fixed"
139 prod_info.addMapping("environ", src.pyconf.Mapping(prod_info), "")
142 # If prod_info is still None, it means that there is no product definition
143 # in the config. The user has to provide it.
144 if prod_info is None:
145 prod_pyconf_path = src.find_file_in_lpath(product_name + ".pyconf",
146 config.PATHS.PRODUCTPATH)
147 if not prod_pyconf_path:
148 msg = _("No definition found for the product %s\n"
149 "Please create a %s.pyconf file." % (product_name, product_name))
151 msg = _("No definition corresponding to the version %(version)s was"
152 " found in the file %(prod_file_path)s.\nPlease add a "
153 "section in it." % {"version" : vv,
154 "prod_file_path" : prod_pyconf_path} )
155 raise src.SatException(msg)
157 # Set the debug, dev and version keys
158 prod_info.debug = debug
160 prod_info.version = version
162 # Set the archive_info if the product is get in archive mode
163 if prod_info.get_source == "archive":
164 if not "archive_info" in prod_info:
165 prod_info.addMapping("archive_info",
166 src.pyconf.Mapping(prod_info),
168 if "archive_name" not in prod_info.archive_info:
169 arch_name = product_name + "-" + version + ".tar.gz"
170 arch_path = src.find_file_in_lpath(arch_name,
171 config.PATHS.ARCHIVEPATH)
173 msg = _("Archive %(arch_name)s for %(prod_name)s not found:"
174 "\n" % {"arch_name" : arch_name,
175 "prod_name" : prod_info.name})
176 raise src.SatException(msg)
177 prod_info.archive_info.archive_name = arch_path
179 if (os.path.basename(prod_info.archive_info.archive_name) ==
180 prod_info.archive_info.archive_name):
181 arch_name = prod_info.archive_info.archive_name
182 arch_path = src.find_file_in_lpath(
184 config.PATHS.ARCHIVEPATH)
186 msg = _("Archive %(arch_name)s for %(prod_name)s not found:"
187 "\n" % {"arch_name" : arch_name,
188 "prod_name" : prod_info.name})
189 raise src.SatException(msg)
190 prod_info.archive_info.archive_name = arch_path
192 # If the product compiles with a script, check the script existence
193 # and if it is executable
194 if product_has_script(prod_info):
195 # Check the compil_script key existence
196 if "compil_script" not in prod_info:
197 msg = _("No compilation script found for the product %s\n"
198 "Please provide a \"compil_script\" key in its definition."
200 raise src.SatException(msg)
202 # Get the path of the script
203 script = prod_info.compil_script
204 script_name = os.path.basename(script)
205 if script == script_name:
206 # Only a name is given. Search in the default directory
207 script_path = src.find_file_in_lpath(script_name,
208 config.PATHS.PRODUCTPATH,
211 raise src.SatException(_("Compilation script not found: %s") %
213 prod_info.compil_script = script_path
214 if src.architecture.is_windows():
215 prod_info.compil_script = prod_info.compil_script[:-len(".sh")] + ".bat"
217 # Check that the script is executable
218 if not os.access(prod_info.compil_script, os.X_OK):
219 raise src.SatException(
220 _("Compilation script cannot be executed: %s") %
221 prod_info.compil_script)
223 # Get the full paths of all the patches
224 if product_has_patches(prod_info):
226 for patch in prod_info.patches:
228 # If only a filename, then search for the patch in the PRODUCTPATH
229 if os.path.basename(patch_path) == patch_path:
230 # Search in the PRODUCTPATH/patches
231 patch_path = src.find_file_in_lpath(patch,
232 config.PATHS.PRODUCTPATH,
235 msg = _("Patch %(patch_name)s for %(prod_name)s not found:"
236 "\n" % {"patch_name" : patch,
237 "prod_name" : prod_info.name})
238 raise src.SatException(msg)
239 patches.append(patch_path)
240 prod_info.patches = patches
242 # Get the full paths of the environment scripts
243 if product_has_env_script(prod_info):
244 env_script_path = prod_info.environ.env_script
245 # If only a filename, then search for the environment script
246 # in the PRODUCTPATH/env_scripts
247 if os.path.basename(env_script_path) == env_script_path:
248 # Search in the PRODUCTPATH/env_scripts
249 env_script_path = src.find_file_in_lpath(
250 prod_info.environ.env_script,
251 config.PATHS.PRODUCTPATH,
253 if not env_script_path:
254 msg = _("Environment script %(env_name)s for %(prod_name)s not "
255 "found.\n" % {"env_name" : env_script_path,
256 "prod_name" : prod_info.name})
257 raise src.SatException(msg)
259 prod_info.environ.env_script = env_script_path
262 # The variable with_install_dir is at false only for internal use
263 # of the function get_install_dir
265 # Save the install_dir key if there is any
266 if "install_dir" in prod_info and not "install_dir_save" in prod_info:
267 prod_info.install_dir_save = prod_info.install_dir
269 # if it is not the first time the install_dir is computed, it means
270 # that install_dir_save exists and it has to be taken into account.
271 if "install_dir_save" in prod_info:
272 prod_info.install_dir = prod_info.install_dir_save
274 # Set the install_dir key
275 prod_info.install_dir = get_install_dir(config, base, version, prod_info)
279 def get_product_section(config, product_name, version, section=None):
280 '''Get the product description from the configuration
282 :param config Config: The global configuration
283 :param product_name str: The product name
284 :param version str: The version of the product
285 :param section str: The searched section (if not None, the section is
287 :return: The product description
291 # if section is not None, try to get the corresponding section
293 if section not in config.PRODUCTS[product_name]:
295 # returns specific information for the given version
296 prod_info = config.PRODUCTS[product_name][section]
297 prod_info.section = section
298 prod_info.from_file = config.PRODUCTS[product_name].from_file
301 # If it exists, get the information of the product_version
302 if "version_" + version in config.PRODUCTS[product_name]:
303 # returns specific information for the given version
304 prod_info = config.PRODUCTS[product_name]["version_" + version]
305 prod_info.section = "version_" + version
306 prod_info.from_file = config.PRODUCTS[product_name].from_file
309 # Else, check if there is a description for multiple versions
310 l_section_name = config.PRODUCTS[product_name].keys()
311 l_section_ranges = [section_name for section_name in l_section_name
312 if VERSION_DELIMITER in section_name]
313 for section_range in l_section_ranges:
314 minimum, maximum = section_range.split(VERSION_DELIMITER)
315 if (src.only_numbers(version) >= src.only_numbers(minimum)
316 and src.only_numbers(version) <= src.only_numbers(maximum)):
317 # returns specific information for the versions
318 prod_info = config.PRODUCTS[product_name][section_range]
319 prod_info.section = section_range
320 prod_info.from_file = config.PRODUCTS[product_name].from_file
323 # Else, get the standard informations
324 if "default" in config.PRODUCTS[product_name]:
325 # returns the generic information (given version not found)
326 prod_info = config.PRODUCTS[product_name].default
327 prod_info.section = "default"
328 prod_info.from_file = config.PRODUCTS[product_name].from_file
331 # if noting was found, return None
334 def get_install_dir(config, base, version, prod_info):
335 '''Compute the installation directory of a given product
337 :param config Config: The global configuration
338 :param base str: This corresponds to the value given by user in its
339 application.pyconf for the specific product. If "yes", the
340 user wants the product to be in base. If "no", he wants the
341 product to be in the application workdir
342 :param version str: The version of the product
343 :param product_info Config: The configuration specific to
346 :return: The path of the product installation
351 if (("install_dir" in prod_info and prod_info.install_dir == "base")
354 if (base == "no" or ("no_base" in config.APPLICATION
355 and config.APPLICATION.no_base == "yes")):
359 install_dir = get_base_install_dir(config, prod_info, version)
361 if "install_dir" not in prod_info or prod_info.install_dir == "base":
362 # Set it to the default value (in application directory)
363 install_dir = os.path.join(config.APPLICATION.workdir,
367 install_dir = prod_info.install_dir
371 def get_base_install_dir(config, prod_info, version):
372 '''Compute the installation directory of a product in base
374 :param config Config: The global configuration
375 :param product_info Config: The configuration specific to
377 :param version str: The version of the product
378 :return: The path of the product installation
381 base_path = src.get_base_path(config)
382 prod_dir = os.path.join(base_path, prod_info.name + "-" + version)
383 if not os.path.exists(prod_dir):
384 return os.path.join(prod_dir, "config-1")
386 exists, install_dir = check_config_exists(config, prod_dir, prod_info)
390 # Find the first config-<i> directory that is available in the product
395 install_dir = os.path.join(prod_dir, "config-%i" % label)
396 if os.path.exists(install_dir):
403 def check_config_exists(config, prod_dir, prod_info):
404 '''Verify that the installation directory of a product in a base exists
405 Check all the config-<i> directory and verify the sat-config.pyconf file
408 :param config Config: The global configuration
409 :param prod_dir str: The product installation directory path
411 :param product_info Config: The configuration specific to
413 :return: True or false is the installation is found or not
414 and if it is found, the path of the found installation
415 :rtype: (boolean, str)
417 # check if the directories or files of the directory corresponds to the
418 # directory installation of the product
419 l_dir_and_files = os.listdir(prod_dir)
420 for dir_or_file in l_dir_and_files:
421 oExpr = re.compile(config_expression)
422 if not(oExpr.search(dir_or_file)):
423 # not config-<i>, not interesting
425 # check if there is the file sat-config.pyconf file in the installation
427 config_file = os.path.join(prod_dir, dir_or_file, src.CONFIG_FILENAME)
428 if not os.path.exists(config_file):
431 # If there is no dependency, it is the right path
432 if len(prod_info.depend)==0:
433 compile_cfg = src.pyconf.Config(config_file)
434 if len(compile_cfg) == 0:
435 return True, os.path.join(prod_dir, dir_or_file)
438 # check if there is the config described in the file corresponds the
439 # dependencies of the product
440 config_corresponds = True
441 compile_cfg = src.pyconf.Config(config_file)
442 for prod_dep in prod_info.depend:
443 # if the dependency is not in the config,
444 # the config does not correspond
445 if prod_dep not in compile_cfg:
446 config_corresponds = False
449 prod_dep_info = get_product_config(config, prod_dep, False)
450 # If the version of the dependency does not correspond,
451 # the config does not correspond
452 if prod_dep_info.version != compile_cfg[prod_dep]:
453 config_corresponds = False
456 for prod_name in compile_cfg:
457 if prod_name not in prod_info.depend:
458 config_corresponds = False
461 if config_corresponds:
462 return True, os.path.join(prod_dir, dir_or_file)
468 def get_products_infos(lproducts, config):
469 '''Get the specific configuration of a list of products
471 :param lproducts List: The list of product names
472 :param config Config: The global configuration
473 :return: the list of tuples
474 (product name, specific configuration of the product)
475 :rtype: [(str, Config)]
478 # Loop on product names
479 for prod in lproducts:
480 # Get the specific configuration of the product
481 prod_info = get_product_config(config, prod)
482 if prod_info is not None:
483 products_infos.append((prod, prod_info))
485 msg = _("The %s product has no definition "
486 "in the configuration.") % prod
487 raise src.SatException(msg)
488 return products_infos
490 def get_product_dependencies(config, product_info):
491 '''Get recursively the list of products that are
492 in the product_info dependencies
494 :param config Config: The global configuration
495 :param product_info Config: The configuration specific to
497 :return: the list of products in dependence
500 if "depend" not in product_info or product_info.depend == []:
503 for prod in product_info.depend:
504 if prod == product_info.name:
508 prod_info = get_product_config(config, prod)
509 dep_prod = get_product_dependencies(config, prod_info)
510 for prod_in_dep in dep_prod:
511 if prod_in_dep not in res:
512 res.append(prod_in_dep)
515 def check_installation(product_info):
516 '''Verify if a product is well installed. Checks install directory presence
517 and some additional files if it is defined in the config
519 :param product_info Config: The configuration specific to
521 :return: True if it is well installed
524 if not product_compiles(product_info):
526 install_dir = product_info.install_dir
527 if not os.path.exists(install_dir):
529 if ("present_files" in product_info and
530 "install" in product_info.present_files):
531 for file_relative_path in product_info.present_files.install:
532 file_path = os.path.join(install_dir, file_relative_path)
533 if not os.path.exists(file_path):
537 def product_is_sample(product_info):
538 '''Know if a product has the sample type
540 :param product_info Config: The configuration specific to
542 :return: True if the product has the sample type, else False
545 if 'type' in product_info:
546 ptype = product_info.type
547 return ptype.lower() == 'sample'
551 def product_is_salome(product_info):
552 '''Know if a product is of type salome
554 :param product_info Config: The configuration specific to
556 :return: True if the product is salome, else False
559 if 'type' in product_info:
560 ptype = product_info.type
561 return ptype.lower() == 'salome'
565 def product_is_fixed(product_info):
566 '''Know if a product is fixed
568 :param product_info Config: The configuration specific to
570 :return: True if the product is fixed, else False
573 get_src = product_info.get_source
574 return get_src.lower() == 'fixed'
576 def product_is_native(product_info):
577 '''Know if a product is native
579 :param product_info Config: The configuration specific to
581 :return: True if the product is native, else False
584 get_src = product_info.get_source
585 return get_src.lower() == 'native'
587 def product_is_dev(product_info):
588 '''Know if a product is in dev mode
590 :param product_info Config: The configuration specific to
592 :return: True if the product is in dev mode, else False
595 dev = product_info.dev
596 return dev.lower() == 'yes'
598 def product_is_debug(product_info):
599 '''Know if a product is in debug mode
601 :param product_info Config: The configuration specific to
603 :return: True if the product is in debug mode, else False
606 debug = product_info.debug
607 return debug.lower() == 'yes'
609 def product_is_autotools(product_info):
610 '''Know if a product is compiled using the autotools
612 :param product_info Config: The configuration specific to
614 :return: True if the product is autotools, else False
617 build_src = product_info.build_source
618 return build_src.lower() == 'autotools'
620 def product_is_cmake(product_info):
621 '''Know if a product is compiled using the cmake
623 :param product_info Config: The configuration specific to
625 :return: True if the product is cmake, else False
628 build_src = product_info.build_source
629 return build_src.lower() == 'cmake'
631 def product_is_vcs(product_info):
632 '''Know if a product is download using git, svn or cvs (not archive)
634 :param product_info Config: The configuration specific to
636 :return: True if the product is vcs, else False
639 return product_info.get_source in AVAILABLE_VCS
641 def product_is_SALOME(product_info):
642 '''Know if a product is a SALOME module
644 :param product_info Config: The configuration specific to
646 :return: True if the product is a SALOME module, else False
649 return ("properties" in product_info and
650 "is_SALOME_module" in product_info.properties and
651 product_info.properties.is_SALOME_module == "yes")
653 def product_is_smesh_plugin(product_info):
654 '''Know if a product is a SMESH plugin
656 :param product_info Config: The configuration specific to
658 :return: True if the product is a SMESH plugin, else False
661 return ("properties" in product_info and
662 "smesh_plugin" in product_info.properties and
663 product_info.properties.smesh_plugin == "yes")
665 def product_is_cpp(product_info):
666 '''Know if a product is cpp
668 :param product_info Config: The configuration specific to
670 :return: True if the product is a cpp, else False
673 return ("properties" in product_info and
674 "cpp" in product_info.properties and
675 product_info.properties.cpp == "yes")
677 def product_compiles(product_info):
678 '''Know if a product compiles or not (some products do not have a
679 compilation procedure)
681 :param product_info Config: The configuration specific to
683 :return: True if the product compiles, else False
686 return not("properties" in product_info and
687 "compilation" in product_info.properties and
688 product_info.properties.compilation == "no")
690 def product_has_script(product_info):
691 '''Know if a product has a compilation script
693 :param product_info Config: The configuration specific to
695 :return: True if the product it has a compilation script, else False
698 if "build_source" not in product_info:
701 build_src = product_info.build_source
702 return build_src.lower() == 'script'
704 def product_has_env_script(product_info):
705 '''Know if a product has an environment script
707 :param product_info Config: The configuration specific to
709 :return: True if the product it has an environment script, else False
712 return "environ" in product_info and "env_script" in product_info.environ
714 def product_has_patches(product_info):
715 '''Know if a product has one or more patches
717 :param product_info Config: The configuration specific to
719 :return: True if the product has one or more patches
722 return "patches" in product_info and len(product_info.patches) > 0
724 def product_has_logo(product_info):
725 '''Know if a product has a logo (YACSGEN generate)
727 :param product_info Config: The configuration specific to
729 :return: The path of the logo if the product has a logo, else False
732 if ("properties" in product_info and
733 "logo" in product_info.properties):
734 return product_info.properties.logo
738 def product_has_salome_gui(product_info):
739 '''Know if a product has a SALOME gui
741 :param product_info Config: The configuration specific to
743 :return: True if the product has a SALOME gui, else False
746 return ("properties" in product_info and
747 "has_salome_gui" in product_info.properties and
748 product_info.properties.has_salome_gui == "yes")
750 def product_is_mpi(product_info):
751 '''Know if a product has openmpi in its dependencies
753 :param product_info Config: The configuration specific to
755 :return: True if the product has openmpi inits dependencies
758 return "openmpi" in product_info.depend
760 def product_is_generated(product_info):
761 '''Know if a product is generated (YACSGEN)
763 :param product_info Config: The configuration specific to
765 :return: True if the product is generated
768 return ("properties" in product_info and
769 "generate" in product_info.properties and
770 product_info.properties.generate == "yes")
772 def get_product_components(product_info):
773 '''Get the component list to generate with the product
775 :param product_info Config: The configuration specific to
777 :return: The list of names of the components
781 if not product_is_generated(product_info):
785 if "component_name" in product_info:
786 compo_list = product_info.component_name
788 if isinstance(compo_list, str):
789 compo_list = [ compo_list ]