source-controller/internal/helm/chart_test.go

/*
Copyright 2020 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 helm

import (
	"reflect"
	"testing"

	. "github.com/onsi/gomega"
	helmchart "helm.sh/helm/v3/pkg/chart"
	"helm.sh/helm/v3/pkg/chartutil"
)

var (
	originalValuesFixture = []byte("override: original")
	chartFilesFixture     = []*helmchart.File{
		{
			Name: "values.yaml",
			Data: originalValuesFixture,
		},
	}
	chartFixture = helmchart.Chart{
		Metadata: &helmchart.Metadata{
			Name:    "test",
			Version: "0.1.0",
		},
		Raw:   chartFilesFixture,
		Files: chartFilesFixture,
	}
)

func TestOverwriteChartDefaultValues(t *testing.T) {
	invalidChartFixture := chartFixture
	invalidChartFixture.Raw = []*helmchart.File{}
	invalidChartFixture.Files = []*helmchart.File{}

	testCases := []struct {
		desc      string
		chart     helmchart.Chart
		data      []byte
		ok        bool
		expectErr bool
	}{
		{
			desc:      "invalid chart",
			chart:     invalidChartFixture,
			data:      originalValuesFixture,
			expectErr: true,
		},
		{
			desc:  "identical override",
			chart: chartFixture,
			data:  originalValuesFixture,
		},
		{
			desc:  "valid override",
			chart: chartFixture,
			ok:    true,
			data:  []byte("override: test"),
		},
		{
			desc:  "empty override",
			chart: chartFixture,
			ok:    true,
			data:  []byte(""),
		},
		{
			desc:      "invalid",
			chart:     chartFixture,
			data:      []byte("!fail:"),
			expectErr: true,
		},
	}
	for _, tt := range testCases {
		t.Run(tt.desc, func(t *testing.T) {
			fixture := tt.chart
			ok, err := OverwriteChartDefaultValues(&fixture, tt.data)
			if ok != tt.ok {
				t.Fatalf("should return %v, returned %v", tt.ok, ok)
			}
			if err != nil && !tt.expectErr {
				t.Fatalf("returned unexpected error: %v", err)
			}
			if err == nil && tt.expectErr {
				t.Fatal("expected error")
			}

			for _, f := range fixture.Raw {
				if f.Name == chartutil.ValuesfileName && reflect.DeepEqual(f.Data, originalValuesFixture) && tt.ok {
					t.Error("should override values.yaml in Raw field")
				}
			}
			for _, f := range fixture.Files {
				if f.Name == chartutil.ValuesfileName && reflect.DeepEqual(f.Data, originalValuesFixture) && tt.ok {
					t.Error("should override values.yaml in Files field")
				}
			}
		})
	}
}

func Test_LoadChartMetadataFromDir(t *testing.T) {
	tests := []struct {
		name                string
		dir                 string
		wantName            string
		wantVersion         string
		wantDependencyCount int
		wantErr             string
	}{
		{
			name:        "Loads from dir",
			dir:         "testdata/charts/helmchart",
			wantName:    "helmchart",
			wantVersion: "0.1.0",
		},
		{
			name:                "Loads from v1 dir including requirements.yaml",
			dir:                 "testdata/charts/helmchartwithdeps-v1",
			wantName:            chartNameV1,
			wantVersion:         chartVersionV1,
			wantDependencyCount: 1,
		},
		{
			name:    "Error if no Chart.yaml",
			dir:     "testdata/charts/",
			wantErr: "testdata/charts/Chart.yaml: no such file or directory",
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			g := NewWithT(t)

			got, err := LoadChartMetadataFromDir(tt.dir)
			if tt.wantErr != "" {
				g.Expect(err).To(HaveOccurred())
				g.Expect(err.Error()).To(ContainSubstring(tt.wantErr))
				g.Expect(got).To(BeNil())
				return
			}

			g.Expect(err).ToNot(HaveOccurred())
			g.Expect(got).ToNot(BeNil())
			g.Expect(got.Validate()).To(Succeed())
			g.Expect(got.Name).To(Equal(tt.wantName))
			g.Expect(got.Version).To(Equal(tt.wantVersion))
			g.Expect(got.Dependencies).To(HaveLen(tt.wantDependencyCount))
		})
	}
}

func TestLoadChartMetadataFromArchive(t *testing.T) {
	tests := []struct {
		name                string
		archive             string
		wantName            string
		wantVersion         string
		wantDependencyCount int
		wantErr             string
	}{
		{
			name:        "Loads from archive",
			archive:     helmPackageFile,
			wantName:    chartName,
			wantVersion: chartVersion,
		},
		{
			name:                "Loads from v1 archive including requirements.yaml",
			archive:             helmPackageV1File,
			wantName:            chartNameV1,
			wantVersion:         chartVersionV1,
			wantDependencyCount: 1,
		},
		{
			name:    "Error on not found",
			archive: "testdata/invalid.tgz",
			wantErr: "no such file or directory",
		},
		{
			name:    "Error if no Chart.yaml",
			archive: "testdata/charts/empty.tgz",
			wantErr: "no 'Chart.yaml' found",
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			g := NewWithT(t)

			got, err := LoadChartMetadataFromArchive(tt.archive)
			if tt.wantErr != "" {
				g.Expect(err).To(HaveOccurred())
				g.Expect(err.Error()).To(ContainSubstring(tt.wantErr))
				g.Expect(got).To(BeNil())
				return
			}

			g.Expect(err).ToNot(HaveOccurred())
			g.Expect(got).ToNot(BeNil())
			g.Expect(got.Validate()).To(Succeed())
			g.Expect(got.Name).To(Equal(tt.wantName))
			g.Expect(got.Version).To(Equal(tt.wantVersion))
			g.Expect(got.Dependencies).To(HaveLen(tt.wantDependencyCount))
		})
	}
}