Merge pull request #68 from Cognifide/vlt-clean-edge-case

pun-ky · web-flow · commit 431138c7db9e · 2017-10-07T16:47:35.000+02:00
VLT clean edge case
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ buildscript {
     }
     
     dependencies {
-        classpath 'com.cognifide.gradle:aem-plugin:2.0.7'
+        classpath 'com.cognifide.gradle:aem-plugin:2.0.8'
     }
 }
 
diff --git a/build.gradle b/build.gradle
@@ -6,7 +6,7 @@ plugins {
 }
 
 group 'com.cognifide.gradle'
-version '2.0.8-SNAPSHOT'
+version '2.0.8'
 description = 'Gradle AEM Plugin'
 defaultTasks = ['clean', 'publishToMavenLocal']
 
diff --git a/src/main/kotlin/com/cognifide/gradle/aem/AemConfig.kt b/src/main/kotlin/com/cognifide/gradle/aem/AemConfig.kt
@@ -86,11 +86,11 @@ open class AemConfig(project: Project) : Serializable {
     var deployParallel: Boolean = false
 
     /**
-     * CRX package name conventions indicating that package can change over time while having
-     * same version specified.
+     * CRX package name conventions (with wildcard) indicating that package can change over time
+     * while having same version specified.
      */
     @Input
-    var deploySnapshots: List<String> = mutableListOf("**/*-SNAPSHOT.zip")
+    var deploySnapshots: List<String> = mutableListOf()
 
     /**
      * Force upload CRX package regardless if it was previously uploaded.
diff --git a/src/main/kotlin/com/cognifide/gradle/aem/instance/Instance.kt b/src/main/kotlin/com/cognifide/gradle/aem/instance/Instance.kt
@@ -64,17 +64,16 @@ interface Instance : Serializable {
         fun filter(project: Project, instanceFilter: String = FILTER_LOCAL): List<Instance> {
             val config = AemConfig.of(project)
             val instanceValues = project.properties[LIST_PROP] as String?
-            if (!instanceValues.isNullOrBlank()) {
-                return parse(instanceValues!!)
-            }
 
-            val instances = if (config.instances.values.isEmpty()) {
-                return defaults()
+            val instances = if (!instanceValues.isNullOrBlank()) {
+                parse(instanceValues!!)
+            } else if (!config.instances.values.isEmpty()) {
+                config.instances.values
             } else {
-                config.instances
+                defaults()
             }
 
-            return instances.values.filter { instance ->
+            return instances.filter { instance ->
                 PropertyParser(project).filter(instance.name, NAME_PROP, instanceFilter)
             }
         }
diff --git a/src/main/kotlin/com/cognifide/gradle/aem/internal/file/FileException.kt b/src/main/kotlin/com/cognifide/gradle/aem/internal/file/FileException.kt
@@ -2,7 +2,7 @@ package com.cognifide.gradle.aem.internal.file
 
 import com.cognifide.gradle.aem.AemException
 
-class DownloadException : AemException {
+class FileException : AemException {
 
     constructor(message: String, cause: Throwable) : super(message, cause)
 
diff --git a/src/main/kotlin/com/cognifide/gradle/aem/internal/file/FileResolver.kt b/src/main/kotlin/com/cognifide/gradle/aem/internal/file/FileResolver.kt
@@ -218,6 +218,10 @@ class FileResolver(val project: Project, val downloadDir: File) {
 
     @Synchronized
     fun group(name: String, configurer: Closure<*>) {
+        if (resolvers.any { it.group == name }) {
+            throw FileException("File group to be resolved named '$name' is already defined for download dir: $downloadDir")
+        }
+
         group = name
         ConfigureUtil.configureSelf(configurer, this)
         group = GROUP_DEFAULT
diff --git a/src/main/kotlin/com/cognifide/gradle/aem/internal/file/HttpFileDownloader.kt b/src/main/kotlin/com/cognifide/gradle/aem/internal/file/HttpFileDownloader.kt
@@ -49,7 +49,7 @@ class HttpFileDownloader(val project: Project) {
 
             downloader.download(response.entity.content, targetFile)
         } catch (e: Exception) {
-            throw DownloadException("Cannot download URL '$sourceUrl' to file '$targetFile' using HTTP(s). Check connection.", e)
+            throw FileException("Cannot download URL '$sourceUrl' to file '$targetFile' using HTTP(s). Check connection.", e)
         }
     }
 
diff --git a/src/main/kotlin/com/cognifide/gradle/aem/internal/file/SftpFileDownloader.kt b/src/main/kotlin/com/cognifide/gradle/aem/internal/file/SftpFileDownloader.kt
@@ -39,7 +39,7 @@ class SftpFileDownloader(val project: Project) {
                 downloader.download(input, targetFile)
             })
         } catch (e: Exception) {
-            throw DownloadException("Cannot download URL '$sourceUrl' to file '$targetFile' using SFTP. Check connection.", e)
+            throw FileException("Cannot download URL '$sourceUrl' to file '$targetFile' using SFTP. Check connection.", e)
         }
     }
 
diff --git a/src/main/kotlin/com/cognifide/gradle/aem/internal/file/SmbFileDownloader.kt b/src/main/kotlin/com/cognifide/gradle/aem/internal/file/SmbFileDownloader.kt
@@ -29,7 +29,7 @@ class SmbFileDownloader(val project: Project) {
 
             downloader.download(smbFile.inputStream, targetFile)
         } catch (e: Exception) {
-            throw DownloadException("Cannot download URL '$sourceUrl' to file '$targetFile' using SMB. Check connection.", e)
+            throw FileException("Cannot download URL '$sourceUrl' to file '$targetFile' using SMB. Check connection.", e)
         }
     }
 
diff --git a/src/main/kotlin/com/cognifide/gradle/aem/internal/file/UrlFileDownloader.kt b/src/main/kotlin/com/cognifide/gradle/aem/internal/file/UrlFileDownloader.kt
@@ -27,7 +27,7 @@ class UrlFileDownloader(val project: Project) {
 
             downloader.download(connection.getInputStream(), targetFile)
         } catch (e: Exception) {
-            throw DownloadException("Cannot download URL '$sourceUrl' to file '$targetFile'.", e)
+            throw FileException("Cannot download URL '$sourceUrl' to file '$targetFile'.", e)
         }
     }
 
diff --git a/src/main/kotlin/com/cognifide/gradle/aem/vlt/VltCleaner.kt b/src/main/kotlin/com/cognifide/gradle/aem/vlt/VltCleaner.kt
@@ -8,7 +8,6 @@ import org.apache.commons.lang3.StringUtils
 import org.gradle.api.logging.Logger
 import java.io.File
 import java.io.IOException
-import java.util.*
 
 class VltCleaner(val root: File, val logger: Logger) {
 
@@ -25,38 +24,45 @@ class VltCleaner(val root: File, val logger: Logger) {
         }
     }
 
-    fun cleanupDotContent(contentProperties: List<String>, lineEnding : String) {
+    fun cleanupDotContent(contentProperties: List<String>, lineEnding: String) {
         for (file in FileUtils.listFiles(root, NameFileFilter(JCR_CONTENT_FILE), TrueFileFilter.INSTANCE)) {
             try {
                 logger.info("Cleaning up {}", file.path)
 
-                val lines = ArrayList<String>()
-                for (line in FileUtils.readLines(file, CharEncoding.UTF_8)) {
-                    val cleanLine = StringUtils.trimToEmpty(line)
-                    val lineContains = lineContainsProperty(cleanLine, contentProperties)
-                    if (lineContains) {
-                        if (!cleanLine.endsWith(">")) {
-                        } else {
-                            val lastLine = lines.removeAt(lines.size - 1)
-                            lines.add(lastLine + ">")
-                        }
-
-                    } else {
-                        lines.add(line)
-                    }
-
-                }
+                val inputLines = FileUtils.readLines(file, CharEncoding.UTF_8)
+                val filteredLines = filterLines(inputLines, contentProperties)
 
-                FileUtils.writeLines(file, CharEncoding.UTF_8, lines, lineEnding)
+                FileUtils.writeLines(file, CharEncoding.UTF_8, filteredLines, lineEnding)
             } catch (e: IOException) {
                 throw VltException(String.format("Error opening %s", file.path), e)
             }
-
         }
     }
 
-    private fun lineContainsProperty(cleanLine: String, contentProperties: List<String>): Boolean {
-        return contentProperties.any { cleanLine.startsWith(it) }
+    private fun filterLines(lines: List<String>, contentProperties: List<String>): List<String> {
+        val result = mutableListOf<String>()
+
+        for (line in lines) {
+            val cleanLine = StringUtils.trimToEmpty(line)
+            if (contentProperties.any { cleanLine.startsWith(it) }) {
+                when {
+                    cleanLine.endsWith("/>") -> {
+                        result.add(result.removeAt(result.size - 1) + "/>")
+                    }
+                    cleanLine.endsWith(">") -> {
+                        result.add(result.removeAt(result.size - 1) + ">")
+                    }
+                    else -> {
+                        // skip line with property
+                    }
+                }
+            } else {
+                result.add(line)
+            }
+
+        }
+
+        return result
     }
 
 }
diff --git a/src/test/kotlin/com/cognifide/gradle/aem/vlt/NopLogger.kt b/src/test/kotlin/com/cognifide/gradle/aem/vlt/NopLogger.kt
@@ -0,0 +1,48 @@
+package com.cognifide.gradle.aem.vlt
+
+import org.gradle.api.logging.LogLevel
+import org.gradle.api.logging.Logger
+import org.slf4j.helpers.NOPLogger
+
+class NopLogger : NOPLogger(), Logger {
+
+    override fun isQuietEnabled(): Boolean {
+        return false
+    }
+
+    override fun log(level: LogLevel?, message: String?) {
+    }
+
+    override fun log(level: LogLevel?, message: String?, vararg objects: Any?) {
+    }
+
+    override fun log(level: LogLevel?, message: String?, throwable: Throwable?) {
+    }
+
+    override fun isEnabled(level: LogLevel?): Boolean {
+        return false
+    }
+
+    override fun lifecycle(message: String?) {
+    }
+
+    override fun lifecycle(message: String?, vararg objects: Any?) {
+    }
+
+    override fun lifecycle(message: String?, throwable: Throwable?) {
+    }
+
+    override fun quiet(message: String?) {
+    }
+
+    override fun quiet(message: String?, vararg objects: Any?) {
+    }
+
+    override fun quiet(message: String?, throwable: Throwable?) {
+    }
+
+    override fun isLifecycleEnabled(): Boolean {
+        return false
+    }
+
+}
diff --git a/src/test/kotlin/com/cognifide/gradle/aem/vlt/VltCleanerTest.kt b/src/test/kotlin/com/cognifide/gradle/aem/vlt/VltCleanerTest.kt
@@ -0,0 +1,46 @@
+package com.cognifide.gradle.aem.vlt
+
+import org.apache.commons.io.FileUtils
+import org.junit.Assert.assertEquals
+import org.junit.Rule
+import org.junit.Test
+import org.junit.rules.TemporaryFolder
+import java.io.File
+
+class VltCleanerTest {
+
+    @Rule
+    @JvmField
+    var tmpDir = TemporaryFolder()
+
+    @Test
+    fun shouldCleanupDotContentWithDefaultClosing() {
+        cleanUpDotContent("cleanupDotContent/defaultClosing")
+    }
+
+    @Test
+    fun shouldCleanupDotContentWithSelfClosing() {
+        cleanUpDotContent("cleanupDotContent/selfClosing")
+    }
+
+    private fun cleanUpDotContent(case: String) {
+        val expectedFile = File(javaClass.getResource("$case-expected.xml").toURI())
+        val sourceFile = File(javaClass.getResource("$case.xml").toURI())
+        val testedFile = File(tmpDir.newFolder(), ".content.xml")
+
+        FileUtils.copyFile(sourceFile, testedFile)
+        VltCleaner(testedFile.parentFile, NopLogger()).cleanupDotContent(listOf(
+                "jcr:lastModified",
+                "jcr:created",
+                "cq:lastModified",
+                "cq:lastReplicat*",
+                "jcr:uuid"
+        ), "\r\n")
+
+        val testedFileText = testedFile.bufferedReader().use { it.readText() }
+        val expectedFileText = expectedFile.bufferedReader().use { it.readText() }
+
+        assertEquals(expectedFileText, testedFileText)
+    }
+
+}
diff --git a/src/test/resources/com/cognifide/gradle/aem/vlt/cleanupDotContent/defaultClosing-expected.xml b/src/test/resources/com/cognifide/gradle/aem/vlt/cleanupDotContent/defaultClosing-expected.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:cq="http://www.day.com/jcr/cq/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:nt="http://www.jcp.org/jcr/nt/1.0"
+  jcr:primaryType="cq:Page">
+  <jcr:content
+    jcr:primaryType="cq:PageContent"
+    jcr:title="Sample Page"
+    sling:resourceType="zg/commons/renderers/base/contentSnippetRenderer">
+  </jcr:content>
+</jcr:root>
diff --git a/src/test/resources/com/cognifide/gradle/aem/vlt/cleanupDotContent/defaultClosing.xml b/src/test/resources/com/cognifide/gradle/aem/vlt/cleanupDotContent/defaultClosing.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:cq="http://www.day.com/jcr/cq/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:nt="http://www.jcp.org/jcr/nt/1.0"
+  jcr:primaryType="cq:Page">
+  <jcr:content
+    jcr:primaryType="cq:PageContent"
+    jcr:uuid="123e4567-e89b-12d3-a456-426655440000"
+    jcr:title="Sample Page"
+    sling:resourceType="zg/commons/renderers/base/contentSnippetRenderer"
+    cq:lastModifiedBy="foo">
+  </jcr:content>
+</jcr:root>
diff --git a/src/test/resources/com/cognifide/gradle/aem/vlt/cleanupDotContent/selfClosing-expected.xml b/src/test/resources/com/cognifide/gradle/aem/vlt/cleanupDotContent/selfClosing-expected.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:cq="http://www.day.com/jcr/cq/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:nt="http://www.jcp.org/jcr/nt/1.0"
+  jcr:primaryType="cq:Page">
+  <jcr:content
+    jcr:primaryType="cq:PageContent"
+    jcr:title="Sample Page"
+    sling:resourceType="zg/commons/renderers/base/contentSnippetRenderer"/>
+</jcr:root>
diff --git a/src/test/resources/com/cognifide/gradle/aem/vlt/cleanupDotContent/selfClosing.xml b/src/test/resources/com/cognifide/gradle/aem/vlt/cleanupDotContent/selfClosing.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:cq="http://www.day.com/jcr/cq/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:nt="http://www.jcp.org/jcr/nt/1.0"
+  jcr:primaryType="cq:Page">
+  <jcr:content
+    jcr:primaryType="cq:PageContent"
+    jcr:uuid="123e4567-e89b-12d3-a456-426655440000"
+    jcr:title="Sample Page"
+    sling:resourceType="zg/commons/renderers/base/contentSnippetRenderer"
+    cq:lastModifiedBy="foo"/>
+</jcr:root>

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ buildscript {`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`dependencies {`
`66`		`- classpath 'com.cognifide.gradle:aem-plugin:2.0.7'`
	`66`	`+ classpath 'com.cognifide.gradle:aem-plugin:2.0.8'`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ plugins {`
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`group 'com.cognifide.gradle'`
`9`		`-version '2.0.8-SNAPSHOT'`
	`9`	`+version '2.0.8'`
`10`	`10`	`description = 'Gradle AEM Plugin'`
`11`	`11`	`defaultTasks = ['clean', 'publishToMavenLocal']`
`12`	`12`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ class HttpFileDownloader(val project: Project) {`
`49`	`49`
`50`	`50`	`downloader.download(response.entity.content, targetFile)`
`51`	`51`	`} catch (e: Exception) {`
`52`		`- throw DownloadException("Cannot download URL '$sourceUrl' to file '$targetFile' using HTTP(s). Check connection.", e)`
	`52`	`+ throw FileException("Cannot download URL '$sourceUrl' to file '$targetFile' using HTTP(s). Check connection.", e)`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ class SftpFileDownloader(val project: Project) {`
`39`	`39`	`downloader.download(input, targetFile)`
`40`	`40`	`})`
`41`	`41`	`} catch (e: Exception) {`
`42`		`- throw DownloadException("Cannot download URL '$sourceUrl' to file '$targetFile' using SFTP. Check connection.", e)`
	`42`	`+ throw FileException("Cannot download URL '$sourceUrl' to file '$targetFile' using SFTP. Check connection.", e)`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class SmbFileDownloader(val project: Project) {`
`29`	`29`
`30`	`30`	`downloader.download(smbFile.inputStream, targetFile)`
`31`	`31`	`} catch (e: Exception) {`
`32`		`- throw DownloadException("Cannot download URL '$sourceUrl' to file '$targetFile' using SMB. Check connection.", e)`
	`32`	`+ throw FileException("Cannot download URL '$sourceUrl' to file '$targetFile' using SMB. Check connection.", e)`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ class UrlFileDownloader(val project: Project) {`
`27`	`27`
`28`	`28`	`downloader.download(connection.getInputStream(), targetFile)`
`29`	`29`	`} catch (e: Exception) {`
`30`		`- throw DownloadException("Cannot download URL '$sourceUrl' to file '$targetFile'.", e)`
	`30`	`+ throw FileException("Cannot download URL '$sourceUrl' to file '$targetFile'.", e)`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`