feat: added service implementation bindings (#43)

Author: Frnd-me

.idea/runConfigurations/cirrina__run_.xml

@@ -36,8 +36,7 @@ pkl {
     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",
+        "src/main/resources/pkl/csm/ServiceImplementationBindings.pkl",
       )
       generateGetters.set(true)
       generateJavadoc.set(true)

build.gradle.kts

@@ -4,8 +4,9 @@ import at.ac.uibk.dps.cirrina.execution.`object`.context.Context
 import at.ac.uibk.dps.cirrina.execution.`object`.context.NatsContext
 import at.ac.uibk.dps.cirrina.execution.`object`.event.EventHandler
 import at.ac.uibk.dps.cirrina.execution.`object`.event.NatsEventHandler
-import at.ac.uibk.dps.cirrina.execution.service.OptimalServiceImplementationSelector
+import at.ac.uibk.dps.cirrina.execution.service.RandomServiceImplementationSelector
 import at.ac.uibk.dps.cirrina.execution.service.ServiceImplementationBuilder
+import at.ac.uibk.dps.cirrina.io.parsing.CsmParser
 import io.opentelemetry.api.OpenTelemetry
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk
 import org.apache.logging.log4j.Level
@@ -55,16 +56,24 @@ class Cirrina {
         newPersistentContext().use { persistentContext ->
           val openTelemetry = getOpenTelemetry()
 
-          val services = ServiceImplementationBuilder.from(listOf()).build()
-          val serviceImplementationSelector = OptimalServiceImplementationSelector(services)
-
+          // Create a service implementation selector based on the parsed service implementation
+          // bindings
+          val serviceImplementationSelector =
+            RandomServiceImplementationSelector(
+              ServiceImplementationBuilder.from(
+                  CsmParser.parseServiceImplementationBindings(
+                      EnvironmentVariables.serviceBindingsPath.get()
+                    )
+                    .bindings
+                )
+                .build()
+            )
+
+          // Create and run the runtime
           val runtime =
             Runtime(openTelemetry, serviceImplementationSelector, eventHandler, persistentContext)
 
-          runtime.run(
-            EnvironmentVariables.applicationPath.get(),
-            EnvironmentVariables.instantiate.get(),
-          )
+          runtime.run(EnvironmentVariables.appPath.get(), EnvironmentVariables.instantiate.get())
 
           logger.info("Done running")
         }
@@ -93,21 +102,21 @@ class Cirrina {
 
   // Construct a new persistent context based as configured.
   private fun newPersistentContext(): Context =
-    when (EnvironmentVariables.persistentContextProvider.get()) {
+    when (EnvironmentVariables.contextProvider.get()) {
       PersistentContextProvider.NATS -> newNatsPersistentContext()
       else ->
         throw ConfigurationError.Unknown(
           "persistent context",
-          EnvironmentVariables.persistentContextProvider.get(),
+          EnvironmentVariables.contextProvider.get(),
         )
     }
 
   // Construct a new NATS persistent context as configured.
   private fun newNatsPersistentContext(): NatsContext =
     NatsContext(
       false,
-      EnvironmentVariables.natsPersistentContextUrl.get(),
-      EnvironmentVariables.natsPersistentContextBucket.get(),
+      EnvironmentVariables.natsContextUrl.get(),
+      EnvironmentVariables.natsContextBucket.get(),
     )
 
   // Construct a new OpenTelemetry instance as configured.

src/main/java/at/ac/uibk/dps/cirrina/cirrina/Cirrina.kt

@@ -38,16 +38,17 @@ object EnvironmentVariables {
   /** The NATS event server URL. */
   val natsEventUrl = EnvironmentVariable("NATS_EVENT_URL", default = "nats://localhost:4222/")
 
-  /** The NATS persistent context server URL. */
-  val natsPersistentContextUrl =
-    EnvironmentVariable("NATS_PERSISTENT_CONTEXT_URL", default = "nats://localhost:4222")
+  /** The NATS context server URL. */
+  val natsContextUrl = EnvironmentVariable("NATS_CONTEXT_URL", default = "nats://localhost:4222")
 
-  /** The NATS persistent context bucket. */
-  val natsPersistentContextBucket =
-    EnvironmentVariable("NATS_PERSISTENT_CONTEXT_BUCKET", default = "persistent")
+  /** The NATS context bucket. */
+  val natsContextBucket = EnvironmentVariable("NATS_CONTEXT_BUCKET", default = "persistent")
 
   /** The path to the CSML application. */
-  val applicationPath = EnvironmentVariable<String>("APPLICATION_PATH", required = true)
+  val appPath = EnvironmentVariable<String>("APP_PATH", required = true)
+
+  /** The path to the service implementation bindings. */
+  val serviceBindingsPath = EnvironmentVariable<String>("SERVICE_BINDINGS_PATH", required = true)
 
   /** The state machine names to instantiate. */
   val instantiate =
@@ -75,17 +76,17 @@ object EnvironmentVariables {
       },
     )
 
-  /** The persistent context provider to use. */
-  val persistentContextProvider =
+  /** The context provider to use. */
+  val contextProvider =
     EnvironmentVariable(
-      name = "PERSISTENT_CONTEXT_PROVIDER",
+      name = "CONTEXT_PROVIDER",
       default = PersistentContextProvider.NATS,
       mapper = { value ->
         try {
           PersistentContextProvider.valueOf(value.uppercase())
         } catch (_: IllegalArgumentException) {
           throw EnvironmentVariableError.Invalid(
-            "PERSISTENT_CONTEXT_PROVIDER",
+            "CONTEXT_PROVIDER",
             value,
             PersistentContextProvider.entries.toString(),
           )

src/main/java/at/ac/uibk/dps/cirrina/cirrina/EnvironmentVariables.kt

@@ -7,7 +7,7 @@ import at.ac.uibk.dps.cirrina.execution.`object`.context.Extent
 import at.ac.uibk.dps.cirrina.execution.`object`.event.EventHandler
 import at.ac.uibk.dps.cirrina.execution.`object`.statemachine.StateMachine
 import at.ac.uibk.dps.cirrina.execution.service.ServiceImplementationSelector
-import at.ac.uibk.dps.cirrina.io.description.CsmlParser
+import at.ac.uibk.dps.cirrina.io.parsing.CsmParser
 import at.ac.uibk.dps.cirrina.utils.Id
 import io.opentelemetry.api.OpenTelemetry
 import java.io.IOException
@@ -66,7 +66,7 @@ class Runtime(
     val collaborativeStateMachineClass =
       CollaborativeStateMachineClassBuilder.from(
           // A main.pkl file is required in the CSML project
-          CsmlParser.parse(Path(path).pathString)
+          CsmParser.parseCsml(Path(path).pathString)
         )
         .build()
 

src/main/java/at/ac/uibk/dps/cirrina/cirrina/Runtime.kt

@@ -2,8 +2,8 @@
 
 import at.ac.uibk.dps.cirrina.classes.statemachine.StateMachineClass;
 import at.ac.uibk.dps.cirrina.classes.statemachine.StateMachineClassBuilder;
-import at.ac.uibk.dps.cirrina.csml.description.Csml;
-import at.ac.uibk.dps.cirrina.csml.description.Csml.EventChannel;
+import at.ac.uibk.dps.cirrina.csm.Csml;
+import at.ac.uibk.dps.cirrina.csm.Csml.EventChannel;
 import at.ac.uibk.dps.cirrina.execution.object.context.Context;
 import at.ac.uibk.dps.cirrina.execution.object.context.ContextBuilder;
 import at.ac.uibk.dps.cirrina.execution.object.event.Event;

src/main/java/at/ac/uibk/dps/cirrina/classes/collaborativestatemachine/CollaborativeStateMachineClassBuilder.java

@@ -1,6 +1,6 @@
 package at.ac.uibk.dps.cirrina.classes.state;
 
-import at.ac.uibk.dps.cirrina.csml.description.Csml.ContextDescription;
+import at.ac.uibk.dps.cirrina.csm.Csml.ContextDescription;
 import at.ac.uibk.dps.cirrina.execution.object.action.Action;
 import at.ac.uibk.dps.cirrina.execution.object.action.ActionGraph;
 import at.ac.uibk.dps.cirrina.execution.object.action.ActionGraphBuilder;

src/main/java/at/ac/uibk/dps/cirrina/classes/state/StateClass.java

@@ -1,7 +1,7 @@
 package at.ac.uibk.dps.cirrina.classes.state;
 
-import at.ac.uibk.dps.cirrina.csml.description.Csml.ActionDescription;
-import at.ac.uibk.dps.cirrina.csml.description.Csml.StateDescription;
+import at.ac.uibk.dps.cirrina.csm.Csml.ActionDescription;
+import at.ac.uibk.dps.cirrina.csm.Csml.StateDescription;
 import at.ac.uibk.dps.cirrina.execution.object.action.Action;
 import at.ac.uibk.dps.cirrina.execution.object.action.ActionBuilder;
 import at.ac.uibk.dps.cirrina.execution.object.action.TimeoutAction;

src/main/java/at/ac/uibk/dps/cirrina/classes/state/StateClassBuilder.java

@@ -3,7 +3,7 @@
 import at.ac.uibk.dps.cirrina.classes.state.StateClass;
 import at.ac.uibk.dps.cirrina.classes.transition.OnTransitionClass;
 import at.ac.uibk.dps.cirrina.classes.transition.TransitionClass;
-import at.ac.uibk.dps.cirrina.csml.description.Csml.ContextDescription;
+import at.ac.uibk.dps.cirrina.csm.Csml.ContextDescription;
 import at.ac.uibk.dps.cirrina.execution.object.action.EventRaisingAction;
 import at.ac.uibk.dps.cirrina.execution.object.event.Event;
 import at.ac.uibk.dps.cirrina.io.plantuml.Exportable;

src/main/java/at/ac/uibk/dps/cirrina/classes/statemachine/StateMachineClass.java

@@ -2,9 +2,9 @@
 
 import at.ac.uibk.dps.cirrina.classes.state.StateClassBuilder;
 import at.ac.uibk.dps.cirrina.classes.transition.TransitionClassBuilder;
-import at.ac.uibk.dps.cirrina.csml.description.Csml.StateDescription;
-import at.ac.uibk.dps.cirrina.csml.description.Csml.StateMachineDescription;
-import at.ac.uibk.dps.cirrina.csml.description.Csml.TransitionDescription;
+import at.ac.uibk.dps.cirrina.csm.Csml.StateDescription;
+import at.ac.uibk.dps.cirrina.csm.Csml.StateMachineDescription;
+import at.ac.uibk.dps.cirrina.csm.Csml.TransitionDescription;
 import java.util.List;
 import java.util.Optional;
 import java.util.function.Consumer;