Merge pull request #321 from wttech/sdk-os-configurable

SDK OS configurable

Author: krystian-panek-vmltech

cmd/aem/vendor.go

@@ -14,6 +14,7 @@ func (c *CLI) vendorCmd() *cobra.Command {
 	}
 	cmd.AddCommand(c.vendorListCmd())
 	cmd.AddCommand(c.vendorPrepareCmd())
+	cmd.AddCommand(c.vendorCleanCmd())
 
 	return cmd
 }
@@ -74,3 +75,24 @@ func (c *CLI) vendorPrepareCmd() *cobra.Command {
 	}
 	return cmd
 }
+
+func (c *CLI) vendorCleanCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "clean",
+		Short:   "Clean vendor tools",
+		Aliases: []string{"cl"},
+		Run: func(cmd *cobra.Command, args []string) {
+			changed, err := c.aem.VendorManager().CleanWithChanged()
+			if err != nil {
+				c.Error(err)
+				return
+			}
+			if changed {
+				c.Changed("vendor tools cleaned")
+			} else {
+				c.Ok("vendor tools already cleaned")
+			}
+		},
+	}
+	return cmd
+}

examples/docker/src/aem/default/etc/aem.yml

@@ -241,6 +241,11 @@ vendor:
     # AEM License properties file
     license_file: "aem/home/lib/license.properties"
 
+  # AEM SDK source files
+  sdk:
+    # Controls which distribution of dispatcher is unpacked (auto|unix|windows)
+    os: auto
+
   # JDK used to: run AEM instances, build OSGi bundles, assemble AEM packages
   java:
     # Require following versions before e.g running AEM instances

pkg/cfg/defaults.go

@@ -7,6 +7,7 @@ import (
 	"github.com/wttech/aemc/pkg/common/fmtx"
 	"github.com/wttech/aemc/pkg/instance"
 	"github.com/wttech/aemc/pkg/pkg"
+	"github.com/wttech/aemc/pkg/sdk"
 	"time"
 )
 
