NONRTRIC-946: Get Allowed Publishers
[nonrtric/plt/sme.git] / capifcore / internal / publishservice / publishservice.go
index bf79899..372b1f8 100644 (file)
@@ -2,7 +2,8 @@
 //   ========================LICENSE_START=================================
 //   O-RAN-SC
 //   %%
-//   Copyright (C) 2022: Nordix Foundation
+//   Copyright (C) 2022-2023: Nordix Foundation
+//   Copyright (C) 2024: OpenInfra Foundation Europe
 //   %%
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -27,7 +28,7 @@ import (
        "strings"
        "sync"
 
-       "github.com/labstack/echo/v4"
+       echo "github.com/labstack/echo/v4"
        "k8s.io/utils/strings/slices"
 
        "oransc.org/nonrtric/capifcore/internal/common29122"
@@ -48,6 +49,7 @@ type PublishRegister interface {
        // Gets all published APIs.
        // Returns a list of all APIs that has been published.
        GetAllPublishedServices() []publishapi.ServiceAPIDescription
+       GetAllowedPublishedServices(invokerApiList []publishapi.ServiceAPIDescription) []publishapi.ServiceAPIDescription
 }
 
 type PublishService struct {
@@ -93,19 +95,42 @@ func (ps *PublishService) GetAllPublishedServices() []publishapi.ServiceAPIDescr
        return publishedDescriptions
 }
 
+func (ps *PublishService) GetAllowedPublishedServices(apiListRequestedServices []publishapi.ServiceAPIDescription) []publishapi.ServiceAPIDescription {
+       apiListAllPublished := ps.GetAllPublishedServices()
+       if apiListRequestedServices != nil {
+               allowedPublishedServices := intersection(apiListAllPublished, apiListRequestedServices)
+               return allowedPublishedServices
+       }
+       return []publishapi.ServiceAPIDescription{}
+}
+
+func intersection(a, b []publishapi.ServiceAPIDescription) []publishapi.ServiceAPIDescription {
+       var result []publishapi.ServiceAPIDescription
+
+       for _, itemA := range a {
+               for _, itemB := range b {
+                       if *itemA.ApiId == *itemB.ApiId {
+                               result = append(result, itemA)
+                               break
+                       }
+               }
+       }
+       return result
+}
+
 // Retrieve all published APIs.
 func (ps *PublishService) GetApfIdServiceApis(ctx echo.Context, apfId string) error {
-       serviceDescriptions, ok := ps.publishedServices[apfId]
-       if ok {
-               err := ctx.JSON(http.StatusOK, serviceDescriptions)
-               if err != nil {
-                       // Something really bad happened, tell Echo that our handler failed
-                       return err
-               }
-       } else {
-               return sendCoreError(ctx, http.StatusNotFound, fmt.Sprintf("Provider %s not registered", apfId))
+       if !ps.serviceRegister.IsPublishingFunctionRegistered(apfId) {
+               errorMsg := fmt.Sprintf("Unable to get the service due to %s api is only available for publishers", apfId)
+               return sendCoreError(ctx, http.StatusNotFound, errorMsg)
        }
 
+       serviceDescriptions := ps.publishedServices[apfId]
+       err := ctx.JSON(http.StatusOK, serviceDescriptions)
+       if err != nil {
+               // Something really bad happened, tell Echo that our handler failed
+               return err
+       }
        return nil
 }
 
@@ -118,8 +143,12 @@ func (ps *PublishService) PostApfIdServiceApis(ctx echo.Context, apfId string) e
                return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errorMsg, "invalid format for service "+apfId))
        }
 
