add devcontainer class to vscode package

Author: shadycuz

docker/jfr/Dockerfile

@@ -15,5 +15,3 @@ RUN rm /etc/s6-overlay/s6-rc.d/user/contents.d/jenkins
 
 COPY /docker/jfr/run_job.sh /usr/bin/run_job
 COPY docker/jfr/root /
-
-ENV JENKINS_HOME="/usr/share/jenkins/ref/"

docker/prod/Dockerfile

@@ -15,7 +15,9 @@ RUN apt-get update && \
     kmod \
     wget \
     git \
-    curl && \
+    curl \
+    build-essential \
+    python3 && \
     rm -rf /var/lib/apt/lists/*
 
 # Install and setup docker into the container

jobs/vscode/devcontainer_example.groovy

@@ -0,0 +1,48 @@
+/* groovylint-disable, DuplicateMapLiteral, DuplicateStringLiteral, UnusedVariable */
+@Library('jenkins-std-lib')
+
+import org.dsty.logging.LogClient
+import org.dsty.system.os.Path
+import org.dsty.system.os.programs.CliTool
+import org.dsty.js.node.Node
+import org.dsty.js.node.Npm
+import org.dsty.vscode.DevContainer
+import org.dsty.scm.Git
+
+LogClient log = new LogClient()
+
+node() {
+
+    log.info('To use vscode devcontainers we will first need Node and npm.')
+
+    log.info('Lets install the latest version of Node and npm.')
+
+    // Note that Node wont be downloaded and installed until we try to use it.
+    Node nodeJS = new Node()
+
+    DevContainer devcontainer = new DevContainer(nodeJS.npm)
+
+    log.info('Lets clone the rust example project https://github.com/microsoft/vscode-remote-try-rust')
+
+    Git git = new Git(this)
+
+    git.checkout(
+        changelog: false,
+        poll: false,
+        scm: [
+            $class: 'GitSCM',
+            branches: [[name: 'main']],
+            extensions: [],
+            userRemoteConfigs: [[url: 'https://github.com/microsoft/vscode-remote-try-rust.git']]
+        ]
+    )
+
+    log.info('Now we can start the devcontainer and run a command inside it.')
+
+    devcontainer.withContainer {
+        devcontainer.exec("cargo run")
+    }
+
+    // The devcontainer will be stopped but not removed.
+
+}

src/org/dsty/system/os/programs/ExecutableBuilder.groovy

