b8946df5acdd06c49a3bdafdc4b59c161961b8d3
[ric-plt/alarm-go.git] / 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) respondWithError(w http.ResponseWriter, code int, message string) {
34         a.respondWithJSON(w, code, map[string]string{"error": message})
35 }
36
37 func (a *AlarmManager) respondWithJSON(w http.ResponseWriter, code int, payload interface{}) {
38         w.Header().Set("Content-Type", "application/json")
39         w.WriteHeader(code)
40         if payload != nil {
41                 response, _ := json.Marshal(payload)
42                 w.Write(response)
43         }
44 }
45
46 func (a *AlarmManager) GetActiveAlarms(w http.ResponseWriter, r *http.Request) {
47         app.Logger.Info("GetActiveAlarms: %+v", a.activeAlarms)
48         a.respondWithJSON(w, http.StatusOK, a.activeAlarms)
49 }
50
51 func (a *AlarmManager) GetAlarmHistory(w http.ResponseWriter, r *http.Request) {
52         app.Logger.Info("GetAlarmHistory: %+v", a.alarmHistory)
53         a.respondWithJSON(w, http.StatusOK, a.alarmHistory)
54 }
55
56 func (a *AlarmManager) RaiseAlarm(w http.ResponseWriter, r *http.Request) {
57         if err := a.doAction(w, r, true); err != nil {
58                 a.respondWithJSON(w, http.StatusOK, err)
59         }
60 }
61
62 func (a *AlarmManager) ClearAlarm(w http.ResponseWriter, r *http.Request) {
63         if err := a.doAction(w, r, false); err != nil {
64                 a.respondWithJSON(w, http.StatusOK, err)
65         }
66 }
67
68 func (a *AlarmManager) SetAlarmDefinition(w http.ResponseWriter, r *http.Request) {
69
70         app.Logger.Debug("POST arrived for creating alarm definition ")
71         /* If body is nil then return error */
72         if r.Body == nil {
73                 app.Logger.Error("POST - body is empty")
74                 a.respondWithError(w, http.StatusBadRequest, "No data in request body.")
75                 return
76         }
77         defer r.Body.Close()
78
79         /* Parameters are available. Check if they are valid */
80         var alarmDefinitions RicAlarmDefinitions
81         err := json.NewDecoder(r.Body).Decode(&alarmDefinitions)
82         if err != nil {
83                 app.Logger.Error("POST - received alarm definition  parameters are invalid - " + err.Error())
84                 a.respondWithError(w, http.StatusBadRequest, "Invalid data in request body.")
85                 return
86         }
87
88         for _, alarmDefinition := range alarmDefinitions.AlarmDefinitions {
89                 _, exists := alarm.RICAlarmDefinitions[alarmDefinition.AlarmId]
90                 if exists {
91                         app.Logger.Error("POST - alarm definition already exists for %v", alarmDefinition.AlarmId)
92                 } else {
93                         ricAlarmDefintion := new(alarm.AlarmDefinition)
94                         ricAlarmDefintion.AlarmId = alarmDefinition.AlarmId
95                         ricAlarmDefintion.AlarmText = alarmDefinition.AlarmText
96                         ricAlarmDefintion.EventType = alarmDefinition.EventType
97                         ricAlarmDefintion.OperationInstructions = alarmDefinition.OperationInstructions
98                         ricAlarmDefintion.RaiseDelay = alarmDefinition.RaiseDelay
99                         ricAlarmDefintion.ClearDelay = alarmDefinition.ClearDelay
100                         alarm.RICAlarmDefinitions[alarmDefinition.AlarmId] = ricAlarmDefintion
101                         app.Logger.Debug("POST - alarm definition added for alarm id %v", alarmDefinition.AlarmId)
102                 }
103         }
104
105         a.respondWithJSON(w, http.StatusOK, nil)
106         return
107 }
108
109 func (a *AlarmManager) DeleteAlarmDefinition(w http.ResponseWriter, r *http.Request) {
110         pathParams := mux.Vars(r)
111         alarmId, alarmIdok := pathParams["alarmId"]
112         if alarmIdok {
113                 if ialarmId, err := strconv.Atoi(alarmId); err == nil {
114                         delete(alarm.RICAlarmDefinitions, ialarmId)
115                         app.Logger.Debug("DELETE - alarm definition deleted for alarmId %v", ialarmId)
116                 } else {
117                         app.Logger.Error("DELETE - alarmId string to int conversion failed %v", alarmId)
118                         a.respondWithError(w, http.StatusBadRequest, "Invalid path parameter")
119                         return
120                 }
121         } else {
122                 app.Logger.Error("DELETE - alarmId does not exist %v", alarmId)
123                 a.respondWithError(w, http.StatusBadRequest, "Invalid path parameter")
124                 return
125
126         }
127 }
128
129 func (a *AlarmManager) GetAlarmDefinition(w http.ResponseWriter, r *http.Request) {
130         var ricAlarmDefinitions RicAlarmDefinitions
131         pathParams := mux.Vars(r)
132         alarmId, alarmIdok := pathParams["alarmId"]
133         if alarmIdok {
134                 if ialarmId, err := strconv.Atoi(alarmId); err == nil {
135                         alarmDefinition, ok := alarm.RICAlarmDefinitions[ialarmId]
136                         if ok {
137                                 app.Logger.Debug("Successfully returned alarm defintion for alarm id %v", ialarmId)
138                                 a.respondWithJSON(w, http.StatusOK, alarmDefinition)
139                                 return
140
141                         } else {
142                                 app.Logger.Error("Requested alarm id not found %v", ialarmId)
143                                 a.respondWithError(w, http.StatusBadRequest, "Non existent alarmId")
144                                 return
145                         }
146                 } else {
147                         app.Logger.Error("alarmId string to int conversion failed %v", alarmId)
148                         a.respondWithError(w, http.StatusBadRequest, "Invalid alarmId")
149                         return
150                 }
151         } else {
152                 app.Logger.Debug("GET arrived for all alarm definitions ")
153                 for _, alarmDefinition := range alarm.RICAlarmDefinitions {
154                         ricAlarmDefinitions.AlarmDefinitions = append(ricAlarmDefinitions.AlarmDefinitions, alarmDefinition)
155                 }
156                 app.Logger.Debug("Successfully returned all alarm definitions")
157                 a.respondWithJSON(w, http.StatusOK, ricAlarmDefinitions)
158         }
159 }
160
161 func (a *AlarmManager) doAction(w http.ResponseWriter, r *http.Request, isRaiseAlarm bool) error {
162         app.Logger.Info("doAction: request received = %t", isRaiseAlarm)
163
164         if r.Body == nil {
165                 app.Logger.Error("Error: Invalid message body!")
166                 return nil
167         }
168         defer r.Body.Close()
169
170         var m alarm.AlarmMessage
171         if err := json.NewDecoder(r.Body).Decode(&m); err != nil {
172                 app.Logger.Error("json.NewDecoder failed: %v", err)
173                 return err
174         }
175
176         if m.Alarm.ManagedObjectId == "" || m.Alarm.ApplicationId == "" || m.AlarmAction == "" {
177                 app.Logger.Error("Error: Mandatory parameters missing!")
178                 return nil
179         }
180
181         if m.AlarmTime == 0 {
182                 m.AlarmTime = time.Now().UnixNano()
183         }
184
185         _, err := a.ProcessAlarm(&AlarmNotification{m, alarm.AlarmDefinition{}})
186         return err
187 }
188
189 func (a *AlarmManager) HandleViaRmr(d alarm.Alarm, isRaiseAlarm bool) error {
190         alarmClient, err := alarm.InitAlarm(d.ManagedObjectId, d.ApplicationId)
191         if err != nil {
192                 app.Logger.Error("json.NewDecoder failed: %v", err)
193                 return err
194         }
195
196         alarmData := alarmClient.NewAlarm(d.SpecificProblem, d.PerceivedSeverity, d.AdditionalInfo, d.IdentifyingInfo)
197         if isRaiseAlarm {
198                 alarmClient.Raise(alarmData)
199         } else {
200                 alarmClient.Clear(alarmData)
201         }
202
203         return nil
204 }
205
206 func (a *AlarmManager) SetAlarmConfig(w http.ResponseWriter, r *http.Request) {
207         var m alarm.AlarmConfigParams
208         if err := json.NewDecoder(r.Body).Decode(&m); err != nil {
209                 app.Logger.Error("json.NewDecoder failed: %v", err)
210         } else {
211                 a.maxActiveAlarms = m.MaxActiveAlarms
212                 a.maxAlarmHistory = m.MaxAlarmHistory
213                 app.Logger.Debug("new maxActiveAlarms = %v", a.maxActiveAlarms)
214                 app.Logger.Debug("new maxAlarmHistory = %v", a.maxAlarmHistory)
215                 a.respondWithJSON(w, http.StatusOK, err)
216         }
217 }
218
219 func (a *AlarmManager) GetAlarmConfig(w http.ResponseWriter, r *http.Request) {
220         var m alarm.AlarmConfigParams
221
222         m.MaxActiveAlarms = a.maxActiveAlarms
223         m.MaxAlarmHistory = a.maxAlarmHistory
224
225         a.respondWithJSON(w, http.StatusOK, m)
226         return
227 }