tests, changelog, fixec

Author: pkoq

CHANGELOG.md

@@ -25,6 +25,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 - Option to add list of rows to table and list of cells to table row in their respective builders
 - Support for document object pdf tagging/accessibility metadata
 - Added Hierarchy task and its accompanying html visualisation
+- External display rule support along with metadata, subject, target aliasing,
+  base template override, variable structure override and target folder
+  override support
 
 ### Changed
 

migration-examples/src/main/groovy/com/quadient/migration/example/example/Import.groovy

@@ -84,6 +84,9 @@ def variableStructure = new VariableStructureBuilder("variableStructure")
 // Display displayHeaderRule to conditionally display the address.
 // Header is hidden if displayHeaderVariable is set to false
 def displayAddressRule = new DisplayRuleBuilder("displayAddressRule")
+    .internal(false)
+    .subject("External display rule")
+    .metadata("key") { it.string("value") }
     .group {
         it.operator(GroupOp.Or)
         it.comparison { it.variable(nameVariable.id).notEquals().value("") }
@@ -92,10 +95,14 @@ def displayAddressRule = new DisplayRuleBuilder("displayAddressRule")
         it.comparison { it.variable(stateVariable.id).notEquals().value("") }
     }.build()
 
-def displayHeaderRule = new DisplayRuleBuilder("displayHeaderRule")
+def dummyDisplayHeaderRule = new DisplayRuleBuilder("dummyDisplayHeaderRule")
     .comparison { it.value(true).equals().variable(displayHeaderVariable.id) }
     .build()
 
+def displayHeaderRule = new DisplayRuleBuilder("displayHeaderRule")
+    .targetId(dummyDisplayHeaderRule.id)
+    .build()
+
 def displayParagraphRule = new DisplayRuleBuilder("displayParagraphRule")
     .comparison { it.value(true).equals().variable(displayParagraphVariable.id) }
     .build()
