Merge pull request #151 from Cognifide/instances-dsl

Instances DSL

Author: pun-ky

README.md

@@ -115,7 +115,7 @@ buildscript {
     }
     
     dependencies {
-        classpath 'com.cognifide.gradle:aem-plugin:3.1.0'
+        classpath 'com.cognifide.gradle:aem-plugin:3.1.1'
     }
 }
 
@@ -501,7 +501,7 @@ allprojects { subproject ->
   plugins.withId 'com.cognifide.aem.base', {
     aem {
         config {
-          localInstance("http://localhost:6502")
+          localInstance "http://localhost:6502"
           contentPath = subproject.file("src/main/aem")
         }
     }
@@ -539,29 +539,62 @@ In AEM configuration section, there is possibility to use `localInstance` or `re
 ```groovy
 aem {
     config {
-      localAuthorInstance() // property: aem.instance.author.httpUrl or default 'http://localhost:4502' ; local-author
-      localPublishInstance() // property: aem.instance.author.httpUrl or default 'http://localhost:4502' ; local-publish
+        localAuthorInstance() // property: aem.instance.author.httpUrl or default 'http://localhost:4502' ; local-author
+        localPublishInstance() // property: aem.instance.author.httpUrl or default 'http://localhost:4502' ; local-publish
     
-      localInstance("http://localhost:4502") // local-author
-      localInstance("http://localhost:4502", "admin", "admin", "author", 14502) // local-author
+        localInstance "http://localhost:4502" // local-author
+        localInstance "http://localhost:4502", { // local-author
+            user = "admin"
+            password = "admin"
+            typeName = "author"
+            debugPort = 14502 
+        }
       
-      localInstance("http://localhost:4503") // local-publish
-      localInstance("http://localhost:4503", "admin", "admin", "publish", 14502) // local-publish
+        localInstance "http://localhost:4503" // local-publish
+        localInstance "http://localhost:4503", { // local-publish
+            user = "admin"
+            password = "admin"
+            typeName = "publish"
+            debugPort = 14502
+        } 
       
-      remoteAuthorInstance() // property: aem.instance.author.httpUrl or default 'http://localhost:4502' ; local-author
-      remotePublishInstance() // property: aem.instance.author.httpUrl or default 'http://localhost:4502' ; local-publish
+        remoteAuthorInstance() // property: aem.instance.author.httpUrl or default 'http://localhost:4502' ; local-author
+        remotePublishInstance() // property: aem.instance.author.httpUrl or default 'http://localhost:4502' ; local-publish
       
-      remoteInstance("http://192.168.10.1:4502", "user1", "password2", "integration") // integration-author
-      remoteInstance("http://192.168.10.2:4503", "user2", "password2", "integration") // integration-publish
+        remoteInstance "http://192.168.10.1:4502", { // integration-author1
+            user = "user1" 
+            password = "password2"
+            environment = "integration"
+            typeName = "author1"
+        } 
+        remoteInstance "http://192.168.10.1:8080", { // integration-author2
+            user = "user1" 
+            password = "password2"
+            environment = "integration"
+            typeName = "author2
+        } 
+        remoteInstance "http://192.168.10.2:4503", { // integration-publish1
+            user = "user2"
+            password = "password2"
+            environment = "integration"
+            typeName = "publish1"
+        } 
+        remoteInstance "http://192.168.10.2:8080", { // integration-publish2
+            user = "user2"
+            password = "password2"
+            environment = "integration"
+            typeName = "publish2"
+        } 
     }
 }
 ```
 
-Rules:
+**Rules:**
 
-* Instance name is a combination of `${environment}-${type}` e.g *local-author*, *integration-publish* etc.
+* Instance name is a combination of *${environment}-${typeName}* e.g *local-author*, *integration-publish* etc.
+* Instance type name must start with prefix *author* or *publish*. Sample valid names: *author*, *author1*, *author2*, *author-master* and *publish*, *publish1* *publish2* etc.
 * Only instances being defined as *local* are being considered in command `aemSetup`, `aemCreate`, `aemUp` etc (that comes from `com.cognifide.aem.instance` plugin).
-* All instances being defined as *local* or *remote* are being considered in commands CRX package deployment related like `aemDeploy`, `aemUpload`, `aemInstall` etc.
+* All instances being defined as *local* or *remote* are being considered in commands CRX package deployment related like `aemSatisfy`, `aemDeploy`, `aemUpload`, `aemInstall` etc.
 
 ### Understand why there are one or two plugins to be applied in build script
 

build.gradle

@@ -6,7 +6,7 @@ plugins {
 }
 
 group 'com.cognifide.gradle'
-version '3.1.0'
+version '3.1.1'
 description = 'Gradle AEM Plugin'
 defaultTasks = ['clean', 'build', 'publishToMavenLocal']
 

src/main/kotlin/com/cognifide/gradle/aem/api/AemConfig.kt

@@ -7,11 +7,13 @@ import com.cognifide.gradle.aem.internal.PropertyParser
 import com.cognifide.gradle.aem.pkg.ComposeTask
 import com.cognifide.gradle.aem.pkg.PackagePlugin
 import com.fasterxml.jackson.annotation.JsonIgnore
+import groovy.lang.Closure
 import org.gradle.api.DefaultTask
 import org.gradle.api.Project
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.Internal
 import org.gradle.language.base.plugins.LifecycleBasePlugin
+import org.gradle.util.ConfigureUtil
 import java.io.File
 import java.io.Serializable
 import java.util.*
@@ -421,63 +423,82 @@ class AemConfig(
         instance(LocalInstance.create(httpUrl))
     }
 
-    fun localInstance(httpUrl: String, type: String) {
-        instance(LocalInstance.create(httpUrl, type))
+    fun localInstance(httpUrl: String, configurer: LocalInstance.() -> Unit) {
+        instance(LocalInstance.create(httpUrl, configurer))
     }
 
-    fun localInstance(httpUrl: String, user: String, password: String) {
-        instance(LocalInstance.create(httpUrl, user, password))
+    fun localInstance(httpUrl: String, configurer: Closure<*>) {
+        localInstance(httpUrl, { ConfigureUtil.configure(configurer, this) })
     }
 
-    fun localInstance(httpUrl: String, user: String, password: String, type: String) {
-        instance(LocalInstance.create(httpUrl, user, password, type))
+    fun localAuthorInstance() {
+        localAuthorInstance({})
     }
 
-    fun localInstance(httpUrl: String, user: String, password: String, type: String, debugPort: Int) {
-        instance(LocalInstance(httpUrl, user, password, type, debugPort))
+    fun localAuthorInstance(configurer: LocalInstance.() -> Unit) {
+        localInstance(propParser.string(Instance.AUTHOR_URL_PROP, Instance.URL_AUTHOR_DEFAULT), configurer)
     }
 
-    fun localAuthorInstance() {
-        val httpUrl = propParser.string(Instance.AUTHOR_URL_PROP, Instance.URL_AUTHOR_DEFAULT)
-        instance(LocalInstance.create(httpUrl))
+    fun localAuthorInstance(configurer: Closure<*>) {
+        localAuthorInstance({ ConfigureUtil.configure(configurer, this) })
     }
 
     fun localPublishInstance() {
-        val httpUrl = propParser.string(Instance.PUBLISH_URL_PROP, Instance.URL_PUBLISH_DEFAULT)
-        instance(LocalInstance.create(httpUrl))
+        localPublishInstance({})
     }
 
-    fun remoteInstance(httpUrl: String) {
-        instance(RemoteInstance.create(httpUrl, deployEnvironment))
+    fun localPublishInstance(configurer: LocalInstance.() -> Unit) {
+        localInstance(propParser.string(Instance.PUBLISH_URL_PROP, Instance.URL_PUBLISH_DEFAULT), configurer)
     }
 
-    fun remoteInstance(httpUrl: String, environment: String) {
-        instance(RemoteInstance.create(httpUrl, environment))
+    fun localPublishInstance(configurer: Closure<*>) {
+        localPublishInstance({ ConfigureUtil.configure(configurer, this) })
     }
 
-    fun remoteInstance(httpUrl: String, user: String, password: String) {
-        instance(RemoteInstance.create(httpUrl, user, password, deployEnvironment))
+    fun remoteInstance(httpUrl: String) {
+        instance(RemoteInstance.create(httpUrl))
     }
 
-    fun remoteInstance(httpUrl: String, user: String, password: String, environment: String) {
-        instance(RemoteInstance.create(httpUrl, user, password, environment))
+    fun remoteInstance(httpUrl: String, configurer: RemoteInstance.() -> Unit) {
+        instance(RemoteInstance.create(httpUrl, {
+            this.environment = deployEnvironment
+            this.apply(configurer)
+        }))
     }
 
-    fun remoteInstance(httpUrl: String, user: String, password: String, type: String, environment: String) {
-        instance(RemoteInstance(httpUrl, user, password, type, environment))
+    fun remoteInstance(httpUrl: String, configurer: Closure<*>) {
+        remoteInstance(httpUrl, { ConfigureUtil.configure(configurer, this) })
     }
 
     fun remoteAuthorInstance() {
-        val httpUrl = propParser.string(Instance.AUTHOR_URL_PROP, Instance.URL_AUTHOR_DEFAULT)
-        instance(RemoteInstance.create(httpUrl, deployEnvironment))
+        remoteAuthorInstance({})
+    }
+
+    fun remoteAuthorInstance(configurer: RemoteInstance.() -> Unit) {
+        remoteInstance(propParser.string(Instance.AUTHOR_URL_PROP, Instance.URL_AUTHOR_DEFAULT), configurer)
+    }
+
+    fun remoteAuthorInstance(configurer: Closure<*>) {
+        remoteAuthorInstance({ ConfigureUtil.configure(configurer, this) })
     }
 
     fun remotePublishInstance() {
-        val httpUrl = propParser.string(Instance.PUBLISH_URL_PROP, Instance.URL_PUBLISH_DEFAULT)
-        instance(RemoteInstance.create(httpUrl, deployEnvironment))
+        remotePublishInstance({})
+    }
+
+    fun remotePublishInstance(configurer: RemoteInstance.() -> Unit) {
+        remoteInstance(propParser.string(Instance.PUBLISH_URL_PROP, Instance.URL_PUBLISH_DEFAULT), configurer)
+    }
+
+    fun remotePublishInstance(configurer: Closure<*>) {
+        remotePublishInstance({ ConfigureUtil.configure(configurer, this) })
     }
 
     private fun instance(instance: Instance) {
+        if (instances.containsKey(instance.name)) {
+            throw AemException("Instance named '${instance.name}' is already defined. Enumerate instance types (for instance 'author1', 'author2') or distinguish environments.")
+        }
+
         instances[instance.name] = instance
     }
 
@@ -552,6 +573,90 @@ class AemConfig(
     @Internal
     fun isUniqueProjectName() = project == project.rootProject || project.name == project.rootProject.name
 
+    /**
+     * @Deprecated Will be removed in 4.0.0
+     */
+    fun localInstance(httpUrl: String, typeName: String) {
+        localInstance(httpUrl, {
+            this.typeName = typeName
+        })
+    }
+
+    /**
+     * @Deprecated Will be removed in 4.0.0
+     */
+    fun localInstance(httpUrl: String, user: String, password: String) {
+        localInstance(httpUrl, {
+            this.user = user
+            this.password = password
+        })
+    }
+
+    /**
+     * @Deprecated Will be removed in 4.0.0
+     */
+    fun localInstance(httpUrl: String, user: String, password: String, typeName: String) {
+        localInstance(httpUrl, {
+            this.user = user
+            this.password = password
+            this.typeName = typeName
+        })
+    }
+
+    /**
+     * @Deprecated Will be removed in 4.0.0
+     */
+    fun localInstance(httpUrl: String, user: String, password: String, type: String, debugPort: Int) {
+        localInstance(httpUrl, {
+            this.user = user
+            this.password = password
+            this.typeName = type
+            this.debugPort = debugPort
+        })
+    }
+
+    /**
+     * @Deprecated Will be removed in 4.0.0
+     */
+    fun remoteInstance(httpUrl: String, environment: String) {
+        remoteInstance(httpUrl, {
+            this.environment = environment
+        })
+    }
+
+    /**
+     * @Deprecated Will be removed in 4.0.0
+     */
+    fun remoteInstance(httpUrl: String, user: String, password: String) {
+        remoteInstance(httpUrl, {
+            this.user = user
+            this.password = password
+        })
+    }
+
+    /**
+     * @Deprecated Will be removed in 4.0.0
+     */
+    fun remoteInstance(httpUrl: String, user: String, password: String, environment: String) {
+        remoteInstance(httpUrl, {
+            this.user = user
+            this.password = password
+            this.environment = environment
+        })
+    }
+
+    /**
+     * @Deprecated Will be removed in 4.0.0
+     */
+    fun remoteInstance(httpUrl: String, user: String, password: String, typeName: String, environment: String) {
+        remoteInstance(httpUrl, {
+            this.user = user
+            this.password = password
+            this.typeName = typeName
+            this.environment = environment
+        })
+    }
+
     companion object {
 
         /**

src/main/kotlin/com/cognifide/gradle/aem/instance/Instance.kt

@@ -43,16 +43,22 @@ interface Instance : Serializable {
                     4 -> {
                         val (httpUrl, type, user, password) = parts
 
-                        RemoteInstance(httpUrl, user, password, type, ENVIRONMENT_CMD)
+                        RemoteInstance.create(httpUrl, {
+                            this.user = user
+                            this.password = password
+                            this.typeName = type
+                        })
                     }
                     3 -> {
                         val (httpUrl, user, password) = parts
-                        val type = InstanceType.nameByUrl(httpUrl)
 
-                        RemoteInstance(httpUrl, user, password, type, ENVIRONMENT_CMD)
+                        RemoteInstance.create(httpUrl, {
+                            this.user = user
+                            this.password = password
+                        })
                     }
                     else -> {
-                        RemoteInstance.create(urlRaw, ENVIRONMENT_CMD)
+                        RemoteInstance.create(urlRaw)
                     }
                 }
             }
@@ -64,8 +70,8 @@ interface Instance : Serializable {
             val publishUrl = project.properties.getOrElse(PUBLISH_URL_PROP, { URL_PUBLISH_DEFAULT }) as String
 
             return listOf(
-                    RemoteInstance.create(authorUrl, config.deployEnvironment),
-                    RemoteInstance.create(publishUrl, config.deployEnvironment)
+                    RemoteInstance.create(authorUrl, { environment = config.deployEnvironment }),
+                    RemoteInstance.create(publishUrl, { environment = config.deployEnvironment })
             )
         }
 

src/main/kotlin/com/cognifide/gradle/aem/instance/InstanceType.kt

@@ -12,7 +12,7 @@ enum class InstanceType {
         private val AUTHOR_RULES = listOf("*02")
 
         fun byName(type: String): InstanceType {
-            return values().find { it.name.startsWith(type, true) }
+            return values().find { type.startsWith(it.name, ignoreCase = true)  }
                     ?: throw AemException("Invalid instance type: $type")
         }
 

src/main/kotlin/com/cognifide/gradle/aem/instance/InstanceUrl.kt

@@ -17,9 +17,15 @@ class InstanceUrl(raw: String) {
     val httpUrl: String
         get() = "${config.protocol}://${config.host}:${config.port}"
 
-    val type: String
+    val typeName: String
         get() = InstanceType.nameByUrl(httpUrl)
 
+    val type: InstanceType
+        get() = InstanceType.byUrl(httpUrl)
+
+    val debugPort: Int
+        get() = "1${Instance.portOfUrl(httpUrl)}".toInt()
+
     private fun userPart(index: Int): String? {
         return config.userInfo?.split(":")
                 ?.takeIf { it.size == 2 }