add support for depends_on in views and editor from envars (#591)

Signed-off-by: vsoch <[email protected]>

Author: vsoch

CHANGELOG.md

@@ -14,6 +14,7 @@ and **Merged pull requests**. Critical items to know are:
 The versions coincide with releases on pip. Only major versions will be released as tags on Github.
 
 ## [0.0.x](https://github.com/singularityhub/singularity-hpc/tree/main) (0.0.x)
+ - support for system modules, depends on, in views and editor envars (0.1.13)
  - Wrappers now supported for shell/exec/run container commands (0.1.12)
  - Update add to return container yaml (0.1.11)
  - Fixing bug with writing package file in update (0.1.1)

docs/getting_started/user-guide.rst

@@ -867,6 +867,7 @@ we load a view module named mpi, we always want to load a system module named "o
 
 .. code-block:: console
 
+    $ shpc view add <view> system_modules <name1> <name2>
     $ shpc view add mpi system_modules openmpi mymod
     Wrote updated .view_module: /home/vanessa/Desktop/Code/shpc/views/mpi/.view_module
     
@@ -891,6 +892,43 @@ Note that if you edit the files manually, you would need to edit the view.yaml A
 .view_module that is always updated from it.
 
 
+Add and Remove Depends On Modules to a View
+-------------------------------------------
+
+You can add (or remove) a ``depends_on`` clause to a view, just like with system modules.
+The syntax is the same, however you specify a different key to add to:
+
+.. code-block:: console
+
+    $ shpc view add <view> depends_on <name1> <name2>
+    $ shpc view add mpi depends_on openmpi
+    $ shpc view remove mpi depends_on openmpi
+
+When you add a ``depends_on`` or ``system_modules`` to a view, what we are doing under
+the hood is adding a ``.view_module`` that will be loaded with the view, and it includes these
+extra parameters. 
+
+.. code-block:: console
+
+    views/
+    └── mpi
+      ├── python
+      ├── view.yaml
+      ├── .view_module
+      └── 3.11-rc.lua -> /home/vanessa/Desktop/Code/shpc/modules/python/3.11-rc/module.lua
+        
+Here are example contents of ``.view_module`` (this will vary depending on your module software):
+
+.. code-block:: tcl
+
+    module load("myextraprogram")
+    depends_on("openmpi")
+
+
+If you want any extra features added to this custom file (e.g., to support loading in a view)
+please open an issue for discussion.
+
+
 Delete a View
 -------------
 
@@ -1018,7 +1056,8 @@ You can also open the config in the editor defined in settings at ``config_edito
     $ shpc config edit
     
 
-which defaults to vim.
+which will first look at the environment variables ``$EDITOR`` and ``$VISUAL`` and will
+fall back to the ``config_editor`` in your user settings (vim by default).
 
 .. _getting_started-commands-show:
 

shpc/main/modules/templates/view_module.lua

@@ -3,4 +3,5 @@
 --
 
 {% for module in system_modules %}
-module load("{{ module }}"){% endfor %}
+module load("{{ module }}"){% endfor %}{% for depends in depends_on %}
+depends_on("{{ depends }}"){% endfor %}

shpc/main/modules/templates/view_module.tcl

@@ -4,5 +4,5 @@
 # View for singularity-hpc (https://github.com/singularityhub/singularity-hpc)
 #=====
 
-{% for module in system_modules %}
-module load {{ module }}{% endfor %}
+{% if system_modules %}module load {% for module in system_modules %}{{ module }} {% endfor %}{% endif %}
+{% if depends_on %}depends-on {% for depend in depends_on %}{{ depend }} {% endfor %}{% endif %}

shpc/main/modules/views.py

@@ -16,7 +16,7 @@
 from shpc.logger import logger
 
 # Supported variables and defaults
-supported_view_variables = {"system_modules": []}
+supported_view_variables = {"system_modules": [], "depends_on": []}
 
 
 class ViewModule:
@@ -41,7 +41,8 @@ def write(self, view_dir, view_config):
         template = self.template.load("view_module.%s" % self.module_extension)
         view_module_file = os.path.join(view_dir, ".view_module")
         out = template.render(
-            system_modules=view_config["view"].get("system_modules", [])
+            system_modules=view_config["view"].get("system_modules", []),
+            depends_on=view_config["view"].get("depends_on", []),
         )
         utils.write_file(view_module_file, out)
         logger.info("Wrote updated .view_module: %s" % view_module_file)
@@ -251,9 +252,16 @@ def edit(self, name):
 
     def generate_view_config(self, name):
         """
-        Generate an empty view config. system_modules are not supported yet.
+        Generate an empty view config. system_modules/depends_on are not supported yet.
         """
-        cfg = {"view": {"name": name, "modules": [], "system_modules": []}}
+        cfg = {
+            "view": {
+                "name": name,
+                "modules": [],
+                "system_modules": [],
+                "depends_on": [],
+            }
+        }
         self.save_config(name, cfg)
 
 

shpc/main/schemas.py

@@ -193,6 +193,7 @@
 
 viewProperties = {
     "system_modules": {"type": "array", "items": {"type": "string"}},
+    "depends_on": {"type": "array", "items": {"type": "string"}},
     "modules": {"type": "array", "items": {"type": "string"}},
     "name": {"type": "string"},
 }

shpc/main/settings.py

@@ -76,14 +76,38 @@ def edit(self, settings_file=None):
         if not settings_file or not os.path.exists(settings_file):
             logger.exit("%s does not exist." % settings_file)
 
-        # Make sure editor exists first!
-        editor = utils.which(self.config_editor)
-        if editor["return_code"] != 0:
+        # Discover editor user has preferences for
+        editor = None
+
+        # First try EDITOR and VISUAL envars
+        for envar_name in ["EDITOR", "VISUAL"]:
+            envar = os.environ.get(envar_name)
+            editor = self._find_editor(envar)
+            if editor is not None:
+                break
+
+        # If we get here and no editor, try system default
+        if not editor:
+            editor = self._find_editor(self.config_editor)
+        if not editor:
             logger.exit(
-                "Editor '%s' not found! Update with shpc config set config_editor:<name>"
-                % self.config_editor
+                "No editors found! Update with shpc config set config_editor:<name>"
             )
-        utils.run_command([self.config_editor, settings_file], stream=True)
+
+        utils.run_command([editor, settings_file], stream=True)
+
+    def _find_editor(self, path):
+        """
+        Check to see that an editor exists.
+        """
+        if not path:
+            return
+
+        editor = utils.which(path)
+
+        # Only return the editor name if we find it!
+        if editor["return_code"] == 0:
+            return path
 
     def get_settings_file(self, settings_file=None):
         """

shpc/tests/test_views.py

@@ -106,31 +106,37 @@ def test_views(tmp_path, module_sys, module_file, container_tech, remote):
         os.path.join(client.settings.module_base, "ghcr.io", "autamus")
     )
 
-    # Try adding system modules
-    assert not view._config["view"]["system_modules"]
+    # Before adding any attributes, this file should not exist
     view_module = os.path.join(view.path, ".view_module")
     assert not os.path.exists(view_module)
-    view_handler.add_variable(view_name, "system_modules", "openmpi")
-    assert os.path.exists(view_module)
 
-    # Make sure we have openmpi in the content
-    content = utils.read_file(view_module)
-    assert "openmpi" in content
+    # Try adding valid attributes
+    for attribute, check_content in [
+        ["system_modules", "module"],
+        ["depends_on", "depends"],
+    ]:
+        assert not view._config["view"][attribute]
+        view_handler.add_variable(view_name, attribute, "openmpi")
+        assert os.path.exists(view_module)
 
-    # Reload the view config file
-    view.reload()
-    assert "openmpi" in view._config["view"]["system_modules"]
+        # Make sure we have openmpi in the content
+        content = utils.read_file(view_module)
+        assert "openmpi" in content and check_content in content
 
-    # We can't add unknown variables
-    with pytest.raises(SystemExit):
-        view_handler.add_variable(view_name, "system-modules", [1, 2, 3])
+        # Reload the view config file
+        view.reload()
+        assert "openmpi" in view._config["view"][attribute]
 
-    # Try removing now
-    view_handler.remove_variable(view_name, "system_modules", "openmpi")
-    view.reload()
-    assert not view._config["view"]["system_modules"]
-    content = utils.read_file(view_module)
-    assert "openmpi" not in content
+        # We can't add unknown variables
+        with pytest.raises(SystemExit):
+            view_handler.add_variable(view_name, attribute.replace("_", "-"), [1, 2, 3])
+
+        # Try removing now
+        view_handler.remove_variable(view_name, attribute, "openmpi")
+        view.reload()
+        assert not view._config["view"][attribute]
+        content = utils.read_file(view_module)
+        assert "openmpi" not in content and check_content not in content
 
     # Ensure we can uninstall
     view_handler.delete(view_name, force=True)
@@ -141,3 +147,75 @@ def test_views(tmp_path, module_sys, module_file, container_tech, remote):
     view_client.create_from_file(
         view_name, views_config, settings_file=client.settings.settings_file, force=True
     )
+
+
+@pytest.mark.parametrize(
+    "module_sys,module_file,container_tech,remote",
+    [
+        ("lmod", "module.lua", "singularity", True),
+        ("lmod", "module.lua", "podman", True),
+        ("tcl", "module.tcl", "singularity", True),
+        ("tcl", "module.tcl", "podman", True),
+        ("lmod", "module.lua", "singularity", False),
+        ("lmod", "module.lua", "podman", False),
+        ("tcl", "module.tcl", "singularity", False),
+        ("tcl", "module.tcl", "podman", False),
+    ],
+)
+def test_view_components(tmp_path, module_sys, module_file, container_tech, remote):
+    """
+    Test view components
+    """
+    client = init_client(str(tmp_path), module_sys, container_tech, remote=remote)
+
+    # Create the view handler based on the client settings file
+    view_handler = views.ViewsHandler(
+        settings_file=client.settings.settings_file, module_sys=module_sys
+    )
+
+    # A view name
+    view_name = "mpi"
+    assert view_name not in client.views
+
+    # Create the view!
+    view_handler.create(view_name)
+    client.detect_views()
+    assert view_name in client.views
+
+    # Before adding any attributes, this file should not exist
+    view = client.views[view_name]
+    view_module = os.path.join(view.path, ".view_module")
+    assert not os.path.exists(view_module)
+
+    # Try adding valid attributes
+    for attribute, check_content in [
+        ["system_modules", "module"],
+        ["depends_on", "depends"],
+    ]:
+        assert not view._config["view"][attribute]
+        view_handler.add_variable(view_name, attribute, "openmpi")
+        assert os.path.exists(view_module)
+
+        # Make sure we have openmpi in the content
+        content = utils.read_file(view_module)
+        print(content)
+        assert "openmpi" in content and check_content in content
+
+        # Reload the view config file
+        view.reload()
+        assert "openmpi" in view._config["view"][attribute]
+
+        # We can't add unknown variables
+        with pytest.raises(SystemExit):
+            view_handler.add_variable(view_name, attribute.replace("_", "-"), [1, 2, 3])
+
+        # Try removing now
+        view_handler.remove_variable(view_name, attribute, "openmpi")
+        view.reload()
+        assert not view._config["view"][attribute]
+        content = utils.read_file(view_module)
+        assert "openmpi" not in content and check_content not in content
+
+    # Ensure we can uninstall
+    view_handler.delete(view_name, force=True)
+    assert not os.path.exists(view.path)

shpc/version.py

@@ -2,7 +2,7 @@
 __copyright__ = "Copyright 2021-2022, Vanessa Sochat"
 __license__ = "MPL 2.0"
 
-__version__ = "0.1.12"
+__version__ = "0.1.13"
 AUTHOR = "Vanessa Sochat"
 EMAIL = "[email protected]"
 NAME = "singularity-hpc"