capifcore/capifcore.go

   1 // -
   2 //   ========================LICENSE_START=================================
   3 //   O-RAN-SC
   4 //   %%
   5 //   Copyright (C) 2022-2023: Nordix Foundation. All rights reserved.
   6 //   Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved.
   7 //   %%
   8 //   Licensed under the Apache License, Version 2.0 (the "License");
   9 //   you may not use this file except in compliance with the License.
  10 //   You may obtain a copy of the License at
  11 //
  12 //        http://www.apache.org/licenses/LICENSE-2.0
  13 //
  14 //   Unless required by applicable law or agreed to in writing, software
  15 //   distributed under the License is distributed on an "AS IS" BASIS,
  16 //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17 //   See the License for the specific language governing permissions and
  18 //   limitations under the License.
  19 //   ========================LICENSE_END===================================
  20 //
  21
  22 package capifcore
  23
  24 import (
  25         "net/http"
  26
  27         "github.com/getkin/kin-openapi/openapi3"
  28         "github.com/labstack/echo/v4"
  29         "oransc.org/nonrtric/capifcore/internal/common29122"
  30         "oransc.org/nonrtric/capifcore/internal/discoverserviceapi"
  31         "oransc.org/nonrtric/capifcore/internal/eventsapi"
  32         "oransc.org/nonrtric/capifcore/internal/invokermanagementapi"
  33         "oransc.org/nonrtric/capifcore/internal/providermanagementapi"
  34         "oransc.org/nonrtric/capifcore/internal/securityapi"
  35
  36         "github.com/deepmap/oapi-codegen/pkg/middleware"
  37         echomiddleware "github.com/labstack/echo/v4/middleware"
  38         log "github.com/sirupsen/logrus"
  39         "oransc.org/nonrtric/capifcore/internal/helmmanagement"
  40
  41         "oransc.org/nonrtric/capifcore/internal/discoverservice"
  42         "oransc.org/nonrtric/capifcore/internal/eventservice"
  43         "oransc.org/nonrtric/capifcore/internal/invokermanagement"
  44         "oransc.org/nonrtric/capifcore/internal/providermanagement"
  45         "oransc.org/nonrtric/capifcore/internal/publishservice"
  46         "oransc.org/nonrtric/capifcore/internal/publishserviceapi"
  47         security "oransc.org/nonrtric/capifcore/internal/securityservice"
  48         "oransc.org/nonrtric/capifcore/internal/keycloak"
  49 )
  50
  51 func RegisterHandlers(e *echo.Echo, helmManager helmmanagement.HelmManager, km *keycloak.KeycloakManager) {
  52         // Log all requests
  53         e.Use(echomiddleware.Logger())
  54
  55         var group *echo.Group
  56         // Register ProviderManagement
  57         providerManagerSwagger, err := providermanagementapi.GetSwagger()
  58         if err != nil {
  59                 log.Fatalf("Error loading ProviderManagement swagger spec\n: %s", err)
  60         }
  61         providerManagerSwagger.Servers = nil
  62         providerManager := providermanagement.NewProviderManager()
  63         group = e.Group("/api-provider-management/v1")
  64         group.Use(middleware.OapiRequestValidator(providerManagerSwagger))
  65         providermanagementapi.RegisterHandlersWithBaseURL(e, providerManager, "/api-provider-management/v1")
  66
  67         // Register EventService
  68         eventServiceSwagger, err := eventsapi.GetSwagger()
  69         if err != nil {
  70                 log.Fatalf("Error loading EventService swagger spec\n: %s", err)
  71         }
  72         eventServiceSwagger.Servers = nil
  73         eventService := eventservice.NewEventService(&http.Client{})
  74         group = e.Group("/capif-events/v1")
  75         group.Use(middleware.OapiRequestValidator(eventServiceSwagger))
  76         eventsapi.RegisterHandlersWithBaseURL(e, eventService, "/capif-events/v1")
  77         eventChannel := eventService.GetNotificationChannel()
  78
  79         // Register PublishService
  80         publishServiceSwagger, err := publishserviceapi.GetSwagger()
  81         if err != nil {
  82                 log.Fatalf("Error loading PublishService swagger spec\n: %s", err)
  83         }
  84         publishServiceSwagger.Servers = nil
  85         publishService := publishservice.NewPublishService(providerManager, helmManager, eventChannel)
  86         group = e.Group("/published-apis/v1")
  87         group.Use(middleware.OapiRequestValidator(publishServiceSwagger))
  88         publishserviceapi.RegisterHandlersWithBaseURL(e, publishService, "/published-apis/v1")
  89
  90         // Register InvokerManagement
  91         invokerManagerSwagger, err := invokermanagementapi.GetSwagger()
  92         if err != nil {
  93                 log.Fatalf("Error loading InvokerManagement swagger spec\n: %s", err)
  94         }
  95         invokerManagerSwagger.Servers = nil
  96         invokerManager := invokermanagement.NewInvokerManager(publishService, km, eventChannel)
  97         group = e.Group("/api-invoker-management/v1")
  98         group.Use(middleware.OapiRequestValidator(invokerManagerSwagger))
  99         invokermanagementapi.RegisterHandlersWithBaseURL(e, invokerManager, "/api-invoker-management/v1")
 100
 101         // Register DiscoverService
 102         discoverServiceSwagger, err := discoverserviceapi.GetSwagger()
 103         if err != nil {
 104                 log.Fatalf("Error loading DiscoverService swagger spec\n: %s", err)
 105         }
 106         discoverServiceSwagger.Servers = nil
 107         discoverService := discoverservice.NewDiscoverService(invokerManager)
 108         group = e.Group("/service-apis/v1")
 109         group.Use(middleware.OapiRequestValidator(discoverServiceSwagger))
 110         discoverserviceapi.RegisterHandlersWithBaseURL(e, discoverService, "/service-apis/v1")
 111
 112         // Register Security
 113         securitySwagger, err := securityapi.GetSwagger()
 114         if err != nil {
 115                 log.Fatalf("Error loading Security swagger spec\n: %s", err)
 116         }
 117         securitySwagger.Servers = nil
 118         securityService := security.NewSecurity(providerManager, publishService, invokerManager, km)
 119         group = e.Group("/capif-security/v1")
 120         group.Use(middleware.OapiRequestValidator(securitySwagger))
 121         securityapi.RegisterHandlersWithBaseURL(e, securityService, "/capif-security/v1")
 122
 123         e.GET("/", hello)
 124
 125         e.GET("/swagger/:apiName", getSwagger)
 126 }
 127
 128 func hello(c echo.Context) error {
 129         return c.String(http.StatusOK, "Hello, World!")
 130 }
 131
 132 func getSwagger(c echo.Context) error {
 133         var swagger *openapi3.T
 134         var err error
 135         switch api := c.Param("apiName"); api {
 136         case "provider":
 137                 swagger, err = providermanagementapi.GetSwagger()
 138         case "publish":
 139                 swagger, err = publishserviceapi.GetSwagger()
 140         case "invoker":
 141                 swagger, err = invokermanagementapi.GetSwagger()
 142         case "discover":
 143                 swagger, err = discoverserviceapi.GetSwagger()
 144         case "events":
 145                 swagger, err = eventsapi.GetSwagger()
 146         case "security":
 147                 swagger, err = securityapi.GetSwagger()
 148         default:
 149                 return c.JSON(http.StatusBadRequest, getProblemDetails("Invalid API name "+api, http.StatusBadRequest))
 150         }
 151         if err != nil {
 152                 return c.JSON(http.StatusInternalServerError, getProblemDetails("Unable to get swagger for API", http.StatusInternalServerError))
 153         }
 154         return c.JSON(http.StatusOK, swagger)
 155 }
 156
 157 func getProblemDetails(cause string, status int) common29122.ProblemDetails {
 158         return common29122.ProblemDetails{
 159                 Cause:  &cause,
 160                 Status: &status,
 161         }
 162 }