bin/appli_gen.py

   1 #! /usr/bin/env python
   2 #  -*- coding: iso-8859-1 -*-
   3 # Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   4 #
   5 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   6 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   7 #
   8 # This library is free software; you can redistribute it and/or
   9 # modify it under the terms of the GNU Lesser General Public
  10 # License as published by the Free Software Foundation; either
  11 # version 2.1 of the License, or (at your option) any later version.
  12 #
  13 # This library is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 # Lesser General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU Lesser General Public
  19 # License along with this library; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21 #
  22 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  23 #
  24
  25 ## \file appli_gen.py
  26 #  Create a %SALOME application (virtual Salome installation)
  27 #
  28 usage = """%(prog)s [options]
  29 Typical use is:
  30   python %(prog)s
  31 Typical use with options is:
  32   python %(prog)s --verbose --prefix=<install directory> --config=<configuration file>
  33 """
  34
  35 import os
  36 import sys
  37 import shutil
  38 import virtual_salome
  39 import xml.sax
  40 import optparse
  41
  42 # --- names of tags in XML configuration file
  43 appli_tag   = "application"
  44 prereq_tag  = "prerequisites"
  45 context_tag = "context"
  46 system_conf_tag  = "system_conf"
  47 modules_tag = "modules"
  48 module_tag  = "module"
  49 samples_tag = "samples"
  50 extra_tests_tag = "extra_tests"
  51 extra_test_tag = "extra_test"
  52 resources_tag = "resources"
  53
  54 # --- names of attributes in XML configuration file
  55 nam_att  = "name"
  56 path_att = "path"
  57 gui_att  = "gui"
  58
  59 # -----------------------------------------------------------------------------
  60
  61 # --- xml reader for SALOME application configuration file
  62
  63 class xml_parser:
  64     def __init__(self, fileName ):
  65         print "Configure parser: processing %s ..." % fileName
  66         self.space = []
  67         self.config = {}
  68         self.config["modules"] = []
  69         self.config["guimodules"] = []
  70         self.config["extra_tests"] = []
  71         parser = xml.sax.make_parser()
  72         parser.setContentHandler(self)
  73         parser.parse(fileName)
  74         pass
  75
  76     def boolValue( self, text):
  77         if text in ("yes", "y", "1"):
  78             return 1
  79         elif text in ("no", "n", "0"):
  80             return 0
  81         else:
  82             return text
  83         pass
  84
  85     def startElement(self, name, attrs):
  86         self.space.append(name)
  87         self.current = None
  88         # --- if we are analyzing "prerequisites" element then store its "path" attribute
  89         if self.space == [appli_tag, prereq_tag] and path_att in attrs.getNames():
  90             self.config["prereq_path"] = attrs.getValue( path_att )
  91             pass
  92         # --- if we are analyzing "context" element then store its "path" attribute
  93         if self.space == [appli_tag, context_tag] and path_att in attrs.getNames():
  94             self.config["context_path"] = attrs.getValue( path_att )
  95             pass
  96         # --- if we are analyzing "system_conf" element then store its "path" attribute
  97         if self.space == [appli_tag, system_conf_tag] and path_att in attrs.getNames():
  98             self.config["system_conf_path"] = attrs.getValue( path_att )
  99             pass
 100         # --- if we are analyzing "resources" element then store its "path" attribute
 101         if self.space == [appli_tag, resources_tag] and path_att in attrs.getNames():
 102             self.config["resources_path"] = attrs.getValue( path_att )
 103             pass
 104         # --- if we are analyzing "samples" element then store its "path" attribute
 105         if self.space == [appli_tag, samples_tag] and path_att in attrs.getNames():
 106             self.config["samples_path"] = attrs.getValue( path_att )
 107             pass
 108         # --- if we are analyzing "module" element then store its "name" and "path" attributes
 109         elif self.space == [appli_tag,modules_tag,module_tag] and \
 110             nam_att in attrs.getNames() and \
 111             path_att in attrs.getNames():
 112             nam = attrs.getValue( nam_att )
 113             path = attrs.getValue( path_att )
 114             gui = 1
 115             if gui_att in attrs.getNames():
 116                 gui = self.boolValue(attrs.getValue( gui_att ))
 117                 pass
 118             self.config["modules"].append(nam)
 119             self.config[nam]=path
 120             if gui:
 121                 self.config["guimodules"].append(nam)
 122                 pass
 123             pass
 124         # --- if we are analyzing "extra_test" element then store its "name" and "path" attributes
 125         elif self.space == [appli_tag,extra_tests_tag,extra_test_tag] and \
 126             nam_att in attrs.getNames() and \
 127             path_att in attrs.getNames():
 128             nam = attrs.getValue( nam_att )
 129             path = attrs.getValue( path_att )
 130             self.config["extra_tests"].append(nam)
 131             self.config[nam]=path
 132             pass
 133         pass
 134
 135     def endElement(self, name):
 136         self.space.pop()
 137         self.current = None
 138         pass
 139
 140     def characters(self, content):
 141         pass
 142
 143     def processingInstruction(self, target, data):
 144         pass
 145
 146     def setDocumentLocator(self, locator):
 147         pass
 148
 149     def startDocument(self):
 150         self.read = None
 151         pass
 152
 153     def endDocument(self):
 154         self.read = None
 155         pass
 156
 157 # -----------------------------------------------------------------------------
 158
 159 class params:
 160     pass
 161
 162 # -----------------------------------------------------------------------------
 163
 164 def makedirs(namedir):
 165   if os.path.exists(namedir):
 166     dirbak = namedir+".bak"
 167     if os.path.exists(dirbak):
 168       shutil.rmtree(dirbak)
 169     os.rename(namedir, dirbak)
 170     os.listdir(dirbak) #sert seulement a mettre a jour le systeme de fichier sur certaines machines
 171   os.makedirs(namedir)
 172
 173 def install(prefix, config_file, verbose=0):
 174     home_dir = os.path.abspath(os.path.expanduser(prefix))
 175     filename = os.path.abspath(os.path.expanduser(config_file))
 176     _config = {}
 177     try:
 178         parser = xml_parser(filename)
 179         _config = parser.config
 180     except xml.sax.SAXParseException, inst:
 181         print inst.getMessage()
 182         print "Configure parser: parse error in configuration file %s" % filename
 183         pass
 184     except xml.sax.SAXException, inst:
 185         print inst.args
 186         print "Configure parser: error in configuration file %s" % filename
 187         pass
 188     except:
 189         print "Configure parser: Error : can not read configuration file %s, check existence and rights" % filename
 190         pass
 191
 192     if verbose:
 193         for cle,val in _config.items():
 194             print cle, val
 195             pass
 196
 197     # Remove CTestTestfile.cmake; this file will be filled by successive calls to link_module and link_extra_test
 198     try:
 199       ctest_file = os.path.join(home_dir, 'bin', 'salome', 'test', "CTestTestfile.cmake")
 200       os.remove(ctest_file)
 201     except:
 202       pass
 203
 204     for module in _config.get("modules", []):
 205         if _config.has_key(module):
 206             print "--- add module ", module, _config[module]
 207             options = params()
 208             options.verbose = verbose
 209             options.clear = 0
 210             options.prefix = home_dir
 211             options.module_name = module
 212             options.module_path = _config[module]
 213             virtual_salome.link_module(options)
 214             pass
 215         pass
 216
 217     for extra_test in _config.get("extra_tests", []):
 218         if _config.has_key(extra_test):
 219             print "--- add extra test ", extra_test, _config[extra_test]
 220             options = params()
 221             options.verbose = verbose
 222             options.clear = 0
 223             options.prefix = home_dir
 224             options.extra_test_name = extra_test
 225             options.extra_test_path = _config[extra_test]
 226             virtual_salome.link_extra_test(options)
 227             pass
 228         pass
 229
 230     # Generate CTestCustom.cmake to handle long output
 231     ctest_custom = os.path.join(home_dir, 'bin', 'salome', 'test', "CTestCustom.cmake")
 232     with open(ctest_custom, 'w') as f:
 233       f.write("SET(CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE 1048576) # 1MB\n")
 234       f.write("SET(CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE 1048576) # 1MB\n")
 235
 236     appliskel_dir = os.path.join(home_dir, 'bin', 'salome', 'appliskel')
 237
 238     for fn in ('envd',
 239                'getAppliPath.py',
 240                'kill_remote_containers.py',
 241                'runRemote.sh',
 242                'salome',
 243                'update_catalogs.py',
 244                '.bashrc',
 245                ):
 246         virtual_salome.symlink( os.path.join( appliskel_dir, fn ), os.path.join( home_dir, fn) )
 247         pass
 248
 249     if filename != os.path.join(home_dir,"config_appli.xml"):
 250         shutil.copyfile(filename, os.path.join(home_dir,"config_appli.xml"))
 251         pass
 252
 253
 254     # Add .salome-completion.sh file
 255     shutil.copyfile(os.path.join(appliskel_dir, ".salome-completion.sh"),
 256                     os.path.join(home_dir, ".salome-completion.sh"))
 257
 258
 259     # Creation of env.d directory
 260     virtual_salome.mkdir(os.path.join(home_dir,'env.d'))
 261
 262     if _config.has_key("prereq_path") and os.path.isfile(_config["prereq_path"]):
 263         shutil.copyfile(_config["prereq_path"],
 264                         os.path.join(home_dir, 'env.d', 'envProducts.sh'))
 265         pass
 266     else:
 267         print "WARNING: prerequisite file does not exist"
 268         pass
 269
 270     if _config.has_key("context_path") and os.path.isfile(_config["context_path"]):
 271         shutil.copyfile(_config["context_path"],
 272                         os.path.join(home_dir, 'env.d', 'envProducts.cfg'))
 273         pass
 274     else:
 275         print "WARNING: context file does not exist"
 276         pass
 277
 278     if _config.has_key("system_conf_path") and os.path.isfile(_config["system_conf_path"]):
 279         shutil.copyfile(_config["system_conf_path"],
 280                         os.path.join(home_dir, 'env.d', 'envConfSystem.sh'))
 281         pass
 282
 283     # Create environment file: configSalome.sh
 284     with open(os.path.join(home_dir, 'env.d', 'configSalome.sh'),'w') as f:
 285         for module in _config.get("modules", []):
 286             command = 'export '+ module + '_ROOT_DIR=${HOME}/${APPLI}\n'
 287             f.write(command)
 288             pass
 289         if _config.has_key("samples_path"):
 290             command = 'export DATA_DIR=' + _config["samples_path"] +'\n'
 291             f.write(command)
 292             pass
 293         if _config.has_key("resources_path") and os.path.isfile(_config["resources_path"]):
 294             command = 'export USER_CATALOG_RESOURCES_FILE=' + os.path.abspath(_config["resources_path"]) +'\n'
 295             f.write(command)
 296
 297     # Create configuration file: configSalome.cfg
 298     with open(os.path.join(home_dir, 'env.d', 'configSalome.cfg'),'w') as f:
 299         command = "[SALOME ROOT_DIR (modules) Configuration]\n"
 300         f.write(command)
 301         for module in _config.get("modules", []):
 302             command = module + '_ROOT_DIR=${HOME}/${APPLI}\n'
 303             f.write(command)
 304             pass
 305         if _config.has_key("samples_path"):
 306             command = 'DATA_DIR=' + _config["samples_path"] +'\n'
 307             f.write(command)
 308             pass
 309         if _config.has_key("resources_path") and os.path.isfile(_config["resources_path"]):
 310             command = 'USER_CATALOG_RESOURCES_FILE=' + os.path.abspath(_config["resources_path"]) +'\n'
 311             f.write(command)
 312
 313
 314     # Create environment file: configGUI.sh
 315     with open(os.path.join(home_dir, 'env.d', 'configGUI.sh'),'w') as f:
 316         command = """export SalomeAppConfig=${HOME}/${APPLI}
 317 export SUITRoot=${HOME}/${APPLI}/share/salome
 318 export DISABLE_FPE=1
 319 export MMGT_REENTRANT=1
 320 """
 321         f.write(command)
 322
 323     # Create configuration file: configGUI.cfg
 324     with open(os.path.join(home_dir, 'env.d', 'configGUI.cfg'),'w') as f:
 325         command = """[SALOME GUI Configuration]
 326 SalomeAppConfig=${HOME}/${APPLI}
 327 SUITRoot=${HOME}/${APPLI}/share/salome
 328 DISABLE_FPE=1
 329 MMGT_REENTRANT=1
 330 """
 331         f.write(command)
 332
 333     #SalomeApp.xml file
 334     with open(os.path.join(home_dir,'SalomeApp.xml'),'w') as f:
 335         command = """<document>
 336   <section name="launch">
 337     <!-- SALOME launching parameters -->
 338     <parameter name="gui"        value="yes"/>
 339     <parameter name="splash"     value="yes"/>
 340     <parameter name="file"       value="no"/>
 341     <parameter name="key"        value="no"/>
 342     <parameter name="interp"     value="no"/>
 343     <parameter name="logger"     value="no"/>
 344     <parameter name="xterm"      value="no"/>
 345     <parameter name="portkill"   value="no"/>
 346     <parameter name="killall"    value="no"/>
 347     <parameter name="noexcepthandler"  value="no"/>
 348     <parameter name="modules"    value="%s"/>
 349     <parameter name="pyModules"  value=""/>
 350     <parameter name="embedded"   value="SalomeAppEngine,study,cppContainer,registry,moduleCatalog"/>
 351     <parameter name="standalone" value=""/>
 352   </section>
 353 </document>
 354 """
 355         mods = []
 356         #Keep all modules except KERNEL and GUI
 357         for module in _config.get("modules", []):
 358             if module in ("KERNEL","GUI"):
 359                 continue
 360             mods.append(module)
 361         f.write(command % ",".join(mods))
 362
 363     #Add USERS directory with 777 permission to store users configuration files
 364     users_dir = os.path.join(home_dir,'USERS')
 365     makedirs(users_dir)
 366     os.chmod(users_dir, 0777)
 367
 368 def main():
 369     parser = optparse.OptionParser(usage=usage)
 370
 371     parser.add_option('--prefix', dest="prefix", default='.',
 372                       help="Installation directory (default .)")
 373
 374     parser.add_option('--config', dest="config", default='config_appli.xml',
 375                       help="XML configuration file (default config_appli.xml)")
 376
 377     parser.add_option('-v', '--verbose', action='count', dest='verbose',
 378                       default=0, help="Increase verbosity")
 379
 380     options, args = parser.parse_args()
 381     if not os.path.exists(options.config):
 382         print "ERROR: config file %s does not exist. It is mandatory." % options.config
 383         sys.exit(1)
 384
 385     install(prefix=options.prefix, config_file=options.config, verbose=options.verbose)
 386     pass
 387
 388 # -----------------------------------------------------------------------------
 389
 390 if __name__ == '__main__':
 391     main()
 392     pass