Allow resources in multiple namespaces

Author: mortent

pkg/apply/applier.go

@@ -5,12 +5,13 @@ package apply
 
 import (
 	"context"
-	"fmt"
 	"sort"
 	"time"
 
 	"github.com/go-errors/errors"
 	"github.com/spf13/cobra"
+	v1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/cli-runtime/pkg/genericclioptions"
 	"k8s.io/cli-runtime/pkg/resource"
@@ -167,6 +168,13 @@ func (a *Applier) prepareObjects(infos []*resource.Info) (*ResourceObjects, erro
 	if err != nil {
 		return nil, err
 	}
+
+	// Verify that the set of resources does not include the namespace
+	// in which we will place the inventory.
+	if err := validateNamespace(localInv, localInfos); err != nil {
+		return nil, err
+	}
+
 	currentObjs, err := object.InfosToObjMetas(localInfos)
 	if err != nil {
 		return nil, err
@@ -180,11 +188,7 @@ func (a *Applier) prepareObjects(infos []*resource.Info) (*ResourceObjects, erro
 	}
 	// Sort order for applied resources.
 	sort.Sort(ordering.SortableInfos(localInfos))
-	// TODO(seans3): Remove this single namespace requirement once we've
-	// implemented multi-namespace apply.
-	if !validateNamespace(localInfos) {
-		return nil, fmt.Errorf("objects have differing namespaces")
-	}
+
 	return &ResourceObjects{
 		LocalInv:  localInv,
 		Resources: localInfos,
@@ -367,22 +371,23 @@ func handleError(eventChannel chan event.Event, err error) {
 	}
 }
 
+var coreV1Namespace = v1.SchemeGroupVersion.WithKind("Namespace")
+
 // validateNamespace returns true if all the objects in the passed
 // infos parameter have the same namespace; false otherwise. Ignores
 // cluster-scoped resources.
-func validateNamespace(infos []*resource.Info) bool {
-	currentNamespace := metav1.NamespaceNone
+func validateNamespace(inv *resource.Info, infos []*resource.Info) error {
+	invAcc, _ := meta.Accessor(inv.Object)
+	invNamespace := invAcc.GetNamespace()
+
 	for _, info := range infos {
-		// Ignore cluster-scoped resources.
-		if info.Namespaced() {
-			// If the current namespace has not been set--then set it.
-			if currentNamespace == metav1.NamespaceNone {
-				currentNamespace = info.Namespace
-			}
-			if currentNamespace != info.Namespace {
-				return false
+		acc, _ := meta.Accessor(info.Object)
+		gvk := info.Object.GetObjectKind().GroupVersionKind()
+		if gvk == coreV1Namespace && acc.GetName() == invNamespace {
+			return &inventory.InventoryNamespaceInSet{
+				Namespace: invNamespace,
 			}
 		}
 	}
-	return true
+	return nil
 }

pkg/apply/applier_test.go

@@ -356,24 +356,6 @@ var obj3Info = &resource.Info{
 	},
 }
 
-var defaultObjInfo = &resource.Info{
-	Namespace: metav1.NamespaceDefault,
-	Name:      "default-obj",
-	Mapping: &meta.RESTMapping{
-		Scope: meta.RESTScopeNamespace,
-	},
-	Object: &unstructured.Unstructured{
-		Object: map[string]interface{}{
-			"apiVersion": "v1",
-			"kind":       "Pod",
-			"metadata": map[string]interface{}{
-				"name":      "default-obj",
-				"namespace": metav1.NamespaceDefault,
-			},
-		},
-	},
-}
-
 var clusterScopedObjInfo = &resource.Info{
 	Name: "cluster-scoped-1",
 	Mapping: &meta.RESTMapping{
@@ -390,75 +372,55 @@ var clusterScopedObjInfo = &resource.Info{
 	},
 }
 
-var clusterScopedObj2Info = &resource.Info{
-	Name: "cluster-scoped-2",
-	Mapping: &meta.RESTMapping{
-		Scope: meta.RESTScopeRoot,
-	},
-	Object: &unstructured.Unstructured{
-		Object: map[string]interface{}{
-			"apiVersion": "rbac.authorization.k8s.io/v1",
-			"kind":       "ClusterRoleBinding",
-			"metadata": map[string]interface{}{
-				"name": "cluster-scoped-2",
+func createNamespaceInfo(ns string) *resource.Info {
+	return &resource.Info{
+		Name: ns,
+		Object: &unstructured.Unstructured{
+			Object: map[string]interface{}{
+				"apiVersion": "v1",
+				"kind":       "Namespace",
+				"metadata": map[string]interface{}{
+					"name": ns,
+				},
 			},
 		},
-	},
+	}
 }
 
 func TestValidateNamespace(t *testing.T) {
 	tests := map[string]struct {
 		objects []*resource.Info
-		isValid bool
+		err     error
 	}{
 		"No resources is valid": {
 			objects: []*resource.Info{},
-			isValid: true,
+			err:     nil,
 		},
-		"One resource is valid": {
-			objects: []*resource.Info{obj1Info},
-			isValid: true,
-		},
-		"Two resources with same namespace is valid": {
+		"Resources other than namespace is valid": {
 			objects: []*resource.Info{obj1Info, obj2Info},
-			isValid: true,
-		},
-		"Two resources with same namespace and cluster-scoped obj is valid": {
-			objects: []*resource.Info{obj1Info, clusterScopedObjInfo, obj2Info},
-			isValid: true,
+			err:     nil,
 		},
-		"Single cluster-scoped obj is valid": {
-			objects: []*resource.Info{clusterScopedObjInfo},
-			isValid: true,
+		"Different namespace resource is valid": {
+			objects: []*resource.Info{createNamespaceInfo("foo")},
+			err:     nil,
 		},
-		"Multiple cluster-scoped objs is valid": {
-			objects: []*resource.Info{clusterScopedObjInfo, clusterScopedObj2Info},
-			isValid: true,
-		},
-		"Two resources with differing namespaces is not valid": {
-			objects: []*resource.Info{obj1Info, obj3Info},
-			isValid: false,
-		},
-		"Two resources with differing namespaces and cluster-scoped obj is not valid": {
-			objects: []*resource.Info{clusterScopedObjInfo, obj1Info, obj3Info},
-			isValid: false,
-		},
-		"Three resources, one with differing namespace is not valid": {
-			objects: []*resource.Info{obj1Info, obj2Info, obj3Info},
-			isValid: false,
-		},
-		"Default namespace not equal to other namespaces": {
-			objects: []*resource.Info{obj3Info, defaultObjInfo},
-			isValid: false,
+		"Same namespace resource is not valid": {
+			objects: []*resource.Info{obj1Info, createNamespaceInfo(namespace)},
+			err: inventory.InventoryNamespaceInSet{
+				Namespace: namespace,
+			},
 		},
 	}
 
 	for name, tc := range tests {
 		t.Run(name, func(t *testing.T) {
-			actualValid := validateNamespace(tc.objects)
-			if tc.isValid != actualValid {
-				t.Errorf("Expected valid namespace (%t), got (%t)", tc.isValid, actualValid)
+			err := validateNamespace(inventoryObjInfo, tc.objects)
+
+			if tc.err != nil {
+				assert.IsType(t, &inventory.InventoryNamespaceInSet{}, err)
+				return
 			}
+			assert.NoError(t, err)
 		})
 	}
 }
@@ -523,9 +485,9 @@ func TestReadAndPrepareObjects(t *testing.T) {
 			pruneIds:    []*resource.Info{},
 			isError:     false,
 		},
-		"objects can not be in different namespaces": {
+		"namespace resource for the namespace used in inventory is not allowed": {
 			resources: []*resource.Info{obj1Info, obj2Info,
-				inventoryObjInfo, obj3Info},
+				inventoryObjInfo, obj3Info, createNamespaceInfo(namespace)},
 			isError: true,
 		},
 	}

pkg/inventory/inventory_error.go

@@ -20,6 +20,11 @@ const multipleInventoryErrorStr = `Package has multiple inventory object templat
 The package should have one and only one inventory object template.
 `
 
+const inventoryNamespaceInSet = `Inventory use namespace defined in package.
+
+The inventory cannot use a namespace that is defined in the package.
+`
+
 type NoInventoryObjError struct{}
 
 func (g NoInventoryObjError) Error() string {
@@ -33,3 +38,11 @@ type MultipleInventoryObjError struct {
 func (g MultipleInventoryObjError) Error() string {
 	return multipleInventoryErrorStr
 }
+
+type InventoryNamespaceInSet struct {
+	Namespace string
+}
+
+func (g InventoryNamespaceInSet) Error() string {
+	return inventoryNamespaceInSet
+}