Non Watched Namespace Labeled selectors

Makefile

@@ -96,6 +96,9 @@ $(OUTPUT_DIR)/.clientset: $(GENERATED_PROTO_FILES) $(SOURCES)
 .PHONY: generated-code
 generated-code: $(OUTPUT_DIR)/.generated-code update-licenses
 
+.PHONY: generate-all
+generate-all: generated-code
+
 SUBDIRS:=pkg test
 $(OUTPUT_DIR)/.generated-code:
 	mkdir -p ${OUTPUT_DIR}

README.md

@@ -1,6 +1,10 @@
 # solo-kit
 A collection of code generation and libraries to for API development.
 
+### Testing
+To generate tests set `SkipGeneratedTests` to false in the `generate.go` file. This will use the test templates
+to generate the code for the tests. This will allow generation of templates such as `pkg/code-generator/codegen/templates/snapshot_emitter_test_template.go`
+
 ### Description:
 - Define your declarative API in `.proto` files
 - APIs are defined by top-level protobuf messages in `.proto` files

changelog/v0.37.0/namespace-selectors.yaml

@@ -0,0 +1,10 @@
+changelog:
+  - type: BREAKING_CHANGE
+    issueLink: https://github.com/solo-io/gloo/issues/5868 
+    resolvesIssue: false
+    description: |
+      Added the ability to watch namespaces given by Expression Selectors in the Watch Opts.
+      Watched Namespaces work as normally. When Expression Selectors are set the snapshot
+      emitter will watch, in addition to the watched namespaces, namespaces that
+      are labeled and meet the criteria of the Expression Selector. All resource 
+      clients will watch these namespaces, if set, via the snapshot emitters.

pkg/api/external/kubernetes/customresourcedefinition/resource_client.go

