From 255db7aab15d6a8b45564a18fb2bfa990da02ead Mon Sep 17 00:00:00 2001
From: gkoutsou <gkoutsou@users.noreply.github.com>
Date: Fri, 16 Aug 2024 22:18:47 +0200
Subject: [PATCH] Add ENVs using NewTestDockerCluster (#27457)

* Add ENVs using NewTestDockerCluster

Currently NewTestDockerCluster had no means for setting any
environment variables. This makes it tricky to create test
for functionality that require thems, like having to set
AWS environment variables.

DockerClusterOptions now exposes an option to pass extra
enviroment variables to the containers, which are appended
to the existing ones.

* adding changelog

* added test case for setting env variables to containers

* fix changelog typo; env name

* Update changelog/27457.txt

Co-authored-by: akshya96 <87045294+akshya96@users.noreply.github.com>

* adding the missing copyright

---------

Co-authored-by: akshya96 <87045294+akshya96@users.noreply.github.com>
---
 changelog/27457.txt                           |  3 ++
 sdk/helper/testcluster/docker/environment.go  | 20 ++++++----
 .../testcluster/docker/environment_test.go    | 38 +++++++++++++++++++
 3 files changed, 53 insertions(+), 8 deletions(-)
 create mode 100644 changelog/27457.txt
 create mode 100644 sdk/helper/testcluster/docker/environment_test.go

diff --git a/changelog/27457.txt b/changelog/27457.txt
new file mode 100644
index 0000000000..e3cf89a765
--- /dev/null
+++ b/changelog/27457.txt
@@ -0,0 +1,3 @@
+```release-note:improvement
+sdk/helper: Allow setting environment variables when using NewTestDockerCluster
+```
diff --git a/sdk/helper/testcluster/docker/environment.go b/sdk/helper/testcluster/docker/environment.go
index fd1c11ffee..8dd40904f7 100644
--- a/sdk/helper/testcluster/docker/environment.go
+++ b/sdk/helper/testcluster/docker/environment.go
@@ -805,20 +805,23 @@ func (n *DockerClusterNode) Start(ctx context.Context, opts *DockerClusterOption
 		}
 	}
 
+	envs := []string{
+		// For now we're using disable_mlock, because this is for testing
+		// anyway, and because it prevents us using external plugins.
+		"SKIP_SETCAP=true",
+		"VAULT_LOG_FORMAT=json",
+		"VAULT_LICENSE=" + opts.VaultLicense,
+	}
+	envs = append(envs, opts.Envs...)
+
 	r, err := dockhelper.NewServiceRunner(dockhelper.RunOptions{
 		ImageRepo: n.ImageRepo,
 		ImageTag:  n.ImageTag,
 		// We don't need to run update-ca-certificates in the container, because
 		// we're providing the CA in the raft join call, and otherwise Vault
 		// servers don't talk to one another on the API port.
-		Cmd: append([]string{"server"}, opts.Args...),
-		Env: []string{
-			// For now we're using disable_mlock, because this is for testing
-			// anyway, and because it prevents us using external plugins.
-			"SKIP_SETCAP=true",
-			"VAULT_LOG_FORMAT=json",
-			"VAULT_LICENSE=" + opts.VaultLicense,
-		},
+		Cmd:               append([]string{"server"}, opts.Args...),
+		Env:               envs,
 		Ports:             ports,
 		ContainerName:     n.Name(),
 		NetworkName:       opts.NetworkName,
@@ -1089,6 +1092,7 @@ type DockerClusterOptions struct {
 	CA          *testcluster.CA
 	VaultBinary string
 	Args        []string
+	Envs        []string
 	StartProbe  func(*api.Client) error
 	Storage     testcluster.ClusterStorage
 	DisableTLS  bool
diff --git a/sdk/helper/testcluster/docker/environment_test.go b/sdk/helper/testcluster/docker/environment_test.go
new file mode 100644
index 0000000000..bb23764052
--- /dev/null
+++ b/sdk/helper/testcluster/docker/environment_test.go
@@ -0,0 +1,38 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package docker
+
+import (
+	"testing"
+)
+
+func TestSettingEnvsToContainer(t *testing.T) {
+	expectedEnv := "TEST_ENV=value1"
+	expectedEnv2 := "TEST_ENV2=value2"
+	opts := &DockerClusterOptions{
+		ImageRepo: "hashicorp/vault",
+		ImageTag:  "latest",
+		Envs:      []string{expectedEnv, expectedEnv2},
+	}
+	cluster := NewTestDockerCluster(t, opts)
+	defer cluster.Cleanup()
+
+	envs := cluster.GetActiveClusterNode().Container.Config.Env
+
+	if !findEnv(envs, expectedEnv) {
+		t.Errorf("Missing ENV variable: %s", expectedEnv)
+	}
+	if !findEnv(envs, expectedEnv2) {
+		t.Errorf("Missing ENV variable: %s", expectedEnv2)
+	}
+}
+
+func findEnv(envs []string, env string) bool {
+	for _, e := range envs {
+		if e == env {
+			return true
+		}
+	}
+	return false
+}