Maven in subdir (#937)

* Maven subdir support

* Disp align

* Validation

* Nesting with VCS ignore

* Bugfix

* Alignment

* Launcher cloud works

* Fix

* Cloud launcher works

* Regression fix

* Empty dir fix

Author: krystian-panek-vmltech

build.gradle.kts

@@ -60,7 +60,7 @@ dependencies {
     detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:1.21.0")
     testImplementation("org.junit.jupiter:junit-jupiter:5.8.2")
 
-    implementation("com.cognifide.gradle:common-plugin:1.1.14")
+    implementation("com.cognifide.gradle:common-plugin:1.1.15")
 
     // External dependencies
     implementation("org.jsoup:jsoup:1.14.3")

docs/launcher.md

@@ -26,6 +26,21 @@ Moreover, to run GAP, it is needed to have a project which has at least Gradle W
 To eliminate such ceremony, GAP standalone launcher could be used to be able to use its features with minimal effort, anywhere.
 Simply, using e.g bash script - download the GAP launcher run it with regular GAP arguments - all tasks and properties are available to be used.
 
+## Compatibility
+
+| GAP Launcher | AEM Project Archetype |
+|--------------|-----------------------|
+| 16.0.1       | 39                    | 
+
+See also [plugin compatibility](../README.MD#compatibility).
+
+Note that GAP launcher is trying to scaffold AEM configuration that will work with both versions of AEM (OnPrem & Cloud).
+However, the changes made in the AEM archetype are being done independently by Adobe team. This requires that from time to time GAP Launcher need to be aligned to the changes made by Adobe. 
+
+**Contributions in this area are highly welcomed! :)**
+
+Simply saying - don't hesitate to make pull requests to make GAP Launcher compatible again when a new version of Adobe AEM Archetype is available or at least report an issue!
+
 ## Downloads
 
 Grab most recent version of launcher from GitHub [releases](https://github.com/Cognifide/gradle-aem-plugin/releases) section.

launcher/src/main/kotlin/com/cognifide/gradle/aem/launcher/BuildScaffolder.kt

@@ -1,18 +1,15 @@
 package com.cognifide.gradle.aem.launcher
 
-import java.io.File
 import java.util.Properties
 
 class BuildScaffolder(private val launcher: Launcher) {
 
     fun scaffold() {
         saveProperties()
         saveSettings()
-        saveRootBuildScript()
-        savePropertiesTemplate()
         when (aemVersion) {
             "cloud" -> EnvCloudScaffolder(launcher).scaffold()
-            null -> EnvScaffolder(launcher).scaffold()
+            null -> EnvInstanceOnlyScaffolder(launcher).scaffold()
             else -> EnvOnPremScaffolder(launcher).scaffold()
         }
     }
@@ -23,7 +20,7 @@ class BuildScaffolder(private val launcher: Launcher) {
         archetypePropertiesFile.inputStream().buffered().use { load(it) }
     } else null
 
-    private val archetypePropertiesFile get() = File("archetype.properties")
+    private val archetypePropertiesFile get() = launcher.appDir.resolve("archetype.properties")
 
     private fun saveProperties() = launcher.workFileOnce("gradle.properties") {
         println("Saving Gradle properties file '$this'")
@@ -43,198 +40,6 @@ class BuildScaffolder(private val launcher: Launcher) {
         .map { it.removePrefix(Launcher.ARG_SAVE_PREFIX) }
         .associate { it.substringBefore("=") to it.substringAfter("=") }
 
-    @Suppress("LongMethod")
-    private fun saveRootBuildScript() = launcher.workFileOnce("build.gradle.kts") {
-        println("Saving root Gradle build script file '$this'")
-        writeText(
-            """
-            import com.cognifide.gradle.aem.common.instance.local.OpenMode
-                
-            plugins {
-                id("io.wttech.config")
-                id("com.cognifide.aem.common")
-            }
-            
-            config {
-                define {
-                    labelAbbrs("aem")
-                    valueSaveGradleProperties()
-                
-                    group("instance") {
-                        prop("instanceType") {
-                            options("local", "remote")
-                            description("Local - instance will be created on local file system\nRemote - connecting to remote instance only")
-                        }
-                        prop("instanceAuthorHttpUrl") {
-                            default("http://localhost:4502")
-                            visible { boolValue("instanceAuthorEnabled") }
-                            optional()
-                        }
-                        prop("instanceAuthorEnabled") {
-                            checkbox(true)
-                        }
-                        prop("instancePublishHttpUrl") {
-                            default("http://localhost:4503")
-                            visible { boolValue("instancePublishEnabled") }
-                            optional()
-                        }
-                        prop("instancePublishEnabled") {
-                            checkbox(true)
-                        }
-                        prop("instancePassword") {
-                            default("admin")
-                            optional()
-                        }
-                        prop("instanceServiceCredentialsUri") {
-                            label("Service Credentials Uri")
-                            description("JSON file downloaded from AEMaaCS developer console")
-                            optional()
-                        }
-                        prop("localInstanceRunModes") {
-                            label("Run Modes")
-                            optional()
-                        }
-                        prop("localInstanceQuickstartDistUri") {
-                            label("AEM distribution URI")
-                            description("Typically AEM SDK zip file or AEM jar file")
-                        }
-                        prop("localInstanceQuickstartLicenseUri") {
-                            label("Quickstart License URI")
-                            description("Typically file named 'license.properties'")
-                        }
-                        prop("localInstanceSpUri") {
-                            description("Only for on-prem AEM instances. Typically file named 'aem-service-pkg-*.zip'")
-                            optional()
-                        }
-                        prop("localInstanceCoreComponentsUri") {
-                            description("Only for on-prem AEM instances. Typically file named 'core.wcm.components.all-*.zip'")
-                            optional()
-                        }
-                        prop("localInstanceOpenMode") {
-                            label("Open Automatically")
-                            description("Open web browser when instances are up.")
-                            options(OpenMode.values().map { it.name.toLowerCase() })
-                            default(OpenMode.ALWAYS.name.toLowerCase())
-                        }
-                    }
-                    group("build") {
-                        prop("mvnBuildProfiles") {
-                            default("fedDev")
-                            description("Comma delimited")
-                            optional()
-                        }
-                        prop("mvnBuildArgs") {
-                            description("Added extra")
-                            optional()
-                        }
-                    }
-                    group("deploy") {
-                        prop("packageDeployAvoidance") {
-                            label("Avoidance")
-                            description("Avoids uploading and installing package if identical is already deployed on instance.")
-                            checkbox(true)
-                        }
-                        prop("packageDamAssetToggle") {
-                            label("Toggle DAM Worklows")
-                            description("Turns on/off temporary disablement of assets processing for package deployment time.\n" +
-                                    "Useful to avoid redundant rendition generation when package contains renditions synchronized earlier.")
-                            checkbox(true)
-                        }
-                    }
-                    group("authorization") {
-                        prop("companyUser") {
-                            default(System.getProperty("user.name").orEmpty())
-                            description("For resolving AEM files from authorized URL")
-                            optional()
-                        }
-                        prop("companyPassword") {
-                            optional()
-                        }
-                        prop("companyDomain") {
-                            default(System.getenv("USERDOMAIN").orEmpty())
-                            description("For files resolved using SMB")
-                            optional()
-                        }
-                    }
-                
-                }
-            }
-            
-            if (config.captured) {
-                if (aem.mvnBuild.available) defaultTasks(":env:setup")
-                else defaultTasks(":env:instanceSetup")
-            }
-            
-            allprojects {
-                repositories {
-                    mavenCentral()
-                }
-            }
-            
-            aem {
-                mvnBuild {
-                    depGraph {
-                        // softRedundantModule("ui.content" to "ui.apps")
-                    }
-                    discover()
-                }
-            }
-            """.trimIndent()
-        )
-    }
-
-    private fun savePropertiesTemplate() = launcher.workFileOnce("gradle.properties.peb") {
-        println("Saving user-specific properties template '$this'")
-        writeText(
-            """
-            # === Gradle    
-            
-            org.gradle.logging.level=info
-            org.gradle.daemon=true
-            org.gradle.parallel=true
-            org.gradle.caching=true
-            org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 
-                
-            # === Gradle AEM Plugin ===
-            
-            package.manager.deployAvoidance={{ config.packageDeployAvoidance }}
-            {% if packageDamAssetToggle == 'true' %}
-            package.manager.workflowToggle=[dam_asset=false]
-            {% endif %}
-            
-            localInstance.quickstart.distUrl={{ config.localInstanceQuickstartDistUri }}
-            localInstance.quickstart.licenseUrl={{ config.localInstanceQuickstartLicenseUri }}
-            localInstance.openMode={{ config.localInstanceOpenMode }}
-            
-            localInstance.spUrl={{ config.localInstanceSpUri }}
-            localInstance.coreComponentsUrl={{ config.localInstanceCoreComponentsUri }}
-            
-            instance.default.runModes={{ config.localInstanceRunModes }}
-            instance.default.password={{ config.instancePassword }}
-            
-            instance.{{ config.instanceType }}-author.serviceCredentialsUrl={{ config.instanceServiceCredentialsUri }}
-            instance.{{ config.instanceType }}-author.enabled={{ config.instanceAuthorEnabled }}
-            instance.{{ config.instanceType }}-author.httpUrl={{ config.instanceAuthorHttpUrl }}
-            instance.{{ config.instanceType }}-author.openPath=/aem/start.html
-            instance.{{ config.instanceType }}-publish.enabled={{ config.instancePublishEnabled }}
-            instance.{{ config.instanceType }}-publish.httpUrl={{ config.instancePublishHttpUrl }}
-            instance.{{ config.instanceType }}-publish.openPath=/crx/packmgr
-
-            mvnBuild.args={{ config.mvnBuildArgs }}
-
-            # === Gradle Common Plugin ===
-            
-            javaSupport.version=11
-            
-            notifier.enabled=true
-            
-            fileTransfer.user={{ config.companyUser }}
-            fileTransfer.password={{ config.companyPassword }}
-            fileTransfer.domain={{ config.companyDomain }}
-            """.trimIndent()
-        )
-    }
-
     private fun saveSettings() = launcher.workFileOnce("settings.gradle.kts") {
         println("Saving Gradle settings file '$this'")
         writeText(