forked from argoproj/argo-workflows
-
Notifications
You must be signed in to change notification settings - Fork 0
/
context.go
173 lines (150 loc) · 6.38 KB
/
context.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
package templateresolution
import (
"github.com/argoproj/argo/errors"
wfv1 "github.com/argoproj/argo/pkg/apis/workflow/v1alpha1"
typed "github.com/argoproj/argo/pkg/client/clientset/versioned/typed/workflow/v1alpha1"
"github.com/argoproj/argo/workflow/common"
log "github.com/sirupsen/logrus"
apierr "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// maxResolveDepth is the limit of template reference resolution.
const maxResolveDepth int = 10
// workflowTemplateInterfaceWrapper is an internal struct to wrap clientset.
type workflowTemplateInterfaceWrapper struct {
clientset typed.WorkflowTemplateInterface
}
// Get retrieves the WorkflowTemplate of a given name.
func (wrapper *workflowTemplateInterfaceWrapper) Get(name string) (*wfv1.WorkflowTemplate, error) {
return wrapper.clientset.Get(name, metav1.GetOptions{})
}
// WorkflowTemplateNamespaceLister helps get WorkflowTemplates.
type WorkflowTemplateNamespacedGetter interface {
// Get retrieves the WorkflowTemplate from the indexer for a given name.
Get(name string) (*wfv1.WorkflowTemplate, error)
}
// Context is a context of template search.
type Context struct {
// wftmplGetter is an interface to get WorkflowTemplates.
wftmplGetter WorkflowTemplateNamespacedGetter
// tmplBase is the base of local template search.
tmplBase wfv1.TemplateGetter
}
// NewContext returns new Context.
func NewContext(wftmplGetter WorkflowTemplateNamespacedGetter, tmplBase wfv1.TemplateGetter) *Context {
return &Context{
wftmplGetter: wftmplGetter,
tmplBase: tmplBase,
}
}
// NewContext returns new Context.
func NewContextFromClientset(clientset typed.WorkflowTemplateInterface, tmplBase wfv1.TemplateGetter) *Context {
return &Context{
wftmplGetter: &workflowTemplateInterfaceWrapper{clientset: clientset},
tmplBase: tmplBase,
}
}
// GetTemplateByName returns a template by name in the context.
func (ctx *Context) GetTemplateByName(name string) (*wfv1.Template, error) {
tmpl := ctx.tmplBase.GetTemplateByName(name)
if tmpl == nil {
return nil, errors.Errorf(errors.CodeNotFound, "template %s not found", name)
}
return tmpl.DeepCopy(), nil
}
// GetTemplateFromRef returns a template found by a given template ref.
func (ctx *Context) GetTemplateFromRef(tmplRef *wfv1.TemplateRef) (*wfv1.Template, error) {
wftmpl, err := ctx.wftmplGetter.Get(tmplRef.Name)
if err != nil {
if apierr.IsNotFound(err) {
return nil, errors.Errorf(errors.CodeNotFound, "workflow template %s not found", tmplRef.Name)
}
return nil, err
}
tmpl := wftmpl.GetTemplateByName(tmplRef.Template)
if tmpl == nil {
return nil, errors.Errorf(errors.CodeNotFound, "template %s not found in workflow template %s", tmplRef.Template, tmplRef.Name)
}
return tmpl.DeepCopy(), nil
}
// GetTemplate returns a template found by template name or template ref.
func (ctx *Context) GetTemplate(tmplHolder wfv1.TemplateHolder) (*wfv1.Template, error) {
log.Debugf("Getting the template of %s on %s", common.GetTemplateHolderString(tmplHolder), common.GetTemplateGetterString(ctx.tmplBase))
tmplName := tmplHolder.GetTemplateName()
tmplRef := tmplHolder.GetTemplateRef()
if tmplRef != nil {
return ctx.GetTemplateFromRef(tmplRef)
} else if tmplName != "" {
return ctx.GetTemplateByName(tmplName)
} else {
if tmpl, ok := tmplHolder.(*wfv1.Template); ok {
if tmpl.GetType() != wfv1.TemplateTypeUnknown {
return tmpl.DeepCopy(), nil
}
return nil, errors.Errorf(errors.CodeNotFound, "template %s is not a concrete template", tmpl.Name)
}
}
return nil, errors.Errorf(errors.CodeInternal, "failed to get a template")
}
// GetTemplateBase returns a template base of a found template.
func (ctx *Context) GetTemplateBase(tmplHolder wfv1.TemplateHolder) (wfv1.TemplateGetter, error) {
tmplRef := tmplHolder.GetTemplateRef()
if tmplRef != nil {
wftmpl, err := ctx.wftmplGetter.Get(tmplRef.Name)
if err != nil && apierr.IsNotFound(err) {
return nil, errors.Errorf(errors.CodeNotFound, "workflow template %s not found", tmplRef.Name)
}
return wftmpl, err
} else {
return ctx.tmplBase, nil
}
}
// ResolveTemplate digs into referenes and returns a merged template.
// This method is the public start point of template resolution.
func (ctx *Context) ResolveTemplate(tmplHolder wfv1.TemplateHolder, args wfv1.ArgumentsProvider, globalParams, localParams map[string]string, validateOnly bool) (*Context, *wfv1.Template, error) {
return ctx.resolveTemplateImpl(tmplHolder, args, globalParams, localParams, validateOnly, 0)
}
// resolveTemplateImpl digs into referenes and returns a merged template.
func (ctx *Context) resolveTemplateImpl(tmplHolder wfv1.TemplateHolder, args wfv1.ArgumentsProvider, globalParams, localParams map[string]string, validateOnly bool, depth int) (*Context, *wfv1.Template, error) {
// Avoid infinite references
if depth > maxResolveDepth {
return nil, nil, errors.Errorf(errors.CodeBadRequest, "template reference exceeded max depth (%d)", maxResolveDepth)
}
log.Debugf("Resolving %s on %s (%d)", common.GetTemplateHolderString(tmplHolder), common.GetTemplateGetterString(ctx.tmplBase), depth)
// Find template and context
tmpl, err := ctx.GetTemplate(tmplHolder)
if err != nil {
return nil, nil, err
}
newTmplBase, err := ctx.GetTemplateBase(tmplHolder)
if err != nil {
return nil, nil, err
}
newTmplCtx := ctx.WithTemplateBase(newTmplBase)
tmpTmpl := &wfv1.Template{Inputs: *tmpl.Inputs.DeepCopy(), Arguments: *tmpl.Arguments.DeepCopy()}
processedTmpl, err := common.ProcessArgs(tmpTmpl, args, globalParams, localParams, validateOnly)
if err != nil {
return nil, nil, err
}
tmpl.Inputs = processedTmpl.Inputs
tmpl.Arguments = processedTmpl.Arguments
// Return a concrete template without digging into it.
if tmpl.GetType() != wfv1.TemplateTypeUnknown {
return newTmplCtx, tmpl, nil
}
// Dig into nested references with new template base.
finalTmplCtx, newTmpl, err := newTmplCtx.resolveTemplateImpl(tmpl, &tmpl.Arguments, globalParams, localParams, validateOnly, depth+1)
if err != nil {
return nil, nil, err
}
// Merge the referred template into the original.
mergedTmpl, err := common.MergeReferredTemplate(tmpl, newTmpl)
if err != nil {
return nil, nil, err
}
return finalTmplCtx, mergedTmpl, nil
}
// WithTemplateBase creates new context with a wfv1.TemplateGetter.
func (ctx *Context) WithTemplateBase(tmplBase wfv1.TemplateGetter) *Context {
return NewContext(ctx.wftmplGetter, tmplBase)
}