/
defined.go
62 lines (50 loc) · 1.58 KB
/
defined.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
// Copyright 2020-2021 Dave Shanley / Quobix
// SPDX-License-Identifier: MIT
package core
import (
"fmt"
"github.com/daveshanley/vacuum/model"
vacuumUtils "github.com/daveshanley/vacuum/utils"
"github.com/pb33f/libopenapi/utils"
"gopkg.in/yaml.v3"
)
// Defined is a rule that will determine if a field has been set on a node slice.
type Defined struct {
}
// GetSchema returns a model.RuleFunctionSchema defining the schema of the Defined rule.
func (d Defined) GetSchema() model.RuleFunctionSchema {
return model.RuleFunctionSchema{
Name: "defined",
RequiresField: true,
}
}
// RunRule will execute the Defined rule, based on supplied context and a supplied []*yaml.Node slice.
func (d Defined) RunRule(nodes []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult {
if len(nodes) <= 0 {
return nil
}
var results []model.RuleFunctionResult
message := context.Rule.Message
pathValue := "unknown"
if path, ok := context.Given.(string); ok {
pathValue = path
}
ruleMessage := context.Rule.Description
if context.Rule.Message != "" {
ruleMessage = context.Rule.Message
}
for _, node := range nodes {
fieldNode, _ := utils.FindKeyNode(context.RuleAction.Field, node.Content)
if fieldNode == nil {
results = append(results, model.RuleFunctionResult{
Message: vacuumUtils.SuppliedOrDefault(message,
fmt.Sprintf("%s: `%s` must be defined", ruleMessage, context.RuleAction.Field)),
StartNode: node,
EndNode: vacuumUtils.BuildEndNode(node),
Path: pathValue,
Rule: context.Rule,
})
}
}
return results
}