feat: Keep single entrypoint and make it so benchmarking is the default behavior

Author: viniciusfabri

README.md

@@ -7,7 +7,6 @@ This repository provides a framework and helper tools to streamline the process
 - `internal/processor.go`: Contains the `PluginProcessor` struct and methods for building plugins, calling functions within those plugins, running tests, and getting input data.
 - `internal/input.go`: Contains the `Args` struct and functions for processing command-line arguments and determining file paths.
 - `runner.go`: The main entry point that ties everything together by processing arguments, building the plugin, getting input, running tests, and calling the solution function.
-- `benchmark.go`: Alternative entry point that benchmarks every part of every day, and displays the result as a table afterwards.
 - It is expected to set up a folder structure following the pattern: `/year/day/partnumber.go`. For example, for the first part of the first day's challenge in 2024, the file should be located at `/2024/day1/part1.go`.
 - It is expected to add test files for each day. As a minimal it is adviced to add a test case for each part of a day based on the sample input and output provided by `Advent of Code`.
 

benchmark.go

@@ -17,7 +17,7 @@ type Args struct {
 
 func ProcessArgs() Args {
 	year := flag.String("year", fmt.Sprint(time.Now().Year()), "Year of the challenge")
-	day := flag.String("day", "1", "Day of the challenge")
+	day := flag.String("day", "0", "Day of the challenge. 0 to run all days.")
 	part := flag.String("part", "1", "Part of the challenge")
 	flag.Parse()
 
@@ -39,6 +39,10 @@ func ProcessArgs() Args {
 }
 
 func (args Args) getPath() (string, error) {
+	if args.Day == "0" {
+		return "", nil
+	}
+
 	path := filepath.Join("./", args.Year, "day"+args.Day, "part"+args.Part)
 	if _, err := os.Stat(filepath.Dir(path)); os.IsNotExist(err) {
 		return "", fmt.Errorf("the directory %s does not exist", filepath.Dir(path))

internal/input.go

@@ -2,32 +2,77 @@ package aoc
 
 import (
 	"fmt"
+	"os"
+	"text/tabwriter"
+	"time"
 
 	internal "github.com/igorwulff/aoc/internal"
 )
 
-func Run() {
-	args := internal.ProcessArgs()
+type BenchmarkResult struct {
+	TotalTimeInMs int64
+}
 
-	plugin := internal.PluginProcessor{Args: args}
-	if err := plugin.Build(); err != nil {
-		fmt.Println(err)
-		return
+func Run() ([]BenchmarkResult, error) {
+	args := internal.ProcessArgs()
+	var plugins []internal.PluginProcessor
+	// Benchmarking mode
+	if args.Day == "0" {
+		allPlugins, err := internal.GetAllPluginProcessors(args)
+		if err != nil {
+			fmt.Println(err)
+			return nil, err
+		}
+		plugins = append(plugins, allPlugins...)
+	} else {
+		plugins = append(plugins, internal.PluginProcessor{Args: args})
 	}
 
-	input, err := plugin.GetInput()
-	if err != nil {
-		fmt.Println(err)
-		return
-	}
+	results := make([]BenchmarkResult, len(plugins))
+	for i, plugin := range plugins {
+		input, err := plugin.GetInput()
+		if err != nil {
+			fmt.Printf("Could not find input.txt for Day %s Part %s\n", plugin.Args.Day, plugin.Args.Part)
+			return nil, err
+		}
 
-	plugin.RunTests()
+		fmt.Printf("Building day %s part %s... ", plugin.Args.Day, plugin.Args.Part)
+		if err := plugin.Build(); err != nil {
+			fmt.Print("ERROR!\n")
+			fmt.Println(err)
+			return nil, err
+		}
+		fmt.Print("OK!\n")
+
+		fmt.Print("Executing tests... ")
+		if err := plugin.RunTests(); err != nil {
+			fmt.Print("ERROR!\n")
+			fmt.Println(err)
+			return nil, err
+		}
+
+		fmt.Print("Executing main function... ")
+		timeBeforeExec := time.Now().UnixMilli()
+		output, err := plugin.CallFunc(input)
+		if err != nil {
+			fmt.Print("ERROR!\n")
+			fmt.Println(err)
+			return nil, err
+		}
+		timeAfterExec := time.Now().UnixMilli()
+		results[i] = BenchmarkResult{TotalTimeInMs: timeAfterExec - timeBeforeExec}
+
+		fmt.Printf("Solution: %s\n", output)
+	}
 
-	output, err := plugin.CallFunc(input)
-	if err != nil {
-		fmt.Println(err)
-		return
+	fmt.Println("Execution finished! Total time:")
+	w := tabwriter.NewWriter(os.Stdout, 0, 4, 4, ' ', 0)
+	fmt.Fprintln(w, "Day\tPart\tTime (ms)")
+	for i, plugin := range plugins {
+		// @TODO: would be nice to join day & parts in a single row, but for now it's already nice they're alphabetically sorted
+		fmt.Fprintf(w, "%s\t%s\t%d\n", plugin.Args.Day, plugin.Args.Part, results[i].TotalTimeInMs)
 	}
+	w.Flush()
 
-	fmt.Println("\nSolution:\n", output)
+	return results, nil
 }