feat(api): implement Distribution template function (#3061)

* feat(api): implement Distribution and NodeCount template functions

* f

* f

* f

Author: emosbaugh

api/pkg/template/engine.go

@@ -23,24 +23,26 @@ const (
 )
 
 type Engine struct {
-	mode        Mode
-	config      *kotsv1beta1.Config
-	license     *kotsv1beta1.License
-	releaseData *release.ReleaseData
+	mode                       Mode
+	config                     *kotsv1beta1.Config
+	license                    *kotsv1beta1.License
+	releaseData                *release.ReleaseData
+	privateCACertConfigMapName string // ConfigMap name for private CA certificates, empty string if not available
+	isAirgapInstallation       bool   // Whether the installation is an airgap installation
+
+	// ExecOptions
+	proxySpec        *ecv1beta1.ProxySpec    // Proxy spec for the proxy template functions, if applicable
+	registrySettings *types.RegistrySettings // Registry settings for registry template functions, if applicable
 
 	// Internal state
-	configValues               types.AppConfigValues
-	prevConfigValues           types.AppConfigValues
-	tmpl                       *template.Template
-	funcMap                    template.FuncMap
-	cache                      map[string]resolvedConfigItem
-	depsTree                   map[string][]string
-	stack                      []string
-	proxySpec                  *ecv1beta1.ProxySpec    // Proxy spec for the proxy template functions, if applicable
-	registrySettings           *types.RegistrySettings // Registry settings for registry template functions, if applicable
-	privateCACertConfigMapName string                  // ConfigMap name for private CA certificates, empty string if not available
-	isAirgapInstallation       bool                    // Whether the installation is an airgap installation
-	mtx                        sync.Mutex
+	configValues     types.AppConfigValues
+	prevConfigValues types.AppConfigValues
+	tmpl             *template.Template
+	funcMap          template.FuncMap
+	cache            map[string]resolvedConfigItem
+	depsTree         map[string][]string
+	stack            []string
+	mtx              sync.Mutex
 }
 
 type EngineOption func(*Engine)

api/pkg/template/execute.go

@@ -174,6 +174,7 @@ func (e *Engine) getFuncMap() template.FuncMap {
 		"ParseUint":    e.parseUint,
 		"HumanSize":    e.humanSize,
 		"YamlEscape":   e.yamlEscape,
+		"Distribution": e.distribution,
 
 		// Registry template functions
 		"HasLocalRegistry":             e.hasLocalRegistry,
@@ -183,7 +184,7 @@ func (e *Engine) getFuncMap() template.FuncMap {
 		"ImagePullSecretName":          e.imagePullSecretName,
 		"LocalRegistryImagePullSecret": e.localRegistryImagePullSecret,
 
-		// Release template functions
+		// Airgap template functions
 		"IsAirgap": e.isAirgap,
 	}
 }

api/pkg/template/static.go

@@ -285,6 +285,10 @@ func (e *Engine) yamlEscape(plain string) string {
 	return indented
 }
 
+func (e *Engine) distribution() string {
+	return "embedded-cluster"
+}
+
 // copied from sprig
 func indent(spaces int, v string) string {
 	pad := strings.Repeat(" ", spaces)

api/pkg/template/static_test.go

@@ -893,3 +893,19 @@ func TestEngine_YamlEscape(t *testing.T) {
 		})
 	}
 }
+
+func TestEngine_Distribution(t *testing.T) {
+	config := &kotsv1beta1.Config{
+		Spec: kotsv1beta1.ConfigSpec{
+			Groups: []kotsv1beta1.ConfigGroup{},
+		},
+	}
+
+	engine := NewEngine(config)
+
+	err := engine.Parse("{{repl Distribution }}")
+	require.NoError(t, err)
+	result, err := engine.Execute(nil, WithProxySpec(&ecv1beta1.ProxySpec{}))
+	require.NoError(t, err)
+	assert.Equal(t, "embedded-cluster", result)
+}

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

@@ -633,3 +633,11 @@ spec:
             ---
 
             {{repl if IsAirgap }}Yes{{repl else }}No{{repl end }}
+
+        - name: template_function_distribution
+          type: label
+          title: |
+            ## Distribution
+            ---
+
+            {{repl Distribution }}

web/src/components/wizard/tests/ConfigurationStep.test.tsx

@@ -5,6 +5,7 @@ import { setupServer } from "msw/node";
 import { renderWithProviders } from "../../../test/setup.tsx";
 import ConfigurationStep from "../config/ConfigurationStep.tsx";
 import { AppConfig, AppConfigGroup, AppConfigItem, AppConfigValues } from "../../../types";
+import '@testing-library/jest-dom/vitest';
 
 // Mock the debounced fetch to remove timing issues in tests
 vi.mock("../../../utils/debouncedFetch", () => ({
@@ -1771,12 +1772,13 @@ describe.each([
       // Mock FileReader for new file upload
       const mockFileReader = {
         readAsDataURL: vi.fn().mockImplementation(() => {
+          // Use setTimeout with a small delay to simulate async file reading
           setTimeout(() => {
             if (mockFileReader.onload) {
               // eslint-disable-next-line @typescript-eslint/no-explicit-any
               mockFileReader.onload({ target: { result: 'data:text/plain;base64,bmV3IGNvbnRlbnQ=' } } as any);
             }
-          }, 0);
+          }, 10);
         }),
         result: 'data:text/plain;base64,bmV3IGNvbnRlbnQ=',
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1791,11 +1793,14 @@ describe.each([
       // Upload new file
       fireEvent.change(configFileInput, { target: { files: [newFile] } });
 
-      // Wait for the new filename to appear
+      // Wait for the new filename to appear and file processing to complete
       await waitFor(() => {
         expect(screen.getByText("new-config.yml")).toBeInTheDocument();
       });
 
+      // Wait a bit more to ensure the file processing is fully complete
+      await new Promise(resolve => setTimeout(resolve, 20));
+
       // Verify the old filename is no longer displayed
       expect(screen.queryByText("config.yaml")).not.toBeInTheDocument();
 
@@ -1883,12 +1888,13 @@ describe.each([
       // Mock FileReader
       const mockFileReader = {
         readAsDataURL: vi.fn().mockImplementation(() => {
+          // Use setTimeout with a small delay to simulate async file reading
           setTimeout(() => {
             if (mockFileReader.onload) {
               // eslint-disable-next-line @typescript-eslint/no-explicit-any
               mockFileReader.onload({ target: { result: 'data:text/plain;base64,Y29udGVudA==' } } as any);
             }
-          }, 0);
+          }, 10);
         }),
         result: 'data:text/plain;base64,Y29udGVudA==',
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1903,11 +1909,14 @@ describe.each([
       // Upload file
       fireEvent.change(fileInput, { target: { files: [newFile] } });
 
-      // Wait for the filename to appear
+      // Wait for the filename to appear and file processing to complete
       await waitFor(() => {
         expect(screen.getByTestId("file-input-no_filename_file-filename")).toBeInTheDocument();
       });
 
+      // Wait a bit more to ensure the file processing is fully complete
+      await new Promise(resolve => setTimeout(resolve, 20));
+
       expect(screen.getByText("uploaded-file.txt")).toBeInTheDocument();
     });
   });