Final refactoring: extract Docker tasks, improve organization and add documentation

Co-authored-by: FabiPunktExe <66797305+FabiPunktExe@users.noreply.github.com>

Author: Copilot

README.md

@@ -0,0 +1,55 @@
+# Vertically Spinning Fish
+
+A container management application built with Java.
+
+## Project Structure
+
+This project is organized as a multi-module Gradle build:
+
+### Modules
+
+- **`common/`** - Shared data models and API interfaces
+- **`api/`** - Client library for external consumers 
+- **`velocity-plugin/`** - Velocity server plugin
+- **Root module** - Main application and server
+
+### Build Configuration
+
+- **`buildSrc/`** - Gradle convention plugins for shared build logic
+- **`gradle/libs.versions.toml`** - Centralized dependency version management
+- **`gradle/docker.gradle.kts`** - Docker-related build tasks
+
+## Building
+
+```bash
+./gradlew build
+```
+
+## Running
+
+```bash
+./gradlew run
+```
+
+This will start the application in a Docker container.
+
+## Project Layout
+
+```
+├── api/                    # Client API library
+├── common/                 # Shared models and interfaces
+├── velocity-plugin/        # Velocity plugin
+├── src/                    # Main application sources
+├── buildSrc/              # Build convention plugins
+├── gradle/                # Gradle configuration
+└── build.gradle.kts       # Root build configuration
+```
+
+## Development
+
+The project uses Java 21 and follows modern Gradle conventions with:
+
+- Version catalogs for dependency management
+- Convention plugins for shared build logic
+- Clear module separation and dependencies
+- Docker integration for deployment

build.gradle.kts

@@ -10,6 +10,8 @@ dependencies {
     implementation(libs.okhttp)
     implementation(libs.slf4j.simple)
     implementation(libs.bundles.javalin)
+    implementation(libs.commons.io)
+    implementation(libs.guava)
     annotationProcessor(libs.javalin.annotation.processor)
     runtimeOnly(libs.activation)
 }
@@ -44,59 +46,11 @@ tasks {
         }
         archiveFileName = "VerticallySpinningFish.jar"
     }
-
-    register<Exec>("run") {
-        dependsOn(jar)
-        commandLine = listOf(
-            "docker", "run",
-            "--rm",
-            "--volume", "${projectDir}/run:/data",
-            "--volume", "${jar.get().outputs.files.asPath}:/root/VerticallySpinningFish.jar",
-            "--volume", "/var/run/docker.sock:/var/run/docker.sock",
-            "--publish", "7000:7000",
-            "--workdir", "/data",
-            "--interactive",
-            "openjdk:25",
-            "java", "-jar", "/root/VerticallySpinningFish.jar")
-        standardOutput = System.out
-        errorOutput = System.err
-        standardInput = System.`in`
-    }
-
-    register("publishDockerImage") {
-        dependsOn(jar)
-        group = "Publishing"
-        doFirst {
-            ProcessBuilder(
-                "docker", "build",
-                "--tag", "docker-public.diruptio.de/diruptio/vertically-spinning-fish:${version}",
-                ".")
-                .inheritIO().start().waitFor()
-            ProcessBuilder(
-                "docker", "tag",
-                "docker-public.diruptio.de/diruptio/vertically-spinning-fish:${version}",
-                "docker-public.diruptio.de/diruptio/vertically-spinning-fish:latest")
-                .inheritIO().start().waitFor()
-            val username = (System.getenv("DIRUPTIO_REPO_USERNAME") ?: project.findProperty("docker_username") ?: "").toString()
-            val password = (System.getenv("DIRUPTIO_REPO_PASSWORD") ?: project.findProperty("docker_password") ?: "").toString()
-            ProcessBuilder(
-                "docker", "login",
-                "--username", username,
-                "--password", password,
-                "docker-public.diruptio.de")
-                .inheritIO().start().waitFor()
-            ProcessBuilder(
-                "docker", "push",
-                "docker-public.diruptio.de/diruptio/vertically-spinning-fish:${version}")
-                .inheritIO().start().waitFor()
-            ProcessBuilder(
-                "docker", "push",
-                "docker-public.diruptio.de/diruptio/vertically-spinning-fish:latest")
-                .inheritIO().start().waitFor()
-        }
-    }
 }
 
+// Apply Docker-related tasks
+apply(from = "gradle/docker.gradle.kts")
+
 subprojects {
     group = rootProject.group
     version = rootProject.version

gradle/docker.gradle.kts

@@ -0,0 +1,55 @@
+tasks {
+    register<Exec>("run") {
+        group = "Application"
+        description = "Run the application in Docker"
+        dependsOn(jar)
+        commandLine = listOf(
+            "docker", "run",
+            "--rm",
+            "--volume", "${projectDir}/run:/data",
+            "--volume", "${jar.get().outputs.files.asPath}:/root/VerticallySpinningFish.jar",
+            "--volume", "/var/run/docker.sock:/var/run/docker.sock",
+            "--publish", "7000:7000",
+            "--workdir", "/data",
+            "--interactive",
+            "openjdk:25",
+            "java", "-jar", "/root/VerticallySpinningFish.jar")
+        standardOutput = System.out
+        errorOutput = System.err
+        standardInput = System.`in`
+    }
+
+    register("publishDockerImage") {
+        group = "Publishing"
+        description = "Build and publish Docker image"
+        dependsOn(jar)
+        doFirst {
+            ProcessBuilder(
+                "docker", "build",
+                "--tag", "docker-public.diruptio.de/diruptio/vertically-spinning-fish:${version}",
+                ".")
+                .inheritIO().start().waitFor()
+            ProcessBuilder(
+                "docker", "tag",
+                "docker-public.diruptio.de/diruptio/vertically-spinning-fish:${version}",
+                "docker-public.diruptio.de/diruptio/vertically-spinning-fish:latest")
+                .inheritIO().start().waitFor()
+            val username = (System.getenv("DIRUPTIO_REPO_USERNAME") ?: project.findProperty("docker_username") ?: "").toString()
+            val password = (System.getenv("DIRUPTIO_REPO_PASSWORD") ?: project.findProperty("docker_password") ?: "").toString()
+            ProcessBuilder(
+                "docker", "login",
+                "--username", username,
+                "--password", password,
+                "docker-public.diruptio.de")
+                .inheritIO().start().waitFor()
+            ProcessBuilder(
+                "docker", "push",
+                "docker-public.diruptio.de/diruptio/vertically-spinning-fish:${version}")
+                .inheritIO().start().waitFor()
+            ProcessBuilder(
+                "docker", "push",
+                "docker-public.diruptio.de/diruptio/vertically-spinning-fish:latest")
+                .inheritIO().start().waitFor()
+        }
+    }
+}

src/main/java/diruptio/verticallyspinningfish/VerticallySpinningFish.java

@@ -7,8 +7,9 @@
 import com.github.dockerjava.core.DockerClientConfig;
 import com.google.common.hash.Hashing;
 import diruptio.util.config.Config;
-import diruptio.verticallyspinningfish.api.*;
+import diruptio.verticallyspinningfish.api.ApiBridge;
 import diruptio.verticallyspinningfish.api.Container;
+import diruptio.verticallyspinningfish.api.Status;
 import diruptio.verticallyspinningfish.api.endpoints.LiveUpdatesWebSocket;
 import diruptio.verticallyspinningfish.template.CopyStep;
 import diruptio.verticallyspinningfish.template.TemplateBuilder;