Using a script in a script

It is possible to use another script in an installed script. It allows to have more modular code in your scripts.

Usage

There are four methods to get another script in a script. These metrghods are all accessible through the ScriptContext:

• The ScriptContext.createScript(File) creates the script with its associated script file, using the default configuration for the ScriptHelper configuration
• The ScriptContext.createScript(String) creates the script with the relative or absolute path of its file relative to the calling script, using the default configuration for the ScriptHelper configuration
• The ScriptContext.createScript(File, boolean) creates the script with its associated script file, specifying if the ScriptContext, ScriptHelper, and ScriptLogger are available in the created script
• The ScriptContext.createScript(String, boolean) creates the script with the relative or absolute path of its file relative to the calling script, specifying if the ScriptContext, ScriptHelper, and ScriptLogger are available in the created script

Usage using the help, helper and logger

If the ScriptContext, ScriptHelper, and ScriptLogger are available in the created script, they will be usable through the context, helper, and logger variables in the additional script.

Example

Example with context and help not available

Suppose the script interface:

   public interface Script {
     public String execute();
   }

And our Groovy script file:

   public String execute() {
      var other = context.createScript("otherScript.groovy");
      return other.compute();
   }

The otherScript.groovy script is:

   public String compute() {
      return "toto";
   }

We can do:

   ScriptWrapper<Script> wrapper = new GroovyScriptWrapper<Script>(){
   };
   Script script = wrapper.getScript();

   File file = new File(<our script file>);
   wrapper.installScript(file);

   String value = script.execute();

Example with context and help available

Suppose the script interface:

   public interface Script {
     public String execute();
   }

And our Groovy script file:

   public String execute() {
      var other = context.createScript("otherScript.groovy");
      return other.compute();
   }

The otherScript.groovy script is:

   public String compute() {
      context.echo("I am working hard!"); // we use context because it will be availble in our additional script
      return "toto";
   }

We can do:

   ScriptHelperConfig.useContextInAdditionalScripts(true); // make context, helper and logger available in additional scripts
   ScriptWrapper<Script> wrapper = new GroovyScriptWrapper<Script>(){
   };
   Script script = wrapper.getScript();

   File file = new File(<our script file>);
   wrapper.installScript(file);

   String value = script.execute();

Limitations

The following table presents the limitations of this functionality depending on the scripting language:

Supported syntaxes

Language	Supported	Limitations
Groovy	Yes	-
Ruby	Yes	-
Python	Yes	Navigation in StackTrace when using context not supported
Javascript	No	-