Filter service bindings by display name

`cf curl /v3/service_credential_bindings?names=b1,b3`, The names querry
params is now supported. This also allows to use `cf service-key` command

fixes #4149

Author: uzabanov

api/payloads/service_binding.go

@@ -71,6 +71,7 @@ func (r ServiceBindingRelationships) Validate() error {
 }
 
 type ServiceBindingList struct {
+	Names                string
 	Type                 string
 	AppGUIDs             string
 	ServiceInstanceGUIDs string
@@ -92,6 +93,7 @@ func (l ServiceBindingList) Validate() error {
 
 func (l *ServiceBindingList) ToMessage() repositories.ListServiceBindingsMessage {
 	return repositories.ListServiceBindingsMessage{
+		Names:                parse.ArrayParam(l.Names),
 		ServiceInstanceGUIDs: parse.ArrayParam(l.ServiceInstanceGUIDs),
 		AppGUIDs:             parse.ArrayParam(l.AppGUIDs),
 		LabelSelector:        l.LabelSelector,
@@ -103,11 +105,12 @@ func (l *ServiceBindingList) ToMessage() repositories.ListServiceBindingsMessage
 }
 
 func (l *ServiceBindingList) SupportedKeys() []string {
-	return []string{"app_guids", "service_instance_guids", "include", "type", "order_by", "per_page", "page", "label_selector", "service_plan_guids"}
+	return []string{"names", "app_guids", "service_instance_guids", "include", "type", "order_by", "per_page", "page", "label_selector", "service_plan_guids"}
 }
 
 func (l *ServiceBindingList) DecodeFromURLValues(values url.Values) error {
 	l.Type = values.Get("type")
+	l.Names = values.Get("names")
 	l.AppGUIDs = values.Get("app_guids")
 	l.ServiceInstanceGUIDs = values.Get("service_instance_guids")
 	l.Include = values.Get("include")

api/payloads/service_binding_test.go

@@ -23,6 +23,7 @@ var _ = Describe("ServiceBindingList", func() {
 		},
 		Entry("type", "type=key", payloads.ServiceBindingList{Type: korifiv1alpha1.CFServiceBindingTypeKey}),
 		Entry("type", "type=app", payloads.ServiceBindingList{Type: korifiv1alpha1.CFServiceBindingTypeApp}),
+		Entry("names", "names=name1,name2", payloads.ServiceBindingList{Names: "name1,name2"}),
 		Entry("app_guids", "app_guids=app_guid", payloads.ServiceBindingList{AppGUIDs: "app_guid"}),
 		Entry("service_instance_guids", "service_instance_guids=si_guid", payloads.ServiceBindingList{ServiceInstanceGUIDs: "si_guid"}),
 		Entry("include", "include=app", payloads.ServiceBindingList{Include: "app"}),
@@ -58,6 +59,7 @@ var _ = Describe("ServiceBindingList", func() {
 		BeforeEach(func() {
 			payload = payloads.ServiceBindingList{
 				Type:                 korifiv1alpha1.CFServiceBindingTypeApp,
+				Names:                "binding1,binding2",
 				AppGUIDs:             "app1,app2",
 				ServiceInstanceGUIDs: "s1,s2",
 				Include:              "include",
@@ -79,6 +81,7 @@ var _ = Describe("ServiceBindingList", func() {
 			Expect(message).To(Equal(repositories.ListServiceBindingsMessage{
 				Type:                 korifiv1alpha1.CFServiceBindingTypeApp,
 				AppGUIDs:             []string{"app1", "app2"},
+				Names:                []string{"binding1", "binding2"},
 				ServiceInstanceGUIDs: []string{"s1", "s2"},
 				LabelSelector:        "foo=bar",
 				PlanGUIDs:            []string{"p1", "p2"},

api/repositories/service_binding_repository.go

@@ -102,6 +102,7 @@ type DeleteServiceBindingMessage struct {
 }
 
 type ListServiceBindingsMessage struct {
+	Names                []string
 	AppGUIDs             []string
 	ServiceInstanceGUIDs []string
 	LabelSelector        string
@@ -114,6 +115,7 @@ type ListServiceBindingsMessage struct {
 func (m *ListServiceBindingsMessage) toListOptions() []ListOption {
 	opts := []ListOption{
 		WithLabelSelector(m.LabelSelector),
+		WithLabelIn(korifiv1alpha1.DisplayNameLabelKey, tools.EncodeValuesToSha224(m.Names...)),
 		WithLabelIn(korifiv1alpha1.CFServiceInstanceGUIDLabelKey, m.ServiceInstanceGUIDs),
 		WithLabelIn(korifiv1alpha1.CFAppGUIDLabelKey, m.AppGUIDs),
 		WithLabelIn(korifiv1alpha1.PlanGUIDLabelKey, m.PlanGUIDs),

api/repositories/service_binding_repository_test.go

@@ -999,6 +999,7 @@ var _ = Describe("ServiceBindingRepo", func() {
 				fakeKlient = new(fake.Klient)
 				repo = repositories.NewServiceBindingRepo(fakeKlient, nil, nil, nil)
 				requestMessage = repositories.ListServiceBindingsMessage{
+					Names:                []string{"b1", "b2"},
 					AppGUIDs:             []string{"a1", "a2"},
 					ServiceInstanceGUIDs: []string{"s1", "s2"},
 					LabelSelector:        "foo=bar",
@@ -1019,6 +1020,7 @@ var _ = Describe("ServiceBindingRepo", func() {
 					repositories.WithLabelSelector("foo=bar"),
 					repositories.WithLabelIn(korifiv1alpha1.PlanGUIDLabelKey, []string{"p1", "p2"}),
 					repositories.WithLabelIn(korifiv1alpha1.CFAppGUIDLabelKey, []string{"a1", "a2"}),
+					repositories.WithLabelIn(korifiv1alpha1.DisplayNameLabelKey, tools.EncodeValuesToSha224("b1", "b2")),
 					repositories.WithLabelIn(korifiv1alpha1.CFServiceInstanceGUIDLabelKey, []string{"s1", "s2"}),
 					repositories.WithOrdering("created_at"),
 					repositories.WithPaging(repositories.Pagination{

controllers/webhooks/label_indexer/webhook.go

@@ -82,6 +82,7 @@ func NewWebhook() *LabelIndexerWebhook {
 			},
 			"CFServiceBinding": {
 				LabelRule{Label: korifiv1alpha1.SpaceGUIDLabelKey, IndexingFunc: Unquote(JSONValue("$.metadata.namespace"))},
+				LabelRule{Label: korifiv1alpha1.DisplayNameLabelKey, IndexingFunc: SHA224(Unquote(JSONValue("$.spec.displayName")))},
 				LabelRule{Label: korifiv1alpha1.CFServiceInstanceGUIDLabelKey, IndexingFunc: Unquote(JSONValue("$.spec.service.name"))},
 				LabelRule{Label: korifiv1alpha1.CFAppGUIDLabelKey, IndexingFunc: Unquote(JSONValue("$.spec.appRef.name"))},
 				LabelRule{Label: korifiv1alpha1.CFServiceBindingTypeLabelKey, IndexingFunc: Unquote(JSONValue("$.spec.type"))},

controllers/webhooks/label_indexer/webhook_test.go

@@ -2,6 +2,7 @@ package label_indexer_test
 
 import (
 	korifiv1alpha1 "code.cloudfoundry.org/korifi/controllers/api/v1alpha1"
+	"code.cloudfoundry.org/korifi/tools"
 	"code.cloudfoundry.org/korifi/tools/k8s"
 	"github.com/google/uuid"
 	. "github.com/onsi/ginkgo/v2"
@@ -284,7 +285,8 @@ var _ = Describe("LabelIndexerWebhook", func() {
 					Namespace: namespace,
 				},
 				Spec: korifiv1alpha1.CFServiceBindingSpec{
-					Type: "app",
+					Type:        "app",
+					DisplayName: tools.PtrTo("my-awesome-binding"),
 					Service: corev1.ObjectReference{
 						Name: uuid.NewString(),
 					},
@@ -304,6 +306,7 @@ var _ = Describe("LabelIndexerWebhook", func() {
 				g.Expect(adminClient.Get(ctx, client.ObjectKeyFromObject(binding), binding)).To(Succeed())
 				g.Expect(binding.Labels).To(MatchKeys(IgnoreExtras, Keys{
 					korifiv1alpha1.SpaceGUIDLabelKey:             Equal(binding.Namespace),
+					korifiv1alpha1.DisplayNameLabelKey:           Equal("473e539de6d59aeed16a5e053c3e1180d10f4dd63da6bd7fdba3d2c9"), // SHA224 hash of "my-awesome-binding"
 					korifiv1alpha1.CFServiceInstanceGUIDLabelKey: Equal(binding.Spec.Service.Name),
 					korifiv1alpha1.CFAppGUIDLabelKey:             Equal(binding.Spec.AppRef.Name),
 					korifiv1alpha1.CFServiceBindingTypeLabelKey:  Equal(binding.Spec.Type),

migration/migration/executor.go

@@ -18,6 +18,7 @@ const MigratedByLabelKey = "korifi.cloudfoundry.org/migrated-by"
 
 var korifiObjectLists = []client.ObjectList{
 	&korifiv1alpha1.CFRouteList{},
+	&korifiv1alpha1.CFServiceBindingList{},
 }
 
 type Migrator struct {

migration/migration/executor_test.go

@@ -20,6 +20,12 @@ var _ = Describe("Executor", func() {
 			},
 		},
 	}))
+
+	Describe("CFServiceBinding", test(&korifiv1alpha1.CFServiceBinding{
+		Spec: korifiv1alpha1.CFServiceBindingSpec{
+			Type: "key",
+		},
+	}))
 })
 
 func test(testObj client.Object) func() {

tests/smoke/service_keys_test.go

@@ -0,0 +1,59 @@
+package smoke_test
+
+import (
+	"code.cloudfoundry.org/korifi/tests/helpers"
+	"code.cloudfoundry.org/korifi/tests/helpers/broker"
+
+	"github.com/BooleanCat/go-functional/v2/it"
+	"github.com/google/uuid"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	. "github.com/onsi/gomega/gexec"
+)
+
+var _ = Describe("cf service-key", func() {
+	var (
+		serviceName        string
+		serviceKeysSession *Session
+		serviceKeyName     string
+	)
+
+	BeforeEach(func() {
+		serviceKeyName = uuid.NewString()
+		appName := uuid.NewString()
+		Expect(helpers.Cf("create-app", appName)).To(Exit(0))
+
+		serviceName = uuid.NewString()
+		brokerName := uuid.NewString()
+		Expect(helpers.Cf(
+			"create-service-broker",
+			brokerName,
+			"broker-user",
+			"broker-password",
+			sharedData.BrokerURL,
+		)).To(Exit(0))
+		DeferCleanup(func() {
+			broker.NewDeleter(sharedData.RootNamespace).ForBrokerName(brokerName).Delete()
+		})
+
+		Expect(helpers.Cf("enable-service-access", "sample-service", "-b", brokerName)).To(Exit(0))
+		serviceKeysSession = helpers.Cf("create-service", "sample-service", "sample", serviceName, "-b", brokerName)
+		Expect(serviceKeysSession).To(Exit(0))
+	})
+
+	JustBeforeEach(func() {
+		serviceKeysSession = helpers.Cf("create-service-key", serviceName, serviceKeyName, "--wait")
+		Expect(serviceKeysSession).To(Exit(0))
+	})
+
+	It("creates a service key", func() {
+		serviceKeysSession = helpers.Cf("service-key", serviceName, serviceKeyName)
+		Expect(serviceKeysSession).To(Exit(0))
+		lines := it.MustCollect(it.LinesString(serviceKeysSession.Out))
+		Expect(lines).To(ContainElements(
+			ContainSubstring(`"credentials"`),
+			ContainSubstring(`"username"`),
+			ContainSubstring(`"password"`),
+		))
+	})
+})