@@ -36,6 +37,8 @@ func (c *Config) setDefaults() {
 	v.SetDefault("vendor.quickstart.dist_file", common.QuickstartDistFile)
 	v.SetDefault("vendor.quickstart.license_file", common.QuickstartLicenseFile)
 
+	v.SetDefault("vendor.sdk.os", sdk.OSAuto)
+
 	v.SetDefault("vendor.java.home_dir", "")
 	v.SetDefault("vendor.java.version_constraints", []string{"=> 1.8, < 1.9", "=> 11, < 12", ">= 17, < 18", "=> 21, < 22"})
 	v.SetDefault("vendor.java.download.url", c.tplString("https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.25%2B9/OpenJDK11U-jdk_[[.Arch]]_[[.Os]]_hotspot_11.0.25_9.[[.ArchiveExt]]"))

pkg/project/app_classic/aem/default/etc/aem.yml

@@ -243,6 +243,11 @@ vendor:
     # AEM License properties file
     license_file: "aem/home/lib/license.properties"
 
+  # AEM SDK source files
+  sdk:
+    # Controls which distribution of dispatcher is unpacked (auto|unix|windows)
+    os: auto
+
   # JDK used to: run AEM instances, build OSGi bundles, assemble AEM packages
   java:
     # Require following versions before e.g running AEM instances

pkg/project/app_cloud/aem/default/etc/aem.yml

@@ -243,6 +243,11 @@ vendor:
     # AEM License properties file
     license_file: "aem/home/lib/license.properties"
 
+  # AEM SDK source files
+  sdk:
+    # Controls which distribution of dispatcher is unpacked (auto|unix|windows)
+    os: auto
+
   # JDK used to: run AEM instances, build OSGi bundles, assemble AEM packages
   java:
     # Require following versions before e.g running AEM instances

pkg/project/instance/aem/default/etc/aem.yml

@@ -238,6 +238,11 @@ vendor:
     # AEM License properties file
     license_file: "aem/home/lib/license.properties"
 
+  # AEM SDK source files
+  sdk:
+    # Controls which distribution of dispatcher is unpacked (auto|unix|windows)
+    os: auto
+
   # JDK used to: run AEM instances, build OSGi bundles, assemble AEM packages
   java:
     # Require following versions before e.g running AEM instances

pkg/sdk.go

@@ -2,20 +2,31 @@ package pkg
 
 import (
 	"fmt"
+	"github.com/samber/lo"
 	log "github.com/sirupsen/logrus"
 	"github.com/wttech/aemc/pkg/common/execx"
 	"github.com/wttech/aemc/pkg/common/filex"
 	"github.com/wttech/aemc/pkg/common/osx"
 	"github.com/wttech/aemc/pkg/common/pathx"
+	"github.com/wttech/aemc/pkg/sdk"
 	"path/filepath"
+	"strings"
 )
 
 func NewSDK(vendorManager *VendorManager) *SDK {
-	return &SDK{vendorManager: vendorManager}
+	cv := vendorManager.aem.Config().Values()
+
+	return &SDK{
+		vendorManager: vendorManager,
+
+		OS: cv.GetString("vendor.sdk.os"),
+	}
 }
 
 type SDK struct {
 	vendorManager *VendorManager
+
+	OS string
 }
 
 func (s SDK) Dir() string {
@@ -118,7 +129,12 @@ func (s SDK) findFile(pattern string) (string, error) {
 }
 
 func (s SDK) unpackDispatcher() error {
-	if osx.IsWindows() {
+	os, err := s.determineOs()
+	if err != nil {
+		return err
+	}
+
+	if os == sdk.OSWindows {
 		zip, err := s.dispatcherToolsWindowsZip()
 		if err != nil {
 			return err
@@ -145,6 +161,20 @@ func (s SDK) unpackDispatcher() error {
 	return nil
 }
 
+func (s SDK) determineOs() (string, error) {
+	os := s.OS
+	if !lo.Contains(sdk.OsTypes(), os) {
+		return "", fmt.Errorf("unsupported SDK OS type '%s', supported types are: %s", os, strings.Join(sdk.OsTypes(), ", "))
+	}
+	if os != sdk.OSAuto {
+		return os, nil
+	}
+	if osx.IsWindows() {
+		return sdk.OSWindows, nil
+	}
+	return sdk.OSUnix, nil
+}
+
 func (s SDK) Destroy() error {
 	return pathx.Delete(s.Dir())
 }

pkg/sdk/constants.go

@@ -0,0 +1,11 @@
+package sdk
+
+const (
+	OSAuto    = "auto"
+	OSUnix    = "unix"
+	OSWindows = "windows"
+)
+
+func OsTypes() []string {
+	return []string{OSAuto, OSUnix, OSWindows}
+}

pkg/vendor_manager.go

@@ -1,5 +1,7 @@
 package pkg
 
+import "github.com/wttech/aemc/pkg/common/pathx"
+
 // VendorManager manages third-party tools like JDK, OakRun, and Vault CLI
 type VendorManager struct {
 	aem *AEM
@@ -34,7 +36,7 @@ func (vm *VendorManager) PrepareWithChanged(requireLibs bool) (bool, error) {
 	changed := false
 
 	javaChanged, err := vm.javaManager.PrepareWithChanged()
-	changed = changed || javaChanged
+	changed = javaChanged
 	if err != nil {
 		return changed, err
 	}
@@ -62,6 +64,17 @@ func (vm *VendorManager) PrepareWithChanged(requireLibs bool) (bool, error) {
 	return changed, nil
 }
 
+func (vm *VendorManager) CleanWithChanged() (bool, error) {
+	dir := vm.aem.BaseOpts().ToolDir
+	if !pathx.Exists(dir) {
+		return false, nil
+	}
+	if err := pathx.Delete(dir); err != nil {
+		return false, err
+	}
+	return true, nil
+}
+
 func (vm *VendorManager) JavaManager() *JavaManager {
 	return vm.javaManager
 }