Add example tester service to show API Integration Testing of a Goa System

.github/workflows/integration.yaml

@@ -0,0 +1,46 @@
+name: Integration Tests
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  integration-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v4
+        with:
+          go-version: "1.21"
+      - name: tests
+        run: |
+          echo "stop/disable/kill mono"
+          sudo systemctl stop mono-xsp4.service || true
+          sudo systemctl disable mono-xsp4.service || true
+          sudo pkill mono || true
+          echo "change to weather example directory"
+          cd example/weather
+          echo "run setup script"
+          ./scripts/setup
+          echo "run server"
+          ./bin/forecaster -monitoring-enabled=false &
+          ./bin/locator -monitoring-enabled=false &
+          ./bin/tester -monitoring-enabled=false &
+          ./bin/front -monitoring-enabled=false &
+          sleep 1
+          echo "-----RUN TESTS-----"
+          results=$(curl -X POST http://localhost:8084/tester/smoke)
+          echo "-----RESULTS-----"
+          echo $results
+          echo "----------"
+          if [ $(echo $results | jq '.fail_count') -gt 0 ];
+          then
+            echo "Test errors found."
+            exit 1
+          else
+            echo "Tests passed."
+            exit 0
+          fi

example/weather/scripts/setup

@@ -9,10 +9,21 @@ source ./scripts/utils/common.sh
 
 proto_pkg="protobuf-compiler"
 
+# install protoc, update version as needed
+PROTO_VER=24.4
+
 if is_mac; then
+  PROTOC_ZIP=protoc-${PROTO_VER}-osx-universal_binary.zip
   proto_pkg="protobuf"
+else
+  PROTOC_ZIP=protoc-${PROTO_VER}-linux-x86_64.zip
 fi
 
+curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v${PROTO_VER}/${PROTOC_ZIP}
+sudo unzip -o $PROTOC_ZIP -d /usr/local bin/protoc
+sudo unzip -o $PROTOC_ZIP -d /usr/local 'include/*'
+rm -f $PROTOC_ZIP
+
 check_required_cmd "protoc" $proto_pkg
 
 if [[ "$CI" == "" ]]; then

example/weather/services/forecaster/cmd/forecaster/main.go

@@ -31,10 +31,11 @@ import (
 
 func main() {
 	var (
-		grpcaddr  = flag.String("grpc-addr", ":8080", "gRPC listen address")
-		httpaddr  = flag.String("http-addr", ":8081", "HTTP listen address (health checks and metrics)")
-		agentaddr = flag.String("agent-addr", ":4317", "Grafana agent listen address")
-		debugf    = flag.Bool("debug", false, "Enable debug logs")
+		grpcaddr          = flag.String("grpc-addr", ":8080", "gRPC listen address")
+		httpaddr          = flag.String("http-addr", ":8081", "HTTP listen address (health checks and metrics)")
+		agentaddr         = flag.String("agent-addr", ":4317", "Grafana agent listen address")
+		debugf            = flag.Bool("debug", false, "Enable debug logs")
+		monitoringEnabled = flag.Bool("monitoring-enabled", true, "monitoring")
 	)
 	flag.Parse()
 
@@ -51,19 +52,26 @@ func main() {
 	}
 
 	// 2. Setup tracing
-	log.Debugf(ctx, "connecting to Grafana agent %s", *agentaddr)
-	conn, err := grpc.DialContext(ctx, *agentaddr,
-		grpc.WithTransportCredentials(insecure.NewCredentials()),
-		grpc.WithBlock())
-	if err != nil {
-		log.Errorf(ctx, err, "failed to connect to Grafana agent")
-		os.Exit(1)
-	}
-	log.Debugf(ctx, "connected to Grafana agent %s", *agentaddr)
-	ctx, err = trace.Context(ctx, genforecaster.ServiceName, trace.WithGRPCExporter(conn))
-	if err != nil {
-		log.Errorf(ctx, err, "failed to initialize tracing")
-		os.Exit(1)
+	if !*monitoringEnabled {
+		var err error
+		if ctx, err = trace.Context(ctx, genforecaster.ServiceName, trace.WithDisabled()); err != nil {
+			log.Error(ctx, err, log.KV{K: "msg", V: "failed to initialize tracing"})
+		}
+	} else {
+		log.Debugf(ctx, "connecting to Grafana agent %s", *agentaddr)
+		conn, err := grpc.DialContext(ctx, *agentaddr,
+			grpc.WithTransportCredentials(insecure.NewCredentials()),
+			grpc.WithBlock())
+		if err != nil {
+			log.Errorf(ctx, err, "failed to connect to Grafana agent")
+			os.Exit(1)
+		}
+		log.Debugf(ctx, "connected to Grafana agent %s", *agentaddr)
+		ctx, err = trace.Context(ctx, genforecaster.ServiceName, trace.WithGRPCExporter(conn))
+		if err != nil {
+			log.Errorf(ctx, err, "failed to initialize tracing")
+			os.Exit(1)
+		}
 	}
 
 	// 3. Setup metrics

example/weather/services/front/cmd/front/main.go

@@ -39,8 +39,9 @@ func main() {
 		locatorHealthAddr    = flag.String("locator-health-addr", ":8083", "Locator service health-check address")
 		testerAddr           = flag.String("tester-addr", ":8090", "Tester service address")
 		// No testerHealthAddr because we don't want the whole system to die just because tester isn't healthy for some reason
-		agentaddr = flag.String("agent-addr", ":4317", "Grafana agent listen address")
-		debugf    = flag.Bool("debug", false, "Enable debug logs")
+		agentaddr         = flag.String("agent-addr", ":4317", "Grafana agent listen address")
+		debugf            = flag.Bool("debug", false, "Enable debug logs")
+		monitoringEnabled = flag.Bool("monitoring-enabled", true, "monitoring")
 	)
 	flag.Parse()
 
@@ -57,19 +58,26 @@ func main() {
 	}
 
 	// 2. Setup tracing
-	log.Debugf(ctx, "connecting to Grafana agent %s", *agentaddr)
-	conn, err := grpc.DialContext(ctx, *agentaddr,
-		grpc.WithTransportCredentials(insecure.NewCredentials()),
-		grpc.WithBlock())
-	if err != nil {
-		log.Errorf(ctx, err, "failed to connect to Grafana agent")
-		os.Exit(1)
-	}
-	log.Debugf(ctx, "connected to Grafana agent %s", *agentaddr)
-	ctx, err = trace.Context(ctx, genfront.ServiceName, trace.WithGRPCExporter(conn))
-	if err != nil {
-		log.Errorf(ctx, err, "failed to initialize tracing")
-		os.Exit(1)
+	if !*monitoringEnabled {
+		var err error
+		if ctx, err = trace.Context(ctx, genfront.ServiceName, trace.WithDisabled()); err != nil {
+			log.Error(ctx, err, log.KV{K: "msg", V: "failed to initialize tracing"})
+		}
+	} else {
+		log.Debugf(ctx, "connecting to Grafana agent %s", *agentaddr)
+		conn, err := grpc.DialContext(ctx, *agentaddr,
+			grpc.WithTransportCredentials(insecure.NewCredentials()),
+			grpc.WithBlock())
+		if err != nil {
+			log.Errorf(ctx, err, "failed to connect to Grafana agent")
+			os.Exit(1)
+		}
+		log.Debugf(ctx, "connected to Grafana agent %s", *agentaddr)
+		ctx, err = trace.Context(ctx, genfront.ServiceName, trace.WithGRPCExporter(conn))
+		if err != nil {
+			log.Errorf(ctx, err, "failed to initialize tracing")
+			os.Exit(1)
+		}
 	}
 
 	// 3. Setup metrics

example/weather/services/locator/cmd/locator/main.go

@@ -31,10 +31,11 @@ import (
 
 func main() {
 	var (
-		grpcaddr  = flag.String("grpc-addr", ":8082", "gRPC listen address")
-		httpaddr  = flag.String("http-addr", ":8083", "HTTP listen address (health checks and metrics)")
-		agentaddr = flag.String("agent-addr", ":4317", "Grafana agent listen address")
-		debugf    = flag.Bool("debug", false, "Enable debug logs")
+		grpcaddr          = flag.String("grpc-addr", ":8082", "gRPC listen address")
+		httpaddr          = flag.String("http-addr", ":8083", "HTTP listen address (health checks and metrics)")
+		agentaddr         = flag.String("agent-addr", ":4317", "Grafana agent listen address")
+		debugf            = flag.Bool("debug", false, "Enable debug logs")
+		monitoringEnabled = flag.Bool("monitoring-enabled", true, "monitoring")
 	)
 	flag.Parse()
 
@@ -51,19 +52,26 @@ func main() {
 	}
 
 	// 2. Setup tracing
-	log.Debugf(ctx, "connecting to Grafana agent %s", *agentaddr)
-	conn, err := grpc.DialContext(ctx, *agentaddr,
-		grpc.WithTransportCredentials(insecure.NewCredentials()),
-		grpc.WithBlock())
-	if err != nil {
-		log.Errorf(ctx, err, "failed to connect to Grafana agent")
-		os.Exit(1)
-	}
-	log.Debugf(ctx, "connected to Grafana agent %s", *agentaddr)
-	ctx, err = trace.Context(ctx, genlocator.ServiceName, trace.WithGRPCExporter(conn))
-	if err != nil {
-		log.Errorf(ctx, err, "failed to initialize tracing")
-		os.Exit(1)
+	if !*monitoringEnabled {
+		var err error
+		if ctx, err = trace.Context(ctx, genlocator.ServiceName, trace.WithDisabled()); err != nil {
+			log.Error(ctx, err, log.KV{K: "msg", V: "failed to initialize tracing"})
+		}
+	} else {
+		log.Debugf(ctx, "connecting to Grafana agent %s", *agentaddr)
+		conn, err := grpc.DialContext(ctx, *agentaddr,
+			grpc.WithTransportCredentials(insecure.NewCredentials()),
+			grpc.WithBlock())
+		if err != nil {
+			log.Errorf(ctx, err, "failed to connect to Grafana agent")
+			os.Exit(1)
+		}
+		log.Debugf(ctx, "connected to Grafana agent %s", *agentaddr)
+		ctx, err = trace.Context(ctx, genlocator.ServiceName, trace.WithGRPCExporter(conn))
+		if err != nil {
+			log.Errorf(ctx, err, "failed to initialize tracing")
+			os.Exit(1)
+		}
 	}
 
 	// 3. Setup metrics

example/weather/services/tester/cmd/tester/main.go

@@ -40,6 +40,7 @@ func main() {
 		locatorAddr          = flag.String("locator-addr", ":8082", "Locator service address")
 		locatorHealthAddr    = flag.String("locator-health-addr", ":8083", "Locator service health-check address")
 		debugf               = flag.Bool("debug", false, "Enable debug logs")
+		monitoringEnabled    = flag.Bool("monitoring-enabled", true, "monitoring")
 	)
 	flag.Parse()
 
@@ -56,19 +57,26 @@ func main() {
 	}
 
 	// 2. Setup tracing
-	log.Debugf(ctx, "connecting to Grafana agent %s", *agentaddr)
-	conn, err := grpc.DialContext(ctx, *agentaddr,
-		grpc.WithTransportCredentials(insecure.NewCredentials()),
-		grpc.WithBlock())
-	if err != nil {
-		log.Errorf(ctx, err, "failed to connect to Grafana agent")
-		os.Exit(1)
-	}
-	log.Debugf(ctx, "connected to Grafana agent %s", *agentaddr)
-	ctx, err = trace.Context(ctx, gentester.ServiceName, trace.WithGRPCExporter(conn))
-	if err != nil {
-		log.Errorf(ctx, err, "failed to initialize tracing")
-		os.Exit(1)
+	if !*monitoringEnabled {
+		var err error
+		if ctx, err = trace.Context(ctx, gentester.ServiceName, trace.WithDisabled()); err != nil {
+			log.Error(ctx, err, log.KV{K: "msg", V: "failed to initialize tracing"})
+		}
+	} else {
+		log.Debugf(ctx, "connecting to Grafana agent %s", *agentaddr)
+		conn, err := grpc.DialContext(ctx, *agentaddr,
+			grpc.WithTransportCredentials(insecure.NewCredentials()),
+			grpc.WithBlock())
+		if err != nil {
+			log.Errorf(ctx, err, "failed to connect to Grafana agent")
+			os.Exit(1)
+		}
+		log.Debugf(ctx, "connected to Grafana agent %s", *agentaddr)
+		ctx, err = trace.Context(ctx, gentester.ServiceName, trace.WithGRPCExporter(conn))
+		if err != nil {
+			log.Errorf(ctx, err, "failed to initialize tracing")
+			os.Exit(1)
+		}
 	}
 
 	// 3. Setup metrics