-
Notifications
You must be signed in to change notification settings - Fork 416
/
resource.go
179 lines (155 loc) · 6.71 KB
/
resource.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
/*
Copyright 2019 The Tekton 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 template
import (
"bytes"
"context"
"encoding/json"
"fmt"
"strings"
triggersv1 "github.com/tektoncd/triggers/pkg/apis/triggers/v1alpha1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/rand"
)
// uidMatch determines the uid variable within the resource template
var uidMatch = []byte(`$(uid)`)
// ResolvedTrigger contains the dereferenced TriggerBindings and
// TriggerTemplate after resolving the k8s ObjectRef.
type ResolvedTrigger struct {
TriggerBindings []*triggersv1.TriggerBinding
ClusterTriggerBindings []*triggersv1.ClusterTriggerBinding
TriggerTemplate *triggersv1.TriggerTemplate
BindingParams []triggersv1.Param
}
type getTriggerBinding func(ctx context.Context, name string, options metav1.GetOptions) (*triggersv1.TriggerBinding, error)
type getTriggerTemplate func(ctx context.Context, name string, options metav1.GetOptions) (*triggersv1.TriggerTemplate, error)
type getClusterTriggerBinding func(ctx context.Context, name string, options metav1.GetOptions) (*triggersv1.ClusterTriggerBinding, error)
// ResolveTrigger takes in a trigger containing object refs to bindings and
// templates and resolves them to their underlying values.
func ResolveTrigger(trigger triggersv1.EventListenerTrigger, getTB getTriggerBinding, getCTB getClusterTriggerBinding, getTT getTriggerTemplate) (ResolvedTrigger, error) {
bp, err := resolveBindingsToParams(trigger.Bindings, getTB, getCTB)
if err != nil {
return ResolvedTrigger{}, fmt.Errorf("failed to resolve bindings: %w", err)
}
var resolvedTT *triggersv1.TriggerTemplate
if trigger.Template.Spec != nil {
resolvedTT = &triggersv1.TriggerTemplate{
ObjectMeta: metav1.ObjectMeta{}, // Unused. TODO: Just return Specs from here.
Spec: *trigger.Template.Spec,
}
} else {
var ttName string
if trigger.Template.Ref != nil {
ttName = *trigger.Template.Ref
} else {
// TODO(#791): Remove Name field
// Ignore staticcheck linter as it will complain about using deprecated type
ttName = trigger.Template.Name //nolint:staticcheck
}
resolvedTT, err = getTT(context.Background(), ttName, metav1.GetOptions{})
if err != nil {
return ResolvedTrigger{}, fmt.Errorf("error getting TriggerTemplate %s: %w", ttName, err)
}
}
return ResolvedTrigger{TriggerTemplate: resolvedTT, BindingParams: bp}, nil
}
// resolveBindingsToParams takes in both embedded bindings and references and returns a list of resolved Param values.ResolveBindingsToParams
func resolveBindingsToParams(bindings []*triggersv1.TriggerSpecBinding, getTB getTriggerBinding, getCTB getClusterTriggerBinding) ([]triggersv1.Param, error) {
bindingParams := []triggersv1.Param{}
for _, b := range bindings {
switch {
case b.Spec != nil: // Could also call SetDefaults and not rely on this?
bindingParams = append(bindingParams, b.Spec.Params...)
case b.Name != "" && b.Value != nil:
bindingParams = append(bindingParams, triggersv1.Param{
Name: b.Name,
Value: *b.Value,
})
case b.Ref != "" && b.Kind == triggersv1.ClusterTriggerBindingKind:
ctb, err := getCTB(context.Background(), b.Ref, metav1.GetOptions{})
if err != nil {
return nil, fmt.Errorf("error getting ClusterTriggerBinding %s: %w", b.Name, err)
}
bindingParams = append(bindingParams, ctb.Spec.Params...)
case b.Ref != "": // if no kind is set, assume NamespacedTriggerBinding
tb, err := getTB(context.Background(), b.Ref, metav1.GetOptions{})
if err != nil {
return nil, fmt.Errorf("error getting TriggerBinding %s: %w", b.Name, err)
}
bindingParams = append(bindingParams, tb.Spec.Params...)
default:
return nil, fmt.Errorf("invalid binding: %v", b)
}
}
// Check for duplicate params
seen := make(map[string]bool, len(bindingParams))
for _, p := range bindingParams {
if seen[p.Name] {
return nil, fmt.Errorf("duplicate param name: %s", p.Name)
}
seen[p.Name] = true
}
return bindingParams, nil
}
// applyParamsToResourceTemplate returns the TriggerResourceTemplate with the
// param values substituted for all matching param variables in the template
func applyParamsToResourceTemplate(params []triggersv1.Param, rt json.RawMessage) json.RawMessage {
// Assume the params are valid
for _, param := range params {
rt = applyParamToResourceTemplate(param, rt)
}
return rt
}
// applyParamToResourceTemplate returns the TriggerResourceTemplate with the
// param value substituted for all matching param variables in the template
func applyParamToResourceTemplate(param triggersv1.Param, rt json.RawMessage) json.RawMessage {
// Assume the param is valid
paramVariable := fmt.Sprintf("$(tt.params.%s)", param.Name)
// Escape quotes so that that JSON strings can be appended to regular strings.
// See #257 for discussion on this behavior.
paramValue := strings.Replace(param.Value, `"`, `\"`, -1)
rt = bytes.Replace(rt, []byte(paramVariable), []byte(paramValue), -1)
return rt
}
// UID generates a random string like the Kubernetes apiserver generateName metafield postfix.
var UID = func() string { return rand.String(5) }
// applyUIDToResourceTemplate returns the TriggerResourceTemplate after uid replacement
// The same uid should be used per trigger to properly address resources throughout the TriggerTemplate.
func applyUIDToResourceTemplate(rt json.RawMessage, uid string) json.RawMessage {
return bytes.Replace(rt, uidMatch, []byte(uid), -1)
}
func convertParamMapToArray(paramMap map[string]string) []triggersv1.Param {
params := []triggersv1.Param{}
for name, value := range paramMap {
params = append(params, triggersv1.Param{Name: name, Value: value})
}
return params
}
// mergeBindingParams merges params across multiple bindings.
func mergeBindingParams(bindings []*triggersv1.TriggerBinding, clusterbindings []*triggersv1.ClusterTriggerBinding) ([]triggersv1.Param, error) {
params := []triggersv1.Param{}
for _, b := range bindings {
params = append(params, b.Spec.Params...)
}
for _, cb := range clusterbindings {
params = append(params, cb.Spec.Params...)
}
seen := make(map[string]bool, len(params))
for _, p := range params {
if seen[p.Name] {
return nil, fmt.Errorf("duplicate param name: %s", p.Name)
}
seen[p.Name] = true
}
return params, nil
}