feat(api): VersionLabel template function (#3062)

* feat(api): VersionLabel template function

* f

Author: emosbaugh

api/pkg/template/execute.go

@@ -143,8 +143,10 @@ func (e *Engine) getFuncMap() template.FuncMap {
 		"ConfigOptionFilename":  e.configOptionFilename,
 		"ConfigOptionNotEquals": e.configOptionNotEquals,
 
+		// License and release data template functions
 		"LicenseFieldValue": e.licenseFieldValue,
 		"LicenseDockerCfg":  e.licenseDockerCfg,
+		"VersionLabel":      e.versionLabel,
 
 		"HTTPProxy":  e.httpProxy,
 		"HTTPSProxy": e.httpsProxy,

api/pkg/template/release.go

@@ -0,0 +1,13 @@
+package template
+
+import "fmt"
+
+func (e *Engine) versionLabel() (string, error) {
+	if e.releaseData == nil {
+		return "", fmt.Errorf("release data is nil")
+	}
+	if e.releaseData.ChannelRelease == nil {
+		return "", fmt.Errorf("channel release is nil")
+	}
+	return e.releaseData.ChannelRelease.VersionLabel, nil
+}

api/pkg/template/release_test.go

@@ -0,0 +1,125 @@
+package template
+
+import (
+	"testing"
+
+	ecv1beta1 "github.com/replicatedhq/embedded-cluster/kinds/apis/v1beta1"
+	"github.com/replicatedhq/embedded-cluster/pkg/release"
+	kotsv1beta1 "github.com/replicatedhq/kotskinds/apis/kots/v1beta1"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestEngine_VersionLabel(t *testing.T) {
+	config := &kotsv1beta1.Config{
+		Spec: kotsv1beta1.ConfigSpec{
+			Groups: []kotsv1beta1.ConfigGroup{},
+		},
+	}
+
+	releaseData := &release.ReleaseData{
+		EmbeddedClusterConfig: &ecv1beta1.Config{
+			Spec: ecv1beta1.ConfigSpec{},
+		},
+		ChannelRelease: &release.ChannelRelease{
+			VersionLabel: "v1.2.3",
+		},
+	}
+
+	engine := NewEngine(config, WithReleaseData(releaseData))
+
+	err := engine.Parse("{{repl VersionLabel }}")
+	require.NoError(t, err)
+	result, err := engine.Execute(nil, WithProxySpec(&ecv1beta1.ProxySpec{}))
+	require.NoError(t, err)
+	assert.Equal(t, "v1.2.3", result)
+}
+
+func TestEngine_VersionLabelEmpty(t *testing.T) {
+	config := &kotsv1beta1.Config{
+		Spec: kotsv1beta1.ConfigSpec{
+			Groups: []kotsv1beta1.ConfigGroup{},
+		},
+	}
+
+	releaseData := &release.ReleaseData{
+		EmbeddedClusterConfig: &ecv1beta1.Config{
+			Spec: ecv1beta1.ConfigSpec{},
+		},
+		ChannelRelease: &release.ChannelRelease{
+			VersionLabel: "",
+		},
+	}
+
+	engine := NewEngine(config, WithReleaseData(releaseData))
+
+	err := engine.Parse("{{repl VersionLabel }}")
+	require.NoError(t, err)
+	result, err := engine.Execute(nil, WithProxySpec(&ecv1beta1.ProxySpec{}))
+	require.NoError(t, err)
+	assert.Equal(t, "", result)
+}
+
+func TestEngine_VersionLabelWithoutReleaseData(t *testing.T) {
+	config := &kotsv1beta1.Config{
+		Spec: kotsv1beta1.ConfigSpec{
+			Groups: []kotsv1beta1.ConfigGroup{},
+		},
+	}
+
+	engine := NewEngine(config)
+
+	err := engine.Parse("{{repl VersionLabel }}")
+	require.NoError(t, err)
+	_, err = engine.Execute(nil, WithProxySpec(&ecv1beta1.ProxySpec{}))
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "release data is nil")
+}
+
+func TestEngine_VersionLabelWithoutChannelRelease(t *testing.T) {
+	config := &kotsv1beta1.Config{
+		Spec: kotsv1beta1.ConfigSpec{
+			Groups: []kotsv1beta1.ConfigGroup{},
+		},
+	}
+
+	releaseData := &release.ReleaseData{
+		EmbeddedClusterConfig: &ecv1beta1.Config{
+			Spec: ecv1beta1.ConfigSpec{},
+		},
+		ChannelRelease: nil,
+	}
+
+	engine := NewEngine(config, WithReleaseData(releaseData))
+
+	err := engine.Parse("{{repl VersionLabel }}")
+	require.NoError(t, err)
+	_, err = engine.Execute(nil, WithProxySpec(&ecv1beta1.ProxySpec{}))
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "channel release is nil")
+}
+
+func TestEngine_VersionLabelInTemplate(t *testing.T) {
+	config := &kotsv1beta1.Config{
+		Spec: kotsv1beta1.ConfigSpec{
+			Groups: []kotsv1beta1.ConfigGroup{},
+		},
+	}
+
+	releaseData := &release.ReleaseData{
+		EmbeddedClusterConfig: &ecv1beta1.Config{
+			Spec: ecv1beta1.ConfigSpec{},
+		},
+		ChannelRelease: &release.ChannelRelease{
+			VersionLabel: "2024.1.0",
+		},
+	}
+
+	engine := NewEngine(config, WithReleaseData(releaseData))
+
+	err := engine.Parse("version: {{repl VersionLabel }}")
+	require.NoError(t, err)
+	result, err := engine.Execute(nil, WithProxySpec(&ecv1beta1.ProxySpec{}))
+	require.NoError(t, err)
+	assert.Equal(t, "version: 2024.1.0", result)
+}

e2e/kots-release-install-v3/config.yaml

@@ -641,3 +641,11 @@ spec:
             ---
 
             {{repl Distribution }}
+
+        - name: template_function_version_label
+          type: label
+          title: |
+            ## Version Label
+            ---
+
+            {{repl VersionLabel }}