docker-compose-legacy-auth_test.go

//go:build docker || compose || integration || integrationComposeLegacyAuth
// +build docker compose integration integrationComposeLegacyAuth

package integration

import (
	"fmt"
	"strings"
	"testing"

	"path/filepath"

	"github.com/gruntwork-io/terratest/modules/docker"
	"github.com/gruntwork-io/terratest/modules/logger"
	"github.com/gruntwork-io/terratest/modules/random"

	"github.com/stretchr/testify/require"
	"github.com/stretchr/testify/suite"

	"github.com/compose-spec/compose-go/v2/dotenv"
)

const (
	dockerLegacyAuthDir = "../../../docker/legacy-auth"
)

var legacyAuthComposeFile = "compose.yaml"
var legacyAuthComposePluginsFile = "compose.plugins.yaml"
var legacyAuthComposeDedicatedPluginsFile = "compose.dedicated-plugins.yaml"
var legacyAuthComposeDelegatedOperationsFile = "compose.delegated-operators.yaml"
var legacyAuthEnvTemplateFilePath = filepath.Join(dockerLegacyAuthDir, "env.template")

type commonServicesLegacyAuthDockerComposeUpTest struct {
	suite.Suite
	composeFilePath      string
	dotEnvFiles          []string
	overrideFiles        []string
	overrideFilesPlugins []string
	overrideFilesDO      []string
}

func TestDockerComposeUpLegacyAuth(t *testing.T) {
	t.Parallel()

	_, err := filepath.Abs(dockerLegacyAuthDir)
	require.NoError(t, err)

	// Set the override files used for the tests
	overrideFiles := []string{
		overrideFile,
		mongodbComposeFile,
	}

	// Plugins require overriding the teams-plugin image
	var overrideFilesPlugins []string
	overrideFilesPlugins = append(overrideFilesPlugins, overrideFiles...)
	overrideFilesPlugins = append(overrideFilesPlugins, mongodbComposeFilePlugins)

	var overrideFilesDO []string
	overrideFilesDO = append(overrideFilesDO, legacyAuthComposePluginsFile)
	overrideFilesDO = append(overrideFilesDO, overrideFiles...)
	overrideFilesDO = append(overrideFilesDO, mongodbComposeFileDO)

	suite.Run(t, &commonServicesLegacyAuthDockerComposeUpTest{
		Suite:           suite.Suite{},
		composeFilePath: dockerLegacyAuthDir,
		dotEnvFiles: []string{
			legacyAuthEnvTemplateFilePath,
			legacyAuthEnvFixtureFilePath,
		},
		overrideFiles:        overrideFiles,
		overrideFilesPlugins: overrideFilesPlugins,
		overrideFilesDO:      overrideFilesDO,
	})
}

