feat: adding resolving of csm pkl module (#42)

Author: Frnd-me

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

@@ -66,7 +66,7 @@ class Runtime(
     val collaborativeStateMachineClass =
       CollaborativeStateMachineClassBuilder.from(
           // A main.pkl file is required in the CSML project
-          CsmlParser.parse(Path(path, "main.pkl").pathString)
+          CsmlParser.parse(Path(path).pathString)
         )
         .build()
 

src/main/java/at/ac/uibk/dps/cirrina/io/description/CsmlParser.kt

@@ -1,10 +1,53 @@
 package at.ac.uibk.dps.cirrina.io.description
 
 import at.ac.uibk.dps.cirrina.csml.description.Csml
-import org.pkl.config.java.ConfigEvaluator
+import java.net.URI
+import java.util.*
+import java.util.regex.Pattern
+import org.pkl.config.java.ConfigEvaluatorBuilder
 import org.pkl.core.ModuleSource
+import org.pkl.core.SecurityManager
+import org.pkl.core.module.ModuleKey
+import org.pkl.core.module.ModuleKeyFactory
+import org.pkl.core.module.ResolvedModuleKey
+import org.pkl.core.util.IoUtils
 
-/** CsmlParser, used to parse a Pkl file into a Csml object. */
+/** CsmModuleKey, used to load CSM modules from the classpath. */
+class CsmModuleKey(private val uri: URI) : ModuleKey, ResolvedModuleKey {
+
+  /** Get the original module key. */
+  override fun getOriginal(): ModuleKey = this
+
+  /** Get the URI of the module. */
+  override fun getUri(): URI = uri
+
+  /** Load the source code of the module. */
+  override fun loadSource(): String =
+    IoUtils.readClassPathResourceAsString(javaClass, "/pkl/csm/${uri.schemeSpecificPart}.pkl")
+
+  /** Resolve the module. */
+  override fun resolve(securityManager: SecurityManager): ResolvedModuleKey {
+    securityManager.checkResolveModule(uri)
+    return this
+  }
+
+  /** Csm modules are always hierarchical. */
+  override fun hasHierarchicalUris(): Boolean = true
+
+  /** Csm modules cannot be globbed. */
+  override fun isGlobbable(): Boolean = false
+}
+
+/** Factory for CsmModuleKey, converts csm: modules to CsmModuleKey. */
+class CsmModuleKeyFactory : ModuleKeyFactory {
+  /** Converts a URI into a CsmModuleKey if the URI scheme is csm. */
+  override fun create(uri: URI): Optional<ModuleKey> =
+    Optional.ofNullable(
+      uri.takeIf { it.scheme.equals("csm", ignoreCase = true) }?.let { CsmModuleKey(it) }
+    )
+}
+
+/** Csml parser, used to parse a Pkl file into a Csml object. */
 object CsmlParser {
   /**
    * Parse a Pkl module at a path. Returns an instance of Csml upon success. Any errors will result
@@ -16,7 +59,17 @@ object CsmlParser {
    */
   fun parse(mainModulePath: String): Csml {
     try {
-      ConfigEvaluator.preconfigured().use { evaluator ->
+      // Create a preconfigured ConfigEvaluatorBuilder
+      val builder = ConfigEvaluatorBuilder.preconfigured()
+
+      // Mark the CSM module as an allowed module
+      builder.allowedModules.add(Pattern.compile("csm:.*"))
+
+      // Add the CsmModuleKeyFactory to the builder
+      builder.evaluatorBuilder.addModuleKeyFactory(CsmModuleKeyFactory())
+
+      // Build and load the main module
+      builder.build().use { evaluator ->
         return evaluator.evaluate(ModuleSource.file(mainModulePath)).`as`(Csml::class.java)
       }
     } catch (e: Exception) {

src/test/java/at/ac/uibk/dps/cirrina/classes/statemachine/StateMachineClassTest.kt

@@ -21,7 +21,7 @@ class StateMachineClassTest {
     assertDoesNotThrow {
       stateMachineClass =
         CollaborativeStateMachineClassBuilder.from(
-            CsmlParser.parse(Path(DefaultDescriptions.complete, "main.pkl").pathString)
+            CsmlParser.parse(Path(DefaultDescriptions.complete).pathString)
           )
           .build()
           .findStateMachineClassByName("stateMachine1")

src/test/java/at/ac/uibk/dps/cirrina/data/DefaultDescriptions.kt

@@ -1,11 +1,11 @@
 package at.ac.uibk.dps.cirrina.data
 
 object DefaultDescriptions {
-  const val complete: String = "src/test/resources/pkl/complete"
+  const val complete: String = "src/test/resources/pkl/complete/main.pkl"
 
-  const val invoke: String = "src/test/resources/pkl/invoke"
+  const val invoke: String = "src/test/resources/pkl/invoke/main.pkl"
 
-  const val timeout: String = "src/test/resources/pkl/timeout"
+  const val timeout: String = "src/test/resources/pkl/timeout/main.pkl"
 
-  const val pingPong: String = "src/test/resources/pkl/pingPong"
+  const val pingPong: String = "src/test/resources/pkl/pingPong/main.pkl"
 }

src/test/resources/pkl/complete/main.pkl

@@ -1,4 +1,4 @@
-amends "modulepath:/pkl/csm/Csml.pkl"
+amends "csm:Csml"
 import "stateMachineOne.pkl"
 
 name = "complete"

src/test/resources/pkl/complete/stateMachineOne.pkl

@@ -1,4 +1,4 @@
-import "modulepath:/pkl/csm/Csml.pkl"
+import "csm:Csml"
 
 //                                           State Machine One                                           
 // ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐

src/test/resources/pkl/invoke/main.pkl

@@ -1,5 +1,5 @@
-amends "modulepath:/pkl/csm/Csml.pkl"
-import "modulepath:/pkl/csm/Csml.pkl"
+amends "csm:Csml"
+import "csm:Csml"
 
 name = "invoke"
 version = "3.0.0"

src/test/resources/pkl/pingPong/main.pkl

@@ -1,4 +1,4 @@
-amends "modulepath:/pkl/csm/Csml.pkl"
+amends "csm:Csml"
 import "stateMachineOne.pkl"
 import "stateMachineTwo.pkl"
 

src/test/resources/pkl/pingPong/stateMachineOne.pkl

@@ -1,4 +1,4 @@
-import "modulepath:/pkl/csm/Csml.pkl"
+import "csm:Csml"
 
 //             State Machine One
 // ┌──────────────────────────────────────────┐

src/test/resources/pkl/pingPong/stateMachineTwo.pkl

@@ -1,4 +1,4 @@
-import "modulepath:/pkl/csm/Csml.pkl"
+import "csm:Csml"
 
 //             State Machine Two
 // ┌──────────────────────────────────────────┐