Merge pull request #957 from modelix/fix/error-no-included-modules

MODELIX-784 Clearly state that no module matched the specified conditions when exporting from MPS in the error message

Author: mhuster23

bulk-model-sync-gradle/src/main/kotlin/org/modelix/model/sync/bulk/gradle/tasks/ExportFromModelServer.kt

@@ -84,7 +84,7 @@ abstract class ExportFromModelServer : DefaultTask() {
             branch.runRead {
                 val root = branch.getRootNode()
                 logger.info("Got root node: {}", root)
-                val outputDir = outputDir.get().asFile
+                val outputDir = outputDir.get().asFile.toPath()
 
                 getIncludedModules(root).forEach {
                     val fileName = it.getPropertyValue(BuiltinLanguages.jetbrains_mps_lang_core.INamedConcept.name)

bulk-model-sync-lib/mps-test/build.gradle.kts

@@ -34,6 +34,7 @@ dependencies {
     testImplementation(project(":mps-model-adapters"))
     testImplementation(libs.kotlin.serialization.json)
     testImplementation(libs.xmlunit.matchers)
+    testImplementation(libs.jimfs)
 }
 
 intellij {

bulk-model-sync-lib/mps-test/src/test/kotlin/org/modelix/model/sync/bulk/lib/test/ExportRepositoryTest.kt

@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2024.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.modelix.model.sync.bulk.lib.test
+import com.google.common.jimfs.Jimfs
+import org.modelix.mps.model.sync.bulk.MPSBulkSynchronizer
+import kotlin.io.path.listDirectoryEntries
+import kotlin.io.path.name
+
+class ExportRepositoryTest : MPSTestBase() {
+
+    private val fileSystem = Jimfs.newFileSystem()
+    private val outputPath = fileSystem.getPath("/some/output/path")
+
+    fun `test exports module included by name (testdata oneEmptyModule)`() {
+        MPSBulkSynchronizer.exportModulesFromRepository(mpsProject.repository, setOf("onlySolution"), emptySet(), outputPath)
+
+        assertEquals(listOf("onlySolution.json"), outputPath.listDirectoryEntries().map { it.name })
+    }
+
+    fun `test exports module included by prefix (testdata oneEmptyModule)`() {
+        MPSBulkSynchronizer.exportModulesFromRepository(mpsProject.repository, emptySet(), setOf("onlySol"), outputPath)
+
+        assertEquals(listOf("onlySolution.json"), outputPath.listDirectoryEntries().map { it.name })
+    }
+
+    fun `test fail if no module is found (testdata oneEmptyModule)`() {
+        val expectedMsg = """
+            No module matched the inclusion criteria.
+            [includedModules] = [someSolution]
+            [includedModulePrefixes] = [somePrefix]
+        """.trimIndent()
+
+        try {
+            MPSBulkSynchronizer
+                .exportModulesFromRepository(mpsProject.repository, setOf("someSolution"), setOf("somePrefix"), outputPath)
+            fail("Exporting models should fail.")
+        } catch (ex: IllegalArgumentException) {
+            assertEquals(expectedMsg, ex.message)
+        } catch (ex: Throwable) {
+            fail("Expected IllegalArgumentException but got $ex")
+        }
+    }
+}

bulk-model-sync-lib/src/jvmMain/kotlin/org/modelix/model/sync/bulk/ModelExporter.kt

@@ -21,7 +21,9 @@ import kotlinx.serialization.json.Json
 import kotlinx.serialization.json.encodeToStream
 import org.modelix.model.api.INode
 import org.modelix.model.data.ModelData
-import java.io.File
+import java.nio.file.Files
+import java.nio.file.Path
+import kotlin.io.path.outputStream
 
 actual class ModelExporter actual constructor(private val root: INode) {
 
@@ -31,8 +33,8 @@ actual class ModelExporter actual constructor(private val root: INode) {
      * @param outputFile target file of the export
      */
     @OptIn(ExperimentalSerializationApi::class)
-    fun export(outputFile: File) {
-        outputFile.parentFile.mkdirs()
+    fun export(outputFile: Path) {
+        Files.createDirectories(outputFile.parent)
 
         val modelData = ModelData(root = root.asExported())
         outputFile.outputStream().use { outputStream ->

bulk-model-sync-mps/src/main/kotlin/org/modelix/mps/model/sync/bulk/MPSBulkSynchronizer.kt

@@ -33,6 +33,7 @@ import kotlinx.coroutines.runBlocking
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.json.Json
 import kotlinx.serialization.json.decodeFromStream
+import org.jetbrains.annotations.VisibleForTesting
 import org.jetbrains.mps.openapi.model.EditableSModel
 import org.jetbrains.mps.openapi.module.ModelAccess
 import org.jetbrains.mps.openapi.module.SModule
@@ -55,6 +56,7 @@ import org.modelix.model.sync.bulk.ModelImporter
 import org.modelix.model.sync.bulk.ModelSynchronizer
 import org.modelix.model.sync.bulk.isModuleIncluded
 import java.io.File
+import java.nio.file.Path
 import java.util.concurrent.atomic.AtomicInteger
 
 /**
@@ -91,14 +93,38 @@ object MPSBulkSynchronizer {
         val includedModuleNames = parseRawPropertySet(System.getProperty("modelix.mps.model.sync.bulk.output.modules"))
         val includedModulePrefixes =
             parseRawPropertySet(System.getProperty("modelix.mps.model.sync.bulk.output.modules.prefixes"))
+        val outputPathName = System.getProperty("modelix.mps.model.sync.bulk.output.path")
+        val outputPath = Path.of(outputPathName)
+        exportModulesFromRepository(repository, includedModuleNames, includedModulePrefixes, outputPath)
+    }
 
+    /**
+     * Export modules that are included either by [includedModuleNames] or [includedModulePrefixes]
+     * as files into [outputPath].
+     */
+    @JvmStatic
+    @VisibleForTesting
+    fun exportModulesFromRepository(
+        repository: SRepository,
+        includedModuleNames: Set<String>,
+        includedModulePrefixes: Set<String>,
+        outputPath: Path,
+    ) {
         repository.modelAccess.runReadAction {
             val allModules = repository.modules
             val includedModules = allModules.filter {
                 isModuleIncluded(it.moduleName!!, includedModuleNames, includedModulePrefixes)
             }
+
+            require(includedModules.isNotEmpty()) {
+                """
+                    No module matched the inclusion criteria.
+                    [includedModules] = $includedModuleNames
+                    [includedModulePrefixes] = $includedModulePrefixes
+                """.trimIndent()
+            }
+
             val numIncludedModules = includedModules.count()
-            val outputPath = System.getProperty("modelix.mps.model.sync.bulk.output.path")
             val counter = AtomicInteger()
 
             includedModules.parallelStream().forEach { module ->
@@ -107,7 +133,7 @@ object MPSBulkSynchronizer {
                 repository.modelAccess.runReadAction {
                     println("Exporting module $pos of $numIncludedModules: '${module.moduleName}'")
                     val exporter = ModelExporter(MPSModuleAsNode(module))
-                    val outputFile = File(outputPath + File.separator + module.moduleName + ".json")
+                    val outputFile = outputPath.resolve(module.moduleName + ".json")
                     exporter.export(outputFile)
                     println("Exported module $pos of $numIncludedModules: '${module.moduleName}'")
                 }
@@ -162,6 +188,7 @@ object MPSBulkSynchronizer {
      * [getModulesToImport] is a lambda to be executed with read access in MPS.
      */
     @JvmStatic
+    @VisibleForTesting
     fun importModelsIntoRepository(
         repository: SRepository,
         rootOfImport: INode,

gradle/libs.versions.toml

@@ -128,3 +128,5 @@ micrometer-registry-prometheus = { group = "io.micrometer", name = "micrometer-r
 
 detekt-api = { group = "io.gitlab.arturbosch.detekt", name= "detekt-api", version.ref = "detekt" }
 detekt-test = { group = "io.gitlab.arturbosch.detekt", name= "detekt-test", version.ref = "detekt" }
+
+jimfs = { group = "com.google.jimfs", name = "jimfs", version = "1.3.0" }