GenerateManifests test (#18)

crenshaw-dev · web-flow · commit 3df8952539ce · 2022-12-14T14:06:29.000-05:00
* GenerateManifests test

Signed-off-by: Michael Crenshaw &lt;350466+crenshaw-dev@users.noreply.github.com&gt;
diff --git a/reposerver/repository/repository.go b/reposerver/repository/repository.go
@@ -83,8 +83,8 @@ var ErrExceededMaxCombinedManifestFileSize = errors.New("exceeded max combined m
 type Service struct {
 	gitCredsStore             git.CredsStore
 	rootDir                   string
-	gitRepoPaths              *io.TempPaths
-	chartPaths                *io.TempPaths
+	gitRepoPaths              io.TempPaths
+	chartPaths                io.TempPaths
 	gitRepoInitializer        func(rootPath string) goio.Closer
 	repoLock                  *repositoryLock
 	cache                     *reposervercache.Cache
@@ -118,6 +118,8 @@ func NewService(metricsServer *metrics.MetricsServer, cache *reposervercache.Cac
 		parallelismLimitSemaphore = semaphore.NewWeighted(initConstants.ParallelismLimit)
 	}
 	repoLock := NewRepositoryLock()
+	gitRandomizedPaths := io.NewRandomizedTempPaths(rootDir)
+	helmRandomizedPaths := io.NewRandomizedTempPaths(rootDir)
 	return &Service{
 		parallelismLimitSemaphore: parallelismLimitSemaphore,
 		repoLock:                  repoLock,
@@ -131,8 +133,8 @@ func NewService(metricsServer *metrics.MetricsServer, cache *reposervercache.Cac
 		initConstants:      initConstants,
 		now:                time.Now,
 		gitCredsStore:      gitCredsStore,
-		gitRepoPaths:       io.NewTempPaths(rootDir),
-		chartPaths:         io.NewTempPaths(rootDir),
+		gitRepoPaths:       gitRandomizedPaths,
+		chartPaths:         helmRandomizedPaths,
 		gitRepoInitializer: directoryPermissionInitializer,
 		rootDir:            rootDir,
 	}
@@ -946,7 +948,7 @@ func populateRequestRepos(appPath string, q *apiclient.ManifestRequest) error {
 	return nil
 }
 
-func helmTemplate(appPath string, repoRoot string, env *v1alpha1.Env, q *apiclient.ManifestRequest, isLocal bool, gitRepoPaths *io.TempPaths) ([]*unstructured.Unstructured, error) {
+func helmTemplate(appPath string, repoRoot string, env *v1alpha1.Env, q *apiclient.ManifestRequest, isLocal bool, gitRepoPaths io.TempPaths) ([]*unstructured.Unstructured, error) {
 	concurrencyAllowed := isConcurrencyAllowed(appPath)
 	if !concurrencyAllowed {
 		manifestGenerateLock.Lock(appPath)
@@ -1084,7 +1086,7 @@ func getResolvedValueFiles(
 	allowedValueFilesSchemas []string,
 	rawValueFiles []string,
 	refSources map[string]*v1alpha1.RefTarget,
-	gitRepoPaths *io.TempPaths,
+	gitRepoPaths io.TempPaths,
 	ignoreMissingValueFiles bool,
 ) ([]pathutil.ResolvedFilePath, error) {
 	var resolvedValueFiles []pathutil.ResolvedFilePath
@@ -1128,7 +1130,7 @@ func getResolvedRefValueFile(
 	env *v1alpha1.Env,
 	allowedValueFilesSchemas []string,
 	refSourceRepo string,
-	gitRepoPaths *io.TempPaths,
+	gitRepoPaths io.TempPaths,
 ) (pathutil.ResolvedFilePath, error) {
 	pathStrings := strings.Split(rawValueFile, "/")
 	repoPath := gitRepoPaths.GetPathIfExists(git.NormalizeGitURL(refSourceRepo))
@@ -1197,7 +1199,7 @@ func WithCMPTarExcludedGlobs(excludedGlobs []string) GenerateManifestOpt {
 }
 
 // GenerateManifests generates manifests from a path. Overrides are applied as a side effect on the given ApplicationSource.
-func GenerateManifests(ctx context.Context, appPath, repoRoot, revision string, q *apiclient.ManifestRequest, isLocal bool, gitCredsStore git.CredsStore, maxCombinedManifestQuantity resource.Quantity, gitRepoPaths *io.TempPaths, opts ...GenerateManifestOpt) (*apiclient.ManifestResponse, error) {
+func GenerateManifests(ctx context.Context, appPath, repoRoot, revision string, q *apiclient.ManifestRequest, isLocal bool, gitCredsStore git.CredsStore, maxCombinedManifestQuantity resource.Quantity, gitRepoPaths io.TempPaths, opts ...GenerateManifestOpt) (*apiclient.ManifestResponse, error) {
 	opt := newGenerateManifestOpt(opts...)
 	var targetObjs []*unstructured.Unstructured
 	var dest *v1alpha1.ApplicationDestination
@@ -1923,7 +1925,7 @@ func (s *Service) createGetAppDetailsCacheHandler(res *apiclient.RepoAppDetailsR
 	}
 }
 
-func populateHelmAppDetails(res *apiclient.RepoAppDetailsResponse, appPath string, repoRoot string, q *apiclient.RepoServerAppDetailsQuery, gitRepoPaths *io.TempPaths) error {
+func populateHelmAppDetails(res *apiclient.RepoAppDetailsResponse, appPath string, repoRoot string, q *apiclient.RepoServerAppDetailsQuery, gitRepoPaths io.TempPaths) error {
 	var selectedValueFiles []string
 
 	if q.Source.Helm != nil {
diff --git a/reposerver/repository/repository_test.go b/reposerver/repository/repository_test.go
@@ -35,26 +35,28 @@ import (
 	fileutil "github.com/argoproj/argo-cd/v2/test/fixture/path"
 	"github.com/argoproj/argo-cd/v2/util/argo"
 	cacheutil "github.com/argoproj/argo-cd/v2/util/cache"
+	dbmocks "github.com/argoproj/argo-cd/v2/util/db/mocks"
 	"github.com/argoproj/argo-cd/v2/util/git"
 	gitmocks "github.com/argoproj/argo-cd/v2/util/git/mocks"
 	"github.com/argoproj/argo-cd/v2/util/helm"
 	helmmocks "github.com/argoproj/argo-cd/v2/util/helm/mocks"
 	"github.com/argoproj/argo-cd/v2/util/io"
+	iomocks "github.com/argoproj/argo-cd/v2/util/io/mocks"
 )
 
 const testSignature = `gpg: Signature made Wed Feb 26 23:22:34 2020 CET
 gpg:                using RSA key 4AEE18F83AFDEB23
 gpg: Good signature from "GitHub (web-flow commit signing) <noreply@github.com>" [ultimate]
 `
 
-type clientFunc func(*gitmocks.Client, *helmmocks.Client)
+type clientFunc func(*gitmocks.Client, *helmmocks.Client, *iomocks.TempPaths)
 
 func newServiceWithMocks(root string, signed bool) (*Service, *gitmocks.Client) {
 	root, err := filepath.Abs(root)
 	if err != nil {
 		panic(err)
 	}
-	return newServiceWithOpt(func(gitClient *gitmocks.Client, helmClient *helmmocks.Client) {
+	return newServiceWithOpt(func(gitClient *gitmocks.Client, helmClient *helmmocks.Client, paths *iomocks.TempPaths) {
 		gitClient.On("Init").Return(nil)
 		gitClient.On("Fetch", mock.Anything).Return(nil)
 		gitClient.On("Checkout", mock.Anything, mock.Anything).Return(nil)
@@ -79,13 +81,17 @@ func newServiceWithMocks(root string, signed bool) (*Service, *gitmocks.Client)
 		helmClient.On("CleanChartCache", chart, version).Return(nil)
 		helmClient.On("CleanChartCache", oobChart, version).Return(nil)
 		helmClient.On("DependencyBuild").Return(nil)
+
+		paths.On("GetPath", mock.Anything).Return(root, nil)
+		paths.On("GetPathIfExists", mock.Anything).Return(root, nil)
 	}, root)
 }
 
 func newServiceWithOpt(cf clientFunc, root string) (*Service, *gitmocks.Client) {
 	helmClient := &helmmocks.Client{}
 	gitClient := &gitmocks.Client{}
-	cf(gitClient, helmClient)
+	paths := &iomocks.TempPaths{}
+	cf(gitClient, helmClient, paths)
 	service := NewService(metrics.NewMetricsServer(), cache.NewCache(
 		cacheutil.NewCache(cacheutil.NewInMemoryCache(1*time.Minute)),
 		1*time.Minute,
@@ -101,6 +107,7 @@ func newServiceWithOpt(cf clientFunc, root string) (*Service, *gitmocks.Client)
 	service.gitRepoInitializer = func(rootPath string) goio.Closer {
 		return io.NopCloser
 	}
+	service.gitRepoPaths = paths
 	return service, gitClient
 }
 
@@ -122,7 +129,7 @@ func newServiceWithCommitSHA(root, revision string) *Service {
 		revisionErr = errors.New("not a commit SHA")
 	}
 
-	service, gitClient := newServiceWithOpt(func(gitClient *gitmocks.Client, helmClient *helmmocks.Client) {
+	service, gitClient := newServiceWithOpt(func(gitClient *gitmocks.Client, helmClient *helmmocks.Client, paths *iomocks.TempPaths) {
 		gitClient.On("Init").Return(nil)
 		gitClient.On("Fetch", mock.Anything).Return(nil)
 		gitClient.On("Checkout", mock.Anything, mock.Anything).Return(nil)
@@ -286,6 +293,35 @@ func TestHelmManifestFromChartRepo(t *testing.T) {
 	}, response)
 }
 
+func TestHelmChartReferencingExternalValues(t *testing.T) {
+	service := newService(".")
+	spec := argoappv1.ApplicationSpec{
+		Sources: []argoappv1.ApplicationSource{
+			{RepoURL: "https://helm.example.com", Chart: "my-chart", TargetRevision: ">= 1.0.0", Helm: &argoappv1.ApplicationSourceHelm{
+				ValueFiles: []string{"$ref/testdata/my-chart/my-chart-values.yaml"},
+			}},
+			{Ref: "ref", RepoURL: "https://git.example.com/test/repo"},
+		},
+	}
+	repoDB := &dbmocks.ArgoDB{}
+	repoDB.On("GetRepository", context.Background(), "https://git.example.com/test/repo").Return(&argoappv1.Repository{
+		Repo: "https://git.example.com/test/repo",
+	}, nil)
+	refSources, err := argo.GetRefSources(context.Background(), spec, repoDB)
+	require.NoError(t, err)
+	request := &apiclient.ManifestRequest{Repo: &argoappv1.Repository{}, ApplicationSource: &spec.Sources[0], NoCache: true, RefSources: refSources, HasMultipleSources: true}
+	response, err := service.GenerateManifest(context.Background(), request)
+	assert.NoError(t, err)
+	assert.NotNil(t, response)
+	assert.Equal(t, &apiclient.ManifestResponse{
+		Manifests:  []string{"{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"my-map\"}}"},
+		Namespace:  "",
+		Server:     "",
+		Revision:   "1.1.0",
+		SourceType: "Helm",
+	}, response)
+}
+
 func TestGenerateManifestsUseExactRevision(t *testing.T) {
 	service, gitClient := newServiceWithMocks(".", false)
 
@@ -2496,7 +2532,7 @@ func Test_findHelmValueFilesInPath(t *testing.T) {
 }
 
 func Test_populateHelmAppDetails(t *testing.T) {
-	var emptyTempPaths = io.NewTempPaths(t.TempDir())
+	var emptyTempPaths = io.NewRandomizedTempPaths(t.TempDir())
 	res := apiclient.RepoAppDetailsResponse{}
 	q := apiclient.RepoServerAppDetailsQuery{
 		Repo: &argoappv1.Repository{},
@@ -2513,7 +2549,7 @@ func Test_populateHelmAppDetails(t *testing.T) {
 }
 
 func Test_populateHelmAppDetails_values_symlinks(t *testing.T) {
-	var emptyTempPaths = io.NewTempPaths(t.TempDir())
+	var emptyTempPaths = io.NewRandomizedTempPaths(t.TempDir())
 	t.Run("inbound", func(t *testing.T) {
 		res := apiclient.RepoAppDetailsResponse{}
 		q := apiclient.RepoServerAppDetailsQuery{Repo: &argoappv1.Repository{}, Source: &argoappv1.ApplicationSource{}}
@@ -2550,7 +2586,7 @@ func TestOCIDependencies(t *testing.T) {
 
 func Test_getResolvedValueFiles(t *testing.T) {
 	tempDir := t.TempDir()
-	paths := io.NewTempPaths(tempDir)
+	paths := io.NewRandomizedTempPaths(tempDir)
 	paths.Add(git.NormalizeGitURL("https://github.com/org/repo1"), path.Join(tempDir, "repo1"))
 
 	testCases := []struct {
diff --git a/util/helm/client.go b/util/helm/client.go
@@ -65,7 +65,7 @@ func WithIndexCache(indexCache indexCache) ClientOpts {
 	}
 }
 
-func WithChartPaths(chartPaths *argoio.TempPaths) ClientOpts {
+func WithChartPaths(chartPaths argoio.TempPaths) ClientOpts {
 	return func(c *nativeHelmChart) {
 		c.chartCachePaths = chartPaths
 	}
@@ -82,7 +82,7 @@ func NewClientWithLock(repoURL string, creds Creds, repoLock sync.KeyLock, enabl
 		repoLock:        repoLock,
 		enableOci:       enableOci,
 		proxy:           proxy,
-		chartCachePaths: argoio.NewTempPaths(os.TempDir()),
+		chartCachePaths: argoio.NewRandomizedTempPaths(os.TempDir()),
 	}
 	for i := range opts {
 		opts[i](c)
@@ -93,7 +93,7 @@ func NewClientWithLock(repoURL string, creds Creds, repoLock sync.KeyLock, enabl
 var _ Client = &nativeHelmChart{}
 
 type nativeHelmChart struct {
-	chartCachePaths *argoio.TempPaths
+	chartCachePaths argoio.TempPaths
 	repoURL         string
 	creds           Creds
 	repoLock        sync.KeyLock
diff --git a/util/io/mocks/TempPaths.go b/util/io/mocks/TempPaths.go
diff --git a/util/io/paths.go b/util/io/paths.go
@@ -7,28 +7,34 @@ import (
 	"github.com/google/uuid"
 )
 
-// TempPaths allows generating and memoizing random paths, each path being mapped to a specific key.
-type TempPaths struct {
+type TempPaths interface {
+	Add(key string, value string)
+	GetPath(key string) (string, error)
+	GetPathIfExists(key string) string
+}
+
+// RandomizedTempPaths allows generating and memoizing random paths, each path being mapped to a specific key.
+type RandomizedTempPaths struct {
 	root  string
 	paths map[string]string
 	lock  sync.Mutex
 }
 
-func NewTempPaths(root string) *TempPaths {
-	return &TempPaths{
+func NewRandomizedTempPaths(root string) *RandomizedTempPaths {
+	return &RandomizedTempPaths{
 		root:  root,
 		paths: map[string]string{},
 	}
 }
 
-func (p *TempPaths) Add(key string, value string) {
+func (p *RandomizedTempPaths) Add(key string, value string) {
 	p.lock.Lock()
 	defer p.lock.Unlock()
 	p.paths[key] = value
 }
 
 // GetPath generates a path for the given key or returns previously generated one.
-func (p *TempPaths) GetPath(key string) (string, error) {
+func (p *RandomizedTempPaths) GetPath(key string) (string, error) {
 	p.lock.Lock()
 	defer p.lock.Unlock()
 	if val, ok := p.paths[key]; ok {
@@ -44,7 +50,7 @@ func (p *TempPaths) GetPath(key string) (string, error) {
 }
 
 // GetPathIfExists gets a path for the given key if it exists. Otherwise, returns an empty string.
-func (p *TempPaths) GetPathIfExists(key string) string {
+func (p *RandomizedTempPaths) GetPathIfExists(key string) string {
 	p.lock.Lock()
 	defer p.lock.Unlock()
 	if val, ok := p.paths[key]; ok {
diff --git a/util/io/paths_test.go b/util/io/paths_test.go
@@ -9,7 +9,7 @@ import (
 )
 
 func TestGetPath_SameURLs(t *testing.T) {
-	paths := NewTempPaths(os.TempDir())
+	paths := NewRandomizedTempPaths(os.TempDir())
 	res1, err := paths.GetPath("https://localhost/test.txt")
 	require.NoError(t, err)
 	res2, err := paths.GetPath("https://localhost/test.txt")
@@ -18,7 +18,7 @@ func TestGetPath_SameURLs(t *testing.T) {
 }
 
 func TestGetPath_DifferentURLs(t *testing.T) {
-	paths := NewTempPaths(os.TempDir())
+	paths := NewRandomizedTempPaths(os.TempDir())
 	res1, err := paths.GetPath("https://localhost/test1.txt")
 	require.NoError(t, err)
 	res2, err := paths.GetPath("https://localhost/test2.txt")
@@ -27,17 +27,17 @@ func TestGetPath_DifferentURLs(t *testing.T) {
 }
 
 func TestGetPath_SameURLsDifferentInstances(t *testing.T) {
-	paths1 := NewTempPaths(os.TempDir())
+	paths1 := NewRandomizedTempPaths(os.TempDir())
 	res1, err := paths1.GetPath("https://localhost/test.txt")
 	require.NoError(t, err)
-	paths2 := NewTempPaths(os.TempDir())
+	paths2 := NewRandomizedTempPaths(os.TempDir())
 	res2, err := paths2.GetPath("https://localhost/test.txt")
 	require.NoError(t, err)
 	assert.NotEqual(t, res1, res2)
 }
 
 func TestGetPathIfExists(t *testing.T) {
-	paths := NewTempPaths(os.TempDir())
+	paths := NewRandomizedTempPaths(os.TempDir())
 	t.Run("does not exist", func(t *testing.T) {
 		path := paths.GetPathIfExists("https://localhost/test.txt")
 		assert.Empty(t, path)

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ func WithIndexCache(indexCache indexCache) ClientOpts {`
`65`	`65`	`}`
`66`	`66`	`}`
`67`	`67`
`68`		`-func WithChartPaths(chartPaths *argoio.TempPaths) ClientOpts {`
	`68`	`+func WithChartPaths(chartPaths argoio.TempPaths) ClientOpts {`
`69`	`69`	`return func(c *nativeHelmChart) {`
`70`	`70`	`c.chartCachePaths = chartPaths`
`71`	`71`	`}`
`@@ -82,7 +82,7 @@ func NewClientWithLock(repoURL string, creds Creds, repoLock sync.KeyLock, enabl`
`82`	`82`	`repoLock: repoLock,`
`83`	`83`	`enableOci: enableOci,`
`84`	`84`	`proxy: proxy,`
`85`		`- chartCachePaths: argoio.NewTempPaths(os.TempDir()),`
	`85`	`+ chartCachePaths: argoio.NewRandomizedTempPaths(os.TempDir()),`
`86`	`86`	`}`
`87`	`87`	`for i := range opts {`
`88`	`88`	`opts[i](c)`
`@@ -93,7 +93,7 @@ func NewClientWithLock(repoURL string, creds Creds, repoLock sync.KeyLock, enabl`
`93`	`93`	`var _ Client = &nativeHelmChart{}`
`94`	`94`
`95`	`95`	`type nativeHelmChart struct {`
`96`		`- chartCachePaths *argoio.TempPaths`
	`96`	`+ chartCachePaths argoio.TempPaths`
`97`	`97`	`repoURL string`
`98`	`98`	`creds Creds`
`99`	`99`	`repoLock sync.KeyLock`