X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=capifcore%2Finternal%2Finvokermanagement%2Finvokermanagement.go;h=5fa5ce65cf618362e45c5c3ea136778795ac1120;hb=b8e717a8c264a8b3f73626fc28c81ae65283ae80;hp=20bba33de57264c87e51003fc335fb2600e8e889;hpb=712247934a771ca533b0febcca4b2702225b17cb;p=nonrtric%2Fplt%2Fsme.git diff --git a/capifcore/internal/invokermanagement/invokermanagement.go b/capifcore/internal/invokermanagement/invokermanagement.go index 20bba33..5fa5ce6 100644 --- a/capifcore/internal/invokermanagement/invokermanagement.go +++ b/capifcore/internal/invokermanagement/invokermanagement.go @@ -21,12 +21,13 @@ package invokermanagement import ( + "errors" + "fmt" "net/http" "path" - "strconv" - "strings" "sync" + "oransc.org/nonrtric/capifcore/internal/eventsapi" publishapi "oransc.org/nonrtric/capifcore/internal/publishserviceapi" "oransc.org/nonrtric/capifcore/internal/common29122" @@ -39,23 +40,32 @@ import ( //go:generate mockery --name InvokerRegister type InvokerRegister interface { + // Checks if the invoker is registered. + // Returns true of the provided invoker is registered, false otherwise. IsInvokerRegistered(invokerId string) bool + // Verifies that the provided secret is the invoker's registered secret. + // Returns true if the provided secret is the registered invoker's secret, false otherwise. VerifyInvokerSecret(invokerId, secret string) bool + // Gets the provided invoker's registered APIs. + // Returns a list of all the invoker's registered APIs. GetInvokerApiList(invokerId string) *invokerapi.APIList } type InvokerManager struct { onboardedInvokers map[string]invokerapi.APIInvokerEnrolmentDetails - apiRegister publishservice.APIRegister + publishRegister publishservice.PublishRegister nextId int64 + eventChannel chan<- eventsapi.EventNotification lock sync.Mutex } -func NewInvokerManager(apiRegister publishservice.APIRegister) *InvokerManager { +// Creates a manager that implements both the InvokerRegister and the invokermanagementapi.ServerInterface interfaces. +func NewInvokerManager(publishRegister publishservice.PublishRegister, eventChannel chan<- eventsapi.EventNotification) *InvokerManager { return &InvokerManager{ onboardedInvokers: make(map[string]invokerapi.APIInvokerEnrolmentDetails), - apiRegister: apiRegister, + publishRegister: publishRegister, nextId: 1000, + eventChannel: eventChannel, } } @@ -79,42 +89,36 @@ func (im *InvokerManager) VerifyInvokerSecret(invokerId, secret string) bool { } func (im *InvokerManager) GetInvokerApiList(invokerId string) *invokerapi.APIList { + var apiList invokerapi.APIList = im.publishRegister.GetAllPublishedServices() + im.lock.Lock() + defer im.lock.Unlock() invoker, ok := im.onboardedInvokers[invokerId] if ok { - return invoker.ApiList + invoker.ApiList = &apiList + return &apiList } return nil } +// Creates a new individual API Invoker profile. func (im *InvokerManager) PostOnboardedInvokers(ctx echo.Context) error { var newInvoker invokerapi.APIInvokerEnrolmentDetails - err := ctx.Bind(&newInvoker) - if err != nil { - return sendCoreError(ctx, http.StatusBadRequest, "Invalid format for invoker") + errMsg := "Unable to onboard invoker due to %s" + if err := ctx.Bind(&newInvoker); err != nil { + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, "invalid format for invoker")) } - shouldReturn, coreError := im.validateInvoker(newInvoker, ctx) - if shouldReturn { - return coreError + if err := im.validateInvoker(newInvoker, ctx); err != nil { + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err)) } - im.lock.Lock() - defer im.lock.Unlock() - - newInvoker.ApiInvokerId = im.getId(newInvoker.ApiInvokerInformation) - onboardingSecret := "onboarding_secret_" - if newInvoker.ApiInvokerInformation != nil { - onboardingSecret = onboardingSecret + strings.ReplaceAll(*newInvoker.ApiInvokerInformation, " ", "_") - } else { - onboardingSecret = onboardingSecret + *newInvoker.ApiInvokerId - } - newInvoker.OnboardingInformation.OnboardingSecret = &onboardingSecret + im.prepareNewInvoker(&newInvoker) - im.onboardedInvokers[*newInvoker.ApiInvokerId] = newInvoker + go im.sendEvent(*newInvoker.ApiInvokerId, eventsapi.CAPIFEventAPIINVOKERONBOARDED) uri := ctx.Request().Host + ctx.Request().URL.String() ctx.Response().Header().Set(echo.HeaderLocation, ctx.Scheme()+`://`+path.Join(uri, *newInvoker.ApiInvokerId)) - err = ctx.JSON(http.StatusCreated, newInvoker) + err := ctx.JSON(http.StatusCreated, newInvoker) if err != nil { // Something really bad happened, tell Echo that our handler failed return err @@ -123,41 +127,58 @@ func (im *InvokerManager) PostOnboardedInvokers(ctx echo.Context) error { return nil } -func (im *InvokerManager) DeleteOnboardedInvokersOnboardingId(ctx echo.Context, onboardingId string) error { +func (im *InvokerManager) prepareNewInvoker(newInvoker *invokerapi.APIInvokerEnrolmentDetails) { + var apiList invokerapi.APIList = im.publishRegister.GetAllPublishedServices() + newInvoker.ApiList = &apiList + im.lock.Lock() defer im.lock.Unlock() - delete(im.onboardedInvokers, onboardingId) + newInvoker.PrepareNewInvoker() + + im.onboardedInvokers[*newInvoker.ApiInvokerId] = *newInvoker +} + +// Deletes an individual API Invoker. +func (im *InvokerManager) DeleteOnboardedInvokersOnboardingId(ctx echo.Context, onboardingId string) error { + if _, ok := im.onboardedInvokers[onboardingId]; ok { + im.deleteInvoker(onboardingId) + } + + go im.sendEvent(onboardingId, eventsapi.CAPIFEventAPIINVOKEROFFBOARDED) return ctx.NoContent(http.StatusNoContent) } +func (im *InvokerManager) deleteInvoker(onboardingId string) { + im.lock.Lock() + defer im.lock.Unlock() + delete(im.onboardedInvokers, onboardingId) +} + +// Updates an individual API invoker details. func (im *InvokerManager) PutOnboardedInvokersOnboardingId(ctx echo.Context, onboardingId string) error { var invoker invokerapi.APIInvokerEnrolmentDetails - err := ctx.Bind(&invoker) - if err != nil { - return sendCoreError(ctx, http.StatusBadRequest, "Invalid format for invoker") + errMsg := "Unable to update invoker due to %s" + if err := ctx.Bind(&invoker); err != nil { + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, "invalid format for invoker")) } if onboardingId != *invoker.ApiInvokerId { - return sendCoreError(ctx, http.StatusBadRequest, "Invoker ApiInvokerId not matching") + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, "ApiInvokerId not matching")) } - shouldReturn, coreError := im.validateInvoker(invoker, ctx) - if shouldReturn { - return coreError + if err := im.validateInvoker(invoker, ctx); err != nil { + return sendCoreError(ctx, http.StatusBadRequest, fmt.Sprintf(errMsg, err)) } - im.lock.Lock() - defer im.lock.Unlock() - if _, ok := im.onboardedInvokers[onboardingId]; ok { - im.onboardedInvokers[*invoker.ApiInvokerId] = invoker + im.updateInvoker(invoker) } else { return sendCoreError(ctx, http.StatusNotFound, "The invoker to update has not been onboarded") } - err = ctx.JSON(http.StatusOK, invoker) + err := ctx.JSON(http.StatusOK, invoker) if err != nil { // Something really bad happened, tell Echo that our handler failed return err @@ -166,42 +187,43 @@ func (im *InvokerManager) PutOnboardedInvokersOnboardingId(ctx echo.Context, onb return nil } +func (im *InvokerManager) updateInvoker(invoker invokerapi.APIInvokerEnrolmentDetails) { + im.lock.Lock() + defer im.lock.Unlock() + im.onboardedInvokers[*invoker.ApiInvokerId] = invoker +} + func (im *InvokerManager) ModifyIndApiInvokeEnrolment(ctx echo.Context, onboardingId string) error { return ctx.NoContent(http.StatusNotImplemented) } -func (im *InvokerManager) validateInvoker(invoker invokerapi.APIInvokerEnrolmentDetails, ctx echo.Context) (bool, error) { - if invoker.NotificationDestination == "" { - return true, sendCoreError(ctx, http.StatusBadRequest, "Invoker missing required NotificationDestination") - } - - if invoker.OnboardingInformation.ApiInvokerPublicKey == "" { - return true, sendCoreError(ctx, http.StatusBadRequest, "Invoker missing required OnboardingInformation.ApiInvokerPublicKey") +func (im *InvokerManager) validateInvoker(invoker invokerapi.APIInvokerEnrolmentDetails, ctx echo.Context) error { + if err := invoker.Validate(); err != nil { + return err } - - if !im.areAPIsRegistered(invoker.ApiList) { - return true, sendCoreError(ctx, http.StatusBadRequest, "Some APIs needed by invoker are not registered") + if !im.areAPIsPublished(invoker.ApiList) { + return errors.New("some APIs needed by invoker are not registered") } - return false, nil + return nil } -func (im *InvokerManager) areAPIsRegistered(apis *invokerapi.APIList) bool { +func (im *InvokerManager) areAPIsPublished(apis *invokerapi.APIList) bool { if apis == nil { return true } - return im.apiRegister.AreAPIsRegistered((*[]publishapi.ServiceAPIDescription)(apis)) + return im.publishRegister.AreAPIsPublished((*[]publishapi.ServiceAPIDescription)(apis)) } -func (im *InvokerManager) getId(invokerInfo *string) *string { - idAsString := "api_invoker_id_" - if invokerInfo != nil { - idAsString = idAsString + strings.ReplaceAll(*invokerInfo, " ", "_") - } else { - idAsString = idAsString + strconv.FormatInt(im.nextId, 10) - im.nextId = im.nextId + 1 +func (im *InvokerManager) sendEvent(invokerId string, eventType eventsapi.CAPIFEvent) { + invokerIds := []string{invokerId} + event := eventsapi.EventNotification{ + EventDetail: &eventsapi.CAPIFEventDetail{ + ApiInvokerIds: &invokerIds, + }, + Events: eventType, } - return &idAsString + im.eventChannel <- event } // This function wraps sending of an error in the Error format, and