manager/cmd/restapi.go

   1 /*
   2  *  Copyright (c) 2020 AT&T Intellectual Property.
   3  *  Copyright (c) 2020 Nokia.
   4  *
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  * This source code is part of the near-RT RIC (RAN Intelligent Controller)
  18  * platform project (RICP).
  19  */
  20
  21 package main
  22
  23 import (
  24         "encoding/json"
  25         "gerrit.o-ran-sc.org/r/ric-plt/alarm-go/alarm"
  26         app "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
  27         "github.com/gorilla/mux"
  28         "net/http"
  29         "strconv"
  30         "time"
  31 )
  32
  33 func (a *AlarmManager) InjectRoutes() {
  34         app.Resource.InjectRoute("/ric/v1/alarms", a.RaiseAlarm, "POST")
  35         app.Resource.InjectRoute("/ric/v1/alarms", a.ClearAlarm, "DELETE")
  36         app.Resource.InjectRoute("/ric/v1/alarms/active", a.GetActiveAlarms, "GET")
  37         app.Resource.InjectRoute("/ric/v1/alarms/history", a.GetAlarmHistory, "GET")
  38         app.Resource.InjectRoute("/ric/v1/alarms/config", a.SetAlarmConfig, "POST")
  39         app.Resource.InjectRoute("/ric/v1/alarms/config", a.GetAlarmConfig, "GET")
  40         app.Resource.InjectRoute("/ric/v1/alarms/define", a.SetAlarmDefinition, "POST")
  41         app.Resource.InjectRoute("/ric/v1/alarms/define/{alarmId}", a.DeleteAlarmDefinition, "DELETE")
  42         app.Resource.InjectRoute("/ric/v1/alarms/define", a.GetAlarmDefinition, "GET")
  43         app.Resource.InjectRoute("/ric/v1/alarms/define/{alarmId}", a.GetAlarmDefinition, "GET")
  44
  45         app.Resource.InjectRoute("/ric/v1/symptomdata", a.SymptomDataHandler, "GET")
  46
  47         a.utils = NewUtils()
  48 }
  49
  50 func (a *AlarmManager) respondWithError(w http.ResponseWriter, code int, message string) {
  51         a.respondWithJSON(w, code, map[string]string{"error": message})
  52 }
  53
  54 func (a *AlarmManager) respondWithJSON(w http.ResponseWriter, code int, payload interface{}) {
  55         w.Header().Set("Content-Type", "application/json")
  56         w.WriteHeader(code)
  57         if payload != nil {
  58                 response, _ := json.Marshal(payload)
  59                 w.Write(response)
  60         }
  61 }
  62
  63 func (a *AlarmManager) GetActiveAlarms(w http.ResponseWriter, r *http.Request) {
  64         app.Logger.Info("GetActiveAlarms: %+v", a.activeAlarms)
  65         a.respondWithJSON(w, http.StatusOK, a.activeAlarms)
  66 }
  67
  68 func (a *AlarmManager) GetAlarmHistory(w http.ResponseWriter, r *http.Request) {
  69         app.Logger.Info("GetAlarmHistory: %+v", a.alarmHistory)
  70         a.respondWithJSON(w, http.StatusOK, a.alarmHistory)
  71 }
  72
  73 func (a *AlarmManager) RaiseAlarm(w http.ResponseWriter, r *http.Request) {
  74         if err := a.doAction(w, r, true); err != nil {
  75                 a.respondWithJSON(w, http.StatusOK, err)
  76         }
  77 }
  78
  79 func (a *AlarmManager) ClearAlarm(w http.ResponseWriter, r *http.Request) {
  80         if err := a.doAction(w, r, false); err != nil {
  81                 a.respondWithJSON(w, http.StatusOK, err)
  82         }
  83 }
  84
  85 func (a *AlarmManager) SetAlarmDefinition(w http.ResponseWriter, r *http.Request) {
  86
  87         app.Logger.Debug("POST arrived for creating alarm definition ")
  88         /* If body is nil then return error */
  89         if r.Body == nil {
  90                 app.Logger.Error("POST - body is empty")
  91                 a.respondWithError(w, http.StatusBadRequest, "No data in request body.")
  92                 return
  93         }
  94         defer r.Body.Close()
  95
  96         /* Parameters are available. Check if they are valid */
  97         var alarmDefinitions RicAlarmDefinitions
  98         err := json.NewDecoder(r.Body).Decode(&alarmDefinitions)
  99         if err != nil {
 100                 app.Logger.Error("POST - received alarm definition  parameters are invalid - " + err.Error())
 101                 a.respondWithError(w, http.StatusBadRequest, "Invalid data in request body.")
 102                 return
 103         }
 104
 105         for _, alarmDefinition := range alarmDefinitions.AlarmDefinitions {
 106                 _, exists := alarm.RICAlarmDefinitions[alarmDefinition.AlarmId]
 107                 if exists {
 108                         app.Logger.Error("POST - alarm definition already exists for %v", alarmDefinition.AlarmId)
 109                 } else {
 110                         ricAlarmDefintion := new(alarm.AlarmDefinition)
 111                         ricAlarmDefintion.AlarmId = alarmDefinition.AlarmId
 112                         ricAlarmDefintion.AlarmText = alarmDefinition.AlarmText
 113                         ricAlarmDefintion.EventType = alarmDefinition.EventType
 114                         ricAlarmDefintion.OperationInstructions = alarmDefinition.OperationInstructions
 115                         ricAlarmDefintion.RaiseDelay = alarmDefinition.RaiseDelay
 116                         ricAlarmDefintion.ClearDelay = alarmDefinition.ClearDelay
 117                         ricAlarmDefintion.TimeToLive = alarmDefinition.TimeToLive
 118                         alarm.RICAlarmDefinitions[alarmDefinition.AlarmId] = ricAlarmDefintion
 119                         app.Logger.Debug("POST - alarm definition added for alarm id %v", alarmDefinition.AlarmId)
 120                 }
 121         }
 122
 123         a.respondWithJSON(w, http.StatusOK, nil)
 124         return
 125 }
 126
 127 func (a *AlarmManager) DeleteAlarmDefinition(w http.ResponseWriter, r *http.Request) {
 128         pathParams := mux.Vars(r)
 129         alarmId, alarmIdok := pathParams["alarmId"]
 130         if alarmIdok {
 131                 if ialarmId, err := strconv.Atoi(alarmId); err == nil {
 132                         delete(alarm.RICAlarmDefinitions, ialarmId)
 133                         app.Logger.Debug("DELETE - alarm definition deleted for alarmId %v", ialarmId)
 134                 } else {
 135                         app.Logger.Error("DELETE - alarmId string to int conversion failed %v", alarmId)
 136                         a.respondWithError(w, http.StatusBadRequest, "Invalid path parameter")
 137                         return
 138                 }
 139         } else {
 140                 app.Logger.Error("DELETE - alarmId does not exist %v", alarmId)
 141                 a.respondWithError(w, http.StatusBadRequest, "Invalid path parameter")
 142                 return
 143
 144         }
 145 }
 146
 147 func (a *AlarmManager) GetAlarmDefinition(w http.ResponseWriter, r *http.Request) {
 148         var ricAlarmDefinitions RicAlarmDefinitions
 149         pathParams := mux.Vars(r)
 150         alarmId, alarmIdok := pathParams["alarmId"]
 151         if alarmIdok {
 152                 if ialarmId, err := strconv.Atoi(alarmId); err == nil {
 153                         alarmDefinition, ok := alarm.RICAlarmDefinitions[ialarmId]
 154                         if ok {
 155                                 app.Logger.Debug("Successfully returned alarm defintion for alarm id %v", ialarmId)
 156                                 a.respondWithJSON(w, http.StatusOK, alarmDefinition)
 157                                 return
 158
 159                         } else {
 160                                 app.Logger.Error("Requested alarm id not found %v", ialarmId)
 161                                 a.respondWithError(w, http.StatusBadRequest, "Non existent alarmId")
 162                                 return
 163                         }
 164                 } else {
 165                         app.Logger.Error("alarmId string to int conversion failed %v", alarmId)
 166                         a.respondWithError(w, http.StatusBadRequest, "Invalid alarmId")
 167                         return
 168                 }
 169         } else {
 170                 app.Logger.Debug("GET arrived for all alarm definitions ")
 171                 for _, alarmDefinition := range alarm.RICAlarmDefinitions {
 172                         ricAlarmDefinitions.AlarmDefinitions = append(ricAlarmDefinitions.AlarmDefinitions, alarmDefinition)
 173                 }
 174                 app.Logger.Debug("Successfully returned all alarm definitions")
 175                 a.respondWithJSON(w, http.StatusOK, ricAlarmDefinitions)
 176         }
 177 }
 178
 179 func (a *AlarmManager) doAction(w http.ResponseWriter, r *http.Request, isRaiseAlarm bool) error {
 180         app.Logger.Info("doAction: request received = %t", isRaiseAlarm)
 181
 182         if r.Body == nil {
 183                 app.Logger.Error("Error: Invalid message body!")
 184                 return nil
 185         }
 186         defer r.Body.Close()
 187
 188         var m alarm.AlarmMessage
 189         if err := json.NewDecoder(r.Body).Decode(&m); err != nil {
 190                 app.Logger.Error("json.NewDecoder failed: %v", err)
 191                 return err
 192         }
 193
 194         if m.Alarm.ManagedObjectId == "" || m.Alarm.ApplicationId == "" || m.AlarmAction == "" {
 195                 app.Logger.Error("Error: Mandatory parameters missing!")
 196                 return nil
 197         }
 198
 199         if m.AlarmTime == 0 {
 200                 m.AlarmTime = time.Now().UnixNano()
 201         }
 202
 203         _, err := a.ProcessAlarm(&AlarmNotification{m, alarm.AlarmDefinition{}})
 204         return err
 205 }
 206
 207 func (a *AlarmManager) HandleViaRmr(d alarm.Alarm, isRaiseAlarm bool) error {
 208         alarmClient, err := alarm.InitAlarm(d.ManagedObjectId, d.ApplicationId)
 209         if err != nil {
 210                 app.Logger.Error("json.NewDecoder failed: %v", err)
 211                 return err
 212         }
 213
 214         alarmData := alarmClient.NewAlarm(d.SpecificProblem, d.PerceivedSeverity, d.AdditionalInfo, d.IdentifyingInfo)
 215         if isRaiseAlarm {
 216                 alarmClient.Raise(alarmData)
 217         } else {
 218                 alarmClient.Clear(alarmData)
 219         }
 220
 221         return nil
 222 }
 223
 224 func (a *AlarmManager) SetAlarmConfig(w http.ResponseWriter, r *http.Request) {
 225         var m alarm.AlarmConfigParams
 226         if err := json.NewDecoder(r.Body).Decode(&m); err != nil {
 227                 app.Logger.Error("json.NewDecoder failed: %v", err)
 228         } else {
 229                 a.maxActiveAlarms = m.MaxActiveAlarms
 230                 a.maxAlarmHistory = m.MaxAlarmHistory
 231                 app.Logger.Debug("new maxActiveAlarms = %v", a.maxActiveAlarms)
 232                 app.Logger.Debug("new maxAlarmHistory = %v", a.maxAlarmHistory)
 233                 a.respondWithJSON(w, http.StatusOK, err)
 234         }
 235 }
 236
 237 func (a *AlarmManager) GetAlarmConfig(w http.ResponseWriter, r *http.Request) {
 238         var m alarm.AlarmConfigParams
 239
 240         m.MaxActiveAlarms = a.maxActiveAlarms
 241         m.MaxAlarmHistory = a.maxAlarmHistory
 242
 243         a.respondWithJSON(w, http.StatusOK, m)
 244         return
 245 }
 246
 247 func (a *AlarmManager) SymptomDataHandler(w http.ResponseWriter, r *http.Request) {
 248         baseDir := "/tmp/symptomdata/"
 249         if err := a.utils.CreateDir(baseDir); err != nil {
 250                 a.utils.SendSymptomDataError(w, r, "CreateDir failed: "+err.Error())
 251                 return
 252         }
 253
 254         if b, err := json.Marshal(a.activeAlarms); err == nil {
 255                 if err := a.utils.WriteToFile(baseDir+"active_alarms.json", string(b)); err != nil {
 256                         a.utils.SendSymptomDataError(w, r, "writeToFile failed: "+err.Error())
 257                         return
 258                 }
 259         }
 260
 261         if b, err := json.Marshal(a.alarmHistory); err == nil {
 262                 if err := a.utils.WriteToFile(baseDir+"alarm_history.json", string(b)); err != nil {
 263                         a.utils.SendSymptomDataError(w, r, "writeToFile failed: "+err.Error())
 264                         return
 265                 }
 266         }
 267
 268         var ac alarm.AlarmConfigParams
 269         ac.MaxActiveAlarms = a.maxActiveAlarms
 270         ac.MaxAlarmHistory = a.maxAlarmHistory
 271
 272         if b, err := json.Marshal(ac); err == nil {
 273                 if err := a.utils.WriteToFile(baseDir+"alarm_config.json", string(b)); err != nil {
 274                         a.utils.SendSymptomDataError(w, r, "writeToFile failed: "+err.Error())
 275                         return
 276                 }
 277         }
 278
 279         var ad RicAlarmDefinitions
 280         for _, alarmDefinition := range alarm.RICAlarmDefinitions {
 281                 ad.AlarmDefinitions = append(ad.AlarmDefinitions, alarmDefinition)
 282         }
 283         if b, err := json.Marshal(ad); err == nil {
 284                 if err := a.utils.WriteToFile(baseDir+"alarm_defs.json", string(b)); err != nil {
 285                         a.utils.SendSymptomDataError(w, r, "writeToFile failed: "+err.Error())
 286                         return
 287                 }
 288         }
 289
 290         a.utils.SendSymptomDataFile(w, r, baseDir, "symptomdata.zip")
 291 }