@@ -67,6 +67,10 @@ func ToKubeCustomResourceDefinition(resource resources.Resource) (*v1.CustomReso
 
 var _ clients.ResourceClient = &customResourceDefinitionResourceClient{}
 
+func (rc *customResourceDefinitionResourceClient) RegisterNamespace(namespace string) error {
+	return nil
+}
+
 func (rc *customResourceDefinitionResourceClient) Read(namespace, name string, opts clients.ReadOpts) (resources.Resource, error) {
 	if err := resources.ValidateName(name); err != nil {
 		return nil, errors.Wrapf(err, "validation error")

pkg/api/external/kubernetes/deployment/resource_client.go

@@ -66,6 +66,10 @@ func ToKubeDeployment(resource resources.Resource) (*appsv1.Deployment, error) {
 
 var _ clients.ResourceClient = &deploymentResourceClient{}
 
+func (rc *deploymentResourceClient) RegisterNamespace(namespace string) error {
+	return nil
+}
+
 func (rc *deploymentResourceClient) Read(namespace, name string, opts clients.ReadOpts) (resources.Resource, error) {
 	if err := resources.ValidateName(name); err != nil {
 		return nil, errors.Wrapf(err, "validation error")

pkg/api/external/kubernetes/job/resource_client.go

@@ -66,6 +66,10 @@ func ToKubeJob(resource resources.Resource) (*batchv1.Job, error) {
 
 var _ clients.ResourceClient = &jobResourceClient{}
 
+func (rc *jobResourceClient) RegisterNamespace(namespace string) error {
+	return nil
+}
+
 func (rc *jobResourceClient) Read(namespace, name string, opts clients.ReadOpts) (resources.Resource, error) {
 	if err := resources.ValidateName(name); err != nil {
 		return nil, errors.Wrapf(err, "validation error")

pkg/api/external/kubernetes/namespace/resource_client.go

@@ -17,7 +17,6 @@ import (
 	kubev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/kubernetes"
 )
@@ -65,6 +64,10 @@ func ToKubeNamespace(resource resources.Resource) (*kubev1.Namespace, error) {
 	return &namespace, nil
 }
 
+func (rc *namespaceResourceClient) RegisterNamespace(namespace string) error {
+	return rc.cache.RegisterNewNamespaceCache(namespace)
+}
+
 func (rc *namespaceResourceClient) Read(namespace, name string, opts clients.ReadOpts) (resources.Resource, error) {
 	if err := resources.ValidateName(name); err != nil {
 		return nil, eris.Wrapf(err, "validation error")
@@ -173,7 +176,11 @@ func (rc *namespaceResourceClient) List(namespace string, opts clients.ListOpts)
 		return nil, eris.New("to list namespaces you must watch all namespaces")
 	}
 
-	namespaceObjList, err := rc.cache.NamespaceLister().List(labels.SelectorFromSet(opts.Selector))
+	listOptions, err := clients.GetLabelSelector(opts)
+	if err != nil {
+		return nil, err
+	}
+	namespaceObjList, err := rc.cache.NamespaceLister().List(listOptions)
 	if err != nil {
 		return nil, eris.Wrapf(err, "listing namespaces level")
 	}

pkg/api/external/kubernetes/namespace/resource_namespace.go

@@ -0,0 +1,185 @@
+package namespace
+
+import (
+	"bytes"
+
+	"github.com/pkg/errors"
+	"github.com/solo-io/solo-kit/pkg/api/v1/clients"
+	"github.com/solo-io/solo-kit/pkg/api/v1/clients/kube/cache"
+	"github.com/solo-io/solo-kit/pkg/api/v1/resources"
+	skkube "github.com/solo-io/solo-kit/pkg/api/v1/resources/common/kubernetes"
+	kubev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	kubewatch "k8s.io/apimachinery/pkg/watch"
+	"k8s.io/client-go/kubernetes"
+)
+
+var _ resources.ResourceNamespaceLister = &kubeResourceNamespaceLister{}
+var _ resources.ResourceNamespaceLister = &kubeClientResourceNamespaceLister{}
+
+// NewKubeClientCacheResourceNamespaceLister will create a new resource namespace lister that requires the kubernestes
+// client and cache.
+func NewKubeClientCacheResourceNamespaceLister(kube kubernetes.Interface, cache cache.KubeCoreCache) resources.ResourceNamespaceLister {
+	return &kubeResourceNamespaceLister{
+		client: NewNamespaceClient(kube, cache),
+	}
+}
+
+// NewKubeClientResourceNamespaceLister will create a new resource namespace lister that requires the kubernetes client
+// interface.
+func NewKubeClientResourceNamespaceLister(kube kubernetes.Interface) resources.ResourceNamespaceLister {
+	return &kubeClientResourceNamespaceLister{
+		kube: kube,
+	}
+}
+
+type kubeResourceNamespaceLister struct {
+	client skkube.KubeNamespaceClient
+}
+
+// GetResourceNamespaceList is the kubernetes implementation that returns the list of namespaces
+func (kns *kubeResourceNamespaceLister) GetResourceNamespaceList(opts resources.ResourceNamespaceListOptions, filtered resources.ResourceNamespaceList) (resources.ResourceNamespaceList, error) {
+	namespaces, err := kns.client.List(clients.TranslateResourceNamespaceListToListOptions(opts))
+	if err != nil {
+		return nil, err
+	}
+	converted := convertNamespaceListToResourceNamespace(namespaces)
+	return kns.filter(converted, filtered), nil
+}
+
+// GetResourceNamespaceWatch returns a watch for events that occur on kube namespaces returning a list of all the namespaces
+func (kns *kubeResourceNamespaceLister) GetResourceNamespaceWatch(opts resources.ResourceNamespaceWatchOptions, filtered resources.ResourceNamespaceList) (chan resources.ResourceNamespaceList, <-chan error, error) {
+	ctx := opts.Ctx
+	wopts := clients.TranslateResourceNamespaceListToWatchOptions(opts)
+	namespaceChan, errorChan, err := kns.client.Watch(wopts)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	resourceNamespaceChan := make(chan resources.ResourceNamespaceList)
+	go func() {
+		defer close(resourceNamespaceChan)
+		for {
+			select {
+			case namespaceList := <-namespaceChan:
+				select {
+				case resourceNamespaceChan <- kns.filter(convertNamespaceListToResourceNamespace(namespaceList), filtered):
+				case <-ctx.Done():
+					return
+				}
+			case <-ctx.Done():
+				return
+			}
+		}
+	}()
+	return resourceNamespaceChan, errorChan, nil
+}
+
+func (kns *kubeResourceNamespaceLister) filter(namespaces resources.ResourceNamespaceList, filter resources.ResourceNamespaceList) resources.ResourceNamespaceList {
+	filteredList := resources.ResourceNamespaceList{}
+	for _, ns := range namespaces {
+		add := true
+		for _, wns := range filter {
+			if ns.Name == wns.Name {
+				add = false
+				break
+			}
+		}
+		if add {
+			filteredList = append(filteredList, ns)
+		}
+	}
+	return filteredList
+}
+
+func convertNamespaceListToResourceNamespace(namespaces skkube.KubeNamespaceList) resources.ResourceNamespaceList {
+	l := make(resources.ResourceNamespaceList, len(namespaces))
+	for i, ns := range namespaces {
+		l[i] = resources.ResourceNamespace{Name: ns.ObjectMeta.Name}
+	}
+	return l
+}
+
+type kubeClientResourceNamespaceLister struct {
+	kube kubernetes.Interface
+}
+
+// GetResourceNamespaceList is the kubernetes implementation that returns the list of namespaces
+func (client *kubeClientResourceNamespaceLister) GetResourceNamespaceList(opts resources.ResourceNamespaceListOptions, filtered resources.ResourceNamespaceList) (resources.ResourceNamespaceList, error) {
+	excludeNamespaces := client.getExcludeFieldSelector(filtered)
+	namespaceList, err := client.kube.CoreV1().Namespaces().List(opts.Ctx, metav1.ListOptions{FieldSelector: excludeNamespaces, LabelSelector: opts.ExpressionSelector})
+	if err != nil {
+		return nil, err
+	}
+	return convertNamespaceListToResourceNamespaceList(namespaceList), nil
+}
+
+// GetResourceNamespaceWatch returns a watch for events that occur on kube namespaces returning a list of all the namespaces
+func (client *kubeClientResourceNamespaceLister) GetResourceNamespaceWatch(opts resources.ResourceNamespaceWatchOptions, filtered resources.ResourceNamespaceList) (chan resources.ResourceNamespaceList, <-chan error, error) {
+	excludeNamespaces := client.getExcludeFieldSelector(filtered)
+	namespaceWatcher, err := client.kube.CoreV1().Namespaces().Watch(opts.Ctx, metav1.ListOptions{FieldSelector: excludeNamespaces, LabelSelector: opts.ExpressionSelector})
+	if err != nil {
+		return nil, nil, err
+	}
+	namespaceChan := namespaceWatcher.ResultChan()
+	resourceNamespaceChan := make(chan resources.ResourceNamespaceList)
+	errorChannel := make(chan error)
+	go func() {
+		defer func() {
+			close(resourceNamespaceChan)
+			close(errorChannel)
+		}()
+		for {
+			select {
+			case <-opts.Ctx.Done():
+				return
+			case event, ok := <-namespaceChan:
+				if !ok {
+					return
+				}
+				switch event.Type {
+				case kubewatch.Error:
+					errorChannel <- errors.Errorf("error with the event from watching namespaces: %v", event)
+					return
+				default:
+					resourceNamespaceList, err := client.GetResourceNamespaceList(resources.ResourceNamespaceListOptions{
+						Ctx:                opts.Ctx,
+						ExpressionSelector: opts.ExpressionSelector,
+					}, filtered)
+					if err != nil {
+						errorChannel <- errors.Wrap(err, "error getting the list of resource namespaces while watching")
+						return
+					}
+					resourceNamespaceChan <- resourceNamespaceList
+				}
+			}
+		}
+	}()
+	return resourceNamespaceChan, errorChannel, nil
+}
+
+func (client *kubeClientResourceNamespaceLister) getExcludeFieldSelector(filtered resources.ResourceNamespaceList) string {
+	// you can filter the namespaces by using metadata.name for more information on field selectors
+	// https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/
+	var buffer bytes.Buffer
+	for i, rns := range filtered {
+		ns := rns.Name
+		if ns != "" {
+			buffer.WriteString("metadata.name!=")
+			buffer.WriteString(ns)
+			if i < len(filtered)-1 {
+				buffer.WriteByte(',')
+			}
+		}
+	}
+	return buffer.String()
+}
+
+func convertNamespaceListToResourceNamespaceList(namespaceList *kubev1.NamespaceList) resources.ResourceNamespaceList {
+	resourceNamespaces := make(resources.ResourceNamespaceList, len(namespaceList.Items))
+	for i, item := range namespaceList.Items {
+		ns := item.Name
+		resourceNamespaces[i] = resources.ResourceNamespace{Name: ns}
+	}
+	return resourceNamespaces
+}

pkg/api/external/kubernetes/pod/resource_client.go

@@ -66,6 +66,10 @@ func ToKubePod(resource resources.Resource) (*kubev1.Pod, error) {
 
 var _ clients.ResourceClient = &podResourceClient{}
 
+func (rc *podResourceClient) RegisterNamespace(namespace string) error {
+	return rc.cache.RegisterNewNamespaceCache(namespace)
+}
+
 func (rc *podResourceClient) Read(namespace, name string, opts clients.ReadOpts) (resources.Resource, error) {
 	if err := resources.ValidateName(name); err != nil {
 		return nil, errors.Wrapf(err, "validation error")

pkg/api/external/kubernetes/service/resource_client.go

@@ -66,6 +66,10 @@ func ToKubeService(resource resources.Resource) (*kubev1.Service, error) {
 
 var _ clients.ResourceClient = &serviceResourceClient{}
 
+func (rc *serviceResourceClient) RegisterNamespace(namespace string) error {
+	return rc.cache.RegisterNewNamespaceCache(namespace)
+}
+
 func (rc *serviceResourceClient) Read(namespace, name string, opts clients.ReadOpts) (resources.Resource, error) {
 	if err := resources.ValidateName(name); err != nil {
 		return nil, errors.Wrapf(err, "validation error")

pkg/api/v1/clients/apiclient/resource_client.go

@@ -47,6 +47,10 @@ func (rc *ResourceClient) Register() error {
 	return nil
 }
 
+func (rc *ResourceClient) RegisterNamespace(namespace string) error {
+	return nil
+}
+
 func (rc *ResourceClient) Read(namespace, name string, opts clients.ReadOpts) (resources.Resource, error) {
 	if err := resources.ValidateName(name); err != nil {
 		return nil, errors.Wrapf(err, "validation error")

pkg/api/v1/clients/client_interface.go

@@ -32,6 +32,7 @@ type ResourceClient interface {
 	NewResource() resources.Resource
 	// Deprecated: implemented only by the kubernetes resource client. Will be removed from the interface.
 	Register() error
+	RegisterNamespace(namespace string) error
 	Read(namespace, name string, opts ReadOpts) (resources.Resource, error)
 	Write(resource resources.Resource, opts WriteOpts) (resources.Resource, error)
 	Delete(namespace, name string, opts DeleteOpts) error

pkg/api/v1/clients/common/common.go

@@ -37,10 +37,8 @@ func KubeResourceWatch(cache cache.Cache, listFunc ResourceListFunc, namespace s
 	// prevent flooding the channel with duplicates
 	var previous *resources.ResourceList
 	updateResourceList := func() {
-		list, err := listFunc(namespace, clients.ListOpts{
-			Ctx:      opts.Ctx,
-			Selector: opts.Selector,
-		})
+		lopts := clients.TranslateWatchOptsIntoListOpts(opts)
+		list, err := listFunc(namespace, lopts)
 		if err != nil {
 			errs <- err
 			return

pkg/api/v1/clients/configmap/resource_client.go

@@ -54,6 +54,10 @@ func NewResourceClientWithConverter(kube kubernetes.Interface, resourceType reso
 
 var _ clients.ResourceClient = &ResourceClient{}
 
+func (rc *ResourceClient) RegisterNamespace(namespace string) error {
+	return rc.cache.RegisterNewNamespaceCache(namespace)
+}
+
 func (rc *ResourceClient) Read(namespace, name string, opts clients.ReadOpts) (resources.Resource, error) {
 	if err := resources.ValidateName(name); err != nil {
 		return nil, errors.Wrapf(err, "validation error")

pkg/api/v1/clients/consul/resource_client.go

@@ -51,6 +51,10 @@ func (rc *ResourceClient) Register() error {
 	return nil
 }
 
+func (rc *ResourceClient) RegisterNamespace(ns string) error {
+	return nil
+}
+
 func (rc *ResourceClient) Read(namespace, name string, opts clients.ReadOpts) (resources.Resource, error) {
 	if err := resources.ValidateName(name); err != nil {
 		return nil, errors.Wrapf(err, "validation error")

pkg/api/v1/clients/file/resource_client.go

@@ -53,6 +53,10 @@ func (rc *ResourceClient) Register() error {
 	return nil
 }
 
+func (rc *ResourceClient) RegisterNamespace(namespace string) error {
+	return nil
+}
+
 func (rc *ResourceClient) Read(namespace, name string, opts clients.ReadOpts) (resources.Resource, error) {
 	if err := resources.ValidateName(name); err != nil {
 		return nil, errors.Wrapf(err, "validation error")