remove useless struct & interface

Author: dbriemann

cf_cli_java_plugin.go

@@ -102,7 +102,7 @@ func (c *JavaPlugin) Run(cliConnection plugin.CliConnection, args []string) {
 		fmt.Printf("[VERBOSE] Run called with args: %v\n", args)
 	}
 
-	_, err := c.DoRun(&commandExecutorImpl{cliConnection: cliConnection}, &uuidGeneratorImpl{}, utils.CfJavaPluginUtilImpl{}, args)
+	_, err := c.DoRun(&commandExecutorImpl{cliConnection: cliConnection}, &uuidGeneratorImpl{}, args)
 	if err != nil {
 		if c.verbose {
 			fmt.Printf("[VERBOSE] Error occurred: %v\n", err)
@@ -115,15 +115,15 @@ func (c *JavaPlugin) Run(cliConnection plugin.CliConnection, args []string) {
 }
 
 // DoRun is an internal method that we use to wrap the cmd package with CommandExecutor for test purposes
-func (c *JavaPlugin) DoRun(commandExecutor cmd.CommandExecutor, uuidGenerator UUIDGenerator, util utils.CfJavaPluginUtil, args []string) (string, error) {
+func (c *JavaPlugin) DoRun(commandExecutor cmd.CommandExecutor, uuidGenerator UUIDGenerator, args []string) (string, error) {
 	traceLogger := trace.NewLogger(os.Stdout, true, os.Getenv("CF_TRACE"), "")
 	ui := terminal.NewUI(os.Stdin, os.Stdout, terminal.NewTeePrinter(os.Stdout), traceLogger)
 
 	if c.verbose {
 		fmt.Printf("[VERBOSE] DoRun called with args: %v\n", args)
 	}
 
-	output, err := c.execute(commandExecutor, uuidGenerator, util, args)
+	output, err := c.execute(commandExecutor, uuidGenerator, args)
 	if err != nil {
 		if err.Error() == "unexpected EOF" {
 			return output, err
@@ -486,7 +486,7 @@ func toSentenceCase(input string) string {
 	return strings.ToUpper(string(input[0])) + strings.ToLower(input[1:])
 }
 
-func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator UUIDGenerator, util utils.CfJavaPluginUtil, args []string) (string, error) {
+func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator UUIDGenerator, args []string) (string, error) {
 	if len(args) == 0 {
 		return "", &InvalidUsageError{message: "No command provided"}
 	}
@@ -632,7 +632,7 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 
 	logVerbose("CF SSH arguments: %v", cfSSHArguments)
 
-	supported, err := util.CheckRequiredTools(applicationName)
+	supported, err := utils.CheckRequiredTools(applicationName)
 
 	if err != nil || !supported {
 		return "required tools checking failed", err
@@ -665,7 +665,7 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 	// Initialize fspath and fileName for commands that need them
 	if command.GenerateFiles || command.NeedsFileName || command.GenerateArbitraryFiles {
 		logVerbose("Command requires file generation")
-		fspath, err = util.GetAvailablePath(applicationName, remoteDir)
+		fspath, err = utils.GetAvailablePath(applicationName, remoteDir)
 		if err != nil {
 			return "", fmt.Errorf("failed to get available path: %w", err)
 		}
@@ -740,10 +740,10 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 		switch command.FileExtension {
 		case ".hprof":
 			logVerbose("Finding heap dump file")
-			finalFile, err = util.FindHeapDumpFile(cfSSHArguments, fileName, fspath)
+			finalFile, err = utils.FindHeapDumpFile(cfSSHArguments, fileName, fspath)
 		case ".jfr":
 			logVerbose("Finding JFR file")
-			finalFile, err = util.FindJFRFile(cfSSHArguments, fileName, fspath)
+			finalFile, err = utils.FindJFRFile(cfSSHArguments, fileName, fspath)
 		default:
 			return "", &InvalidUsageError{message: fmt.Sprintf("Unsupported file extension %q", command.FileExtension)}
 		}
@@ -759,7 +759,7 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 
 		localFileFullPath := localDir + "/" + applicationName + "-" + command.FileNamePart + "-" + uuidGenerator.Generate() + command.FileExtension
 		logVerbose("Downloading file to: %s", localFileFullPath)
-		err = util.CopyOverCat(cfSSHArguments, fileName, localFileFullPath)
+		err = utils.CopyOverCat(cfSSHArguments, fileName, localFileFullPath)
 		if err == nil {
 			logVerbose("File download completed successfully")
 			fmt.Println(toSentenceCase(command.FileLabel) + " file saved to: " + localFileFullPath)
@@ -770,7 +770,7 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 
 		if !keepAfterDownload {
 			logVerbose("Deleting remote file")
-			err = util.DeleteRemoteFile(cfSSHArguments, fileName)
+			err = utils.DeleteRemoteFile(cfSSHArguments, fileName)
 			if err != nil {
 				logVerbose("Failed to delete remote file: %v", err)
 				return "", err
@@ -785,7 +785,7 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 		logVerbose("Processing arbitrary files download: %s", fspath)
 		logVerbose("cfSSHArguments: %v", cfSSHArguments)
 		// download all files in the generic folder
-		files, err := util.ListFiles(cfSSHArguments, fspath)
+		files, err := utils.ListFiles(cfSSHArguments, fspath)
 		for i, file := range files {
 			logVerbose("File %d: %s", i+1, file)
 		}
@@ -798,7 +798,7 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 			for _, file := range files {
 				logVerbose("Downloading file: %s", file)
 				localFileFullPath := localDir + "/" + file
-				err = util.CopyOverCat(cfSSHArguments, fspath+"/"+file, localFileFullPath)
+				err = utils.CopyOverCat(cfSSHArguments, fspath+"/"+file, localFileFullPath)
 				if err == nil {
 					logVerbose("File %s downloaded successfully", file)
 					fmt.Printf("File %s saved to: %s\n", file, localFileFullPath)
@@ -810,7 +810,7 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 
 			if !keepAfterDownload {
 				logVerbose("Deleting remote file folder")
-				err = util.DeleteRemoteFile(cfSSHArguments, fspath)
+				err = utils.DeleteRemoteFile(cfSSHArguments, fspath)
 				if err != nil {
 					logVerbose("Failed to delete remote folder: %v", err)
 					return "", err
@@ -897,7 +897,7 @@ func (c *JavaPlugin) GetMetadata() plugin.PluginMetadata {
 	}
 }
 
-// Unlike most Go programs, the `Main()` function will not be used to run all of the
+// Unlike most Go programs, the `main()` function will not be used to run all of the
 // commands provided in your plugin. Main will be used to initialize the plugin
 // process, as well as any dependencies you might require for your
 // plugin.

utils/cf_java_plugin_util.go

@@ -6,18 +6,6 @@ import (
 	"strings"
 )
 
-type CfJavaPluginUtil interface {
-	FindReasonForAccessError(app string) string
-	CheckRequiredTools(app string) (bool, error)
-	GetAvailablePath(data string, userpath string) (string, error)
-	CopyOverCat(args []string, src string, dest string) error
-	DeleteRemoteFile(args []string, path string) error
-	FindHeapDumpFile(args []string, fullpath string, fspath string) (string, error)
-	FindJFRFile(args []string, fullpath string, fspath string) (string, error)
-	FindFile(args []string, fullpath string, fspath string, pattern string) (string, error)
-	ListFiles(args []string, path string) ([]string, error)
-}
-
 // FuzzySearch returns up to `max` words from `words` that are closest in
 // Levenshtein distance to `needle`.
 func FuzzySearch(needle string, words []string, max int) []string {

utils/cfutils.go

@@ -10,8 +10,6 @@ import (
 	"strings"
 )
 
-type CfJavaPluginUtilImpl struct{}
-
 type CFAppEnv struct {
 	EnvironmentVariables struct {
 		JbpConfigSpringAutoReconfiguration string `json:"JBP_CONFIG_SPRING_AUTO_RECONFIGURATION"`
@@ -90,14 +88,14 @@ func checkUserPathAvailability(app string, path string) (bool, error) {
 	return false, nil
 }
 
-func (checker CfJavaPluginUtilImpl) FindReasonForAccessError(app string) string {
+func FindReasonForAccessError(app string) string {
 	out, err := exec.Command("cf", "apps").Output()
 	if err != nil {
 		return "cf is not logged in, please login and try again"
 	}
 	// find all app names
 	lines := strings.Split(string(out[:]), "\n")
-	appNames := make([]string, 100)
+	appNames := []string{}
 	foundHeader := false
 	for _, line := range lines {
 		if foundHeader && len(line) > 0 {
@@ -116,17 +114,19 @@ func (checker CfJavaPluginUtilImpl) FindReasonForAccessError(app string) string
 	return "Could not find " + app + ". Did you mean " + matches[0] + "?"
 }
 
-func (checker CfJavaPluginUtilImpl) CheckRequiredTools(app string) (bool, error) {
+func CheckRequiredTools(app string) (bool, error) {
 	guid, err := exec.Command("cf", "app", app, "--guid").Output()
 	if err != nil {
-		return false, errors.New(checker.FindReasonForAccessError(app))
+		return false, errors.New(FindReasonForAccessError(app))
 	}
 	output, err := exec.Command("cf", "curl", "/v3/apps/"+strings.TrimSuffix(string(guid), "\n")+"/ssh_enabled").Output()
 	if err != nil {
 		return false, err
 	}
 	var result map[string]any
-	json.Unmarshal([]byte(output), &result)
+	if err := json.Unmarshal([]byte(output), &result); err != nil {
+		return false, err
+	}
 
 	if enabled, ok := result["enabled"].(bool); !ok || !enabled {
 		return false, errors.New("ssh is not enabled for app: '" + app + "', please run below 2 shell commands to enable ssh and try again(please note application should be restarted before take effect):\ncf enable-ssh " + app + "\ncf restart " + app)
@@ -135,7 +135,7 @@ func (checker CfJavaPluginUtilImpl) CheckRequiredTools(app string) (bool, error)
 	return true, nil
 }
 
-func (checker CfJavaPluginUtilImpl) GetAvailablePath(data string, userpath string) (string, error) {
+func GetAvailablePath(data string, userpath string) (string, error) {
 	if len(userpath) > 0 {
 		valid, _ := checkUserPathAvailability(data, userpath)
 		if valid {
@@ -151,7 +151,9 @@ func (checker CfJavaPluginUtilImpl) GetAvailablePath(data string, userpath strin
 	}
 
 	var cfAppEnv CFAppEnv
-	json.Unmarshal(env, &cfAppEnv)
+	if err := json.Unmarshal(env, &cfAppEnv); err != nil {
+		return "", err
+	}
 
 	for _, v := range cfAppEnv.SystemEnvJSON.VcapServices.FsStorage {
 		for _, v2 := range v.VolumeMounts {
@@ -164,7 +166,7 @@ func (checker CfJavaPluginUtilImpl) GetAvailablePath(data string, userpath strin
 	return "/tmp", nil
 }
 
-func (checker CfJavaPluginUtilImpl) CopyOverCat(args []string, src string, dest string) error {
+func CopyOverCat(args []string, src string, dest string) error {
 	f, err := os.OpenFile(dest, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
 	if err != nil {
 		return errors.New("Error creating local file at  " + dest + ". Please check that you are allowed to create files at the given local path.")
@@ -189,7 +191,7 @@ func (checker CfJavaPluginUtilImpl) CopyOverCat(args []string, src string, dest
 	return nil
 }
 
-func (checker CfJavaPluginUtilImpl) DeleteRemoteFile(args []string, path string) error {
+func DeleteRemoteFile(args []string, path string) error {
 	args = append(args, "rm -fr "+path)
 	_, err := exec.Command("cf", args...).Output()
 	if err != nil {
@@ -199,15 +201,15 @@ func (checker CfJavaPluginUtilImpl) DeleteRemoteFile(args []string, path string)
 	return nil
 }
 
-func (checker CfJavaPluginUtilImpl) FindHeapDumpFile(args []string, fullpath string, fspath string) (string, error) {
-	return checker.FindFile(args, fullpath, fspath, "java_pid*.hprof")
+func FindHeapDumpFile(args []string, fullpath string, fspath string) (string, error) {
+	return FindFile(args, fullpath, fspath, "java_pid*.hprof")
 }
 
-func (checker CfJavaPluginUtilImpl) FindJFRFile(args []string, fullpath string, fspath string) (string, error) {
-	return checker.FindFile(args, fullpath, fspath, "*.jfr")
+func FindJFRFile(args []string, fullpath string, fspath string) (string, error) {
+	return FindFile(args, fullpath, fspath, "*.jfr")
 }
 
-func (checker CfJavaPluginUtilImpl) FindFile(args []string, fullpath string, fspath string, pattern string) (string, error) {
+func FindFile(args []string, fullpath string, fspath string, pattern string) (string, error) {
 	cmd := " [ -f '" + fullpath + "' ] && echo '" + fullpath + "' ||  find " + fspath + " -name '" + pattern + "' -printf '%T@ %p\\0' | sort -zk 1nr | sed -z 's/^[^ ]* //' | tr '\\0' '\\n' | head -n 1 "
 
 	args = append(args, cmd)
@@ -219,7 +221,7 @@ func (checker CfJavaPluginUtilImpl) FindFile(args []string, fullpath string, fsp
 	return strings.Trim(string(output[:]), "\n"), nil
 }
 
-func (checker CfJavaPluginUtilImpl) ListFiles(args []string, path string) ([]string, error) {
+func ListFiles(args []string, path string) ([]string, error) {
 	cmd := "ls " + path
 	args = append(args, cmd)
 	output, err := exec.Command("cf", args...).Output()