Support generating arbitrary files

Author: parttimenerd

cf_cli_java_plugin.go

@@ -119,6 +119,9 @@ type Command struct {
 	FileExtension string
 	FileLabel     string
 	FileNamePart  string
+	// Run the command in a subfolder of the container
+	GenerateArbitraryFiles  bool
+	GenerateArbitraryFilesFolderName string
 }
 
 var commands = []Command{
@@ -215,6 +218,8 @@ fi`,
 		OnlyOnRecentSapMachine: true,
 		RequiredTools:          []string{"asprof"},
 		GenerateFiles:          false,
+		GenerateArbitraryFiles:           true,
+		GenerateArbitraryFilesFolderName: "asprof",
 		SshCommand:             `$ASPROF_COMMAND $(pidof java) $$ARGS`,
 	},
 	{
@@ -244,7 +249,7 @@ fi`,
 		NeedsFileName:          true,
 		FileExtension:          ".jfr",
 		FileNamePart:           "asprof",
-		SshCommand:             `$ASPROF_COMMAND start $$ARGS -f $$FILE_NAME -e ctimer $(pidof java)`,
+		SshCommand:             `$ASPROF_COMMAND start $$ARGS -f $$FILE_NAME -e cpu $(pidof java)`,
 	},
 	{
 		Name:                   "start-asprof-wall-clock-profile",
@@ -352,7 +357,7 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 	}
 
 	command := commands[index]
