bump go version + move result file content + standard deviation in re…

…sult

go.mod

@@ -1,8 +1,10 @@
 module github.com/Shravan-1908/bench
 
-go 1.16
+go 1.20
 
 require (
-	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
+	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
 	github.com/thatisuday/commando v1.0.4
 )
+
+require github.com/thatisuday/clapper v1.0.10 // indirect

internal/export.go

@@ -6,6 +6,16 @@ import (
 	"text/template"
 )
 
+// Result struct which is shown at the end as benchmarking summary and is written to a file.
+type Result struct {
+	Started           string
+	Ended             string
+	Command           string
+	Iterations        int
+	Average           string
+	StandardDeviation string
+}
+
 var summaryNoColor = `
 Benchmarking Summary
 --------------------
@@ -14,7 +24,7 @@ Started:            {{ .Started }}
 Ended:              {{ .Ended }} 
 Executed Command:   {{ .Command }} 
 Total iterations:   {{ .Iterations }} 
-Average time taken: {{ .Average }} 
+Average time taken: {{ .Average }} ± {{ .StandardDeviation }}
 `
 
 var summaryColor = `
@@ -25,9 +35,8 @@ ${yellow}Started:            ${green}{{ .Started }} ${reset}
 ${yellow}Ended:              ${green}{{ .Ended }} ${reset}
 ${yellow}Executed Command:   ${green}{{ .Command }} ${reset}
 ${yellow}Total iterations:   ${green}{{ .Iterations }} ${reset}
-${yellow}Average time taken: ${green}{{ .Average }} ${reset}
+${yellow}Average time taken: ${green}{{ .Average }} ± {{ .StandardDeviation }} ${reset}
 `
-// todo add standard deviation to summary
 
 // Consolify prints the benchmark summary of the Result struct to the console, with color codes.
 func (result *Result) Consolify() {
@@ -126,6 +135,6 @@ func (result *Result) Export(exportFormat string) {
 		markdownify(result)
 
 	} else if exportFormat != "none" {
-		Log("red", "Invalid export format: " + exportFormat + ".")
+		Log("red", "Invalid export format: "+exportFormat+".")
 	}
 }

internal/up.go

@@ -1,15 +1,16 @@
 package internal
 
+// todo replace self updater with check for updates
+
 import (
 	"io"
-	"io/ioutil"
 	"net/http"
 	"os"
 	"runtime"
 	"strings"
+	"sync"
 )
 
-
 // Update updates bench by downloading the latest executable from github, and renaming the
 // old executable to `bench-old` so that it can be deleted by `DeletePreviousInstallation`.
 func Update() {
@@ -80,16 +81,17 @@ func Update() {
 }
 
 // DeletePreviousInstallation deletes previous installation if it exists.
-func DeletePreviousInstallation() {
+func DeletePreviousInstallation(wg *sync.WaitGroup) {
 	benchDir, _ := os.UserHomeDir()
 	benchDir += "/.bench"
 
-	files, _ := ioutil.ReadDir(benchDir)
+	files, _ := os.ReadDir(benchDir)
 	for _, f := range files {
 		if strings.HasSuffix(f.Name(), "-old") {
 			// fmt.Println("found existsing installation")
 			os.Remove(benchDir + "/" + f.Name())
 		}
 		// fmt.Println(f.Name())
 	}
+	wg.Done()
 }

internal/utils.go

@@ -2,6 +2,7 @@ package internal
 
 import (
 	"fmt"
+	"math"
 	"os"
 	"strings"
 )
@@ -25,3 +26,24 @@ func writeToFile(text, filename string) (err error) {
 	_, err = f.WriteString(text)
 	return err
 }
+
+type numberLike interface {
+	~int | ~float64 | ~int32 | ~int64 | ~float32
+}
+
+func ComputeAverageAndStandardDeviation[T numberLike](population []T) (float64, float64) {
+	var deviationSum float64 = 0
+	var avg float64 = 0
+	n := float64(len(population))
+	for _, v := range population {
+		avg += float64(v)
+	}
+	avg /= n
+	for _, v := range population {
+		deviationSum += math.Pow((float64(v) - avg), 2)
+	}
+	deviationSum /= n
+	deviationSum = math.Sqrt(deviationSum)
+
+	return avg, deviationSum
+}

main.go

@@ -5,11 +5,12 @@ import (
 	"os"
 	"os/exec"
 	"strings"
+	"sync"
 	"time"
 
 	"github.com/Shravan-1908/bench/internal"
-	"github.com/thatisuday/commando"
 	"github.com/google/shlex"
+	"github.com/thatisuday/commando"
 )
 
 const (
@@ -55,7 +56,9 @@ func run(command []string, verbose bool, ignoreError bool) (time.Duration, error
 func main() {
 	internal.Log("white", fmt.Sprintf("%v %v\n", NAME, VERSION))
 
-	go internal.DeletePreviousInstallation()
+	var wg sync.WaitGroup
+	wg.Add(1)
+	go internal.DeletePreviousInstallation(&wg)
 
 	// * basic configuration
 	commando.
@@ -130,9 +133,8 @@ func main() {
 			}
 
 			// actual runs
-			var sum time.Duration
+			var runs []int64
 			started := time.Now().Format("02-01-2006 15:04:05")
-
 			// * looping for given iterations
 			for i := 1; i <= iterations; i++ {
 				internal.Log("purple", fmt.Sprintf("***********\nRunning iteration %d\n***********", i))
@@ -141,18 +143,30 @@ func main() {
 				if e != nil {
 					return
 				}
-				sum += dur
+				runs = append(runs, (dur.Microseconds()))
 			}
 
 			ended := time.Now().Format("02-01-2006 15:04:05")
 
 			// * intialising the template struct
+			avg, stddev := internal.ComputeAverageAndStandardDeviation(runs)
+			avgString := fmt.Sprintf("%.2fus", avg)
+			avgDuration, err := time.ParseDuration(avgString)
+			if err != nil {
+				panic("unable to parse duration from string: " + avgString + "\n" + err.Error())
+			}
+			stddevString := fmt.Sprintf("%.2fus", stddev)
+			stddevDuration, err := time.ParseDuration(stddevString)
+			if err != nil {
+				panic("unable to parse duration from string: " + stddevString + "\n" + err.Error())
+			}
 			result := internal.Result{
 				Started:    started,
 				Ended:      ended,
 				Command:    strings.Join(command, " "),
 				Iterations: iterations,
-				Average:    (sum / time.Duration(iterations)).String(),
+				Average:    avgDuration.String(),
+				StandardDeviation: stddevDuration.String(),
 			}
 
 			result.Consolify()
@@ -182,4 +196,5 @@ func main() {
 		})
 
 	commando.Parse(nil)
+	wg.Wait()
 }