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.
170 def __init__(self, cfg, environ, forBuild=False, for_package=None):
173 :param cfg Config: the global config
174 :param environ Environ: the Environ instance where
175 to store the environment variables
176 :param forBuild bool: If true, it is a launch environment,
178 :param for_package str: If not None, produce a relative environment
179 designed for a package.
181 self.environ = environ
183 self.forBuild = forBuild
184 self.for_package = for_package
188 """easy non exhaustive quick resume for debug print"""
190 res["environ"]=str(self.environ)
191 res["forBuild"]=self.forBuild
192 return self.__class__.__name__ + str(res)[0:-1] + " ...etc...}"
194 def append(self, key, value, sep=os.pathsep):
195 '''append value to key using sep
197 :param key str: the environment variable to append
198 :param value str: the value to append to key
199 :param sep str: the separator string
201 return self.environ.append(key, value, sep)
203 def prepend(self, key, value, sep=os.pathsep):
204 '''prepend value to key using sep
206 :param key str: the environment variable to prepend
207 :param value str: the value to prepend to key
208 :param sep str: the separator string
210 return self.environ.prepend(key, value, sep)
212 def is_defined(self, key):
213 '''Check if the key exists in the environment
215 :param key str: the environment variable to check
217 return self.environ.is_defined(key)
220 '''Get the value of the environment variable "key"
222 :param key str: the environment variable
224 return self.environ.get(key)
226 def set(self, key, value):
227 '''Set the environment variable "key" to value "value"
229 :param key str: the environment variable to set
230 :param value str: the value
232 # check if value needs to be evaluated
233 if value is not None and value.startswith("`") and value.endswith("`"):
234 res = subprocess.Popen("echo %s" % value,
236 stdout=subprocess.PIPE).communicate()
237 value = res[0].strip()
239 return self.environ.set(key, value)
242 """Write the environment to out
244 :param out file: the stream where to write the environment
246 for k in self.environ.environ.keys():
251 out.write("%s=%s\n" % (k, value))
253 def add_line(self, nb_line):
254 """Add empty lines to the out stream (in case of file generation)
256 :param nb_line int: the number of empty lines to add
258 if 'add_line' in dir(self.environ):
259 self.environ.add_line(nb_line)
261 def add_comment(self, comment):
262 """Add a commentary to the out stream (in case of file generation)
264 :param comment str: the commentary to add
266 if 'add_comment' in dir(self.environ):
267 self.environ.add_comment(comment)
269 def add_warning(self, warning):
270 """Add a warning to the out stream (in case of file generation)
272 :param warning str: the warning to add
274 if 'add_warning' in dir(self.environ):
275 self.environ.add_warning(warning)
277 def finish(self, required):
278 """Add a final instruction in the out file (in case of file generation)
280 :param required bool: Do nothing if required is False
282 if 'finish' in dir(self.environ):
283 self.environ.add_line(1)
284 self.environ.add_comment("clean all the path")
285 self.environ.finish(required)
287 def set_python_libdirs(self):
288 """Set some generic variables for python library paths
290 ver = self.get('PYTHON_VERSION')
291 self.set('PYTHON_LIBDIR0', os.path.join('lib',
294 self.set('PYTHON_LIBDIR1', os.path.join('lib64',
298 self.python_lib0 = self.get('PYTHON_LIBDIR0')
299 self.python_lib1 = self.get('PYTHON_LIBDIR1')
301 def get_names(self, lProducts):
302 """Get the products name to add in SALOME_MODULES environment variable
303 It is the name of the product, except in the case where the is a
304 component name. And it has to be in SALOME_MODULES variable only
307 :param lProducts list: List of products to potentially add
309 lProdHasGui = [p for p in lProducts if 'type ' in
310 src.product.get_product_config(self.cfg, p) and
311 src.product.get_product_config(self.cfg, p).type=='salome']
313 for ProdName in lProdHasGui:
314 pi = src.product.get_product_config(self.cfg, ProdName)
315 if 'component_name' in pi:
316 lProdName.append(pi.component_name)
318 lProdName.append(ProdName)
321 def set_application_env(self, logger):
322 """Sets the environment defined in the APPLICATION file.
324 :param logger Logger: The logger instance to display messages
327 # Set the variables defined in the "environ" section
328 if 'environ' in self.cfg.APPLICATION:
329 self.add_comment("APPLICATION environment")
330 for p in self.cfg.APPLICATION.environ:
331 self.set(p, self.cfg.APPLICATION.environ[p])
334 # If there is an "environ_script" section, load the scripts
335 if 'environ_script' in self.cfg.APPLICATION:
336 for pscript in self.cfg.APPLICATION.environ_script:
337 self.add_comment("script %s" % pscript)
338 sname = pscript.replace(" ", "_")
339 self.run_env_script("APPLICATION_%s" % sname,
340 self.cfg.APPLICATION.environ_script[pscript],
344 # If there is profile (SALOME), then define additional variables
345 if ('profile' in self.cfg.APPLICATION and
346 "product" in self.cfg.APPLICATION.profile):
347 profile_product = self.cfg.APPLICATION.profile.product
348 product_info_profile = src.product.get_product_config(self.cfg,
350 profile_share_salome = os.path.join(product_info_profile.install_dir,
353 self.set( "SUITRoot", profile_share_salome )
354 self.set( "SalomeAppConfig",
355 os.path.join(profile_share_salome,
357 profile_product.lower() ) )
359 # The list of products to launch
360 lProductsName = self.get_names(self.cfg.APPLICATION.products.keys())
362 self.set( "SALOME_MODULES", ','.join(lProductsName))
364 def set_salome_minimal_product_env(self, product_info, logger):
365 """Sets the minimal environment for a SALOME product.
366 xxx_ROOT_DIR and xxx_SRC_DIR
368 :param product_info Config: The product description
369 :param logger Logger: The logger instance to display messages
372 root_dir = product_info.name + "_ROOT_DIR"
373 if not self.is_defined(root_dir):
374 if 'install_dir' in product_info and product_info.install_dir:
375 self.set(root_dir, product_info.install_dir)
376 elif not self.silent:
377 logger.write(" " + _("No install_dir for product %s\n") %
378 product_info.name, 5)
380 if not self.for_package:
381 # set source dir, unless no source dir
382 if not src.product.product_is_fixed(product_info):
383 src_dir = product_info.name + "_SRC_DIR"
384 if not self.is_defined(src_dir):
385 self.set(src_dir, product_info.source_dir)
387 def set_salome_generic_product_env(self, product):
388 """Sets the generic environment for a SALOME product.
390 :param product str: The product name
392 # get the product descritption
393 pi = src.product.get_product_config(self.cfg, product)
394 # Construct XXX_ROOT_DIR
395 env_root_dir = self.get(pi.name + "_ROOT_DIR")
396 l_binpath_libpath = []
398 # create additional ROOT_DIR for CPP components
399 if 'component_name' in pi:
400 compo_name = pi.component_name
401 if compo_name + "CPP" == product:
402 compo_root_dir = compo_name + "_ROOT_DIR"
403 envcompo_root_dir = os.path.join(
404 self.cfg.TOOLS.common.install_root, compo_name )
405 self.set(compo_root_dir , envcompo_root_dir)
406 bin_path = os.path.join(envcompo_root_dir, 'bin', 'salome')
407 lib_path = os.path.join(envcompo_root_dir, 'lib', 'salome')
408 l_binpath_libpath.append( (bin_path, lib_path) )
411 if (src.get_cfg_param(pi, 'product_type', 'SALOME').upper()
412 not in [ "SALOME", "SMESH_PLUGIN", "SAMPLE" ]):
415 # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
417 bin_path = os.path.join(env_root_dir, 'bin', appliname)
418 lib_path = os.path.join(env_root_dir, 'lib', appliname)
419 l_binpath_libpath.append( (bin_path, lib_path) )
421 for bin_path, lib_path in l_binpath_libpath:
422 if not self.forBuild:
423 self.prepend('PATH', bin_path)
424 if src.architecture.is_windows():
425 self.prepend('PATH', lib_path)
427 self.prepend('LD_LIBRARY_PATH', lib_path)
429 l = [ bin_path, lib_path,
430 os.path.join(env_root_dir, self.python_lib0, appliname),
431 os.path.join(env_root_dir, self.python_lib1, appliname)
433 self.prepend('PYTHONPATH', l)
435 def load_cfg_environment(self, cfg_env):
436 """Loads environment defined in cfg_env
438 :param cfg_env Config: A config containing an environment
440 # Loop on cfg_env values
441 for env_def in cfg_env:
442 val = cfg_env[env_def]
444 # if it is env_script, do not do anything (reserved keyword)
445 if env_def == "env_script":
448 # if it is a dict, do not do anything
449 if isinstance(val, src.pyconf.Mapping):
452 # if it is a list, loop on its values
453 if isinstance(val, src.pyconf.Sequence):
454 # transform into list of strings
460 # "_" means that the value must be prepended
461 if env_def.startswith("_"):
462 # separator exception for PV_PLUGIN_PATH
463 if env_def[1:] == 'PV_PLUGIN_PATH':
464 self.prepend(env_def[1:], val, ';')
466 self.prepend(env_def[1:], val)
467 elif env_def.endswith("_"):
468 # separator exception for PV_PLUGIN_PATH
469 if env_def[:-1] == 'PV_PLUGIN_PATH':
470 self.append(env_def[:-1], val, ';')
472 self.append(env_def[:-1], val)
474 self.set(env_def, val)
476 def set_a_product(self, product, logger):
477 """Sets the environment of a product.
479 :param product str: The product name
480 :param logger Logger: The logger instance to display messages
483 # Get the informations corresponding to the product
484 pi = src.product.get_product_config(self.cfg, product)
487 pi.install_dir = os.path.join(self.for_package, pi.name)
489 # Do not define environment if the product is native
490 if src.product.product_is_native(pi):
494 logger.write(_("Setting environment for %s\n") % product, 4)
497 self.add_comment('setting environ for ' + product)
499 # Set an additional environment for SALOME products
500 if src.product.product_is_salome(pi):
501 # set environment using definition of the product
502 self.set_salome_minimal_product_env(pi, logger)
503 self.set_salome_generic_product_env(product)
505 # Put the environment define in the configuration of the product
507 self.load_cfg_environment(pi.environ)
508 if self.forBuild and "build" in pi.environ:
509 self.load_cfg_environment(pi.environ.build)
510 if not self.forBuild and "launch" in pi.environ:
511 self.load_cfg_environment(pi.environ.launch)
512 # if product_info defines a env_scripts, load it
513 if 'env_script' in pi.environ:
514 self.run_env_script(pi, logger)
519 def run_env_script(self, product_info, logger=None):
520 """Runs an environment script.
522 :param product_info Config: The product description
523 :param logger Logger: The logger instance to display messages
525 env_script = product_info.environ.env_script
526 # Check that the script exists
527 if not os.path.exists(env_script):
528 raise src.SatException(_("Environment script not found: %s") %
531 if not self.silent and logger is not None:
532 logger.write(" ** load %s\n" % env_script, 4)
534 # import the script and run the set_env function
537 pyproduct = imp.load_source(product_info.name + "_env_script",
539 pyproduct.set_env(self, product_info.install_dir,
540 product_info.version)
542 __, exceptionValue, exceptionTraceback = sys.exc_info()
543 print(exceptionValue)
545 traceback.print_tb(exceptionTraceback)
546 traceback.print_exc()
548 def run_simple_env_script(self, script_path, logger=None):
549 """Runs an environment script. Same as run_env_script, but with a
550 script path as parameter.
552 :param script_path str: a path to an environment script
553 :param logger Logger: The logger instance to display messages
555 # Check that the script exists
556 if not os.path.exists(script_path):
557 raise src.SatException(_("Environment script not found: %s") %
560 if not self.silent and logger is not None:
561 logger.write(" ** load %s\n" % script_path, 4)
563 script_basename = os.path.basename(script_path)
564 if script_basename.endswith(".py"):
565 script_basename = script_basename[:-len(".py")]
567 # import the script and run the set_env function
570 pyproduct = imp.load_source(script_basename + "_env_script",
572 pyproduct.load_env(self)
574 __, exceptionValue, exceptionTraceback = sys.exc_info()
575 print(exceptionValue)
577 traceback.print_tb(exceptionTraceback)
578 traceback.print_exc()
580 def set_products(self, logger, src_root=None):
581 """Sets the environment for all the products.
583 :param logger Logger: The logger instance to display messages
584 :param src_root src: the application working directory
587 self.add_comment('setting environ for all products')
589 self.set_python_libdirs()
591 # Set the application working directory
593 src_root = self.cfg.APPLICATION.workdir
594 self.set('SRC_ROOT', src_root)
598 if "APPLI" in self.cfg and "application_name" in self.cfg.APPLI:
599 appli_name = self.cfg.APPLI.application_name
600 self.set("SALOME_APPLI_ROOT",
601 os.path.join(self.cfg.APPLICATION.workdir, appli_name))
603 # The loop on the products
604 for product in self.cfg.APPLICATION.products.keys():
605 self.set_a_product(product, logger)
608 def set_full_environ(self, logger, env_info):
609 """Sets the full environment for products
610 specified in env_info dictionary.
612 :param logger Logger: The logger instance to display messages
613 :param env_info list: the list of products
615 # set product environ
616 self.set_application_env(logger)
618 self.set_python_libdirs()
621 for product in env_info:
622 self.set_a_product(product, logger)
625 """Class to dump the environment to a file.
627 def __init__(self, config, logger, out_dir, src_root, env_info=None):
630 :param cfg Config: the global config
631 :param logger Logger: The logger instance to display messages
632 :param out_dir str: The directory path where t put the output files
633 :param src_root str: The application working directory
634 :param env_info str: The list of products to add in the files.
638 self.out_dir = out_dir
639 self.src_root= src_root
641 self.env_info = env_info
643 def write_env_file(self, filename, forBuild, shell):
644 """Create an environment file.
646 :param filename str: the file path
647 :param forBuild bool: if true, the build environment
648 :param shell str: the type of file wanted (.sh, .bat)
649 :return: The path to the generated file
653 self.logger.write(_("Create environment file %s\n") %
654 src.printcolors.printcLabel(filename), 3)
656 # create then env object
657 env_file = open(os.path.join(self.out_dir, filename), "w")
658 tmp = src.fileEnviron.get_file_environ(env_file,
661 env = SalomeEnviron(self.config, tmp, forBuild)
662 env.silent = self.silent
664 # Set the environment
665 if self.env_info is not None:
666 env.set_full_environ(self.logger, self.env_info)
668 # set env from the APPLICATION
669 env.set_application_env(self.logger)
671 env.set_products(self.logger,
672 src_root=self.src_root)
674 # add cleanup and close
680 def write_cfgForPy_file(self,
684 """Append to current opened aFile a cfgForPy
685 environment (SALOME python launcher).
687 :param filename str: the file path
688 :param additional_env dict: a dictionary of additional variables
689 to add to the environment
690 :param for_package str: If not None, produce a relative environment
691 designed for a package.
694 self.logger.write(_("Create configuration file %s\n") %
695 src.printcolors.printcLabel(filename.name), 3)
697 # create then env object
698 tmp = src.fileEnviron.get_file_environ(filename,
701 # environment for launch
702 env = SalomeEnviron(self.config,
705 for_package=for_package)
706 env.silent = self.silent
708 if self.env_info is not None:
709 env.set_full_environ(self.logger, self.env_info)
711 # set env from PRODUCT
712 env.set_application_env(self.logger)
715 env.set_products(self.logger,
716 src_root=self.src_root)
718 # Add the additional environment if it is not empty
719 if len(additional_env) != 0:
720 for variable in additional_env:
721 env.set(variable, additional_env[variable])
723 # add cleanup and close
727 """Definition of a Shell.
729 def __init__(self, name, extension):
732 :param name str: the shell name
733 :param extension str: the shell extension
736 self.extension = extension
738 def load_environment(config, build, logger):
739 """Loads the environment (used to run the tests, for example).
741 :param config Config: the global config
742 :param build bool: build environement if True
743 :param logger Logger: The logger instance to display messages
745 environ = SalomeEnviron(config, Environ(os.environ), build)
746 environ.set_application_env(logger)
747 environ.set_products(logger)