feat(api): ChannelName, IsKurl, and Sequence template functions (#3104)

* feat(api): ChannelName, IsKurl, and Sequence template functions

* f

* f

* f

Author: emosbaugh

api/integration/app/install/config_test.go

@@ -570,7 +570,8 @@ func (s *AppInstallTestSuite) TestTemplateAppConfig() {
 	s.T().Run("Success with default values", func(t *testing.T) {
 		// Create an install controller with the app config
 		apiInstance := s.createAPI(t, states.StateNew, &release.ReleaseData{
-			AppConfig: &appConfigWithTemplates,
+			AppConfig:      &appConfigWithTemplates,
+			ChannelRelease: &release.ChannelRelease{},
 		}, nil)
 
 		// Create a router and register the API routes
@@ -985,7 +986,8 @@ func (s *AppInstallTestSuite) TestTemplateAppConfig_AdditionalTemplateFunctions(
 	s.T().Run("Success with default values", func(t *testing.T) {
 		// Create an install controller with the app config
 		apiInstance := s.createAPI(t, states.StateNew, &release.ReleaseData{
-			AppConfig: &appConfigWithTemplates,
+			AppConfig:      &appConfigWithTemplates,
+			ChannelRelease: &release.ChannelRelease{},
 		}, nil)
 
 		// Create a router and register the API routes

api/integration/util.go

@@ -108,5 +108,9 @@ func NewTargetKubernetesAPIWithReleaseData(t *testing.T, mode types.Mode, opts .
 func DefaultReleaseData() *release.ReleaseData {
 	return &release.ReleaseData{
 		AppConfig: &kotsv1beta1.Config{},
+		ChannelRelease: &release.ChannelRelease{
+			ChannelSequence: 1,
+			ChannelID:       "123",
+		},
 	}
 }

api/pkg/template/execute.go

@@ -147,6 +147,8 @@ func (e *Engine) getFuncMap() template.FuncMap {
 		"LicenseFieldValue": e.licenseFieldValue,
 		"LicenseDockerCfg":  e.licenseDockerCfg,
 		"VersionLabel":      e.versionLabel,
+		"ChannelName":       e.channelName,
+		"Sequence":          e.sequence,
 
 		"HTTPProxy":  e.httpProxy,
 		"HTTPSProxy": e.httpsProxy,
@@ -177,6 +179,7 @@ func (e *Engine) getFuncMap() template.FuncMap {
 		"HumanSize":    e.humanSize,
 		"YamlEscape":   e.yamlEscape,
 		"Distribution": e.distribution,
+		"IsKurl":       func() bool { return false },
 
 		// Registry template functions
 		"HasLocalRegistry":             e.hasLocalRegistry,

api/pkg/template/license.go

@@ -10,60 +10,60 @@ import (
 	"github.com/replicatedhq/embedded-cluster/pkg/release"
 )
 
-func (e *Engine) licenseFieldValue(name string) string {
+func (e *Engine) licenseFieldValue(name string) (string, error) {
 	if e.license == nil {
-		return ""
+		return "", fmt.Errorf("license is nil")
 	}
 
 	// Update docs at https://github.com/replicatedhq/kots.io/blob/main/content/reference/template-functions/license-context.md
 	// when adding new values
 	switch name {
 	case "isSnapshotSupported":
-		return fmt.Sprintf("%t", e.license.Spec.IsSnapshotSupported)
+		return fmt.Sprintf("%t", e.license.Spec.IsSnapshotSupported), nil
 	case "IsDisasterRecoverySupported":
-		return fmt.Sprintf("%t", e.license.Spec.IsDisasterRecoverySupported)
+		return fmt.Sprintf("%t", e.license.Spec.IsDisasterRecoverySupported), nil
 	case "isGitOpsSupported":
-		return fmt.Sprintf("%t", e.license.Spec.IsGitOpsSupported)
+		return fmt.Sprintf("%t", e.license.Spec.IsGitOpsSupported), nil
 	case "isSupportBundleUploadSupported":
-		return fmt.Sprintf("%t", e.license.Spec.IsSupportBundleUploadSupported)
+		return fmt.Sprintf("%t", e.license.Spec.IsSupportBundleUploadSupported), nil
 	case "isEmbeddedClusterMultiNodeEnabled":
-		return fmt.Sprintf("%t", e.license.Spec.IsEmbeddedClusterMultiNodeEnabled)
+		return fmt.Sprintf("%t", e.license.Spec.IsEmbeddedClusterMultiNodeEnabled), nil
 	case "isIdentityServiceSupported":
-		return fmt.Sprintf("%t", e.license.Spec.IsIdentityServiceSupported)
+		return fmt.Sprintf("%t", e.license.Spec.IsIdentityServiceSupported), nil
 	case "isGeoaxisSupported":
-		return fmt.Sprintf("%t", e.license.Spec.IsGeoaxisSupported)
+		return fmt.Sprintf("%t", e.license.Spec.IsGeoaxisSupported), nil
 	case "isAirgapSupported":
-		return fmt.Sprintf("%t", e.license.Spec.IsAirgapSupported)
+		return fmt.Sprintf("%t", e.license.Spec.IsAirgapSupported), nil
 	case "licenseType":
-		return e.license.Spec.LicenseType
+		return e.license.Spec.LicenseType, nil
 	case "licenseSequence":
-		return fmt.Sprintf("%d", e.license.Spec.LicenseSequence)
+		return fmt.Sprintf("%d", e.license.Spec.LicenseSequence), nil
 	case "signature":
-		return string(e.license.Spec.Signature)
+		return string(e.license.Spec.Signature), nil
 	case "appSlug":
-		return e.license.Spec.AppSlug
+		return e.license.Spec.AppSlug, nil
 	case "channelID":
-		return e.license.Spec.ChannelID
+		return e.license.Spec.ChannelID, nil
 	case "channelName":
-		return e.license.Spec.ChannelName
+		return e.license.Spec.ChannelName, nil
 	case "isSemverRequired":
-		return fmt.Sprintf("%t", e.license.Spec.IsSemverRequired)
+		return fmt.Sprintf("%t", e.license.Spec.IsSemverRequired), nil
 	case "customerName":
-		return e.license.Spec.CustomerName
+		return e.license.Spec.CustomerName, nil
 	case "licenseID", "licenseId":
-		return e.license.Spec.LicenseID
+		return e.license.Spec.LicenseID, nil
 	case "endpoint":
 		if e.releaseData == nil {
-			return ""
+			return "", fmt.Errorf("release data is nil")
 		}
 		ecDomains := utils.GetDomains(e.releaseData)
-		return netutils.MaybeAddHTTPS(ecDomains.ReplicatedAppDomain)
+		return netutils.MaybeAddHTTPS(ecDomains.ReplicatedAppDomain), nil
 	default:
 		entitlement, ok := e.license.Spec.Entitlements[name]
 		if ok {
-			return fmt.Sprintf("%v", entitlement.Value.Value())
+			return fmt.Sprintf("%v", entitlement.Value.Value()), nil
 		}
-		return ""
+		return "", nil
 	}
 }
 
@@ -74,6 +74,9 @@ func (e *Engine) licenseDockerCfg() (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")
+	}
 
 	auth := fmt.Sprintf("%s:%s", e.license.Spec.LicenseID, e.license.Spec.LicenseID)
 	encodedAuth := base64.StdEncoding.EncodeToString([]byte(auth))
@@ -111,3 +114,25 @@ func getRegistryProxyInfo(releaseData *release.ReleaseData) *registryProxyInfo {
 		Registry: ecDomains.ReplicatedRegistryDomain,
 	}
 }
+
+func (e *Engine) channelName() (string, error) {
+	if e.license == nil {
+		return "", fmt.Errorf("license is nil")
+	}
+	if e.releaseData == nil {
+		return "", fmt.Errorf("release data is nil")
+	}
+	if e.releaseData.ChannelRelease == nil {
+		return "", fmt.Errorf("channel release is nil")
+	}
+
+	for _, channel := range e.license.Spec.Channels {
+		if channel.ChannelID == e.releaseData.ChannelRelease.ChannelID {
+			return channel.ChannelName, nil
+		}
+	}
+	if e.license.Spec.ChannelID == e.releaseData.ChannelRelease.ChannelID {
+		return e.license.Spec.ChannelName, nil
+	}
+	return "", fmt.Errorf("channel %s not found in license", e.releaseData.ChannelRelease.ChannelID)
+}