✅ Add End-To-End test suite

.github/workflows/build.yml

@@ -34,3 +34,22 @@ jobs:
           load: true
           cache-from: type=gha
           cache-to: type=gha,mode=max
+
+      - name: setup@test
+        uses: gacts/install-hurl@v1
+
+      - name: e2e@test
+        working-directory: ./tests/e2e
+        run: sh ./run.sh
+
+      - name: report@test
+        uses: mikepenz/[email protected]
+        if: ${{ github.event_name == 'pull_request' && (success() || failure()) }}
+        with:
+          report_paths: "./tests/e2e/reports/junit.xml"
+          include_passed: true
+          check_name: "End-To-End Test Report"
+          job_summary: true
+          comment: true
+          updateComment: true
+          fail_on_failure: true

README.md

@@ -63,15 +63,6 @@ Result:
  - **Total time:** 481.65s
  - **Average:** 2076.18 request/s
 
-## :warning: Disclaimer
-
-This project is in a very early stage of development, as such:
-
- - it has not been tested in production
- - not even an automated test suite
-
-Those points will be improved on given enough time.
-
 ## :construction: Build
 
 **Requirements:**

Taskfile.yml

@@ -8,12 +8,23 @@ tasks:
       - task: "gen:js"
       - go build -o bin/ ./...
 
-  test:
-    desc: "Run tests"
+  run:
+    desc: "Run the project"
+    cmds:
+      - ./bin/flowg serve {{.CLI_ARGS}}
+
+  "test:unit":
+    desc: "Run unit tests"
     cmds:
       - task: "test:go"
       - task: "test:rust"
 
+  "test:e2e":
+    desc: "Run end-to-end tests"
+    dir: ./tests/e2e
+    cmds:
+      - sh run.sh
+
   doc:
     desc: "Generate documentation"
     cmds:

api/create_token.go

