Introduce ResId and ResMap.

2026-06-13 01:50:55 +00:00 · 2018-05-31 23:22:46 -07:00
parent 9a5c0f5a25
commit ef71cb478f
39 changed files with 1063 additions and 1447 deletions
--- a/pkg/app/application.go
+++ b/pkg/app/application.go
@@ -25,6 +25,7 @@ import (
 	"github.com/kubernetes-sigs/kustomize/pkg/constants"
 	interror "github.com/kubernetes-sigs/kustomize/pkg/internal/error"
 	"github.com/kubernetes-sigs/kustomize/pkg/loader"
+	"github.com/kubernetes-sigs/kustomize/pkg/resmap"
 	"github.com/kubernetes-sigs/kustomize/pkg/resource"
 	"github.com/kubernetes-sigs/kustomize/pkg/transformers"
 	"github.com/kubernetes-sigs/kustomize/pkg/types"
@@ -32,14 +33,14 @@ import (

 type Application interface {
 	// Resources computes and returns the resources for the app.
-	Resources() (resource.ResourceCollection, error)
+	Resources() (resmap.ResMap, error)
 	// SemiResources computes and returns the resources without name hash and name reference for the app
-	SemiResources() (resource.ResourceCollection, error)
+	SemiResources() (resmap.ResMap, error)
 	// RawResources computes and returns the raw resources from the kustomization file.
 	// It contains resources from
 	// 1) untransformed resources from current kustomization file
 	// 2) transformed resources from sub packages
-	RawResources() (resource.ResourceCollection, error)
+	RawResources() (resmap.ResMap, error)
 }

 var _ Application = &applicationImpl{}
@@ -68,7 +69,7 @@ func New(loader loader.Loader) (Application, error) {
 // Resources computes and returns the resources from the kustomization file.
 // The namehashing for configmap/secrets and resolving name reference is only done
 // in the most top overlay once at the end of getting resources.
-func (a *applicationImpl) Resources() (resource.ResourceCollection, error) {
+func (a *applicationImpl) Resources() (resmap.ResMap, error) {
 	res, err := a.SemiResources()
 	if err != nil {
 		return nil, err
@@ -85,32 +86,32 @@ func (a *applicationImpl) Resources() (resource.ResourceCollection, error) {
 }

 // SemiResources computes and returns the resources without name hash and name reference for the app
-func (a *applicationImpl) SemiResources() (resource.ResourceCollection, error) {
+func (a *applicationImpl) SemiResources() (resmap.ResMap, error) {
 	errs := &interror.KustomizationErrors{}
 	raw, err := a.rawResources()
 	if err != nil {
 		errs.Append(err)
 	}

-	cms, err := resource.NewFromConfigMaps(a.loader, a.kustomization.ConfigMapGenerator)
+	cms, err := resmap.NewResMapFromConfigMapArgs(a.loader, a.kustomization.ConfigMapGenerator)
 	if err != nil {
 		errs.Append(err)
 	}
-	secrets, err := resource.NewFromSecretGenerators(a.loader.Root(), a.kustomization.SecretGenerator)
+	secrets, err := resmap.NewResMapFromSecretArgs(a.loader.Root(), a.kustomization.SecretGenerator)
 	if err != nil {
 		errs.Append(err)
 	}
-	res, err := resource.Merge(cms, secrets)
+	res, err := resmap.Merge(cms, secrets)
 	if err != nil {
 		return nil, err
 	}

-	allRes, err := resource.MergeWithOverride(raw, res)
+	allRes, err := resmap.MergeWithOverride(raw, res)
 	if err != nil {
 		return nil, err
 	}

-	patches, err := resource.NewFromPatches(a.loader, a.kustomization.Patches)
+	patches, err := resmap.NewResourceSliceFromPatches(a.loader, a.kustomization.Patches)
 	if err != nil {
 		errs.Append(err)
 	}
@@ -134,7 +135,7 @@ func (a *applicationImpl) SemiResources() (resource.ResourceCollection, error) {
 // RawResources computes and returns the raw resources from the kustomization file.
 // The namehashing for configmap/secrets and resolving name reference is only done
 // in the most top overlay once at the end of getting resources.
-func (a *applicationImpl) RawResources() (resource.ResourceCollection, error) {
+func (a *applicationImpl) RawResources() (resmap.ResMap, error) {
 	res, err := a.rawResources()
 	if err != nil {
 		return nil, err
@@ -150,9 +151,9 @@ func (a *applicationImpl) RawResources() (resource.ResourceCollection, error) {
 	return res, nil
 }

-func (a *applicationImpl) rawResources() (resource.ResourceCollection, error) {
+func (a *applicationImpl) rawResources() (resmap.ResMap, error) {
 	subAppResources, errs := a.subAppResources()
-	resources, err := resource.NewFromResources(a.loader, a.kustomization.Resources)
+	resources, err := resmap.NewResMapFromFiles(a.loader, a.kustomization.Resources)
 	if err != nil {
 		errs.Append(err)
 	}
@@ -161,11 +162,11 @@ func (a *applicationImpl) rawResources() (resource.ResourceCollection, error) {
 		return nil, errs
 	}

-	return resource.Merge(resources, subAppResources)
+	return resmap.Merge(resources, subAppResources)
 }

-func (a *applicationImpl) subAppResources() (resource.ResourceCollection, *interror.KustomizationErrors) {
-	sliceOfSubAppResources := []resource.ResourceCollection{}
+func (a *applicationImpl) subAppResources() (resmap.ResMap, *interror.KustomizationErrors) {
+	sliceOfSubAppResources := []resmap.ResMap{}
 	errs := &interror.KustomizationErrors{}
 	for _, pkgPath := range a.kustomization.Bases {
 		subloader, err := a.loader.New(pkgPath)
@@ -186,7 +187,7 @@ func (a *applicationImpl) subAppResources() (resource.ResourceCollection, *inter
 		}
 		sliceOfSubAppResources = append(sliceOfSubAppResources, subAppResources)
 	}
-	allResources, err := resource.Merge(sliceOfSubAppResources...)
+	allResources, err := resmap.Merge(sliceOfSubAppResources...)
 	if err != nil {
 		errs.Append(err)
 	}
--- a/pkg/app/application_test.go
+++ b/pkg/app/application_test.go
@@ -18,15 +18,14 @@ package app

 import (
 	"encoding/base64"
-	"fmt"
 	"reflect"
 	"testing"

 	"github.com/kubernetes-sigs/kustomize/pkg/constants"
 	"github.com/kubernetes-sigs/kustomize/pkg/loader"
 	"github.com/kubernetes-sigs/kustomize/pkg/loader/loadertest"
+	"github.com/kubernetes-sigs/kustomize/pkg/resmap"
 	"github.com/kubernetes-sigs/kustomize/pkg/resource"
-	"github.com/kubernetes-sigs/kustomize/pkg/types"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -71,13 +70,14 @@ metadata:
 	return loader
 }

+var deploy = schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}
+var cmap = schema.GroupVersionKind{Version: "v1", Kind: "ConfigMap"}
+var secret = schema.GroupVersionKind{Version: "v1", Kind: "Secret"}
+
 func TestResources(t *testing.T) {
-	expected := resource.ResourceCollection{
-		types.GroupVersionKindName{
-			GVK:  schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"},
-			Name: "dply1",
-		}: &resource.Resource{
-			Data: &unstructured.Unstructured{
+	expected := resmap.ResMap{
+		resource.NewResId(deploy, "dply1"): resource.NewBehaviorlessResource(
+			&unstructured.Unstructured{
 				Object: map[string]interface{}{
 					"apiVersion": "apps/v1",
 					"kind":       "Deployment",
@@ -108,13 +108,9 @@ func TestResources(t *testing.T) {
 						},
 					},
 				},
-			},
-		},
-		types.GroupVersionKindName{
-			GVK:  schema.GroupVersionKind{Version: "v1", Kind: "ConfigMap"},
-			Name: "literalConfigMap",
-		}: &resource.Resource{
-			Data: &unstructured.Unstructured{
+			}),
+		resource.NewResId(cmap, "literalConfigMap"): resource.NewBehaviorlessResource(
+			&unstructured.Unstructured{
 				Object: map[string]interface{}{
 					"apiVersion": "v1",
 					"kind":       "ConfigMap",
@@ -133,13 +129,9 @@ func TestResources(t *testing.T) {
 						"DB_PASSWORD": "somepw",
 					},
 				},
-			},
-		},
-		types.GroupVersionKindName{
-			GVK:  schema.GroupVersionKind{Version: "v1", Kind: "Secret"},
-			Name: "secret",
-		}: &resource.Resource{
-			Data: &unstructured.Unstructured{
+			}),
+		resource.NewResId(secret, "secret"): resource.NewBehaviorlessResource(
+			&unstructured.Unstructured{
 				Object: map[string]interface{}{
 					"apiVersion": "v1",
 					"kind":       "Secret",
@@ -159,8 +151,7 @@ func TestResources(t *testing.T) {
 						"DB_PASSWORD": base64.StdEncoding.EncodeToString([]byte("somepw")),
 					},
 				},
-			},
-		},
+			}),
 	}
 	l := setupTest(t)
 	app, err := New(l)
@@ -173,18 +164,15 @@ func TestResources(t *testing.T) {
 	}

 	if !reflect.DeepEqual(actual, expected) {
-		err = compareMap(actual, expected)
+		err = expected.ErrorIfNotEqual(actual)
 		t.Fatalf("unexpected error: %v", err)
 	}
 }

 func TestRawResources(t *testing.T) {
-	expected := resource.ResourceCollection{
-		types.GroupVersionKindName{
-			GVK:  schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"},
-			Name: "dply1",
-		}: &resource.Resource{
-			Data: &unstructured.Unstructured{
+	expected := resmap.ResMap{
+		resource.NewResId(deploy, "dply1"): resource.NewBehaviorlessResource(
+			&unstructured.Unstructured{
 				Object: map[string]interface{}{
 					"apiVersion": "apps/v1",
 					"kind":       "Deployment",
@@ -192,8 +180,7 @@ func TestRawResources(t *testing.T) {
 						"name": "dply1",
 					},
 				},
-			},
-		},
+			}),
 	}
 	l := setupTest(t)
 	app, err := New(l)
@@ -205,31 +192,7 @@ func TestRawResources(t *testing.T) {
 		t.Fatalf("Unexpected error %v", err)
 	}

-	if err := compareMap(actual, expected); err != nil {
+	if err := expected.ErrorIfNotEqual(actual); err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}
 }
-
-func compareMap(m1, m2 resource.ResourceCollection) error {
-	if len(m1) != len(m2) {
-		keySet1 := []types.GroupVersionKindName{}
-		keySet2 := []types.GroupVersionKindName{}
-		for GVKn := range m1 {
-			keySet1 = append(keySet1, GVKn)
-		}
-		for GVKn := range m1 {
-			keySet2 = append(keySet2, GVKn)
-		}
-		return fmt.Errorf("maps has different number of entries: %#v doesn't equals %#v", keySet1, keySet2)
-	}
-	for GVKn, obj1 := range m1 {
-		obj2, found := m2[GVKn]
-		if !found {
-			return fmt.Errorf("%#v doesn't exist in %#v", GVKn, m2)
-		}
-		if !reflect.DeepEqual(obj1, obj2) {
-			return fmt.Errorf("%#v doesn't match %#v", obj1, obj2)
-		}
-	}
-	return nil
-}