1 #! /usr/bin/env python3
2 # Copyright (C) 2007-2019 CEA/DEN, EDF R&D, OPEN CASCADE
4 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
7 # This library is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU Lesser General Public
9 # License as published by the Free Software Foundation; either
10 # version 2.1 of the License, or (at your option) any later version.
12 # This library is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # Lesser General Public License for more details.
17 # You should have received a copy of the GNU Lesser General Public
18 # License along with this library; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
25 # Create a %SALOME application (virtual Salome installation)
27 usage = """%(prog)s [options]
30 Typical use with options is:
31 python %(prog)s --verbose --prefix=<install directory> --config=<configuration file>
42 # --- names of tags in XML configuration file
43 appli_tag = "application"
44 prereq_tag = "prerequisites"
45 context_tag = "context"
46 sha1_collect_tag = "sha1_collections"
47 system_conf_tag = "system_conf"
48 modules_tag = "modules"
50 samples_tag = "samples"
51 extra_tests_tag = "extra_tests"
52 extra_test_tag = "extra_test"
53 resources_tag = "resources"
54 env_modules_tag = "env_modules"
55 env_module_tag = "env_module"
58 # --- names of attributes in XML configuration file
62 version_att = "version"
64 # -----------------------------------------------------------------------------
66 # --- xml reader for SALOME application configuration file
69 def __init__(self, fileName ):
70 print("Configure parser: processing %s ..." % fileName)
73 self.config["modules"] = []
74 self.config["guimodules"] = []
75 self.config["extra_tests"] = []
76 self.config["env_modules"] = []
77 parser = xml.sax.make_parser()
78 parser.setContentHandler(self)
79 parser.parse(fileName)
82 def boolValue( self, text):
83 if text in ("yes", "y", "1"):
85 elif text in ("no", "n", "0"):
91 def startElement(self, name, attrs):
92 self.space.append(name)
94 # --- if we are analyzing "prerequisites" element then store its "path" attribute
95 if self.space == [appli_tag, prereq_tag] and path_att in attrs.getNames():
96 self.config["prereq_path"] = attrs.getValue( path_att )
98 # --- if we are analyzing "context" element then store its "path" attribute
99 if self.space == [appli_tag, context_tag] and path_att in attrs.getNames():
100 self.config["context_path"] = attrs.getValue( path_att )
102 # --- if we are analyzing "sha1_collection" element then store its "path" attribute
103 if self.space == [appli_tag, sha1_collect_tag] and path_att in attrs.getNames():
104 self.config["sha1_collect_path"] = attrs.getValue( path_att )
106 # --- if we are analyzing "python" element then store its "version" attribute
107 if self.space == [appli_tag, python_tag] and version_att in attrs.getNames():
108 self.config["python_version"] = attrs.getValue( version_att )
110 # --- if we are analyzing "system_conf" element then store its "path" attribute
111 if self.space == [appli_tag, system_conf_tag] and path_att in attrs.getNames():
112 self.config["system_conf_path"] = attrs.getValue( path_att )
114 # --- if we are analyzing "resources" element then store its "path" attribute
115 if self.space == [appli_tag, resources_tag] and path_att in attrs.getNames():
116 self.config["resources_path"] = attrs.getValue( path_att )
118 # --- if we are analyzing "samples" element then store its "path" attribute
119 if self.space == [appli_tag, samples_tag] and path_att in attrs.getNames():
120 self.config["samples_path"] = attrs.getValue( path_att )
122 # --- if we are analyzing "module" element then store its "name" and "path" attributes
123 elif self.space == [appli_tag,modules_tag,module_tag] and \
124 nam_att in attrs.getNames() and \
125 path_att in attrs.getNames():
126 nam = attrs.getValue( nam_att )
127 path = attrs.getValue( path_att )
129 if gui_att in attrs.getNames():
130 gui = self.boolValue(attrs.getValue( gui_att ))
132 self.config["modules"].append(nam)
133 self.config[nam]=path
135 self.config["guimodules"].append(nam)
138 # --- if we are analyzing "env_module" element then store its "name" attribute
139 elif self.space == [appli_tag, env_modules_tag, env_module_tag] and \
140 nam_att in attrs.getNames():
141 nam = attrs.getValue( nam_att )
142 self.config["env_modules"].append(nam)
144 # --- if we are analyzing "extra_test" element then store its "name" and "path" attributes
145 elif self.space == [appli_tag,extra_tests_tag,extra_test_tag] and \
146 nam_att in attrs.getNames() and \
147 path_att in attrs.getNames():
148 nam = attrs.getValue( nam_att )
149 path = attrs.getValue( path_att )
150 self.config["extra_tests"].append(nam)
151 self.config[nam]=path
155 def endElement(self, name):
160 def characters(self, content):
163 def processingInstruction(self, target, data):
166 def setDocumentLocator(self, locator):
169 def startDocument(self):
173 def endDocument(self):
177 # -----------------------------------------------------------------------------
182 # -----------------------------------------------------------------------------
184 def makedirs(namedir):
185 if os.path.exists(namedir):
186 dirbak = namedir+".bak"
187 if os.path.exists(dirbak):
188 shutil.rmtree(dirbak)
189 os.rename(namedir, dirbak)
190 os.listdir(dirbak) #sert seulement a mettre a jour le systeme de fichier sur certaines machines
193 def install(prefix, config_file, verbose=0):
194 home_dir = os.path.abspath(os.path.expanduser(prefix))
195 filename = os.path.abspath(os.path.expanduser(config_file))
198 parser = xml_parser(filename)
199 _config = parser.config
200 except xml.sax.SAXParseException as inst:
201 print(inst.getMessage())
202 print("Configure parser: parse error in configuration file %s" % filename)
204 except xml.sax.SAXException as inst:
206 print("Configure parser: error in configuration file %s" % filename)
209 print("Configure parser: Error : can not read configuration file %s, check existence and rights" % filename)
213 for cle,val in _config.items():
217 # Remove CTestTestfile.cmake; this file will be filled by successive calls to link_module and link_extra_test
219 ctest_file = os.path.join(home_dir, 'bin', 'salome', 'test', "CTestTestfile.cmake")
220 os.remove(ctest_file)
224 for module in _config.get("modules", []):
225 if module in _config:
226 print("--- add module ", module, _config[module])
228 options.verbose = verbose
230 options.prefix = home_dir
231 options.module_name = module
232 options.module_path = _config[module]
233 virtual_salome.link_module(options)
234 # To fix GEOM_TestXAO issue https://codev-tuleap.cea.fr/plugins/tracker/?aid=16599
236 # link <appli_path>/bin/salome/test/<module> to <module_path>/bin/salome/test
237 test_dir=os.path.join(home_dir,'bin','salome', 'test')
238 module_dir=os.path.abspath(options.module_path)
239 xao_link=os.path.join(module_dir,'bin','salome', 'test', "xao")
240 print("link %s --> %s"%(os.path.join(test_dir, "xao"), xao_link))
241 virtual_salome.symlink(xao_link, os.path.join(test_dir, "xao"))
245 for extra_test in _config.get("extra_tests", []):
246 if extra_test in _config:
247 print("--- add extra test ", extra_test, _config[extra_test])
249 options.verbose = verbose
251 options.prefix = home_dir
252 options.extra_test_name = extra_test
253 options.extra_test_path = _config[extra_test]
254 virtual_salome.link_extra_test(options)
258 # Sort test labels by name in generated CTestTestfile.cmake
259 with open(ctest_file) as f:
260 lines = f.readlines()
262 with open(ctest_file, "w") as f:
263 f.write("".join(lines))
265 # Generate CTestCustom.cmake to handle long output
266 ctest_custom = os.path.join(home_dir, 'bin', 'salome', 'test', "CTestCustom.cmake")
267 with open(ctest_custom, 'w') as f:
268 f.write("SET(CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE 1048576) # 1MB\n")
269 f.write("SET(CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE 1048576) # 1MB\n")
271 appliskel_dir = os.path.join(home_dir, 'bin', 'salome', 'appliskel')
275 'kill_remote_containers.py',
278 'update_catalogs.py',
281 virtual_salome.symlink( os.path.join( appliskel_dir, fn ), os.path.join( home_dir, fn) )
284 if filename != os.path.join(home_dir,"config_appli.xml"):
285 shutil.copyfile(filename, os.path.join(home_dir,"config_appli.xml"))
290 salome_script = open(os.path.join(appliskel_dir, "salome")).read()
291 salome_file = os.path.join(home_dir, "salome")
293 os.remove(salome_file)
296 env_modules = _config.get('env_modules', [])
297 with open(salome_file, 'w') as fd:
298 fd.write(salome_script.replace('MODULES = []', 'MODULES = {}'.format(env_modules)))
299 os.chmod(salome_file, 0o755)
302 # Add .salome-completion.sh file
303 shutil.copyfile(os.path.join(appliskel_dir, ".salome-completion.sh"),
304 os.path.join(home_dir, ".salome-completion.sh"))
307 # Creation of env.d directory
308 virtual_salome.mkdir(os.path.join(home_dir,'env.d'))
310 if "prereq_path" in _config and os.path.isfile(_config["prereq_path"]):
311 shutil.copyfile(_config["prereq_path"],
312 os.path.join(home_dir, 'env.d', 'envProducts.sh'))
315 print("WARNING: prerequisite file does not exist")
318 if "context_path" in _config and os.path.isfile(_config["context_path"]):
319 shutil.copyfile(_config["context_path"],
320 os.path.join(home_dir, 'env.d', 'envProducts.cfg'))
323 print("WARNING: context file does not exist")
326 if "sha1_collect_path" in _config and os.path.isfile(_config["sha1_collect_path"]):
327 shutil.copyfile(_config["sha1_collect_path"],
328 os.path.join(home_dir, 'sha1_collections.txt'))
331 print("WARNING: sha1 collections file does not exist")
334 if "system_conf_path" in _config and os.path.isfile(_config["system_conf_path"]):
335 shutil.copyfile(_config["system_conf_path"],
336 os.path.join(home_dir, 'env.d', 'envConfSystem.sh'))
339 # Create environment file: configSalome.sh
341 if "python_version" in _config:
342 versionPython_split = _config["python_version"].split('.')
343 versionPython = versionPython_split[0] + "." + versionPython_split[1]
345 cmd='source %s && python3 -c "import sys ; sys.stdout.write(\\"{}.{}\\".format(sys.version_info.major,sys.version_info.minor))"' %(_config["prereq_path"])
346 versionPython=subprocess.check_output(['/bin/bash', '-l' ,'-c',cmd]).decode("utf-8")
348 with open(os.path.join(home_dir, 'env.d', 'configSalome.sh'),'w') as f:
349 for module in _config.get("modules", []):
350 command = 'export '+ module + '_ROOT_DIR=${HOME}/${APPLI}\n'
353 if "samples_path" in _config:
354 command = 'export DATA_DIR=' + _config["samples_path"] +'\n'
357 if "resources_path" in _config and os.path.isfile(_config["resources_path"]):
358 command = 'export USER_CATALOG_RESOURCES_FILE=' + os.path.abspath(_config["resources_path"]) +'\n'
360 # Note: below, PYTHONPATH should not be extended to bin/salome! Python modules must be installed in lib/pythonX.Y, to be fixed (e.g. Kernel SALOME_Container.py)
361 command ="""export PATH=${HOME}/${APPLI}/bin/salome:$PATH
362 export PYTHONPATH=${HOME}/${APPLI}/lib/python%s/site-packages/salome:$PYTHONPATH
363 export PYTHONPATH=${HOME}/${APPLI}/lib/salome:$PYTHONPATH
364 export PYTHONPATH=${HOME}/${APPLI}/bin/salome:$PYTHONPATH
365 export LD_LIBRARY_PATH=${HOME}/${APPLI}/lib/salome:$LD_LIBRARY_PATH
368 # Create environment variable for the salome test
369 for module in _config.get("modules", []):
370 command = "export LD_LIBRARY_PATH=${HOME}/${APPLI}/bin/salome/test/" + module + "/lib:$LD_LIBRARY_PATH\n"
373 # Create environment for plugins GEOM
374 command = "export GEOM_PluginsList=BREPPlugin:STEPPlugin:IGESPlugin:STLPlugin:XAOPlugin:VTKPlugin:AdvancedGEOM\n"
376 # Create environment for Healing
377 command = "export CSF_ShHealingDefaults=${HOME}/${APPLI}/share/salome/resources/geom\n"
379 # Create environment for Meshers
380 command = "export SMESH_MeshersList=StdMeshers:HYBRIDPlugin:HexoticPLUGIN:GMSHPlugin:GHS3DPlugin:NETGENPlugin:HEXABLOCKPlugin:BLSURFPlugin\nexport SALOME_StdMeshersResources=${HOME}/${APPLI}/share/salome/resources/smesh\n"
383 # Create configuration file: configSalome.cfg
384 with open(os.path.join(home_dir, 'env.d', 'configSalome.cfg'),'w') as f:
385 command = "[SALOME ROOT_DIR (modules) Configuration]\n"
387 for module in _config.get("modules", []):
388 command = module + '_ROOT_DIR=${HOME}/${APPLI}\n'
391 if "samples_path" in _config:
392 command = 'DATA_DIR=' + _config["samples_path"] +'\n'
395 if "resources_path" in _config and os.path.isfile(_config["resources_path"]):
396 command = 'USER_CATALOG_RESOURCES_FILE=' + os.path.abspath(_config["resources_path"]) +'\n'
398 command ="""ADD_TO_PATH: ${HOME}/${APPLI}/bin/salome
399 ADD_TO_PYTHONPATH: ${HOME}/${APPLI}/lib/python%s/site-packages/salome
400 ADD_TO_PYTHONPATH: ${HOME}/${APPLI}/lib/salome
401 ADD_TO_LD_LIBRARY_PATH: ${HOME}/${APPLI}/lib/salome
404 for module in _config.get("modules", []):
405 command = "ADD_TO_LD_LIBRARY_PATH: ${HOME}/${APPLI}/bin/salome/test/" + module + "/lib\n"
408 # Create environment for plugins GEOM
409 command = "GEOM_PluginsList=BREPPlugin:STEPPlugin:IGESPlugin:STLPlugin:XAOPlugin:VTKPlugin:AdvancedGEOM\n"
411 # Create environment for Healing
412 command = "CSF_ShHealingDefaults=${HOME}/${APPLI}/share/salome/resources/geom\n"
414 # Create environment for Meshers
415 command = "SMESH_MeshersList=StdMeshers:HYBRIDPlugin:HexoticPLUGIN:GMSHPlugin:GHS3DPlugin:NETGENPlugin:HEXABLOCKPlugin:BLSURFPlugin\nSALOME_StdMeshersResources=${HOME}/${APPLI}/share/salome/resources/smesh\n"
419 # Create environment file: configGUI.sh
421 salomeappname = "SalomeApp"
422 with open(os.path.join(home_dir, 'env.d', 'configGUI.sh'),'w') as f:
423 for module in _config.get("modules", []):
424 if module not in ["KERNEL", "GUI", ""]:
425 d = os.path.join(_config[module],"share","salome","resources",module.lower())
426 d_appli = os.path.join("${HOME}","${APPLI}","share","salome","resources",module.lower())
427 if os.path.exists( os.path.join(d,"{0}.xml".format(salomeappname)) ):
428 dirs_ress_icon.append( d_appli )
429 AppConfig="export SalomeAppConfig=${HOME}/${APPLI}:${HOME}/${APPLI}/share/salome/resources/gui/"
430 for dir_module in dirs_ress_icon:
431 AppConfig=AppConfig+":"+dir_module
432 f.write(AppConfig+"\n")
433 command = """export SUITRoot=${HOME}/${APPLI}/share/salome
435 export MMGT_REENTRANT=1
439 # Create configuration file: configGUI.cfg
441 with open(os.path.join(home_dir, 'env.d', 'configGUI.cfg'),'w') as f:
442 command = """[SALOME GUI Configuration]\n"""
444 for module in _config.get("modules", []):
445 if module not in ["KERNEL", "GUI", ""]:
446 d = os.path.join(_config[module],"share","salome","resources",module.lower())
447 d_appli = os.path.join("${HOME}","${APPLI}","share","salome","resources",module.lower())
448 if os.path.exists( os.path.join(d,"{0}.xml".format(salomeappname)) ):
449 dirs_ress_icon.append( d_appli )
450 AppConfig="SalomeAppConfig=${HOME}/${APPLI}:${HOME}/${APPLI}/share/salome/resources/gui/"
451 for dir_module in dirs_ress_icon:
452 AppConfig=AppConfig+":"+dir_module
453 f.write(AppConfig+"\n")
454 command = """SUITRoot=${HOME}/${APPLI}/share/salome
461 with open(os.path.join(home_dir,'SalomeApp.xml'),'w') as f:
462 command = """<document>
463 <section name="launch">
464 <!-- SALOME launching parameters -->
465 <parameter name="gui" value="yes"/>
466 <parameter name="splash" value="yes"/>
467 <parameter name="file" value="no"/>
468 <parameter name="key" value="no"/>
469 <parameter name="interp" value="no"/>
470 <parameter name="logger" value="no"/>
471 <parameter name="xterm" value="no"/>
472 <parameter name="portkill" value="no"/>
473 <parameter name="killall" value="no"/>
474 <parameter name="noexcepthandler" value="no"/>
475 <parameter name="modules" value="%s"/>
476 <parameter name="pyModules" value=""/>
477 <parameter name="embedded" value="SalomeAppEngine,study,cppContainer,registry,moduleCatalog"/>
478 <parameter name="standalone" value=""/>
483 #Keep all modules except KERNEL and GUI
484 for module in _config.get("modules", []):
485 if module in ("KERNEL","GUI"):
488 f.write(command % ",".join(mods))
490 #Add USERS directory with 777 permission to store users configuration files
491 users_dir = os.path.join(home_dir,'USERS')
493 os.chmod(users_dir, 0o777)
496 parser = optparse.OptionParser(usage=usage)
498 parser.add_option('--prefix', dest="prefix", default='.',
499 help="Installation directory (default .)")
501 parser.add_option('--config', dest="config", default='config_appli.xml',
502 help="XML configuration file (default config_appli.xml)")
504 parser.add_option('-v', '--verbose', action='count', dest='verbose',
505 default=0, help="Increase verbosity")
507 options, args = parser.parse_args()
508 if not os.path.exists(options.config):
509 print("ERROR: config file %s does not exist. It is mandatory." % options.config)
512 install(prefix=options.prefix, config_file=options.config, verbose=options.verbose)
515 # -----------------------------------------------------------------------------
517 if __name__ == '__main__':