Merge pull request #3 from AlexsanderHamir/refactors

Core non-wrapping feature implemented

Author: AlexsanderHamir

.gitignore

@@ -1 +1,4 @@
-tasks.md
+tasks.md
+*.out
+*.prof
+*prof

benchmark/api.go

@@ -8,6 +8,7 @@ import (
 	"path/filepath"
 
 	"github.com/AlexsanderHamir/prof/args"
+	"github.com/AlexsanderHamir/prof/collector"
 	"github.com/AlexsanderHamir/prof/parser"
 	"github.com/AlexsanderHamir/prof/shared"
 )
@@ -18,11 +19,11 @@ func SetupDirectories(tag string, benchmarks, profiles []string) error {
 	if err != nil {
 		return err
 	}
-	tagDir := filepath.Join(currentDir, shared.MainDirOutput, tag)
 
-	err = deleteContents(tagDir)
+	tagDir := filepath.Join(currentDir, shared.MainDirOutput, tag)
+	err = shared.CleanOrCreateDir(tagDir)
 	if err != nil {
-		return fmt.Errorf("deleteContents failed: %w", err)
+		return fmt.Errorf("CleanOrCreateDir failed: %w", err)
 	}
 
 	if err = createBenchDirectories(tagDir, benchmarks); err != nil {
@@ -39,9 +40,9 @@ func RunBenchmark(benchmarkName string, profiles []string, count int, tag string
 		return err
 	}
 
-	textDir, binDir := getOrCreateOutputDirectories(benchmarkName, tag)
+	textDir, binDir := getOutputDirectories(benchmarkName, tag)
 
-	outputFile := filepath.Join(textDir, fmt.Sprintf("%s.%s", benchmarkName, textExtension))
+	outputFile := filepath.Join(textDir, fmt.Sprintf("%s.%s", benchmarkName, shared.TextExtension))
 	if err = runBenchmarkCommand(cmd, outputFile); err != nil {
 		return err
 	}
@@ -69,15 +70,15 @@ func ProcessProfiles(benchmarkName string, profiles []string, tag string) error
 			return fmt.Errorf("failed to stat profile file %s: %w", profileFile, err)
 		}
 
-		outputFile := filepath.Join(textDir, fmt.Sprintf("%s_%s.%s", benchmarkName, profile, textExtension))
+		outputFile := filepath.Join(textDir, fmt.Sprintf("%s_%s.%s", benchmarkName, profile, shared.TextExtension))
 		profileFunctionsDir := filepath.Join(tagDir, profile+shared.FunctionsDirSuffix, benchmarkName)
 
-		if err := generateTextProfile(profileFile, outputFile); err != nil {
+		if err := collector.GenerateProfileTextOutput(profileFile, outputFile); err != nil {
 			return fmt.Errorf("failed to generate text profile for %s: %w", profile, err)
 		}
 
-		pngFile := filepath.Join(profileFunctionsDir, fmt.Sprintf("%s_%s.png", benchmarkName, profile))
-		if err := generatePNGVisualization(profileFile, pngFile); err != nil {
+		pngDesiredFilePath := filepath.Join(profileFunctionsDir, fmt.Sprintf("%s_%s.png", benchmarkName, profile))
+		if err := collector.GeneratePNGVisualization(profileFile, pngDesiredFilePath); err != nil {
 			return fmt.Errorf("failed to generate PNG visualization for %s: %w", profile, err)
 		}
 
@@ -95,17 +96,12 @@ func CollectProfileFunctions(args *args.CollectionArgs) error {
 			return fmt.Errorf("failed to create output directory: %w", err)
 		}
 
-		filter := parser.ProfileFilter{
-			FunctionPrefixes: args.BenchmarkConfig.IncludePrefixes,
-			IgnoreFunctions:  args.BenchmarkConfig.IgnoreFunctions,
-		}
-
-		functions, err := parser.GetAllFunctionNames(paths.ProfileTextFile, filter)
+		functions, err := parser.GetAllFunctionNames(paths.ProfileTextFile, args.BenchmarkConfig)
 		if err != nil {
 			return fmt.Errorf("failed to extract function names: %w", err)
 		}
 
-		if err = saveAllFunctionsPprofContents(functions, paths); err != nil {
+		if err = collector.SaveAllFunctionsPprofContents(functions, paths.ProfileBinaryFile, paths.FunctionDirectory); err != nil {
 			return fmt.Errorf("getAllFunctionsPprofContents failed: %w", err)
 		}
 	}

benchmark/helpers.go

@@ -22,17 +22,7 @@ func getProfileFlags() map[string]string {
 	}
 }
 
-func getPprofTextParams() []string {
-	return []string{
-		"-cum",
-		"-edgefraction=0",
-		"-nodefraction=0",
-		"-top",
-	}
-}
-
 const (
-	textExtension       = "txt"
 	binExtension        = "out"
 	descriptionFileName = "description.txt"
 	moduleNotFoundMsg   = "go: cannot find main module"
@@ -115,36 +105,8 @@ func buildBenchmarkCommand(benchmarkName string, profiles []string, count int) (
 	return cmd, nil
 }
 
-func deleteContents(dir string) error {
-	info, err := os.Stat(dir)
-
-	if os.IsNotExist(err) {
-		return nil
-	} else if err != nil {
-		return err
-	}
-
-	if !info.IsDir() {
-		return fmt.Errorf("path is not a directory: %s", dir)
-	}
-
-	entries, err := os.ReadDir(dir)
-	if err != nil {
-		return fmt.Errorf("failed to read directory: %w", err)
-	}
-
-	for _, entry := range entries {
-		path := filepath.Join(dir, entry.Name())
-		if err = os.RemoveAll(path); err != nil {
-			return fmt.Errorf("failed to remove %s: %w", path, err)
-		}
-	}
-
-	return nil
-}
-
 // getOutputDirectories gets or creates the output directories.
-func getOrCreateOutputDirectories(benchmarkName, tag string) (textDir string, binDir string) {
+func getOutputDirectories(benchmarkName, tag string) (textDir string, binDir string) {
 	tagDir := filepath.Join(shared.MainDirOutput, tag)
 	textDir = filepath.Join(tagDir, shared.ProfileTextDir, benchmarkName)
 	binDir = filepath.Join(tagDir, shared.ProfileBinDir, benchmarkName)
@@ -212,34 +174,6 @@ func moveTestFiles(benchmarkName, binDir string) error {
 	return nil
 }
 
-func generateTextProfile(profileFile, outputFile string) error {
-	pprofTextParams := getPprofTextParams()
-	cmd := append([]string{"go", "tool", "pprof"}, pprofTextParams...)
-	cmd = append(cmd, profileFile)
-
-	// #nosec G204 -- cmd is constructed internally by generateTextProfile(), not from user input
-	execCmd := exec.Command(cmd[0], cmd[1:]...)
-	output, err := execCmd.Output()
-	if err != nil {
-		return fmt.Errorf("pprof command failed: %w", err)
-	}
-
-	return os.WriteFile(outputFile, output, shared.PermFile)
-}
-
-func generatePNGVisualization(profileFile, outputFile string) error {
-	cmd := []string{"go", "tool", "pprof", "-png", profileFile}
-
-	// #nosec G204 -- cmd is constructed internally by generatePNGVisualization(), not from user input
-	execCmd := exec.Command(cmd[0], cmd[1:]...)
-	output, err := execCmd.Output()
-	if err != nil {
-		return fmt.Errorf("pprof PNG generation failed: %w", err)
-	}
-
-	return os.WriteFile(outputFile, output, shared.PermFile)
-}
-
 // ProfilePaths holds paths for profile text, binary, and output directories.
 type ProfilePaths struct {
 	// Desired file path for specified profile
@@ -265,7 +199,7 @@ type ProfilePaths struct {
 //   - bench/v1.0/cpu_functions/BenchmarkPool/function1.txt
 func getProfilePaths(tag, benchmarkName, profile string) ProfilePaths {
 	tagDir := filepath.Join("bench", tag)
-	profileTextFile := fmt.Sprintf("%s_%s.%s", benchmarkName, profile, textExtension)
+	profileTextFile := fmt.Sprintf("%s_%s.%s", benchmarkName, profile, shared.TextExtension)
 	profileBinFile := fmt.Sprintf("%s_%s.%s", benchmarkName, profile, binExtension)
 
 	return ProfilePaths{
@@ -274,35 +208,3 @@ func getProfilePaths(tag, benchmarkName, profile string) ProfilePaths {
 		FunctionDirectory: filepath.Join(tagDir, profile+shared.FunctionsDirSuffix, benchmarkName),
 	}
 }
-
-// saveAllFunctionsPprofContents calls [getFunctionPprofContent] sequentially.
-func saveAllFunctionsPprofContents(functions []string, paths ProfilePaths) error {
-	for _, function := range functions {
-		if err := getFunctionPprofContent(function, paths); err != nil {
-			return fmt.Errorf("failed to extract function content for %s: %w", function, err)
-		}
-	}
-
-	return nil
-}
-
-// getFunctionPprofContent gets code line level mapping of specified function
-// and writes the data to a file named after the function.
-func getFunctionPprofContent(function string, paths ProfilePaths) error {
-	outputFile := filepath.Join(paths.FunctionDirectory, function+"."+textExtension)
-	cmd := []string{"go", "tool", "pprof", fmt.Sprintf("-list=%s", function), paths.ProfileBinaryFile}
-
-	// #nosec ProfileTextDir04 -- cmd is constructed internally by getFunctionPprofContent(), not from user input
-	execCmd := exec.Command(cmd[0], cmd[1:]...)
-	output, err := execCmd.Output()
-	if err != nil {
-		return fmt.Errorf("pprof list command failed: %w", err)
-	}
-
-	if err = os.WriteFile(outputFile, output, shared.PermFile); err != nil {
-		return fmt.Errorf("failed to write function content: %w", err)
-	}
-
-	slog.Info("Collected function", "function", function)
-	return nil
-}

cli/api.go

@@ -6,6 +6,7 @@ import (
 	"log/slog"
 
 	"github.com/AlexsanderHamir/prof/args"
+	"github.com/AlexsanderHamir/prof/collector"
 	"github.com/AlexsanderHamir/prof/config"
 	"github.com/AlexsanderHamir/prof/tracker"
 	"github.com/AlexsanderHamir/prof/version"
@@ -35,6 +36,7 @@ func CreateRootCmd() *cobra.Command {
 		RunE:  runBenchmarks,
 	}
 
+	rootCmd.AddCommand(createManualCmd())
 	rootCmd.AddCommand(createRunCmd())
 	rootCmd.AddCommand(createSetupCmd())
 	rootCmd.AddCommand(createTrackCmd())
@@ -43,6 +45,24 @@ func CreateRootCmd() *cobra.Command {
 	return rootCmd
 }
 
+func createManualCmd() *cobra.Command {
+	manualCmd := &cobra.Command{
+		Use:     "manual",
+		Short:   "Receives profile files and performs data collection and organization.",
+		Args:    cobra.MinimumNArgs(1),
+		Example: "prof manual cpu.prof memory.prof block.prof",
+		RunE: func(_ *cobra.Command, args []string) error {
+			return collector.RunCollector(args, tag)
+		},
+	}
+
+	tagFlag := "tag"
+	manualCmd.Flags().StringVar(&tag, tagFlag, "", "Tag for organization")
+	_ = manualCmd.MarkFlagRequired(tagFlag)
+
+	return manualCmd
+}
+
 func createRunCmd() *cobra.Command {
 	benchFlag := "benchmarks"
 	profileFlag := "profiles"
@@ -142,7 +162,7 @@ func runBenchmarks(_ *cobra.Command, _ []string) error {
 		cfg = &config.Config{}
 	}
 
-	benchmarkList, profileList, err := parseBenchmarkConfig(benchmarks, profiles)
+	benchmarkList, profileList, err := parseAndValidateBenchmarkParams(benchmarks, profiles)
 	if err != nil {
 		return fmt.Errorf("failed to parse benchmark config: %w", err)
 	}

cli/helpers.go

@@ -59,7 +59,7 @@ func parseListArgument(arg string) []string {
 }
 
 // Rest of the functions remain the same...
-func parseBenchmarkConfig(benchmarks, profiles string) ([]string, []string, error) {
+func parseAndValidateBenchmarkParams(benchmarks, profiles string) ([]string, []string, error) {
 	if err := validateListArguments(benchmarks, profiles); err != nil {
 		return nil, nil, err
 	}