external-dns/provider/aws/config_test.go

/*
Copyright 2023 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package aws

import (
	"fmt"
	"os"
	"testing"

	"github.com/sirupsen/logrus"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"sigs.k8s.io/external-dns/internal/testutils"
	logtest "sigs.k8s.io/external-dns/internal/testutils/log"
	"sigs.k8s.io/external-dns/pkg/apis/externaldns"
)

func Test_newV2Config(t *testing.T) {
	testutils.TestHelperEnvSetter(t, map[string]string{
		"AWS_REGION":                "us-east-1",
		"AWS_EC2_METADATA_DISABLED": "true",
	})

	t.Run("should use profile from credentials file", func(t *testing.T) {
		// setup
		credsFile, err := prepareCredentialsFile(t)
		defer os.Remove(credsFile.Name())
		require.NoError(t, err)
		testutils.TestHelperEnvSetter(t, map[string]string{
			"AWS_SHARED_CREDENTIALS_FILE": credsFile.Name(),
		})

		// when
		cfg, err := newV2Config(AWSSessionConfig{Profile: "profile2"})
		require.NoError(t, err)
		creds, err := cfg.Credentials.Retrieve(t.Context())

		// then
		assert.NoError(t, err)
		assert.Equal(t, "AKID2345", creds.AccessKeyID)
		assert.Equal(t, "SECRET2", creds.SecretAccessKey)
	})

	t.Run("should respect env variables without profile", func(t *testing.T) {
		// setup
		testutils.TestHelperEnvSetter(t, map[string]string{
			"AWS_ACCESS_KEY_ID":     "AKIAIOSFODNN7EXAMPLE",
			"AWS_SECRET_ACCESS_KEY": "topsecret",
		})

		// when
		cfg, err := newV2Config(AWSSessionConfig{})
		require.NoError(t, err)
		creds, err := cfg.Credentials.Retrieve(t.Context())

		// then
		assert.NoError(t, err)
		assert.Equal(t, "AKIAIOSFODNN7EXAMPLE", creds.AccessKeyID)
		assert.Equal(t, "topsecret", creds.SecretAccessKey)
	})

	t.Run("should not error when AWS_CA_BUNDLE set", func(t *testing.T) {
		// setup
		testutils.TestHelperEnvSetter(t, map[string]string{
			"AWS_CA_BUNDLE": "../../internal/testresources/ca.pem",
		})

		// when
		_, err := newV2Config(AWSSessionConfig{})
		require.NoError(t, err)

		// then
		assert.NoError(t, err)
	})

	t.Run("should configure assume role credentials", func(t *testing.T) {
		// setup
		testutils.TestHelperEnvSetter(t, map[string]string{
			"AWS_ACCESS_KEY_ID":     "AKIAIOSFODNN7EXAMPLE",
			"AWS_SECRET_ACCESS_KEY": "topsecret",
		})

		// when
		cfg, err := newV2Config(AWSSessionConfig{
			AssumeRole:           "arn:aws:iam::123456789012:role/example",
			AssumeRoleExternalID: "external-id",
		})

		// then
		require.NoError(t, err)
		require.NotNil(t, cfg.Credentials)
		assert.Contains(t, fmt.Sprintf("%T", cfg.Credentials), "CredentialsCache")
	})

	t.Run("should log assume role without external ID", func(t *testing.T) {
		// setup
		testutils.TestHelperEnvSetter(t, map[string]string{
			"AWS_ACCESS_KEY_ID":     "AKIAIOSFODNN7EXAMPLE",
			"AWS_SECRET_ACCESS_KEY": "topsecret",
		})

		hook := logtest.LogsUnderTestWithLogLevel(logrus.InfoLevel, t)
		defer hook.Reset()

		// when
		_, err := newV2Config(AWSSessionConfig{
			AssumeRole: "arn:aws:iam::123456789012:role/example",
		})

		// then
		require.NoError(t, err)
		logtest.TestHelperLogContainsWithLogLevel(
			"Assuming role: arn:aws:iam::123456789012:role/example",
			logrus.InfoLevel,
			hook,
			t,
		)
	})

	t.Run("returns error when config cannot be loaded", func(t *testing.T) {
		// setup
		testutils.TestHelperEnvSetter(t, map[string]string{
			"AWS_SHARED_CREDENTIALS_FILE": "missing-ca.pem",
		})

		// when
		_, err := newV2Config(AWSSessionConfig{Profile: "profile1"})

		// then
		require.Error(t, err)
		assert.Contains(t, err.Error(), "instantiating AWS config")
	})
}

func prepareCredentialsFile(t *testing.T) (*os.File, error) {
	credsFile, err := os.CreateTemp(t.TempDir(), "aws-*.creds")
	require.NoError(t, err)
	_, err = credsFile.WriteString("[profile1]\naws_access_key_id=AKID1234\naws_secret_access_key=SECRET1\n\n[profile2]\naws_access_key_id=AKID2345\naws_secret_access_key=SECRET2\n")
	require.NoError(t, err)
	err = credsFile.Close()
	require.NoError(t, err)
	return credsFile, err
}

func TestCreateV2Configs(t *testing.T) {
	testutils.TestHelperEnvSetter(t, map[string]string{
		"AWS_REGION":                "us-east-1",
		"AWS_EC2_METADATA_DISABLED": "true",
	})

	t.Run("returns default profile when none configured", func(t *testing.T) {
		// setup
		testutils.TestHelperEnvSetter(t, map[string]string{
			"AWS_ACCESS_KEY_ID":     "AKIAIOSFODNN7EXAMPLE",
			"AWS_SECRET_ACCESS_KEY": "topsecret",
		})

		cfg := &externaldns.Config{
			AWSAPIRetries: 3,
		}

		// when
		configs := CreateV2Configs(cfg)

		// then
		require.Len(t, configs, 1)
		_, ok := configs[defaultAWSProfile]
		assert.True(t, ok)
	})

	t.Run("returns profile configs when configured", func(t *testing.T) {
		// setup
		credsFile, err := prepareCredentialsFile(t)
		defer os.Remove(credsFile.Name())
		require.NoError(t, err)
		testutils.TestHelperEnvSetter(t, map[string]string{
			"AWS_SHARED_CREDENTIALS_FILE": credsFile.Name(),
		})

		cfg := &externaldns.Config{
			AWSProfiles:   []string{"profile1", "profile2"},
			AWSAPIRetries: 2,
		}

		// when
		configs := CreateV2Configs(cfg)

		// then
		require.Len(t, configs, 2)
		creds, err := configs["profile1"].Credentials.Retrieve(t.Context())
		require.NoError(t, err)
		assert.Equal(t, "AKID1234", creds.AccessKeyID)
		assert.Equal(t, "SECRET1", creds.SecretAccessKey)

		creds, err = configs["profile2"].Credentials.Retrieve(t.Context())
		require.NoError(t, err)
		assert.Equal(t, "AKID2345", creds.AccessKeyID)
		assert.Equal(t, "SECRET2", creds.SecretAccessKey)
	})
}

func TestCreateConfigFatalOnError(t *testing.T) {
	testutils.TestHelperEnvSetter(t, map[string]string{
		"AWS_REGION":                "us-east-1",
		"AWS_EC2_METADATA_DISABLED": "true",
	})

	t.Run("CreateDefaultV2Config exits on load error", func(t *testing.T) {
		testutils.TestHelperEnvSetter(t, map[string]string{
			"AWS_PROFILE":                 "profile1",
			"AWS_SHARED_CREDENTIALS_FILE": "missing-ca.pem",
		})

		exitCode := 0
		_ = logtest.TestHelperWithLogExitFunc(func(code int) {
			exitCode = code
			panic("exit")
		})

		assert.Panics(t, func() {
			CreateDefaultV2Config(&externaldns.Config{})
		})
		assert.Equal(t, 1, exitCode)
	})

	t.Run("CreateV2Configs exits on load error", func(t *testing.T) {
		testutils.TestHelperEnvSetter(t, map[string]string{
			"AWS_SHARED_CREDENTIALS_FILE": "missing-ca.pem",
		})

		exitCode := 0
		_ = logtest.TestHelperWithLogExitFunc(func(code int) {
			exitCode = code
			panic("exit")
		})

		assert.Panics(t, func() {
			CreateV2Configs(&externaldns.Config{AWSProfiles: []string{"profile1"}})
		})
		assert.Equal(t, 1, exitCode)
	})
}