Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Label release resources with HelmRelease origin #238

Merged
merged 1 commit into from
Mar 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions internal/runner/post_renderer_origin_labels.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
/*
Copyright 2021 The Flux 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 runner

import (
"bytes"
"fmt"

"sigs.k8s.io/kustomize/api/builtins"
"sigs.k8s.io/kustomize/api/k8sdeps/kunstruct"
"sigs.k8s.io/kustomize/api/resmap"
"sigs.k8s.io/kustomize/api/resource"
kustypes "sigs.k8s.io/kustomize/api/types"

v2 "github.com/fluxcd/helm-controller/api/v2beta1"
)

func newPostRendererOriginLabels(release *v2.HelmRelease) *postRendererOriginLabels {
return &postRendererOriginLabels{
name: release.ObjectMeta.Name,
namespace: release.ObjectMeta.Namespace,
}
}

type postRendererOriginLabels struct {
name string
namespace string
}

func (k *postRendererOriginLabels) Run(renderedManifests *bytes.Buffer) (modifiedManifests *bytes.Buffer, err error) {
resFactory := resource.NewFactory(kunstruct.NewKunstructuredFactoryImpl())
resMapFactory := resmap.NewFactory(resFactory, nil)

resMap, err := resMapFactory.NewResMapFromBytes(renderedManifests.Bytes())
if err != nil {
return nil, err
}

labelTransformer := builtins.LabelTransformerPlugin{
Labels: originLabels(k.name, k.namespace),
FieldSpecs: []kustypes.FieldSpec{
{Path: "metadata/labels", CreateIfNotPresent: true},
},
}
if err := labelTransformer.Transform(resMap); err != nil {
return nil, err
}

yaml, err := resMap.AsYaml()
if err != nil {
return nil, err
}

return bytes.NewBuffer(yaml), nil
}

func originLabels(name, namespace string) map[string]string {
return map[string]string{
fmt.Sprintf("%s/name", v2.GroupVersion.Group): name,
fmt.Sprintf("%s/namespace", v2.GroupVersion.Group): namespace,
}
}
83 changes: 83 additions & 0 deletions internal/runner/post_renderer_origin_labels_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
/*
Copyright 2021 The Flux 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 runner

import (
"bytes"
"reflect"
"testing"
)

const mixedResourceMock = `apiVersion: v1
kind: Pod
metadata:
name: pod-without-labels
---
apiVersion: v1
kind: Service
metadata:
name: service-with-labels
labels:
existing: label
`

func Test_postRendererOriginLabels_Run(t *testing.T) {
tests := []struct {
name string
renderedManifests string
expectManifests string
expectErr bool
}{
{
name: "labels",
renderedManifests: mixedResourceMock,
expectManifests: `apiVersion: v1
kind: Pod
metadata:
labels:
helm.toolkit.fluxcd.io/name: name
helm.toolkit.fluxcd.io/namespace: namespace
name: pod-without-labels
---
apiVersion: v1
kind: Service
metadata:
labels:
existing: label
helm.toolkit.fluxcd.io/name: name
helm.toolkit.fluxcd.io/namespace: namespace
name: service-with-labels
`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
k := &postRendererOriginLabels{
name: "name",
namespace: "namespace",
}
gotModifiedManifests, err := k.Run(bytes.NewBufferString(tt.renderedManifests))
if (err != nil) != tt.expectErr {
t.Errorf("Run() error = %v, expectErr %v", err, tt.expectErr)
return
}
if !reflect.DeepEqual(gotModifiedManifests, bytes.NewBufferString(tt.expectManifests)) {
t.Errorf("Run() gotModifiedManifests = %v, want %v", gotModifiedManifests, tt.expectManifests)
}
})
}
}
1 change: 1 addition & 0 deletions internal/runner/runner.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ func postRenderers(hr v2.HelmRelease) (postrender.PostRenderer, error) {
combinedRenderer.addRenderer(newPostRendererKustomize(r.Kustomize))
}
}
combinedRenderer.addRenderer(newPostRendererOriginLabels(&hr))
if len(combinedRenderer.renderers) == 0 {
return nil, nil
}
Expand Down