-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
literal.go
156 lines (128 loc) · 3.96 KB
/
literal.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
/*
Copyright 2019 The Kubernetes Authors.
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 terraform
import (
"encoding/json"
"fmt"
"sort"
"k8s.io/klog/v2"
)
type fileFn string
const (
fileFnFile fileFn = "file"
fileFnFileBase64 fileFn = "filebase64"
)
// Literal represents a literal in terraform syntax
type Literal struct {
// Value is only used in terraform 0.11 and represents the literal string to use as a value.
// "${}" interpolation is supported.
Value string `cty:"value"`
// The below fields are only used in terraform 0.12.
// ResourceType represents the type of a resource in a literal reference
ResourceType string `cty:"resource_type"`
// ResourceName represents the name of a resource in a literal reference
ResourceName string `cty:"resource_name"`
// ResourceProp represents the property of a resource in a literal reference
ResourceProp string `cty:"resource_prop"`
// FilePath represents the path for a file reference
FilePath string `cty:"file_path"`
// FileFn represents the function used to reference the file
FileFn fileFn `cty:"file_fn"`
}
var _ json.Marshaler = &Literal{}
func (l *Literal) MarshalJSON() ([]byte, error) {
return json.Marshal(&l.Value)
}
func LiteralFileExpression(modulePath string, base64 bool) *Literal {
fn := fileFnFile
if base64 {
fn = fileFnFileBase64
}
return &Literal{
// file() is hardcoded here because this field is
// used for Terraform 0.11 which does not have filebase64()
Value: fmt.Sprintf("${file(%q)}", modulePath),
FilePath: modulePath,
FileFn: fn,
}
}
func LiteralSelfLink(resourceType, resourceName string) *Literal {
return LiteralProperty(resourceType, resourceName, "self_link")
}
func LiteralProperty(resourceType, resourceName, prop string) *Literal {
tfName := tfSanitize(resourceName)
expr := "${" + resourceType + "." + tfName + "." + prop + "}"
return &Literal{
Value: expr,
ResourceType: resourceType,
ResourceName: tfName,
ResourceProp: prop,
}
}
func LiteralFromStringValue(s string) *Literal {
return &Literal{Value: s}
}
type literalWithJSON struct {
literal *Literal
key string
}
type byKey []*literalWithJSON
func (a byKey) Len() int { return len(a) }
func (a byKey) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
func (a byKey) Less(i, j int) bool {
return a[i].key < a[j].key
}
// buildSortProxies maps a list of Literals to a list of literalWithJSON
func buildSortProxies(v []*Literal) ([]*literalWithJSON, error) {
var proxies []*literalWithJSON
for _, l := range v {
k, err := json.Marshal(l)
if err != nil {
return nil, err
}
proxies = append(proxies, &literalWithJSON{
literal: l,
key: string(k),
})
}
return proxies, nil
}
// SortLiterals sorts a list of Literal, by key. It does so in-place
func SortLiterals(v []*Literal) {
proxies, err := buildSortProxies(v)
if err != nil {
// Very unexpected
klog.Fatalf("error processing terraform Literal: %v", err)
}
sort.Sort(byKey(proxies))
for i := range proxies {
v[i] = proxies[i].literal
}
}
// DedupLiterals removes any duplicate Literals before returning the slice.
// As a side-effect, it currently returns the Literals in sorted order.
func DedupLiterals(v []*Literal) ([]*Literal, error) {
proxies, err := buildSortProxies(v)
if err != nil {
return nil, err
}
sort.Sort(byKey(proxies))
var deduped []*Literal
for i, p := range proxies {
if i != 0 && proxies[i-1].key == proxies[i].key {
continue
}
deduped = append(deduped, p.literal)
}
return deduped, nil
}