implemented a tool for making coverage reports by external tests

Author: Serhii Zakharov

aggregator.go

@@ -445,7 +445,11 @@ func main() {
 		command = strings.ToLower(strings.TrimSpace(os.Args[1]))
 	}
 
-	os.Exit(handleCommand(command))
+	errCode := handleCommand(command)
+	if errCode != 0 {
+		log.Error().Msgf("Service exited with non-zero code %v", errCode)
+		os.Exit(errCode)
+	}
 }
 
 func handleCommand(command string) int {

consumer/consumer.go

@@ -57,6 +57,7 @@ type KafkaConsumer struct {
 	numberOfSuccessfullyConsumedMessages uint64
 	numberOfErrorsConsumingMessages      uint64
 	ready                                chan bool
+	cancel                               context.CancelFunc
 }
 
 // DefaultSaramaConfig is a config which will be used by default
@@ -100,6 +101,7 @@ func NewWithSaramaConfig(
 // Serve starts listening for messages and processing them. It blocks current thread.
 func (consumer *KafkaConsumer) Serve() {
 	ctx, cancel := context.WithCancel(context.Background())
+	consumer.cancel = cancel
 
 	go func() {
 		for {
@@ -180,6 +182,10 @@ func (consumer *KafkaConsumer) ConsumeClaim(session sarama.ConsumerGroupSession,
 
 // Close method closes all resources used by consumer
 func (consumer *KafkaConsumer) Close() error {
+	if consumer.cancel != nil {
+		consumer.cancel()
+	}
+
 	if consumer.ConsumerGroup != nil {
 		if err := consumer.ConsumerGroup.Close(); err != nil {
 			log.Error().Err(err).Msg("Unable to close consumer group")

export_test.go

@@ -39,4 +39,5 @@ var (
 	SetMigrationVersion   = setMigrationVersion
 	PerformMigrations     = performMigrations
 	AutoMigratePtr        = &autoMigrate
+	Main                  = main
 )

make-coverage.sh

@@ -0,0 +1,57 @@
+#!/usr/bin/env bash
+
+rm coverage.out 2>/dev/null
+
+case $1 in
+"unit-sqlite")
+    echo "Running unit tests with SQLite in memory..."
+    go test -coverprofile=coverage.out ./... 1>&2
+    ;;
+"unit-postgres")
+    export INSIGHTS_RESULTS_AGGREGATOR__TESTS_DB="postgres"
+    export INSIGHTS_RESULTS_AGGREGATOR__TESTS_DB_ADMIN_PASS="admin"
+
+    echo "Running unit tests with postgres..."
+    go test -coverprofile=coverage.out ./... 1>&2
+    ;;
+"rest")
+    echo rest # TODO: rest
+    echo "Running REST API tests..."
+    rm test.db 2> /dev/null
+    rm ./insights-results-aggregator.test 2> /dev/null
+
+    go test -c -v -tags testrunmain -coverpkg="./..." . 1>&2
+
+    (
+        export INSIGHTS_RESULTS_AGGREGATOR_CONFIG_FILE=./tests/tests
+
+        echo "Migrating the DB"
+        go run . migrate latest
+        echo "Starting a service"
+        ./insights-results-aggregator.test -test.v -test.run "^TestRunMain$" -test.coverprofile=coverage.out 1>&2
+    ) &
+
+    # TODO: use curl in a loop to test when service is available
+    sleep 2s
+    ./test.sh --verbose --no-service 1>&2
+    pkill --signal SIGINT -f insights-results-aggregator.test
+
+    rm ./insights-results-aggregator.test 2>/dev/null
+
+    ;;
+"integration")
+    echo "Running a service..."
+    echo "Start your integration tests and press Ctrl+C when they are done"
+
+    export INSIGHTS_RESULTS_AGGREGATOR_CONFIG_FILE=./config-devel
+    go test -v -tags testrunmain -run "^TestRunMain$" -coverprofile=coverage.out -coverpkg="./..." . 1>&2
+    ;;
+*)
+    echo 'Please, choose "unit-sqlite", "unit-postgres", "rest" or "integration"'
+    echo "Aggregator's output will be redirected to stderr."
+    echo "Coverage is saved to 'coverage.out' file"
+    exit 1
+    ;;
+esac
+
+go tool cover -func=coverage.out | grep -E "^total"

run_main_test.go

@@ -0,0 +1,29 @@
+// +build testrunmain
+
+package main_test
+
+import (
+	"fmt"
+	"os"
+	"os/signal"
+	"testing"
+
+	main "github.com/RedHatInsights/insights-results-aggregator"
+)
+
+func TestRunMain(t *testing.T) {
+	interruptSignal := make(chan os.Signal, 1)
+	signal.Notify(interruptSignal, os.Interrupt)
+	go func() {
+		<-interruptSignal
+		errCode := main.StopService()
+		if errCode != 0 {
+			panic(fmt.Sprintf("service has exited with a code %v", errCode))
+		}
+	}()
+
+	fmt.Println("starting...")
+	os.Args = []string{"./insights-results-aggregator", "start-service"}
+	main.Main()
+	fmt.Println("exiting...")
+}

test.sh

@@ -17,13 +17,18 @@ COLORS_RED='\033[0;31m'
 COLORS_RESET='\033[0m'
 LOG_LEVEL="fatal"
 VERBOSE=false
+NO_SERVICE=false
 
 if [[ $* == *verbose* ]]; then
     # print all possible logs
     LOG_LEVEL=""
     VERBOSE=true
 fi
 
+if [[ $* == *no-service* ]]; then
+    NO_SERVICE=true
+fi
+
 function cleanup() {
     print_descendent_pids() {
         pids=$(pgrep -P "$1")
@@ -65,8 +70,7 @@ function migrate_db_to_latest() {
     echo "Migrating DB to the latest migration version..."
 
     if INSIGHTS_RESULTS_AGGREGATOR_CONFIG_FILE=./tests/tests \
-        ./insights-results-aggregator migrate latest >/dev/null
-    then
+        ./insights-results-aggregator migrate latest >/dev/null; then
 
         echo "Database migration was successful"
         return 0
@@ -89,6 +93,11 @@ function populate_db_with_mock_data() {
 }
 
 function start_service() {
+    if [ "$NO_SERVICE" = true ]; then
+        echo "Not starting service"
+        return
+    fi
+
     echo "Starting a service"
     # TODO: stop parent(this script) if service died
     INSIGHTS_RESULTS_AGGREGATOR__LOGGING__LOG_LEVEL=$LOG_LEVEL \
@@ -135,8 +144,7 @@ function test_openapi() {
     echo "Testing OpenAPI specifications file"
     # shellcheck disable=2181
 
-    if docker run --rm -v "${PWD}":/local/:Z openapitools/openapi-generator-cli validate -i ./local/openapi.json
-    then
+    if docker run --rm -v "${PWD}":/local/:Z openapitools/openapi-generator-cli validate -i ./local/openapi.json; then
         echo "OpenAPI spec file is OK"
     else
         echo "OpenAPI spec file validation failed"