Workflow extension: code review

Author:    Gabriele Russo Russo <gabri.russo17@gmail.com>
Co-authored-by: Matteo Nardelli <matnar@gmail.com>

Author: grussorusso

.github/workflows/makefile.yml

@@ -23,4 +23,4 @@ jobs:
        run: make
 
      - name: Test
-       run: make unit_test
+       run: make test

Makefile

@@ -40,19 +40,8 @@ push-images:
 	docker push $(DOCKERHUB_USER)/serverledge-base
 	docker push $(DOCKERHUB_USER)/serverledge-nodejs17ng
 
-unit_test:
-	go test -v ./...
-
 test:
-	INTEGRATION=1 go test -v ./...
-
-# to get coverage, install cover
-# go get golang.org/x/tools/cmd/cover
-test_coverage:
-	go test -coverprofile coverage.txt ./...
-
-coverage:
-	go tool cover -html=coverage.txt
+	go test -v ./...
 
 .PHONY: serverledge serverledge-cli lb executor test images
 

README.md

@@ -170,4 +170,4 @@ The configuration file may look like this:
 ## License
 
 Serverledge is distributed under the terms of the [MIT
-license](https://github.com/grussorusso/serverledge/blob/master/LICENSE.txt).
+license](https://github.com/serverledge-faas/serverledge/blob/master/LICENSE.txt).

cmd/cli/main.go

@@ -5,8 +5,8 @@ import (
 	"os"
 	"strconv"
 
-	"github.com/grussorusso/serverledge/internal/cli"
-	"github.com/grussorusso/serverledge/internal/config"
+	"github.com/serverledge-faas/serverledge/internal/cli"
+	"github.com/serverledge-faas/serverledge/internal/config"
 )
 
 func main() {

cmd/executor/executor.go

@@ -5,7 +5,7 @@ import (
 	"log"
 	"net/http"
 
-	"github.com/grussorusso/serverledge/internal/executor"
+	"github.com/serverledge-faas/serverledge/internal/executor"
 )
 
 func main() {

cmd/lb/main.go

@@ -9,10 +9,10 @@ import (
 
 	"golang.org/x/net/context"
 
-	"github.com/grussorusso/serverledge/internal/config"
-	"github.com/grussorusso/serverledge/internal/lb"
-	"github.com/grussorusso/serverledge/internal/registration"
-	"github.com/grussorusso/serverledge/utils"
+	"github.com/serverledge-faas/serverledge/internal/config"
+	"github.com/serverledge-faas/serverledge/internal/lb"
+	"github.com/serverledge-faas/serverledge/internal/registration"
+	"github.com/serverledge-faas/serverledge/utils"
 	"github.com/labstack/echo/v4"
 	"github.com/labstack/echo/v4/middleware"
 )

cmd/serverledge/main.go

@@ -10,14 +10,14 @@ import (
 	"os/signal"
 	"time"
 
-	"github.com/grussorusso/serverledge/internal/api"
-	"github.com/grussorusso/serverledge/internal/cache"
-	"github.com/grussorusso/serverledge/internal/config"
-	"github.com/grussorusso/serverledge/internal/metrics"
-	"github.com/grussorusso/serverledge/internal/node"
-	"github.com/grussorusso/serverledge/internal/registration"
-	"github.com/grussorusso/serverledge/internal/scheduling"
-	"github.com/grussorusso/serverledge/utils"
+	"github.com/serverledge-faas/serverledge/internal/api"
+	"github.com/serverledge-faas/serverledge/internal/cache"
+	"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"
+	"github.com/serverledge-faas/serverledge/utils"
 
 	"github.com/labstack/echo/v4"
 	"github.com/labstack/echo/v4/middleware"

docs/custom_runtime.md

@@ -7,7 +7,7 @@ your function code, as explained below.
 
 The easiest way to build a custom function image is by leveraging the
 Serverledge base runtime image, i.e., `grussorusso/serverledge-base`.
-This image contains a simple implementation of the [Executor](https://github.com/grussorusso/serverledge/blob/main/docs/executor.md)
+This image contains a simple implementation of the [Executor](https://github.com/serverledge-faas/serverledge/blob/main/docs/executor.md)
 server. When the function is invoked, the Executor runs a user-specified
 command as a new process and sets a few environment variables that may be
 used by the called process:

docs/writing-function-compositions.md

@@ -1,23 +1,23 @@
 # Functions composition
 
-Serverledge accepts DAGs defined by users through a subset of the JSON-based *Amazon States Language*, currently in use by AWS Step Functions. Furthermore, you can define DAGs programmatically
-with the DagBuilder APIs.
+Serverledge accepts workflows defined by users through a subset of the JSON-based *Amazon States Language*, currently in use by AWS Step Functions. Furthermore, you can define workflows programmatically
+with the Builder APIs.
 
-Serverledge DAGs comprise 4 types of nodes:
+Serverledge workflows comprise 4 types of nodes:
 - **SimpleNode**: a node that wraps a function. This is the only node that executes user-defined functions.
 - **ChoiceNode**: a node with N conditions that transfers its input to the first branch whose condition is evaluated as true
 - **FanOutNode**: a node with N outputs that copies (or scatters) the input to all the outputs (with subsequent nodes activated in parallel)
 -  **FanInNode**: a node with N inputs that waits for the termination of all the parent nodes, and then merges the results in one output. The node fails after a specified timeout.
 
 Three special nodes are always present and pre-built when using the APIs:
-- **StartNode**: the single node from which the DAG starts executing
-- **EndNode**: the final node of the DAG
-- **ErrorNode**: a node that terminates DAG execution with failure 
+- **StartNode**: the single node from which the workflow starts executing
+- **EndNode**: the final node of the workflow
+- **ErrorNode**: a node that terminates workflow execution with failure 
 
 
 ## Signature
 Specifying a signature is optional for Serverledge functions. However,
-in order to use functions within DAGs, they must have an associated signature.
+in order to use functions within workflows, they must have an associated signature.
 A signature specifies the type of the inputs accepted by the function, as well as the type of the produced outputs. For instance, a *Fibonacci* function might have a single integer input, and produce a single integer output.
 
 The signature can be specified when creating a function through the CLI.
@@ -41,10 +41,10 @@ Example:
 
 TODO
 
-## DagBuilder API
+## Builder API
 
-It is possible to use the internal builder APIs to build complex DAGs programmatically in Go.
-Here is an example of a DAG made by two simple nodes and a choice node, with N alternative conditions
+It is possible to use the internal builder APIs to build complex workflows programmatically in Go.
+Here is an example of a workflow made by two simple nodes and a choice node, with N alternative conditions
 
 	N := 4
 	function := function.Function{...}
@@ -53,11 +53,11 @@ Here is an example of a DAG made by two simple nodes and a choice node, with N a
 	...
 	condition[N-1] = Condition{...}
 
-	NewDagBuilder().
+	NewBuilder().
 	    AddSimpleNode(&function).
 	    AddSimpleNode(&function2).
 	    AddChoiceNode(conditions).
-	    ForEach(NewDagBuilder().
+	    ForEach(NewBuilder().
 	            AddSimpleNode(&function).
 	            Build()).
 	    EndChoiceNode().

go.mod

@@ -1,4 +1,4 @@
-module github.com/grussorusso/serverledge
+module github.com/serverledge-faas/serverledge
 
 go 1.20
 
@@ -8,7 +8,6 @@ require (
 	github.com/cornelk/hashmap v1.0.8
 	github.com/docker/docker v24.0.5+incompatible
 	github.com/hexablock/vivaldi v0.0.0-20180727225019-07adad3f2b5f
-	github.com/labstack/echo v3.3.10+incompatible
 	github.com/labstack/echo/v4 v4.6.1
 	github.com/labstack/gommon v0.3.0
 	github.com/lithammer/shortuuid v3.0.0+incompatible
@@ -27,7 +26,6 @@ require (
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
 	github.com/coreos/go-semver v0.3.0 // indirect
 	github.com/coreos/go-systemd/v22 v22.5.0 // indirect
-	github.com/dgrijalva/jwt-go v3.2.0+incompatible // indirect
 	github.com/docker/distribution v2.8.2+incompatible // indirect
 	github.com/docker/go-connections v0.4.0 // indirect
 	github.com/docker/go-units v0.5.0 // indirect