Merge "Configure Repo for Documentation"
[ric-plt/e2mgr.git] / E2Manager / services / rnib_data_service.go
1 //
2 // Copyright 2019 AT&T Intellectual Property
3 // Copyright 2019 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 services
22
23 import (
24         "e2mgr/configuration"
25         "e2mgr/logger"
26         "e2mgr/rNibWriter"
27         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
28         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/reader"
29         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
30         "net"
31         "time"
32 )
33
34 type RNibDataService interface {
35         SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error
36         UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
37         SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
38         GetNodeb(ranName string) (*entities.NodebInfo, error)
39         GetListNodebIds() ([]*entities.NbIdentity, error)
40         PingRnib() bool
41 }
42
43 type rNibDataService struct {
44         logger             *logger.Logger
45         rnibReaderProvider func() reader.RNibReader
46         rnibWriterProvider func() rNibWriter.RNibWriter
47         maxAttempts        int
48         retryInterval      time.Duration
49 }
50
51 func NewRnibDataService(logger *logger.Logger, config *configuration.Configuration, rnibReaderProvider func() reader.RNibReader, rnibWriterProvider func() rNibWriter.RNibWriter) *rNibDataService {
52         return &rNibDataService{
53                 logger:             logger,
54                 rnibReaderProvider: rnibReaderProvider,
55                 rnibWriterProvider: rnibWriterProvider,
56                 maxAttempts:        config.MaxRnibConnectionAttempts,
57                 retryInterval:      time.Duration(config.RnibRetryIntervalMs) * time.Millisecond,
58         }
59 }
60
61 func (w *rNibDataService) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
62         w.logger.Infof("#RnibDataService.UpdateNodebInfo - nodebInfo: %s", nodebInfo)
63
64         err := w.retry("UpdateNodebInfo", func() (err error) {
65                 err = w.rnibWriterProvider().UpdateNodebInfo(nodebInfo)
66                 return
67         })
68
69         return err
70 }
71
72 func (w *rNibDataService) SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error {
73         w.logger.Infof("#RnibDataService.SaveNodeb - nbIdentity: %s, nodebInfo: %s", nbIdentity, nb)
74
75         err := w.retry("SaveNodeb", func() (err error) {
76                 err = w.rnibWriterProvider().SaveNodeb(nbIdentity, nb)
77                 return
78         })
79
80         return err
81 }
82
83 func (w *rNibDataService) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
84         w.logger.Infof("#RnibDataService.SaveRanLoadInformation - inventoryName: %s, ranLoadInformation: %s", inventoryName, ranLoadInformation)
85
86         err := w.retry("SaveRanLoadInformation", func() (err error) {
87                 err = w.rnibWriterProvider().SaveRanLoadInformation(inventoryName, ranLoadInformation)
88                 return
89         })
90
91         return err
92 }
93
94 func (w *rNibDataService) GetNodeb(ranName string) (*entities.NodebInfo, error) {
95         w.logger.Infof("#RnibDataService.GetNodeb - RAN name: %s", ranName)
96
97         var nodeb *entities.NodebInfo = nil
98
99         err := w.retry("GetNodeb", func() (err error) {
100                 nodeb, err = w.rnibReaderProvider().GetNodeb(ranName)
101                 return
102         })
103
104         return nodeb, err
105 }
106
107 func (w *rNibDataService) GetListNodebIds() ([]*entities.NbIdentity, error) {
108         w.logger.Infof("#RnibDataService.GetListNodebIds")
109
110         var nodeIds []*entities.NbIdentity = nil
111
112         err := w.retry("GetListNodebIds", func() (err error) {
113                 nodeIds, err = w.rnibReaderProvider().GetListNodebIds()
114                 return
115         })
116
117         return nodeIds, err
118 }
119
120 func (w *rNibDataService) PingRnib() bool {
121         err := w.retry("GetListNodebIds", func() (err error) {
122                 _, err = w.rnibReaderProvider().GetListNodebIds()
123                 return
124         })
125
126         return !isRnibConnectionError(err)
127 }
128
129 func (w *rNibDataService) retry(rnibFunc string, f func() error) (err error) {
130         attempts := w.maxAttempts
131
132         for i := 1; ; i++ {
133                 err = f()
134                 if err == nil {
135                         return
136                 }
137                 if !isRnibConnectionError(err) {
138                         return err
139                 }
140                 if i >= attempts {
141                         w.logger.Errorf("#RnibDataService.retry - after %d attempts of %s, last error: %s", attempts, rnibFunc, err)
142                         return err
143                 }
144                 time.Sleep(w.retryInterval)
145
146                 w.logger.Infof("#RnibDataService.retry - retrying %d %s after error: %s", i, rnibFunc, err)
147         }
148 }
149
150
151 func isRnibConnectionError(err error) bool {
152         internalErr, ok := err.(*common.InternalError)
153         if !ok {
154                 return false
155         }
156         _, ok = internalErr.Err.(*net.OpError)
157
158         return ok
159 }