-       if ps.isServicePublished(newServiceAPIDescription) {
-               return sendCoreError(ctx, http.StatusForbidden, fmt.Sprintf(errorMsg, "service already published"))
+       if !ps.serviceRegister.IsPublishingFunctionRegistered(apfId) {
+               return sendCoreError(ctx, http.StatusForbidden, fmt.Sprintf(errorMsg, "api is only available for publishers "+apfId))
+       }
+
+       if err := ps.isServicePublished(newServiceAPIDescription); err != nil {
+               return sendCoreError(ctx, http.StatusForbidden, fmt.Sprintf(errorMsg, err))
        }
 
        if err := newServiceAPIDescription.Validate(); err != nil {
@@ -161,15 +190,15 @@ func (ps *PublishService) PostApfIdServiceApis(ctx echo.Context, apfId string) e
        return nil
 }
 
-func (ps *PublishService) isServicePublished(newService publishapi.ServiceAPIDescription) bool {
+func (ps *PublishService) isServicePublished(newService publishapi.ServiceAPIDescription) error {
        for _, services := range ps.publishedServices {
                for _, service := range services {
-                       if service.IsPublished(newService) {
-                               return true
+                       if err := service.ValidateAlreadyPublished(newService); err != nil {
+                               return err
                        }
                }
        }
-       return false
+       return nil
 }
 
 func (ps *PublishService) installHelmChart(newServiceAPIDescription publishapi.ServiceAPIDescription, ctx echo.Context) (bool, error) {
@@ -228,7 +257,8 @@ func (ps *PublishService) GetApfIdServiceApisServiceApiId(ctx echo.Context, apfI
 
 func getServiceDescription(serviceApiId string, descriptions []publishapi.ServiceAPIDescription) (int, *publishapi.ServiceAPIDescription) {
        for pos, description := range descriptions {
-               if serviceApiId == *description.ApiId {
+               // Check for nil as we had a failure here when running unit tests in parallel against a single Capifcore instance
+               if (description.ApiId != nil) && (serviceApiId == *description.ApiId) {
                        return pos, &description
                }
        }
@@ -252,21 +282,33 @@ func (ps *PublishService) PutApfIdServiceApisServiceApiId(ctx echo.Context, apfI
        ps.lock.Lock()
        defer ps.lock.Unlock()
        errMsg := "Unable to update service due to %s."
+
        pos, publishedService, err := ps.checkIfServiceIsPublished(apfId, serviceApiId, ctx)
        if err != nil {
                return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err))
        }
+
        updatedServiceDescription, err := getServiceFromRequest(ctx)
        if err != nil {
                return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err))
        }
+
+       // Additional validation for PUT
+       if (updatedServiceDescription.ApiId == nil) || (*updatedServiceDescription.ApiId != serviceApiId) {
+               errDetail := "ServiceAPIDescription ApiId doesn't match path parameter"
+               return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, errDetail))
+       }
+
        err = ps.checkProfilesRegistered(apfId, *updatedServiceDescription.AefProfiles)
        if err != nil {
                return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err))
        }
+
        ps.updateDescription(pos, apfId, &updatedServiceDescription, &publishedService)
+
        publishedService.AefProfiles = updatedServiceDescription.AefProfiles
        ps.publishedServices[apfId][pos] = publishedService
+
        err = ctx.JSON(http.StatusOK, publishedService)
        if err != nil {
                // Something really bad happened, tell Echo that our handler failed
@@ -274,6 +316,7 @@ func (ps *PublishService) PutApfIdServiceApisServiceApiId(ctx echo.Context, apfI
        }
        return nil
 }
+
 func (ps *PublishService) checkIfServiceIsPublished(apfId string, serviceApiId string, ctx echo.Context) (int, publishapi.ServiceAPIDescription, error) {
        publishedServices, ok := ps.publishedServices[apfId]
        if !ok {
@@ -287,6 +330,7 @@ func (ps *PublishService) checkIfServiceIsPublished(apfId string, serviceApiId s
        }
        return 0, publishapi.ServiceAPIDescription{}, fmt.Errorf("service must be published before updating it")
 }
+
 func getServiceFromRequest(ctx echo.Context) (publishapi.ServiceAPIDescription, error) {
        var updatedServiceDescription publishapi.ServiceAPIDescription
        err := ctx.Bind(&updatedServiceDescription)
@@ -295,6 +339,7 @@ func getServiceFromRequest(ctx echo.Context) (publishapi.ServiceAPIDescription,
        }
        return updatedServiceDescription, nil
 }
+
 func (ps *PublishService) updateDescription(pos int, apfId string, updatedServiceDescription, publishedService *publishapi.ServiceAPIDescription) {
        if updatedServiceDescription.Description != nil {
                publishedService.Description = updatedServiceDescription.Description