tools/geneos: consolidate the various almost-identical file import loops, rename component file lists and refactor previous internal ImportFiles to Filename type

Author: pgalbavy-itrs

tools/geneos/cmd/add.go

@@ -35,7 +35,7 @@ import (
 var addCmdTemplate, addCmdBase, addCmdKeyfileCRC string
 var addCmdStart, addCmdLogs bool
 var addCmdPort uint16
-var addCmdImportFiles instance.ImportFiles
+var addCmdImportFiles instance.Filename
 var addCmdKeyfile string
 
 var addCmdExtras = instance.SetConfigValues{}
@@ -195,12 +195,7 @@ func AddInstance(ct *geneos.Component, addCmdExtras instance.SetConfigValues, it
 	i.Load()
 	i.Rebuild(true)
 
-	for _, importfile := range addCmdImportFiles {
-		if _, err = geneos.ImportSource(i.Host(), i.Home(), importfile); err != nil && err != geneos.ErrExists {
-			return err
-		}
-	}
-	err = nil
+	_ = instance.ImportFiles(i, addCmdImportFiles...)
 
 	fmt.Printf("%s added, port %d\n", i, cf.GetInt("port"))
 

tools/geneos/cmd/deploy.go

@@ -43,7 +43,7 @@ var deployCmdSigningBundle, deployCmdInstanceBundle string
 var deployCmdPort uint16
 var deployCmdArchive, deployCmdVersion, deployCmdOverride string
 var deployCmdPassword *config.Plaintext
-var deployCmdImportFiles instance.ImportFiles
+var deployCmdImportFiles instance.Filename
 var deployCmdKeyfile string
 var deployCmdExtras = instance.SetConfigValues{}
 
@@ -388,12 +388,7 @@ var deployCmd = &cobra.Command{
 		log.Debug().Msgf("home is now %s", i.Home())
 		i.Rebuild(true)
 
-		for _, importfile := range deployCmdImportFiles {
-			if _, err = geneos.ImportSource(i.Host(), i.Home(), importfile); err != nil && err != geneos.ErrExists {
-				return err
-			}
-		}
-		err = nil
+		_ = instance.ImportFiles(i, deployCmdImportFiles...)
 
 		fmt.Printf("%s added, port %d\n", i, cf.GetInt("port"))
 

tools/geneos/cmd/import.go

@@ -137,11 +137,7 @@ func importInstance(i geneos.Instance, params ...any) (resp *instance.Response)
 		log.Fatal().Msg("no file/url provided")
 	}
 
-	for _, source := range sources {
-		if _, resp.Err = geneos.ImportSource(i.Host(), i.Home(), source); resp.Err != nil && resp.Err != geneos.ErrExists {
-			return
-		}
-	}
+	_ = instance.ImportFiles(i, sources...)
 	resp.Err = nil
 	return
 }

tools/geneos/internal/component/ac2/ac2.go

@@ -81,7 +81,7 @@ var AC2 = geneos.Component{
 	GetPID: pidCheckFn,
 }
 
-var ac2Files = []string{
+var initialFiles = []string{
 	// "ActiveConsole.gci",
 	// "log4j2.properties",
 	// "defaultws.dwx",
@@ -199,13 +199,7 @@ func (n *AC2s) Add(tmpl string, port uint16) (err error) {
 		return
 	}
 
-	for _, source := range ac2Files {
-		if _, err = geneos.ImportSource(n.Host(), n.Home(), source); err != nil && err != geneos.ErrExists {
-			return
-		}
-	}
-	err = nil
-
+	_ = instance.ImportFiles(n, initialFiles...)
 	return
 }
 

tools/geneos/internal/component/ca3/ca3.go

@@ -93,7 +93,7 @@ const (
 
 var ca3jarRE = regexp.MustCompile(`^` + ca3prefix + `(.+)` + ca3suffix)
 
-var ca3Files = []string{
+var initialFiles = []string{
 	"collection-agent.yml",
 	"logback.xml",
 }
@@ -210,14 +210,7 @@ func (n *CA3s) Add(tmpl string, port uint16) (err error) {
 		return
 	}
 
-	for _, source := range ca3Files {
-		if _, err = geneos.ImportSource(n.Host(), n.Home(), source); err != nil && err != geneos.ErrExists {
-			return
-		}
-	}
-	err = nil
-
-	// default config XML etc.
+	_ = instance.ImportFiles(n, initialFiles...)
 	return
 }
 

tools/geneos/internal/component/ssoagent/ssoagent.go

@@ -142,12 +142,12 @@ func factory(name string) geneos.Instance {
 // list of file patterns to copy?
 // from WebBins + WebBase + /config
 
-// ssoagentFiles is a list of files to import from the "read-only"
+// initialFiles is a list of files to import from the "read-only"
 // package.
 //
 // `config/=config/file` means import file into config/ with no name
 // change
-var ssoagentFiles = []string{
+var initialFiles = []string{
 	"conf",
 }
 
@@ -226,14 +226,7 @@ func (s *SSOAgents) Add(tmpl string, port uint16) (err error) {
 		return
 	}
 
-	for _, source := range ssoagentFiles {
-		if _, err = geneos.ImportSource(s.Host(), s.Home(), source); err != nil && !errors.Is(err, geneos.ErrExists) {
-			log.Warn().Err(err).Msgf("source file %q may not exist", source)
-			return
-		}
-	}
-	err = nil
-
+	_ = instance.ImportFiles(s, initialFiles...)
 	return
 }
 

tools/geneos/internal/component/webserver/webserver.go

@@ -145,22 +145,15 @@ func factory(name string) geneos.Instance {
 // list of file patterns to copy?
 // from WebBins + WebBase + /config
 
-// webserverFiles is a list of files to import from the "read-only"
+// initialFiles is a list of files to import from the "read-only"
 // package.
 //
 // `config/=config/file` means import file into config/ with no name
 // change
-var webserverFiles = []string{
+var initialFiles = []string{
+	"config",
 	"config/config.xml=config/config.xml.min.tmpl",
-	"config/=config/log4j.properties",
-	"config/=config/log4j2.properties",
-	"config/=config/logging.properties",
-	"config/=config/login.conf",
-	"config/=config/security.properties",
-	"config/=config/security.xml",
-	"config/=config/sso.properties",
-	"config/=config/users.properties",
-	"cacerts=JRE/lib/security/cacerts",
+	"JRE/lib/security/cacerts",
 }
 
 // interface method set
@@ -243,13 +236,7 @@ func (w *Webservers) Add(tmpl string, port uint16) (err error) {
 		return
 	}
 
-	for _, source := range webserverFiles {
-		if _, err = geneos.ImportSource(w.Host(), w.Home(), source); err != nil && err != geneos.ErrExists {
-			return
-		}
-	}
-	err = nil
-
+	_ = instance.ImportFiles(w, initialFiles...)
 	return
 }
 

tools/geneos/internal/instance/instance.go

@@ -411,3 +411,12 @@ func SplitName(in string, defaultHost *geneos.Host) (ct *geneos.Component, name
 	}
 	return
 }
+
+func ImportFiles(s geneos.Instance, files ...string) (err error) {
+	for _, source := range files {
+		if _, err = geneos.ImportSource(s.Host(), s.Home(), source); err != nil {
+			return
+		}
+	}
+	return
+}

tools/geneos/internal/instance/values.go

@@ -574,18 +574,18 @@ func (i *UnsetVars) Type() string {
 	return "SETTING"
 }
 
-// ImportFiles fulfils the Var interface for pflag
-type ImportFiles []string
+// Filename fulfils the Var interface for pflag
+type Filename []string
 
-func (i *ImportFiles) String() string {
+func (i *Filename) String() string {
 	return ""
 }
 
-func (i *ImportFiles) Set(value string) error {
+func (i *Filename) Set(value string) error {
 	*i = append(*i, value)
 	return nil
 }
 
-func (i *ImportFiles) Type() string {
+func (i *Filename) Type() string {
 	return "[DEST=]PATH|URL"
 }