feat(package): add value options to 'helm package'

Signed-off-by: cndoit18 <cndoit18@outlook.com>

cmd/helm/package.go

@@ -120,6 +120,7 @@ func newPackageCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
 	f.StringVar(&client.AppVersion, "app-version", "", "set the appVersion on the chart to this version")
 	f.StringVarP(&client.Destination, "destination", "d", ".", "location to write the chart.")
 	f.BoolVarP(&client.DependencyUpdate, "dependency-update", "u", false, `update dependencies from "Chart.yaml" to dir "charts/" before packaging`)
+	addValueOptionsFlags(f, valueOpts)
 
 	return cmd
 }

cmd/helm/package_test.go

@@ -26,6 +26,7 @@ import (
 	"helm.sh/helm/v3/internal/test/ensure"
 	"helm.sh/helm/v3/pkg/chart"
 	"helm.sh/helm/v3/pkg/chart/loader"
+	"helm.sh/helm/v3/pkg/chartutil"
 )
 
 func TestPackage(t *testing.T) {
@@ -192,6 +193,173 @@ func TestSetAppVersion(t *testing.T) {
 	}
 }
 
+func TestAddValueOptions(t *testing.T) {
+	tests := []struct {
+		name   string
+		args   []string
+		expect string
+		chart  string
+		err    bool
+	}{
+		{
+			name: "package without set value",
+			args: []string{},
+			expect: `# The pod name
+Name: my-alpine
+List: []
+List1:
+- a
+`,
+			chart: "issue-3141",
+			err:   false,
+		},
+		{
+			name: "package set values",
+			args: []string{
+				"--set Name=other",
+			},
+			chart: "issue-3141",
+			expect: `# The pod name
+Name: other
+List: []
+List1:
+- a
+`,
+			err: false,
+		},
+		{
+			name: "package append values",
+			args: []string{
+				"--set Key=other",
+			},
+			chart: "issue-3141",
+			expect: `# The pod name
+Name: my-alpine
+List: []
+List1:
+- a
+Key: other
+`,
+			err: false,
+		},
+		{
+			name: "package multiple values",
+			args: []string{
+				"--set a=b,c=d",
+			},
+			chart: "issue-3141",
+			expect: `# The pod name
+Name: my-alpine
+List: []
+List1:
+- a
+a: b
+c: d
+`,
+			err: false,
+		},
+		{
+			name: "package more complex expressions",
+			args: []string{
+				"--set outer.inner=value",
+			},
+			chart: "issue-3141",
+			expect: `# The pod name
+Name: my-alpine
+List: []
+List1:
+- a
+outer:
+  inner: value
+`,
+			err: false,
+		},
+		{
+			name: "package lists values",
+			args: []string{
+				"--set List={a,b,c}",
+			},
+			chart: "issue-3141",
+			expect: `# The pod name
+Name: my-alpine
+List:
+- a
+- b
+- c
+List1:
+- a
+`,
+			err: false,
+		},
+		{
+			name: "package replace values",
+			args: []string{
+				"--set List1={a,b,c}",
+			},
+			chart: "issue-3141",
+			expect: `# The pod name
+Name: my-alpine
+List: []
+List1:
+- a
+- b
+- c
+`,
+			err: false,
+		},
+		{
+			name: "package no values file",
+			args: []string{
+				"--set List={a,b,c}",
+			},
+			chart: "issue-3141-without-values",
+			expect: `List:
+- a
+- b
+- c
+`,
+			err: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			dir := ensure.TempDir(t)
+			t.Cleanup(func() {
+				os.RemoveAll(dir)
+			})
+
+			chartToPackage := "testdata/testcharts/" + tt.chart
+			cmd := fmt.Sprintf("package %s --destination=%s %s", chartToPackage, dir, strings.Join(tt.args, " "))
+			_, _, err := executeActionCommand(cmd)
+			if err != nil {
+				if tt.err {
+					return
+				}
+				t.Fatal(err)
+			}
+			if tt.err {
+				t.Fatalf("Expected error in test %q", tt.name)
+			}
+			chartPath := filepath.Join(dir, tt.chart+"-0.1.0.tgz")
+			if fi, err := os.Stat(chartPath); err != nil {
+				t.Errorf("expected file %q, got err %q", chartPath, err)
+			} else if fi.Size() == 0 {
+				t.Errorf("file %q has zero bytes.", chartPath)
+			}
+			ch, err := loader.Load(chartPath)
+			if err != nil {
+				t.Fatalf("unexpected error loading packaged chart: %v", err)
+			}
+			for _, f := range ch.Raw {
+				if f.Name == chartutil.ValuesfileName && string(f.Data) != tt.expect {
+					t.Errorf("expected values %q, found %q", tt.expect, string(f.Data))
+				}
+			}
+		})
+	}
+}
+
 func TestPackageFileCompletion(t *testing.T) {
 	checkFileCompletion(t, "package", true)
 	checkFileCompletion(t, "package mypath", true) // Multiple paths can be given

cmd/helm/testdata/testcharts/issue-3141-without-values/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

cmd/helm/testdata/testcharts/issue-3141-without-values/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: issue-3141-without-values
+description: A Helm chart for Kubernetes
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "1.16.0"

cmd/helm/testdata/testcharts/issue-3141-without-values/templates/NOTES.txt

@@ -0,0 +1,22 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "issue-3141.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "issue-3141.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "issue-3141.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "issue-3141.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
+{{- end }}

cmd/helm/testdata/testcharts/issue-3141-without-values/templates/_helpers.tpl

@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "issue-3141.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "issue-3141.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "issue-3141.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "issue-3141.labels" -}}
+helm.sh/chart: {{ include "issue-3141.chart" . }}
+{{ include "issue-3141.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "issue-3141.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "issue-3141.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "issue-3141.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "issue-3141.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

cmd/helm/testdata/testcharts/issue-3141-without-values/templates/deployment.yaml

@@ -0,0 +1,61 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "issue-3141.fullname" . }}
+  labels:
+    {{- include "issue-3141.labels" . | nindent 4 }}
+spec:
+  {{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "issue-3141.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "issue-3141.selectorLabels" . | nindent 8 }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "issue-3141.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - name: http
+              containerPort: 80
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}