feat: major api improvements

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
           go-version: 1.17
 
       - name: Install coverage tool
-        run: go get github.com/ory/go-acc
+        run: go install github.com/ory/go-acc@v0.2.8
 
       # Check #1: Lint
       - name: Lint
@@ -28,7 +28,7 @@ jobs:
 
       # Check #2: Test & generate coverage report
       - name: Test & coverage
-        run: make test-cov
+        run: ./script/coverage
 
       - name: Upload coverage report
         uses: codecov/codecov-action@v1.0.2

.gitignore

@@ -1,9 +1,3 @@
-# Env files
-.env
-
-# Binary files
-/bin
-
 # IDE files
 /.vscode
 /.idea
@@ -12,6 +6,3 @@
 /.benchttp.yml
 /.benchttp.yaml
 /.benchttp.json
-
-# Benchttp reports
-/benchttp.report.*.json

.golangci.yml

@@ -111,7 +111,7 @@ linters-settings:
     extra-rules: true
 
   goimports:
-    local-prefixes: github.com/benchttp/engine
+    local-prefixes: github.com/benchttp/sdk
 
   misspell:
     locale: US
@@ -131,7 +131,6 @@ linters:
   disable-all: true
   enable:
     - bodyclose # enforce resp.Body.Close()
-    - deadcode
     - dupl # duplicate code
     - errcheck
     - exportloopref
@@ -145,10 +144,8 @@ linters:
     - prealloc # enforce capacity allocation when possible
     - revive # golint enhancement
     - staticcheck # go vet enhancement
-    - structcheck # unused struct fields
     - testpackage # checks on tests (*_test)
     - thelper # enforce t.Helper()
-    - varcheck # unused global var and const
     - wastedassign
   fast: false
 

README.md

@@ -5,12 +5,12 @@
     <img alt="Github Worklow Status" src="https://img.shields.io/github/actions/workflow/status/benchttp/engine/ci.yml?branch=main"></a>
   <a href="https://codecov.io/gh/benchttp/engine">
     <img alt="Code coverage" src="https://img.shields.io/codecov/c/gh/benchttp/engine?label=coverage"></a>
-  <a href="https://goreportcard.com/report/github.com/benchttp/engine">
-    <img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/benchttp/engine" /></a>
+  <a href="https://goreportcard.com/report/github.com/benchttp/sdk">
+    <img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/benchttp/sdk" /></a>
   <br />
-  <a href="https://pkg.go.dev/github.com/benchttp/engine#section-documentation">
+  <a href="https://pkg.go.dev/github.com/benchttp/sdk#section-documentation">
     <img alt="Go package Reference" src="https://img.shields.io/badge/pkg-reference-informational?logo=go" /></a>
-  <a href="https://github.com/benchttp/engine/releases">
+  <a href="https://github.com/benchttp/sdk/releases">
     <img alt="Latest version" src="https://img.shields.io/github/v/tag/benchttp/engine?label=release"></a>
 </p>
 
@@ -28,7 +28,7 @@ Go1.17 environment or higher is required.
 Install.
 
 ```txt
-go get github.com/benchttp/engine
+go get github.com/benchttp/sdk
 ```
 
 ## Usage
@@ -42,16 +42,14 @@ import (
     "context"
     "fmt"
 
-    "github.com/benchttp/engine/runner"
+    "github.com/benchttp/sdk/benchttp"
 )
 
