Add test scripts, CI workflow, and Docker Compose test configuration

Author: ajeetraina

.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: GenAI App Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  integration-tests:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.20'
+
+      - name: Install dependencies
+        run: |
+          cd tests
+          go mod download
+          go run github.com/playwright-community/playwright-go/cmd/playwright install --with-deps
+          
+      - name: Run short tests
+        run: |
+          cd tests
+          go test -v ./integration -short
+          
+      - name: Run API tests
+        if: success() || failure()  # Run even if previous step failed
+        run: |
+          cd tests
+          go test -v ./integration -run TestGenAIAppIntegration
+        
+      - name: Run quality tests
+        if: success() || failure()  # Run even if previous step failed
+        run: |
+          cd tests
+          go test -v ./integration -run TestGenAIQuality
+          
+      - name: Clean up
+        if: always()  # Always run cleanup
+        run: |
+          docker network prune -f --filter "name=genai-*"
+          docker container prune -f --filter "name=test-*"

tests/README.md

@@ -52,6 +52,28 @@ go test -v ./tests/integration -run TestGenAIAppIntegration
 go test -v ./tests/integration -short
 ```
 
+Alternatively, you can use the provided Makefile:
+
+```bash
+# Setup dependencies
+make -C tests setup
+
+# Run all tests
+make -C tests test
+
+# Run specific test categories
+make -C tests test-api
+make -C tests test-frontend
+make -C tests test-performance
+make -C tests test-quality
+
+# Run tests in short mode
+make -C tests test-short
+
+# Clean up test artifacts
+make -C tests clean
+```
+
 ## Test Environment
 
 The tests create isolated Docker containers for:
@@ -62,18 +84,14 @@ The tests create isolated Docker containers for:
 
 All containers are connected via a dedicated Docker network to ensure proper communication.
 
-## Customizing Tests
+## Test Reports
+
+Test results are displayed in the console. Screenshots for UI tests are saved to the system's temporary directory for visual inspection when failures occur.
+
+## Extending the Tests
 
 To add new test cases or modify existing ones:
 
 - For API tests, add new test functions to `api_test.go`
 - For UI tests, add new test steps to the Playwright tests in `frontend_test.go`
 - For quality evaluation, add new test cases to the `testCases` array in `quality_test.go`
-
-## Best Practices
-
-1. Keep tests isolated - each test should run independently
-2. Use descriptive test names that indicate what's being tested
-3. Include both positive and negative test cases
-4. For UI tests, add screenshots to help debug failures
-5. For LLM quality tests, focus on pattern matching rather than exact text comparison

tests/docker-compose.test.yml

@@ -0,0 +1,60 @@
+version: '3.8'
+
+services:
+  ollama:
+    image: ilopezluna/llama3.2:0.5.4-1b
+    ports:
+      - "11434:11434"
+    healthcheck:
+      test:
+        [
+          'CMD-SHELL',
+          'bash',
+          '-c',
+          "{ printf >&3 'GET / HTTP/1.0\\r\\n\\r\\n'; cat <&3; } 3<>/dev/tcp/localhost/11434 | grep 'Ollama is' || exit 1",
+        ]
+      interval: 10s
+      timeout: 5s
+      retries: 3
+      start_period: 10s
+    networks:
+      - test-network
+
+  backend:
+    build:
+      context: ..
+      target: backend
+    environment:
+      - BASE_URL=http://ollama:11434/engines/llama.cpp/v1/
+      - MODEL=ignaciolopezluna020/llama3.2:1b
+      - API_KEY=ollama
+    ports:
+      - "8080:8080"
+    depends_on:
+      ollama:
+        condition: service_healthy
+    networks:
+      - test-network
+    healthcheck:
+      test: ['CMD', 'wget', '-qO-', 'http://localhost:8080/health']
+      interval: 3s
+      timeout: 3s
+      retries: 3
+
+  frontend:
+    build:
+      context: ../frontend
+    ports:
+      - "3000:3000"
+    environment:
+      - REACT_APP_API_URL=http://backend:8080
+      - VITE_API_URL=http://backend:8080
+    depends_on:
+      backend:
+        condition: service_healthy
+    networks:
+      - test-network
+
+networks:
+  test-network:
+    driver: bridge

tests/integration/run_docker_test.go

@@ -0,0 +1,61 @@
+package integration
+
+import (
+	"fmt"
+	"os"
+	"os/exec"
+	"testing"
+	"time"
+)
+
+// TestWithDockerCompose runs tests using docker-compose instead of testcontainers
+// This is useful for CI environments or when you want to debug the tests
+func TestWithDockerCompose(t *testing.T) {
+	if os.Getenv("USE_DOCKER_COMPOSE") != "true" {
+		t.Skip("Skipping docker-compose tests. Set USE_DOCKER_COMPOSE=true to run these tests.")
+	}
+
+	// Start the environment with docker-compose
+	cmd := exec.Command("docker-compose", "-f", "../docker-compose.test.yml", "up", "-d")
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+
+	if err := cmd.Run(); err != nil {
+		t.Fatalf("Failed to start docker-compose: %s", err)
+	}
+	defer func() {
+		// Clean up after tests
+		cmd := exec.Command("docker-compose", "-f", "../docker-compose.test.yml", "down")
+		cmd.Stdout = os.Stdout
+		cmd.Stderr = os.Stderr
+		cmd.Run()
+	}()
+
+	// Wait for services to be ready
+	t.Log("Waiting for services to be ready...")
+	time.Sleep(30 * time.Second)
+
+	// Define test URLs
+	backendURL := "http://localhost:8080"
+	frontendURL := "http://localhost:3000"
+
+	// Run tests
+	t.Run("API_Health", func(t *testing.T) {
+		testHealthEndpoint(t, backendURL)
+	})
+
+	t.Run("API_Chat", func(t *testing.T) {
+		testChatEndpoint(t, backendURL)
+	})
+
+	t.Run("API_Streaming", func(t *testing.T) {
+		testStreamingResponse(t, backendURL)
+	})
+
+	// Uncomment to run browser tests if needed
+	// t.Run("UI_Tests", func(t *testing.T) {
+	// 	runPlaywrightTests(t, frontendURL)
+	// })
+
+	t.Log("Tests completed successfully!")
+}

tests/scripts/run_tests.sh

@@ -0,0 +1,60 @@
+#!/bin/bash
+
+# Script to run integration tests
+
+set -e
+
+cd "$(dirname "$0")/../"
+
+# Ensure dependencies are installed
+go mod tidy
+echo "Installing Playwright dependencies..."
+go run github.com/playwright-community/playwright-go/cmd/playwright install --with-deps
+
+# Parse arguments
+RUN_MODE="all"
+if [ "$1" == "short" ]; then
+  RUN_MODE="short"
+elif [ "$1" == "api" ]; then
+  RUN_MODE="api"
+elif [ "$1" == "frontend" ]; then
+  RUN_MODE="frontend"
+elif [ "$1" == "quality" ]; then
+  RUN_MODE="quality"
+elif [ "$1" == "performance" ]; then
+  RUN_MODE="performance"
+elif [ "$1" == "compose" ]; then
+  RUN_MODE="compose"
+fi
+
+# Run tests based on mode
+if [ "$RUN_MODE" == "short" ]; then
+  echo "Running tests in short mode..."
+  go test -v ./integration -short
+elif [ "$RUN_MODE" == "api" ]; then
+  echo "Running API tests..."
+  go test -v ./integration -run TestGenAIAppIntegration
+elif [ "$RUN_MODE" == "frontend" ]; then
+  echo "Running frontend tests..."
+  go test -v ./integration -run TestFrontendIntegration
+elif [ "$RUN_MODE" == "quality" ]; then
+  echo "Running quality tests..."
+  go test -v ./integration -run TestGenAIQuality
+elif [ "$RUN_MODE" == "performance" ]; then
+  echo "Running performance tests..."
+  go test -v ./integration -run TestGenAIPerformance
+elif [ "$RUN_MODE" == "compose" ]; then
+  echo "Running tests using docker-compose..."
+  export USE_DOCKER_COMPOSE=true
+  go test -v ./integration -run TestWithDockerCompose
+else
+  echo "Running all tests..."
+  go test -v ./integration
+fi
+
+# Clean up
+echo "Cleaning up test resources..."
+docker network prune -f --filter "name=genai-*" || true
+docker container prune -f --filter "name=test-*" || true
+
+echo "Tests completed!"