Improve locking
[nonrtric/plt/sme.git] / capifcore / internal / invokermanagement / invokermanagement.go
index 1d8582d..9025f83 100644 (file)
@@ -27,6 +27,7 @@ import (
        "strings"
        "sync"
 
+       "oransc.org/nonrtric/capifcore/internal/eventsapi"
        publishapi "oransc.org/nonrtric/capifcore/internal/publishserviceapi"
 
        "oransc.org/nonrtric/capifcore/internal/common29122"
@@ -39,22 +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,
        }
 }
 
@@ -77,6 +88,19 @@ func (im *InvokerManager) VerifyInvokerSecret(invokerId, secret string) bool {
        return verified
 }
 
+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 {
+               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)
@@ -89,19 +113,9 @@ func (im *InvokerManager) PostOnboardedInvokers(ctx echo.Context) error {
                return coreError
        }
 
-       im.lock.Lock()
-       defer im.lock.Unlock()
+       im.prepareNewInvoker(&newInvoker)
 
-       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.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))
@@ -114,15 +128,47 @@ 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) {
        im.lock.Lock()
        defer im.lock.Unlock()
 
-       delete(im.onboardedInvokers, onboardingId)
+       newInvoker.ApiInvokerId = im.getId(newInvoker.ApiInvokerInformation)
+       newInvoker.OnboardingInformation.OnboardingSecret = getOnboardingSecret(*newInvoker)
+
+       var apiList invokerapi.APIList = im.publishRegister.GetAllPublishedServices()
+       newInvoker.ApiList = &apiList
+
+       im.onboardedInvokers[*newInvoker.ApiInvokerId] = *newInvoker
+}
+
+func getOnboardingSecret(newInvoker invokerapi.APIInvokerEnrolmentDetails) *string {
+       onboardingSecret := "onboarding_secret_"
+       if newInvoker.ApiInvokerInformation != nil {
+               onboardingSecret = onboardingSecret + strings.ReplaceAll(*newInvoker.ApiInvokerInformation, " ", "_")
+       } else {
+               onboardingSecret = onboardingSecret + *newInvoker.ApiInvokerId
+       }
+       return &onboardingSecret
+}
+
+// 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)
@@ -139,11 +185,8 @@ func (im *InvokerManager) PutOnboardedInvokersOnboardingId(ctx echo.Context, onb
                return coreError
        }
 
-       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")
        }
@@ -157,6 +200,12 @@ 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)
 }
@@ -170,18 +219,18 @@ func (im *InvokerManager) validateInvoker(invoker invokerapi.APIInvokerEnrolment
                return true, sendCoreError(ctx, http.StatusBadRequest, "Invoker missing required OnboardingInformation.ApiInvokerPublicKey")
        }
 
-       if !im.areAPIsRegistered(invoker.ApiList) {
+       if !im.areAPIsPublished(invoker.ApiList) {
                return true, sendCoreError(ctx, http.StatusBadRequest, "Some APIs needed by invoker are not registered")
        }
 
        return false, 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 {
@@ -195,6 +244,17 @@ func (im *InvokerManager) getId(invokerInfo *string) *string {
        return &idAsString
 }
 
+func (im *InvokerManager) sendEvent(invokerId string, eventType eventsapi.CAPIFEvent) {
+       invokerIds := []string{invokerId}
+       event := eventsapi.EventNotification{
+               EventDetail: &eventsapi.CAPIFEventDetail{
+                       ApiInvokerIds: &invokerIds,
+               },
+               Events: eventType,
+       }
+       im.eventChannel <- event
+}
+
 // This function wraps sending of an error in the Error format, and
 // handling the failure to marshal that.
 func sendCoreError(ctx echo.Context, code int, message string) error {