-
Notifications
You must be signed in to change notification settings - Fork 480
/
valuedescriptor.go
409 lines (343 loc) · 10.3 KB
/
valuedescriptor.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
/*******************************************************************************
* Copyright 2017 Dell Inc.
*
* 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 data
import (
"context"
"encoding/json"
"fmt"
"io"
"regexp"
"github.com/edgexfoundry/edgex-go/internal/core/data/config"
"github.com/edgexfoundry/edgex-go/internal/core/data/errors"
"github.com/edgexfoundry/edgex-go/internal/core/data/interfaces"
"github.com/edgexfoundry/edgex-go/internal/pkg/db"
"github.com/edgexfoundry/go-mod-core-contracts/clients/logger"
"github.com/edgexfoundry/go-mod-core-contracts/clients/metadata"
contract "github.com/edgexfoundry/go-mod-core-contracts/models"
)
const (
formatSpecifier = "%(\\d+\\$)?([-#+ 0,(\\<]*)?(\\d+)?(\\.\\d+)?([tT])?([a-zA-Z%])"
maxExceededString string = "Error, exceeded the max limit as defined in config"
)
// Check if the value descriptor matches the format string regular expression
func validateFormatString(v contract.ValueDescriptor, lc logger.LoggingClient) error {
// No formatting specified
if v.Formatting == "" {
return nil
}
match, err := regexp.MatchString(formatSpecifier, v.Formatting)
if err != nil {
lc.Error("Error checking for format string for value descriptor " + v.Name)
return err
}
if !match {
err = fmt.Errorf("format is not a valid printf format")
lc.Error(fmt.Sprintf("Error posting value descriptor. %s", err.Error()))
return errors.NewErrValueDescriptorInvalid(v.Name, err)
}
return nil
}
func getValueDescriptorByName(
name string,
lc logger.LoggingClient,
dbClient interfaces.DBClient) (vd contract.ValueDescriptor, err error) {
vd, err = dbClient.ValueDescriptorByName(name)
if err != nil {
lc.Error(err.Error())
if err == db.ErrNotFound {
return contract.ValueDescriptor{}, errors.NewErrDbNotFound()
} else {
return contract.ValueDescriptor{}, err
}
}
return vd, nil
}
func getValueDescriptorById(
id string,
lc logger.LoggingClient,
dbClient interfaces.DBClient) (vd contract.ValueDescriptor, err error) {
vd, err = dbClient.ValueDescriptorById(id)
if err != nil {
lc.Error(err.Error())
if err == db.ErrNotFound {
return contract.ValueDescriptor{}, errors.NewErrDbNotFound()
} else if err == db.ErrInvalidObjectId {
return contract.ValueDescriptor{}, errors.NewErrInvalidId(id)
} else {
return contract.ValueDescriptor{}, err
}
}
return vd, nil
}
func getValueDescriptorsByUomLabel(
uomLabel string,
lc logger.LoggingClient,
dbClient interfaces.DBClient) (vdList []contract.ValueDescriptor, err error) {
vdList, err = dbClient.ValueDescriptorsByUomLabel(uomLabel)
if err != nil {
lc.Error(err.Error())
if err == db.ErrNotFound {
return []contract.ValueDescriptor{}, errors.NewErrDbNotFound()
} else {
return []contract.ValueDescriptor{}, err
}
}
return vdList, nil
}
func getValueDescriptorsByLabel(
label string,
lc logger.LoggingClient,
dbClient interfaces.DBClient) (vdList []contract.ValueDescriptor, err error) {
vdList, err = dbClient.ValueDescriptorsByLabel(label)
if err != nil {
lc.Error(err.Error())
if err == db.ErrNotFound {
return []contract.ValueDescriptor{}, errors.NewErrDbNotFound()
} else {
return []contract.ValueDescriptor{}, err
}
}
return vdList, nil
}
func getValueDescriptorsByType(
typ string,
lc logger.LoggingClient,
dbClient interfaces.DBClient) (vdList []contract.ValueDescriptor, err error) {
vdList, err = dbClient.ValueDescriptorsByType(typ)
if err != nil {
lc.Error(err.Error())
if err == db.ErrNotFound {
return []contract.ValueDescriptor{}, errors.NewErrDbNotFound()
} else {
return []contract.ValueDescriptor{}, err
}
}
return vdList, nil
}
func getValueDescriptorsByDevice(
device contract.Device,
lc logger.LoggingClient,
dbClient interfaces.DBClient) (vdList []contract.ValueDescriptor, err error) {
// Get the names of the value descriptors
vdNames := []string{}
device.AllAssociatedValueDescriptors(&vdNames)
// Get the value descriptors
vdList = []contract.ValueDescriptor{}
for _, name := range vdNames {
vd, err := getValueDescriptorByName(name, lc, dbClient)
// Not an error if not found
if err != nil {
switch err.(type) {
case errors.ErrDbNotFound:
continue
default:
return []contract.ValueDescriptor{}, err
}
}
vdList = append(vdList, vd)
}
return vdList, nil
}
func getValueDescriptorsByDeviceName(
ctx context.Context,
name string,
lc logger.LoggingClient,
dbClient interfaces.DBClient,
mdc metadata.DeviceClient) (vdList []contract.ValueDescriptor, err error) {
// Get the device
device, err := mdc.DeviceForName(ctx, name)
if err != nil {
lc.Error("Problem getting device from metadata: " + err.Error())
return []contract.ValueDescriptor{}, err
}
return getValueDescriptorsByDevice(device, lc, dbClient)
}
func getValueDescriptorsByDeviceId(
ctx context.Context,
id string,
lc logger.LoggingClient,
dbClient interfaces.DBClient,
mdc metadata.DeviceClient) (vdList []contract.ValueDescriptor, err error) {
// Get the device
device, err := mdc.Device(ctx, id)
if err != nil {
lc.Error("Problem getting device from metadata: " + err.Error())
return []contract.ValueDescriptor{}, err
}
return getValueDescriptorsByDevice(device, lc, dbClient)
}
func getAllValueDescriptors(
lc logger.LoggingClient,
dbClient interfaces.DBClient) (vd []contract.ValueDescriptor, err error) {
vd, err = dbClient.ValueDescriptors()
if err != nil {
lc.Error(err.Error())
return nil, err
}
return vd, nil
}
func decodeValueDescriptor(
reader io.ReadCloser,
lc logger.LoggingClient) (vd contract.ValueDescriptor, err error) {
v := contract.ValueDescriptor{}
err = json.NewDecoder(reader).Decode(&v)
// Problems decoding
if err != nil {
lc.Error("Error decoding the value descriptor: " + err.Error())
return contract.ValueDescriptor{}, errors.NewErrJsonDecoding(v.Name)
}
// Check the formatting
err = validateFormatString(v, lc)
if err != nil {
return contract.ValueDescriptor{}, err
}
return v, nil
}
func addValueDescriptor(
vd contract.ValueDescriptor,
lc logger.LoggingClient,
dbClient interfaces.DBClient) (id string, err error) {
id, err = dbClient.AddValueDescriptor(vd)
if err != nil {
lc.Error(err.Error())
if err == db.ErrNotUnique {
return "", errors.NewErrDuplicateValueDescriptorName(vd.Name)
} else {
return "", err
}
}
return id, nil
}
func updateValueDescriptor(
from contract.ValueDescriptor,
lc logger.LoggingClient,
dbClient interfaces.DBClient,
configuration *config.ConfigurationStruct) error {
to, err := getValueDescriptorById(from.Id, lc, dbClient)
if err != nil {
return err
}
// Update the fields
if from.Description != "" {
to.Description = from.Description
}
if from.DefaultValue != "" {
to.DefaultValue = from.DefaultValue
}
if from.Formatting != "" {
match, err := regexp.MatchString(formatSpecifier, from.Formatting)
if err != nil {
lc.Error("Error checking formatting for updated value descriptor")
return err
}
if !match {
lc.Error("value descriptor's format string doesn't fit the required pattern: " + formatSpecifier)
return errors.NewErrValueDescriptorInvalid(from.Name, err)
}
to.Formatting = from.Formatting
}
if from.Labels != nil {
to.Labels = from.Labels
}
if from.Max != "" {
to.Max = from.Max
}
if from.Min != "" {
to.Min = from.Min
}
if from.Name != "" {
// Check if value descriptor is still in use by readings if the name changes
if from.Name != to.Name {
// Arbitrary limit, we're just checking if there are any readings
r, err := getReadingsByValueDescriptor(to.Name, 10, lc, dbClient, configuration)
if err != nil {
lc.Error("Error checking the readings for the value descriptor: " + err.Error())
return err
}
// Value descriptor is still in use
if len(r) != 0 {
lc.Error(
"Data integrity issue. Value Descriptor with name: " +
from.Name +
" is still referenced by existing readings.")
return errors.NewErrValueDescriptorInUse(from.Name)
}
}
to.Name = from.Name
}
if from.Origin != 0 {
to.Origin = from.Origin
}
if from.Type != "" {
to.Type = from.Type
}
if from.UomLabel != "" {
to.UomLabel = from.UomLabel
}
// Push the updated valuedescriptor to the database
err = dbClient.UpdateValueDescriptor(to)
if err != nil {
if err == db.ErrNotUnique {
lc.Error("Value descriptor name is not unique")
return errors.NewErrDuplicateValueDescriptorName(to.Name)
} else {
lc.Error(err.Error())
return err
}
}
return nil
}
func deleteValueDescriptor(
vd contract.ValueDescriptor,
lc logger.LoggingClient,
dbClient interfaces.DBClient) error {
// Check if the value descriptor is still in use by readings
readings, err := dbClient.ReadingsByValueDescriptor(vd.Name, 10)
if err != nil {
lc.Error(err.Error())
return err
}
if len(readings) > 0 {
lc.Error("Data integrity issue. Value Descriptor is still referenced by existing readings.")
return errors.NewErrValueDescriptorInUse(vd.Name)
}
// Delete the value descriptor
if err = dbClient.DeleteValueDescriptorById(vd.Id); err != nil {
lc.Error(err.Error())
return err
}
return nil
}
func deleteValueDescriptorByName(name string, lc logger.LoggingClient, dbClient interfaces.DBClient) error {
// Check if the value descriptor exists
vd, err := getValueDescriptorByName(name, lc, dbClient)
if err != nil {
return err
}
if err = deleteValueDescriptor(vd, lc, dbClient); err != nil {
return err
}
return nil
}
func deleteValueDescriptorById(id string, lc logger.LoggingClient, dbClient interfaces.DBClient) error {
// Check if the value descriptor exists
vd, err := getValueDescriptorById(id, lc, dbClient)
if err != nil {
return err
}
if err = deleteValueDescriptor(vd, lc, dbClient); err != nil {
return err
}
return nil
}