feat(dir): add integration tests for server

Signed-off-by: Bendegúz Csirmaz <csirmazbendeguz@gmail.com>

Author: csirmazbendeguz

.github/workflows/reusable-test-integration.yaml

@@ -0,0 +1,62 @@
+# Copyright AGNTCY Contributors (https://github.com/agntcy)
+# SPDX-License-Identifier: Apache-2.0
+
+name: Test Integration
+
+on:
+  workflow_call:
+    inputs:
+      enable_coverage:
+        required: false
+        type: boolean
+        default: false
+        description: "Whether to collect and upload coverage as artifacts."
+
+jobs:
+  integration:
+    name: Test ${{ matrix.label }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - task: test:integration:server
+            label: "Server"
+            coverage_path: ".coverage/integration/server.out"
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+
+      - name: Login to ghcr.io
+        uses: docker/login-action@b45d80f862d83dbcd57f89517bcf500b2ab88fb2 # v4.0.0
+        with:
+          registry: ghcr.io
+          username: notused
+          password: ${{ secrets.GITHUB_TOKEN  }}
+
+      - name: Install Task
+        uses: go-task/setup-task@3be4020d41929789a01026e0e427a4321ce0ad44 #v2.0.0
+
+      - name: Setup Cosign
+        uses: sigstore/cosign-installer@ba7bc0a3fef59531c69a25acd34668d6d3fe6f22 # v4.1.0
+
+      - name: Setup Go
+        uses: actions/setup-go@4b73464bb391d4059bd26b0524d20df3927bd417 # v6.3.0
+        with:
+          go-version: "1.26.1"
+          cache-dependency-path: "**/*.sum"
+          cache: true
+
+      - name: Run tests
+        run: |
+          COVERAGE_ENABLED="${{ inputs.enable_coverage }}" task ${{ matrix.task }}
+
+      - name: Upload coverage artifact
+        if: ${{ inputs.enable_coverage }}
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
+        with:
+          name: coverage-integration-${{ matrix.label }}
+          path: ${{ matrix.coverage_path }}
+          include-hidden-files: true
+          retention-days: 1

.github/workflows/reusable-test.yaml

@@ -54,6 +54,13 @@ jobs:
       - name: Run unit tests
         run: |
           task test:unit
+
+  integration:
+    name: Integration
+    uses: ./.github/workflows/reusable-test-integration.yaml
+    with:
+      enable_coverage: true
+
   sdk:
     name: SDK
     uses: ./.github/workflows/reusable-test-sdk.yaml

Taskfile.deps.yml

@@ -325,3 +325,12 @@ tasks:
       - python3 {{.PRE_COMMIT_PYZ}} install
     status:
       - test -d {{.PRE_COMMIT_PYZ}}
+
+  deps:ginkgo:
+    desc: Install ginkgo
+    run: once
+    cmds:
+      - GOBIN="{{ .BIN_DIR }}" go install github.com/onsi/ginkgo/v2/ginkgo@v{{ .GINKGO_VERSION }}
+      - mv "{{ .BIN_DIR }}/ginkgo" "{{ .GINKGO_BIN }}"
+    status:
+      - test -f "{{ .GINKGO_BIN }}"

Taskfile.vars.yml

@@ -81,6 +81,8 @@ vars:
   TRIVY_BIN: "{{ .BIN_DIR }}/trivy-{{.TRIVY_VERSION}}"
   PRE_COMMIT_VERSION: "4.5.1"
   PRE_COMMIT_PYZ: "{{ .BIN_DIR }}/pre-commit-{{.PRE_COMMIT_VERSION}}.pyz"
+  GINKGO_VERSION: "2.28.1"
+  GINKGO_BIN: "{{ .BIN_DIR }}/ginkgo-{{ .GINKGO_VERSION }}"
 
   ## Coverage related values
   COVERAGE_DIR: '{{ .COVERAGE_DIR | default (print .ROOT_DIR "/.coverage") }}'

server/database/database.go

@@ -100,6 +100,20 @@ func newSQLite(cfg config.SQLiteConfig) (*gormdb.DB, error) {
 
 // newPostgres creates a new database connection using PostgreSQL driver.
 func newPostgres(cfg config.PostgresConfig) (*gormdb.DB, error) {
+	db, err := NewPostgresGormDb(cfg)
+	if err != nil {
+		return nil, fmt.Errorf("failed to connect to PostgreSQL database: %w", err)
+	}
+
+	gdb, err := gormdb.New(db)
+	if err != nil {
+		return nil, fmt.Errorf("failed to initialize PostgreSQL database: %w", err)
+	}
+
+	return gdb, nil
+}
+
+func NewPostgresGormDb(cfg config.PostgresConfig) (*gorm.DB, error) {
 	host := cfg.Host
 	if host == "" {
 		host = config.DefaultPostgresHost
@@ -123,17 +137,7 @@ func newPostgres(cfg config.PostgresConfig) (*gormdb.DB, error) {
 	dsn := fmt.Sprintf("host=%s port=%d user=%s password=%s dbname=%s sslmode=%s",
 		host, port, cfg.Username, cfg.Password, database, sslMode)
 
-	db, err := gorm.Open(postgres.Open(dsn), &gorm.Config{
+	return gorm.Open(postgres.Open(dsn), &gorm.Config{ //nolint:wrapcheck
 		Logger: newCustomLogger(),
 	})
-	if err != nil {
-		return nil, fmt.Errorf("failed to connect to PostgreSQL database: %w", err)
-	}
-
-	gdb, err := gormdb.New(db)
-	if err != nil {
-		return nil, fmt.Errorf("failed to initialize PostgreSQL database: %w", err)
-	}
-
-	return gdb, nil
 }

server/server.go

@@ -114,7 +114,7 @@ func buildConnectionOptions(cfg config.ConnectionConfig) []grpc.ServerOption {
 func Run(ctx context.Context, cfg *config.Config) error {
 	errCh := make(chan error)
 
-	server, err := New(ctx, cfg)
+	server, err := New(ctx, cfg, nil)
 	if err != nil {
 		return fmt.Errorf("failed to create server: %w", err)
 	}
@@ -153,7 +153,7 @@ func configureOASFValidation(cfg *config.Config) error {
 }
 
 //nolint:cyclop // This function has been at the limit; refactoring is out of scope.
-func New(ctx context.Context, cfg *config.Config) (*Server, error) {
+func New(ctx context.Context, cfg *config.Config, databaseAPI types.DatabaseAPI) (*Server, error) {
 	logger.Debug("Creating server with config", "config", cfg, "version", version.String())
 
 	if err := configureOASFValidation(cfg); err != nil {
@@ -227,9 +227,11 @@ func New(ctx context.Context, cfg *config.Config) (*Server, error) {
 		return nil, fmt.Errorf("failed to create routing: %w", err)
 	}
 
-	databaseAPI, err := database.New(cfg.Database)
-	if err != nil {
-		return nil, fmt.Errorf("failed to create database API: %w", err)
+	if databaseAPI == nil {
+		databaseAPI, err = database.New(cfg.Database)
+		if err != nil {
+			return nil, fmt.Errorf("failed to create database API: %w", err)
+		}
 	}
 
 	// Create JWT authentication service if enabled
@@ -317,6 +319,8 @@ func New(ctx context.Context, cfg *config.Config) (*Server, error) {
 	}, nil
 }
 
+func (s Server) GrpcServer() *grpc.Server { return s.grpcServer }
+
 func (s Server) Options() types.APIOptions { return s.options }
 
 func (s Server) Store() types.StoreAPI { return s.store }

tests/Taskfile.yml

@@ -589,3 +589,26 @@ tasks:
         else
           echo "No pods directory found"
         fi
+
+  test:integration:server:
+    desc: Run integration tests for the API server
+    dir: "{{ .ROOT_DIR }}/tests/integration-server"
+    deps:
+      - task: deps:ginkgo
+    vars:
+      COVERAGE_ENABLED: '{{ .COVERAGE_ENABLED | default "false" }}'
+    cmds:
+      - defer: docker compose down -v
+      - docker compose up -d --build --wait
+      - |
+        if [ "{{ .COVERAGE_ENABLED }}" = "true" ]; then
+          mkdir -p "{{ .COVERAGE_DIR }}/integration"
+          {{ .GINKGO_BIN }} --randomize-all \
+                 -p \
+                 -covermode="atomic" \
+                 -coverpkg="github.com/agntcy/dir/api/...,github.com/agntcy/dir/server/..." \
+                 --output-dir="{{ .COVERAGE_DIR }}/integration" \
+                 -coverprofile="server.out"
+        else
+          {{ .GINKGO_BIN }} --randomize-all -p
+        fi