X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=capifcore%2Finternal%2Fprovidermanagement%2Fprovidermanagement.go;h=5fa786c912d25524a321798ceab9c449ef7909d9;hb=refs%2Fchanges%2F85%2F12585%2F1;hp=82d833ff57e7e89106412212ea2e25c69586d9fc;hpb=c9e08b2a2f647f9f870040570c5e71305f0fb5d2;p=nonrtric%2Fplt%2Fsme.git diff --git a/capifcore/internal/providermanagement/providermanagement.go b/capifcore/internal/providermanagement/providermanagement.go index 82d833f..5fa786c 100644 --- a/capifcore/internal/providermanagement/providermanagement.go +++ b/capifcore/internal/providermanagement/providermanagement.go @@ -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. @@ -21,122 +22,151 @@ package providermanagement import ( + "fmt" "net/http" "path" - "strings" "sync" - "github.com/labstack/echo/v4" + echo "github.com/labstack/echo/v4" + log "github.com/sirupsen/logrus" "oransc.org/nonrtric/capifcore/internal/common29122" provapi "oransc.org/nonrtric/capifcore/internal/providermanagementapi" - - log "github.com/sirupsen/logrus" ) //go:generate mockery --name ServiceRegister type ServiceRegister interface { - IsFunctionRegistered(aefId string) bool + IsFunctionRegistered(functionId string) bool + GetAefsForPublisher(apfId string) []string + IsPublishingFunctionRegistered(apiProvFuncId string) bool } type ProviderManager struct { - onboardedProviders map[string]provapi.APIProviderEnrolmentDetails - lock sync.Mutex + registeredProviders map[string]provapi.APIProviderEnrolmentDetails + lock sync.Mutex } func NewProviderManager() *ProviderManager { return &ProviderManager{ - onboardedProviders: make(map[string]provapi.APIProviderEnrolmentDetails), + registeredProviders: make(map[string]provapi.APIProviderEnrolmentDetails), } } -func (pm *ProviderManager) IsFunctionRegistered(aefId string) bool { - registered := false -out: - for _, provider := range pm.onboardedProviders { - for _, registeredFunc := range *provider.ApiProvFuncs { - if *registeredFunc.ApiProvFuncId == aefId { - registered = true - break out - } +func (pm *ProviderManager) IsFunctionRegistered(functionId string) bool { + for _, provider := range pm.registeredProviders { + if provider.IsFunctionRegistered(functionId) { + return true } } + return false +} - return registered +func (pm *ProviderManager) GetAefsForPublisher(apfId string) []string { + for _, provider := range pm.registeredProviders { + if aefs := provider.GetExposingFunctionIdsForPublisher(apfId); aefs != nil { + return aefs + } + } + return nil +} + +func (pm *ProviderManager) IsPublishingFunctionRegistered(apiProvFuncId string) bool { + for _, provider := range pm.registeredProviders { + if provider.IsPublishingFunctionRegistered(apiProvFuncId) { + return true + } + } + return false } func (pm *ProviderManager) PostRegistrations(ctx echo.Context) error { var newProvider provapi.APIProviderEnrolmentDetails - err := ctx.Bind(&newProvider) - if err != nil { - return sendCoreError(ctx, http.StatusBadRequest, "Invalid format for provider") + errMsg := "Unable to register provider due to %s" + if err := ctx.Bind(&newProvider); err != nil { + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, "invalid format for provider")) } - if newProvider.ApiProvDomInfo == nil || *newProvider.ApiProvDomInfo == "" { - return sendCoreError(ctx, http.StatusBadRequest, "Provider missing required ApiProvDomInfo") + if err := pm.isProviderRegistered(newProvider); err != nil { + return sendCoreError(ctx, http.StatusForbidden, fmt.Sprintf(errMsg, err)) } - pm.lock.Lock() - defer pm.lock.Unlock() - - newProvider.ApiProvDomId = pm.getDomainId(newProvider.ApiProvDomInfo) + if err := newProvider.Validate(); err != nil { + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err)) + } - pm.registerFunctions(newProvider.ApiProvFuncs) - pm.onboardedProviders[*newProvider.ApiProvDomId] = newProvider + pm.prepareNewProvider(&newProvider) uri := ctx.Request().Host + ctx.Request().URL.String() ctx.Response().Header().Set(echo.HeaderLocation, ctx.Scheme()+`://`+path.Join(uri, *newProvider.ApiProvDomId)) - err = ctx.JSON(http.StatusCreated, newProvider) - if err != nil { + if err := ctx.JSON(http.StatusCreated, newProvider); err != nil { // Something really bad happened, tell Echo that our handler failed return err } + return nil +} +func (pm *ProviderManager) isProviderRegistered(newProvider provapi.APIProviderEnrolmentDetails) error { + for _, prov := range pm.registeredProviders { + if err := prov.ValidateAlreadyRegistered(newProvider); err != nil { + return err + } + } return nil } -func (pm *ProviderManager) DeleteRegistrationsRegistrationId(ctx echo.Context, registrationId string) error { +func (pm *ProviderManager) prepareNewProvider(newProvider *provapi.APIProviderEnrolmentDetails) { pm.lock.Lock() defer pm.lock.Unlock() - log.Debug(pm.onboardedProviders) - if _, ok := pm.onboardedProviders[registrationId]; ok { - log.Debug("Deleting provider", registrationId) - delete(pm.onboardedProviders, registrationId) - } + newProvider.PrepareNewProvider() + pm.registeredProviders[*newProvider.ApiProvDomId] = *newProvider +} +func (pm *ProviderManager) DeleteRegistrationsRegistrationId(ctx echo.Context, registrationId string) error { + log.Debug(pm.registeredProviders) + if _, ok := pm.registeredProviders[registrationId]; ok { + pm.deleteProvider(registrationId) + } return ctx.NoContent(http.StatusNoContent) } -func (pm *ProviderManager) PutRegistrationsRegistrationId(ctx echo.Context, registrationId string) error { - registeredProvider, ok := pm.onboardedProviders[registrationId] - if !ok { - return sendCoreError(ctx, http.StatusBadRequest, "Provider must be onboarded before updating it") +func (pm *ProviderManager) deleteProvider(registrationId string) { + log.Debug("Deleting provider", registrationId) + pm.lock.Lock() + defer pm.lock.Unlock() + delete(pm.registeredProviders, registrationId) +} +func (pm *ProviderManager) PutRegistrationsRegistrationId(ctx echo.Context, registrationId string) error { + errMsg := "Unable to update provider due to %s." + registeredProvider, err := pm.checkIfProviderIsRegistered(registrationId) + if err != nil { + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err)) } - var updatedProvider provapi.APIProviderEnrolmentDetails - err := ctx.Bind(&updatedProvider) + updatedProvider, err := getProviderFromRequest(ctx) if err != nil { - return sendCoreError(ctx, http.StatusBadRequest, "Invalid format for provider") + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err)) } - for _, function := range *updatedProvider.ApiProvFuncs { - if function.ApiProvFuncId == nil { - function.ApiProvFuncId = pm.getFuncId(function.ApiProvFuncRole, function.ApiProvFuncInfo) - registeredFuncs := *registeredProvider.ApiProvFuncs - newFuncs := append(registeredFuncs, function) - registeredProvider.ApiProvFuncs = &newFuncs - pm.onboardedProviders[*registeredProvider.ApiProvDomId] = registeredProvider - } + if updatedProvider.Validate() != nil { + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err)) } - err = ctx.JSON(http.StatusOK, registeredProvider) - if err != nil { + // Additional validation for PUT + if (updatedProvider.ApiProvDomId == nil) || (*updatedProvider.ApiProvDomId != registrationId) { + errDetail := "APIProviderEnrolmentDetails ApiProvDomId doesn't match path parameter" + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, errDetail)) + } + + if err = pm.updateProvider(updatedProvider, registeredProvider); err != nil { + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err)) + } + + if err = ctx.JSON(http.StatusOK, updatedProvider); err != nil { // Something really bad happened, tell Echo that our handler failed return err } - return nil } @@ -144,34 +174,33 @@ func (pm *ProviderManager) ModifyIndApiProviderEnrolment(ctx echo.Context, regis return ctx.NoContent(http.StatusNotImplemented) } -func (pm *ProviderManager) registerFunctions(provFuncs *[]provapi.APIProviderFunctionDetails) { - if provFuncs == nil { - return - } - for i, provFunc := range *provFuncs { - (*provFuncs)[i].ApiProvFuncId = pm.getFuncId(provFunc.ApiProvFuncRole, provFunc.ApiProvFuncInfo) +func (pm *ProviderManager) checkIfProviderIsRegistered(registrationId string) (*provapi.APIProviderEnrolmentDetails, error) { + registeredProvider, ok := pm.registeredProviders[registrationId] + if !ok { + return nil, fmt.Errorf("provider not onboarded") } + return ®isteredProvider, nil } -func (pm *ProviderManager) getDomainId(domainInfo *string) *string { - idAsString := "domain_id_" + strings.ReplaceAll(*domainInfo, " ", "_") - return &idAsString +func getProviderFromRequest(ctx echo.Context) (provapi.APIProviderEnrolmentDetails, error) { + var updatedProvider provapi.APIProviderEnrolmentDetails + err := ctx.Bind(&updatedProvider) + if err != nil { + return provapi.APIProviderEnrolmentDetails{}, fmt.Errorf("invalid format for provider") + } + return updatedProvider, nil } -func (pm *ProviderManager) getFuncId(role provapi.ApiProviderFuncRole, funcInfo *string) *string { - var idPrefix string - switch role { - case provapi.ApiProviderFuncRoleAPF: - idPrefix = "APF_id_" - case provapi.ApiProviderFuncRoleAMF: - idPrefix = "AMF_id_" - case provapi.ApiProviderFuncRoleAEF: - idPrefix = "AEF_id_" - default: - idPrefix = "function_id_" +func (pm *ProviderManager) updateProvider(updatedProvider provapi.APIProviderEnrolmentDetails, registeredProvider *provapi.APIProviderEnrolmentDetails) error { + pm.lock.Lock() + defer pm.lock.Unlock() + + if err := updatedProvider.UpdateFuncs(*registeredProvider); err == nil { + pm.registeredProviders[*updatedProvider.ApiProvDomId] = updatedProvider + return nil + } else { + return err } - idAsString := idPrefix + strings.ReplaceAll(*funcInfo, " ", "_") - return &idAsString } // This function wraps sending of an error in the Error format, and