Merge pull request #147 from Cognifide/develop

Release 3.1.0

Author: pun-ky

README.md

@@ -115,7 +115,7 @@ buildscript {
     }
     
     dependencies {
-        classpath 'com.cognifide.gradle:aem-plugin:3.0.9'
+        classpath 'com.cognifide.gradle:aem-plugin:3.1.0'
     }
 }
 
@@ -145,6 +145,7 @@ aem {
         deployParallel = true
         deploySnapshots = []
         deployDistributed = false
+        deployTrustingAllSSLCertificates = true
         uploadForce = true
         uploadRetryTimes = 6
         uploadRetryDelay = 30000

build.gradle

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

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

@@ -70,14 +70,21 @@ class AemConfig(
      * will be performed (only if distributed deploy is enabled).
      */
     @Input
-    var deployInstanceAuthorName: String = propParser.string("aem.deploy.instance.author.name", "$deployEnvironment-${InstanceType.AUTHOR.type}")
+    var deployInstanceAuthorName: String = propParser.string("aem.deploy.instance.author.name", "$deployEnvironment-${InstanceType.AUTHOR}*")
 
     /**
      * Defines maximum time after which initializing connection to AEM will be aborted (e.g on upload, install).
      */
     @Input
     var deployConnectionTimeout: Int = propParser.int("aem.deploy.connectionTimeout", 5000)
 
+    /**
+     * Determines if connection to untrusted (e.g. self-signed) SSL certificates should be allowed.
+     * By default allows all SSL connections.
+     */
+    @Input
+    var deployConnectionUntrustedSsl: Boolean = propParser.boolean("aem.deploy.connectionUntrustedSsl", true)
+
     /**
      * Perform deploy action (upload, install or activate) in parallel to multiple instances at once.
      */
@@ -114,7 +121,7 @@ class AemConfig(
      */
     @Input
     var uploadRetryDelay: Long = propParser.long("aem.upload.retry.delay", TimeUnit.SECONDS.toMillis(30))
-    
+
     /**
      * Determines if when on package install, sub-packages included in CRX package content should be also installed.
      */
@@ -132,7 +139,7 @@ class AemConfig(
      */
     @Input
     var installRetryDelay: Long = propParser.long("aem.install.retry.delay", TimeUnit.SECONDS.toMillis(30))
-    
+
     /**
      * Defines behavior for access control handling included in rep:policy nodes being a part of CRX package content.
      *
@@ -304,13 +311,6 @@ class AemConfig(
     @Input
     var instanceFilesExpanded: MutableList<String> = mutableListOf("**/*.properties", "**/*.sh", "**/*.bat", "**/*.xml", "**/start", "**/stop")
 
-    /**
-     * Time in milliseconds to postpone instance stability checks to avoid race condition related with
-     * actual operation being performed on AEM like starting JCR package installation or even creating launchpad.
-     */
-    @Input
-    var awaitDelay: Long = propParser.long("aem.await.delay", TimeUnit.SECONDS.toMillis(1))
-
     /**
      * Time in milliseconds used as interval between next instance stability checks being performed.
      * Optimization could be necessary only when instance is heavily loaded.
@@ -340,9 +340,10 @@ class AemConfig(
 
     /**
      * Number of intervals / additional instance stability checks to assure all stable instances.
+     * This mechanism protect against temporary stable states.
      */
     @Input
-    var awaitAssurances: Long = propParser.long("aem.await.assurances", 3L)
+    var awaitAssurances: Long = propParser.long("aem.await.assurances", 5L)
 
     /**
      * Hook for customizing condition being an instance stability check.

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

@@ -1,13 +1,18 @@
 package com.cognifide.gradle.aem.api
 
+import com.cognifide.gradle.aem.internal.PropertyParser
 import org.gradle.api.DefaultTask
+import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.Nested
 
 abstract class AemDefaultTask : DefaultTask(), AemTask {
 
     @Nested
     final override val config = AemConfig.of(project)
 
+    @Internal
+    protected val propertyParser = PropertyParser(project)
+
     init {
         group = AemTask.GROUP
     }

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

@@ -28,10 +28,7 @@ open class CreateTask : SyncTask() {
 
         instanceFileResolver.attach(this)
         instanceFileFromProperties()
-
-        project.afterEvaluate {
-            synchronizeLocalInstances { outputs.file(it.lock) }
-        }
+        project.afterEvaluate { Instance.handles(project).forEach { outputs.file(it.lock) } }
     }
 
     private fun instanceFileFromProperties() {

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

@@ -110,6 +110,10 @@ interface Instance : Serializable {
             return filter(project, LocalInstance::class)
         }
 
+        fun handles(project: Project): List<LocalHandle> {
+            return Instance.locals(project).map { LocalHandle(project, it) }
+        }
+
         fun remotes(project: Project): List<RemoteInstance> {
             return filter(project, RemoteInstance::class)
         }

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

@@ -0,0 +1,7 @@
+package com.cognifide.gradle.aem.instance
+
+interface InstanceAction {
+
+    fun perform()
+
+}

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

@@ -33,6 +33,7 @@ class InstancePlugin : Plugin<Project> {
     private fun setupTasks(project: Project) {
         val clean = project.tasks.getByName(LifecycleBasePlugin.CLEAN_TASK_NAME)
 
+        val resolve = project.tasks.create(ResolveTask.NAME, ResolveTask::class.java)
         val create = project.tasks.create(CreateTask.NAME, CreateTask::class.java)
         val destroy = project.tasks.create(DestroyTask.NAME, DestroyTask::class.java)
         val up = project.tasks.create(UpTask.NAME, UpTask::class.java)
@@ -41,22 +42,23 @@ class InstancePlugin : Plugin<Project> {
         val satisfy = project.tasks.create(SatisfyTask.NAME, SatisfyTask::class.java)
         val await = project.tasks.create(AwaitTask.NAME, AwaitTask::class.java)
         val collect = project.tasks.create(CollectTask.NAME, CollectTask::class.java)
+        val setup = project.tasks.create(SetupTask.NAME, SetupTask::class.java)
 
         create.mustRunAfter(clean)
-        up.mustRunAfter(clean)
-        up.dependsOn(create)
+        up.dependsOn(create).mustRunAfter(clean)
+        reload.mustRunAfter(satisfy)
         destroy.mustRunAfter(down)
-        satisfy.mustRunAfter(create, up)
+        resolve.mustRunAfter(clean).shouldRunAfter(create)
+        satisfy.dependsOn(resolve).mustRunAfter(create, up)
         collect.mustRunAfter(satisfy)
+        setup.dependsOn(create, up, satisfy, await)
 
         project.plugins.withId(PackagePlugin.ID, {
-            val setup = project.tasks.create(SetupTask.NAME, SetupTask::class.java)
             val deploy = project.tasks.getByName(DeployTask.NAME)
 
-            setup.dependsOn(create, up, satisfy, deploy, await)
-
+            setup.dependsOn(deploy)
             deploy.mustRunAfter(create, up, satisfy)
-            reload.mustRunAfter(deploy, satisfy)
+            reload.mustRunAfter(deploy)
             await.mustRunAfter(deploy)
         })
 

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

@@ -6,15 +6,15 @@ import org.apache.commons.lang3.builder.HashCodeBuilder
 import org.apache.http.client.config.RequestConfig
 import org.gradle.api.Project
 
-class InstanceState(val project: Project, val instance: Instance) {
+class InstanceState(val project: Project, val instance: Instance, val timeout: Int) {
 
     val config = AemConfig.of(project)
 
     val bundleState by lazy {
         InstanceSync(project, instance).determineBundleState({ method ->
             method.config = RequestConfig.custom()
-                    .setConnectTimeout(config.awaitTimeout)
-                    .setSocketTimeout(config.awaitTimeout)
+                    .setConnectTimeout(timeout)
+                    .setSocketTimeout(timeout)
                     .build()
         })
     }

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

@@ -19,10 +19,13 @@ import org.apache.http.client.entity.UrlEncodedFormEntity
 import org.apache.http.client.methods.HttpGet
 import org.apache.http.client.methods.HttpPost
 import org.apache.http.client.methods.HttpRequestBase
+import org.apache.http.conn.ssl.NoopHostnameVerifier
+import org.apache.http.conn.ssl.SSLConnectionSocketFactory
 import org.apache.http.entity.mime.MultipartEntityBuilder
 import org.apache.http.impl.client.BasicCredentialsProvider
 import org.apache.http.impl.client.HttpClientBuilder
 import org.apache.http.message.BasicNameValuePair
+import org.apache.http.ssl.SSLContextBuilder
 import org.gradle.api.Project
 import org.jsoup.Jsoup
 import org.jsoup.parser.Parser
@@ -112,7 +115,7 @@ class InstanceSync(val project: Project, val instance: Instance) {
     }
 
     fun createHttpClient(): HttpClient {
-        return HttpClientBuilder.create()
+        val httpClientBuilder = HttpClientBuilder.create()
                 .addInterceptorFirst(PreemptiveAuthInterceptor())
                 .setDefaultRequestConfig(RequestConfig.custom()
                         .setConnectTimeout(config.deployConnectionTimeout)
@@ -122,7 +125,18 @@ class InstanceSync(val project: Project, val instance: Instance) {
                 .setDefaultCredentialsProvider(BasicCredentialsProvider().apply {
                     setCredentials(AuthScope.ANY, UsernamePasswordCredentials(instance.user, instance.password))
                 })
+        if (config.deployConnectionUntrustedSsl) {
+            httpClientBuilder.setSSLSocketFactory(createSslConnectionSocketFactory())
+        }
+
+        return httpClientBuilder.build()
+    }
+
+    private fun createSslConnectionSocketFactory(): SSLConnectionSocketFactory {
+        val sslContext = SSLContextBuilder()
+                .loadTrustMaterial(null, { _, _ -> true })
                 .build()
+        return SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE)
     }
 
     private fun createEntityUrlencoded(params: Map<String, Any>): HttpEntity {
@@ -316,26 +330,18 @@ class InstanceSync(val project: Project, val instance: Instance) {
         }
     }
 
-    fun satisfyPackage(file: File, action: () -> Unit): Boolean {
-        val pkg = determineRemotePackage(file, config.satisfyRefreshing)
+    fun isSnapshot(file: File): Boolean {
+        return Patterns.wildcard(file, config.deploySnapshots)
+    }
 
-        return if (pkg == null) {
-            action()
-            true
+    fun deployPackage(file: File = determineLocalPackage(), distributed: Boolean) {
+        if (distributed) {
+            distributePackage(file)
         } else {
-            if (!pkg.installed || isSnapshot(file)) {
-                action()
-                true
-            } else {
-                false
-            }
+            deployPackage(file)
         }
     }
 
-    fun isSnapshot(file: File): Boolean {
-        return Patterns.wildcard(file, config.deploySnapshots)
-    }
-
     fun deployPackage(file: File = determineLocalPackage()): InstallResponse {
         return installPackage(uploadPackage(file).path)
     }
@@ -450,13 +456,13 @@ class InstanceSync(val project: Project, val instance: Instance) {
         }
     }
 
-    fun reload() {
+    fun reload(delay: Long = config.reloadDelay) {
         try {
             logger.info("Triggering instance(s) shutdown")
             postUrlencoded(vmStatUrl, mapOf("shutdown_type" to "Restart"))
 
             logger.info("Awaiting instance(s) shutdown")
-            Behaviors.waitFor(config.reloadDelay)
+            Behaviors.waitFor(delay)
         } catch (e: DeployException) {
             throw InstanceException("Cannot reload instance $instance", e)
         }