Support labels: section in runbooks

Author: k1LoW

book.go

@@ -22,6 +22,7 @@ const noDesc = "[No Description]"
 // book - Aggregated settings. runbook settings and run settings are aggregated.
 type book struct {
 	desc                 string
+	labels               []string
 	runners              map[string]any
 	vars                 map[string]any
 	rawSteps             []map[string]any
@@ -508,6 +509,7 @@ func (bk *book) generateOperatorRoot() (string, error) {
 func (bk *book) merge(loaded *book) error {
 	bk.path = loaded.path
 	bk.desc = loaded.desc
+	bk.labels = loaded.labels
 	bk.ifCond = loaded.ifCond
 	bk.useMap = loaded.useMap
 	for k, r := range loaded.runners {

capture/runbook.go

@@ -27,11 +27,19 @@ type cRunbook struct {
 	runbooks      sync.Map
 	loadDesc      bool
 	desc          string
+	labels        []string
 	runners       map[string]any
 }
 
+type runbookMeta struct {
+	Desc    string        `yaml:"desc"`
+	Labels  []string      `yaml:"labels,omitempty"`
+	Runners yaml.MapSlice `yaml:"runners,omitempty"`
+}
+
 type runbook struct {
 	Desc    string          `yaml:"desc"`
+	Labels  []string        `yaml:"labels,omitempty"`
 	Runners yaml.MapSlice   `yaml:"runners,omitempty"`
 	Steps   []yaml.MapSlice `yaml:"steps"`
 
@@ -71,14 +79,15 @@ func (c *cRunbook) CaptureStart(trs runn.Trails, bookPath, desc string) {
 				c.errs = multierr.Append(c.errs, err)
 				return
 			}
-			rb := runbook{}
+			rb := runbookMeta{}
 			if err := yaml.Unmarshal(b, &rb); err != nil {
 				c.errs = multierr.Append(c.errs, err)
 				return
 			}
 			if c.loadDesc {
 				c.desc = rb.Desc
 			}
+			c.labels = rb.Labels
 			for _, r := range rb.Runners {
 				k, ok := r.Key.(string)
 				if !ok {
@@ -544,6 +553,7 @@ func (c *cRunbook) writeRunbook(trs runn.Trails, bookPath string) {
 	} else {
 		r.Desc = fmt.Sprintf("Captured of %s run", filepath.Base(bookPath))
 	}
+	r.Labels = c.labels
 	b, err := yaml.Marshal(r)
 	if err != nil {
 		c.errs = multierr.Append(c.errs, fmt.Errorf("failed to yaml.Marshal: %w", err))

operator.go

@@ -18,6 +18,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/goccy/go-json"
 	"github.com/k1LoW/concgroup"
 	"github.com/k1LoW/stopw"
 	"github.com/ryo-yamaoka/otchkiss"
@@ -39,6 +40,7 @@ type operator struct {
 	steps          []*step
 	store          store
 	desc           string
+	labels         []string
 	useMap         bool // Use map syntax in `steps:`.
 	debug          bool
 	disableProfile bool
@@ -420,6 +422,7 @@ func New(opts ...Option) (*operator, error) {
 		},
 		useMap:         bk.useMap,
 		desc:           bk.desc,
+		labels:         bk.labels,
 		debug:          bk.debug,
 		disableProfile: bk.disableProfile,
 		interval:       bk.interval,
@@ -441,7 +444,7 @@ func New(opts ...Option) (*operator, error) {
 		afterFuncs:     bk.afterFuncs,
 		sw:             stopw.New(),
 		capturers:      bk.capturers,
-		runResult:      newRunResult(bk.desc, bk.path),
+		runResult:      newRunResult(bk.desc, bk.labels, bk.path),
 	}
 
 	if o.debug {
@@ -776,7 +779,7 @@ func (o *operator) Result() *RunResult {
 }
 
 func (o *operator) clearResult() {
-	o.runResult = newRunResult(o.desc, o.bookPathOrID())
+	o.runResult = newRunResult(o.desc, o.labels, o.bookPathOrID())
 	o.runResult.ID = o.runbookID()
 	for _, s := range o.steps {
 		s.clearResult()
@@ -1511,20 +1514,23 @@ func setElasped(r *RunResult, result *stopw.Span) error {
 
 // collectStepElaspedByRunbookIDFull collects the elapsed time of each step by runbook ID.
 func collectStepElaspedByRunbookIDFull(r *stopw.Span, trs Trails, m map[string]time.Duration) map[string]time.Duration {
-	t, ok := r.ID.(Trail)
+	var t Trail
+	s, ok := r.ID.(string)
 	if ok {
-		trs = append(trs, t)
-		switch t.Type {
-		case TrailTypeRunbook:
-			id := trs.runbookID()
-			if !strings.Contains(id, "?step=") {
-				// Collect root runbook only
+		if err := json.Unmarshal([]byte(s), &t); err != nil {
+			trs = append(trs, t)
+			switch t.Type {
+			case TrailTypeRunbook:
+				id := trs.runbookID()
+				if !strings.Contains(id, "?step=") {
+					// Collect root runbook only
+					m[id] += r.Elapsed
+				}
+			case TrailTypeStep:
+				// Collect steps
+				id := trs.runbookID()
 				m[id] += r.Elapsed
 			}
-		case TrailTypeStep:
-			// Collect steps
-			id := trs.runbookID()
-			m[id] += r.Elapsed
 		}
 	}
 	for _, b := range r.Breakdown {

result.go

@@ -22,6 +22,7 @@ type RunResult struct {
 	// runbook ID
 	ID          string
 	Desc        string
+	Labels      []string
 	Path        string
 	Skipped     bool
 	Err         error
@@ -58,7 +59,8 @@ type runNResultSimplified struct {
 }
 
 type runResultSimplified struct {
-	ID      string                  `json:"id,omitempty"`
+	ID      string                  `json:"id"`
+	Labels  []string                `json:"labels,omitempty"`
 	Path    string                  `json:"path"`
 	Result  result                  `json:"result"`
 	Steps   []*stepResultSimplified `json:"steps"`
@@ -73,10 +75,11 @@ type stepResultSimplified struct {
 	Elapsed           time.Duration        `json:"elapsed,omitempty"`
 }
 
-func newRunResult(desc, path string) *RunResult {
+func newRunResult(desc string, labels []string, path string) *RunResult {
 	return &RunResult{
-		Desc: desc,
-		Path: path,
+		Desc:   desc,
+		Labels: labels,
+		Path:   path,
 	}
 }
 

runbook.go

@@ -39,6 +39,7 @@ type areas struct {
 
 type runbook struct {
 	Desc        string          `yaml:"desc"`
+	Labels      []string        `yaml:"labels,omitempty"`
 	Runners     map[string]any  `yaml:"runners,omitempty"`
 	Vars        map[string]any  `yaml:"vars,omitempty"`
 	Steps       []yaml.MapSlice `yaml:"steps"`
@@ -57,6 +58,7 @@ type runbook struct {
 
 type runbookMapped struct {
 	Desc        string         `yaml:"desc,omitempty"`
+	Labels      []string       `yaml:"labels,omitempty"`
 	Runners     map[string]any `yaml:"runners,omitempty"`
 	Vars        map[string]any `yaml:"vars,omitempty"`
 	Steps       yaml.MapSlice  `yaml:"steps,omitempty"`
@@ -117,6 +119,7 @@ func parseRunbookMapped(b []byte, rb *runbook) error {
 	}
 	rb.useMap = true
 	rb.Desc = m.Desc
+	rb.Labels = m.Labels
 	rb.Runners = m.Runners
 	rb.Vars = m.Vars
 	rb.Debug = m.Debug
@@ -179,6 +182,7 @@ func (rb *runbook) MarshalYAML() (any, error) {
 	}
 	m := &runbookMapped{}
 	m.Desc = rb.Desc
+	m.Labels = rb.Labels
 	m.Runners = rb.Runners
 	m.Vars = rb.Vars
 	m.Debug = rb.Debug
@@ -355,6 +359,7 @@ func (rb *runbook) toBook() (*book, error) {
 	)
 	bk := newBook()
 	bk.desc = rb.Desc
+	bk.labels = rb.Labels
 	bk.runners, ok = normalize(rb.Runners).(map[string]any)
 	if !ok {
 		return nil, fmt.Errorf("failed to normalize runners: %v", rb.Runners)

testdata/book/http.yml

@@ -1,4 +1,7 @@
 desc: Test using HTTP
+labels:
+  - http
+  - openapi3
 runners:
   req:
     endpoint: ${TEST_HTTP_END_POINT:-https:example.com}

testdata/grpc.yml.runbook.golden

@@ -1,7 +1,10 @@
 -- -testdata-book-grpc.yml --
 desc: Captured of grpc.yml run
 runners:
-  greq: '[THIS IS gRPC RUNNER]'
+  greq:
+    addr: grpc://grpc.example.com:443
+    protos:
+    - ../grpctest.proto
 steps:
 - greq:
     grpctest.GrpcTestService/Hello:

testdata/http.yml.runbook.golden

@@ -1,7 +1,12 @@
 -- -testdata-book-http.yml --
 desc: Captured of http.yml run
+labels:
+- http
+- openapi3
 runners:
-  req: '[THIS IS HTTP RUNNER]'
+  req:
+    endpoint: ${TEST_HTTP_END_POINT:-https:example.com}
+    openapi3: ../openapi3.yml
 steps:
 - req:
     /users:

testdata/http_multipart.yml.runbook.golden

@@ -1,7 +1,9 @@
 -- -testdata-book-http_multipart.yml --
 desc: Captured of http_multipart.yml run
 runners:
-  req: '[THIS IS HTTP RUNNER]'
+  req:
+    endpoint: ${TEST_HTTP_END_POINT:-https:example.com}
+    openapi3: ../openapi3.yml
 steps:
 - req:
     /upload:

testdata/pick_step.http.yml.0.golden

@@ -1,7 +1,7 @@
- 7   getusers:
- 8     req:
- 9       /users:
-10         get:
-11           body: null
-12     test: |
-13       'bob' in map(current.res.body, {#.username})
+10   getusers:
+11     req:
+12       /users:
+13         get:
+14           body: null
+15     test: |
+16       'bob' in map(current.res.body, {#.username})

testdata/pick_step.http.yml.8.golden

@@ -1,10 +1,10 @@
- 91   fileupload:
- 92     desc: Post /upload with single file
- 93     req:
- 94       /upload:
- 95         post:
- 96           body:
- 97             multipart/form-data:
- 98               upload0: ../dummy.png
- 99     test: |
-100       current.res.status == 201
+ 94   fileupload:
+ 95     desc: Post /upload with single file
+ 96     req:
+ 97       /upload:
+ 98         post:
+ 99           body:
+100             multipart/form-data:
+101               upload0: ../dummy.png
+102     test: |
+103       current.res.status == 201

trail.go

@@ -31,6 +31,7 @@ const (
 )
 
 // Trail - The trail of elements in the runbook at runtime.
+// Trail does not use slices to copy values.
 type Trail struct {
 	Type           TrailType  `json:"type"`
 	Desc           string     `json:"desc,omitempty"`