From cc3bce7c4d2c1e4300794d1cb7c2068ea7ff35da Mon Sep 17 00:00:00 2001
From: Dan Jaglowski <jaglows3@gmail.com>
Date: Thu, 10 Nov 2022 12:07:30 -0500
Subject: [PATCH] [receiver/rabbitmq] Fix flaky integration test

This test fails periodially with a non-zero exit code returned from
the setup script. The likely cause is that the wait strategy was not
robust enough, in that the rabbitmqadmin command was not ready before
associated commands were run.

This fix incorporates the setup script into a custom wait strategy,
which allows the script to be rerun until it succeeds.
---
 receiver/rabbitmqreceiver/integration_test.go | 45 +++++++++++++++----
 .../testdata/integration/scripts/setup.sh     | 16 ++++---
 2 files changed, 48 insertions(+), 13 deletions(-)

diff --git a/receiver/rabbitmqreceiver/integration_test.go b/receiver/rabbitmqreceiver/integration_test.go
index 02ab83b7c15f4..c59fe46215f26 100644
--- a/receiver/rabbitmqreceiver/integration_test.go
+++ b/receiver/rabbitmqreceiver/integration_test.go
@@ -19,10 +19,14 @@ package rabbitmqreceiver
 
 import (
 	"context"
+	"errors"
 	"fmt"
+	"io"
 	"path/filepath"
+	"strings"
 	"testing"
 	"time"
+	"unicode"
 
 	"github.com/stretchr/testify/require"
 	"github.com/testcontainers/testcontainers-go"
@@ -42,8 +46,7 @@ var (
 		},
 		ExposedPorts: []string{"15672:15672"},
 		Hostname:     "localhost",
-		WaitingFor: wait.ForListeningPort("15672").
-			WithStartupTimeout(2 * time.Minute),
+		WaitingFor:   waitStrategy{},
 	}
 )
 
@@ -54,6 +57,8 @@ func TestRabbitmqIntegration(t *testing.T) {
 		defer func() {
 			require.NoError(t, container.Terminate(context.Background()))
 		}()
+		require.NoError(t, container.Start(context.Background()))
+
 		hostname, err := container.Host(context.Background())
 		require.NoError(t, err)
 
@@ -93,12 +98,36 @@ func getContainer(t *testing.T, req testcontainers.ContainerRequest) testcontain
 			Started:          true,
 		})
 	require.NoError(t, err)
+	return container
+}
 
-	code, _, err := container.Exec(context.Background(), []string{"./setup.sh"})
-	require.NoError(t, err)
-	require.Equal(t, 0, code)
+type waitStrategy struct{}
 
-	err = container.Start(context.Background())
-	require.NoError(t, err)
-	return container
+func (ws waitStrategy) WaitUntilReady(ctx context.Context, st wait.StrategyTarget) error {
+	if err := wait.ForListeningPort("15672").
+		WithStartupTimeout(2*time.Minute).
+		WaitUntilReady(ctx, st); err != nil {
+		return err
+	}
+
+	code, r, err := st.Exec(context.Background(), []string{"./setup.sh"})
+	if err != nil {
+		return err
+	}
+	if code == 0 {
+		return nil
+	}
+
+	// Try to read the error message for the sake of debugging
+	if errBytes, readerErr := io.ReadAll(r); readerErr == nil {
+		// Error message may have non-printable chars, so clean it up
+		errStr := strings.Map(func(r rune) rune {
+			if unicode.IsPrint(r) {
+				return r
+			}
+			return -1
+		}, string(errBytes))
+		return errors.New(strings.TrimSpace(errStr))
+	}
+	return errors.New("setup script returned non-zero exit code")
 }
diff --git a/receiver/rabbitmqreceiver/testdata/integration/scripts/setup.sh b/receiver/rabbitmqreceiver/testdata/integration/scripts/setup.sh
index 5022780b8577c..658e0e02eeed4 100644
--- a/receiver/rabbitmqreceiver/testdata/integration/scripts/setup.sh
+++ b/receiver/rabbitmqreceiver/testdata/integration/scripts/setup.sh
@@ -5,12 +5,18 @@ set -e
 USER='otelu'
 ROOT_PASS='otelp'
 
-echo "creating user: ${USER} . . ."
-rabbitmqctl add_user ${USER} ${ROOT_PASS} > /dev/null
+# Test if rabbitmqctl is working at all
+rabbitmqctl list_users > /dev/null
 
-echo "Configuring ${USER} permissions. . ."
-rabbitmqctl set_user_tags ${USER} administrator > /dev/null
-rabbitmqctl set_permissions -p /  ${USER} ".*" ".*" ".*" > /dev/null
+# Don't recreate user if already exists
+if ! rabbitmqctl list_users | grep otelu > /dev/null; then
+    echo "creating user: ${USER} . . ."
+    rabbitmqctl add_user ${USER} ${ROOT_PASS} > /dev/null
+
+    echo "Configuring ${USER} permissions. . ."
+    rabbitmqctl set_user_tags ${USER} administrator > /dev/null
+    rabbitmqctl set_permissions -p /  ${USER} ".*" ".*" ".*" > /dev/null
+fi
 
 echo "create exchange and queue. . ."
 rabbitmqadmin -u ${USER} -p ${ROOT_PASS} declare exchange --vhost=/ name=some_exchange type=direct > /dev/null