src/environment.py

   1 #!/usr/bin/env python
   2 #-*- coding:utf-8 -*-
   3 #  Copyright (C) 2010-2013  CEA/DEN
   4 #
   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.
   9 #
  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.
  14 #
  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
  19 import os
  20 import subprocess
  21 import string
  22 import sys
  23
  24 import src
  25
  26 class Environ:
  27     '''Class to manage the environment context
  28     '''
  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.
  32
  33         :param environ dict:
  34         '''
  35         if environ is not None:
  36             self.environ = environ
  37         else:
  38             self.environ = os.environ
  39
  40     def __repr__(self):
  41         """easy non exhaustive quick resume for debug print
  42         """
  43         res={}
  44         res["environ"]=self.environ
  45         return self.__class__.__name__ + str(res)[0:-1] + " ...etc...}"
  46
  47     def _expandvars(self, value):
  48         '''replace some $VARIABLE into its actual value in the environment
  49
  50         :param value str: the string to be replaced
  51         :return: the replaced variable
  52         :rtype: str
  53         '''
  54         if "$" in value:
  55             # The string.Template class is a string class
  56             # for supporting $-substitutions
  57             zt = string.Template(value)
  58             try:
  59                 value = zt.substitute(self.environ)
  60             except KeyError as exc:
  61                 raise src.SatException(_("Missing definition "
  62                                          "in environment: %s") % str(exc))
  63         return value
  64
  65     def append_value(self, key, value, sep=os.pathsep):
  66         '''append value to key using sep
  67
  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
  71         '''
  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)
  78             else:
  79                 value_list.append(value_list.pop(value_list.index(value)))
  80             self.set(key, sep.join(value_list))
  81         else:
  82             self.set(key, value)
  83
  84     def append(self, key, value, sep=os.pathsep):
  85         '''Same as append_value but the value argument can be a list
  86
  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
  90         '''
  91         if isinstance(value, list):
  92             for v in value:
  93                 self.append_value(key, v, sep)
  94         else:
  95             self.append_value(key, value, sep)
  96
  97     def prepend_value(self, key, value, sep=os.pathsep):
  98         '''prepend value to key using sep
  99
 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
 103         '''
 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)
 108             else:
 109                 value_list.insert(0, value_list.pop(value_list.index(value)))
 110             self.set(key, sep.join(value_list))
 111         else:
 112             self.set(key, value)
 113
 114     def prepend(self, key, value, sep=os.pathsep):
 115         '''Same as prepend_value but the value argument can be a list
 116
 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
 120         '''
 121         if isinstance(value, list):
 122             for v in value:
 123                 self.prepend_value(key, v, sep)
 124         else:
 125             self.prepend_value(key, value, sep)
 126
 127     def is_defined(self, key):
 128         '''Check if the key exists in the environment
 129
 130         :param key str: the environment variable to check
 131         '''
 132         return key in self.environ.keys()
 133
 134     def set(self, key, value):
 135         '''Set the environment variable "key" to value "value"
 136
 137         :param key str: the environment variable to set
 138         :param value str: the value
 139         '''
 140         self.environ[key] = self._expandvars(value)
 141
 142     def get(self, key):
 143         '''Get the value of the environment variable "key"
 144
 145         :param key str: the environment variable
 146         '''
 147         if key in self.environ:
 148             return self.environ[key]
 149         else:
 150             return ""
 151
 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
 155
 156         :param key str: the environment variable
 157         :param command str: the command to execute
 158         '''
 159         value = subprocess.Popen(command,
 160                                  shell=True,
 161                                  stdout=subprocess.PIPE,
 162                                  env=self.environ).communicate()[0]
 163         self.environ[key] = value
 164
 165
 166 class SalomeEnviron:
 167     """Class to manage the environment of SALOME.
 168     """
 169
 170     def __init__(self, cfg, environ, forBuild=False, for_package=None):
 171         '''Initialization.
 172
 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,
 177                               else a build one
 178         :param for_package str: If not None, produce a relative environment
 179                                 designed for a package.
 180         '''
 181         self.environ = environ
 182         self.cfg = cfg
 183         self.forBuild = forBuild
 184         self.for_package = for_package
 185         self.silent = False
 186
 187     def __repr__(self):
 188         """easy non exhaustive quick resume for debug print"""
 189         res={}
 190         res["environ"]=str(self.environ)
 191         res["forBuild"]=self.forBuild
 192         return self.__class__.__name__ + str(res)[0:-1] + " ...etc...}"
 193
 194     def append(self, key, value, sep=os.pathsep):
 195         '''append value to key using sep
 196
 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
 200         '''
 201         return self.environ.append(key, value, sep)
 202
 203     def prepend(self, key, value, sep=os.pathsep):
 204         '''prepend value to key using sep
 205
 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
 209         '''
 210         return self.environ.prepend(key, value, sep)
 211
 212     def is_defined(self, key):
 213         '''Check if the key exists in the environment
 214
 215         :param key str: the environment variable to check
 216         '''
 217         return self.environ.is_defined(key)
 218
 219     def get(self, key):
 220         '''Get the value of the environment variable "key"
 221
 222         :param key str: the environment variable
 223         '''
 224         return self.environ.get(key)
 225
 226     def set(self, key, value):
 227         '''Set the environment variable "key" to value "value"
 228
 229         :param key str: the environment variable to set
 230         :param value str: the value
 231         '''
 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,
 235                                    shell=True,
 236                                    stdout=subprocess.PIPE).communicate()
 237             value = res[0].strip()
 238
 239         return self.environ.set(key, value)
 240
 241     def dump(self, out):
 242         """Write the environment to out
 243
 244         :param out file: the stream where to write the environment
 245         """
 246         for k in self.environ.environ.keys():
 247             try:
 248                 value = self.get(k)
 249             except:
 250                 value = "?"
 251             out.write("%s=%s\n" % (k, value))
 252
 253     def add_line(self, nb_line):
 254         """Add empty lines to the out stream (in case of file generation)
 255
 256         :param nb_line int: the number of empty lines to add
 257         """
 258         if 'add_line' in dir(self.environ):
 259             self.environ.add_line(nb_line)
 260
 261     def add_comment(self, comment):
 262         """Add a commentary to the out stream (in case of file generation)
 263
 264         :param comment str: the commentary to add
 265         """
 266         if 'add_comment' in dir(self.environ):
 267             self.environ.add_comment(comment)
 268
 269     def add_warning(self, warning):
 270         """Add a warning to the out stream (in case of file generation)
 271
 272         :param warning str: the warning to add
 273         """
 274         if 'add_warning' in dir(self.environ):
 275             self.environ.add_warning(warning)
 276
 277     def finish(self, required):
 278         """Add a final instruction in the out file (in case of file generation)
 279
 280         :param required bool: Do nothing if required is False
 281         """
 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)
 286
 287     def set_python_libdirs(self):
 288         """Set some generic variables for python library paths
 289         """
 290         ver = self.get('PYTHON_VERSION')
 291         self.set('PYTHON_LIBDIR0', os.path.join('lib',
 292                                                 'python' + ver,
 293                                                 'site-packages'))
 294         self.set('PYTHON_LIBDIR1', os.path.join('lib64',
 295                                                 'python' + ver,
 296                                                 'site-packages'))
 297
 298         self.python_lib0 = self.get('PYTHON_LIBDIR0')
 299         self.python_lib1 = self.get('PYTHON_LIBDIR1')
 300
 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
 305            if has_gui = "yes"
 306
 307         :param lProducts list: List of products to potentially add
 308         """
 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']
 312         lProdName = []
 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)
 317             else:
 318                 lProdName.append(ProdName)
 319         return lProdName
 320
 321     def set_application_env(self, logger):
 322         """Sets the environment defined in the APPLICATION file.
 323
 324         :param logger Logger: The logger instance to display messages
 325         """
 326
 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])
 332             self.add_line(1)
 333
 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],
 341                                 logger)
 342                 self.add_line(1)
 343
 344         # If there is profile (SALOME), then define additional variables
 345         if 'profile' in self.cfg.APPLICATION:
 346             profile_product = self.cfg.APPLICATION.profile.product
 347             product_info_profile = src.product.get_product_config(self.cfg,
 348                                                             profile_product)
 349             profile_share_salome = os.path.join(product_info_profile.install_dir,
 350                                                 "share",
 351                                                 "salome" )
 352             self.set( "SUITRoot", profile_share_salome )
 353             self.set( "SalomeAppConfig",
 354                       os.path.join(profile_share_salome,
 355                                    "resources",
 356                                    profile_product.lower() ) )
 357
 358         # The list of products to launch
 359         lProductsName = self.get_names(self.cfg.APPLICATION.products.keys())
 360
 361         self.set( "SALOME_MODULES",    ','.join(lProductsName))
 362
 363     def set_salome_minimal_product_env(self, product_info, logger):
 364         """Sets the minimal environment for a SALOME product.
 365            xxx_ROOT_DIR and xxx_SRC_DIR
 366
 367         :param product_info Config: The product description
 368         :param logger Logger: The logger instance to display messages
 369         """
 370         # set root dir
 371         root_dir = product_info.name + "_ROOT_DIR"
 372         if not self.is_defined(root_dir):
 373             if 'install_dir' in product_info and product_info.install_dir:
 374                 self.set(root_dir, product_info.install_dir)
 375             elif not self.silent:
 376                 logger.write("  " + _("No install_dir for product %s\n") %
 377                               product_info.name, 5)
 378
 379         if not self.for_package:
 380             # set source dir, unless no source dir
 381             if not src.product.product_is_fixed(product_info):
 382                 src_dir = product_info.name + "_SRC_DIR"
 383                 if not self.is_defined(src_dir):
 384                     self.set(src_dir, product_info.source_dir)
 385
 386     def set_salome_generic_product_env(self, product):
 387         """Sets the generic environment for a SALOME product.
 388
 389         :param product str: The product name
 390         """
 391         # get the product descritption
 392         pi = src.product.get_product_config(self.cfg, product)
 393         # Construct XXX_ROOT_DIR
 394         env_root_dir = self.get(pi.name + "_ROOT_DIR")
 395         l_binpath_libpath = []
 396
 397         # create additional ROOT_DIR for CPP components
 398         if 'component_name' in pi:
 399             compo_name = pi.component_name
 400             if compo_name + "CPP" == product:
 401                 compo_root_dir = compo_name + "_ROOT_DIR"
 402                 envcompo_root_dir = os.path.join(
 403                             self.cfg.TOOLS.common.install_root, compo_name )
 404                 self.set(compo_root_dir ,  envcompo_root_dir)
 405                 bin_path = os.path.join(envcompo_root_dir, 'bin', 'salome')
 406                 lib_path = os.path.join(envcompo_root_dir, 'lib', 'salome')
 407                 l_binpath_libpath.append( (bin_path, lib_path) )
 408
 409         appliname = 'salome'
 410         if (src.get_cfg_param(pi, 'product_type', 'SALOME').upper()
 411                             not in [ "SALOME", "SMESH_PLUGIN", "SAMPLE" ]):
 412             appliname = ''
 413
 414         # Construct the paths to prepend to PATH and LD_LIBRARY_PATH and
 415         # PYTHONPATH
 416         bin_path = os.path.join(env_root_dir, 'bin', appliname)
 417         lib_path = os.path.join(env_root_dir, 'lib', appliname)
 418         l_binpath_libpath.append( (bin_path, lib_path) )
 419
 420         for bin_path, lib_path in l_binpath_libpath:
 421             if not self.forBuild:
 422                 self.prepend('PATH', bin_path)
 423                 if src.architecture.is_windows():
 424                     self.prepend('PATH', lib_path)
 425                 else :
 426                     self.prepend('LD_LIBRARY_PATH', lib_path)
 427
 428             l = [ bin_path, lib_path,
 429                   os.path.join(env_root_dir, self.python_lib0, appliname),
 430                   os.path.join(env_root_dir, self.python_lib1, appliname)
 431                 ]
 432             self.prepend('PYTHONPATH', l)
 433
 434     def load_cfg_environment(self, cfg_env):
 435         """Loads environment defined in cfg_env
 436
 437         :param cfg_env Config: A config containing an environment
 438         """
 439         # Loop on cfg_env values
 440         for env_def in cfg_env:
 441             val = cfg_env[env_def]
 442
 443             # if it is env_script, do not do anything (reserved keyword)
 444             if env_def == "env_script":
 445                 continue
 446
 447             # if it is a dict, do not do anything
 448             if isinstance(val, src.pyconf.Mapping):
 449                 continue
 450
 451             # if it is a list, loop on its values
 452             if isinstance(val, src.pyconf.Sequence):
 453                 # transform into list of strings
 454                 l_val = []
 455                 for item in val:
 456                     l_val.append(item)
 457                 val = l_val
 458
 459             # "_" means that the value must be prepended
 460             if env_def.startswith("_"):
 461                 # separator exception for PV_PLUGIN_PATH
 462                 if env_def[1:] == 'PV_PLUGIN_PATH':
 463                     self.prepend(env_def[1:], val, ';')
 464                 else:
 465                     self.prepend(env_def[1:], val)
 466             elif env_def.endswith("_"):
 467                 # separator exception for PV_PLUGIN_PATH
 468                 if env_def[:-1] == 'PV_PLUGIN_PATH':
 469                     self.append(env_def[:-1], val, ';')
 470                 else:
 471                     self.append(env_def[:-1], val)
 472             else:
 473                 self.set(env_def, val)
 474
 475     def set_a_product(self, product, logger):
 476         """Sets the environment of a product.
 477
 478         :param product str: The product name
 479         :param logger Logger: The logger instance to display messages
 480         """
 481
 482         # Get the informations corresponding to the product
 483         pi = src.product.get_product_config(self.cfg, product)
 484
 485         if self.for_package:
 486             pi.install_dir = os.path.join(self.for_package, pi.name)
 487
 488         # Do not define environment if the product is native
 489         if src.product.product_is_native(pi):
 490             return
 491
 492         if not self.silent:
 493             logger.write(_("Setting environment for %s\n") % product, 4)
 494
 495         self.add_line(1)
 496         self.add_comment('setting environ for ' + product)
 497
 498         # Set an additional environment for SALOME products
 499         if src.product.product_is_salome(pi):
 500             # set environment using definition of the product
 501             self.set_salome_minimal_product_env(pi, logger)
 502             self.set_salome_generic_product_env(product)
 503
 504         # Put the environment define in the configuration of the product
 505         if "environ" in pi:
 506             self.load_cfg_environment(pi.environ)
 507             if self.forBuild and "build" in pi.environ:
 508                 self.load_cfg_environment(pi.environ.build)
 509             if not self.forBuild and "launch" in pi.environ:
 510                 self.load_cfg_environment(pi.environ.launch)
 511             # if product_info defines a env_scripts, load it
 512             if 'env_script' in pi.environ:
 513                 self.run_env_script(pi, logger)
 514
 515
 516
 517
 518     def run_env_script(self, product_info, logger=None):
 519         """Runs an environment script.
 520
 521         :param product_info Config: The product description
 522         :param logger Logger: The logger instance to display messages
 523         """
 524         env_script = product_info.environ.env_script
 525         # Check that the script exists
 526         if not os.path.exists(env_script):
 527             raise src.SatException(_("Environment script not found: %s") %
 528                                    env_script)
 529
 530         if not self.silent and logger is not None:
 531             logger.write("  ** load %s\n" % env_script, 4)
 532
 533         # import the script and run the set_env function
 534         try:
 535             import imp
 536             pyproduct = imp.load_source(product_info.name + "_env_script",
 537                                         env_script)
 538             pyproduct.set_env(self, product_info.install_dir,
 539                               product_info.version)
 540         except:
 541             __, exceptionValue, exceptionTraceback = sys.exc_info()
 542             print(exceptionValue)
 543             import traceback
 544             traceback.print_tb(exceptionTraceback)
 545             traceback.print_exc()
 546
 547     def run_simple_env_script(self, script_path, logger=None):
 548         """Runs an environment script. Same as run_env_script, but with a
 549            script path as parameter.
 550
 551         :param script_path str: a path to an environment script
 552         :param logger Logger: The logger instance to display messages
 553         """
 554         # Check that the script exists
 555         if not os.path.exists(script_path):
 556             raise src.SatException(_("Environment script not found: %s") %
 557                                    script_path)
 558
 559         if not self.silent and logger is not None:
 560             logger.write("  ** load %s\n" % script_path, 4)
 561
 562         script_basename = os.path.basename(script_path)
 563         if script_basename.endswith(".py"):
 564             script_basename = script_basename[:-len(".py")]
 565
 566         # import the script and run the set_env function
 567         try:
 568             import imp
 569             pyproduct = imp.load_source(script_basename + "_env_script",
 570                                         script_path)
 571             pyproduct.load_env(self)
 572         except:
 573             __, exceptionValue, exceptionTraceback = sys.exc_info()
 574             print(exceptionValue)
 575             import traceback
 576             traceback.print_tb(exceptionTraceback)
 577             traceback.print_exc()
 578
 579     def set_products(self, logger, src_root=None):
 580         """Sets the environment for all the products.
 581
 582         :param logger Logger: The logger instance to display messages
 583         :param src_root src: the application working directory
 584         """
 585         self.add_line(1)
 586         self.add_comment('setting environ for all products')
 587
 588         self.set_python_libdirs()
 589
 590         # Set the application working directory
 591         if src_root is None:
 592             src_root = self.cfg.APPLICATION.workdir
 593         self.set('SRC_ROOT', src_root)
 594
 595         # SALOME variables
 596         appli_name = "APPLI"
 597         if "APPLI" in self.cfg and "application_name" in self.cfg.APPLI:
 598             appli_name = self.cfg.APPLI.application_name
 599         self.set("SALOME_APPLI_ROOT",
 600                  os.path.join(self.cfg.APPLICATION.workdir, appli_name))
 601
 602         # The loop on the products
 603         for product in self.cfg.APPLICATION.products.keys():
 604             self.set_a_product(product, logger)
 605             self.finish(False)
 606
 607     def set_full_environ(self, logger, env_info):
 608         """Sets the full environment for products
 609            specified in env_info dictionary.
 610
 611         :param logger Logger: The logger instance to display messages
 612         :param env_info list: the list of products
 613         """
 614         # set product environ
 615         self.set_application_env(logger)
 616
 617         self.set_python_libdirs()
 618
 619         # set products
 620         for product in env_info:
 621             self.set_a_product(product, logger)
 622
 623 class FileEnvWriter:
 624     """Class to dump the environment to a file.
 625     """
 626     def __init__(self, config, logger, out_dir, src_root, env_info=None):
 627         '''Initialization.
 628
 629         :param cfg Config: the global config
 630         :param logger Logger: The logger instance to display messages
 631         :param out_dir str: The directory path where t put the output files
 632         :param src_root str: The application working directory
 633         :param env_info str: The list of products to add in the files.
 634         '''
 635         self.config = config
 636         self.logger = logger
 637         self.out_dir = out_dir
 638         self.src_root= src_root
 639         self.silent = True
 640         self.env_info = env_info
 641
 642     def write_env_file(self, filename, forBuild, shell):
 643         """Create an environment file.
 644
 645         :param filename str: the file path
 646         :param forBuild bool: if true, the build environment
 647         :param shell str: the type of file wanted (.sh, .bat)
 648         :return: The path to the generated file
 649         :rtype: str
 650         """
 651         if not self.silent:
 652             self.logger.write(_("Create environment file %s\n") %
 653                               src.printcolors.printcLabel(filename), 3)
 654
 655         # create then env object
 656         env_file = open(os.path.join(self.out_dir, filename), "w")
 657         tmp = src.fileEnviron.get_file_environ(env_file,
 658                                                shell,
 659                                                {})
 660         env = SalomeEnviron(self.config, tmp, forBuild)
 661         env.silent = self.silent
 662
 663         # Set the environment
 664         if self.env_info is not None:
 665             env.set_full_environ(self.logger, self.env_info)
 666         else:
 667             # set env from the APPLICATION
 668             env.set_application_env(self.logger)
 669             # set the products
 670             env.set_products(self.logger,
 671                             src_root=self.src_root)
 672
 673         # add cleanup and close
 674         env.finish(True)
 675         env_file.close()
 676
 677         return env_file.name
 678
 679     def write_cfgForPy_file(self,
 680                             filename,
 681                             additional_env = {},
 682                             for_package = None):
 683         """Append to current opened aFile a cfgForPy
 684            environment (SALOME python launcher).
 685
 686         :param filename str: the file path
 687         :param additional_env dict: a dictionary of additional variables
 688                                     to add to the environment
 689         :param for_package str: If not None, produce a relative environment
 690                                 designed for a package.
 691         """
 692         if not self.silent:
 693             self.logger.write(_("Create configuration file %s\n") %
 694                               src.printcolors.printcLabel(filename.name), 3)
 695
 696         # create then env object
 697         tmp = src.fileEnviron.get_file_environ(filename,
 698                                                "cfgForPy",
 699                                                {})
 700         # environment for launch
 701         env = SalomeEnviron(self.config,
 702                             tmp,
 703                             forBuild=False,
 704                             for_package=for_package)
 705         env.silent = self.silent
 706
 707         if self.env_info is not None:
 708             env.set_full_environ(self.logger, self.env_info)
 709         else:
 710             # set env from PRODUCT
 711             env.set_application_env(self.logger)
 712
 713             # set the products
 714             env.set_products(self.logger,
 715                             src_root=self.src_root)
 716
 717         # Add the additional environment if it is not empty
 718         if len(additional_env) != 0:
 719             for variable in additional_env:
 720                 env.set(variable, additional_env[variable])
 721
 722         # add cleanup and close
 723         env.finish(True)
 724
 725 class Shell:
 726     """Definition of a Shell.
 727     """
 728     def __init__(self, name, extension):
 729         '''Initialization.
 730
 731         :param name str: the shell name
 732         :param extension str: the shell extension
 733         '''
 734         self.name = name
 735         self.extension = extension
 736
 737 def load_environment(config, build, logger):
 738     """Loads the environment (used to run the tests, for example).
 739
 740     :param config Config: the global config
 741     :param build bool: build environement if True
 742     :param logger Logger: The logger instance to display messages
 743     """
 744     environ = SalomeEnviron(config, Environ(os.environ), build)
 745     environ.set_application_env(logger)
 746     environ.set_products(logger)
 747     environ.finish(True)