Added reporting to the condition executor

Author: MaartendeKruijf

internal/executors/condition/condition.go

@@ -2,7 +2,9 @@ package condition
 
 import (
 	"errors"
+	"fmt"
 	"reflect"
+	"soarca/internal/reporter"
 	"soarca/logger"
 	"soarca/models/cacao"
 	"soarca/models/execution"
@@ -16,8 +18,10 @@ func init() {
 	log = logger.Logger(component, logger.Info, "", logger.Json)
 }
 
-func New(comparison comparison.IComparison) *Executor {
-	return &Executor{comparison: comparison}
+func New(comparison comparison.IComparison,
+	reporter reporter.IStepReporter) *Executor {
+	return &Executor{comparison: comparison,
+		reporter: reporter}
 }
 
 type IExecuter interface {
@@ -27,6 +31,7 @@ type IExecuter interface {
 
 type Executor struct {
 	comparison comparison.IComparison
+	reporter   reporter.IStepReporter
 }
 
 func (executor *Executor) Execute(meta execution.Metadata, step cacao.Step, variables cacao.Variables) (string, bool, error) {
@@ -37,22 +42,35 @@ func (executor *Executor) Execute(meta execution.Metadata, step cacao.Step, vari
 		return step.OnFailure, false, err
 	}
 
+	executor.reporter.ReportStepStart(meta.ExecutionId, step, variables)
+
 	result, err := executor.comparison.Evaluate(step.Condition, variables)
+
+	// We are reporting early to not have double reporting
+	executor.reporter.ReportStepEnd(meta.ExecutionId,
+		step,
+		variables,
+		err)
+
 	if err != nil {
 		log.Error(err)
 		return "", false, err
 	}
 
+	log.Debug("the result was: ", fmt.Sprint(result))
+
 	if result {
 		if step.OnTrue != "" {
-			log.Trace("")
+			log.Trace("will return on true step ", step.OnTrue)
 			return step.OnTrue, true, nil
 		}
 	} else {
 		if step.OnFalse != "" {
+			log.Trace("will return on false step ", step.OnFalse)
 			return step.OnFalse, true, nil
 		}
 	}
+	log.Trace("will return on completion step ", step.OnCompletion)
 
 	return step.OnCompletion, false, nil
 }

test/unittest/executor/condition/condition_executor_test.go

@@ -1,9 +1,11 @@
 package condition_test
 
 import (
+	"errors"
 	"soarca/internal/executors/condition"
 	"soarca/models/cacao"
 	"soarca/models/execution"
+	"soarca/test/unittest/mocks/mock_reporter"
 	mock_stix "soarca/test/unittest/mocks/mock_utils/stix"
 	"testing"
 
@@ -13,8 +15,9 @@ import (
 
 func TestExecuteConditionTrue(t *testing.T) {
 	mock_stix := new(mock_stix.MockStix)
+	mock_reporter := new(mock_reporter.Mock_Reporter)
 
-	conditionExecutior := condition.New(mock_stix)
+	conditionExecutior := condition.New(mock_stix, mock_reporter)
 
 	executionId := uuid.New()
 
@@ -28,19 +31,25 @@ func TestExecuteConditionTrue(t *testing.T) {
 		OnFalse:   "4"}
 	vars := cacao.NewVariables()
 
+	mock_reporter.On("ReportStepStart", executionId, step, vars)
 	mock_stix.On("Evaluate", "a = a", vars).Return(true, nil)
+	mock_reporter.On("ReportStepEnd", executionId, step, vars, nil)
 
 	nextStepId, goToBranch, err := conditionExecutior.Execute(meta, step, vars)
 	assert.Equal(t, nil, err)
 	assert.Equal(t, true, goToBranch)
 	assert.Equal(t, "3", nextStepId)
 
+	mock_reporter.AssertExpectations(t)
+	mock_stix.AssertExpectations(t)
+
 }
 
 func TestExecuteConditionFalse(t *testing.T) {
 	mock_stix := new(mock_stix.MockStix)
+	mock_reporter := new(mock_reporter.Mock_Reporter)
 
-	conditionExecutior := condition.New(mock_stix)
+	conditionExecutior := condition.New(mock_stix, mock_reporter)
 
 	executionId := uuid.New()
 
@@ -54,11 +63,48 @@ func TestExecuteConditionFalse(t *testing.T) {
 		OnFalse:   "4"}
 	vars := cacao.NewVariables()
 
-	mock_stix.On("Evaluate", "a = a", vars).Return(true, nil)
+	mock_reporter.On("ReportStepStart", executionId, step, vars)
+	mock_stix.On("Evaluate", "a = a", vars).Return(false, nil)
+	mock_reporter.On("ReportStepEnd", executionId, step, vars, nil)
 
 	nextStepId, goToBranch, err := conditionExecutior.Execute(meta, step, vars)
 	assert.Equal(t, nil, err)
 	assert.Equal(t, true, goToBranch)
-	assert.Equal(t, "3", nextStepId)
+	assert.Equal(t, "4", nextStepId)
+
+	mock_reporter.AssertExpectations(t)
+	mock_stix.AssertExpectations(t)
+}
+
+func TestExecuteConditionError(t *testing.T) {
+	mock_stix := new(mock_stix.MockStix)
+	mock_reporter := new(mock_reporter.Mock_Reporter)
+
+	conditionExecutior := condition.New(mock_stix, mock_reporter)
+
+	executionId := uuid.New()
+
+	meta := execution.Metadata{ExecutionId: executionId,
+		PlaybookId: "1",
+		StepId:     "2"}
+
+	step := cacao.Step{Type: cacao.StepTypeIfCondition,
+		Condition: "a = a",
+		OnTrue:    "3",
+		OnFalse:   "4"}
+	vars := cacao.NewVariables()
+
+	evaluationError := errors.New("some ds error")
+
+	mock_reporter.On("ReportStepStart", executionId, step, vars)
+	mock_stix.On("Evaluate", "a = a", vars).Return(false, evaluationError)
+	mock_reporter.On("ReportStepEnd", executionId, step, vars, evaluationError)
+
+	nextStepId, goToBranch, err := conditionExecutior.Execute(meta, step, vars)
+	assert.Equal(t, evaluationError, err)
+	assert.Equal(t, false, goToBranch)
+	assert.Equal(t, "", nextStepId)
 
+	mock_reporter.AssertExpectations(t)
+	mock_stix.AssertExpectations(t)
 }