feat: improving application running workflow (#38)

Author: Frnd-me

.idea/codeStyles/Project.xml

@@ -36,4 +36,12 @@ automatically build and test your changes.
 Make sure that your both the commits in your pull request and the pull request title are formatted according to the
 [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. Commit linting is enforced by the CI. Squashed commits
 upon merging are also enforced by the CI and will receive the pull request title as the commit message. We use Conventional Commits to
-generate the changelogs.
+generate the changelogs.
+
+## Code Guidelines
+
+This project uses Java for the majority of the code. However, we only accept new contributions in Kotlin, and where possible, Java
+implementations should be reimplemented in Kotlin.
+
+Public functions and members should be properly documented using Javadoc or KDoc. Private functions and members should be commented in case
+they are not self-explanatory.

.idea/runConfigurations/cirrina__run_.xml

@@ -17,4 +17,4 @@ FROM gcr.io/distroless/java21-debian12 AS runtime
 
 COPY --from=build /tmp/cirrina /opt/cirrina
 
-ENTRYPOINT ["java", "-cp", "/opt/cirrina/lib/*", "at.ac.uibk.dps.cirrina.cirrina.Cirrina"]
+ENTRYPOINT ["java", "-cp", "/opt/cirrina/lib/*", "at.ac.uibk.dps.cirrina.cirrina.CirrinaKt"]

.idea/watcherTasks.xml

@@ -1,146 +1,146 @@
 import com.google.protobuf.gradle.id
 
 plugins {
-    application
-    jacoco
+  application
+  jacoco
 
-    id("com.google.protobuf") version "0.9.4"
-    id("org.pkl-lang") version "0.29.0"
+  id("com.google.protobuf") version "0.9.4"
+  id("org.pkl-lang") version "0.29.0"
 
-    kotlin("jvm")
+  kotlin("jvm")
 }
 
 group = "ac.at.uibk.dps.cirrina"
 version = rootProject.file("version.txt").readText().trim()
 
 application {
-    mainClass = "at.ac.uibk.dps.cirrina.cirrina.Cirrina"
+  mainClass = "at.ac.uibk.dps.cirrina.cirrina.CirrinaKt"
 }
 
 java {
-    toolchain {
-        languageVersion = JavaLanguageVersion.of(21)
-    }
+  toolchain {
+    languageVersion = JavaLanguageVersion.of(21)
+  }
 }
 
 jacoco {
-    toolVersion = "0.8.11"
+  toolVersion = "0.8.11"
 }
 
 pkl {
-    project {
-        packagers {
-            register("pklMakePackages") {
-                projectDirectories.from(file("src/main/resources/pkl/csm/"))
-                outputPath.set(File("build/generated/pkl/packages/csm"))
-            }
-        }
+  project {
+    packagers {
+      register("pklMakePackages") {
+        projectDirectories.from(file("src/main/resources/pkl/csm/"))
+        outputPath.set(File("build/generated/pkl/packages/csm"))
+      }
     }
-    javaCodeGenerators {
-        register("pklGenJava") {
-            sourceModules.addAll(
-                "src/main/resources/pkl/csm/Csml.pkl",
-                "src/main/resources/pkl/csm/HttpServiceImplementationDescription.pkl",
-                "src/main/resources/pkl/csm/ServiceImplementationDescription.pkl"
-            )
-            generateGetters.set(true)
-            generateJavadoc.set(true)
-        }
+  }
+  javaCodeGenerators {
+    register("pklGenJava") {
+      sourceModules.addAll(
+        "src/main/resources/pkl/csm/Csml.pkl",
+        "src/main/resources/pkl/csm/HttpServiceImplementationDescription.pkl",
+        "src/main/resources/pkl/csm/ServiceImplementationDescription.pkl"
+      )
+      generateGetters.set(true)
+      generateJavadoc.set(true)
     }
+  }
 }
 
 protobuf {
-    generateProtoTasks {
-        all().forEach { task ->
-            task.builtins {
-                id("python")
-                id("cpp")
-            }
-        }
+  generateProtoTasks {
+    all().forEach { task ->
+      task.builtins {
+        id("python")
+        id("cpp")
+      }
     }
+  }
 }
 
 dependencies {
-    implementation("com.ecwid.consul:consul-api:1.4.5")
+  implementation("com.ecwid.consul:consul-api:1.4.5")
 
-    implementation("com.fasterxml.jackson.core:jackson-databind:2.15.1")
-    implementation("com.fasterxml.jackson.module:jackson-module-parameter-names:2.15.1")
-    implementation("com.fasterxml.jackson.module:jackson-module-jsonSchema:2.15.1")
-    implementation("com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.15.1")
-    implementation("com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.15.1")
+  implementation("com.fasterxml.jackson.core:jackson-databind:2.15.1")
+  implementation("com.fasterxml.jackson.module:jackson-module-parameter-names:2.15.1")
+  implementation("com.fasterxml.jackson.module:jackson-module-jsonSchema:2.15.1")
+  implementation("com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.15.1")
+  implementation("com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.15.1")
 
-    implementation("com.google.guava:guava:33.0.0-jre")
+  implementation("com.google.guava:guava:33.0.0-jre")
 
-    implementation("com.google.protobuf:protobuf-java:4.32.0")
+  implementation("com.google.protobuf:protobuf-java:4.32.0")
 
-    implementation("info.schnatterer.moby-names-generator:moby-names-generator:20.10.1-r0")
+  implementation("io.nats:jnats:2.17.3")
 
-    implementation("io.nats:jnats:2.17.3")
+  implementation(platform("io.opentelemetry:opentelemetry-bom:1.38.0"));
+  implementation("io.opentelemetry:opentelemetry-api");
+  implementation("io.opentelemetry:opentelemetry-sdk");
+  implementation("io.opentelemetry:opentelemetry-exporter-logging");
+  implementation("io.opentelemetry:opentelemetry-exporter-otlp");
+  implementation("io.opentelemetry.semconv:opentelemetry-semconv:1.25.0-alpha");
+  implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure");
 
-    implementation(platform("io.opentelemetry:opentelemetry-bom:1.38.0"));
-    implementation("io.opentelemetry:opentelemetry-api");
-    implementation("io.opentelemetry:opentelemetry-sdk");
-    implementation("io.opentelemetry:opentelemetry-exporter-logging");
-    implementation("io.opentelemetry:opentelemetry-exporter-otlp");
-    implementation("io.opentelemetry.semconv:opentelemetry-semconv:1.25.0-alpha");
-    implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure");
+  implementation("jakarta.annotation:jakarta.annotation-api:3.0.0")
 
-    implementation("jakarta.annotation:jakarta.annotation-api:3.0.0")
+  implementation("org.apache.commons:commons-jexl3:3.3")
 
-    implementation("org.apache.commons:commons-jexl3:3.3")
+  implementation("org.apache.httpcomponents.client5:httpclient5:5.3.1")
 
-    implementation("org.apache.httpcomponents.client5:httpclient5:5.3.1")
+  implementation("org.apache.logging.log4j:log4j-core:2.23.1")
 
-    implementation("org.apache.logging.log4j:log4j-core:2.23.1")
+  implementation("org.glassfish.expressly:expressly:5.0.0")
 
-    implementation("org.glassfish.expressly:expressly:5.0.0")
+  implementation("org.hibernate.validator:hibernate-validator:8.0.1.Final")
+  implementation("org.hibernate:hibernate-validator-cdi:8.0.1.Final")
 
-    implementation("org.hibernate.validator:hibernate-validator:8.0.1.Final")
-    implementation("org.hibernate:hibernate-validator-cdi:8.0.1.Final")
+  implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.9.0")
 
-    implementation("org.jgrapht:jgrapht-core:1.5.2")
+  implementation("org.jgrapht:jgrapht-core:1.5.2")
 
-    implementation("org.pkl-lang:pkl-config-java:0.29.0")
-    implementation("org.pkl-lang:pkl-codegen-java:0.29.0")
+  implementation("org.pkl-lang:pkl-config-java:0.29.0")
+  implementation("org.pkl-lang:pkl-codegen-java:0.29.0")
 
-    testImplementation(platform("org.junit:junit-bom:5.9.1"))
-    testImplementation("org.junit.jupiter:junit-jupiter")
+  testImplementation(platform("org.junit:junit-bom:5.9.1"))
+  testImplementation("org.junit.jupiter:junit-jupiter")
 
-    testImplementation("org.mockito:mockito-core:5.11.0")
-    implementation(kotlin("stdlib-jdk8"))
+  testImplementation("org.mockito:mockito-core:5.11.0")
+  implementation(kotlin("stdlib-jdk8"))
 }
 
 repositories {
-    mavenCentral()
-    gradlePluginPortal()
-    maven(url = "https://repository.cloudera.com/artifactory/cloudera-repos/")
+  mavenCentral()
+  gradlePluginPortal()
+  maven(url = "https://repository.cloudera.com/artifactory/cloudera-repos/")
 }
 
 tasks.compileJava {
-    dependsOn("pklMakePackages")
+  dependsOn("pklMakePackages")
 }
 
 tasks.distZip {
-    archiveFileName.set("${project.name}.zip")
+  archiveFileName.set("${project.name}.zip")
 }
 
 tasks.test {
-    useJUnitPlatform()
-    finalizedBy(tasks.jacocoTestReport)
+  useJUnitPlatform()
+  finalizedBy(tasks.jacocoTestReport)
 }
 
 tasks.jacocoTestReport {
-    dependsOn(tasks.test)
-    reports {
-        xml.required = true
-        html.required = false
-        csv.required = false
-    }
+  dependsOn(tasks.test)
+  reports {
+    xml.required = true
+    html.required = false
+    csv.required = false
+  }
 }
 
 tasks.withType<Jar> {
-    manifest {
-        attributes["Main-Class"] = "at.ac.uibk.dps.cirrina.main.Main"
-        attributes["Implementation-Version"] = version
-    }
+  manifest {
+    attributes["Main-Class"] = "at.ac.uibk.dps.cirrina.main.Main"
+    attributes["Implementation-Version"] = version
+  }
 }

CONTRIBUTING.md

@@ -0,0 +1,30 @@
+version: '3.7'
+configs:
+  telegraf_config:
+    file: ./telegraf.conf
+services:
+  influxdb:
+    image: "influxdb:2"
+    ports:
+      - "8086:8086"
+    environment:
+      - DOCKER_INFLUXDB_INIT_MODE=setup
+      - DOCKER_INFLUXDB_INIT_USERNAME=admin
+      - DOCKER_INFLUXDB_INIT_PASSWORD=adminadmin
+      - DOCKER_INFLUXDB_INIT_ORG=org
+      - DOCKER_INFLUXDB_INIT_BUCKET=bucket
+      - DOCKER_INFLUXDB_INIT_ADMIN_TOKEN=bzO10KmR8x
+  telegraf:
+    image: "telegraf:latest"
+    ports:
+      - "4317:4317"
+    configs:
+      - source: telegraf_config
+        target: /etc/telegraf/telegraf.conf
+  nats:
+    image: "nats:latest"
+    command:
+      - "-js"
+    ports:
+      - "4222:4222"
+      - "6222:6222"