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
|
// Copyright © 2018 The Homeport Team
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package ytbx
import (
"fmt"
yamlv3 "gopkg.in/yaml.v3"
)
// Grab gets the value from the provided YAML tree using a path to traverse
// through the tree structure
func Grab(node *yamlv3.Node, pathString string) (*yamlv3.Node, error) {
path, err := ParsePathString(pathString, node)
if err != nil {
return nil, err
}
switch node.Kind {
case yamlv3.DocumentNode:
return grabByPath(node.Content[0], path)
default:
return grabByPath(node, path)
}
}
func grabByPath(node *yamlv3.Node, path Path) (*yamlv3.Node, error) {
pointer := node
pointerPath := Path{DocumentIdx: path.DocumentIdx}
for _, element := range path.PathElements {
switch {
// Key/Value Map, where the element name is the key for the map
case element.isMapElement():
if pointer.Kind != yamlv3.MappingNode {
return nil,
fmt.Errorf("failed to traverse tree, expected %s but found type %s at %s",
typeMap,
GetType(pointer),
pointerPath.ToGoPatchStyle(),
)
}
entry, err := getValueByKey(pointer, element.Name)
if err != nil {
return nil, err
}
pointer = entry
// Complex List, where each list entry is a Key/Value map and the entry is
// identified by name using an identifier (e.g. name, key, or id)
case element.isComplexListElement():
if pointer.Kind != yamlv3.SequenceNode {
return nil,
fmt.Errorf("failed to traverse tree, expected %s but found type %s at %s",
typeComplexList,
GetType(pointer),
pointerPath.ToGoPatchStyle(),
)
}
entry, err := getEntryByIdentifierAndName(pointer, element.Key, element.Name)
if err != nil {
return nil, err
}
pointer = entry
// Simple List (identified by index)
case element.isSimpleListElement():
if pointer.Kind != yamlv3.SequenceNode {
return nil,
fmt.Errorf("failed to traverse tree, expected %s but found type %s at %s",
typeSimpleList,
GetType(pointer),
pointerPath.ToGoPatchStyle(),
)
}
if element.Idx < 0 || element.Idx >= len(pointer.Content) {
return nil,
fmt.Errorf("failed to traverse tree, provided %s index %d is not in range: 0..%d",
typeSimpleList,
element.Idx,
len(pointer.Content)-1,
)
}
pointer = pointer.Content[element.Idx]
default:
return nil, fmt.Errorf("failed to traverse tree, the provided path %s seems to be invalid", path)
}
// Update the path that the current pointer to keep track of the traversing
pointerPath.PathElements = append(pointerPath.PathElements, element)
}
return pointer, nil
}
|
