feat: Add smoke tests and actuator configuration for service health checks

Author: RandithaK

.github/workflows/build-test.yml

@@ -79,6 +79,35 @@ jobs:
           vuln-type: 'os,library'
           severity: 'CRITICAL,HIGH' # Only fail on Critical and High issues
 
+      # --- NEW STEP: Run Smoke Tests ---
+      - name: Start Services and Run Smoke Tests
+        run: |
+          # Create a network
+          docker network create smoke-test-net
+
+          # Start MongoDB
+          docker run -d --name mongodb --network smoke-test-net \
+            mongo:6-jammy
+
+          # Wait a bit for MongoDB
+          sleep 10
+
+          # Start App
+          docker run -d --name app --network smoke-test-net \
+            -e SERVER_PORT=8080 \
+            -e MONGODB_URI=mongodb://mongodb:27017/CSO2_product_catalogue_service \
+            -p 8080:8080 \
+            local-image-scan:latest
+
+          # Run smoke test script
+          chmod +x ./scripts/smoke-test.sh
+          ./scripts/smoke-test.sh http://localhost:8080
+
+          # Cleanup
+          docker stop app mongodb
+          docker rm app mongodb
+          docker network rm smoke-test-net
+
       - name: Log in to GHCR
         uses: docker/login-action@v3
         with:

pom.xml

@@ -45,6 +45,10 @@
 			<scope>runtime</scope>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-actuator</artifactId>
+		</dependency>
 	</dependencies>
 
 	<build>

scripts/smoke-test.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+# Configuration
+SERVICE_URL=${1:-"http://localhost:8080"}
+MAX_RETRIES=30
+SLEEP_INTERVAL=5
+
+echo "Starting smoke tests against $SERVICE_URL..."
+
+# Function to check health
+check_health() {
+    local url="$1/actuator/health"
+    
+    # Get HTTP response code and body
+    local response=$(curl -s -w "\n%{http_code}" "$url")
+    local body=$(echo "$response" | sed '$d')
+    local http_code=$(echo "$response" | tail -n1)
+    
+    if [ "$http_code" == "200" ]; then
+        # Check if status is UP
+        if echo "$body" | grep -q '"status":"UP"'; then
+            return 0
+        else
+            echo "Health check returned 200 but status is not UP: $body"
+            return 1
+        fi
+    else
+        echo "Health check returned HTTP $http_code"
+        return 1
+    fi
+}
+
+# Wait for service to be ready
+echo "Waiting for service to be up..."
+for ((i=1; i<=MAX_RETRIES; i++)); do
+    if check_health "$SERVICE_URL"; then
+        echo "✅ Service is UP and healthy!"
+        
+        # Print health details
+        echo "Health endpoint response:"
+        curl -s "$SERVICE_URL/actuator/health" | head -c 500
+        echo ""
+        
+        exit 0
+    fi
+    echo "Attempt $i/$MAX_RETRIES: Service not ready yet... waiting ${SLEEP_INTERVAL}s"
+    sleep $SLEEP_INTERVAL
+done
+
+echo "❌ Service failed to start within timeout."
+echo "Final health check attempt:"
+curl -s "$SERVICE_URL/actuator/health" || echo "Could not reach service"
+exit 1

src/main/resources/application.properties

@@ -3,3 +3,7 @@ server.port=${SERVER_PORT:8082}
 
 # MongoDB Configuration (override via env vars in production)
 spring.data.mongodb.uri=${MONGODB_URI:mongodb://localhost:27017/CSO2_product_catalogue_service}
+
+# Actuator Configuration
+management.endpoints.web.exposure.include=health,info
+management.endpoint.health.show-details=always