Salome HOME
Fix commit 1d03556: salome scripts must be copied, not add as symlinks
[modules/kernel.git] / bin / appli_gen.py
index d35b3339df8a489972c94a3214cca40b26ff6d29..f6345e339d23ecc90a12ad1011cd85c8637bab18 100755 (executable)
@@ -1,5 +1,5 @@
 #! /usr/bin/env python3
-# Copyright (C) 2007-2020  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
 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 #
 
-## \file appli_gen.py
+# \file appli_gen.py
 #  Create a %SALOME application (virtual Salome installation)
 #
-usage = """%(prog)s [options]
-Typical use is:
-  python %(prog)s
-Typical use with options is:
-  python %(prog)s --verbose --prefix=<install directory> --config=<configuration file>
-"""
 
+import json
 import os
 import sys
 import shutil
@@ -39,14 +34,22 @@ import xml.sax
 import optparse
 import subprocess
 
+usage = """%(prog)s [options]
+Typical use is:
+  python %(prog)s
+Typical use with options is:
+  python %(prog)s --verbose --prefix=<install directory> --config=<configuration file>
+"""
+
 # --- names of tags in XML configuration file
-appli_tag   = "application"
-prereq_tag  = "prerequisites"
+appli_tag = "application"
+prereq_tag = "prerequisites"
 context_tag = "context"
+venv_directory_tag = "venv_directory"
 sha1_collect_tag = "sha1_collections"
-system_conf_tag  = "system_conf"
+system_conf_tag = "system_conf"
 modules_tag = "modules"
-module_tag  = "module"
+module_tag = "module"
 samples_tag = "samples"
 extra_tests_tag = "extra_tests"
 extra_test_tag = "extra_test"
@@ -56,17 +59,17 @@ env_module_tag = "env_module"
 python_tag = "python"
 
 # --- names of attributes in XML configuration file
-nam_att  = "name"
+nam_att = "name"
 path_att = "path"
-gui_att  = "gui"
+gui_att = "gui"
 version_att = "version"
-
 # -----------------------------------------------------------------------------
 
+
 # --- xml reader for SALOME application configuration file
 
 class xml_parser:
-    def __init__(self, fileName ):
+    def __init__(self, fileName):
         print("Configure parser: processing %s ..." % fileName)
         self.space = []
         self.config = {}
@@ -79,7 +82,7 @@ class xml_parser:
         parser.parse(fileName)
         pass
 
-    def boolValue( self, text):
+    def boolValue(self, text):
         if text in ("yes", "y", "1"):
             return 1
         elif text in ("no", "n", "0"):
@@ -99,6 +102,10 @@ 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 )
@@ -205,7 +212,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
 
@@ -218,7 +225,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", []):
@@ -274,6 +281,7 @@ def install(prefix, config_file, verbose=0):
                'getAppliPath.py',
                'kill_remote_containers.py',
                'runRemote.sh',
+               'runRemoteSSL.sh',
                '.salome_run',
                'update_catalogs.py',
                '.bashrc',
@@ -285,6 +293,22 @@ 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'))
+
+    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_modules.json'), 'w') as fd:
+            json.dump({"env_modules": env_modules}, fd)
+        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:
 
@@ -293,9 +317,8 @@ def install(prefix, config_file, verbose=0):
         salome_file = os.path.join(home_dir, scripts)
         try:
             os.remove(salome_file)
-        except:
+        except Exception:
             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)
@@ -304,10 +327,6 @@ def install(prefix, config_file, verbose=0):
     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'))
@@ -346,6 +365,19 @@ def install(prefix, config_file, verbose=0):
        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", []):
             command = 'export '+ module + '_ROOT_DIR=${HOME}/${APPLI}\n'
@@ -380,6 +412,16 @@ export LD_LIBRARY_PATH=${HOME}/${APPLI}/lib/salome:$LD_LIBRARY_PATH
         # 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
 
     # Create configuration file: configSalome.cfg
     with open(os.path.join(home_dir, 'env.d', 'configSalome.cfg'),'w') as f:
@@ -415,7 +457,16 @@ ADD_TO_LD_LIBRARY_PATH: ${HOME}/${APPLI}/lib/salome
         # 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 = []