/
feature.go
278 lines (238 loc) · 8.56 KB
/
feature.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/*
* Copyright 2018-2023, CS Systemes d'Information, http://csgroup.eu
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package listeners
import (
"context"
"encoding/json"
"fmt"
"github.com/CS-SI/SafeScale/v22/lib/backend/handlers"
"github.com/CS-SI/SafeScale/v22/lib/backend/resources/enums/featuretargettype"
"github.com/CS-SI/SafeScale/v22/lib/backend/resources/operations/converters"
srvutils "github.com/CS-SI/SafeScale/v22/lib/backend/utils"
"github.com/CS-SI/SafeScale/v22/lib/protocol"
"github.com/CS-SI/SafeScale/v22/lib/utils/data"
"github.com/CS-SI/SafeScale/v22/lib/utils/debug"
"github.com/CS-SI/SafeScale/v22/lib/utils/fail"
googleprotobuf "github.com/golang/protobuf/ptypes/empty"
)
// FeatureListener feature service server grpc
type FeatureListener struct {
protocol.UnimplementedFeatureServiceServer
}
// List ...
func (s *FeatureListener) List(inctx context.Context, in *protocol.FeatureListRequest) (_ *protocol.FeatureListResponse, ferr error) {
defer fail.OnExitConvertToGRPCStatus(inctx, &ferr)
defer fail.OnExitWrapError(inctx, &ferr, "cannot list Features")
defer fail.OnPanic(&ferr)
empty := &protocol.FeatureListResponse{}
if s == nil {
return empty, fail.InvalidInstanceError()
}
if inctx == nil {
return empty, fail.InvalidParameterError("inctx", "cannot be nil").ToGRPCStatus()
}
if in == nil {
return empty, fail.InvalidParameterError("in", "cannot be nil")
}
targetType, xerr := convertTargetType(in.GetTargetType())
if xerr != nil {
return nil, xerr
}
targetRef, _ := srvutils.GetReference(in.GetTargetRef())
if targetRef == "" {
return empty, fail.InvalidParameterError("in.TargetRef", "neither Name nor ID fields are provided")
}
job, xerr := PrepareJob(inctx, in.GetTargetRef().GetTenantId(), "/features/list")
if xerr != nil {
return nil, xerr
}
defer job.Close()
ctx := job.Context()
handler := handlers.NewFeatureHandler(job)
list, xerr := handler.List(targetType, targetRef, in.GetInstalledOnly())
if xerr != nil {
return empty, xerr
}
return converters.FeatureSliceFromResourceToProtocol(ctx, list), nil
}
func convertTargetType(in protocol.FeatureTargetType) (featuretargettype.Enum, fail.Error) {
var targetType featuretargettype.Enum
switch in {
case protocol.FeatureTargetType_FT_HOST:
targetType = featuretargettype.Host
case protocol.FeatureTargetType_FT_CLUSTER:
targetType = featuretargettype.Cluster
default:
return featuretargettype.Unknown, fail.InvalidParameterError("in", "invalid value %d", in)
}
return targetType, nil
}
// Check checks if a feature installed on target
func (s *FeatureListener) Check(inctx context.Context, in *protocol.FeatureActionRequest) (empty *googleprotobuf.Empty, ferr error) {
defer fail.OnExitConvertToGRPCStatus(inctx, &ferr)
defer func() {
ferr = debug.InjectPlannedError(ferr)
if ferr != nil {
switch cerr := ferr.(type) {
case *fail.ErrNotFound:
// Do not wrap *fail.ErrNotFound if it means "Feature not installed"
if val, found := cerr.Annotation("not_installed"); !found || !val.(bool) {
fail.OnExitWrapError(inctx, &ferr, "cannot check Feature")
}
default:
fail.OnExitWrapError(inctx, &ferr, "cannot check Feature")
}
}
}()
defer fail.OnPanic(&ferr)
empty = &googleprotobuf.Empty{}
if s == nil {
return empty, fail.InvalidInstanceError()
}
if inctx == nil {
return empty, fail.InvalidParameterError("inctx", "cannot be nil")
}
targetType, xerr := convertTargetType(in.GetTargetType())
if xerr != nil {
return nil, xerr
}
targetRef, targetRefLabel := srvutils.GetReference(in.GetTargetRef())
if targetRef == "" {
return empty, fail.InvalidRequestError("target reference is missing")
}
featureName := in.GetName()
featureVariables, xerr := convertVariablesToDataMap(in.GetVariables())
if xerr != nil {
return empty, fail.Wrap(xerr, "failed to check feature")
}
featureSettings := converters.FeatureSettingsFromProtocolToResource(in.GetSettings())
job, err := PrepareJob(inctx, in.GetTenantId(), fmt.Sprintf("/feature/%s/check/%s/%s", featureName, targetType, targetRef))
if err != nil {
return nil, err
}
defer job.Close()
ctx := job.Context()
defer func() {
ferr = debug.InjectPlannedError(ferr)
if ferr != nil {
switch ferr.(type) {
case *fail.ErrNotFound:
default:
fail.OnExitLogError(ctx, ferr)
}
}
}()
handler := handlers.NewFeatureHandler(job)
xerr = handler.Check(targetType, targetRef, featureName, featureVariables, featureSettings)
if xerr != nil {
switch xerr.(type) {
case *fail.ErrNotFound:
return empty, fail.NotFoundError("failed to find Feature '%s' on %s %s", featureName, targetType.String(), targetRefLabel)
default:
return empty, xerr
}
}
return empty, nil
}
func convertVariablesToDataMap(in map[string]string) (data.Map, fail.Error) {
var out data.Map
if len(in) > 0 {
jsoned, err := json.Marshal(in)
if err != nil {
return data.NewMap(), fail.Wrap(err, "failed to check feature: failed to convert variables to json")
}
if err = json.Unmarshal(jsoned, &out); err != nil {
return data.NewMap(), fail.Wrap(err, "failed to check feature: failed to convert variables")
}
}
return out, nil
}
// Add ...
func (s *FeatureListener) Add(inctx context.Context, in *protocol.FeatureActionRequest) (empty *googleprotobuf.Empty, ferr error) {
defer fail.OnExitConvertToGRPCStatus(inctx, &ferr)
defer fail.OnExitWrapError(inctx, &ferr, "cannot add Feature")
defer fail.OnPanic(&ferr)
empty = &googleprotobuf.Empty{}
if s == nil {
return empty, fail.InvalidInstanceError()
}
if inctx == nil {
return empty, fail.InvalidParameterError("inctx", "cannot be nil")
}
targetType, xerr := convertTargetType(in.GetTargetType())
if xerr != nil {
return nil, xerr
}
targetRef, targetRefLabel := srvutils.GetReference(in.GetTargetRef())
if targetRef == "" {
return empty, fail.InvalidRequestError("target reference is missing")
}
featureName := in.GetName()
featureVariables, xerr := convertVariablesToDataMap(in.GetVariables())
if xerr != nil {
return empty, fail.Wrap(xerr, "failed to add feature")
}
featureSettings := converters.FeatureSettingsFromProtocolToResource(in.GetSettings())
job, err := PrepareJob(inctx, in.GetTenantId(), fmt.Sprintf("/feature/%s/add/%s/%s", featureName, targetType, targetRef))
if err != nil {
return nil, err
}
defer job.Close()
handler := handlers.NewFeatureHandler(job)
xerr = handler.Add(targetType, targetRef, featureName, featureVariables, featureSettings)
if xerr != nil {
return empty, fail.Wrap(xerr, "failed to add feature '%s' to %s %s", featureName, targetType.String(), targetRefLabel)
}
return empty, nil
}
// Remove uninstalls a Feature
func (s *FeatureListener) Remove(inctx context.Context, in *protocol.FeatureActionRequest) (empty *googleprotobuf.Empty, ferr error) {
defer fail.OnExitConvertToGRPCStatus(inctx, &ferr)
defer fail.OnExitWrapError(inctx, &ferr, "cannot remove Feature")
defer fail.OnPanic(&ferr)
empty = &googleprotobuf.Empty{}
if s == nil {
return empty, fail.InvalidInstanceError()
}
if inctx == nil {
return empty, fail.InvalidParameterError("inctx", "cannot be nil")
}
targetType, xerr := convertTargetType(in.GetTargetType())
if xerr != nil {
return nil, xerr
}
targetRef, targetRefLabel := srvutils.GetReference(in.GetTargetRef())
if targetRef == "" {
return empty, fail.InvalidRequestError("target reference is missing")
}
featureName := in.GetName()
featureVariables, xerr := convertVariablesToDataMap(in.GetVariables())
if xerr != nil {
return empty, fail.Wrap(xerr, "failed to check feature")
}
featureSettings := converters.FeatureSettingsFromProtocolToResource(in.GetSettings())
job, err := PrepareJob(inctx, in.GetTenantId(), fmt.Sprintf("/feature/%s/remove/%s/%s", featureName, targetType, targetRef))
if err != nil {
return empty, err
}
defer job.Close()
handler := handlers.NewFeatureHandler(job)
xerr = handler.Remove(targetType, targetRef, featureName, featureVariables, featureSettings)
if xerr != nil {
return empty, fail.Wrap(xerr, "failed to remove Feature '%s' from %s %s", featureName, targetType.String(), targetRefLabel)
}
return empty, nil
}