-	if !command.GenerateFiles {
+	if !command.GenerateFiles && !command.GenerateArbitraryFiles {
 		for _, flag := range fileFlags {
 			if commandFlags.IsSet(flag) {
 				return "", &InvalidUsageError{message: fmt.Sprintf("The flag %q is not supported for %s", flag, command.Name)}
@@ -382,10 +387,10 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 
 	for _, requiredTool := range command.RequiredTools {
 		uppercase := strings.ToUpper(requiredTool)
-		var toolCommand = fmt.Sprintf("%s_COMMAND=$(find -executable -name %s | head -1 | tr -d [:space:]); if [ -z \"${%s_COMMAND}\" ]; then echo \"%s not found\"; exit 1; fi", uppercase, requiredTool, uppercase, requiredTool)
+		var toolCommand = fmt.Sprintf("%s_COMMAND=$(realpath $(find -executable -name %s | head -1 | tr -d [:space:])); if [ -z \"${%s_COMMAND}\" ]; then echo \"%s not found\"; exit 1; fi", uppercase, requiredTool, uppercase, requiredTool)
 		if requiredTool == "jcmd" {
 			// add code that first checks whether asprof is present and if so use `asprof jcmd` instead of `jcmd`
-			remoteCommandTokens = append(remoteCommandTokens, toolCommand, "ASPROF_COMMAND=$(find -executable -name asprof | head -1 | tr -d [:space:]); if [ -n \"${ASPROF_COMMAND}\" ]; then JCMD_COMMAND=\"${ASPROF_COMMAND} jcmd\"; fi")
+			remoteCommandTokens = append(remoteCommandTokens, toolCommand, "ASPROF_COMMAND=$(realpath $(find -executable -name asprof | head -1 | tr -d [:space:])); if [ -n \"${ASPROF_COMMAND}\" ]; then JCMD_COMMAND=\"${ASPROF_COMMAND} jcmd\"; fi")
 		} else {
 			remoteCommandTokens = append(remoteCommandTokens, toolCommand)
 		}
@@ -398,15 +403,23 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 		"$$APP_NAME": applicationName,
 	}
 
-	if command.GenerateFiles || command.NeedsFileName {
+	if command.GenerateFiles || command.NeedsFileName || command.GenerateArbitraryFiles {
 		fspath, err = util.GetAvailablePath(applicationName, remoteDir)
 		if err != nil {
 			return "", err
 		}
+		if command.GenerateArbitraryFiles {
+			fspath = fspath + "/" + command.GenerateArbitraryFilesFolderName
+		}
 
 		fileName = fspath + "/" + applicationName + "-" + command.FileNamePart + "-" + uuidGenerator.Generate() + command.FileExtension
 		replacements["$$FILE_NAME"] = fileName
 		replacements["$$FSPATH"] = fspath
+		if command.GenerateArbitraryFiles {
+			// prepend 'mkdir -p $$FSPATH' to the command to create the directory if it does not exist
+			remoteCommandTokens = append([]string{"mkdir -p " + fspath}, remoteCommandTokens...)
+			remoteCommandTokens = append(remoteCommandTokens, "cd " + fspath)
+		}
 	}
 
 	var commandText = command.SshCommand
@@ -472,6 +485,34 @@ func (c *JavaPlugin) execute(commandExecutor cmd.CommandExecutor, uuidGenerator
 			fmt.Println(toSentenceCase(command.FileLabel) + " file deleted in app container")
 		}
 	}
+	if command.GenerateArbitraryFiles {
+		// download all files in the generic folder
+		files, err := util.ListFiles(cfSSHArguments, fspath)
+		if err != nil {
+			return "", err
+		}
+		if copyToLocal {
+			for _, file := range files {
+				localFileFullPath := localDir + "/" + file
+				err = util.CopyOverCat(cfSSHArguments, fspath+"/"+file, localFileFullPath)
+				if err == nil {
+					fmt.Printf("File %s saved to: %s\n", file, localFileFullPath)
+				} else {
+					return "", err
+				}
+			}
+		} else {
+			fmt.Println(toSentenceCase(command.FileLabel) + " will not be copied as parameter `local-dir` was not set")
+		}
+
+		if !keepAfterDownload {
+			err = util.DeleteRemoteFile(cfSSHArguments, fspath)
+			if err != nil {
+				return "", err
+			}
+			fmt.Println("File folder deleted in app container")
+		}
+	}
 	// We keep this around to make the compiler happy, but commandExecutor.Execute will cause an os.Exit
 	return strings.Join(output, "\n"), err
 }

cf_cli_java_plugin_test.go

@@ -15,7 +15,7 @@ import (
 )
 
 const (
-	JcmdDetectionCommand = "JCMD_COMMAND=$(find -executable -name jcmd | head -1 | tr -d [:space:]); if [ -z \"${JCMD_COMMAND}\" ]; then echo \"jcmd not found\"; exit 1; fi; ASPROF_COMMAND=$(find -executable -name asprof | head -1 | tr -d [:space:]); if [ -n \"${ASPROF_COMMAND}\" ]; then JCMD_COMMAND=\"${ASPROF_COMMAND} jcmd\"; fi"
+	JcmdDetectionCommand = "JCMD_COMMAND=$(realpath $(find -executable -name jcmd | head -1 | tr -d [:space:])); if [ -z \"${JCMD_COMMAND}\" ]; then echo \"jcmd not found\"; exit 1; fi; ASPROF_COMMAND=$(realpath $(find -executable -name asprof | head -1 | tr -d [:space:])); if [ -n \"${ASPROF_COMMAND}\" ]; then JCMD_COMMAND=\"${ASPROF_COMMAND} jcmd\"; fi"
 )
 
 type commandOutput struct {

utils/cf_java_plugin_util.go

@@ -8,4 +8,5 @@ type CfJavaPluginUtil interface {
 	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)
 }

utils/cfutils.go

@@ -186,7 +186,7 @@ func (checker CfJavaPluginUtilImpl) CopyOverCat(args []string, src string, dest
 }
 
 func (checker CfJavaPluginUtilImpl) DeleteRemoteFile(args []string, path string) error {
-	args = append(args, "rm "+path)
+	args = append(args, "rm -fr "+path)
 	_, err := exec.Command("cf", args...).Output()
 
 	if err != nil {
@@ -218,3 +218,14 @@ 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) {
+	cmd := "ls " + path
+	args = append(args, cmd)
+	output, err := exec.Command("cf", args...).Output()
+
+	if err != nil {
+		return nil, errors.New("error occured while listing files: " + string(output[:]))
+	}
+	return strings.Split(strings.Trim(string(output[:]), "\n"), "\n"), nil
+}

utils/fakes/fake_utils_impl.go

@@ -91,4 +91,8 @@ func (fake FakeCfJavaPluginUtil) FindJFRFile(args []string, fullpath string, fsp
 
 func (fake FakeCfJavaPluginUtil) FindFile(args []string, fullpath string, fspath string, pattern string) (string, error) {
 	return fake.FindHeapDumpFile(args, fullpath, fspath) // same as FindHeapDumpFile, just to avoid duplication
+}
+
+func (fake FakeCfJavaPluginUtil) ListFiles(args []string, path string) ([]string, error) {
+	return []string{fake.OutputFileName}, nil
 }