Skip to content

Commit d259a09

Browse files
bpareesbparees
committed
allow namespace specification via parameter in templates
1 parent c07de24 commit d259a09

File tree

4 files changed

+158
-8
lines changed

4 files changed

+158
-8
lines changed

‎pkg/config/cmd/cmd.go

+3
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,9 @@ func HaltOnError(fn AfterFunc) AfterFunc {
131131

132132
// Create is the default create operation for a generic resource.
133133
func Create(info *resource.Info, namespace string, obj runtime.Object) (runtime.Object, error) {
134+
if len(info.Namespace) > 0 {
135+
namespace = info.Namespace
136+
}
134137
return resource.NewHelper(info.Client, info.Mapping).Create(namespace, false, obj)
135138
}
136139

‎pkg/template/template.go

+9-8
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,16 @@ func (p *Processor) Process(template *api.Template) field.ErrorList {
6565
item = decodedObj
6666
}
6767

68-
newItem, err := p.SubstituteParameters(paramMap, item)
69-
if err != nil {
70-
templateErrors = append(templateErrors, field.Invalid(idxPath.Child("parameters"), template.Parameters, err.Error()))
71-
}
7268
// If an object definition's metadata includes a namespace field, the field will be stripped out of
7369
// the definition during template instantiation. This is necessary because all objects created during
7470
// instantiation are placed into the target namespace, so it would be invalid for the object to declare
7571
//a different namespace.
76-
stripNamespace(newItem)
72+
stripNamespace(item)
73+
74+
newItem, err := p.SubstituteParameters(paramMap, item)
75+
if err != nil {
76+
templateErrors = append(templateErrors, field.Invalid(idxPath.Child("parameters"), template.Parameters, err.Error()))
77+
}
7778
if err := util.AddObjectLabels(newItem, template.ObjectLabels); err != nil {
7879
templateErrors = append(templateErrors, field.Invalid(idxPath.Child("labels"),
7980
template.ObjectLabels, fmt.Sprintf("label could not be applied: %v", err)))
@@ -86,21 +87,21 @@ func (p *Processor) Process(template *api.Template) field.ErrorList {
8687

8788
func stripNamespace(obj runtime.Object) {
8889
// Remove namespace from the item
89-
if itemMeta, err := meta.Accessor(obj); err == nil && len(itemMeta.GetNamespace()) > 0 {
90+
if itemMeta, err := meta.Accessor(obj); err == nil && len(itemMeta.GetNamespace()) > 0 && !stringParameterExp.MatchString(itemMeta.GetNamespace()) {
9091
itemMeta.SetNamespace("")
9192
return
9293
}
9394
// TODO: allow meta.Accessor to handle runtime.Unstructured
9495
if unstruct, ok := obj.(*runtime.Unstructured); ok && unstruct.Object != nil {
9596
if obj, ok := unstruct.Object["metadata"]; ok {
9697
if m, ok := obj.(map[string]interface{}); ok {
97-
if _, ok := m["namespace"]; ok {
98+
if _, ok := m["namespace"]; ok && !stringParameterExp.MatchString(m["namespace"].(string)) {
9899
m["namespace"] = ""
99100
}
100101
}
101102
return
102103
}
103-
if _, ok := unstruct.Object["namespace"]; ok {
104+
if _, ok := unstruct.Object["namespace"]; ok && stringParameterExp.MatchString(unstruct.Object["namespace"].(string)) {
104105
unstruct.Object["namespace"] = ""
105106
return
106107
}

‎test/cmd/newapp.sh

+17
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ trap os::test::junit::reconcile_output EXIT
66
(
77
set +e
88
# oc delete all,templates --all
9+
oc delete-project template-substitute
10+
oc delete-project prefix-template-substitute
911
exit 0
1012
) &>/dev/null
1113

@@ -50,6 +52,21 @@ os::cmd::expect_failure 'oc get dc/mysql'
5052
os::cmd::expect_failure 'oc get dc/php'
5153
os::cmd::expect_success_and_text 'oc new-app -f test/testdata/template-without-app-label.json -o yaml' 'app: ruby-helloworld-sample'
5254

55+
# check object namespace handling
56+
# hardcoded values should be stripped
57+
os::cmd::expect_success_and_not_text 'oc new-app -f test/testdata/template-with-namespaces.json -o yaml' 'namespace: STRIPPED'
58+
# normal parameterized values should be substituted and retained
59+
os::cmd::expect_success_and_text 'oc new-app -f test/testdata/template-with-namespaces.json -o yaml' 'namespace: substituted'
60+
os::cmd::expect_success_and_text 'oc new-app -f test/testdata/template-with-namespaces.json -o yaml' 'namespace: prefix-substituted'
61+
# non-string parameterized values should be stripped
62+
os::cmd::expect_success_and_not_text 'oc new-app -f test/testdata/template-with-namespaces.json -o yaml' 'namespace: ${{SUBSTITUTED}}'
63+
os::cmd::expect_success_and_not_text 'oc new-app -f test/testdata/template-with-namespaces.json -o yaml' 'namespace: pre-${{SUBSTITUTED}}'
64+
# ensure the objects can actually get created with a namespace specified
65+
os::cmd::expect_success 'oc new-project template-substitute'
66+
os::cmd::expect_success 'oc new-project prefix-template-substitute'
67+
os::cmd::expect_success 'oc new-app -f test/testdata/template-with-namespaces.json -p SUBSTITUTED=template-substitute'
68+
os::cmd::expect_success 'oc delete all -l app=ruby-hello-world-sample'
69+
5370
# ensure non-duplicate invalid label errors show up
5471
os::cmd::expect_failure_and_text 'oc new-app nginx -l qwer1345%$$#=self' 'error: ImageStream "nginx" is invalid'
5572
os::cmd::expect_failure_and_text 'oc new-app nginx -l qwer1345%$$#=self' 'DeploymentConfig "nginx" is invalid'

‎test/testdata/template-with-namespaces.json

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
{
2+
"kind": "Template",
3+
"apiVersion": "v1",
4+
"metadata": {
5+
"name": "ruby-helloworld-sample",
6+
"creationTimestamp": null,
7+
"annotations": {
8+
"description": "some objects in this template declare their own namespace via a parameter confirm new-app will tolerate it",
9+
"iconClass": "icon-ruby",
10+
"tags": "instant-app,ruby,mysql"
11+
}
12+
},
13+
"objects": [
14+
{
15+
"kind": "Service",
16+
"apiVersion": "v1",
17+
"metadata": {
18+
"name": "frontend",
19+
"namespace": "STRIPPED"
20+
},
21+
"spec": {
22+
"ports": [
23+
{
24+
"name": "web",
25+
"protocol": "TCP",
26+
"port": 5432,
27+
"targetPort": 8080,
28+
"nodePort": 0
29+
}
30+
],
31+
"selector": {
32+
"name": "frontend"
33+
},
34+
"type": "ClusterIP",
35+
"sessionAffinity": "None"
36+
},
37+
"status": {
38+
"loadBalancer": {}
39+
}
40+
},
41+
{
42+
"kind": "Route",
43+
"apiVersion": "v1",
44+
"metadata": {
45+
"name": "route-edge",
46+
"namespace": "${SUBSTITUTED}"
47+
},
48+
"spec": {
49+
"host": "www.example.com",
50+
"to": {
51+
"kind": "Service",
52+
"name": "frontend"
53+
},
54+
"tls": {
55+
"termination": "edge"
56+
}
57+
},
58+
"status": {}
59+
},
60+
{
61+
"kind": "Route",
62+
"apiVersion": "v1",
63+
"metadata": {
64+
"name": "route-edge2",
65+
"namespace": "${{SUBSTITUTED}}"
66+
},
67+
"spec": {
68+
"host": "www.example.com",
69+
"to": {
70+
"kind": "Service",
71+
"name": "frontend"
72+
},
73+
"tls": {
74+
"termination": "edge"
75+
}
76+
},
77+
"status": {}
78+
},
79+
{
80+
"kind": "Route",
81+
"apiVersion": "v1",
82+
"metadata": {
83+
"name": "route-edge3",
84+
"namespace": "prefix-${SUBSTITUTED}"
85+
},
86+
"spec": {
87+
"host": "www.example.com",
88+
"to": {
89+
"kind": "Service",
90+
"name": "frontend"
91+
},
92+
"tls": {
93+
"termination": "edge"
94+
}
95+
},
96+
"status": {}
97+
},
98+
{
99+
"kind": "Route",
100+
"apiVersion": "v1",
101+
"metadata": {
102+
"name": "route-edge4",
103+
"namespace": "prefix-${{SUBSTITUTED}}"
104+
},
105+
"spec": {
106+
"host": "www.example.com",
107+
"to": {
108+
"kind": "Service",
109+
"name": "frontend"
110+
},
111+
"tls": {
112+
"termination": "edge"
113+
}
114+
},
115+
"status": {}
116+
}
117+
],
118+
"parameters": [
119+
{
120+
"name": "SUBSTITUTED",
121+
"description": "namespace value",
122+
"value": "substituted",
123+
"required": true
124+
}
125+
],
126+
"labels": {
127+
"template": "application-template-stibuild"
128+
}
129+
}

0 commit comments

Comments
 (0)