Merge pull request #281 from wttech/tools-upgrade

Tools upgrade

Author: krystian-panek-vmltech

README.md

@@ -138,31 +138,29 @@ Supported project types:
 
 ---
 
-Run command below to initialize the AEM Compose tool in your project:
+Run command below to install the AEM Compose tool in your project:
 
 ```shell
-curl https://raw.githubusercontent.com/wttech/aemc/main/project-init.sh | sh
+curl https://raw.githubusercontent.com/wttech/aemc/main/project-install.sh | sh
 ```
 
-and then:
-
-```shell
-sh aemw init
-```
-
-After successful initialization, remember to always use the tool via wrapper script in the following way:
+After successful installation, remember to always use the tool via wrapper script in the following way:
 
 ```shell
 sh aemw [command]
 ```
 
-For example:
+Next scaffold the AEM Compose files in the project:
 
 ```shell
-sh aemw version
+sh aemw project scaffold
 ```
 
-Project initialization sets up ready-to-use tasks powered by [Task tool](https://taskfile.dev/) which are aggregating one or many AEM Compose CLI commands into useful procedures.
+Project scaffolding:
+
+- sets up ready-to-use tasks powered by [Task tool](https://taskfile.dev/), which aggregate one or many AEM Compose CLI commands into useful procedures.
+- provides configuration for provisioning AEM instances (installing service pack, setting replication agents, etc.).
+- provides configuration for running AEM Dispatcher on [Podman](https://podman-desktop.io/) or [Docker](https://www.docker.com/products/docker-desktop/).
 
 To list all available tasks, run:
 
@@ -176,19 +174,6 @@ For example:
 sh taskw setup
 ```
 
-Some tasks like `aem:build` may accept parameters.
-For example, to build AEM application with:
-
-- Applying frontend development mode Maven profile
-- Unit tests skipping 
-- UI tests skipping
-
-Simply run command with appending [task variable](https://taskfile.dev/usage/#variables) to the end:
-
-```shell
-sh taskw aem:build AEM_BUILD_ARGS="-PfedDev -DskipTests -pl '!ui.tests'"
-```
-
 ## IaaC Providers
 
 The tool is designed to be used in Infrastructure as a Code (IaaC) solutions such as [Terraform](https://www.terraform.io/) or [Pulumi](https://www.pulumi.com/).
@@ -378,7 +363,7 @@ instance:
 
     # Oak Run tool options (offline instance management)
     oak_run:
-      download_url: "https://repo1.maven.org/maven2/org/apache/jackrabbit/oak-run/1.44.0/oak-run-1.44.0.jar"
+      download_url: "https://repo1.maven.org/maven2/org/apache/jackrabbit/oak-run/1.72.0/oak-run-1.72.0.jar"
       store_path: "crx-quickstart/repository/segmentstore"
 
     # Source files
@@ -458,7 +443,7 @@ java:
   # Auto-installed JDK options
   download:
     # Source URL with template vars support
-    url: "https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.18%2B10/OpenJDK11U-jdk_[[.Arch]]_[[.Os]]_hotspot_11.0.18_10.[[.ArchiveExt]]"
+    url: "https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.25%2B9/OpenJDK11U-jdk_[[.Arch]]_[[.Os]]_hotspot_11.0.25_9.[[.ArchiveExt]]"
     # Map source URL template vars to be compatible with Adoptium Java
     replacements:
       # Var 'Os' (GOOS)
@@ -471,9 +456,6 @@ java:
       "arm64": "x64"
       "aarch64": "x64"
 
-vault:
-  "download_url": "https://repo1.maven.org/maven2/org/apache/jackrabbit/vault/vault-cli/3.7.2/vault-cli-3.7.2-bin.tar.gz"
-
 base:
   # Location of temporary files (downloaded AEM packages, etc)
   tmp_dir: aem/home/tmp

cmd/aem/crypto.go

@@ -3,7 +3,6 @@ package main
 import (
 	"github.com/spf13/cobra"
 	"github.com/wttech/aemc/pkg"
-	"github.com/wttech/aemc/pkg/common"
 	"github.com/wttech/aemc/pkg/common/mapsx"
 )
 
@@ -59,8 +58,9 @@ func (c *CLI) cryptoSetupCmd() *cobra.Command {
 			}
 		},
 	}
-	cmd.Flags().String("hmac-file", common.LibDir+"/crypto/data/hmac", "Path to file 'hmac'")
-	cmd.Flags().String("master-file", common.LibDir+"/crypto/data/master", "Path to file 'master'")
+	libDir := c.config.Values().GetString("base.lib_dir")
+	cmd.Flags().String("hmac-file", libDir+"/crypto/data/hmac", "Path to file 'hmac'")
+	cmd.Flags().String("master-file", libDir+"/crypto/data/master", "Path to file 'master'")
 	return cmd
 }
 

cmd/aem/instance.go

@@ -23,7 +23,6 @@ func (c *CLI) instanceCmd() *cobra.Command {
 	cmd.AddCommand(c.instanceListCmd())
 	cmd.AddCommand(c.instanceAwaitCmd())
 	cmd.AddCommand(c.instanceBackupCmd())
-	cmd.AddCommand(c.instanceInitCmd())
 	cmd.AddCommand(c.instanceImportCmd())
 	return cmd
 }
@@ -334,34 +333,3 @@ func (c *CLI) instanceListCmd() *cobra.Command {
 		},
 	}
 }
-
-func (c *CLI) instanceInitCmd() *cobra.Command {
-	return &cobra.Command{
-		Use:     "init",
-		Aliases: []string{"initialize"},
-		Short:   "Init prerequisites for AEM instance(s)",
-		Run: func(cmd *cobra.Command, args []string) {
-			if err := c.aem.InstanceManager().LocalOpts.Initialize(); err != nil {
-				c.Error(err)
-				return
-			}
-
-			javaHome, err := c.aem.JavaOpts().FindHomeDir()
-			if err != nil {
-				c.Error(err)
-				return
-			}
-			c.SetOutput("javaHome", javaHome)
-
-			javaExecutable, err := c.aem.JavaOpts().Executable()
-			if err != nil {
-				c.Error(err)
-				return
-			}
-			c.SetOutput("javaExecutable", javaExecutable)
-
-			c.SetOutput("initialized", true)
-			c.Changed("initialized prerequisites for instance(s)")
-		},
-	}
-}

cmd/aem/project.go

@@ -7,18 +7,26 @@ import (
 	"strings"
 )
 
+func (c *CLI) projectCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "project",
+		Short:   "Manage project files",
+		Aliases: []string{"prj"},
+	}
+	cmd.AddCommand(c.projectInitCmd())
+	cmd.AddCommand(c.projectScaffoldCmd())
+
+	return cmd
+}
+
 const projectKindFlag = "project-kind"
 
-func (c *CLI) initCmd() *cobra.Command {
+func (c *CLI) projectScaffoldCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "init",
-		Aliases: []string{"initialize"},
-		Short:   "Initializes AEMC in the project",
+		Use:     "scaffold",
+		Aliases: []string{"setup"},
+		Short:   "Scaffold required files in the project",
 		Run: func(cmd *cobra.Command, args []string) {
-			if err := c.aem.Project().EnsureDirs(); err != nil {
-				c.Error(err)
-				return
-			}
 			kindName, _ := cmd.Flags().GetString(projectKindFlag)
 			kind, err := c.aem.Project().KindDetermine(kindName)
 			if err != nil {
@@ -29,24 +37,72 @@ func (c *CLI) initCmd() *cobra.Command {
 				c.Fail(fmt.Sprintf("project kind cannot be determined; specify it with flag '--%s=[%s]'", projectKindFlag, strings.Join(project.KindStrings(), "|")))
 				return
 			}
-			changed, err := c.aem.Project().InitializeWithChanged(kind)
+
+			changed, err := c.aem.Project().ScaffoldWithChanged(kind)
+			if err != nil {
+				c.Error(err)
+				return
+			}
+
+			c.SetOutput("gettingStarted", c.aem.Project().ScaffoldGettingStarted())
+
+			if changed {
+				c.Changed("project files scaffolded")
+			} else {
+				c.Ok("project files already scaffolded")
+			}
+		},
+	}
+	cmd.Flags().String(projectKindFlag, project.KindAuto, fmt.Sprintf("Type of AEM to work with (%s)", strings.Join(project.KindStrings(), "|")))
+	return cmd
+}
+
+func (c *CLI) projectInitCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "init",
+		Aliases: []string{"initialize"},
+		Short:   "Initializes AEMC in the project",
+		Run: func(cmd *cobra.Command, args []string) {
+			if !c.aem.Project().IsScaffolded() {
+				c.Fail(fmt.Sprintf("project need to be scaffolded before running initialization"))
+				return
+			}
+
+			changed := false
+
+			c.SetOutput("gettingStarted", c.aem.Project().InitGettingStartedError())
+
+			baseChanged, err := c.aem.BaseOpts().PrepareWithChanged()
+			changed = changed || baseChanged
 			if err != nil {
 				c.Error(err)
 				return
 			}
-			gettingStarted, err := c.aem.Project().GettingStarted(kind)
+			c.SetOutput("baseChanged", baseChanged)
+
+			// Download and prepare vendor tools (including JDK and AEM SDK)
+			vendorPrepared, err := c.aem.VendorManager().PrepareWithChanged()
+			changed = changed || vendorPrepared
 			if err != nil {
 				c.Error(err)
 				return
 			}
-			c.SetOutput("gettingStarted", gettingStarted)
+			c.SetOutput("vendorPrepared", vendorPrepared)
+
+			// Validate AEM instance files and prepared SDK
+			if err := c.aem.InstanceManager().LocalOpts.Validate(); err != nil {
+				c.Error(err)
+				return
+			}
+
+			c.SetOutput("gettingStarted", c.aem.Project().InitGettingStartedSuccess())
+
 			if changed {
 				c.Changed("project initialized")
 			} else {
 				c.Ok("project already initialized")
 			}
 		},
 	}
-	cmd.Flags().String(projectKindFlag, project.KindAuto, fmt.Sprintf("Type of AEM to work with (%s)", strings.Join(project.KindStrings(), "|")))
 	return cmd
 }

cmd/aem/root.go

@@ -19,7 +19,8 @@ func (c *CLI) rootCmd() *cobra.Command {
 		},
 	}
 	cmd.AddCommand(c.versionCmd())
-	cmd.AddCommand(c.initCmd())
+	cmd.AddCommand(c.projectCmd())
+	cmd.AddCommand(c.vendorCmd())
 	cmd.AddCommand(c.configCmd())
 	cmd.AddCommand(c.instanceCmd())
 	cmd.AddCommand(c.osgiCmd())
@@ -33,8 +34,9 @@ func (c *CLI) rootCmd() *cobra.Command {
 	cmd.AddCommand(c.fileCmd())
 	cmd.AddCommand(c.authCmd())
 	cmd.AddCommand(c.contentCmd())
-	cmd.AddCommand(c.vaultCmd())
+
 	c.rootFlags(cmd)
+
 	return cmd
 }
 

cmd/aem/vault.go

@@ -0,0 +1,76 @@
+package main
+
+import (
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+	"os"
+)
+
+func (c *CLI) vendorCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "vendor",
+		Short:   "Supportive tools management",
+		Aliases: []string{"ven"},
+	}
+	cmd.AddCommand(c.vendorListCmd())
+	cmd.AddCommand(c.vendorPrepareCmd())
+
+	return cmd
+}
+
+func (c *CLI) vendorListCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "list",
+		Short:   "List vendor tools available",
+		Aliases: []string{"ls"},
+		Run: func(cmd *cobra.Command, args []string) {
+			verbose, _ := cmd.Flags().GetBool("verbose")
+
+			javaHome, err := c.aem.VendorManager().JavaManager().FindHomeDir()
+			if err != nil {
+				javaHome = os.Getenv("JAVA_HOME")
+				if verbose {
+					log.Warnf("java home not available: %s", err)
+				}
+			}
+			c.SetOutput("javaHome", javaHome)
+
+			javaExecutable, err := c.aem.VendorManager().JavaManager().Executable()
+			if err != nil {
+				if verbose {
+					log.Warnf("java executable not available: %s", err)
+				}
+			}
+			c.SetOutput("javaExecutable", javaExecutable)
+
+			oakRunJar := c.aem.VendorManager().OakRun().JarFile()
+			c.setOutput("oakRunJar", oakRunJar)
+
+			c.Ok("vendor tools listed")
+		},
+	}
+	cmd.Flags().BoolP("verbose", "v", false, "Log errors")
+	return cmd
+}
+
+func (c *CLI) vendorPrepareCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "prepare",
+		Short:   "Prepare vendor tools",
+		Aliases: []string{"prep", "download", "dw"},
+		Run: func(cmd *cobra.Command, args []string) {
+			changed, err := c.aem.VendorManager().PrepareWithChanged()
+			if err != nil {
+				c.Error(err)
+				return
+			}
+
+			if changed {
+				c.Changed("vendor tools prepared")
+			} else {
+				c.Ok("vendor tools already prepared")
+			}
+		},
+	}
+	return cmd
+}