Adds ability to filter by [Cluster]ServicePlan.spec.free

Closes: kubernetes-retired#2209

pkg/apis/servicecatalog/types.go

@@ -150,6 +150,7 @@ type CommonServiceBrokerSpec struct {
 //   name - the value set to [Cluster]ServicePlan.Name
 //   spec.externalName - the value set to [Cluster]ServicePlan.Spec.ExternalName
 //   spec.externalID - the value set to [Cluster]ServicePlan.Spec.ExternalID
+//   spec.free - the value set to [Cluster]ServicePlan.Spec.Free
 //   spec.serviceClassName - the value set to ServicePlan.Spec.ServiceClassRef.Name
 //   spec.clusterServiceClass.name - the value set to ClusterServicePlan.Spec.ClusterServiceClassRef.Name
 type CatalogRestrictions struct {

pkg/apis/servicecatalog/v1beta1/filter.go

@@ -17,6 +17,8 @@ limitations under the License.
 package v1beta1
 
 import (
+	"strconv"
+
 	"github.com/kubernetes-incubator/service-catalog/pkg/filter"
 	"k8s.io/apimachinery/pkg/labels"
 )
@@ -50,6 +52,7 @@ func ConvertServicePlanToProperties(servicePlan *ServicePlan) filter.Properties
 		FilterSpecExternalName:     servicePlan.Spec.ExternalName,
 		FilterSpecExternalID:       servicePlan.Spec.ExternalID,
 		FilterSpecServiceClassName: servicePlan.Spec.ServiceClassRef.Name,
+		FilterSpecFree:             strconv.FormatBool(servicePlan.Spec.Free),
 	}
 }
 
@@ -79,5 +82,6 @@ func ConvertClusterServicePlanToProperties(servicePlan *ClusterServicePlan) filt
 		FilterSpecExternalName:            servicePlan.Spec.ExternalName,
 		FilterSpecExternalID:              servicePlan.Spec.ExternalID,
 		FilterSpecClusterServiceClassName: servicePlan.Spec.ClusterServiceClassRef.Name,
+		FilterSpecFree:                    strconv.FormatBool(servicePlan.Spec.Free),
 	}
 }

pkg/apis/servicecatalog/v1beta1/filter_test.go

@@ -83,13 +83,14 @@ func TestConvertServicePlanToProperties(t *testing.T) {
 					CommonServicePlanSpec: CommonServicePlanSpec{
 						ExternalName: "external-plan-name",
 						ExternalID:   "external-id",
+						Free:         true,
 					},
 					ServiceClassRef: LocalObjectReference{
 						Name: "service-class-name",
 					},
 				},
 			},
-			json: `{"name":"service-plan","spec.externalID":"external-id","spec.externalName":"external-plan-name","spec.serviceClass.name":"service-class-name"}`,
+			json: `{"name":"service-plan","spec.externalID":"external-id","spec.externalName":"external-plan-name","spec.free":"true","spec.serviceClass.name":"service-class-name"}`,
 		},
 	}
 	for _, tc := range cases {
@@ -170,13 +171,14 @@ func TestConvertClusterServicePlanToProperties(t *testing.T) {
 					CommonServicePlanSpec: CommonServicePlanSpec{
 						ExternalName: "external-plan-name",
 						ExternalID:   "external-id",
+						Free:         true,
 					},
 					ClusterServiceClassRef: ClusterObjectReference{
 						Name: "cluster-service-class-name",
 					},
 				},
 			},
-			json: `{"name":"service-plan","spec.clusterServiceClass.name":"cluster-service-class-name","spec.externalID":"external-id","spec.externalName":"external-plan-name"}`,
+			json: `{"name":"service-plan","spec.clusterServiceClass.name":"cluster-service-class-name","spec.externalID":"external-id","spec.externalName":"external-plan-name","spec.free":"true"}`,
 		},
 	}
 	for _, tc := range cases {

pkg/apis/servicecatalog/v1beta1/types.go

@@ -136,21 +136,21 @@ type CommonServiceBrokerSpec struct {
 // This is an example of a whitelist on service externalName.
 // Goal: Only list Services with the externalName of FooService and BarService,
 // Solution: restrictions := ServiceCatalogRestrictions{
-// 		ServiceClass: ["externalName in (FooService, BarService)"]
+// 		ServiceClass: ["spec.externalName in (FooService, BarService)"]
 // }
 //
 // This is an example of a blacklist on service externalName.
 // Goal: Allow all services except the ones with the externalName of FooService and BarService,
 // Solution: restrictions := ServiceCatalogRestrictions{
-// 		ServiceClass: ["externalName notin (FooService, BarService)"]
+// 		ServiceClass: ["spec.externalName notin (FooService, BarService)"]
 // }
 //
 // This whitelists plans called "Demo", and blacklists (but only a single element in
 // the list) a service and a plan.
 // Goal: Allow all plans with the externalName demo, but not AABBCC, and not a specific service by name,
 // Solution: restrictions := ServiceCatalogRestrictions{
 // 		ServiceClass: ["name!=AABBB-CCDD-EEGG-HIJK"]
-// 		ServicePlan: ["externalName in (Demo)", "name!=AABBCC"]
+// 		ServicePlan: ["spec.externalName in (Demo)", "name!=AABBCC"]
 // }
 //
 // CatalogRestrictions strings have a special format similar to Label Selectors,
@@ -171,8 +171,9 @@ type CommonServiceBrokerSpec struct {
 //   name - the value set to [Cluster]ServicePlan.Name
 //   spec.externalName - the value set to [Cluster]ServicePlan.Spec.ExternalName
 //   spec.externalID - the value set to [Cluster]ServicePlan.Spec.ExternalID
+//   spec.free - the value set to [Cluster]ServicePlan.Spec.Free
 //   spec.serviceClass.name - the value set to ServicePlan.Spec.ServiceClassRef.Name
-//   spec.clusterServiceClass.name - the vlaue set to ClusterServicePlan.Spec.ClusterServiceClassRef.Name
+//   spec.clusterServiceClass.name - the value set to ClusterServicePlan.Spec.ClusterServiceClassRef.Name
 type CatalogRestrictions struct {
 	// ServiceClass represents a selector for plans, used to filter catalog re-lists.
 	ServiceClass []string `json:"serviceClass,omitempty"`
@@ -1372,6 +1373,8 @@ const (
 	FilterSpecClusterServiceClassName = "spec.clusterServiceClass.name"
 	// SpecServiceClassName is only used for plans, the parent service class name.
 	FilterSpecServiceClassName = "spec.serviceClass.name"
+	// FilterSpecFree is only used for plans, determines if the plan is free.
+	FilterSpecFree = "spec.free"
 )
 
 // SecretTransform is a single transformation that is applied to the

pkg/controller/controller_test.go

@@ -1588,6 +1588,15 @@ func TestConvertAndFilterCatalog(t *testing.T) {
 			plans:   []string{"Goldengrove", "Queensgate"},
 			catalog: largeTestCatalog,
 		},
+		{
+			name: "filter free plans",
+			restrictions: &v1beta1.CatalogRestrictions{
+				ServicePlan: []string{"spec.free==true"},
+			},
+			classes: []string{"Arrax", "Balerion"},
+			plans:   []string{"Eastwatch-by-the-Sea", "OldOak", "Queensgate"},
+			catalog: largeTestCatalog,
+		},
 	}
 	for _, tc := range cases {
 		t.Run(tc.name, func(t *testing.T) {