func (s *commonServicesLegacyAuthDockerComposeUpTest) TestDockerComposeUp() {
	testCases := []struct {
		name          string
		composeFile   string
		overrideFiles []string
		envFiles      []string // file paths to ".env" files with additional environment variable data
		expected      []serviceValidations
	}{
		{
			"compose",
			legacyAuthComposeFile,
			s.overrideFiles,
			s.dotEnvFiles,
			[]serviceValidations{
				{
					name:             "teams-api",
					url:              "http://127.0.0.1:8000/health",
					responsePayload:  `{"status":{"teams":"available"}}`,
					httpResponseCode: 200,
					log:              "FiftyOne Teams API starting up",
				},
				{
					name:             "teams-app",
					url:              "http://127.0.0.1:3000/api/hello",
					responsePayload:  `{"status":"available"}`,
					httpResponseCode: 200,
					log:              " ✓ Ready in",
				},
				{
					name:             "teams-cas",
					url:              "http://127.0.0.1:3030/cas/api",
					responsePayload:  `{"status":"available"}`,
					httpResponseCode: 200,
					log:              "FiftyOne CAS starting up",
				},
				// ordering this last to avoid test flakes where testing for log before the container is running
				{
					name:             "fiftyone-app",
					url:              "",
					responsePayload:  "",
					httpResponseCode: 200,
					log:              "Running on http://0.0.0.0:5151",
				},
			},
		},
		{
			"composePlugins",
			legacyAuthComposePluginsFile,
			s.overrideFiles,
			s.dotEnvFiles,
			[]serviceValidations{
				{
					name:             "teams-api",
					url:              "http://127.0.0.1:8000/health",
					responsePayload:  `{"status":{"teams":"available"}}`,
					httpResponseCode: 200,
					log:              "FiftyOne Teams API starting up",
				},
				{
					name:             "teams-app",
					url:              "http://127.0.0.1:3000/api/hello",
					responsePayload:  `{"status":"available"}`,
					httpResponseCode: 200,
					log:              " ✓ Ready in",
				},
				{
					name:             "teams-cas",
					url:              "http://127.0.0.1:3030/cas/api",
					responsePayload:  `{"status":"available"}`,
					httpResponseCode: 200,
					log:              "FiftyOne CAS starting up",
				},
				// ordering this last to avoid test flakes where testing for log before the container is running
				{
					name:             "fiftyone-app",
					url:              "",
					responsePayload:  "",
					httpResponseCode: 200,
					log:              "Running on http://0.0.0.0:5151",
				},
			},
		},
		{
			"composeDedicatedPlugins",
			legacyAuthComposeDedicatedPluginsFile,
			s.overrideFilesPlugins,
			s.dotEnvFiles,
			[]serviceValidations{
				{
					name:             "teams-api",
					url:              "http://127.0.0.1:8000/health",
					responsePayload:  `{"status":{"teams":"available"}}`,
					httpResponseCode: 200,
					log:              "FiftyOne Teams API starting up",
				},
				{
					name:             "teams-app",
					url:              "http://127.0.0.1:3000/api/hello",
					responsePayload:  `{"status":"available"}`,
					httpResponseCode: 200,
					log:              " ✓ Ready in",
				},
				{
					name:             "teams-cas",
					url:              "http://127.0.0.1:3030/cas/api",
					responsePayload:  `{"status":"available"}`,
					httpResponseCode: 200,
					log:              "FiftyOne CAS starting up",
				},
				// ordering this last to avoid test flakes where testing for log before the container is running
				{
					name:             "fiftyone-app",
					url:              "",
					responsePayload:  "",
					httpResponseCode: 0,
					log:              "Running on http://0.0.0.0:5151",
				},
				{
					name:             "teams-plugins",
					url:              "",
					responsePayload:  "",
					httpResponseCode: 0,
					log:              "Running on http://0.0.0.0:5151", // same as fiftyone-app since plugins uses or is based on the fiftyone-app image
				},
			},
		},
		{
			"composeDelegatedOperations",
			legacyAuthComposeDelegatedOperationsFile,
			s.overrideFilesDO,
			s.dotEnvFiles,
			[]serviceValidations{
				{
					name:             "teams-api",
					url:              "http://127.0.0.1:8000/health",
					responsePayload:  `{"status":{"teams":"available"}}`,
					httpResponseCode: 200,
					log:              "FiftyOne Teams API starting up",
				},
				{
					name:             "teams-app",
					url:              "http://127.0.0.1:3000/api/hello",
					responsePayload:  `{"status":"available"}`,
					httpResponseCode: 200,
					log:              " ✓ Ready in",
				},
				{
					name:             "teams-cas",
					url:              "http://127.0.0.1:3030/cas/api",
					responsePayload:  `{"status":"available"}`,
					httpResponseCode: 200,
					log:              "FiftyOne CAS starting up",
				},
				// ordering this last to avoid test flakes where testing for log before the container is running
				{
					name:             "fiftyone-app",
					url:              "",
					responsePayload:  "",
					httpResponseCode: 0,
					log:              "Running on http://0.0.0.0:5151",
				},
				{
					name:             "teams-do",
					url:              "",
					responsePayload:  "",
					httpResponseCode: 0,
					log:              "Registering executor builtin",
				},
			},
		},
	}

	for _, testCase := range testCases {
		testCase := testCase

		s.Run(testCase.name, func() {
			subT := s.T()
			// TODO: If we need parallel, dynamically set mongoDB port and configure the env vars with the custom port
			// For now, we cannot perform concurrent runs because mongodb will error on port already in use
			// subT.Parallel()

			// TODO: Should we use `--env-file` instead of the library `dotenv.Read`
			// to more closely align to real world usage?
			// Something like
			//
			// ```shell
			// docker compose \
			//   -f tests/fixtures/docker/compose.override.mongodb.yaml \
			//   --env-file tests/fixtures/docker/integration_legacy_auth.env

			//   up -d
			// ```
			//
			// Use existing function to get map[string]string of environment variables from .env file(s)
			environmentVariables, err := dotenv.Read(testCase.envFiles...)
			s.NoError(err)

			dockerOptions := &docker.Options{
				ProjectName: "fiftyone-" + strings.ToLower(random.UniqueId()),
				WorkingDir:  dockerLegacyAuthDir,
				EnvVars:     environmentVariables,
			}

			// In golang, we cannot mix strings with string slice unpacking.
			// Let's create a slice that will later be unpacked and used as an argument
			// to the variadic function `docker.RunDockerCompose` parameter `args`.
			argsConfig := []string{}
			argsUp := []string{}
			argsDown := []string{}
			args := []string{"-f", testCase.composeFile}

			for _, overrideFile := range testCase.overrideFiles {
				args = append(args, "-f", overrideFile)
			}

			argsConfig = append(args, "config")
			argsUp = append(argsUp, args...)
			argsUp = append(argsUp, "up", "--detach")
			argsDown = append(argsDown, args...)
			argsDown = append(argsDown, "down", "--remove-orphans", "--timeout", "2")
			argsDown = append(argsDown, "--volumes")

			// Config
			docker.RunDockerCompose(
				subT,
				dockerOptions,
				argsConfig...,
			)

			// Delete containers after tests complete
			defer docker.RunDockerCompose(
				subT,
				dockerOptions,
				argsDown...,
			)

			// Run containers
			output := docker.RunDockerCompose(
				subT,
				dockerOptions,
				argsUp...,
			)

			// Validate system health
			for _, expected := range testCase.expected {
				logger.Log(subT, fmt.Sprintf("Validating service %s...", expected.name))
				// Compose CLI v2.x emitted two spaces between `-1` and
				// `Started`; v5.x emits one. Match either with \s+.
				s.Regexp(fmt.Sprintf(`Container %s-%s-1\s+Started`, dockerOptions.ProjectName, expected.name), output, fmt.Sprintf("%s - %s - docker compose output should contain service container started", testCase.name, expected.name))

				// Validate endpoint response
				// Skip fiftyone-app and teams-plugins because they do not have callable endpoints that return a response payload.
				if expected.url != "" {
					validate_endpoint(subT, expected.url, expected.responsePayload, expected.httpResponseCode)
				}

				// Validate log output is expected
				checkContainerLogsWithRetries(subT, dockerOptions, expected.name, testCase.name, expected.log)
			}
		})
	}
}