@@ -27,7 +27,7 @@ class ExecutableBuilder {
     static Executable buildExecutable(Path filePath) throws NoSuchFileException {
 
         if (!filePath.exists()) {
-            throw new NoSuchFileException(filePath.absolutize())
+            throw new NoSuchFileException(filePath.absolutize().toString())
         }
 
         final System os = Platform.system()

src/org/dsty/vscode/DevContainer.groovy

@@ -0,0 +1,177 @@
+package org.dsty.vscode
+
+import org.dsty.jenkins.Build
+import org.dsty.logging.LogClient
+import org.dsty.system.os.Path
+import org.dsty.system.os.programs.CliTool
+import org.dsty.system.os.programs.ToolBuilder
+import org.dsty.system.os.shell.Bash
+import org.dsty.system.os.shell.Result
+import org.dsty.system.os.shell.ExecutionException
+import org.dsty.js.node.Npm
+
+import com.cloudbees.groovy.cps.NonCPS
+
+import java.util.regex.Matcher
+
+/**
+ * Installs and runs the vscode <a href="https://github.com/devcontainers/cli"target="_blank">
+ * <strong>devcontainer</strong></a> CLI.
+ * <p>
+ * The devcontainer tool can be used to create and manage devcontainers created from a
+ * <strong>devcontainer.json</strong>.
+ * <pre>{@code
+ * import org.dsty.vscode.DevContainer
+ *node() {
+ *  DevContainer devcontainer = new DevContainer()
+ *  devcontainer.withContainer {
+ *    devcontainer.exec('echo "Hello from inside DevContainer"')
+ *  &#125;
+ *&#125;}</pre>
+ */
+class DevContainer implements Serializable {
+
+    /**
+     * Logging client
+     */
+    private final LogClient log
+
+    private CliTool devContainer
+
+    private Npm npm
+
+    private String workspace
+
+    private Bash bash
+
+    DevContainer(Npm npm) {
+        this.npm = npm
+        this.log = new LogClient()
+        this.bash = new Bash()
+    }
+
+    private Npm getDevContainer() {
+
+        if (!this.@devContainer) {
+
+            this.npm.installGlobal('@devcontainers/cli')
+
+            String prefix = this.npm.call('get prefix').stdOut.trim()
+            Path devContainerPath = new Path(prefix).child('bin/devcontainer')
+
+            this.devContainer = ToolBuilder.buildTool(devContainerPath)
+
+        }
+
+        return this.@devContainer
+    }
+
+    private String getWorkspace() {
+
+        return Path.cwd()
+    }
+
+    /**
+     * Run a command using the <strong>devcontainer</strong></a> executable.
+     *
+     * @param args The arguments passed directly to <strong>devcontainer</strong>.
+     * @return The result from the command.
+     */
+    Result call(String args = '') throws ExecutionException {
+
+        return this.run(args)
+    }
+
+    /**
+     * Calls the devcontainer CLI's <strong>up</strong> command to start the devcontainer
+     * in <strong>devcontainer.json</strong>.
+     * <p>
+     * This command will not stop the container for you. If you want to have the container
+     * stopped automaticly see {@link #withContainer()}.
+     *
+     * @param workspace A path to a directory from where all commands will be executed.
+     *                  If a path is not specified the current directory is used.
+     * @return The result from the command.
+     */
+    Result up(Path workspace = null) {
+
+        if (workspace == null) {
+            workspace = this.workspace
+        }
+
+        this.run("up --workspace-folder ${workspace}")
+    }
+
+    /**
+     * Calls the devcontainer CLI's <strong>exec</strong> command to run a command inside the devcontainer.
+     *
+     * @param cmd The command to run inside the container.
+     * @param workspace A path to a directory from where all commands will be executed.
+     *                  If a path is not specified the current directory is used.
+     * @return The result from the command.
+     */
+    Result exec(String cmd, Path workspace = null) {
+
+        if (workspace == null) {
+            workspace = this.workspace
+        }
+
+        this.run("exec --workspace-folder ${workspace} ${cmd}")
+    }
+
+    /**
+     * Bring up a devcontainer, runs the user supplied code and then stops the container.
+     * <p>
+     * Similar to {@link #up()}, but stops the container automaticlly.
+     *
+     * @param workspace A path to a directory from where all commands will be executed.
+     *                  If a path is not specified the current directory is used.
+     * @param userCode The code to be ran after the devcontainer has been started.
+     */
+    void withContainer(String workspace = null, Closure userCode) {
+
+        String output = this.up(workspace)
+
+        String containerId = this.parseContainerId(output)
+
+        log.debug("Started devcontainer ${containerId}")
+
+        try {
+            userCode()
+        } finally {
+            this.bash.silent("docker stop ${containerId}")
+        }
+
+    }
+
+    /**
+     * Run a command using the <strong>devcontainer</strong> executable using the supplied arugments.
+     *
+     * @param args The arguments passed directly to <strong>devcontainer</strong> executable.
+     * @return The {@link Result} from the command execution.
+     */
+    private Result run(final String args) throws ExecutionException {
+
+        return this.devContainer.runCommand(args)
+
+    }
+
+    /**
+     * Parse the Docker container id from the output of devcontainer up.
+     * @param input to search for container id.
+     * @returns the container id if found.
+     */
+    @NonCPS
+    private String parseContainerId(String input) {
+
+        Matcher matcher = input =~ /(?:\"containerId\")(?:\:\")(\w*)(?:\")/
+
+        if (!matcher.find()) {
+            throw new Exception("Unable to find a container ID in ${input}")
+        }
+
+        String containerID = matcher[0][1]
+
+        return containerID
+    }
+}

src/org/dsty/vscode/package-info.groovy

@@ -0,0 +1,4 @@
+/**
+ * This package provides tools to work with vscode.
+ */
+package org.dsty.vscode

tests/conftest.py

@@ -82,7 +82,7 @@ def run_test(job_path: str) -> str:
 
         cmd = f"run_job {job_path}"
 
-        exitcode, raw_output = container.exec_run(cmd)
+        exitcode, raw_output = container.exec_run(cmd, user="jenkins")
 
         output = raw_output.decode("utf-8")
 

tests/test_vscode/test_devcontainer.py

@@ -0,0 +1,13 @@
+import pytest
+
+from tests.conftest import Container
+
+
+@pytest.fixture()
+def job_folder():
+    return "vscode"
+
+
+def test_devcontainer_example(container: Container, job_folder):
+
+    _ = container(f"{job_folder}/devcontainer_example.groovy")