feat: add examples

Author: not-matthias

example-codspeed/cli/runner.go

@@ -0,0 +1,86 @@
+//go:build codspeed
+// +build codspeed
+
+package main
+
+import (
+	"fmt"
+	"io"
+	"reflect"
+	"time"
+
+	example "example"
+
+	codspeed_testing "github.com/CodSpeedHQ/codspeed-go/testing/testing"
+)
+
+type corpusEntry = struct {
+	Parent     string
+	Path       string
+	Data       []byte
+	Values     []any
+	Generation int
+	IsSeed     bool
+}
+
+type simpleDeps struct{}
+
+func (d simpleDeps) ImportPath() string                          { return "" }
+func (d simpleDeps) MatchString(pat, str string) (bool, error)   { return true, nil }
+func (d simpleDeps) SetPanicOnExit0(bool)                        {}
+func (d simpleDeps) StartCPUProfile(io.Writer) error             { return nil }
+func (d simpleDeps) StopCPUProfile()                             {}
+func (d simpleDeps) StartTestLog(io.Writer)                      {}
+func (d simpleDeps) StopTestLog() error                          { return nil }
+func (d simpleDeps) WriteProfileTo(string, io.Writer, int) error { return nil }
+
+func (d simpleDeps) CoordinateFuzzing(
+	fuzzTime time.Duration,
+	fuzzN int64,
+	minimizeTime time.Duration,
+	minimizeN int64,
+	parallel int,
+	corpus []corpusEntry,
+	types []reflect.Type,
+	corpusDir,
+	cacheDir string,
+) error {
+	return nil
+}
+func (d simpleDeps) RunFuzzWorker(fn func(corpusEntry) error) error {
+	return nil
+}
+func (d simpleDeps) ReadCorpus(dir string, types []reflect.Type) ([]corpusEntry, error) {
+	return nil, nil
+}
+func (d simpleDeps) CheckCorpus(vals []any, types []reflect.Type) error {
+	return nil
+}
+func (d simpleDeps) ResetCoverage()    {}
+func (d simpleDeps) SnapshotCoverage() {}
+func (d simpleDeps) InitRuntimeCoverage() (mode string, tearDown func(coverprofile string, gocoverdir string) (string, error), snapcov func() float64) {
+	return "", nil, nil
+}
+
+func main() {
+	var tests = []codspeed_testing.InternalTest{}
+	var fuzzTargets = []codspeed_testing.InternalFuzzTarget{}
+	var examples = []codspeed_testing.InternalExample{}
+	var benchmarks = []codspeed_testing.InternalBenchmark{
+		{
+			Name: "BenchmarkFibonacci10",
+			F:    example.BenchmarkFibonacci10,
+		},
+		{
+			Name: "BenchmarkFibonacci20",
+			F:    example.BenchmarkFibonacci20,
+		},
+	}
+
+	for i := 0; i < len(benchmarks); i++ {
+		fmt.Printf("Benchmark %d: %s\n", i, benchmarks[i].Name)
+	}
+
+	m := codspeed_testing.MainStart(simpleDeps{}, tests, benchmarks, fuzzTargets, examples)
+	m.Run()
+}

example-codspeed/fib.go

@@ -0,0 +1,8 @@
+package example
+
+func fibonacci(n int) int {
+	if n <= 1 {
+		return n
+	}
+	return fibonacci(n-1) + fibonacci(n-2)
+}

example-codspeed/fib_codspeed.go

@@ -0,0 +1,35 @@
+package example
+
+import (
+	testing "github.com/CodSpeedHQ/codspeed-go/compat/testing"
+)
+
+func BenchmarkFibonacci10(b *testing.B) {
+	// b.Run("fibonacci(40)", func(b *testing.B) {
+	// 	for i := 0; i < b.N; i++ {
+	// 		fibonacci(10)
+	// 	}
+	// })
+	// b.Run("fibonacci(20)", func(b *testing.B) {
+	// 	for i := 0; i < b.N; i++ {
+	// 		fibonacci(20)
+	// 	}
+	// })
+	b.RunParallel(func(b *testing.PB) {
+		for b.Next() {
+			fibonacci(30)
+		}
+	})
+}
+
+func BenchmarkFibonacci20(b *testing.B) {
+	for b.Loop() {
+		fibonacci(30)
+	}
+}
+
+// func BenchmarkFibonacci30(b *testing.B) {
+// 	for i := 0; i < b.N; i++ {
+// 		fibonacci(30)
+// 	}
+// }

example-codspeed/go.mod

@@ -0,0 +1,7 @@
+module example
+
+go 1.24.3
+
+require github.com/CodSpeedHQ/codspeed-go v0.0.0
+
+replace github.com/CodSpeedHQ/codspeed-go => ..

example/fib.go

@@ -0,0 +1,8 @@
+package example
+
+func fibonacci(n int) int {
+	if n <= 1 {
+		return n
+	}
+	return fibonacci(n-1) + fibonacci(n-2)
+}

example/fib_test.go

@@ -0,0 +1,32 @@
+package example
+
+import "testing"
+
+func BenchmarkFibonacci10(b *testing.B) {
+	b.Run("fibonacci(10)", func(b *testing.B) {
+		b.Run("fibonacci(10)", func(b *testing.B) {
+			for i := 0; i < b.N; i++ {
+				fibonacci(10)
+			}
+		})
+
+	})
+}
+
+func BenchmarkFibonacci20_Loop(b *testing.B) {
+	for b.Loop() {
+		fibonacci(20)
+	}
+}
+
+func BenchmarkFibonacci20_bN(b *testing.B) {
+	for i := 0; i < b.N; i++ {
+		fibonacci(20)
+	}
+}
+
+// func BenchmarkFibonacci30(b *testing.B) {
+// 	b.Run("fibonacci(30)", func(b *testing.B) {
+// 		this shouldn't be executed
+// 	})
+// }

example/go.mod

@@ -0,0 +1,3 @@
+module example
+
+go 1.24.3

example/main.go

@@ -0,0 +1,6 @@
+package example
+
+func main() {
+	// This is a placeholder for the main function.
+	// The actual implementation will depend on the specific requirements of the application.
+}

example/sleep_test.go

@@ -0,0 +1,55 @@
+package example
+
+import (
+	"testing"
+	"time"
+)
+
+func busyWait(duration time.Duration) {
+	start := time.Now()
+	for time.Since(start) < duration {
+		// Busy wait loop
+	}
+}
+
+func BenchmarkSleep100ns(b *testing.B) {
+	for i := 0; i < b.N; i++ {
+		busyWait(100 * time.Nanosecond)
+	}
+}
+
+func BenchmarkSleep1us(b *testing.B) {
+	for i := 0; i < b.N; i++ {
+		busyWait(1 * time.Microsecond)
+	}
+}
+
+func BenchmarkSleep10us(b *testing.B) {
+	for i := 0; i < b.N; i++ {
+		busyWait(10 * time.Microsecond)
+	}
+}
+
+func BenchmarkSleep100us(b *testing.B) {
+	for i := 0; i < b.N; i++ {
+		busyWait(100 * time.Microsecond)
+	}
+}
+
+func BenchmarkSleep1ms(b *testing.B) {
+	for i := 0; i < b.N; i++ {
+		busyWait(1 * time.Millisecond)
+	}
+}
+
+func BenchmarkSleep10ms(b *testing.B) {
+	for i := 0; i < b.N; i++ {
+		busyWait(10 * time.Millisecond)
+	}
+}
+
+func BenchmarkSleep50ms(b *testing.B) {
+	for i := 0; i < b.N; i++ {
+		busyWait(50 * time.Millisecond)
+	}
+}