apiproduct: refactor api selectors

apis/networking/v1beta1/apiproduct_types.go

@@ -56,21 +56,22 @@ type SecurityScheme struct {
 	OpenIDConnectAuth *OpenIDConnectAuth `json:"openIDConnectAuth,omitempty"`
 }
 
-type Mapping struct {
-	Prefix string `json:"prefix"`
-}
+type APIReference struct {
+	// Kuadrant API object name
+	Name string `json:"name"`
 
-type APISelector struct {
-	Name      string `json:"name"`
+	// Kuadrant API object namespace
 	Namespace string `json:"namespace"`
 
 	// +optional
 	Tag *string `json:"tag,omitempty"`
 
-	Mapping Mapping `json:"mapping,omitempty"`
+	// Public prefix path to be added to all paths exposed by the API
+	// +optional
+	Prefix *string `json:"prefix,omitempty"`
 }
 
-func (a *APISelector) APINamespacedName() types.NamespacedName {
+func (a *APIReference) APINamespacedName() types.NamespacedName {
 	name := a.Name
 	if a.Tag != nil {
 		name = APIObjectName(a.Name, *a.Tag)
@@ -109,7 +110,10 @@ type APIProductSpec struct {
 	// derived based on the underlying platform.
 	Hosts          []string          `json:"hosts"`
 	SecurityScheme []*SecurityScheme `json:"securityScheme"`
-	APIs           []*APISelector    `json:"APIs"`
+
+	// The list of kuadrant API to be protected
+	// +kubebuilder:validation:MinItems=1
+	APIs []APIReference `json:"APIs"`
 
 	// RateLimit configures global rate limit parameters
 	// +optional
@@ -169,14 +173,18 @@ func (a *APIProduct) Validate() error {
 
 	// Look for duplicated mapping prefixes
 	mappingPrefix := map[string]interface{}{}
-	for idx, apiSel := range a.Spec.APIs {
-		apiField := apisFldPath.Index(idx)
+	for idx := range a.Spec.APIs {
+		apiRef := &a.Spec.APIs[idx]
+		if apiRef.Prefix == nil {
+			continue
+		}
 
-		if _, ok := mappingPrefix[apiSel.Mapping.Prefix]; ok {
-			fieldErrors = append(fieldErrors, field.Invalid(apiField, apiSel.APINamespacedName(), "duplicated prefix"))
+		apiField := apisFldPath.Index(idx)
+		if _, ok := mappingPrefix[*apiRef.Prefix]; ok {
+			fieldErrors = append(fieldErrors, field.Invalid(apiField, apiRef.APINamespacedName(), "duplicated prefix"))
 		}
 
-		mappingPrefix[apiSel.Mapping.Prefix] = nil
+		mappingPrefix[*apiRef.Prefix] = nil
 	}
 
 	if len(fieldErrors) > 0 {

config/crd/bases/networking.kuadrant.io_apiproducts.yaml

@@ -37,25 +37,26 @@ spec:
             description: APIProductSpec defines the desired state of APIProduct
             properties:
               APIs:
+                description: The list of kuadrant API to be protected
                 items:
                   properties:
-                    mapping:
-                      properties:
-                        prefix:
-                          type: string
-                      required:
-                      - prefix
-                      type: object
                     name:
+                      description: Kuadrant API object name
                       type: string
                     namespace:
+                      description: Kuadrant API object namespace
+                      type: string
+                    prefix:
+                      description: Public prefix path to be added to all paths exposed
+                        by the API
                       type: string
                     tag:
                       type: string
                   required:
                   - name
                   - namespace
                   type: object
+                minItems: 1
                 type: array
               hosts:
                 description: The destination hosts to which traffic is being sent.

controllers/apiproduct_controller_test.go

@@ -182,6 +182,8 @@ var _ = Describe("APIPRoduct controller", func() {
 
 func apiProduct(ns string) *networkingv1beta1.APIProduct {
 	tag := "production"
+	catsPrefix := "/cats"
+	dogsPrefix := "/dogs"
 	return &networkingv1beta1.APIProduct{
 		TypeMeta: metav1.TypeMeta{
 			Kind:       networkingv1beta1.APIProductKind,
@@ -190,22 +192,18 @@ func apiProduct(ns string) *networkingv1beta1.APIProduct {
 		ObjectMeta: metav1.ObjectMeta{Name: "apiproduct01", Namespace: ns},
 		Spec: networkingv1beta1.APIProductSpec{
 			Hosts: []string{"petstore.127.0.0.1.nip.io"},
-			APIs: []*networkingv1beta1.APISelector{
+			APIs: []networkingv1beta1.APIReference{
 				{
 					Name:      "cats",
 					Namespace: ns,
 					Tag:       &tag,
-					Mapping: networkingv1beta1.Mapping{
-						Prefix: "/cats",
-					},
+					Prefix:    &catsPrefix,
 				},
 				{
 					Name:      "dogs",
 					Namespace: ns,
 					Tag:       &tag,
-					Mapping: networkingv1beta1.Mapping{
-						Prefix: "/dogs",
-					},
+					Prefix:    &dogsPrefix,
 				},
 			},
 			SecurityScheme: []*networkingv1beta1.SecurityScheme{

pkg/ingressproviders/istioprovider/http_route.go

@@ -117,7 +117,7 @@ func stringMatch(path string, matchType PathMatchType) *v1alpha3.StringMatch {
 	}
 }
 
-func HTTPRoutesFromOAS(oasContent string, pathPrefix string, destination networkingv1beta1.Destination) ([]*v1alpha3.HTTPRoute, error) {
+func HTTPRoutesFromOAS(oasContent string, pathPrefix *string, destination networkingv1beta1.Destination) ([]*v1alpha3.HTTPRoute, error) {
 	doc, err := openapi3.NewLoader().LoadFromData([]byte(oasContent))
 	if err != nil {
 		return nil, err
@@ -146,12 +146,12 @@ func HTTPRoutesFromOAS(oasContent string, pathPrefix string, destination network
 			}
 
 			// Handle Prefix Override.
-			if pathPrefix != "" {
+			if pathPrefix != nil {
 				// We need to rewrite the path, to match what the service expects, basically,
 				// removing the prefixOverride
 				factory.RewriteURI = &path
 				// If there's an Override, lets append it to the actual Operation Path.
-				factory.URIMatchPath = pathPrefix + path
+				factory.URIMatchPath = *pathPrefix + path
 			}
 
 			httpRoutes = append(httpRoutes, factory.HTTPRoute())
@@ -161,7 +161,7 @@ func HTTPRoutesFromOAS(oasContent string, pathPrefix string, destination network
 	return httpRoutes, nil
 }
 
-func HTTPRoutesFromPath(pathMatch *gatewayapiv1alpha1.HTTPPathMatch, pathPrefix string, destination networkingv1beta1.Destination) ([]*v1alpha3.HTTPRoute, error) {
+func HTTPRoutesFromPath(pathMatch *gatewayapiv1alpha1.HTTPPathMatch, pathPrefix *string, destination networkingv1beta1.Destination) ([]*v1alpha3.HTTPRoute, error) {
 	if pathMatch == nil {
 		return nil, nil
 	}
@@ -186,12 +186,12 @@ func HTTPRoutesFromPath(pathMatch *gatewayapiv1alpha1.HTTPPathMatch, pathPrefix
 		}
 
 		// Handle Prefix Override.
-		if pathPrefix != "" {
+		if pathPrefix != nil {
 			// We need to rewrite the path, to match what the service expects, basically,
 			// removing the prefixOverride
 			factory.RewriteURI = pathMatch.Value
 			// If there's an Override, lets append it to the actual Operation Path.
-			factory.URIMatchPath = pathPrefix + *pathMatch.Value
+			factory.URIMatchPath = *pathPrefix + *pathMatch.Value
 		}
 
 		httpRoutes = append(httpRoutes, factory.HTTPRoute())

pkg/ingressproviders/istioprovider/provider.go

@@ -173,8 +173,8 @@ func (is *IstioProvider) getAuthorizationPolicy(virtualService *istio.VirtualSer
 
 func (is *IstioProvider) virtualServiceFromAPIProduct(ctx context.Context, apip *networkingv1beta1.APIProduct) (*istio.VirtualService, error) {
 	httpRoutes := []*v1alpha3.HTTPRoute{}
-	for _, apiSel := range apip.Spec.APIs {
-		apiHTTPRoutes, err := is.apiHTTPRoutes(ctx, apiSel)
+	for idx := range apip.Spec.APIs {
+		apiHTTPRoutes, err := is.apiHTTPRoutes(ctx, &apip.Spec.APIs[idx])
 		if err != nil {
 			return nil, err
 		}
@@ -191,18 +191,18 @@ func (is *IstioProvider) virtualServiceFromAPIProduct(ctx context.Context, apip
 	return factory.VirtualService(), nil
 }
 
-func (is *IstioProvider) apiHTTPRoutes(ctx context.Context, apiSel *networkingv1beta1.APISelector) ([]*v1alpha3.HTTPRoute, error) {
+func (is *IstioProvider) apiHTTPRoutes(ctx context.Context, apiRef *networkingv1beta1.APIReference) ([]*v1alpha3.HTTPRoute, error) {
 	api := &networkingv1beta1.API{}
-	err := is.Client().Get(ctx, apiSel.APINamespacedName(), api)
+	err := is.Client().Get(ctx, apiRef.APINamespacedName(), api)
 	if err != nil {
 		return nil, err
 	}
 
 	if api.Spec.Mappings.OAS != nil {
-		return HTTPRoutesFromOAS(*api.Spec.Mappings.OAS, apiSel.Mapping.Prefix, api.Spec.Destination)
+		return HTTPRoutesFromOAS(*api.Spec.Mappings.OAS, apiRef.Prefix, api.Spec.Destination)
 	}
 
-	return HTTPRoutesFromPath(api.Spec.Mappings.HTTPPathMatch, apiSel.Mapping.Prefix, api.Spec.Destination)
+	return HTTPRoutesFromPath(api.Spec.Mappings.HTTPPathMatch, apiRef.Prefix, api.Spec.Destination)
 }
 
 func (is *IstioProvider) Status(ctx context.Context, apip *networkingv1beta1.APIProduct) (bool, error) {

samples/apiproduct.yaml

@@ -1,3 +1,4 @@
+---
 apiVersion: networking.kuadrant.io/v1beta1
 kind: APIProduct
 metadata:
@@ -9,13 +10,11 @@ spec:
     - name: dogs
       namespace: default
       tag: production
-      mapping:
-        prefix: /dogs
+      prefix: /dogs
     - name: cats
       namespace: default
       tag: production
-      mapping:
-        prefix: /cats
+      prefix: /cats
   securityScheme:
     - name: MyAPIKey
       apiKeyAuth: