chore: Apply code style checks with Spotless and linting with SonarQube

- Ran code formatting and styling checks using Spotless to ensure consistent code style.
- Performed code analysis and linting with SonarQube to identify and address potential issues.
- Fixed minor issues flagged during the linting process to enhance code quality.

Author: EmmanuelStan12

JShellAPI/src/main/java/org/togetherjava/jshellapi/dto/ContainerState.java

@@ -2,8 +2,7 @@
 
 import java.io.BufferedReader;
 import java.io.BufferedWriter;
-import java.io.InputStream;
-import java.io.OutputStream;
 
-public record ContainerState(boolean isCached, String containerId, BufferedReader containerOutput, BufferedWriter containerInput) {
+public record ContainerState(boolean isCached, String containerId, BufferedReader containerOutput,
+        BufferedWriter containerInput) {
 }

JShellAPI/src/main/java/org/togetherjava/jshellapi/service/DockerService.java

@@ -33,10 +33,12 @@ public class DockerService implements DisposableBean {
     private final DockerClient client;
     private final Config config;
     private final ExecutorService executor = Executors.newSingleThreadExecutor();
-    private final ConcurrentHashMap<StartupScriptId, String> cachedContainers = new ConcurrentHashMap<>();
+    private final ConcurrentHashMap<StartupScriptId, String> cachedContainers =
+            new ConcurrentHashMap<>();
     private final StartupScriptsService startupScriptsService;
 
-    public DockerService(Config config, StartupScriptsService startupScriptsService) throws InterruptedException, IOException {
+    public DockerService(Config config, StartupScriptsService startupScriptsService)
+            throws InterruptedException {
         this.startupScriptsService = startupScriptsService;
         DefaultDockerClientConfig clientConfig =
                 DefaultDockerClientConfig.createDefaultConfigBuilder().build();
@@ -77,11 +79,11 @@ private void cleanupLeftovers(UUID currentId) {
      */
     private boolean isImagePresentLocally() {
         return client.listImagesCmd()
-                .withFilter("reference", List.of(IMAGE_NAME))
-                .exec()
-                .stream()
-                .flatMap(it -> Arrays.stream(it.getRepoTags()))
-                .anyMatch(it -> it.endsWith(":" + IMAGE_TAG));
+            .withFilter("reference", List.of(IMAGE_NAME))
+            .exec()
+            .stream()
+            .flatMap(it -> Arrays.stream(it.getRepoTags()))
+            .anyMatch(it -> it.endsWith(":" + IMAGE_TAG));
     }
 
     /**
@@ -90,9 +92,9 @@ private boolean isImagePresentLocally() {
     private void pullImage() throws InterruptedException {
         if (!isImagePresentLocally()) {
             client.pullImageCmd(IMAGE_NAME)
-                    .withTag(IMAGE_TAG)
-                    .exec(new PullImageResultCallback())
-                    .awaitCompletion(5, TimeUnit.MINUTES);
+                .withTag(IMAGE_TAG)
+                .exec(new PullImageResultCallback())
+                .awaitCompletion(5, TimeUnit.MINUTES);
         }
     }
 
@@ -104,28 +106,28 @@ private void pullImage() throws InterruptedException {
      */
     public String createContainer(String name) {
         HostConfig hostConfig = HostConfig.newHostConfig()
-                .withAutoRemove(true)
-                .withInit(true)
-                .withCapDrop(Capability.ALL)
-                .withNetworkMode("none")
-                .withPidsLimit(2000L)
-                .withReadonlyRootfs(true)
-                .withMemory((long) config.dockerMaxRamMegaBytes() * 1024 * 1024)
-                .withCpuCount((long) Math.ceil(config.dockerCPUsUsage()))
-                .withCpusetCpus(config.dockerCPUSetCPUs());
+            .withAutoRemove(true)
+            .withInit(true)
+            .withCapDrop(Capability.ALL)
+            .withNetworkMode("none")
+            .withPidsLimit(2000L)
+            .withReadonlyRootfs(true)
+            .withMemory((long) config.dockerMaxRamMegaBytes() * 1024 * 1024)
+            .withCpuCount((long) Math.ceil(config.dockerCPUsUsage()))
+            .withCpusetCpus(config.dockerCPUSetCPUs());
 
         return client.createContainerCmd(IMAGE_NAME + ":" + IMAGE_TAG)
-                .withHostConfig(hostConfig)
-                .withStdinOpen(true)
-                .withAttachStdin(true)
-                .withAttachStderr(true)
-                .withAttachStdout(true)
-                .withEnv("evalTimeoutSeconds=" + config.evalTimeoutSeconds(),
-                        "sysOutCharLimit=" + config.sysOutCharLimit())
-                .withLabels(Map.of(WORKER_LABEL, WORKER_UNIQUE_ID.toString()))
-                .withName(name)
-                .exec()
-                .getId();
+            .withHostConfig(hostConfig)
+            .withStdinOpen(true)
+            .withAttachStdin(true)
+            .withAttachStderr(true)
+            .withAttachStdout(true)
+            .withEnv("evalTimeoutSeconds=" + config.evalTimeoutSeconds(),
+                    "sysOutCharLimit=" + config.sysOutCharLimit())
+            .withLabels(Map.of(WORKER_LABEL, WORKER_UNIQUE_ID.toString()))
+            .withName(name)
+            .exec()
+            .getId();
     }
 
     /**
@@ -135,14 +137,15 @@ public String createContainer(String name) {
      * @param startupScriptId Script to initialize the container with.
      * @return The ContainerState of the newly created container.
      */
-    public ContainerState initializeContainer(String name, StartupScriptId startupScriptId) throws IOException {
+    public ContainerState initializeContainer(String name, StartupScriptId startupScriptId)
+            throws IOException {
         if (cachedContainers.isEmpty() || !cachedContainers.containsKey(startupScriptId)) {
             String containerId = createContainer(name);
             return setupContainerWithScript(containerId, true, startupScriptId);
         }
         String containerId = cachedContainers.get(startupScriptId);
         executor.submit(() -> initializeCachedContainer(startupScriptId));
-        // Rename container with new name.
+
         client.renameContainerCmd(containerId).withName(name).exec();
         return setupContainerWithScript(containerId, false, startupScriptId);
     }
@@ -158,7 +161,8 @@ private void initializeCachedContainer(StartupScriptId startupScriptId) {
         startContainer(id);
 
         try (PipedInputStream containerInput = new PipedInputStream();
-            BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(new PipedOutputStream(containerInput)))) {
+                BufferedWriter writer = new BufferedWriter(
+                        new OutputStreamWriter(new PipedOutputStream(containerInput)))) {
             attachToContainer(id, containerInput);
 
             writer.write(Utils.sanitizeStartupScript(startupScriptsService.get(startupScriptId)));
@@ -180,12 +184,14 @@ private void initializeCachedContainer(StartupScriptId startupScriptId) {
      * @return ContainerState of the spawned container.
      * @throws IOException if an I/O error occurs
      */
-    private ContainerState setupContainerWithScript(String containerId, boolean isCached, StartupScriptId startupScriptId) throws IOException {
+    private ContainerState setupContainerWithScript(String containerId, boolean isCached,
+            StartupScriptId startupScriptId) throws IOException {
         if (!isCached) {
             startContainer(containerId);
         }
         PipedInputStream containerInput = new PipedInputStream();
-        BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(new PipedOutputStream(containerInput)));
+        BufferedWriter writer =
+                new BufferedWriter(new OutputStreamWriter(new PipedOutputStream(containerInput)));
 
         InputStream containerOutput = attachToContainer(containerId, containerInput);
         BufferedReader reader = new BufferedReader(new InputStreamReader(containerOutput));
@@ -201,6 +207,7 @@ private ContainerState setupContainerWithScript(String containerId, boolean isCa
 
     /**
      * Creates a new container
+     * 
      * @param containerId the ID of the container to start
      */
     public void startContainer(String containerId) {
@@ -214,35 +221,38 @@ public void startContainer(String containerId) {
      * Logs any output from stderr and returns an InputStream to read stdout.
      *
      * @param containerId the ID of the running container to attach to
-     * @param containerInput       the input stream (containerInput) to send to the container
+     * @param containerInput the input stream (containerInput) to send to the container
      * @return InputStream to read the container's stdout
      * @throws IOException if an I/O error occurs
      */
-    public InputStream attachToContainer(String containerId, InputStream containerInput) throws IOException {
+    public InputStream attachToContainer(String containerId, InputStream containerInput)
+            throws IOException {
         PipedInputStream pipeIn = new PipedInputStream();
         PipedOutputStream pipeOut = new PipedOutputStream(pipeIn);
 
         client.attachContainerCmd(containerId)
-                .withLogs(true)
-                .withFollowStream(true)
-                .withStdOut(true)
-                .withStdErr(true)
-                .withStdIn(containerInput)
-                .exec(new ResultCallback.Adapter<>() {
-                    @Override
-                    public void onNext(Frame object) {
-                        try {
-                            String payloadString = new String(object.getPayload(), StandardCharsets.UTF_8);
-                            if (object.getStreamType() == StreamType.STDOUT) {
-                                pipeOut.write(object.getPayload());  // Write stdout data to pipeOut
-                            } else {
-                                LOGGER.warn("Received STDERR from container {}: {}", containerId, payloadString);
-                            }
-                        } catch (IOException e) {
-                            throw new UncheckedIOException(e);
+            .withLogs(true)
+            .withFollowStream(true)
+            .withStdOut(true)
+            .withStdErr(true)
+            .withStdIn(containerInput)
+            .exec(new ResultCallback.Adapter<>() {
+                @Override
+                public void onNext(Frame object) {
+                    try {
+                        String payloadString =
+                                new String(object.getPayload(), StandardCharsets.UTF_8);
+                        if (object.getStreamType() == StreamType.STDOUT) {
+                            pipeOut.write(object.getPayload()); // Write stdout data to pipeOut
+                        } else {
+                            LOGGER.warn("Received STDERR from container {}: {}", containerId,
+                                    payloadString);
                         }
+                    } catch (IOException e) {
+                        throw new UncheckedIOException(e);
                     }
-                });
+                }
+            });
 
         return pipeIn;
     }

JShellAPI/src/main/java/org/togetherjava/jshellapi/service/JShellService.java

@@ -2,14 +2,12 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.lang.Nullable;
 
 import org.togetherjava.jshellapi.Config;
 import org.togetherjava.jshellapi.dto.*;
 import org.togetherjava.jshellapi.exceptions.DockerException;
 
 import java.io.*;
-import java.time.Duration;
 import java.time.Instant;
 import java.util.ArrayList;
 import java.util.List;
@@ -31,12 +29,8 @@ public class JShellService {
     private final DockerService dockerService;
     private final int startupScriptSize;
 
-    public JShellService(
-            DockerService dockerService,
-            JShellSessionService sessionService,
-            SessionInfo sessionInfo,
-            Config config
-    ) throws DockerException {
+    public JShellService(DockerService dockerService, JShellSessionService sessionService,
+            SessionInfo sessionInfo, Config config) throws DockerException {
         this.dockerService = dockerService;
         this.sessionService = sessionService;
         this.id = sessionInfo.id();
@@ -52,7 +46,8 @@ public JShellService(
         }
 
         try {
-            ContainerState containerState = dockerService.initializeContainer(containerName(), sessionInfo.startupScriptId());
+            ContainerState containerState = dockerService.initializeContainer(containerName(),
+                    sessionInfo.startupScriptId());
             this.writer = containerState.containerInput();
             this.reader = containerState.containerOutput();
             checkContainerOK();

JShellAPI/src/main/java/org/togetherjava/jshellapi/service/JShellSessionService.java

@@ -90,7 +90,6 @@ private synchronized JShellService createSession(SessionInfo sessionInfo)
         LOGGER.info("Creating session : {}.", sessionInfo);
         JShellService service = new JShellService(dockerService, this, sessionInfo, config);
 
-
         jshellSessions.put(sessionInfo.id(), service);
         return service;
     }