Salome HOME
[bos #32519][EDF] (2022-T3)
[modules/kernel.git] / bin / appli_gen.py
index 504d8dc4fba8befcd8cbf20c1e50ec5542686695..0a4e06be391ddc83c653e1282d19f33f471fb4ab 100755 (executable)
@@ -1,5 +1,5 @@
 #! /usr/bin/env python3
-# Copyright (C) 2007-2019  CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2022  CEA/DEN, EDF R&D, OPEN CASCADE
 #
 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -43,6 +43,7 @@ import subprocess
 appli_tag   = "application"
 prereq_tag  = "prerequisites"
 context_tag = "context"
+venv_directory_tag = "venv_directory"
 sha1_collect_tag = "sha1_collections"
 system_conf_tag  = "system_conf"
 modules_tag = "modules"
@@ -53,11 +54,13 @@ extra_test_tag = "extra_test"
 resources_tag = "resources"
 env_modules_tag = "env_modules"
 env_module_tag = "env_module"
+python_tag = "python"
 
 # --- names of attributes in XML configuration file
 nam_att  = "name"
 path_att = "path"
 gui_att  = "gui"
+version_att = "version"
 
 # -----------------------------------------------------------------------------
 
@@ -97,10 +100,18 @@ class xml_parser:
         if self.space == [appli_tag, context_tag] and path_att in attrs.getNames():
             self.config["context_path"] = attrs.getValue( path_att )
             pass
+        # --- if we are analyzing "venv_directory" element then store its "path" attribute
+        if self.space == [appli_tag, venv_directory_tag] and path_att in attrs.getNames():
+            self.config["venv_directory_path"] = attrs.getValue( path_att )
+            pass
         # --- if we are analyzing "sha1_collection" element then store its "path" attribute
         if self.space == [appli_tag, sha1_collect_tag] and path_att in attrs.getNames():
             self.config["sha1_collect_path"] = attrs.getValue( path_att )
             pass
+        # --- if we are analyzing "python" element then store its "version" attribute
+        if self.space == [appli_tag, python_tag] and version_att in attrs.getNames():
+            self.config["python_version"] = attrs.getValue( version_att )
+            pass
         # --- if we are analyzing "system_conf" element then store its "path" attribute
         if self.space == [appli_tag, system_conf_tag] and path_att in attrs.getNames():
             self.config["system_conf_path"] = attrs.getValue( path_att )
@@ -199,7 +210,7 @@ def install(prefix, config_file, verbose=0):
         print(inst.args)
         print("Configure parser: error in configuration file %s" % filename)
         pass
-    except:
+    except Exception:
         print("Configure parser: Error : can not read configuration file %s, check existence and rights" % filename)
         pass
 
@@ -212,7 +223,7 @@ def install(prefix, config_file, verbose=0):
     try:
       ctest_file = os.path.join(home_dir, 'bin', 'salome', 'test', "CTestTestfile.cmake")
       os.remove(ctest_file)
-    except:
+    except Exception:
       pass
 
     for module in _config.get("modules", []):
@@ -249,18 +260,26 @@ def install(prefix, config_file, verbose=0):
             pass
         pass
 
+    # Sort test labels by name in generated CTestTestfile.cmake
+    with open(ctest_file) as f:
+        lines = f.readlines()
+    lines.sort()
+    with open(ctest_file, "w") as f:
+        f.write("".join(lines))
+
     # Generate CTestCustom.cmake to handle long output
     ctest_custom = os.path.join(home_dir, 'bin', 'salome', 'test', "CTestCustom.cmake")
     with open(ctest_custom, 'w') as f:
       f.write("SET(CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE 1048576) # 1MB\n")
       f.write("SET(CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE 1048576) # 1MB\n")
 
-    appliskel_dir = os.path.join(home_dir, 'bin', 'salome', 'appliskel')
+    appliskel_dir = os.path.join(prefix, 'bin', 'salome', 'appliskel')
 
     for fn in ('envd',
                'getAppliPath.py',
                'kill_remote_containers.py',
                'runRemote.sh',
+               'runRemoteSSL.sh',
                '.salome_run',
                'update_catalogs.py',
                '.bashrc',
@@ -272,28 +291,38 @@ def install(prefix, config_file, verbose=0):
         shutil.copyfile(filename, os.path.join(home_dir,"config_appli.xml"))
         pass
 
+    # Creation of env.d directory
+    virtual_salome.mkdir(os.path.join(home_dir,'env.d'))
 
-    # Copy salome script 
-    salome_script = open(os.path.join(appliskel_dir, "salome")).read()
-    salome_file = os.path.join(home_dir, "salome")
-    try:
-        os.remove(salome_file)
-    except:
-        pass
-    env_modules = _config.get('env_modules', [])
-    with open(salome_file, 'w') as fd:
-        fd.write(salome_script.replace('MODULES = []', 'MODULES = {}'.format(env_modules)))
-    os.chmod(salome_file, 0o755)
+    venv_directory_path = _config.get('venv_directory_path')
+    if venv_directory_path and os.path.isdir(venv_directory_path):
+        virtual_salome.symlink(venv_directory_path, os.path.join(home_dir, "venv"))
 
+    # Get the env modules which will be loaded
+    # In the same way as: module load [MODULE_LIST]
+    env_modules = _config.get('env_modules', [])
+    if env_modules:
+        with open(os.path.join(home_dir, 'env.d', 'envModules.sh'), 'w') as fd:
+            fd.write('#!/bin/bash\n')
+            fd.write('module load %s\n' % (' '.join(env_modules)))
+
+    # Copy salome / salome_mesa scripts:
+
+    for scripts in ('salome', 'salome_mesa', 'salome_common.py'):
+        salome_script = open(os.path.join(appliskel_dir, scripts)).read()
+        salome_file = os.path.join(home_dir, scripts)
+        try:
+            os.remove(salome_file)
+        except Exception:
+            pass
+        with open(salome_file, 'w') as fd:
+            fd.write(salome_script.replace('MODULES = []', 'MODULES = {}'.format(env_modules)))
+            os.chmod(salome_file, 0o755)
 
     # Add .salome-completion.sh file
     shutil.copyfile(os.path.join(appliskel_dir, ".salome-completion.sh"),
                     os.path.join(home_dir, ".salome-completion.sh"))
 
-
-    # Creation of env.d directory
-    virtual_salome.mkdir(os.path.join(home_dir,'env.d'))
-
     if "prereq_path" in _config and os.path.isfile(_config["prereq_path"]):
         shutil.copyfile(_config["prereq_path"],
                         os.path.join(home_dir, 'env.d', 'envProducts.sh'))
@@ -325,8 +354,25 @@ def install(prefix, config_file, verbose=0):
 
     # Create environment file: configSalome.sh
 
-    cmd='source %s;python -c "import sys ; sys.stdout.write(\\"{}.{}\\".format(sys.version_info.major,sys.version_info.minor))"' %(_config["prereq_path"])
-    versionPython=subprocess.check_output(['/bin/bash', '-l' ,'-c',cmd])
+    if "python_version" in _config:
+       versionPython_split = _config["python_version"].split('.')
+       versionPython = versionPython_split[0] + "." + versionPython_split[1]
+    else:
+       cmd='source %s && python3 -c "import sys ; sys.stdout.write(\\"{}.{}\\".format(sys.version_info.major,sys.version_info.minor))"' %(_config["prereq_path"])
+       versionPython=subprocess.check_output(['/bin/bash', '-l' ,'-c',cmd]).decode("utf-8")
+
+    venv_directory_path = None
+    if "venv_directory_path" in _config:
+        venv_directory_path = _config["venv_directory_path"]
+        venv_bin_directory_path = os.path.join(venv_directory_path, 'bin')
+        venv_pip_executable = os.path.join(venv_bin_directory_path, 'pip')
+        venv_python_executable = os.path.join(venv_bin_directory_path, 'python')
+        if os.path.isdir(venv_directory_path) and os.path.isfile(venv_pip_executable):
+            requirement_file = os.path.join(home_dir, 'requirements.txt')
+            with open(requirement_file, 'w') as fd:
+                subprocess.call([venv_python_executable, '-m', 'pip', 'freeze'], stdout=fd)
+        else:
+            venv_directory_path = None
 
     with open(os.path.join(home_dir, 'env.d', 'configSalome.sh'),'w') as f:
         for module in _config.get("modules", []):
@@ -340,15 +386,36 @@ def install(prefix, config_file, verbose=0):
         if "resources_path" in _config and os.path.isfile(_config["resources_path"]):
             command = 'export USER_CATALOG_RESOURCES_FILE=' + os.path.abspath(_config["resources_path"]) +'\n'
             f.write(command)
+        # 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)
         command ="""export PATH=${HOME}/${APPLI}/bin/salome:$PATH
 export PYTHONPATH=${HOME}/${APPLI}/lib/python%s/site-packages/salome:$PYTHONPATH
 export PYTHONPATH=${HOME}/${APPLI}/lib/salome:$PYTHONPATH
+export PYTHONPATH=${HOME}/${APPLI}/bin/salome:$PYTHONPATH
 export LD_LIBRARY_PATH=${HOME}/${APPLI}/lib/salome:$LD_LIBRARY_PATH
-""" %versionPython.decode("utf-8")
+""" %versionPython
         f.write(command)
         # Create environment variable for the salome test
         for module in _config.get("modules", []):
-            command = "export LD_LIBRARY_PATH=  ${HOME}/${APPLI}/bin/salome/test/" + module + "/lib:$LD_LIBRARY_PATH\n"
+            command = "export LD_LIBRARY_PATH=${HOME}/${APPLI}/bin/salome/test/" + module + "/lib:$LD_LIBRARY_PATH\n"
+            f.write(command)
+            pass
+        # Create environment for plugins GEOM
+        command = "export GEOM_PluginsList=BREPPlugin:STEPPlugin:IGESPlugin:STLPlugin:XAOPlugin:VTKPlugin:AdvancedGEOM\n"
+        f.write(command)
+        # Create environment for Healing
+        command = "export CSF_ShHealingDefaults=${HOME}/${APPLI}/share/salome/resources/geom\n"
+        f.write(command)
+        # Create environment for Meshers
+        command = "export SMESH_MeshersList=StdMeshers:HYBRIDPlugin:HexoticPLUGIN:GMSHPlugin:GHS3DPlugin:NETGENPlugin:HEXABLOCKPlugin:BLSURFPlugin:GHS3DPRLPlugin\nexport SALOME_StdMeshersResources=${HOME}/${APPLI}/share/salome/resources/smesh\n"
+        f.write(command)
+        # Create environment for virtual env
+        if venv_directory_path:
+            command = """# SALOME venv Configuration
+export SALOME_VENV_DIRECTORY=${HOME}/${APPLI}/venv
+export PATH=${HOME}/${APPLI}/venv/bin:$PATH
+export LD_LIBRARY_PATH=${HOME}/${APPLI}/venv/lib:$LD_LIBRARY_PATH
+export PYTHONPATH=${HOME}/${APPLI}/venv/lib/python%s/site-packages
+""" % (versionPython)
             f.write(command)
             pass
 
@@ -371,13 +438,31 @@ export LD_LIBRARY_PATH=${HOME}/${APPLI}/lib/salome:$LD_LIBRARY_PATH
 ADD_TO_PYTHONPATH: ${HOME}/${APPLI}/lib/python%s/site-packages/salome
 ADD_TO_PYTHONPATH: ${HOME}/${APPLI}/lib/salome
 ADD_TO_LD_LIBRARY_PATH: ${HOME}/${APPLI}/lib/salome
-"""%versionPython.decode("utf-8")
+"""%versionPython
         f.write(command)
         for module in _config.get("modules", []):
             command = "ADD_TO_LD_LIBRARY_PATH: ${HOME}/${APPLI}/bin/salome/test/" + module + "/lib\n"
             f.write(command)
             pass
-
+        # Create environment for plugins GEOM
+        command = "GEOM_PluginsList=BREPPlugin:STEPPlugin:IGESPlugin:STLPlugin:XAOPlugin:VTKPlugin:AdvancedGEOM\n"
+        f.write(command)
+        # Create environment for Healing
+        command = "CSF_ShHealingDefaults=${HOME}/${APPLI}/share/salome/resources/geom\n"
+        f.write(command)
+        # Create environment for Meshers
+        command = "SMESH_MeshersList=StdMeshers:HYBRIDPlugin:HexoticPLUGIN:GMSHPlugin:GHS3DPlugin:NETGENPlugin:HEXABLOCKPlugin:BLSURFPlugin:GHS3DPRLPlugin\nSALOME_StdMeshersResources=${HOME}/${APPLI}/share/salome/resources/smesh\n"
+        f.write(command)
+        # Create environment for virtual env
+        if venv_directory_path:
+            command = """[SALOME venv Configuration]
+SALOME_VENV_DIRECTORY: ${HOME}/${APPLI}/venv
+ADD_TO_PATH: ${HOME}/${APPLI}/venv/bin
+ADD_TO_LD_LIBRARY_PATH: ${HOME}/${APPLI}/venv/lib
+ADD_TO_PYTHONPATH: ${HOME}/${APPLI}/venv/lib/python%s/site-packages
+""" % (versionPython)
+            f.write(command)
+            pass
 
     # Create environment file: configGUI.sh
     dirs_ress_icon = []
@@ -400,6 +485,7 @@ export MMGT_REENTRANT=1
         f.write(command)
 
     # Create configuration file: configGUI.cfg
+    dirs_ress_icon = []
     with open(os.path.join(home_dir, 'env.d', 'configGUI.cfg'),'w') as f:
         command = """[SALOME GUI Configuration]\n"""
         f.write(command)