@@ -494,7 +501,7 @@ for (item in [headingStyle, normalStyle]) {
 for (item in [displayHeaderVariable, displayParagraphVariable, displayLastSentenceVariable, nameVariable, addressVariable, cityVariable, stateVariable]) {
     migration.variableRepository.upsert(item)
 }
-for (item in [displayAddressRule, displayHeaderRule, displayParagraphRule, displayLastSentenceRule, displayRuleStateCzechia, displayRuleStateFrance]) {
+for (item in [displayAddressRule, dummyDisplayHeaderRule, displayHeaderRule, displayParagraphRule, displayLastSentenceRule, displayRuleStateCzechia, displayRuleStateFrance]) {
     migration.displayRuleRepository.upsert(item)
 }
 for (item in [paragraphStyle, headingParaStyle]) {

migration-library/src/main/kotlin/com/quadient/migration/api/dto/migrationmodel/DisplayRule.kt

@@ -21,6 +21,6 @@ data class DisplayRule @JvmOverloads constructor(
     val variableStructureRef: VariableStructureRef? = null,
 ) : MigrationObject, RefValidatable {
     override fun collectRefs(): List<Ref> {
-        return definition?.collectRefs() ?: emptyList()
+        return (definition?.collectRefs() ?: emptyList()) + listOfNotNull(variableStructureRef)
     }
 }

migration-library/src/main/kotlin/com/quadient/migration/service/deploy/InteractiveDeployClient.kt

@@ -143,7 +143,8 @@ class InteractiveDeployClient(
             }
             .distinctBy { it.id }
 
-        for (rule in rules) {
+        for (r in rules) {
+            val rule = r.resolveTarget(displayRuleRepository)
             val targetPath = documentObjectBuilder.getDisplayRulePath(rule).toString()
 
             if (!shouldDeployObject(rule.id, ResourceType.DisplayRule, targetPath, deploymentResult)) {

migration-library/src/test/kotlin/com/quadient/migration/persistence/MappingRepositoryTest.kt

@@ -4,17 +4,27 @@ import com.quadient.migration.Postgres
 import com.quadient.migration.api.dto.migrationmodel.CustomFieldMap
 import com.quadient.migration.api.dto.migrationmodel.MappingItem
 import com.quadient.migration.api.dto.migrationmodel.VariableStructure
-import com.quadient.migration.api.repository.*
+import com.quadient.migration.api.dto.migrationmodel.VariableStructureRef
+import com.quadient.migration.api.repository.AttachmentRepository
+import com.quadient.migration.api.repository.DisplayRuleRepository
+import com.quadient.migration.api.repository.DocumentObjectRepository
+import com.quadient.migration.api.repository.ImageRepository
+import com.quadient.migration.api.repository.MappingRepository
+import com.quadient.migration.api.repository.ParagraphStyleRepository
+import com.quadient.migration.api.repository.TextStyleRepository
+import com.quadient.migration.api.repository.VariableRepository
+import com.quadient.migration.api.repository.VariableStructureRepository
 import com.quadient.migration.shared.VariablePathData
 import com.quadient.migration.tools.aProjectConfig
 import com.quadient.migration.tools.aVariable
+import com.quadient.migration.tools.model.aDisplayRule
 import io.mockk.every
 import io.mockk.just
 import io.mockk.mockk
 import io.mockk.runs
 import io.mockk.verify
-import kotlin.time.Clock
 import org.junit.jupiter.api.Test
+import kotlin.time.Clock
 
 @Postgres
 class MappingRepositoryTest {
@@ -44,7 +54,7 @@ class MappingRepositoryTest {
     fun `apply variable mapping`() {
         every { variableRepository.find("varId") } returns aVariable(id = "varId", name = "Variable Name")
         every { variableStructureRepository.find("varStructId") } returns VariableStructure(
-            id = "varStructId", 
+            id = "varStructId",
             name = "Variable Structure Name",
             originLocations = emptyList(),
             customFields = CustomFieldMap(mutableMapOf()),
@@ -87,8 +97,8 @@ class MappingRepositoryTest {
         verify {
             variableStructureRepository.upsert(
                 match {
-                    it.id == "varStructId" && 
-                    it.name == "new name" && 
+                    it.id == "varStructId" &&
+                    it.name == "new name" &&
                     it.structure == mapOf(
                         "varId" to VariablePathData("somePath"),
                         "anotherVarId" to VariablePathData("anotherPath")
@@ -97,4 +107,36 @@ class MappingRepositoryTest {
             )
         }
     }
+
+    @Test
+    fun `apply display rule mapping`() {
+        every { displayRuleRepository.find("ruleId") } returns aDisplayRule(id = "ruleId", name = "Old Rule")
+        every { displayRuleRepository.upsert(any()) } just runs
+        repo.upsert(
+            "ruleId", MappingItem.DisplayRule(
+                name = "new name",
+                targetFolder = "/some/folder",
+                targetId = "target-123",
+                baseTemplate = "template-base",
+                variableStructureRef = "ref",
+                internal = true,
+            )
+        )
+
+        repo.applyDisplayRuleMapping("ruleId")
+
+        verify {
+            displayRuleRepository.upsert(
+                match {
+                    it.id == "ruleId" &&
+                        it.name == "new name" &&
+                        it.targetFolder == "/some/folder" &&
+                        it.targetId == "target-123" &&
+                        it.baseTemplate == "template-base" &&
+                        it.internal &&
+                        it.variableStructureRef == VariableStructureRef("ref")
+                }
+            )
+        }
+    }
 }

migration-library/src/test/kotlin/com/quadient/migration/service/deploy/InteractiveDeployClientTest.kt

@@ -752,11 +752,22 @@ class InteractiveDeployClientTest {
             .internal(false)
             .build()
         mockDisplayRule(failedUpload)
+        val withTargetId = DisplayRuleBuilder("withTargetId")
+            .targetId("targetRule")
+            .internal(false)
+            .build()
+        mockDisplayRule(withTargetId)
+        val targetRule = DisplayRuleBuilder("targetRule")
+            .comparison { value("a").equals().value("b") }
+            .internal(false)
+            .build()
+        mockDisplayRule(targetRule)
         val block = mockObj(aDocObj("B_1", DocumentObjectType.Block, listOf(
             aParagraph(displayRuleRef = DisplayRuleRef(ruleWithFunction.id)),
             aParagraph(displayRuleRef = DisplayRuleRef(ruleWithInvalidMetadata.id)),
             aParagraph(displayRuleRef = DisplayRuleRef(validRule.id)),
             aParagraph(displayRuleRef = DisplayRuleRef(failedUpload.id)),
+            aParagraph(displayRuleRef = DisplayRuleRef(withTargetId.id)),
         )))
         val template = mockObj(aDocObj("T_1", DocumentObjectType.Template, listOf(aDocumentObjectRef(block.id))))
         mockBasicSuccessfulIpsOperations()
@@ -768,6 +779,7 @@ class InteractiveDeployClientTest {
         every { documentObjectRepository.list(any<Op<Boolean>>()) } returns listOf(template, block)
         every { ipsService.tryUpload("icm://Interactive/tenant/Rules/defaultFolder/valid.jrd", any()) } returns OperationResult.Success
         every { ipsService.tryUpload("icm://Interactive/tenant/Rules/defaultFolder/failed.jrd", any()) } returns OperationResult.Failure("oops")
+        every { ipsService.tryUpload("icm://Interactive/tenant/Rules/defaultFolder/targetRule.jrd", any()) } returns OperationResult.Success
 
         val result = subject.deployDocumentObjects()
 
@@ -781,6 +793,7 @@ class InteractiveDeployClientTest {
         ))
         result.deployed.shouldBeEqualTo(listOf(
             DeploymentInfo("valid", ResourceType.DisplayRule, "icm://Interactive/tenant/Rules/defaultFolder/valid.jrd"),
+            DeploymentInfo("targetRule", ResourceType.DisplayRule, "icm://Interactive/tenant/Rules/defaultFolder/targetRule.jrd"),
             DeploymentInfo("B_1", ResourceType.DocumentObject, "icm://B_1name"),
             DeploymentInfo("T_1", ResourceType.DocumentObject, "icm://T_1name")
         ))
@@ -845,6 +858,10 @@ class InteractiveDeployClientTest {
             null
         }
 
+        if (success) {
+            every { displayRuleRepository.findOrFail(displayRule.id) } returns displayRule
+        }
+
         return displayRule
     }