@@ -13,8 +13,9 @@ import (
 type CreateTokenRequest struct{}
 
 type CreateTokenResponse struct {
-	Success bool   `json:"success"`
-	Token   string `json:"token"`
+	Success   bool   `json:"success"`
+	Token     string `json:"token"`
+	TokenUUID string `json:"token-uuid"`
 }
 
 func CreateTokenUsecase(authDb *auth.Database) usecase.Interactor {
@@ -28,7 +29,7 @@ func CreateTokenUsecase(authDb *auth.Database) usecase.Interactor {
 		) error {
 			user := auth.GetContextUser(ctx)
 
-			token, err := tokenSys.CreateToken(user.Name)
+			token, tokenUuid, err := tokenSys.CreateToken(user.Name)
 			if err != nil {
 				slog.ErrorContext(
 					ctx,
@@ -44,6 +45,7 @@ func CreateTokenUsecase(authDb *auth.Database) usecase.Interactor {
 
 			resp.Success = true
 			resp.Token = token
+			resp.TokenUUID = tokenUuid
 
 			return nil
 		},

api/list_users.go

@@ -12,7 +12,7 @@ import (
 type ListUsersRequest struct{}
 type ListUsersResponse struct {
 	Success bool        `json:"success"`
-	Users   []auth.User `json:"Users"`
+	Users   []auth.User `json:"users"`
 }
 
 func ListUsersUsecase(authDb *auth.Database) usecase.Interactor {

api/main.go

@@ -94,6 +94,8 @@ func NewHandler(
 		r.Put("/api/v1/users/{user}", SaveUserUsecase(authDb))
 		r.Delete("/api/v1/users/{user}", DeleteUserUsecase(authDb))
 
+		r.Get("/api/v1/whoami", WhoamiUsecase(authDb))
+
 		r.Get("/api/v1/tokens", ListTokensUsecase(authDb))
 		r.Post("/api/v1/token", CreateTokenUsecase(authDb))
 		r.Delete("/api/v1/tokens/{token-uuid}", DeleteTokenUsecase(authDb))

api/save_role.go

@@ -31,7 +31,7 @@ func SaveRoleUsecase(authDb *auth.Database) usecase.Interactor {
 				req SaveRoleRequest,
 				resp *SaveRoleResponse,
 			) error {
-				scopes := make([]auth.Scope, 0, len(req.Scopes))
+				scopes := make([]auth.Scope, len(req.Scopes))
 
 				for i, scopeName := range req.Scopes {
 					scope, err := auth.ParseScope(scopeName)

api/whoami.go

@@ -0,0 +1,39 @@
+package api
+
+import (
+	"context"
+
+	"github.com/swaggest/usecase"
+	"github.com/swaggest/usecase/status"
+
+	"link-society.com/flowg/internal/data/auth"
+)
+
+type WhoamiRequest struct{}
+type WhoamiResponse struct {
+	Success bool       `json:"success"`
+	User    *auth.User `json:"user"`
+}
+
+func WhoamiUsecase(authDb *auth.Database) usecase.Interactor {
+	u := usecase.NewInteractor(
+		func(
+			ctx context.Context,
+			req WhoamiRequest,
+			resp *WhoamiResponse,
+		) error {
+			resp.Success = true
+			resp.User = auth.GetContextUser(ctx)
+			return nil
+		},
+	)
+
+	u.SetName("whoami")
+	u.SetTitle("Fetch current profile")
+	u.SetDescription("Fetch the profile of the currently authenticated user")
+	u.SetTags("acls")
+
+	u.SetExpectedErrors(status.PermissionDenied)
+
+	return u
+}

cmd/flowg/admin_token_create.go

@@ -54,7 +54,7 @@ func NewAdminTokenCreateCommand() *cobra.Command {
 				return
 			}
 
-			token, err := tokenSys.CreateToken(user.Name)
+			token, _, err := tokenSys.CreateToken(user.Name)
 			if err != nil {
 				fmt.Fprintln(os.Stderr, "ERROR: Failed to generate token:", err)
 				exitCode = 1

docker/flowg.dockerfile

@@ -89,7 +89,7 @@ RUN npm run build
 FROM golang:1.23-alpine3.20 AS builder-go
 
 RUN apk add --no-cache gcc musl-dev
-RUN go install github.com/a-h/templ/cmd/[email protected].771
+RUN go install github.com/a-h/templ/cmd/[email protected].778
 
 COPY --from=sources-go /src /workspace
 COPY --from=builder-rust-filterdsl /workspace/internal/ffi/filterdsl/rust-crate/target/release/libflowg_filterdsl.a /workspace/internal/ffi/filterdsl/rust-crate/target/release/libflowg_filterdsl.a

internal/data/auth/system_token.go

@@ -21,17 +21,19 @@ func NewTokenSystem(backend *Database) *TokenSystem {
 	return &TokenSystem{backend: backend}
 }
 
-func (sys *TokenSystem) CreateToken(username string) (string, error) {
+func (sys *TokenSystem) CreateToken(username string) (string, string, error) {
 	token, err := newToken(32)
 	if err != nil {
-		return "", err
+		return "", "", err
 	}
 
 	tokenHash, err := hash.HashPassword(token)
 	if err != nil {
-		return "", fmt.Errorf("failed to hash token: %w", err)
+		return "", "", fmt.Errorf("failed to hash token: %w", err)
 	}
 
+	tokenUuid := uuid.New().String()
+
 	err = sys.backend.db.Update(func(txn *badger.Txn) error {
 		userKey := []byte(fmt.Sprintf("index:user:%s", username))
 		_, err := txn.Get(userKey)
@@ -43,7 +45,7 @@ func (sys *TokenSystem) CreateToken(username string) (string, error) {
 			return fmt.Errorf("failed to check if user '%s' exists: %w", username, err)
 		}
 
-		tokenKey := []byte(fmt.Sprintf("pat:%s:%s", username, uuid.New().String()))
+		tokenKey := []byte(fmt.Sprintf("pat:%s:%s", username, tokenUuid))
 		err = txn.Set(tokenKey, []byte(tokenHash))
 		if err != nil {
 			return fmt.Errorf("failed to add token to user '%s': %w", username, err)
@@ -53,10 +55,10 @@ func (sys *TokenSystem) CreateToken(username string) (string, error) {
 	})
 
 	if err != nil {
-		return "", err
+		return "", "", err
 	}
 
-	return token, nil
+	return token, tokenUuid, nil
 }
 
 func (sys *TokenSystem) VerifyToken(token string) (*User, error) {

internal/data/lognotify/notify_test.go

@@ -2,9 +2,11 @@ package lognotify_test
 
 import (
 	"reflect"
-	"sync"
 	"testing"
 
+	"sync"
+	"time"
+
 	"link-society.com/flowg/internal/data/logstorage"
 
 	"link-society.com/flowg/internal/data/lognotify"
@@ -15,11 +17,12 @@ func TestLogNotifier(t *testing.T) {
 	notifier.Start()
 	defer notifier.Stop()
 
-	doneC := make(chan struct{})
-	logC := notifier.Subscribe("test", doneC)
+	logDoneC := make(chan struct{})
+	logC := notifier.Subscribe("test", logDoneC)
 
 	logEntry := logstorage.NewLogEntry(map[string]string{})
 
+	wgDoneC := make(chan struct{})
 	wg := sync.WaitGroup{}
 	wg.Add(2)
 
@@ -34,7 +37,17 @@ func TestLogNotifier(t *testing.T) {
 		result = <-logC
 	}()
 
-	wg.Wait()
+	go func() {
+		wg.Wait()
+		wgDoneC <- struct{}{}
+		close(wgDoneC)
+	}()
+
+	select {
+	case <-wgDoneC:
+	case <-time.After(5 * time.Second):
+		t.Fatalf("timed out waiting for log")
+	}
 
 	if result.Stream != "test" {
 		t.Fatalf("unexpected stream: %s", result.Stream)
@@ -48,6 +61,6 @@ func TestLogNotifier(t *testing.T) {
 		t.Fatalf("unexpected log entry: %v", result.LogEntry)
 	}
 
-	doneC <- struct{}{}
-	close(doneC)
+	logDoneC <- struct{}{}
+	close(logDoneC)
 }