Explorer extending - gitopssets (#3267)

* Add gitopsset kind to supported objects in explorer query

* add gitopssets to rbac rules

* Add gitopssets to ToFluxObject

* Add gitopssets to getKindRoute fn in ui

* Add gitopssets query server testcase to server integration tests

* Use allowGitOpsSetsAnyOnDefaultNamespace for gitopsset support query server test

* Add gitopssets crd to query suite test

* changed category gitopsset (#3290)

---------

Co-authored-by: Eneko Fernández <[email protected]>

Author: 2 people

charts/mccp/templates/clusters-service/collector.yaml

@@ -26,6 +26,9 @@ rules:
   - apiGroups: [""]
     resources: ["events"]
     verbs: ["get", "list", "watch"]
+  - apiGroups: ["templates.weave.works"]
+    resources: ["gitopssets"]
+    verbs: ["get", "list", "watch"]
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding

pkg/query/configuration/objectkind.go

@@ -10,6 +10,7 @@ import (
 	helmv2beta1 "github.com/fluxcd/helm-controller/api/v2beta1"
 	kustomizev1 "github.com/fluxcd/kustomize-controller/api/v1"
 	sourcev1beta2 "github.com/fluxcd/source-controller/api/v1beta2"
+	gitopssets "github.com/weaveworks/gitopssets-controller/api/v1alpha1"
 	rbacv1 "k8s.io/api/rbac/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -27,6 +28,7 @@ const (
 	CategoryAutomation ObjectCategory = "automation"
 	CategorySource     ObjectCategory = "source"
 	CategoryEvent      ObjectCategory = "event"
+	CategoryGitopsSet  ObjectCategory = "gitopsset"
 )
 
 type ObjectKind struct {
@@ -220,6 +222,17 @@ var (
 		},
 		Category: CategoryEvent,
 	}
+
+	GitOpsSetsObjectKind = ObjectKind{
+		Gvk: gitopssets.GroupVersion.WithKind("GitOpsSet"),
+		NewClientObjectFunc: func() client.Object {
+			return &gitopssets.GitOpsSet{}
+		},
+		AddToSchemeFunc: gitopssets.AddToScheme,
+		StatusFunc:      defaultFluxObjectStatusFunc,
+		MessageFunc:     defaultFluxObjectMessageFunc,
+		Category:        CategoryGitopsSet,
+	}
 )
 
 // SupportedObjectKinds list with the default supported Object resources to query.
@@ -232,6 +245,7 @@ var SupportedObjectKinds = []ObjectKind{
 	OCIRepositoryObjectKind,
 	BucketObjectKind,
 	PolicyAgentAuditEventObjectKind,
+	GitOpsSetsObjectKind,
 }
 
 // SupportedRbacKinds list with the default supported RBAC resources.
@@ -297,6 +311,8 @@ func ToFluxObject(obj client.Object) (FluxObject, error) {
 		return t, nil
 	case *sourcev1beta2.OCIRepository:
 		return t, nil
+	case *gitopssets.GitOpsSet:
+		return t, nil
 	case *corev1.Event:
 		e, ok := obj.(*corev1.Event)
 		if !ok {

pkg/query/server/server_integration_test.go

@@ -12,10 +12,13 @@ import (
 	helmv2 "github.com/fluxcd/helm-controller/api/v2beta1"
 	kustomizev1 "github.com/fluxcd/kustomize-controller/api/v1"
 	sourcev1 "github.com/fluxcd/source-controller/api/v1"
+	gitopssetstemplatesv1 "github.com/weaveworks/gitopssets-controller/api/v1alpha1"
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 
 	sourcev1beta2 "github.com/fluxcd/source-controller/api/v1beta2"
 	"github.com/go-logr/logr/testr"
 	. "github.com/onsi/gomega"
+	gitopssets "github.com/weaveworks/gitopssets-controller/api/v1alpha1"
 	api "github.com/weaveworks/weave-gitops-enterprise/pkg/api/query"
 	"github.com/weaveworks/weave-gitops/pkg/server/auth"
 	v1 "k8s.io/api/core/v1"
@@ -169,6 +172,36 @@ func TestQueryServer(t *testing.T) {
 			query:              fmt.Sprintf("kind:%s", sourcev1beta2.BucketKind),
 			expectedNumObjects: 1, // should allow only on default namespace,
 		},
+		{
+			name:   "should support gitopssets",
+			access: allowGitOpsSetsAnyOnDefaultNamespace(principal.ID),
+			objects: []client.Object{
+				&gitopssets.GitOpsSet{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "gitopsset-list",
+						Namespace: defaultNamespace,
+					},
+					TypeMeta: metav1.TypeMeta{
+						Kind:       "GitOpsSet",
+						APIVersion: gitopssets.GroupVersion.String(),
+					},
+					Spec: gitopssets.GitOpsSetSpec{
+						Generators: []gitopssetstemplatesv1.GitOpsSetGenerator{
+							{
+								List: &gitopssetstemplatesv1.ListGenerator{
+									Elements: []apiextensionsv1.JSON{
+										{Raw: []byte(`{"cluster": "engineering-dev"}`)},
+									},
+								},
+							},
+						},
+						Templates: []gitopssetstemplatesv1.GitOpsSetTemplate{},
+					},
+				},
+			},
+			query:              "kind:GitOpsSet",
+			expectedNumObjects: 1,
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
@@ -362,6 +395,29 @@ func allowSourcesAnyOnDefaultNamespace(username string) []client.Object {
 	)
 }
 
+func allowGitOpsSetsAnyOnDefaultNamespace(username string) []client.Object {
+	roleName := "gitopssets-admin"
+	roleBindingName := "wego-admin-gitopssets-release-admin"
+
+	return append(createCollectorSecurityContext(),
+		newRole(roleName, "default",
+			[]rbacv1.PolicyRule{{
+				APIGroups: []string{"*"},
+				Resources: []string{"*"},
+				Verbs:     []string{"*"},
+			}}),
+		newRoleBinding(roleBindingName,
+			"default",
+			"Role",
+			roleName,
+			[]rbacv1.Subject{
+				{
+					Kind: "User",
+					Name: username,
+				},
+			}))
+}
+
 func newRoleBinding(name, namespace, roleKind, roleName string, subjects []rbacv1.Subject) *rbacv1.RoleBinding {
 	return &rbacv1.RoleBinding{
 		TypeMeta: roleBindingTypeMeta,

pkg/query/server/suite_test.go

@@ -20,6 +20,7 @@ import (
 	sourcev1beta2 "github.com/fluxcd/source-controller/api/v1beta2"
 	"github.com/go-logr/logr"
 	clusterctrlv1alpha1 "github.com/weaveworks/cluster-controller/api/v1alpha1"
+	gitopssets "github.com/weaveworks/gitopssets-controller/api/v1alpha1"
 	pb "github.com/weaveworks/weave-gitops-enterprise/cmd/clusters-service/pkg/protos"
 	"github.com/weaveworks/weave-gitops-enterprise/cmd/clusters-service/pkg/server"
 	api "github.com/weaveworks/weave-gitops-enterprise/pkg/api/query"
@@ -93,6 +94,11 @@ func TestMain(m *testing.M) {
 	if err != nil {
 		log.Fatalf("add GitopsCluster to schema failed: %s", err)
 	}
+
+	err = gitopssets.AddToScheme(scheme.Scheme)
+	if err != nil {
+		log.Fatalf("add GitopsSet to schema failed: %s", err)
+	}
 	_, cancel := context.WithCancel(context.Background())
 
 	k8sClient, err = client.New(cfg, client.Options{