NONRTRIC-998: Servicemanager - Add API Docs
[nonrtric/plt/sme.git] / servicemanager / main.go
1 // -
2 //   ========================LICENSE_START=================================
3 //   O-RAN-SC
4 //   %%
5 //   Copyright (C) 2023-2024: OpenInfra Foundation Europe
6 //   %%
7 //   Licensed under the Apache License, Version 2.0 (the "License");
8 //   you may not use this file except in compliance with the License.
9 //   You may obtain a copy of the License at
10 //
11 //        http://www.apache.org/licenses/LICENSE-2.0
12 //
13 //   Unless required by applicable law or agreed to in writing, software
14 //   distributed under the License is distributed on an "AS IS" BASIS,
15 //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 //   See the License for the specific language governing permissions and
17 //   limitations under the License.
18 //   ========================LICENSE_END===================================
19 //
20
21 package main
22
23 import (
24         "fmt"
25         "net/http"
26
27         "github.com/getkin/kin-openapi/openapi3"
28
29         "github.com/deepmap/oapi-codegen/pkg/middleware"
30         echo "github.com/labstack/echo/v4"
31         echomiddleware "github.com/labstack/echo/v4/middleware"
32         log "github.com/sirupsen/logrus"
33
34         "oransc.org/nonrtric/servicemanager/internal/common29122"
35         "oransc.org/nonrtric/servicemanager/internal/envreader"
36
37         "oransc.org/nonrtric/servicemanager/internal/discoverserviceapi"
38         "oransc.org/nonrtric/servicemanager/internal/invokermanagementapi"
39         "oransc.org/nonrtric/servicemanager/internal/providermanagementapi"
40         "oransc.org/nonrtric/servicemanager/internal/publishserviceapi"
41
42         "oransc.org/nonrtric/servicemanager/internal/discoverservice"
43         "oransc.org/nonrtric/servicemanager/internal/invokermanagement"
44         "oransc.org/nonrtric/servicemanager/internal/providermanagement"
45         "oransc.org/nonrtric/servicemanager/internal/publishservice"
46 )
47
48 func main() {
49         realConfigReader := &envreader.RealConfigReader{}
50         myEnv, myPorts, err := realConfigReader.ReadDotEnv()
51         if err != nil {
52                 log.Fatal("error loading environment file")
53                 return
54         }
55
56         eServiceManager := echo.New()
57         err = registerHandlers(eServiceManager, myEnv, myPorts)
58
59         if err != nil {
60                 log.Fatal("registerHandlers fatal error")
61                 return
62         }
63
64         port := myPorts["SERVICE_MANAGER_PORT"]
65
66         go startWebServer(eServiceManager, port)
67         log.Info("server started and listening on port: ", port)
68         keepServerAlive()
69 }
70
71 func registerHandlers(e *echo.Echo, myEnv map[string]string, myPorts map[string]int) (err error) {
72         // Log all requests
73         e.Use(echomiddleware.Logger())
74
75         capifProtocol := myEnv["CAPIF_PROTOCOL"]
76         capifIPv4 := common29122.Ipv4Addr(myEnv["CAPIF_IPV4"])
77         capifPort := common29122.Port(myPorts["CAPIF_PORT"])
78         kongDomain := myEnv["KONG_DOMAIN"]
79         kongProtocol := myEnv["KONG_PROTOCOL"]
80         kongControlPlaneIPv4 := common29122.Ipv4Addr(myEnv["KONG_CONTROL_PLANE_IPV4"])
81         kongControlPlanePort := common29122.Port(myPorts["KONG_CONTROL_PLANE_PORT"])
82         kongDataPlaneIPv4 := common29122.Ipv4Addr(myEnv["KONG_DATA_PLANE_IPV4"])
83         kongDataPlanePort := common29122.Port(myPorts["KONG_DATA_PLANE_PORT"])
84
85         var group *echo.Group
86
87         // Register ProviderManagement
88         providerManagerSwagger, err := providermanagementapi.GetSwagger()
89         if err != nil {
90                 log.Fatalf("error loading ProviderManagement swagger spec\n: %s", err)
91                 return err
92         }
93         providerManagerSwagger.Servers = nil
94         providerManager := providermanagement.NewProviderManager(capifProtocol, capifIPv4, capifPort)
95         group = e.Group("/api-provider-management/v1")
96         group.Use(middleware.OapiRequestValidator(providerManagerSwagger))
97         providermanagementapi.RegisterHandlersWithBaseURL(e, providerManager, "/api-provider-management/v1")
98
99         // Register PublishService
100         publishServiceSwagger, err := publishserviceapi.GetSwagger()
101         if err != nil {
102                 log.Fatalf("error loading PublishService swagger spec\n: %s", err)
103                 return err
104         }
105         publishServiceSwagger.Servers = nil
106         publishService := publishservice.NewPublishService(
107                 kongDomain, kongProtocol,
108                 kongControlPlaneIPv4, kongControlPlanePort,
109                 kongDataPlaneIPv4, kongDataPlanePort,
110                 capifProtocol, capifIPv4, capifPort)
111
112         group = e.Group("/published-apis/v1")
113         group.Use(middleware.OapiRequestValidator(publishServiceSwagger))
114         publishserviceapi.RegisterHandlersWithBaseURL(e, publishService, "/published-apis/v1")
115
116         // Register InvokerManagement
117         invokerManagerSwagger, err := invokermanagementapi.GetSwagger()
118         if err != nil {
119                 log.Fatalf("error loading InvokerManagement swagger spec\n: %s", err)
120                 return err
121         }
122         invokerManagerSwagger.Servers = nil
123         invokerManager := invokermanagement.NewInvokerManager(capifProtocol, capifIPv4, capifPort)
124         group = e.Group("/api-invoker-management/v1")
125         group.Use(middleware.OapiRequestValidator(invokerManagerSwagger))
126         invokermanagementapi.RegisterHandlersWithBaseURL(e, invokerManager, "/api-invoker-management/v1")
127
128         // Register DiscoverService
129         discoverServiceSwagger, err := discoverserviceapi.GetSwagger()
130         if err != nil {
131                 log.Fatalf("error loading DiscoverService swagger spec\n: %s", err)
132                 return err
133         }
134
135         discoverServiceSwagger.Servers = nil
136         discoverService := discoverservice.NewDiscoverService(capifProtocol, capifIPv4, capifPort)
137
138         group = e.Group("/service-apis/v1")
139         group.Use(middleware.OapiRequestValidator(discoverServiceSwagger))
140         discoverserviceapi.RegisterHandlersWithBaseURL(e, discoverService, "/service-apis/v1")
141
142         e.GET("/", hello)
143         e.GET("/swagger/:apiName", getSwagger)
144
145         return err
146 }
147
148 func startWebServer(e *echo.Echo, port int) {
149         e.Logger.Fatal(e.Start(fmt.Sprintf("0.0.0.0:%d", port)))
150 }
151
152 func keepServerAlive() {
153         forever := make(chan int)
154         <-forever
155 }
156
157 func hello(c echo.Context) error {
158         return c.String(http.StatusOK, "Hello, World!")
159 }
160
161 func getSwagger(c echo.Context) error {
162         var swagger *openapi3.T
163         var err error
164         switch api := c.Param("apiName"); api {
165         case "provider":
166                 swagger, err = providermanagementapi.GetSwagger()
167         case "publish":
168                 swagger, err = publishserviceapi.GetSwagger()
169         case "invoker":
170                 swagger, err = invokermanagementapi.GetSwagger()
171         case "discover":
172                 swagger, err = discoverserviceapi.GetSwagger()
173         default:
174                 return c.JSON(http.StatusBadRequest, getProblemDetails("Invalid API name "+api, http.StatusBadRequest))
175         }
176         if err != nil {
177                 return c.JSON(http.StatusInternalServerError, getProblemDetails("Unable to get swagger for API", http.StatusInternalServerError))
178         }
179         return c.JSON(http.StatusOK, swagger)
180 }
181
182 func getProblemDetails(cause string, status int) common29122.ProblemDetails {
183         return common29122.ProblemDetails{
184                 Cause:  &cause,
185                 Status: &status,
186         }
187 }