2 // ========================LICENSE_START=================================
5 // Copyright (C) 2021: Nordix Foundation
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
11 // http://www.apache.org/licenses/LICENSE-2.0
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===================================
32 "github.com/gorilla/mux"
33 log "github.com/sirupsen/logrus"
34 "oransc.org/usecase/oruclosedloop/internal/config"
35 "oransc.org/usecase/oruclosedloop/internal/linkfailure"
36 "oransc.org/usecase/oruclosedloop/internal/repository"
37 "oransc.org/usecase/oruclosedloop/internal/restclient"
40 type Server interface {
41 ListenAndServe() error
44 const jobId = "14e7bb84-a44d-44c1-90b7-6995a92ad43c"
46 var jobRegistrationInfo = struct {
47 InfoTypeId string `json:"info_type_id"`
48 JobResultUri string `json:"job_result_uri"`
49 JobOwner string `json:"job_owner"`
50 JobDefinition interface{} `json:"job_definition"`
52 InfoTypeId: "STD_Fault_Messages",
54 JobOwner: "O-RU Closed Loop Usecase",
58 var client restclient.HTTPClient
59 var configuration *config.Config
60 var linkfailureConfig linkfailure.Configuration
61 var lookupService repository.LookupService
62 var consumerPort string
69 configuration = config.New()
71 log.SetLevel(configuration.LogLevel)
72 log.Debug("Using configuration: ", configuration)
74 consumerPort = fmt.Sprint(configuration.ConsumerPort)
75 jobRegistrationInfo.JobResultUri = configuration.ConsumerHost + ":" + consumerPort
77 linkfailureConfig = linkfailure.Configuration{
78 SDNRAddress: configuration.SDNRAddress,
79 SDNRUser: configuration.SDNRUser,
80 SDNRPassword: configuration.SDNPassword,
85 if err := validateConfiguration(configuration); err != nil {
86 log.Fatalf("Unable to start consumer due to configuration error: %v", err)
89 csvFileHelper := repository.NewCsvFileHelperImpl()
90 if initErr := initializeLookupService(csvFileHelper, configuration.ORUToODUMapFile); initErr != nil {
91 log.Fatalf("Unable to create LookupService due to inability to get O-RU-ID to O-DU-ID map. Cause: %v", initErr)
94 var cert tls.Certificate
95 if c, err := restclient.CreateClientCertificate(configuration.ConsumerCertPath, configuration.ConsumerKeyPath); err == nil {
98 log.Fatalf("Stopping producer due to error: %v", err)
100 client = restclient.CreateRetryClient(cert)
104 os.Exit(1) // If the startServer function exits, it is because there has been a failure in the server, so we exit.
108 deleteOnShutdown(make(chan os.Signal, 1))
115 func validateConfiguration(configuration *config.Config) error {
116 if configuration.ConsumerHost == "" || configuration.ConsumerPort == 0 {
117 return fmt.Errorf("consumer host and port must be provided")
120 if configuration.ConsumerCertPath == "" || configuration.ConsumerKeyPath == "" {
121 return fmt.Errorf("missing CONSUMER_CERT and/or CONSUMER_KEY")
127 func initializeLookupService(csvFileHelper repository.CsvFileHelper, csvFile string) error {
128 lookupService = repository.NewLookupServiceImpl(csvFileHelper, csvFile)
129 return lookupService.Init()
132 func getRouter() *mux.Router {
133 messageHandler := linkfailure.NewLinkFailureHandler(lookupService, linkfailureConfig, client)
136 r.HandleFunc("/", messageHandler.MessagesHandler).Methods(http.MethodPost).Name("messageHandler")
137 r.HandleFunc("/admin/start", startHandler).Methods(http.MethodPost).Name("start")
138 r.HandleFunc("/admin/stop", stopHandler).Methods(http.MethodPost).Name("stop")
145 if restclient.IsUrlSecure(configuration.ConsumerHost) {
146 err = http.ListenAndServeTLS(fmt.Sprintf(":%v", configuration.ConsumerPort), configuration.ConsumerCertPath, configuration.ConsumerKeyPath, getRouter())
148 err = http.ListenAndServe(fmt.Sprintf(":%v", configuration.ConsumerPort), getRouter())
151 log.Errorf("Server stopped unintentionally due to: %v. Deleteing job.", err)
152 if deleteErr := deleteJob(); deleteErr != nil {
153 log.Error(fmt.Sprintf("Unable to delete consumer job due to: %v. Please remove job %v manually.", deleteErr, jobId))
158 func keepConsumerAlive() {
159 forever := make(chan int)
163 func startHandler(w http.ResponseWriter, r *http.Request) {
164 body, _ := json.Marshal(jobRegistrationInfo)
165 putErr := restclient.PutWithoutAuth(configuration.InfoCoordinatorAddress+"/data-consumer/v1/info-jobs/"+jobId, body, client)
167 http.Error(w, fmt.Sprintf("Unable to register consumer job due to: %v.", putErr), http.StatusBadRequest)
170 log.Debug("Registered job.")
173 func stopHandler(w http.ResponseWriter, r *http.Request) {
174 deleteErr := deleteJob()
175 if deleteErr != nil {
176 http.Error(w, fmt.Sprintf("Unable to delete consumer job due to: %v. Please remove job %v manually.", deleteErr, jobId), http.StatusBadRequest)
179 log.Debug("Deleted job.")
182 func deleteOnShutdown(s chan os.Signal) {
183 signal.Notify(s, os.Interrupt)
184 signal.Notify(s, syscall.SIGTERM)
186 log.Info("Shutting down gracefully.")
187 if err := deleteJob(); err != nil {
188 log.Error(fmt.Sprintf("Unable to delete job on shutdown due to: %v. Please remove job %v manually.", err, jobId))
192 func deleteJob() error {
193 return restclient.Delete(configuration.InfoCoordinatorAddress+"/data-consumer/v1/info-jobs/"+jobId, client)