Skip to content

Commit

Permalink
return raw data of chart render results (#593)
Browse files Browse the repository at this point in the history 
Signed-off-by: Zhiwei Yin <[email protected]>
  • Loading branch information
@zhiweiyin318
zhiweiyin318 authored Aug 15, 2024
1 parent 3d8cb1e commit e137912
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 66 deletions.
84 changes: 24 additions & 60 deletions pkg/operator/helpers/chartrender/render.go → pkg/operator/helpers/chart/render.go
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
package chartrender
package chart

import (
"bufio"
"embed"
"fmt"
"io"
"io/fs"
"path/filepath"
"strings"
Expand All @@ -13,33 +11,15 @@ import (
"helm.sh/helm/v3/pkg/chart/loader"
"helm.sh/helm/v3/pkg/chartutil"
"helm.sh/helm/v3/pkg/engine"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apiextensionsv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/serializer"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/util/json"
"k8s.io/apimachinery/pkg/util/yaml"
"k8s.io/client-go/kubernetes/scheme"
"k8s.io/klog/v2"

operatorv1 "open-cluster-management.io/api/operator/v1"

clustermanagerchart "open-cluster-management.io/ocm/deploy/cluster-manager/chart"
klusterletchart "open-cluster-management.io/ocm/deploy/klusterlet/chart"
)

var chartScheme = runtime.NewScheme()
var decoder runtime.Decoder

func init() {
_ = scheme.AddToScheme(chartScheme)
_ = apiextensionsv1.AddToScheme(chartScheme)
_ = apiextensionsv1beta1.AddToScheme(chartScheme)
_ = operatorv1.AddToScheme(chartScheme)

decoder = serializer.NewCodecFactory(chartScheme).UniversalDeserializer()
}

func NewDefaultClusterManagerChartConfig() *clustermanagerchart.ChartConfig {
return &clustermanagerchart.ChartConfig{
ReplicaCount: 3,
Expand All @@ -54,7 +34,7 @@ func NewDefaultKlusterletChartConfig() *klusterletchart.ChartConfig {
}

func RenderChart[T *clustermanagerchart.ChartConfig | *klusterletchart.ChartConfig](config T,
namespace string, chartName string, fs embed.FS) ([]runtime.Object, error) {
namespace string, chartName string, fs embed.FS) ([][]byte, error) {
// chartName is the prefix of chart path here
operatorChart, err := LoadChart(fs, chartName)
if err != nil {
Expand All @@ -78,12 +58,12 @@ func RenderChart[T *clustermanagerchart.ChartConfig | *klusterletchart.ChartConf
return nil, err
}

objects, err := renderManifests(operatorChart, values)
rawObjects, err := renderManifests(operatorChart, values)
if err != nil {
return nil, fmt.Errorf("error rendering cluster manager chart: %v", err)
}

return objects, nil
return rawObjects, nil
}

func getFiles(manifestFS embed.FS) ([]string, error) {
Expand Down Expand Up @@ -151,20 +131,16 @@ func JsonStructToValues(a interface{}) (chartutil.Values, error) {
return nil, err
}
return vals, nil

}

func renderManifests(chart *chart.Chart, values chartutil.Values) ([]runtime.Object, error) {
var objects []runtime.Object
func renderManifests(chart *chart.Chart, values chartutil.Values) ([][]byte, error) {
var rawObjects [][]byte

// make sure the CRDs are at the top.
crds := chart.CRDObjects()
for _, crd := range crds {
klog.V(4).Infof("%v/n", crd.File.Data)

object, _, err := decoder.Decode(crd.File.Data, nil, nil)
if err != nil {
return nil, err
}
objects = append(objects, object)
rawObjects = append(rawObjects, crd.File.Data)
}

helmEngine := engine.Engine{
Expand All @@ -174,37 +150,25 @@ func renderManifests(chart *chart.Chart, values chartutil.Values) ([]runtime.Obj

templates, err := helmEngine.Render(chart, values)
if err != nil {
return objects, err
return rawObjects, err
}

for k, data := range templates {
for _, data := range templates {
if len(data) == 0 {
continue
}
klog.V(4).Infof("rendered template: %v", data)

yamlReader := yaml.NewYAMLReader(bufio.NewReader(strings.NewReader(data)))
for {
b, err := yamlReader.Read()
if err == io.EOF {
break
}
if err != nil {
return nil, err
}
if len(b) != 0 {
object, _, err := decoder.Decode(b, nil, nil)
if err != nil {
// In some conditions, resources will not be rendered
if runtime.IsMissingKind(err) {
klog.V(4).Infof("Skipping template %v, reason: %v", k, err)
continue
}
return nil, err
}
objects = append(objects, object)
}

// remove invalid template
unstructuredObj := &unstructured.Unstructured{}
if err = yaml.Unmarshal([]byte(data), unstructuredObj); err != nil {
return nil, fmt.Errorf("error unmarshalling template: %v", err)
}
kind := unstructuredObj.GetKind()
if kind == "" {
continue
}

rawObjects = append(rawObjects, []byte(data))
}
return objects, nil
return rawObjects, nil
}
42 changes: 36 additions & 6 deletions ...erator/helpers/chartrender/render_test.go → pkg/operator/helpers/chart/render_test.go
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package chartrender
package chart

import (
"fmt"
Expand All @@ -8,7 +8,10 @@ import (
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apiextensionsv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/serializer"
"k8s.io/client-go/kubernetes/scheme"
"sigs.k8s.io/yaml"

operatorv1 "open-cluster-management.io/api/operator/v1"
Expand All @@ -24,6 +27,18 @@ const (

var outputDebug = false

var decoder runtime.Decoder
var chartScheme = runtime.NewScheme()

func init() {
_ = scheme.AddToScheme(chartScheme)
_ = apiextensionsv1.AddToScheme(chartScheme)
_ = apiextensionsv1beta1.AddToScheme(chartScheme)
_ = operatorv1.AddToScheme(chartScheme)

decoder = serializer.NewCodecFactory(chartScheme).UniversalDeserializer()
}

func TestClusterManagerConfig(t *testing.T) {
cases := []struct {
name string
Expand Down Expand Up @@ -70,6 +85,7 @@ func TestClusterManagerConfig(t *testing.T) {
expectedObjCnt: 7,
},
}

for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
registry := defaultRegistry
Expand All @@ -91,8 +107,14 @@ func TestClusterManagerConfig(t *testing.T) {
t.Errorf("expected %d objects, got %d", c.expectedObjCnt, len(objects))
}

outputObjs := make([]runtime.Object, 0, len(objects))
for _, o := range objects {
switch object := o.(type) {
obj, _, err := decoder.Decode(o, nil, nil)
if err != nil {
t.Errorf("error decoding object: %v", err)
}
outputObjs = append(outputObjs, obj)
switch object := obj.(type) {
case *appsv1.Deployment:
if object.Namespace != c.namespace {
t.Errorf("expected namespace is %s, but got %s", c.namespace, object.Namespace)
Expand All @@ -117,7 +139,9 @@ func TestClusterManagerConfig(t *testing.T) {
}

// output is for debug
// output(t, c.name, objects...)
if outputDebug {
output(t, c.name, outputObjs...)
}
})
}
}
Expand Down Expand Up @@ -190,6 +214,7 @@ func TestKlusterletConfig(t *testing.T) {
expectedObjCnt: 2,
},
}

for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
registry := defaultRegistry
Expand All @@ -210,8 +235,14 @@ func TestKlusterletConfig(t *testing.T) {
t.Errorf("expected %d objects, got %d", c.expectedObjCnt, len(objects))
}

outputObjs := make([]runtime.Object, 0, len(objects))
for _, o := range objects {
switch object := o.(type) {
obj, _, err := decoder.Decode(o, nil, nil)
if err != nil {
t.Errorf("error decoding object: %v", err)
}
outputObjs = append(outputObjs, obj)
switch object := obj.(type) {
case *appsv1.Deployment:
if object.Namespace != c.namespace {
t.Errorf("expected namespace is %s, but got %s", c.namespace, object.Namespace)
Expand Down Expand Up @@ -277,12 +308,11 @@ func TestKlusterletConfig(t *testing.T) {
}

}

}

// output is for debug
if outputDebug {
output(t, c.name, objects...)
output(t, c.name, outputObjs...)
}
})
}
Expand Down

0 comments on commit e137912

Please sign in to comment.