Merge pull request crossplane#6205 from cychiang/6057-fix-duplicate-results-due-to-cache-issue

fix(cli): Resolve duplicate validate results due to multiple version of dependencies in cache

Author: jbw976

cmd/crank/beta/validate/cache.go

@@ -32,7 +32,7 @@ type Cache interface {
 	Store(schemas [][]byte, path string) error
 	Flush() error
 	Init() error
-	Load() ([]*unstructured.Unstructured, error)
+	Load(image string) ([]*unstructured.Unstructured, error)
 	Exists(image string) (string, error)
 }
 
@@ -86,26 +86,24 @@ func (c *LocalCache) Flush() error {
 	return c.fs.RemoveAll(c.cacheDir)
 }
 
-// Load loads the schemas from the cache directory.
-func (c *LocalCache) Load() ([]*unstructured.Unstructured, error) {
-	loader, err := NewLoader(c.cacheDir)
+// Load loads schemas from the cache directory.
+// image should be a validate image name with the format: <registry>/<image>:<tag>.
+func (c *LocalCache) Load(image string) ([]*unstructured.Unstructured, error) {
+	cacheImagePath := c.getCachePath(image)
+	loader, err := NewLoader(cacheImagePath)
 	if err != nil {
-		return nil, errors.Wrapf(err, "cannot create loader from the path %s", c.cacheDir)
+		return nil, errors.Wrapf(err, "cannot create loader from %s", cacheImagePath)
 	}
-
 	schemas, err := loader.Load()
 	if err != nil {
-		return nil, errors.Wrapf(err, "cannot load schemas from the path %s", c.cacheDir)
+		return nil, errors.Wrapf(err, "cannot load schemas from %s", cacheImagePath)
 	}
-
 	return schemas, nil
 }
 
 // Exists checks if the cache contains the image and returns the path if it doesn't exist.
 func (c *LocalCache) Exists(image string) (string, error) {
-	fName := strings.ReplaceAll(image, ":", "@")
-	path := filepath.Join(c.cacheDir, fName)
-
+	path := c.getCachePath(image)
 	_, err := os.Stat(path)
 	if err != nil && os.IsNotExist(err) {
 		return path, nil
@@ -115,3 +113,9 @@ func (c *LocalCache) Exists(image string) (string, error) {
 
 	return "", nil
 }
+
+// getCachePath transforms an image name to a validate folder path that store schemas.
+func (c *LocalCache) getCachePath(image string) string {
+	cacheImagePath := strings.ReplaceAll(image, ":", "@")
+	return filepath.Join(c.cacheDir, cacheImagePath)
+}

cmd/crank/beta/validate/cache_test.go

@@ -149,6 +149,7 @@ func TestLocalCacheInit(t *testing.T) {
 func TestLocalCacheLoad(t *testing.T) {
 	type args struct {
 		cacheDir string
+		image    string
 	}
 	type want struct {
 		schemas []*unstructured.Unstructured
@@ -161,7 +162,10 @@ func TestLocalCacheLoad(t *testing.T) {
 	}{
 		"Load": {
 			reason: "Load should load the schemas from the cache",
-			args:   args{cacheDir: "./testdata/crds"},
+			args: args{
+				cacheDir: "./testdata/crds",
+				image:    "xpkg.upbound.io/provider-dummy:v1.0.0",
+			},
 			want: want{
 				schemas: []*unstructured.Unstructured{
 					{
@@ -193,7 +197,7 @@ func TestLocalCacheLoad(t *testing.T) {
 				cacheDir: tc.args.cacheDir,
 			}
 
-			got, err := c.Load()
+			got, err := c.Load(tc.args.image)
 			if diff := cmp.Diff(tc.want.schemas, got); diff != "" {
 				t.Errorf("%s\nLoad(...): -want, +got:\n%s", tc.reason, diff)
 			}

cmd/crank/beta/validate/manager.go

@@ -199,7 +199,7 @@ func (m *Manager) CacheAndLoad(cleanCache bool) error {
 		return errors.Wrapf(err, "cannot cache package dependencies")
 	}
 
-	schemas, err := m.cache.Load()
+	schemas, err := m.loadDependencies()
 	if err != nil {
 		return errors.Wrapf(err, "cannot load cache")
 	}
@@ -312,3 +312,15 @@ func (m *Manager) cacheDependencies() error {
 
 	return nil
 }
+
+func (m *Manager) loadDependencies() ([]*unstructured.Unstructured, error) {
+	schemas := make([]*unstructured.Unstructured, 0)
+	for dep := range m.deps {
+		cachedSchema, err := m.cache.Load(dep)
+		if err != nil {
+			return nil, errors.Wrapf(err, "cannot load cache for %s", dep)
+		}
+		schemas = append(schemas, cachedSchema...)
+	}
+	return schemas, nil
+}