3 # Copyright (C) 2010-2013 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
27 '''Class to manage the environment context
29 def __init__(self, environ=None):
30 '''Initialization. If the environ argument is passed, the environment
31 will be add to it, else it is the external environment.
35 if environ is not None:
36 self.environ = environ
38 self.environ = os.environ
41 """easy non exhaustive quick resume for debug print
44 res["environ"]=self.environ
45 return self.__class__.__name__ + str(res)[0:-1] + " ...etc...}"
47 def _expandvars(self, value):
48 '''replace some $VARIABLE into its actual value in the environment
50 :param value str: the string to be replaced
51 :return: the replaced variable
55 # The string.Template class is a string class
56 # for supporting $-substitutions
57 zt = string.Template(value)
59 value = zt.substitute(self.environ)
60 except KeyError as exc:
61 raise src.SatException(_("Missing definition "
62 "in environment: %s") % str(exc))
65 def append_value(self, key, value, sep=os.pathsep):
66 '''append value to key using sep
68 :param key str: the environment variable to append
69 :param value str: the value to append to key
70 :param sep str: the separator string
72 # check if the key is already in the environment
73 if key in self.environ:
74 value_list = self.environ[key].split(sep)
75 # Check if the value is already in the key value or not
76 if not value in value_list:
77 value_list.append(value)
79 value_list.append(value_list.pop(value_list.index(value)))
80 self.set(key, sep.join(value_list))
84 def append(self, key, value, sep=os.pathsep):
85 '''Same as append_value but the value argument can be a list
87 :param key str: the environment variable to append
88 :param value str or list: the value(s) to append to key
89 :param sep str: the separator string
91 if isinstance(value, list):
93 self.append_value(key, v, sep)
95 self.append_value(key, value, sep)
97 def prepend_value(self, key, value, sep=os.pathsep):
98 '''prepend value to key using sep
100 :param key str: the environment variable to prepend
101 :param value str: the value to prepend to key
102 :param sep str: the separator string
104 if key in self.environ:
105 value_list = self.environ[key].split(sep)
106 if not value in value_list:
107 value_list.insert(0, value)
109 value_list.insert(0, value_list.pop(value_list.index(value)))
110 self.set(key, sep.join(value_list))
114 def prepend(self, key, value, sep=os.pathsep):
115 '''Same as prepend_value but the value argument can be a list
117 :param key str: the environment variable to prepend
118 :param value str or list: the value(s) to prepend to key
119 :param sep str: the separator string
121 if isinstance(value, list):
123 self.prepend_value(key, v, sep)
125 self.prepend_value(key, value, sep)
127 def is_defined(self, key):
128 '''Check if the key exists in the environment
130 :param key str: the environment variable to check
132 return key in self.environ.keys()
134 def set(self, key, value):
135 '''Set the environment variable "key" to value "value"
137 :param key str: the environment variable to set
138 :param value str: the value
140 self.environ[key] = self._expandvars(value)
143 '''Get the value of the environment variable "key"
145 :param key str: the environment variable
147 if key in self.environ:
148 return self.environ[key]
152 def command_value(self, key, command):
153 '''Get the value given by the system command "command"
154 and put it in the environment variable key
156 :param key str: the environment variable
157 :param command str: the command to execute
159 value = subprocess.Popen(command,
161 stdout=subprocess.PIPE,
162 env=self.environ).communicate()[0]
163 self.environ[key] = value
167 """Class to manage the environment of SALOME.
175 enable_simple_env_script = True):
178 :param cfg Config: the global config
179 :param environ Environ: the Environ instance where
180 to store the environment variables
181 :param forBuild bool: If true, it is a launch environment,
183 :param for_package str: If not None, produce a relative environment
184 designed for a package.
186 self.environ = environ
188 self.forBuild = forBuild
189 self.for_package = for_package
190 self.enable_simple_env_script = enable_simple_env_script
194 """easy non exhaustive quick resume for debug print"""
196 res["environ"]=str(self.environ)
197 res["forBuild"]=self.forBuild
198 return self.__class__.__name__ + str(res)[0:-1] + " ...etc...}"
200 def append(self, key, value, sep=os.pathsep):
201 '''append value to key using sep
203 :param key str: the environment variable to append
204 :param value str: the value to append to key
205 :param sep str: the separator string
207 return self.environ.append(key, value, sep)
209 def prepend(self, key, value, sep=os.pathsep):
210 '''prepend value to key using sep
212 :param key str: the environment variable to prepend
213 :param value str: the value to prepend to key
214 :param sep str: the separator string
216 return self.environ.prepend(key, value, sep)
218 def is_defined(self, key):
219 '''Check if the key exists in the environment
221 :param key str: the environment variable to check
223 return self.environ.is_defined(key)
226 '''Get the value of the environment variable "key"
228 :param key str: the environment variable
230 return self.environ.get(key)
232 def set(self, key, value):
233 '''Set the environment variable "key" to value "value"
235 :param key str: the environment variable to set
236 :param value str: the value
238 # check if value needs to be evaluated
239 if value is not None and value.startswith("`") and value.endswith("`"):
240 res = subprocess.Popen("echo %s" % value,
242 stdout=subprocess.PIPE).communicate()
243 value = res[0].strip()
245 return self.environ.set(key, value)
248 """Write the environment to out
250 :param out file: the stream where to write the environment
252 for k in self.environ.environ.keys():
257 out.write("%s=%s\n" % (k, value))
259 def add_line(self, nb_line):
260 """Add empty lines to the out stream (in case of file generation)
262 :param nb_line int: the number of empty lines to add
264 if 'add_line' in dir(self.environ):
265 self.environ.add_line(nb_line)
267 def add_comment(self, comment):
268 """Add a commentary to the out stream (in case of file generation)
270 :param comment str: the commentary to add
272 if 'add_comment' in dir(self.environ):
273 self.environ.add_comment(comment)
275 def add_warning(self, warning):
276 """Add a warning to the out stream (in case of file generation)
278 :param warning str: the warning to add
280 if 'add_warning' in dir(self.environ):
281 self.environ.add_warning(warning)
283 def finish(self, required):
284 """Add a final instruction in the out file (in case of file generation)
286 :param required bool: Do nothing if required is False
288 if 'finish' in dir(self.environ):
289 self.environ.add_line(1)
290 self.environ.add_comment("clean all the path")
291 self.environ.finish(required)
293 def set_python_libdirs(self):
294 """Set some generic variables for python library paths
296 ver = self.get('PYTHON_VERSION')
297 self.set('PYTHON_LIBDIR0', os.path.join('lib',
300 self.set('PYTHON_LIBDIR1', os.path.join('lib64',
304 self.python_lib0 = self.get('PYTHON_LIBDIR0')
305 self.python_lib1 = self.get('PYTHON_LIBDIR1')
307 def get_names(self, lProducts):
308 """Get the products name to add in SALOME_MODULES environment variable
309 It is the name of the product, except in the case where the is a
310 component name. And it has to be in SALOME_MODULES variable only
311 if the product has the property has_salome_hui = "yes"
313 :param lProducts list: List of products to potentially add
315 lProdHasGui = [p for p in lProducts if 'properties' in
316 src.product.get_product_config(self.cfg, p) and
318 src.product.get_product_config(self.cfg, p).properties and
319 src.product.get_product_config(self.cfg,
320 p).properties.has_salome_gui=='yes']
322 for ProdName in lProdHasGui:
323 pi = src.product.get_product_config(self.cfg, ProdName)
324 if 'component_name' in pi:
325 lProdName.append(pi.component_name)
327 lProdName.append(ProdName)
330 def set_application_env(self, logger):
331 """Sets the environment defined in the APPLICATION file.
333 :param logger Logger: The logger instance to display messages
336 # Set the variables defined in the "environ" section
337 if 'environ' in self.cfg.APPLICATION:
338 self.add_comment("APPLICATION environment")
339 self.load_cfg_environment(self.cfg.APPLICATION.environ)
340 if self.forBuild and "build" in self.cfg.APPLICATION.environ:
341 self.load_cfg_environment(self.cfg.APPLICATION.environ.build)
342 if not self.forBuild and "launch" in self.cfg.APPLICATION.environ:
343 self.load_cfg_environment(self.cfg.APPLICATION.environ.launch)
346 # If there is an "environ_script" section, load the scripts
347 if 'environ_script' in self.cfg.APPLICATION:
348 for pscript in self.cfg.APPLICATION.environ_script:
349 self.add_comment("script %s" % pscript)
350 sname = pscript.replace(" ", "_")
351 self.run_env_script("APPLICATION_%s" % sname,
352 self.cfg.APPLICATION.environ_script[pscript],
356 def set_salome_minimal_product_env(self, product_info, logger):
357 """Sets the minimal environment for a SALOME product.
358 xxx_ROOT_DIR and xxx_SRC_DIR
360 :param product_info Config: The product description
361 :param logger Logger: The logger instance to display messages
364 root_dir = product_info.name + "_ROOT_DIR"
365 if not self.is_defined(root_dir):
366 if 'install_dir' in product_info and product_info.install_dir:
367 self.set(root_dir, product_info.install_dir)
368 elif not self.silent:
369 logger.write(" " + _("No install_dir for product %s\n") %
370 product_info.name, 5)
372 source_in_package = src.get_property_in_product_cfg(product_info,
373 "sources_in_package")
374 if not self.for_package or source_in_package == "yes":
375 # set source dir, unless no source dir
376 if not src.product.product_is_fixed(product_info):
377 src_dir = product_info.name + "_SRC_DIR"
378 if not self.is_defined(src_dir):
379 if not self.for_package:
380 self.set(src_dir, product_info.source_dir)
382 self.set(src_dir, os.path.join("out_dir_Path",
386 def set_salome_generic_product_env(self, pi):
387 """Sets the generic environment for a SALOME product.
389 :param pi Config: The product description
391 # Construct XXX_ROOT_DIR
392 env_root_dir = self.get(pi.name + "_ROOT_DIR")
393 l_binpath_libpath = []
395 # create additional ROOT_DIR for CPP components
396 if 'component_name' in pi:
397 compo_name = pi.component_name
398 if compo_name + "CPP" == pi.name:
399 compo_root_dir = compo_name + "_ROOT_DIR"
400 envcompo_root_dir = os.path.join(
401 self.cfg.TOOLS.common.install_root, compo_name )
402 self.set(compo_root_dir , envcompo_root_dir)
403 bin_path = os.path.join(envcompo_root_dir, 'bin', 'salome')
404 lib_path = os.path.join(envcompo_root_dir, 'lib', 'salome')
405 l_binpath_libpath.append( (bin_path, lib_path) )
408 if (src.get_cfg_param(pi, 'product_type', 'SALOME').upper()
409 not in [ "SALOME", "SMESH_PLUGIN", "SAMPLE" ]):
412 # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
414 bin_path = os.path.join(env_root_dir, 'bin', appliname)
415 lib_path = os.path.join(env_root_dir, 'lib', appliname)
416 l_binpath_libpath.append( (bin_path, lib_path) )
418 for bin_path, lib_path in l_binpath_libpath:
419 if not self.forBuild:
420 self.prepend('PATH', bin_path)
421 if src.architecture.is_windows():
422 self.prepend('PATH', lib_path)
424 self.prepend('LD_LIBRARY_PATH', lib_path)
426 l = [ bin_path, lib_path,
427 os.path.join(env_root_dir, self.python_lib0, appliname),
428 os.path.join(env_root_dir, self.python_lib1, appliname)
430 self.prepend('PYTHONPATH', l)
432 def set_cpp_env(self, product_info):
433 """Sets the generic environment for a SALOME cpp product.
435 :param product_info Config: The product description
437 # Construct XXX_ROOT_DIR
438 env_root_dir = self.get(product_info.name + "_ROOT_DIR")
439 l_binpath_libpath = []
441 # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
443 bin_path = os.path.join(env_root_dir, 'bin')
444 lib_path = os.path.join(env_root_dir, 'lib')
445 l_binpath_libpath.append( (bin_path, lib_path) )
447 for bin_path, lib_path in l_binpath_libpath:
448 if not self.forBuild:
449 self.prepend('PATH', bin_path)
450 if src.architecture.is_windows():
451 self.prepend('PATH', lib_path)
453 self.prepend('LD_LIBRARY_PATH', lib_path)
455 l = [ bin_path, lib_path,
456 os.path.join(env_root_dir, self.python_lib0),
457 os.path.join(env_root_dir, self.python_lib1)
459 self.prepend('PYTHONPATH', l)
461 def load_cfg_environment(self, cfg_env):
462 """Loads environment defined in cfg_env
464 :param cfg_env Config: A config containing an environment
466 # Loop on cfg_env values
467 for env_def in cfg_env:
468 val = cfg_env[env_def]
470 # if it is env_script, do not do anything (reserved keyword)
471 if env_def == "env_script":
474 # if it is a dict, do not do anything
475 if isinstance(val, src.pyconf.Mapping):
478 # if it is a list, loop on its values
479 if isinstance(val, src.pyconf.Sequence):
480 # transform into list of strings
486 # "_" means that the value must be prepended
487 if env_def.startswith("_"):
488 # separator exception for PV_PLUGIN_PATH
489 if env_def[1:] == 'PV_PLUGIN_PATH':
490 self.prepend(env_def[1:], val, ';')
492 self.prepend(env_def[1:], val)
493 elif env_def.endswith("_"):
494 # separator exception for PV_PLUGIN_PATH
495 if env_def[:-1] == 'PV_PLUGIN_PATH':
496 self.append(env_def[:-1], val, ';')
498 self.append(env_def[:-1], val)
500 self.set(env_def, val)
502 def set_a_product(self, product, logger):
503 """Sets the environment of a product.
505 :param product str: The product name
506 :param logger Logger: The logger instance to display messages
509 # Get the informations corresponding to the product
510 pi = src.product.get_product_config(self.cfg, product)
513 pi.install_dir = os.path.join("out_dir_Path",
518 logger.write(_("Setting environment for %s\n") % product, 4)
521 self.add_comment('setting environ for ' + product)
523 # Do not define environment if the product is native
524 if src.product.product_is_native(pi):
525 if src.product.product_has_env_script(pi):
526 self.run_env_script(pi, native=True)
529 # Set an additional environment for SALOME products
530 if src.product.product_is_salome(pi):
531 # set environment using definition of the product
532 self.set_salome_minimal_product_env(pi, logger)
533 self.set_salome_generic_product_env(pi)
535 if src.product.product_is_cpp(pi):
536 # set a specific environment for cpp modules
537 self.set_salome_minimal_product_env(pi, logger)
540 if src.product.product_is_generated(pi):
541 if "component_name" in pi:
542 # hack the source and install directories in order to point
543 # on the generated product source install directories
544 install_dir_save = pi.install_dir
545 source_dir_save = pi.source_dir
547 pi.install_dir = os.path.join(self.cfg.APPLICATION.workdir,
551 pi.install_dir = os.path.join("out_dir_Path",
554 pi.source_dir = os.path.join(self.cfg.APPLICATION.workdir,
557 pi.name = pi.component_name
558 self.set_salome_minimal_product_env(pi, logger)
559 self.set_salome_generic_product_env(pi)
561 # Put original values
562 pi.install_dir = install_dir_save
563 pi.source_dir = source_dir_save
566 # Put the environment define in the configuration of the product
568 self.load_cfg_environment(pi.environ)
569 if self.forBuild and "build" in pi.environ:
570 self.load_cfg_environment(pi.environ.build)
571 if not self.forBuild and "launch" in pi.environ:
572 self.load_cfg_environment(pi.environ.launch)
573 # if product_info defines a env_scripts, load it
574 if 'env_script' in pi.environ:
575 self.run_env_script(pi, logger)
580 def run_env_script(self, product_info, logger=None, native=False):
581 """Runs an environment script.
583 :param product_info Config: The product description
584 :param logger Logger: The logger instance to display messages
585 :param native Boolean: if True load set_native_env instead of set_env
587 env_script = product_info.environ.env_script
588 # Check that the script exists
589 if not os.path.exists(env_script):
590 raise src.SatException(_("Environment script not found: %s") %
593 if not self.silent and logger is not None:
594 logger.write(" ** load %s\n" % env_script, 4)
596 # import the script and run the set_env function
599 pyproduct = imp.load_source(product_info.name + "_env_script",
602 pyproduct.set_env(self,
603 product_info.install_dir,
604 product_info.version)
606 if "set_nativ_env" in dir(pyproduct):
607 pyproduct.set_nativ_env(self)
609 __, exceptionValue, exceptionTraceback = sys.exc_info()
610 print(exceptionValue)
612 traceback.print_tb(exceptionTraceback)
613 traceback.print_exc()
615 def run_simple_env_script(self, script_path, logger=None):
616 """Runs an environment script. Same as run_env_script, but with a
617 script path as parameter.
619 :param script_path str: a path to an environment script
620 :param logger Logger: The logger instance to display messages
622 if not self.enable_simple_env_script:
624 # Check that the script exists
625 if not os.path.exists(script_path):
626 raise src.SatException(_("Environment script not found: %s") %
629 if not self.silent and logger is not None:
630 logger.write(" ** load %s\n" % script_path, 4)
632 script_basename = os.path.basename(script_path)
633 if script_basename.endswith(".py"):
634 script_basename = script_basename[:-len(".py")]
636 # import the script and run the set_env function
639 pyproduct = imp.load_source(script_basename + "_env_script",
641 pyproduct.load_env(self)
643 __, exceptionValue, exceptionTraceback = sys.exc_info()
644 print(exceptionValue)
646 traceback.print_tb(exceptionTraceback)
647 traceback.print_exc()
649 def set_products(self, logger, src_root=None):
650 """Sets the environment for all the products.
652 :param logger Logger: The logger instance to display messages
653 :param src_root src: the application working directory
656 self.add_comment('setting environ for all products')
658 # Make sure that the python lib dirs are set after python
659 if "Python" in self.cfg.APPLICATION.products:
660 self.set_a_product("Python", logger)
661 self.set_python_libdirs()
663 # The loop on the products
664 for product in self.cfg.APPLICATION.products.keys():
665 if product == "Python":
667 self.set_a_product(product, logger)
670 def set_full_environ(self, logger, env_info):
671 """Sets the full environment for products
672 specified in env_info dictionary.
674 :param logger Logger: The logger instance to display messages
675 :param env_info list: the list of products
677 # set product environ
678 self.set_application_env(logger)
680 self.set_python_libdirs()
683 for product in env_info:
684 self.set_a_product(product, logger)
687 """Class to dump the environment to a file.
689 def __init__(self, config, logger, out_dir, src_root, env_info=None):
692 :param cfg Config: the global config
693 :param logger Logger: The logger instance to display messages
694 :param out_dir str: The directory path where t put the output files
695 :param src_root str: The application working directory
696 :param env_info str: The list of products to add in the files.
700 self.out_dir = out_dir
701 self.src_root= src_root
703 self.env_info = env_info
705 def write_env_file(self, filename, forBuild, shell, for_package = None):
706 """Create an environment file.
708 :param filename str: the file path
709 :param forBuild bool: if true, the build environment
710 :param shell str: the type of file wanted (.sh, .bat)
711 :return: The path to the generated file
715 self.logger.write(_("Create environment file %s\n") %
716 src.printcolors.printcLabel(filename), 3)
718 # create then env object
719 env_file = open(os.path.join(self.out_dir, filename), "w")
720 tmp = src.fileEnviron.get_file_environ(env_file,
723 env = SalomeEnviron(self.config, tmp, forBuild, for_package=for_package)
724 env.silent = self.silent
726 # Set the environment
727 if self.env_info is not None:
728 env.set_full_environ(self.logger, self.env_info)
730 # set env from the APPLICATION
731 env.set_application_env(self.logger)
733 # The list of products to launch
734 lProductsName = env.get_names(self.config.APPLICATION.products.keys())
735 env.set( "SALOME_MODULES", ','.join(lProductsName))
738 env.set_products(self.logger,
739 src_root=self.src_root)
741 # add cleanup and close
747 def write_cfgForPy_file(self,
751 with_commercial = True):
752 """Append to current opened aFile a cfgForPy
753 environment (SALOME python launcher).
755 :param filename str: the file path
756 :param additional_env dict: a dictionary of additional variables
757 to add to the environment
758 :param for_package str: If not None, produce a relative environment
759 designed for a package.
762 self.logger.write(_("Create configuration file %s\n") %
763 src.printcolors.printcLabel(filename.name), 3)
765 # create then env object
766 tmp = src.fileEnviron.get_file_environ(filename,
769 # environment for launch
770 env = SalomeEnviron(self.config,
773 for_package=for_package,
774 enable_simple_env_script = with_commercial)
775 env.silent = self.silent
777 if self.env_info is not None:
778 env.set_full_environ(self.logger, self.env_info)
780 # set env from PRODUCT
781 env.set_application_env(self.logger)
783 # The list of products to launch
784 lProductsName = env.get_names(self.config.APPLICATION.products.keys())
785 env.set( "SALOME_MODULES", ','.join(lProductsName))
788 env.set_products(self.logger,
789 src_root=self.src_root)
791 # Add the additional environment if it is not empty
792 if len(additional_env) != 0:
793 for variable in additional_env:
794 env.set(variable, additional_env[variable])
796 # add cleanup and close
800 """Definition of a Shell.
802 def __init__(self, name, extension):
805 :param name str: the shell name
806 :param extension str: the shell extension
809 self.extension = extension
811 def load_environment(config, build, logger):
812 """Loads the environment (used to run the tests, for example).
814 :param config Config: the global config
815 :param build bool: build environement if True
816 :param logger Logger: The logger instance to display messages
818 environ = SalomeEnviron(config, Environ(os.environ), build)
819 environ.set_application_env(logger)
820 environ.set_products(logger)