Minor cleanup

Author: grussorusso

internal/container/docker.go

@@ -56,15 +56,6 @@ func (cf *DockerFactory) Create(image string, opts *ContainerOptions) (Container
 
 	r, err := cf.cli.ContainerInspect(cf.ctx, id)
 	log.Printf("Container %s has name %s\n", id, r.Name)
-	// TODO: remove, only for debug
-	//containers, err := cf.cli.ContainerList(cf.ctx, types.ContainerListOptions{})
-	//if err != nil {
-	//	panic(err)
-	//}
-	//
-	//for _, c := range containers {
-	//	fmt.Println(c)
-	//} // end remove
 
 	return id, err
 }

internal/function/function.go

@@ -4,8 +4,6 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/serverledge-faas/serverledge/internal/types"
-
 	"time"
 
 	"github.com/serverledge-faas/serverledge/internal/cache"
@@ -134,8 +132,7 @@ func (f *Function) Delete() error {
 	return nil
 }
 
-func (f *Function) Equals(cmp types.Comparable) bool {
-	f2 := cmp.(*Function)
+func (f *Function) Equals(f2 *Function) bool {
 	return (f == nil && f2 == nil) || (f.Name == f2.Name &&
 		f.CustomImage == f2.CustomImage &&
 		f.CPUDemand == f2.CPUDemand &&

internal/function/signature.go

@@ -181,8 +181,10 @@ func (s SignatureBuilder) Build() *Signature {
 	return &s.signature
 }
 
-// TODO: this function might modify its input to force matching of single inputs
-func (s *Signature) CheckAllInputs(inputMap map[string]interface{}) error {
+// CheckOrMatchInputs performs name and type checking between inputMap and the signature.
+// If the signature has a single input that type-checks with inputMap, the name of
+// the parameter in inputMap is updated to match with the signature.
+func (s *Signature) CheckOrMatchInputs(inputMap map[string]interface{}) error {
 	errors := ""
 	if len(inputMap) < len(s.Inputs) {
 		errors += fmt.Sprintf("type-error: there are %d inputs, but should have been %d\n", len(inputMap), len(s.Inputs))

internal/test/api_test.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"strings"
 	"testing"
 	"time"
 
@@ -177,21 +178,24 @@ func TestDeleteWorkflow(t *testing.T) {
 		AddOutput("result", function.Int{}).
 		Build())
 	utils.AssertNilMsg(t, err, "failed to initialize function")
-	workflow, err := CreateSequenceWorkflow(fn, db, fn)
-	workflow.Name = fcName
+	wflow, err := CreateSequenceWorkflow(fn, db, fn)
+	wflow.Name = fcName
 	utils.AssertNil(t, err)
 
-	err = workflow.Save()
+	err = wflow.Save()
 	utils.AssertNil(t, err)
 
 	// the API under test is the following
-	deleteWorkflowApiTest(t, fcName, HOST, PORT) // TODO: check success
-
-	// delete the container when not used
-	// deleteApiTest(t, fn.Name, HOST, PORT) // the function has already been deleted during composition deletion
+	deleteWorkflowApiTest(t, fcName, HOST, PORT)
 
-	// utils.AssertTrueMsg(t, node.ArePoolsEmptyInThisNode(), "container pools are not empty after the end of test")
-	// utils.AssertTrueMsg(t, workflow.IsEmptyPartialDataCache(), "partial data cache is not empty")
+	list, err := workflow.GetAllWorkflows()
+	found := false
+	for _, w := range list {
+		if strings.Compare(w, wflow.Name) == 0 {
+			found = true
+		}
+	}
+	utils.AssertFalse(t, found)
 }
 
 // TestAsyncInvokeWorkflow tests the REST API that executes a given function composition
@@ -240,7 +244,7 @@ func TestAsyncInvokeWorkflow(t *testing.T) {
 			i++
 			time.Sleep(200 * time.Millisecond)
 		} else {
-			result, err := compExecReport.GetSingleResult()
+			result, err := GetSingleResult(&compExecReport)
 			utils.AssertNilMsg(t, err, "failed to get single result")
 			utils.AssertEquals(t, "4", result)
 			break

internal/test/aslparser_test.go

@@ -5,9 +5,9 @@ import (
 	"os"
 	"testing"
 
+	"github.com/lithammer/shortuuid"
 	"github.com/serverledge-faas/serverledge/internal/workflow"
 	"github.com/serverledge-faas/serverledge/utils"
-	"github.com/lithammer/shortuuid"
 )
 
 // / TestParsedWorkflowName verifies that the composition name matches the filename (without extension)
@@ -221,7 +221,7 @@ func TestParsingChoiceWorkflowWithBoolExpr(t *testing.T) {
 	utils.AssertNil(t, err1)
 
 	// checks the result (1+1+1 = 3)
-	output, err := resultMap.GetIntSingleResult()
+	output, err := GetIntSingleResult(&resultMap)
 	utils.AssertNilMsg(t, err, "failed to get int single result")
 	utils.AssertEquals(t, 3, output)
 
@@ -234,7 +234,7 @@ func TestParsingChoiceWorkflowWithBoolExpr(t *testing.T) {
 	utils.AssertNil(t, err2)
 
 	// checks the result (20*2+1 = 41)
-	output2, err := resultMap2.GetIntSingleResult()
+	output2, err := GetIntSingleResult(&resultMap2)
 	utils.AssertNilMsg(t, err, "failed to get int single result")
 	utils.AssertEquals(t, 41, output2)
 

internal/test/main_test.go

@@ -10,14 +10,14 @@ import (
 	"testing"
 	"time"
 
+	"github.com/labstack/echo/v4"
 	"github.com/serverledge-faas/serverledge/internal/api"
 	"github.com/serverledge-faas/serverledge/internal/config"
 	"github.com/serverledge-faas/serverledge/internal/metrics"
 	"github.com/serverledge-faas/serverledge/internal/node"
 	"github.com/serverledge-faas/serverledge/internal/registration"
 	"github.com/serverledge-faas/serverledge/internal/scheduling"
 	u "github.com/serverledge-faas/serverledge/utils"
-	"github.com/labstack/echo/v4"
 	"google.golang.org/grpc/codes"
 )
 
@@ -53,7 +53,6 @@ func testStartServerledge(isInCloud bool, outboundIp string) (*registration.Regi
 		registry.Area = AREA
 	}
 	// before register checkout other servers into the local area
-	//todo use this info later on; future work with active remote server selection
 	_, err := registry.GetAll(true)
 	if err != nil {
 		log.Fatal(err)

internal/test/signature_test.go

@@ -63,13 +63,13 @@ func TestSignatureInputOnly(t *testing.T) {
 	u.AssertNil(t, sig.CheckAllOutputs(m))
 	// check correct input
 	m["hello"] = "giacomo"
-	u.AssertNil(t, sig.CheckAllInputs(m))
+	u.AssertNil(t, sig.CheckOrMatchInputs(m))
 	// check wrong input
 	m["hello"] = []string{"no", "yes"}
-	u.AssertNonNil(t, sig.CheckAllInputs(m))
+	u.AssertNonNil(t, sig.CheckOrMatchInputs(m))
 	// check nil input value
 	m["hello"] = nil
-	u.AssertNonNil(t, sig.CheckAllInputs(m))
+	u.AssertNonNil(t, sig.CheckOrMatchInputs(m))
 	// u.AssertNil(t, sig.CheckAllOutputs(make(map[string]interface{})))
 }
 
@@ -80,7 +80,7 @@ func TestSignatureOutputOnly(t *testing.T) {
 		Build()
 	m := make(map[string]interface{})
 	// we do not have input
-	u.AssertNil(t, sig.CheckAllInputs(m))
+	u.AssertNil(t, sig.CheckOrMatchInputs(m))
 	// check correct type output
 	m["len"] = 1
 	u.AssertNil(t, sig.CheckAllOutputs(m))
@@ -105,21 +105,21 @@ func TestComplexSignature(t *testing.T) {
 		Build()
 	m := make(map[string]interface{})
 	// we do not have all inputs
-	u.AssertNonNil(t, sig.CheckAllInputs(m))
+	u.AssertNonNil(t, sig.CheckOrMatchInputs(m))
 	// we do not have all outputs
 	u.AssertNonNil(t, sig.CheckAllOutputs(m))
 	// check partially correct input
 	m["hello"] = "giacomo"
-	u.AssertNonNil(t, sig.CheckAllInputs(m))
+	u.AssertNonNil(t, sig.CheckOrMatchInputs(m))
 	// check useless input
 	m["food"] = "pizza"
-	u.AssertNonNil(t, sig.CheckAllInputs(m))
+	u.AssertNonNil(t, sig.CheckOrMatchInputs(m))
 	// check correct input, but also with useless input (should work)
 	m["age"] = "26"
-	u.AssertNil(t, sig.CheckAllInputs(m))
+	u.AssertNil(t, sig.CheckOrMatchInputs(m))
 	// check totally correct input
 	delete(m, "food")
-	u.AssertNil(t, sig.CheckAllInputs(m))
+	u.AssertNil(t, sig.CheckOrMatchInputs(m))
 	// check partial output (with conversion)
 	m["price"] = "2.5"
 	u.AssertNonNil(t, sig.CheckAllOutputs(m))

internal/test/util.go

@@ -8,7 +8,6 @@ import (
 	"os"
 	"testing"
 
-	"github.com/cornelk/hashmap"
 	"github.com/serverledge-faas/serverledge/internal/cli"
 	"github.com/serverledge-faas/serverledge/internal/client"
 	"github.com/serverledge-faas/serverledge/internal/function"
@@ -197,8 +196,7 @@ func createApiIfNotExistsTest(t *testing.T, fn *function.Function, host string,
 
 func invokeApiTest(fn string, params map[string]interface{}, host string, port int) error {
 	request := client.InvocationRequest{
-		Params: params,
-		// QoSClass:        qosClass,
+		Params:          params,
 		QoSMaxRespT:     250,
 		CanDoOffloading: true,
 		Async:           false,
@@ -212,7 +210,6 @@ func invokeApiTest(fn string, params map[string]interface{}, host string, port i
 	if err2 != nil {
 		return err2
 	}
-	// utils.PrintJsonResponse(resp.Body)
 	return nil
 }
 
@@ -276,22 +273,11 @@ func pollWorkflowTest(t *testing.T, requestId string, host string, port int) str
 	return utils.GetJsonResponse(resp.Body)
 }
 
-func newWorkflowRequestTest() *workflow.Request {
-
-	return &workflow.Request{
-		Id: "test",
-		ExecReport: workflow.ExecutionReport{
-			Reports: hashmap.New[workflow.ExecutionReportId, *function.ExecutionReport](), // make(map[workflow.ExecutionReportId]*function.ExecutionReport),
-		},
-	}
-}
-
 func IsWindows() bool {
 	return os.PathSeparator == '\\' && os.PathListSeparator == ';'
 }
 
 // CreateSequenceWorkflow if successful, returns a workflow pointer with a sequence of Simple Nodes
-// TODO: do we need this utility function?
 func CreateSequenceWorkflow(funcs ...*function.Function) (*workflow.Workflow, error) {
 	builder := workflow.NewBuilder()
 	for _, f := range funcs {
@@ -301,7 +287,6 @@ func CreateSequenceWorkflow(funcs ...*function.Function) (*workflow.Workflow, er
 }
 
 // CreateChoiceWorkflow if successful, returns a workflow with one Choice Node with each branch consisting of the same sub-workflow
-// TODO: why is a 'dagger' needed?
 func CreateChoiceWorkflow(dagger func() (*workflow.Workflow, error), condArr ...workflow.Condition) (*workflow.Workflow, error) {
 	return workflow.NewBuilder().
 		AddChoiceNode(condArr...).
@@ -311,7 +296,6 @@ func CreateChoiceWorkflow(dagger func() (*workflow.Workflow, error), condArr ...
 
 // CreateScatterSingleFunctionWorkflow if successful, returns a workflow with one fan out, N simple node with the same function
 // and then a fan in node that merges all the result in an array.
-// TODO: This appears to be used only in tests. Move away from the workflow package
 func CreateScatterSingleFunctionWorkflow(fun *function.Function, fanOutDegree int) (*workflow.Workflow, error) {
 	return workflow.NewBuilder().
 		AddScatterFanOutNode(fanOutDegree).
@@ -322,7 +306,6 @@ func CreateScatterSingleFunctionWorkflow(fun *function.Function, fanOutDegree in
 
 // CreateBroadcastWorkflow if successful, returns a workflow with one fan out node, N simple nodes with different functions and a fan in node
 // The number of branches is defined by the number of given functions
-// TODO: This appears to be used only in tests. Move away from the workflow package
 func CreateBroadcastWorkflow(dagger func() (*workflow.Workflow, error), fanOutDegree int) (*workflow.Workflow, error) {
 	return workflow.NewBuilder().
 		AddBroadcastFanOutNode(fanOutDegree).
@@ -333,8 +316,6 @@ func CreateBroadcastWorkflow(dagger func() (*workflow.Workflow, error), fanOutDe
 
 // CreateBroadcastMultiFunctionWorkflow if successful, returns a workflow with one fan out node, each branch chained with a different workflow that run in parallel, and a fan in node.
 // The number of branch is defined as the number of dagger functions.
-// TODO: why is a 'dagger' needed?
-// TODO: This appears to be used only in tests. Move away from the workflow package
 func CreateBroadcastMultiFunctionWorkflow(dagger ...func() (*workflow.Workflow, error)) (*workflow.Workflow, error) {
 	builder := workflow.NewBuilder().
 		AddBroadcastFanOutNode(len(dagger))
@@ -345,3 +326,25 @@ func CreateBroadcastMultiFunctionWorkflow(dagger ...func() (*workflow.Workflow,
 		AddFanInNode().
 		Build()
 }
+
+func GetSingleResult(cer *workflow.ExecutionReport) (string, error) {
+	if len(cer.Result) == 1 {
+		for _, value := range cer.Result {
+			return fmt.Sprintf("%v", value), nil
+		}
+	}
+	return "", fmt.Errorf("there is not exactly one result: there are %d result(s)", len(cer.Result))
+}
+
+func GetIntSingleResult(cer *workflow.ExecutionReport) (int, error) {
+	if len(cer.Result) == 1 {
+		for _, value := range cer.Result {
+			valueInt, ok := value.(int)
+			if !ok {
+				return 0, fmt.Errorf("value %v cannot be casted to int", value)
+			}
+			return valueInt, nil
+		}
+	}
+	return 0, fmt.Errorf("there is not exactly one result: there are %d result(s)", len(cer.Result))
+}

internal/test/workflow_integration_test.go

@@ -513,7 +513,7 @@ func TestInvokeWorkflowFailAndSucceed(t *testing.T) {
 	resultMap, errInvoke1 := wflow.Invoke(request)
 	u.AssertNilMsg(t, errInvoke1, "error while invoking the branch (succeed)")
 
-	result, err := resultMap.GetIntSingleResult()
+	result, err := GetIntSingleResult(&resultMap)
 	u.AssertNilMsg(t, err, "Result not found")
 	u.AssertEquals(t, 1, result)
 
@@ -560,7 +560,7 @@ func TestInvokeWorkflowPassDoNothing(t *testing.T) {
 	resultMap, errInvoke1 := wflow.Invoke(request)
 	u.AssertNilMsg(t, errInvoke1, "error while invoking the composition with pass node")
 
-	result, err := resultMap.GetIntSingleResult()
+	result, err := GetIntSingleResult(&resultMap)
 	u.AssertNilMsg(t, err, "Result not found")
 	u.AssertEquals(t, 3, result)
 }