feat(scripts): add support for Lua Scripts and Commands tasks (#262)

Author: Malaydewangan09

plugin-script-lua/build.gradle

@@ -0,0 +1,19 @@
+project.description = 'Execute Lua scripts as part of Kestra data workflows.'
+
+jar {
+    manifest {
+        attributes(
+            "X-Kestra-Name": project.name,
+            "X-Kestra-Title": "Lua",
+            "X-Kestra-Group": project.group + ".scripts.lua",
+            "X-Kestra-Description": project.description,
+            "X-Kestra-Version": project.version
+        )
+    }
+}
+
+dependencies {
+    implementation project(':plugin-script')
+
+    testImplementation project(':plugin-script').sourceSets.test.output
+}

plugin-script-lua/src/main/java/io/kestra/plugin/scripts/lua/Commands.java

@@ -0,0 +1,57 @@
+package io.kestra.plugin.scripts.lua;
+
+import io.kestra.core.models.annotations.Example;
+import io.kestra.core.models.annotations.Plugin;
+import io.kestra.core.models.property.Property;
+import io.kestra.core.models.tasks.runners.TargetOS;
+import io.kestra.core.runners.RunContext;
+import io.kestra.plugin.scripts.exec.AbstractExecScript;
+import io.kestra.plugin.scripts.exec.scripts.models.ScriptOutput;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.*;
+import lombok.experimental.SuperBuilder;
+import java.util.List;
+
+@SuperBuilder
+@ToString
+@EqualsAndHashCode
+@Getter
+@NoArgsConstructor
+@Schema(title = "Execute Lua commands from the CLI.")
+@Plugin(examples = {
+    @Example(
+        full = true,
+        title = "Execute one or multiple Lua commands.",
+        code = """
+            id: lua_commands
+            namespace: company.team
+            tasks:
+              - id: lua
+                type: io.kestra.plugin.scripts.lua.Commands
+                commands:
+                  - lua -e 'print("Hello from kestra!")'
+            """
+    )
+})
+public class Commands extends AbstractExecScript {
+    private static final String DEFAULT_IMAGE = "nickblah/lua";
+
+    @Builder.Default
+    protected Property<String> containerImage = Property.ofValue(DEFAULT_IMAGE);
+
+    @Schema(title = "The commands to run.")
+    protected Property<List<String>> commands;
+
+    @Override
+    public ScriptOutput run(RunContext runContext) throws Exception {
+        TargetOS os = runContext.render(this.targetOS).as(TargetOS.class).orElse(null);
+
+        return this.commands(runContext)
+            .withInterpreter(this.interpreter)
+            .withBeforeCommands(beforeCommands)
+            .withBeforeCommandsWithOptions(true)
+            .withCommands(commands)
+            .withTargetOS(os)
+            .run();
+    }
+}

plugin-script-lua/src/main/java/io/kestra/plugin/scripts/lua/Script.java

@@ -0,0 +1,88 @@
+package io.kestra.plugin.scripts.lua;
+
+import io.kestra.core.exceptions.IllegalVariableEvaluationException;
+import io.kestra.core.models.annotations.Example;
+import io.kestra.core.models.annotations.Plugin;
+import io.kestra.core.models.property.Property;
+import io.kestra.core.models.tasks.runners.TargetOS;
+import io.kestra.core.runners.FilesService;
+import io.kestra.core.runners.RunContext;
+import io.kestra.plugin.scripts.exec.AbstractExecScript;
+import io.kestra.plugin.scripts.exec.scripts.models.DockerOptions;
+import io.kestra.plugin.scripts.exec.scripts.models.ScriptOutput;
+import io.kestra.plugin.scripts.exec.scripts.runners.CommandsWrapper;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotNull;
+import lombok.*;
+import lombok.experimental.SuperBuilder;
+
+import java.nio.file.Path;
+import java.util.List;
+import java.util.Map;
+
+@SuperBuilder
+@ToString
+@EqualsAndHashCode
+@Getter
+@NoArgsConstructor
+@Schema(title = "Execute a Lua script.")
+@Plugin(examples = {
+    @Example(
+        title = "Run a simple inline Lua script.",
+        full = true,
+        code = """
+            id: lua_inline
+            namespace: company.team
+            tasks:
+              - id: lua_script
+                type: io.kestra.plugin.scripts.lua.Script
+                script: |
+                  local message = "Hello from Kestra!"
+                  print(message)
+            """
+    ),
+})
+public class Script extends AbstractExecScript {
+    private static final String DEFAULT_IMAGE = "nickblah/lua";
+
+    @Builder.Default
+    protected Property<String> containerImage = Property.ofValue(DEFAULT_IMAGE);
+
+    @Schema(title = "The inline script content.")
+    @NotNull
+    protected Property<String> script;
+
+    @Override
+    protected DockerOptions injectDefaults(RunContext runContext, DockerOptions original) throws IllegalVariableEvaluationException {
+        var builder = original.toBuilder();
+        if (original.getImage() == null) {
+            builder.image(runContext.render(this.getContainerImage()).as(String.class).orElse(null));
+        }
+        return builder.build();
+    }
+
+    @Override
+    public ScriptOutput run(RunContext runContext) throws Exception {
+        CommandsWrapper commands = this.commands(runContext);
+
+        Map<String, String> inputFiles = FilesService.inputFiles(runContext, commands.getTaskRunner().additionalVars(runContext, commands), this.getInputFiles());
+        Path relativeScriptPath = runContext.workingDir().path().relativize(runContext.workingDir().createTempFile(".lua"));
+        inputFiles.put(
+            relativeScriptPath.toString(),
+            commands.render(runContext, this.script)
+        );
+        commands = commands.withInputFiles(inputFiles);
+
+        TargetOS os = runContext.render(this.targetOS).as(TargetOS.class).orElse(null);
+
+        return commands
+            .withInterpreter(this.interpreter)
+            .withBeforeCommands(beforeCommands)
+            .withBeforeCommandsWithOptions(true)
+            .withCommands(Property.ofValue(List.of(
+                String.join(" ", "lua", commands.getTaskRunner().toAbsolutePath(runContext, commands, relativeScriptPath.toString(), os))
+            )))
+            .withTargetOS(os)
+            .run();
+    }
+}

plugin-script-lua/src/main/java/io/kestra/plugin/scripts/lua/package-info.java

@@ -0,0 +1,7 @@
+@PluginSubGroup(
+    description = "This sub-group of plugins contains tasks for running Lua script.",
+    categories = { PluginSubGroup.PluginCategory.SCRIPT }
+)
+package io.kestra.plugin.scripts.lua;
+
+import io.kestra.core.models.annotations.PluginSubGroup;

plugin-script-lua/src/main/resources/icons/io.kestra.plugin.scripts.lua.Commands.svg

@@ -0,0 +1,60 @@
+package io.kestra.plugins.scripts.lua;
+
+import com.google.common.collect.ImmutableMap;
+import io.kestra.core.junit.annotations.KestraTest;
+import io.kestra.core.models.executions.LogEntry;
+import io.kestra.core.models.property.Property;
+import io.kestra.core.queues.QueueFactoryInterface;
+import io.kestra.core.queues.QueueInterface;
+import io.kestra.core.runners.RunContext;
+import io.kestra.core.runners.RunContextFactory;
+import io.kestra.core.utils.IdUtils;
+import io.kestra.core.utils.TestsUtils;
+import io.kestra.plugin.scripts.exec.scripts.models.ScriptOutput;
+import io.kestra.plugin.scripts.lua.Commands;
+import jakarta.inject.Inject;
+import jakarta.inject.Named;
+import org.junit.jupiter.api.Test;
+import reactor.core.publisher.Flux;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+
+@KestraTest
+public class CommandsTest {
+    @Inject
+    RunContextFactory runContextFactory;
+
+    @Inject
+    @Named(QueueFactoryInterface.WORKERTASKLOG_NAMED)
+    private QueueInterface<LogEntry> logQueue;
+
+    @Test
+    void task() throws Exception {
+        List<LogEntry> logs = new ArrayList<>();
+        Flux<LogEntry> receive = TestsUtils.receive(logQueue, l -> logs.add(l.getLeft()));
+
+        Commands luaCommands = Commands.builder()
+            .id(IdUtils.create())
+            .type(Commands.class.getName())
+            .commands(Property.ofValue(List.of("lua main.lua")))
+            .inputFiles(Map.of(
+                "main.lua", "print(\"Hello from kestra!\");"
+            ))
+            .build();
+
+        RunContext runContext = TestsUtils.mockRunContext(runContextFactory, luaCommands, ImmutableMap.of());
+        ScriptOutput run = luaCommands.run(runContext);
+
+        assertThat(run.getExitCode(), is(0));
+
+        String expectedLog = "Hello from kestra!";
+        TestsUtils.awaitLog(logs, log -> log.getMessage() != null && log.getMessage().contains(expectedLog));
+        receive.blockLast();
+        assertThat(logs.stream().anyMatch(log -> log.getMessage() != null && log.getMessage().contains(expectedLog)), is(true));
+    }
+}

plugin-script-lua/src/main/resources/icons/io.kestra.plugin.scripts.lua.Script.svg

@@ -0,0 +1,21 @@
+package io.kestra.plugins.scripts.lua;
+
+import io.kestra.core.junit.annotations.ExecuteFlow;
+import io.kestra.core.junit.annotations.KestraTest;
+import io.kestra.core.models.executions.Execution;
+import io.kestra.core.models.flows.State;
+import org.junit.jupiter.api.Test;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.hasSize;
+import static org.hamcrest.Matchers.is;
+
+@KestraTest(startRunner = true)
+class RunnerTest {
+    @Test
+    @ExecuteFlow("sanity-checks/all_lua.yaml")
+    void all_lua(Execution execution) {
+        assertThat(execution.getTaskRunList(), hasSize(2));
+        assertThat(execution.getState().getCurrent(), is(State.Type.SUCCESS));
+    }
+}