-
Notifications
You must be signed in to change notification settings - Fork 13
/
subscriptionschemapropertybuilder.go
524 lines (457 loc) · 15.5 KB
/
subscriptionschemapropertybuilder.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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
package apic
import (
"fmt"
"sort"
)
// TODO - this file should be able to be removed once Unified Catalog support has been removed
// Supported data types
const (
DataTypeString = "string"
DataTypeNumber = "number"
DataTypeInteger = "integer"
DataTypeArray = "array"
DataTypeObject = "object"
)
// PropertyBuilder - mandatory methods for all property builders
type PropertyBuilder interface {
// Build - builds the property, this is called automatically by the schema builder
Build() (*SubscriptionSchemaPropertyDefinition, error)
}
// SubscriptionPropertyBuilder - common methods related to subscription property builders
type SubscriptionPropertyBuilder interface {
// SetName - sets the name of the property
SetName(name string) SubscriptionPropertyBuilder
// SetDescription - set the description of the property
SetDescription(description string) SubscriptionPropertyBuilder
// SetRequired - set the property as a required field in the schema
SetRequired() SubscriptionPropertyBuilder
// SetReadOnly - set the property as a read only property
SetReadOnly() SubscriptionPropertyBuilder
// SetHidden - set the property as a hidden property
SetHidden() SubscriptionPropertyBuilder
// SetAPICRefField - set the apic reference field for this property
SetAPICRefField(field string) SubscriptionPropertyBuilder
// IsString - Set the property to be of type string
IsString() StringPropertyBuilder
// IsInteger - Set the property to be of type integer
IsInteger() IntegerPropertyBuilder
// IsNumber - Set the property to be of type number
IsNumber() NumberPropertyBuilder
// IsArray - Set the property to be of type array
IsArray() ArrayPropertyBuilder
// IsObject - Set the property to be of type object
IsObject() ObjectPropertyBuilder
PropertyBuilder
}
// StringPropertyBuilder - specific methods related to the String property builders
type StringPropertyBuilder interface {
// SetEnumValues - Set a list of valid values for the property
SetEnumValues(values []string) StringPropertyBuilder
// SetSortEnumValues - Sort the allowed values alphabetically in the schema
SetSortEnumValues() StringPropertyBuilder
// SetFirstEnumValue - Set the value that should appear first in the list
SetFirstEnumValue(value string) StringPropertyBuilder
// AddEnumValue - Add another value to the list of allowed values for the property
AddEnumValue(value string) StringPropertyBuilder
// SetDefaultValue - Define the initial value for the property
SetDefaultValue(value string) StringPropertyBuilder
PropertyBuilder
}
// NumberPropertyBuilder - specific methods related to the Number property builders
type NumberPropertyBuilder interface {
// SetMinValue - Set the minimum allowed number value
SetMinValue(min float64) NumberPropertyBuilder
// SetMaxValue - Set the maximum allowed number value
SetMaxValue(min float64) NumberPropertyBuilder
// SetDefaultValue - Define the initial value for the property
SetDefaultValue(value float64) NumberPropertyBuilder
PropertyBuilder
}
// IntegerPropertyBuilder - specific methods related to the Integer property builders
type IntegerPropertyBuilder interface {
// SetMinValue - Set the minimum allowed integer value
SetMinValue(min int64) IntegerPropertyBuilder
// SetMaxValue - Set the maximum allowed integer value
SetMaxValue(min int64) IntegerPropertyBuilder
// SetDefaultValue - Define the initial value for the property
SetDefaultValue(value int64) IntegerPropertyBuilder
PropertyBuilder
}
// ObjectPropertyBuilder - specific methods related to the Object property builders
type ObjectPropertyBuilder interface {
// AddProperty - Add a property in the object property
AddProperty(property PropertyBuilder) ObjectPropertyBuilder
PropertyBuilder
}
// ArrayPropertyBuilder - specific methods related to the Array property builders
type ArrayPropertyBuilder interface {
// AddItem - Add a item property in the array property
AddItem(item PropertyBuilder) ArrayPropertyBuilder
// SetMinItems - Set the minimum number of items in the array property
SetMinItems(min uint) ArrayPropertyBuilder
// SetMaxItems - Set the maximum number of items in the array property
SetMaxItems(max uint) ArrayPropertyBuilder
PropertyBuilder
}
// schemaProperty - holds basic info needed to create a subscription schema property
type schemaProperty struct {
err error
name string
description string
apicRefField string
required bool
readOnly bool
hidden bool
dataType string
SubscriptionPropertyBuilder
}
// NewSubscriptionSchemaPropertyBuilder - Creates a new subscription schema property builder
func NewSubscriptionSchemaPropertyBuilder() SubscriptionPropertyBuilder {
return &schemaProperty{}
}
// SetName - sets the name of the property
func (p *schemaProperty) SetName(name string) SubscriptionPropertyBuilder {
p.name = name
return p
}
// SetDescription - set the description of the property
func (p *schemaProperty) SetDescription(description string) SubscriptionPropertyBuilder {
p.description = description
return p
}
// SetRequired - set the property as a required field in the schema
func (p *schemaProperty) SetRequired() SubscriptionPropertyBuilder {
p.required = true
return p
}
// SetReadOnly - set the property as a read only property
func (p *schemaProperty) SetReadOnly() SubscriptionPropertyBuilder {
p.readOnly = true
return p
}
// SetHidden - set the property as a hidden property
func (p *schemaProperty) SetHidden() SubscriptionPropertyBuilder {
p.hidden = true
return p
}
// SetAPICRefField - set the apic reference field for this property
func (p *schemaProperty) SetAPICRefField(field string) SubscriptionPropertyBuilder {
p.apicRefField = field
return p
}
// IsString - Set the property to be of type string
func (p *schemaProperty) IsString() StringPropertyBuilder {
p.dataType = DataTypeString
return &stringSchemaProperty{
schemaProperty: p,
}
}
// IsNumber - Set the property to be of type number
func (p *schemaProperty) IsNumber() NumberPropertyBuilder {
p.dataType = DataTypeNumber
return &numberSchemaProperty{
schemaProperty: p,
}
}
// IsInteger - Set the property to be of type integer
func (p *schemaProperty) IsInteger() IntegerPropertyBuilder {
p.dataType = DataTypeInteger
return &integerSchemaProperty{
numberSchemaProperty{
schemaProperty: p,
},
}
}
// IsArray - Set the property to be of type array
func (p *schemaProperty) IsArray() ArrayPropertyBuilder {
p.dataType = DataTypeArray
return &arraySchemaProperty{
schemaProperty: p,
}
}
// IsObject - Set the property to be of type object
func (p *schemaProperty) IsObject() ObjectPropertyBuilder {
p.dataType = DataTypeObject
return &objectSchemaProperty{
schemaProperty: p,
}
}
// Build - create a string SubscriptionSchemaPropertyDefinition for use in the subscription schema builder
func (p *schemaProperty) Build() (*SubscriptionSchemaPropertyDefinition, error) {
if p.err != nil {
return nil, p.err
}
if p.name == "" {
return nil, fmt.Errorf("cannot add a subscription schema property without a name")
}
if p.dataType == "" {
return nil, fmt.Errorf("subscription schema property named %s must have a data type", p.name)
}
prop := &SubscriptionSchemaPropertyDefinition{
Name: p.name,
Title: p.name,
Type: p.dataType,
Description: p.description,
APICRef: p.apicRefField,
ReadOnly: p.readOnly,
Required: p.required,
}
if p.hidden {
prop.Format = "hidden"
}
return prop, nil
}
/**
string property datatype
*/
// stringSchemaProperty - adds specific info needed for a string schema property
type stringSchemaProperty struct {
schemaProperty *schemaProperty
sortEnums bool
firstEnumValue string
enums []string
defaultValue string
StringPropertyBuilder
}
// SetEnumValues - add a list of enum values to the property
func (p *stringSchemaProperty) SetEnumValues(values []string) StringPropertyBuilder {
dict := make(map[string]bool, 0)
// use a temp map to filter out any duplicate values from the input
for _, value := range values {
if _, ok := dict[value]; !ok {
dict[value] = true
p.enums = append(p.enums, value)
}
}
return p
}
// SetSortEnumValues - indicates to sort the enums
func (p *stringSchemaProperty) SetSortEnumValues() StringPropertyBuilder {
p.sortEnums = true
return p
}
// SetFirstEnumValue - Sets a first item for enums. Only needed for sorted enums if you want a specific
// item first in the list
func (p *stringSchemaProperty) SetFirstEnumValue(value string) StringPropertyBuilder {
p.firstEnumValue = value
return p
}
func (p *stringSchemaProperty) enumContains(str string) bool {
for _, v := range p.enums {
if v == str {
return true
}
}
return false
}
// AddEnumValue - Add another value to the list of allowed values for the property
func (p *stringSchemaProperty) AddEnumValue(value string) StringPropertyBuilder {
if !p.enumContains(value) {
p.enums = append(p.enums, value)
}
return p
}
// SetDefaultValue - Define the initial value for the property
func (p *stringSchemaProperty) SetDefaultValue(value string) StringPropertyBuilder {
p.defaultValue = value
return p
}
// Build - create a string SubscriptionSchemaPropertyDefinition for use in the subscription schema builder
func (p *stringSchemaProperty) Build() (def *SubscriptionSchemaPropertyDefinition, err error) {
def, err = p.schemaProperty.Build()
if err != nil {
return
}
// sort if specified to do so
if p.sortEnums {
sort.Strings(p.enums)
}
// append item to start if specified
if p.firstEnumValue != "" {
p.enums = append([]string{p.firstEnumValue}, p.enums...)
}
def.Enum = p.enums
if len(p.defaultValue) > 0 {
if len(p.enums) > 0 {
// Check validity for defaultValue
isDefaultValueValid := false
for _, x := range p.enums {
if x == p.defaultValue {
isDefaultValueValid = true
break
}
}
if !isDefaultValueValid {
return nil, fmt.Errorf("default value (%s) must be present in the enum list (%s)", p.defaultValue, p.enums)
}
}
def.DefaultValue = p.defaultValue
}
return def, err
}
/**
number property datatype builder
*/
// numberSchemaProperty - adds specific info needed for a number schema property
type numberSchemaProperty struct {
schemaProperty *schemaProperty
minValue *float64 // We use a pointer to differentiate the "blank value" from a chosen 0 min value
maxValue *float64 // We use a pointer to differentiate the "blank value" from a chosen 0 max value
defaultValue *float64
SubscriptionPropertyBuilder
}
// SetMinValue - set the minimum allowed value
func (p *numberSchemaProperty) SetMinValue(min float64) NumberPropertyBuilder {
p.minValue = &min
return p
}
// SetMaxValue - set the maximum allowed value
func (p *numberSchemaProperty) SetMaxValue(max float64) NumberPropertyBuilder {
p.maxValue = &max
return p
}
// SetDefaultValue - Define the initial value for the property
func (p *numberSchemaProperty) SetDefaultValue(value float64) NumberPropertyBuilder {
p.defaultValue = &value
return p
}
// Build - create the SubscriptionSchemaPropertyDefinition for use in the subscription schema builder
func (p *numberSchemaProperty) Build() (def *SubscriptionSchemaPropertyDefinition, err error) {
def, err = p.schemaProperty.Build()
if err != nil {
return
}
if p.minValue != nil && p.maxValue != nil && *p.minValue > *p.maxValue {
return nil, fmt.Errorf("max value (%f) must be greater than min value (%f)", *p.maxValue, *p.minValue)
}
if p.defaultValue != nil {
if p.minValue != nil && *p.defaultValue < *p.minValue {
return nil, fmt.Errorf("default value (%f) must be equal or greater than min value (%f)", *p.defaultValue, *p.minValue)
}
if p.maxValue != nil && *p.defaultValue > *p.maxValue {
return nil, fmt.Errorf("default value (%f) must be equal or lower than max value (%f)", *p.defaultValue, *p.maxValue)
}
def.DefaultValue = p.defaultValue
}
def.Minimum = p.minValue
def.Maximum = p.maxValue
return def, err
}
/**
integer property datatype builder
*/
// integerSchemaProperty - adds specific info needed for an integer schema property
type integerSchemaProperty struct {
numberSchemaProperty
}
// SetMinValue - set the minimum allowed value
func (p *integerSchemaProperty) SetMinValue(min int64) IntegerPropertyBuilder {
minimum := float64(min)
p.minValue = &minimum
return p
}
// SetMaxValue - set the maximum allowed value
func (p *integerSchemaProperty) SetMaxValue(max int64) IntegerPropertyBuilder {
maximum := float64(max)
p.maxValue = &maximum
return p
}
// SetDefaultValue - Define the initial value for the property
func (p *integerSchemaProperty) SetDefaultValue(value int64) IntegerPropertyBuilder {
defaultValue := float64(value)
p.defaultValue = &defaultValue
return p
}
/**
array property datatype builder
*/
// arraySchemaProperty - adds specific info needed for an array schema property
type arraySchemaProperty struct {
schemaProperty *schemaProperty
items []SubscriptionSchemaPropertyDefinition
minItems *uint
maxItems *uint
SubscriptionPropertyBuilder
}
// AddItem - add an item in the array property
func (p *arraySchemaProperty) AddItem(item PropertyBuilder) ArrayPropertyBuilder {
def, err := item.Build()
if err == nil {
p.items = append(p.items, *def)
} else {
p.schemaProperty.err = err
}
return p
}
// SetMinItems - set the minimum items in the property array
func (p *arraySchemaProperty) SetMinItems(min uint) ArrayPropertyBuilder {
p.minItems = &min
return p
}
// SetMaxItems - set the maximum items in the property array
func (p *arraySchemaProperty) SetMaxItems(max uint) ArrayPropertyBuilder {
if max < 1 {
p.schemaProperty.err = fmt.Errorf("the max array items must be greater than 0")
} else {
p.maxItems = &max
}
return p
}
// Build - create the SubscriptionSchemaPropertyDefinition for use in the subscription schema builder
func (p *arraySchemaProperty) Build() (def *SubscriptionSchemaPropertyDefinition, err error) {
def, err = p.schemaProperty.Build()
if err != nil {
return
}
var anyOfItems *AnyOfSubscriptionSchemaPropertyDefinitions
if p.items != nil {
anyOfItems = &AnyOfSubscriptionSchemaPropertyDefinitions{p.items}
}
if p.minItems != nil && p.maxItems != nil && *p.minItems > *p.maxItems {
return nil, fmt.Errorf("max array items (%d) must be greater than min array items (%d)", p.maxItems, p.minItems)
}
def.Items = anyOfItems
def.MinItems = p.minItems
def.MaxItems = p.maxItems
return def, err
}
/**
object property datatype builder
*/
// objectSchemaProperty - adds specific info needed for an object schema property
type objectSchemaProperty struct {
schemaProperty *schemaProperty
properties map[string]SubscriptionSchemaPropertyDefinition
SubscriptionPropertyBuilder
}
// AddProperty - Add a property in the object property
func (p *objectSchemaProperty) AddProperty(property PropertyBuilder) ObjectPropertyBuilder {
def, err := property.Build()
if err == nil {
if p.properties == nil {
p.properties = make(map[string]SubscriptionSchemaPropertyDefinition, 0)
}
p.properties[def.Name] = *def
} else {
p.schemaProperty.err = err
}
return p
}
// Build - create the SubscriptionSchemaPropertyDefinition for use in the subscription schema builder
func (p *objectSchemaProperty) Build() (def *SubscriptionSchemaPropertyDefinition, err error) {
def, err = p.schemaProperty.Build()
if err != nil {
return
}
var requiredProperties []string
if p.properties != nil {
for _, property := range p.properties {
if property.Required {
requiredProperties = append(requiredProperties, property.Name)
}
}
}
def.Properties = p.properties
def.RequiredProperties = requiredProperties
return def, err
}