-func main(t *testing.T) {
-    // Set runner configuration
-    config := runner.DefaultConfig()
-    config.Request = config.Request.WithURL("https://example.com")
-
-    // Instantiate runner and run benchmark
-    report, _ := runner.New(nil).Run(context.Background(), config)
+func main() {
+    report, _ := benchttp.
+        DefaultRunner(). // Default runner with safe configuration
+        WithNewRequest("GET", "http://localhost:3000", nil). // Attach request
+        Run(context.Background()) // Run benchmark, retrieve report
 
     fmt.Println(report.Metrics.ResponseTimes.Mean)
 }
@@ -66,27 +64,33 @@ import (
     "context"
     "fmt"
 
-    "github.com/benchttp/engine/configparse"
-    "github.com/benchttp/engine/runner"
+    "github.com/benchttp/sdk/benchttp"
+    "github.com/benchttp/sdk/configparse"
 )
 
 func main() {
     // JSON configuration obtained via e.g. a file or HTTP call
     jsonConfig := []byte(`
 {
   "request": {
-    "url": "https://example.com"
+    "url": "http://localhost:3000"
   }
 }`)
 
-    config, _ := configparse.JSON(jsonConfig)
-    report, _ := runner.New(nil).Run(context.Background(), config)
+    // Instantiate a base Runner (here the default with a safe configuration)
+    runner := benchttp.DefaultRunner()
+
+    // Parse the json configuration into the Runner
+    _ = configparse.JSON(jsonConfig, &runner)
+
+    // Run benchmark, retrieve report
+    report, _ := runner.Run(context.Background())
 
     fmt.Println(report.Metrics.ResponseTimes.Mean)
 }
 ```
 
-📄 Please refer to [our Wiki](https://github.com/benchttp/engine/wiki/IO-Structures) for exhaustive `Config` and `Report` structures (and more!)
+📄 Please refer to [our Wiki](https://github.com/benchttp/sdk/wiki/IO-Structures) for exhaustive `Runner` and `Report` structures (and more!)
 
 ## Development
 
@@ -97,8 +101,8 @@ func main() {
 
 ### Main commands
 
-| Command      | Description                         |
-| ------------ | ----------------------------------- |
-| `make lint`  | Runs lint on the codebase           |
-| `make tests` | Runs tests suites from all packages |
-| `make check` | Runs both lint and tests            |
+| Command         | Description                                       |
+| --------------- | ------------------------------------------------- |
+| `./script/lint` | Runs lint on the codebase                         |
+| `./script/test` | Runs tests suites from all packages               |
+| `./script/doc`  | Serves Go doc for this module at `localhost:9995` |

runner/internal/config/error.go → benchttp/error.go

@@ -1,15 +1,15 @@
-package config
+package benchttp
 
 import "strings"
 
-// InvalidConfigError is the errors returned by Global.Validate
+// InvalidRunnerError is the errors returned by Runner.Validate
 // when values are missing or invalid.
-type InvalidConfigError struct {
+type InvalidRunnerError struct {
 	Errors []error
 }
 
-// Error returns the joined errors of InvalidConfigError as a string.
-func (e *InvalidConfigError) Error() string {
+// Error returns the joined errors of InvalidRunnerError as a string.
+func (e *InvalidRunnerError) Error() string {
 	const sep = "\n  - "
 
 	var b strings.Builder

runner/internal/config/error_test.go → benchttp/error_test.go

@@ -1,14 +1,14 @@
-package config_test
+package benchttp_test
 
 import (
 	"errors"
 	"testing"
 
-	"github.com/benchttp/engine/runner/internal/config"
+	"github.com/benchttp/sdk/benchttp"
 )
 
-func TestInvalidConfigError_Error(t *testing.T) {
-	e := config.InvalidConfigError{
+func TestInvalidRunnerError(t *testing.T) {
+	e := benchttp.InvalidRunnerError{
 		Errors: []error{
 			errors.New("error 0"),
 			errors.New("error 1\nwith new line"),

runner/internal/metrics/aggregate.go → benchttp/internal/metrics/aggregate.go

@@ -3,8 +3,8 @@ package metrics
 import (
 	"time"
 
-	"github.com/benchttp/engine/runner/internal/metrics/timestats"
-	"github.com/benchttp/engine/runner/internal/recorder"
+	"github.com/benchttp/sdk/benchttp/internal/metrics/timestats"
+	"github.com/benchttp/sdk/benchttp/internal/recorder"
 )
 
 type TimeStats = timestats.TimeStats

runner/internal/metrics/aggregate_test.go → benchttp/internal/metrics/aggregate_test.go

@@ -5,9 +5,9 @@ import (
 	"testing"
 	"time"
 
-	"github.com/benchttp/engine/runner/internal/metrics"
-	"github.com/benchttp/engine/runner/internal/metrics/timestats"
-	"github.com/benchttp/engine/runner/internal/recorder"
+	"github.com/benchttp/sdk/benchttp/internal/metrics"
+	"github.com/benchttp/sdk/benchttp/internal/metrics/timestats"
+	"github.com/benchttp/sdk/benchttp/internal/recorder"
 )
 
 func TestNewAggregate(t *testing.T) {

runner/internal/metrics/field.go → benchttp/internal/metrics/field.go

@@ -3,7 +3,7 @@ package metrics
 import (
 	"errors"
 
-	"github.com/benchttp/engine/internal/errorutil"
+	"github.com/benchttp/sdk/internal/errorutil"
 )
 
 // ErrUnknownField occurs when a Field is used with an invalid path.

runner/internal/metrics/field_test.go → benchttp/internal/metrics/field_test.go

@@ -3,7 +3,7 @@ package metrics_test
 import (
 	"testing"
 
-	"github.com/benchttp/engine/runner/internal/metrics"
+	"github.com/benchttp/sdk/benchttp/internal/metrics"
 )
 
 func TestField_Type(t *testing.T) {

runner/internal/metrics/metrics.go → benchttp/internal/metrics/metrics.go

@@ -3,7 +3,7 @@ package metrics
 import (
 	"strings"
 
-	"github.com/benchttp/engine/runner/internal/reflectpath"
+	"github.com/benchttp/sdk/benchttp/internal/reflectpath"
 )
 
 // Value is a concrete metric value, e.g. 120 or 3 * time.Second.

runner/internal/metrics/metrics_test.go → benchttp/internal/metrics/metrics_test.go

@@ -4,8 +4,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/benchttp/engine/runner/internal/metrics"
-	"github.com/benchttp/engine/runner/internal/metrics/timestats"
+	"github.com/benchttp/sdk/benchttp/internal/metrics"
+	"github.com/benchttp/sdk/benchttp/internal/metrics/timestats"
 )
 
 func TestMetric_Compare(t *testing.T) {

runner/internal/metrics/timestats/timestats_test.go → benchttp/internal/metrics/timestats/timestats_test.go

@@ -4,7 +4,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/benchttp/engine/runner/internal/metrics/timestats"
+	"github.com/benchttp/sdk/benchttp/internal/metrics/timestats"
 )
 
 func TestCompute(t *testing.T) {

runner/internal/recorder/recorder.go → benchttp/internal/recorder/recorder.go

@@ -7,7 +7,7 @@ import (
 	"sync"
 	"time"
 
-	"github.com/benchttp/engine/internal/dispatcher"
+	"github.com/benchttp/sdk/internal/dispatcher"
 )
 
 const (

runner/internal/recorder/recorder_internal_test.go → benchttp/internal/recorder/recorder_internal_test.go

@@ -9,7 +9,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/benchttp/engine/internal/dispatcher"
+	"github.com/benchttp/sdk/internal/dispatcher"
 )
 
 var errTest = errors.New("test-generated error")

runner/internal/tests/predicate.go → benchttp/internal/tests/predicate.go

@@ -3,8 +3,8 @@ package tests
 import (
 	"errors"
 
-	"github.com/benchttp/engine/internal/errorutil"
-	"github.com/benchttp/engine/runner/internal/metrics"
+	"github.com/benchttp/sdk/benchttp/internal/metrics"
+	"github.com/benchttp/sdk/internal/errorutil"
 )
 
 var ErrUnknownPredicate = errors.New("tests: unknown predicate")

runner/internal/tests/predicate_test.go → benchttp/internal/tests/predicate_test.go

@@ -4,8 +4,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/benchttp/engine/runner/internal/metrics"
-	"github.com/benchttp/engine/runner/internal/tests"
+	"github.com/benchttp/sdk/benchttp/internal/metrics"
+	"github.com/benchttp/sdk/benchttp/internal/tests"
 )
 
 func TestPredicate(t *testing.T) {

runner/internal/tests/tests.go → benchttp/internal/tests/tests.go

@@ -3,7 +3,7 @@ package tests
 import (
 	"fmt"
 
-	"github.com/benchttp/engine/runner/internal/metrics"
+	"github.com/benchttp/sdk/benchttp/internal/metrics"
 )
 
 type Case struct {

runner/internal/tests/tests_test.go → benchttp/internal/tests/tests_test.go

@@ -5,9 +5,9 @@ import (
 	"testing"
 	"time"
 
-	"github.com/benchttp/engine/runner/internal/metrics"
-	"github.com/benchttp/engine/runner/internal/metrics/timestats"
-	"github.com/benchttp/engine/runner/internal/tests"
+	"github.com/benchttp/sdk/benchttp/internal/metrics"
+	"github.com/benchttp/sdk/benchttp/internal/metrics/timestats"
+	"github.com/benchttp/sdk/benchttp/internal/tests"
 )
 
 func TestRun(t *testing.T) {