Syntax for conditionally loading toolbox items.

galaxyproject · Apr 16, 2024 · eb036e7 · eb036e7
1 parent 6f3e515
commit eb036e7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/lib/galaxy/tool_util/toolbox/base.py b/lib/galaxy/tool_util/toolbox/base.py
@@ -408,6 +408,12 @@ def load_item(
                 panel_dict = self._tool_panel
             if integrated_panel_dict is None:
                 integrated_panel_dict = self._integrated_tool_panel
+            load_if = item.get("if")
+            if load_if == "interactivetools_enable":
+                if not self.app.config.interactivetools_enable:
+                    raise ValueError("Trying to load an InteractiveTool, but InteractiveTools are not enabled.")
+            elif load_if:
+                raise ValueError(f"Unknown conditional tool load condition '{load_if}'")
             if item_type == "tool":
                 self._load_tool_tag_set(
                     item,

diff --git a/test/functional/tools/sample_tool_conf.xml b/test/functional/tools/sample_tool_conf.xml
@@ -237,8 +237,8 @@
   <tool file="multiple_versions_changes_v01.xml" />
   <tool file="multiple_versions_changes_v02.xml" />
 
-  <tool file="interactivetool_simple.xml" />
-  <tool file="interactivetool_two_entry_points.xml" />
+  <tool file="interactivetool_simple.xml" if="interactivetools_enable" />
+  <tool file="interactivetool_two_entry_points.xml" if="interactivetools_enable" />
   <tool file="converter_target_datatype.xml" />
 
   <!-- Tools interesting only for building up test workflows. -->