restconfig_test.go

/*
Copyright 2025 The Flux 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 auth_test

import (
	"context"
	"net/url"
	"testing"
	"time"

	. "github.com/onsi/gomega"
	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

	"github.com/fluxcd/pkg/auth"
	"github.com/fluxcd/pkg/auth/kubernetes"
	"github.com/fluxcd/pkg/cache"
)

func TestGetRESTConfig(t *testing.T) {
	g := NewWithT(t)

	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
	t.Cleanup(cancel)

	kubeClient, oidcClient := newTestEnv(t, ctx)

	// Create a default service account.
	defaultServiceAccount := &corev1.ServiceAccount{
		ObjectMeta: metav1.ObjectMeta{
			Name:      "default",
			Namespace: "default",
		},
	}
	err := kubeClient.Create(ctx, defaultServiceAccount)
	g.Expect(err).NotTo(HaveOccurred())

	// Create a lockdown service account for testing lockdown functionality.
	lockdownServiceAccount := &corev1.ServiceAccount{
		ObjectMeta: metav1.ObjectMeta{
			Name:      "lockdown-sa",
			Namespace: "default",
		},
	}
	err = kubeClient.Create(ctx, lockdownServiceAccount)
	g.Expect(err).NotTo(HaveOccurred())

	now := time.Now()

	for _, tt := range []struct {
		name          string
		provider      *mockProvider
		cluster       string
		opts          []auth.Option
		expectedCreds *auth.RESTConfig
		expectedErr   string
	}{
		{
			name: "restconfig from controller access credential",
			provider: &mockProvider{
				returnControllerCredential: &mockCredential{token: "mock-default-token"},
				returnRESTConfig: &auth.RESTConfig{
					Host:        "https://cluster/resource/name",
					BearerToken: "mock-bearer-token",
					CAData:      []byte("ca-data"),
				},
				paramCluster:       "cluster/resource/name",
				paramFirstScopes:   []string{"first-token"},
				paramSecondScopes:  []string{"second-token"},
				expectFirstScopes:  true,
				expectSecondScopes: true,
				paramAccessCredentials: []auth.Credential{
					&mockCredential{token: "mock-default-token"},
					&mockCredential{token: "mock-default-token"},
				},
			},
			cluster: "cluster/resource/name",
			opts: []auth.Option{
				auth.WithCredentialAudiences("audience1", "audience2"),
				auth.WithScopes("scope1", "scope2"),
				auth.WithAWSRegion("us-east-1"),
				auth.WithAWSSTSEndpoint("https://sts.some-cloud.io"),
				auth.WithProxyURL(url.URL{Scheme: "http", Host: "proxy.io:8080"}),
				auth.WithCAData("ca-data"),
			},
			expectedCreds: &auth.RESTConfig{
				Host:        "https://cluster/resource/name",
				BearerToken: "mock-bearer-token",
				CAData:      []byte("ca-data"),
			},
		},
		{
			name: "restconfig from access credential from service account",
			provider: &mockProvider{
				returnName:             "mock-provider",
				returnAccessCredential: &mockCredential{token: "mock-access-token"},
				returnRESTConfig: &auth.RESTConfig{
					Host:        "https://cluster/resource/name",
					BearerToken: "mock-bearer-token",
					CAData:      []byte("ca-data"),
				},
				paramAudiences:       []string{"audience1", "audience2"},
				paramServiceAccount:  &kubernetes.ServiceAccountReference{Name: defaultServiceAccount.Name, Namespace: defaultServiceAccount.Namespace},
				paramOIDCTokenClient: oidcClient,
				paramCluster:         "cluster/resource/name",
				paramFirstScopes:     []string{"first-token"},
				paramSecondScopes:    []string{"second-token"},
				expectFirstScopes:    true,
				expectSecondScopes:   true,
				paramAccessCredentials: []auth.Credential{
					&mockCredential{token: "mock-access-token"},
					&mockCredential{token: "mock-access-token"},
				},
			},
			cluster: "cluster/resource/name",
			opts: []auth.Option{
				auth.WithClient(kubeClient),
				auth.WithServiceAccountName(defaultServiceAccount.Name),
				auth.WithObject("", "ServiceAccount", defaultServiceAccount),
				auth.WithCredentialAudiences("audience1", "audience2"),
				auth.WithScopes("scope1", "scope2"),
				auth.WithAWSRegion("us-east-1"),
				auth.WithAWSSTSEndpoint("https://sts.some-cloud.io"),
				auth.WithProxyURL(url.URL{Scheme: "http", Host: "proxy.io:8080"}),
				auth.WithCAData("ca-data"),
			},
			expectedCreds: &auth.RESTConfig{
				Host:        "https://cluster/resource/name",
				BearerToken: "mock-bearer-token",
				CAData:      []byte("ca-data"),
			},
		},
		{
			name: "all the options are taken into account in the cache key",
			provider: &mockProvider{
				returnName:          "mock-provider",
				returnIdentity:      "mock-identity",
				paramAudiences:      []string{"audience1", "audience2"},
				paramServiceAccount: &kubernetes.ServiceAccountReference{Name: defaultServiceAccount.Name, Namespace: defaultServiceAccount.Namespace},
				paramCluster:        "cluster/resource/name",
				paramClusterAddress: "https://cluster/resource/name",
				paramFirstScopes:    []string{"first-token"},
				paramSecondScopes:   []string{"second-token"},
				expectFirstScopes:   true,
				expectSecondScopes:  true,
			},
			cluster: "cluster/resource/name",
			opts: []auth.Option{
				auth.WithClient(kubeClient),
				auth.WithServiceAccountName(defaultServiceAccount.Name),
				auth.WithObject("", "ServiceAccount", defaultServiceAccount),
				auth.WithCredentialAudiences("audience1", "audience2"),
				auth.WithScopes("scope1", "scope2"),
				auth.WithAWSRegion("us-east-1"),
				auth.WithAWSSTSEndpoint("https://sts.some-cloud.io"),
				auth.WithProxyURL(url.URL{Scheme: "http", Host: "proxy.io:8080"}),
				auth.WithCAData("ca-data"),
				auth.WithClusterResource("cluster/resource/name"),
				auth.WithClusterAddress("https://cluster/resource/name"),
				func(o *auth.Options) {
					tokenCache, err := cache.NewTokenCache(3)
					g.Expect(err).NotTo(HaveOccurred())

					accessCredentialKey := "61f0d5d2ddd8c21ebcbab3686c5fe73234d7a825d02062baaa2951565eeb7398"
					var credential auth.Credential = &mockCredential{token: "cached-token"}
					cachedCredential, ok, err := tokenCache.GetOrSet(ctx, accessCredentialKey, func(ctx context.Context) (cache.Token, error) {
						return credential, nil
					})
					g.Expect(err).NotTo(HaveOccurred())
					g.Expect(ok).To(BeFalse())
					g.Expect(cachedCredential).To(Equal(credential))

					accessCredentialKey = "583b0d84b5393b72396ad500503a74315e86b7044c3085d470c6597e751438af"
					credential = &mockCredential{token: "cached-token"}
					cachedCredential, ok, err = tokenCache.GetOrSet(ctx, accessCredentialKey, func(ctx context.Context) (cache.Token, error) {
						return credential, nil
					})
					g.Expect(err).NotTo(HaveOccurred())
					g.Expect(ok).To(BeFalse())
					g.Expect(cachedCredential).To(Equal(credential))

					const restConfigKey = "8e65b5b906da5063a5d44023296bf6e83b72ab1f347b96c216a88e7175311f9e"
					credential = &auth.RESTConfig{
						Host:        "https://cluster/resource/name",
						BearerToken: "mock-bearer-token",
						CAData:      []byte("ca-data"),
						ExpiresAt:   now.Add(time.Hour),
					}
					cachedCredential, ok, err = tokenCache.GetOrSet(ctx, restConfigKey, func(ctx context.Context) (cache.Token, error) {
						return credential, nil
					})
					g.Expect(err).NotTo(HaveOccurred())
					g.Expect(ok).To(BeFalse())
					g.Expect(cachedCredential).To(Equal(credential))

					o.Cache = tokenCache
				},
			},
			expectedCreds: &auth.RESTConfig{
				Host:        "https://cluster/resource/name",
				BearerToken: "mock-bearer-token",
				CAData:      []byte("ca-data"),
				ExpiresAt:   now.Add(time.Hour),
			},
		},
		{
			name: "error getting access credential options for cluster",
			provider: &mockProvider{
				paramCluster:            "cluster/resource/name",
				returnRESTConfigOptsErr: "mock error",
			},
			cluster:     "cluster/resource/name",
			expectedErr: "mock error",
		},
		{
			name: "restconfig from explicit service account",
			provider: &mockProvider{
				returnName:             "mock-provider",
				returnAccessCredential: &mockCredential{token: "mock-access-token"},
				returnRESTConfig: &auth.RESTConfig{
					Host:        "https://cluster/resource/name",
					BearerToken: "mock-bearer-token",
					CAData:      []byte("ca-data"),
				},
				paramAudiences:       []string{"audience1", "audience2"},
				paramServiceAccount:  &kubernetes.ServiceAccountReference{Name: lockdownServiceAccount.Name, Namespace: lockdownServiceAccount.Namespace},
				paramOIDCTokenClient: oidcClient,
				paramCluster:         "cluster/resource/name",
				paramFirstScopes:     []string{"first-token"},
				paramSecondScopes:    []string{"second-token"},
				expectFirstScopes:    true,
				expectSecondScopes:   true,
				paramAccessCredentials: []auth.Credential{
					&mockCredential{token: "mock-access-token"},
					&mockCredential{token: "mock-access-token"},
				},
			},
			cluster: "cluster/resource/name",
			opts: []auth.Option{
				auth.WithClient(kubeClient),
				auth.WithServiceAccountName(lockdownServiceAccount.Name),
				auth.WithObject("", "ServiceAccount", lockdownServiceAccount),
				auth.WithCredentialAudiences("audience1", "audience2"),
				auth.WithScopes("scope1", "scope2"),
				auth.WithAWSRegion("us-east-1"),
				auth.WithAWSSTSEndpoint("https://sts.some-cloud.io"),
				auth.WithProxyURL(url.URL{Scheme: "http", Host: "proxy.io:8080"}),
				auth.WithCAData("ca-data"),
			},
			expectedCreds: &auth.RESTConfig{
				Host:        "https://cluster/resource/name",
				BearerToken: "mock-bearer-token",
				CAData:      []byte("ca-data"),
			},
		},
	} {
		t.Run(tt.name, func(t *testing.T) {
			g := NewWithT(t)

			tt.provider.t = t

			if tt.cluster != "" {
				tt.opts = append(tt.opts, auth.WithClusterResource(tt.cluster))
			}

			creds, err := auth.GetRESTConfig(ctx, tt.provider, tt.opts...)

			if tt.expectedErr != "" {
				g.Expect(err).To(HaveOccurred())
				g.Expect(err.Error()).To(ContainSubstring(tt.expectedErr))
				g.Expect(creds).To(BeNil())
			} else {
				g.Expect(err).NotTo(HaveOccurred())
				g.Expect(creds).To(Equal(tt.expectedCreds))
			}
		})
	}
}