Add command output expectation support

Author: bukka

TODO.md

@@ -49,9 +49,7 @@ in the future.
 
 #### Structure - Instances, Actions, Servers, Services
 
-- add command expectation for checking its output
-- look into doing some partial expectation
-  - some sort of contains mode rather than full match
+- test properly command action / expectation usage and possibly add some tweaks and fixes
 - introduce action parameter `on_failure` to set what to do when action fails
   - it should either fail (default) or skip the rest of sequence
   - this is to allow skipping the tests that are for example not applicable on certain configuration

conf/types/action.go

@@ -27,6 +27,7 @@ type CustomExpectationAction struct {
 }
 
 type OutputExpectation struct {
+	Command        string   `wst:"command"`
 	Order          string   `wst:"order,enum=fixed|random,default=fixed"`
 	Match          string   `wst:"match,enum=exact|regexp|prefix|suffix|infix,default=exact"`
 	Type           string   `wst:"type,enum=stdout|stderr|any,default=any"`

mocks/generated/run/environments/environment/output/mock_Collector.go

@@ -1,7 +1,6 @@
 package expect
 
 import (
-	"bufio"
 	"context"
 	"errors"
 	"fmt"
@@ -223,8 +222,7 @@ func Test_customAction_Execute(t *testing.T) {
 				fnd.On("Logger").Return(mockLogger.SugaredLogger)
 				svc.On("RenderTemplate", "test", params).Return("test tmp", nil)
 				r := strings.NewReader("test tmp")
-				scanner := bufio.NewScanner(r)
-				svc.On("OutputScanner", ctx, outputType).Return(scanner, nil)
+				svc.On("OutputReader", ctx, outputType).Return(r, nil)
 			},
 			expectedOutputType: output.Any,
 			want:               true,

mocks/generated/run/services/mock_Service.go

@@ -15,15 +15,18 @@
 package expect
 
 import (
+	"bufio"
 	"context"
 	"fmt"
+	"github.com/pkg/errors"
 	"github.com/wstool/wst/conf/types"
 	"github.com/wstool/wst/run/actions/action"
 	"github.com/wstool/wst/run/environments/environment/output"
 	"github.com/wstool/wst/run/expectations"
 	"github.com/wstool/wst/run/instances/runtime"
 	"github.com/wstool/wst/run/parameters"
 	"github.com/wstool/wst/run/services"
+	"io"
 	"regexp"
 	"strings"
 	"time"
@@ -65,22 +68,44 @@ func (a *outputAction) Timeout() time.Duration {
 	return a.timeout
 }
 
-func (a *outputAction) Execute(ctx context.Context, runData runtime.Data) (bool, error) {
-	logger := a.fnd.Logger()
-	logger.Infof("Executing expectation output action")
+func (a *outputAction) getReader(ctx context.Context, runData runtime.Data) (io.Reader, error) {
 	outputType, err := a.getServiceOutputType(a.OutputType)
 	if err != nil {
-		return false, err
+		return nil, err
+	}
+	if a.Command == "" {
+		// Command is empty so use service output
+		a.fnd.Logger().Debugf("Checking service output")
+		return a.service.OutputReader(ctx, outputType)
+	}
+	// Otherwise get the command data
+	data, ok := runData.Load(fmt.Sprintf("command/%s", a.Command))
+	if !ok {
+		return nil, errors.New("command data not found")
 	}
+	// Cast it to Collector
+	oc, ok := data.(output.Collector)
+	if !ok {
+		return nil, errors.New("invalid response data type")
+	}
+	a.fnd.Logger().Debugf("Checking command %s data", a.Command)
+	// Get collector reader
+	return oc.Reader(ctx, outputType)
+}
+
+func (a *outputAction) Execute(ctx context.Context, runData runtime.Data) (bool, error) {
+	logger := a.fnd.Logger()
+	logger.Infof("Executing expectation output action")
 	messages, err := a.renderMessages(a.Messages)
 	if err != nil {
 		return false, err
 	}
-	scanner, err := a.service.OutputScanner(ctx, outputType)
+	reader, err := a.getReader(ctx, runData)
 	if err != nil {
 		return false, err
 	}
-	lines := []string{}
+	var lines []string
+	scanner := bufio.NewScanner(reader)
 	for scanner.Scan() {
 		line := scanner.Text()
 		lines = append(lines, line)
@@ -92,18 +117,18 @@ func (a *outputAction) Execute(ctx context.Context, runData runtime.Data) (bool,
 			return true, nil
 		}
 	}
-	if scanner.Err() != nil {
+	scannerErr := scanner.Err()
+	if scannerErr != nil {
 		for _, msg := range messages {
 			logger.Debugf("Expected message not found: %s", msg)
 		}
 		for _, line := range lines {
 			logger.Debugf("Unexpected line found: %s", line)
 		}
-		err = scanner.Err()
-		if strings.Contains(err.Error(), "context deadline exceeded") {
+		if strings.Contains(scannerErr.Error(), "context deadline exceeded") {
 			return false, nil
 		}
-		return false, scanner.Err()
+		return false, scannerErr
 	}
 
 	if a.fnd.DryRun() {