kubevela/pkg/cue/convert_test.go

/*
Copyright 2021 The KubeVela 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 cue

import (
	"context"
	"os"
	"strings"
	"testing"

	"cuelang.org/go/cue"
	"github.com/kubevela/pkg/cue/cuex"
	"github.com/kubevela/pkg/util/singleton"
	"github.com/stretchr/testify/assert"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"k8s.io/apimachinery/pkg/runtime"
	dynamicfake "k8s.io/client-go/dynamic/fake"

	"github.com/oam-dev/kubevela/apis/types"
)

func TestGetParameter(t *testing.T) {
	data, _ := os.ReadFile("testdata/workloads/metrics.cue")
	params, err := GetParameters(string(data))
	assert.NoError(t, err)
	assert.Equal(t, params, []types.Parameter{
		{Name: "format", Required: false, Default: "prometheus", Usage: "format of the metrics, " +
			"default as prometheus", Short: "f", Type: cue.StringKind},
		{Name: "enabled", Required: false, Default: true, Type: cue.BoolKind},
		{Name: "port", Required: false, Default: int64(8080), Type: cue.IntKind},
		{Name: "selector", Required: false, Usage: "the label selector for the pods, default is the workload labels", Type: cue.StructKind},
	})
	data, _ = os.ReadFile("testdata/workloads/deployment.cue")
	params, err = GetParameters(string(data))
	assert.NoError(t, err)
	assert.Equal(t, []types.Parameter{
		{Name: "name", Required: true, Default: "", Type: cue.StringKind},
		{Name: "image", Short: "i", Required: true, Usage: "Which image would you like to use for your service", Default: "", Type: cue.StringKind},
		{Name: "port", Short: "p", Required: false, Usage: "Which port do you want customer traffic sent to", Default: int64(8080),
			Type: cue.IntKind},
		{Name: "env", Required: false, Default: nil, Type: cue.ListKind},
		{Name: "cpu", Short: "", Required: false, Usage: "", Default: "", Type: cue.StringKind}},
		params)

	data, _ = os.ReadFile("testdata/workloads/test-param.cue")
	params, err = GetParameters(string(data))
	assert.NoError(t, err)
	assert.Equal(t, []types.Parameter{
		{Name: "name", Required: true, Default: "", Type: cue.StringKind},
		{Name: "image", Short: "i", Required: true, Usage: "Which image would you like to use for your service", Default: "", Type: cue.StringKind},
		{Name: "port", Short: "p", Usage: "Which port do you want customer traffic sent to", Default: int64(8080), Type: cue.IntKind},
		{Name: "env", Required: false, Default: nil, Type: cue.ListKind},
		{Name: "enable", Default: false, Type: cue.BoolKind},
		{Name: "fval", Default: 64.3, Type: cue.FloatKind},
		{Name: "nval", Default: float64(0), Required: true, Type: cue.NumberKind}}, params)
	data, _ = os.ReadFile("testdata/workloads/empty.cue")
	params, err = GetParameters(string(data))
	assert.NoError(t, err)
	var exp []types.Parameter
	assert.Equal(t, exp, params)

	data, _ = os.ReadFile("testdata/workloads/webservice.cue") // test cue parameter with "// +ignore" annotation
	params, err = GetParameters(string(data))                  // Only test for func RetrieveComments
	assert.NoError(t, err)
	var flag bool
	for _, para := range params {
		if para.Name == "addRevisionLabel" {
			flag = true
			assert.Equal(t, para.Usage, "If addRevisionLabel is true, the appRevision label will be added to the underlying pods")
			assert.Equal(t, para.Ignore, true)
		}
	}
	assert.Equal(t, flag, true)

	// Test pattern parameter selectors which would cause panic with Unquoted()
	data, _ = os.ReadFile("testdata/workloads/pattern-params.cue")
	params, err = GetParameters(string(data))
	assert.NoError(t, err) // Should not panic
	// We should get the regular parameters but pattern selectors are handled safely
	assert.GreaterOrEqual(t, len(params), 2) // At least name and port
	foundName := false
	foundPort := false
	for _, p := range params {
		if p.Name == "name" {
			foundName = true
			assert.Equal(t, cue.StringKind, p.Type)
		}
		if p.Name == "port" {
			foundPort = true
			assert.Equal(t, int64(8080), p.Default)
		}
	}
	assert.True(t, foundName, "Should find 'name' parameter")
	assert.True(t, foundPort, "Should find 'port' parameter")
}

func TestGetParametersWithCuex(t *testing.T) {
	ctx := context.Background()

	// Test 1: Basic template without imports
	data, _ := os.ReadFile("testdata/workloads/metrics.cue")
	params, err := GetParametersWithCuex(ctx, string(data))
	assert.NoError(t, err)
	assert.Equal(t, params, []types.Parameter{
		{Name: "format", Required: false, Default: "prometheus", Usage: "format of the metrics, " +
			"default as prometheus", Short: "f", Type: cue.StringKind},
		{Name: "enabled", Required: false, Default: true, Type: cue.BoolKind},
		{Name: "port", Required: false, Default: int64(8080), Type: cue.IntKind},
		{Name: "selector", Required: false, Usage: "the label selector for the pods, default is the workload labels", Type: cue.StructKind},
	})

	// Test 2: Template with cuex package imports
	// Setup test package
	packageObj := &unstructured.Unstructured{
		Object: map[string]interface{}{
			"apiVersion": "cue.oam.dev/v1alpha1",
			"kind":       "Package",
			"metadata": map[string]interface{}{
				"name":      "test-package",
				"namespace": "vela-system",
			},
			"spec": map[string]interface{}{
				"path": "test/ext",
				"templates": map[string]interface{}{
					"test/ext": strings.TrimSpace(`
						package ext
						#Config: {
							host: string
							port: int
						}
					`),
				},
			},
		},
	}

	dcl := dynamicfake.NewSimpleDynamicClient(runtime.NewScheme(), packageObj)
	singleton.DynamicClient.Set(dcl)
	cuex.DefaultCompiler.Reload()

	defer cuex.DefaultCompiler.Reload()
	defer singleton.ReloadClients()

	// Template with import
	templateWithImport := `
import "test/ext"

parameter: {
	name: string
	config: ext.#Config
}
`
	params, err = GetParametersWithCuex(ctx, templateWithImport)
	assert.NoError(t, err, "Should compile template with cuex imports")
	assert.Equal(t, 2, len(params), "Should find 2 parameters")

	foundName := false
	foundConfig := false
	for _, p := range params {
		if p.Name == "name" {
			foundName = true
			assert.Equal(t, cue.StringKind, p.Type)
			assert.True(t, p.Required)
		}
		if p.Name == "config" {
			foundConfig = true
			assert.Equal(t, cue.StructKind, p.Type)
			assert.True(t, p.Required)
		}
	}
	assert.True(t, foundName, "Should find 'name' parameter")
	assert.True(t, foundConfig, "Should find 'config' parameter")

	// Test 3: Template without parameter field
	data, _ = os.ReadFile("testdata/workloads/empty.cue")
	params, err = GetParametersWithCuex(ctx, string(data))
	assert.NoError(t, err)
	var exp []types.Parameter
	assert.Equal(t, exp, params)
}