-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add transformer for appending suffix
- Loading branch information
Showing
6 changed files
with
250 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| Copyright 2018 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 defaultconfig | ||
|
|
||
| const ( | ||
| nameSuffixFieldSpecs = ` | ||
| nameSuffix: | ||
| - path: metadata/name | ||
| ` | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /* | ||
| Copyright 2018 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 transformers | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "log" | ||
|
|
||
| "sigs.k8s.io/kustomize/pkg/gvk" | ||
| "sigs.k8s.io/kustomize/pkg/resmap" | ||
| "sigs.k8s.io/kustomize/pkg/transformers/config" | ||
| ) | ||
|
|
||
| // nameSuffixTransformer contains the suffix and the FieldSpecs | ||
| // for each field needing a name suffix. | ||
| type nameSuffixTransformer struct { | ||
| suffix string | ||
| fieldSpecsToUse []config.FieldSpec | ||
| fieldSpecsToSkip []config.FieldSpec | ||
| } | ||
|
|
||
| var _ Transformer = &nameSuffixTransformer{} | ||
|
|
||
| var suffixFieldSpecsToSkip = []config.FieldSpec{ | ||
| { | ||
| Gvk: gvk.Gvk{Kind: "CustomResourceDefinition"}, | ||
| }, | ||
| } | ||
|
|
||
| // deprecateNameSuffixFieldSpec will be moved into suffixFieldSpecsToSkip in next release | ||
| var deprecateNameSuffixFieldSpec = config.FieldSpec{ | ||
| Gvk: gvk.Gvk{Kind: "Namespace"}, | ||
| } | ||
|
|
||
| // NewNameSuffixTransformer construct a nameSuffixTransformer. | ||
| func NewNameSuffixTransformer(ns string, pc []config.FieldSpec) (Transformer, error) { | ||
| if len(ns) == 0 { | ||
| return NewNoOpTransformer(), nil | ||
| } | ||
| if pc == nil { | ||
| return nil, errors.New("fieldSpecs is not expected to be nil") | ||
| } | ||
| return &nameSuffixTransformer{fieldSpecsToUse: pc, suffix: ns, fieldSpecsToSkip: suffixFieldSpecsToSkip}, nil | ||
| } | ||
|
|
||
| // Transform appends the name suffix. | ||
| func (o *nameSuffixTransformer) Transform(m resmap.ResMap) error { | ||
| // Fill map "mf" with entries subject to name modification, and | ||
| // delete these entries from "m", so that for now m retains only | ||
| // the entries whose names will not be modified. | ||
| mf := resmap.ResMap{} | ||
| for id := range m { | ||
| found := false | ||
| for _, path := range o.fieldSpecsToSkip { | ||
| if id.Gvk().IsSelected(&path.Gvk) { | ||
| found = true | ||
| break | ||
| } | ||
| } | ||
| if !found { | ||
| mf[id] = m[id] | ||
| delete(m, id) | ||
| } | ||
| } | ||
|
|
||
| for id := range mf { | ||
| if id.Gvk().IsSelected(&deprecateNameSuffixFieldSpec.Gvk) { | ||
| log.Println("Adding name suffix to Namespace resource will be deprecated in next release.") | ||
| } | ||
| objMap := mf[id].Map() | ||
| for _, path := range o.fieldSpecsToUse { | ||
| if !id.Gvk().IsSelected(&path.Gvk) { | ||
| continue | ||
| } | ||
| err := mutateField(objMap, path.PathSlice(), path.CreateIfNotPresent, o.addSuffix) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| newId := id.CopyWithNewSuffix(o.suffix) | ||
| m[newId] = mf[id] | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (o *nameSuffixTransformer) addSuffix(in interface{}) (interface{}, error) { | ||
| s, ok := in.(string) | ||
| if !ok { | ||
| return nil, fmt.Errorf("%#v is expectd to be %T", in, s) | ||
| } | ||
| return s + o.suffix, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /* | ||
| Copyright 2018 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 transformers | ||
|
|
||
| import ( | ||
| "reflect" | ||
| "testing" | ||
|
|
||
| "sigs.k8s.io/kustomize/k8sdeps/kunstruct" | ||
| "sigs.k8s.io/kustomize/pkg/resid" | ||
| "sigs.k8s.io/kustomize/pkg/resmap" | ||
| "sigs.k8s.io/kustomize/pkg/resource" | ||
| ) | ||
|
|
||
| func TestSuffixNameRun(t *testing.T) { | ||
| rf := resource.NewFactory( | ||
| kunstruct.NewKunstructuredFactoryImpl()) | ||
| m := resmap.ResMap{ | ||
| resid.NewResId(cmap, "cm1"): rf.FromMap( | ||
| map[string]interface{}{ | ||
| "apiVersion": "v1", | ||
| "kind": "ConfigMap", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "cm1", | ||
| }, | ||
| }), | ||
| resid.NewResId(cmap, "cm2"): rf.FromMap( | ||
| map[string]interface{}{ | ||
| "apiVersion": "v1", | ||
| "kind": "ConfigMap", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "cm2", | ||
| }, | ||
| }), | ||
| resid.NewResId(crd, "crd"): rf.FromMap( | ||
| map[string]interface{}{ | ||
| "apiVersion": "apiextensions.k8s.io/v1beta1", | ||
| "kind": "CustomResourceDefinition", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "crd", | ||
| }, | ||
| }), | ||
| } | ||
| expected := resmap.ResMap{ | ||
| resid.NewResIdWithSuffix(cmap, "cm1", "-somesuffix"): rf.FromMap( | ||
| map[string]interface{}{ | ||
| "apiVersion": "v1", | ||
| "kind": "ConfigMap", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "cm1-somesuffix", | ||
| }, | ||
| }), | ||
| resid.NewResIdWithSuffix(cmap, "cm2", "-somesuffix"): rf.FromMap( | ||
| map[string]interface{}{ | ||
| "apiVersion": "v1", | ||
| "kind": "ConfigMap", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "cm2-somesuffix", | ||
| }, | ||
| }), | ||
| resid.NewResId(crd, "crd"): rf.FromMap( | ||
| map[string]interface{}{ | ||
| "apiVersion": "apiextensions.k8s.io/v1beta1", | ||
| "kind": "CustomResourceDefinition", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "crd", | ||
| }, | ||
| }), | ||
| } | ||
|
|
||
| npt, err := NewNameSuffixTransformer( | ||
| "-somesuffix", defaultTransformerConfig.NameSuffix) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %v", err) | ||
| } | ||
| err = npt.Transform(m) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %v", err) | ||
| } | ||
| if !reflect.DeepEqual(m, expected) { | ||
| err = expected.ErrorIfNotEqual(m) | ||
| t.Fatalf("actual doesn't match expected: %v", err) | ||
| } | ||
| } |