feat(metrics,configparse): allow any metric types for tests

Author: GregoryAlbouy

internal/configparse/parse.go

@@ -2,10 +2,12 @@ package configparse
 
 import (
 	"errors"
+	"fmt"
 	"net/http"
 	"net/url"
 	"os"
 	"path/filepath"
+	"strconv"
 	"time"
 
 	"github.com/benchttp/engine/runner"
@@ -261,12 +263,16 @@ func newParsedConfig(uconf unmarshaledConfig) (parsedConfig, error) { //nolint:g
 	if tests := uconf.Tests; len(tests) > 0 {
 		cases := make([]runner.TestCase, len(tests))
 		for i, t := range tests {
-			d, _ := parseOptionalDuration(*t.Target)
+			source := runner.MetricsSource(*t.Source)
+			target, err := parseMetricValue(source.Type(), *t.Target)
+			if err != nil {
+				return parsedConfig{}, err
+			}
 			cases[i] = runner.TestCase{
 				Name:      *t.Name,
 				Source:    runner.MetricsSource(*t.Source),
 				Predicate: runner.TestPredicate(*t.Predicate),
-				Target:    runner.MetricsValue(d),
+				Target:    target,
 			}
 		}
 		cfg.Tests = cases
@@ -309,3 +315,14 @@ func parseOptionalDuration(raw string) (time.Duration, error) {
 	}
 	return time.ParseDuration(raw)
 }
+
+func parseMetricValue(typ runner.MetricsType, in string) (runner.MetricsValue, error) {
+	switch typ {
+	case runner.MetricsTypeInt:
+		return strconv.Atoi(in)
+	case runner.MetricsTypeDuration:
+		return time.ParseDuration(in)
+	default:
+		return nil, fmt.Errorf("cannot parse metrics type: %v", typ)
+	}
+}

internal/configparse/parse_test.go

@@ -222,6 +222,12 @@ func newExpConfig() runner.Config {
 				Predicate: "LTE",
 				Target:    120 * time.Millisecond,
 			},
+			{
+				Name:      "100% availability",
+				Source:    "FAILURE_COUNT",
+				Predicate: "EQ",
+				Target:    0,
+			},
 		},
 	}
 }

internal/configparse/testdata/valid/benchttp.json

@@ -28,15 +28,21 @@
   "tests": [
     {
       "name": "minimum response time",
-      "metric": "MIN",
+      "source": "MIN",
       "predicate": "GT",
-      "value": "80ms"
+      "target": "80ms"
     },
     {
       "name": "maximum response time",
-      "metric": "MAX",
+      "source": "MAX",
       "predicate": "LTE",
-      "value": "120ms"
+      "target": "120ms"
+    },
+    {
+      "name": "100% availability",
+      "source": "FAILURE_COUNT",
+      "predicate": "EQ",
+      "target": "0"
     }
   ]
 }

internal/configparse/testdata/valid/benchttp.yaml

@@ -26,14 +26,14 @@ output:
 
 tests:
   - name: minimum response time
-    metric: MIN
+    source: MIN
     predicate: GT
-    value: 80ms
+    target: 80ms
   - name: maximum response time
-    metric: MAX
+    source: MAX
     predicate: LTE
-    value: 120ms
-  # - name: 100% availability
-  #   metric: FAILURE_COUNT
-  #   predicate: EQ
-  #   value: 0
+    target: 120ms
+  - name: 100% availability
+    source: FAILURE_COUNT
+    predicate: EQ
+    target: 0

internal/configparse/testdata/valid/benchttp.yml

@@ -23,14 +23,14 @@ output:
 
 tests:
   - name: minimum response time
-    metric: MIN
+    source: MIN
     predicate: GT
-    value: 80ms
+    target: 80ms
   - name: maximum response time
-    metric: MAX
+    source: MAX
     predicate: LTE
-    value: 120ms
-  # - name: 100% availability
-  #   metric: FAILURE_COUNT
-  #   predicate: EQ
-  #   value: 0
+    target: 120ms
+  - name: 100% availability
+    source: FAILURE_COUNT
+    predicate: EQ
+    target: 0

runner/internal/metrics/metrics.go

@@ -1,5 +1,7 @@
 package metrics
 
+import "reflect"
+
 type Value interface{}
 
 type Source string
@@ -13,6 +15,23 @@ const (
 	RequestCount        Source = "TOTAL_COUNT"
 )
 
+type Type uint8
+
+const (
+	TypeInt      Type = Type(reflect.Int)
+	TypeDuration Type = 12
+)
+
+func (src Source) Type() Type {
+	switch src {
+	case ResponseTimeAvg, ResponseTimeMin, ResponseTimeMax:
+		return TypeDuration
+	case RequestFailCount, RequestSuccessCount, RequestCount:
+		return TypeInt
+	}
+	panic(badSource(src))
+}
+
 func (agg Aggregate) MetricOf(src Source) Metric {
 	var v interface{}
 	switch src {
@@ -29,7 +48,7 @@ func (agg Aggregate) MetricOf(src Source) Metric {
 	case RequestCount:
 		v = agg.TotalCount
 	default:
-		panic("metrics.Aggregate.MetricOf: unknown Source: " + src)
+		panic(badSource(src))
 	}
 	return Metric{Source: src, Value: v}
 }
@@ -42,3 +61,11 @@ type Metric struct {
 func (m Metric) Compare(to Metric) ComparisonResult {
 	return compareMetrics(m, to)
 }
+
+func ValueOf(src Source, v Value) Value {
+	return Metric{Source: src, Value: v}
+}
+
+func badSource(src Source) string {
+	return "metrics: unknown Source: " + string(src)
+}

runner/runner.go

@@ -25,6 +25,7 @@ type (
 
 	MetricsSource = metrics.Source
 	MetricsValue  = metrics.Value
+	MetricsType   = metrics.Type
 
 	TestCase      = tests.Case
 	TestPredicate = tests.Predicate
@@ -55,6 +56,10 @@ var (
 	ConfigFieldsUsage = config.FieldsUsage
 	NewRequestBody    = config.NewRequestBody
 	IsConfigField     = config.IsField
+
+	MetricsValueOf      = metrics.ValueOf
+	MetricsTypeInt      = metrics.TypeInt
+	MetricsTypeDuration = metrics.TypeDuration
 )
 
 type Runner struct {