test/usecases/oruclosedlooprecovery/goversion/main.go

   1 // -
   2 //   ========================LICENSE_START=================================
   3 //   O-RAN-SC
   4 //   %%
   5 //   Copyright (C) 2021: Nordix Foundation
   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         "encoding/json"
  25         "fmt"
  26         "net/http"
  27         "os"
  28         "os/signal"
  29         "syscall"
  30         "time"
  31
  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"
  38 )
  39
  40 type Server interface {
  41         ListenAndServe() error
  42 }
  43
  44 const timeoutHTTPClient = time.Second * 5
  45 const jobId = "14e7bb84-a44d-44c1-90b7-6995a92ad43c"
  46
  47 var jobRegistrationInfo = struct {
  48         InfoTypeId    string      `json:"info_type_id"`
  49         JobResultUri  string      `json:"job_result_uri"`
  50         JobOwner      string      `json:"job_owner"`
  51         JobDefinition interface{} `json:"job_definition"`
  52 }{
  53         InfoTypeId:    "STD_Fault_Messages",
  54         JobResultUri:  "",
  55         JobOwner:      "O-RU Closed Loop Usecase",
  56         JobDefinition: "{}",
  57 }
  58
  59 var client restclient.HTTPClient
  60 var configuration *config.Config
  61 var linkfailureConfig linkfailure.Configuration
  62 var lookupService repository.LookupService
  63 var consumerPort string
  64
  65 func init() {
  66         doInit()
  67 }
  68
  69 func doInit() {
  70         configuration = config.New()
  71
  72         log.SetLevel(configuration.LogLevel)
  73
  74         client = &http.Client{
  75                 Timeout: timeoutHTTPClient,
  76         }
  77
  78         consumerPort = fmt.Sprint(configuration.ConsumerPort)
  79         jobRegistrationInfo.JobResultUri = configuration.ConsumerHost + ":" + consumerPort
  80
  81         linkfailureConfig = linkfailure.Configuration{
  82                 SDNRAddress:  configuration.SDNRHost + ":" + fmt.Sprint(configuration.SDNRPort),
  83                 SDNRUser:     configuration.SDNRUser,
  84                 SDNRPassword: configuration.SDNPassword,
  85         }
  86 }
  87
  88 func main() {
  89         if err := validateConfiguration(configuration); err != nil {
  90                 log.Fatalf("Unable to start consumer due to configuration error: %v", err)
  91         }
  92
  93         csvFileHelper := repository.NewCsvFileHelperImpl()
  94         if initErr := initializeLookupService(csvFileHelper, configuration.ORUToODUMapFile); initErr != nil {
  95                 log.Fatalf("Unable to create LookupService due to inability to get O-RU-ID to O-DU-ID map. Cause: %v", initErr)
  96         }
  97
  98         go func() {
  99                 startServer(&http.Server{
 100                         Addr:    ":" + consumerPort,
 101                         Handler: getRouter(),
 102                 })
 103                 os.Exit(1) // If the startServer function exits, it is because there has been a failure in the server, so we exit.
 104         }()
 105
 106         go func() {
 107                 deleteOnShutdown(make(chan os.Signal, 1))
 108                 os.Exit(0)
 109         }()
 110
 111         keepConsumerAlive()
 112 }
 113
 114 func validateConfiguration(configuration *config.Config) error {
 115         if configuration.ConsumerHost == "" || configuration.ConsumerPort == 0 {
 116                 return fmt.Errorf("consumer host and port must be provided")
 117         }
 118         return nil
 119 }
 120
 121 func initializeLookupService(csvFileHelper repository.CsvFileHelper, csvFile string) error {
 122         lookupService = repository.NewLookupServiceImpl(csvFileHelper, csvFile)
 123         return lookupService.Init()
 124 }
 125
 126 func getRouter() *mux.Router {
 127         messageHandler := linkfailure.NewLinkFailureHandler(lookupService, linkfailureConfig, client)
 128
 129         r := mux.NewRouter()
 130         r.HandleFunc("/", messageHandler.MessagesHandler).Methods(http.MethodPost).Name("messageHandler")
 131         r.HandleFunc("/admin/start", startHandler).Methods(http.MethodPost).Name("start")
 132         r.HandleFunc("/admin/stop", stopHandler).Methods(http.MethodPost).Name("stop")
 133
 134         return r
 135 }
 136
 137 func startServer(server Server) {
 138         if err := server.ListenAndServe(); err != nil {
 139                 log.Errorf("Server stopped unintentionally due to: %v. Deleteing job.", err)
 140                 if deleteErr := deleteJob(); deleteErr != nil {
 141                         log.Error(fmt.Sprintf("Unable to delete consumer job due to: %v. Please remove job %v manually.", deleteErr, jobId))
 142                 }
 143         }
 144 }
 145
 146 func keepConsumerAlive() {
 147         forever := make(chan int)
 148         <-forever
 149 }
 150
 151 func startHandler(w http.ResponseWriter, r *http.Request) {
 152         body, _ := json.Marshal(jobRegistrationInfo)
 153         putErr := restclient.PutWithoutAuth(configuration.InfoCoordinatorAddress+"/data-consumer/v1/info-jobs/"+jobId, body, client)
 154         if putErr != nil {
 155                 http.Error(w, fmt.Sprintf("Unable to register consumer job due to: %v.", putErr), http.StatusBadRequest)
 156                 return
 157         }
 158         log.Debug("Registered job.")
 159 }
 160
 161 func stopHandler(w http.ResponseWriter, r *http.Request) {
 162         deleteErr := deleteJob()
 163         if deleteErr != nil {
 164                 http.Error(w, fmt.Sprintf("Unable to delete consumer job due to: %v. Please remove job %v manually.", deleteErr, jobId), http.StatusBadRequest)
 165                 return
 166         }
 167         log.Debug("Deleted job.")
 168 }
 169
 170 func deleteOnShutdown(s chan os.Signal) {
 171         signal.Notify(s, os.Interrupt)
 172         signal.Notify(s, syscall.SIGTERM)
 173         <-s
 174         log.Info("Shutting down gracefully.")
 175         if err := deleteJob(); err != nil {
 176                 log.Error(fmt.Sprintf("Unable to delete job on shutdown due to: %v. Please remove job %v manually.", err, jobId))
 177         }
 178 }
 179
 180 func deleteJob() error {
 181         return restclient.Delete(configuration.InfoCoordinatorAddress+"/data-consumer/v1/info-jobs/"+jobId, client)
 182 }