github.com/kubeshop/testkube@v1.17.23/pkg/tcl/testworkflowstcl/testworkflowresolver/config_test.go

// Copyright 2024 Testkube.
//
// Licensed as a Testkube Pro file under the Testkube Community
// License (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
//     https://github.com/kubeshop/testkube/blob/main/licenses/TCL.txt

package testworkflowresolver

import (
	"testing"

	"github.com/stretchr/testify/assert"
	"k8s.io/apimachinery/pkg/util/intstr"

	testworkflowsv1 "github.com/kubeshop/testkube-operator/api/testworkflows/v1"
	"github.com/kubeshop/testkube/internal/common"
)

func TestApplyConfigTestWorkflow(t *testing.T) {
	cfg := map[string]intstr.IntOrString{
		"foo":    {Type: intstr.Int, IntVal: 30},
		"bar":    {Type: intstr.String, StrVal: "some value"},
		"baz":    {Type: intstr.String, StrVal: "some {{ 30 }} value"},
		"foobar": {Type: intstr.String, StrVal: "some {{ unknown(300) }} value"},
	}
	want := &testworkflowsv1.TestWorkflow{
		Description: "{{some description here }}",
		Spec: testworkflowsv1.TestWorkflowSpec{
			TestWorkflowSpecBase: testworkflowsv1.TestWorkflowSpecBase{
				Pod: &testworkflowsv1.PodConfig{
					ServiceAccountName: "abra 30",
					Labels: map[string]string{
						"some value-key": "some 30 value",
						"other":          "{{value}}",
					},
				},
			},
			Steps: []testworkflowsv1.Step{
				{
					StepBase: testworkflowsv1.StepBase{
						Container: &testworkflowsv1.ContainerConfig{
							WorkingDir: common.Ptr("some {{unknown(300)}} value {{another(500)}}"),
						},
					},
				},
			},
		},
	}
	got, err := ApplyWorkflowConfig(&testworkflowsv1.TestWorkflow{
		Description: "{{some description here }}",
		Spec: testworkflowsv1.TestWorkflowSpec{
			TestWorkflowSpecBase: testworkflowsv1.TestWorkflowSpecBase{
				Pod: &testworkflowsv1.PodConfig{
					ServiceAccountName: "abra {{config.foo}}",
					Labels: map[string]string{
						"{{config.bar}}-key": "{{config.baz}}",
						"other":              "{{value}}",
					},
				},
			},
			Steps: []testworkflowsv1.Step{
				{
					StepBase: testworkflowsv1.StepBase{
						Container: &testworkflowsv1.ContainerConfig{
							WorkingDir: common.Ptr("{{config.foobar}} {{another(500)}}"),
						},
					},
				},
			},
		},
	}, cfg)

	assert.NoError(t, err)
	assert.Equal(t, want, got)
}

func TestApplyMissingConfig(t *testing.T) {
	cfg := map[string]intstr.IntOrString{
		"foo":    {Type: intstr.Int, IntVal: 30},
		"bar":    {Type: intstr.String, StrVal: "some value"},
		"foobar": {Type: intstr.String, StrVal: "some {{ unknown(300) }} value"},
	}
	_, err := ApplyWorkflowConfig(&testworkflowsv1.TestWorkflow{
		Description: "{{some description here }}",
		Spec: testworkflowsv1.TestWorkflowSpec{
			TestWorkflowSpecBase: testworkflowsv1.TestWorkflowSpecBase{
				Pod: &testworkflowsv1.PodConfig{
					ServiceAccountName: "abra {{config.foo}}",
					Labels: map[string]string{
						"{{config.bar}}-key": "{{config.baz}}",
					},
				},
			},
			Steps: []testworkflowsv1.Step{
				{
					StepBase: testworkflowsv1.StepBase{
						Container: &testworkflowsv1.ContainerConfig{
							WorkingDir: common.Ptr("{{config.foobar}} {{another(500)}}"),
						},
					},
				},
			},
		},
	}, cfg)

	assert.Error(t, err)
	assert.Contains(t, err.Error(), "Spec: TestWorkflowSpecBase: Pod: Labels: {{config.bar}}-key")
	assert.Contains(t, err.Error(), "error while accessing config.baz: unknown variable")
}

func TestApplyConfigDefaults(t *testing.T) {
	cfg := map[string]intstr.IntOrString{
		"foo":    {Type: intstr.Int, IntVal: 30},
		"bar":    {Type: intstr.String, StrVal: "some value"},
		"foobar": {Type: intstr.String, StrVal: "some {{ unknown(300) }} value"},
	}
	want := &testworkflowsv1.TestWorkflow{
		Description: "{{some description here }}",
		Spec: testworkflowsv1.TestWorkflowSpec{
			TestWorkflowSpecBase: testworkflowsv1.TestWorkflowSpecBase{
				Config: map[string]testworkflowsv1.ParameterSchema{
					"baz": {Default: &intstr.IntOrString{Type: intstr.String, StrVal: "something"}},
				},
				Pod: &testworkflowsv1.PodConfig{
					ServiceAccountName: "abra 30",
					Labels: map[string]string{
						"some value-key": "something",
					},
				},
			},
			Steps: []testworkflowsv1.Step{
				{
					StepBase: testworkflowsv1.StepBase{
						Container: &testworkflowsv1.ContainerConfig{
							WorkingDir: common.Ptr("some {{unknown(300)}} value {{another(500)}}"),
						},
					},
				},
			},
		},
	}
	got, err := ApplyWorkflowConfig(&testworkflowsv1.TestWorkflow{
		Description: "{{some description here }}",
		Spec: testworkflowsv1.TestWorkflowSpec{
			TestWorkflowSpecBase: testworkflowsv1.TestWorkflowSpecBase{
				Config: map[string]testworkflowsv1.ParameterSchema{
					"baz": {Default: &intstr.IntOrString{Type: intstr.String, StrVal: "something"}},
				},
				Pod: &testworkflowsv1.PodConfig{
					ServiceAccountName: "abra {{config.foo}}",
					Labels: map[string]string{
						"{{config.bar}}-key": "{{config.baz}}",
					},
				},
			},
			Steps: []testworkflowsv1.Step{
				{
					StepBase: testworkflowsv1.StepBase{
						Container: &testworkflowsv1.ContainerConfig{
							WorkingDir: common.Ptr("{{config.foobar}} {{another(500)}}"),
						},
					},
				},
			},
		},
	}, cfg)

	assert.NoError(t, err)
	assert.Equal(t, want, got)
}

func TestInvalidInteger(t *testing.T) {
	cfg := map[string]intstr.IntOrString{
		"foo": {Type: intstr.String, StrVal: "some value"},
	}
	_, err := ApplyWorkflowConfig(&testworkflowsv1.TestWorkflow{
		Description: "{{some description here }}",
		Spec: testworkflowsv1.TestWorkflowSpec{
			TestWorkflowSpecBase: testworkflowsv1.TestWorkflowSpecBase{
				Config: map[string]testworkflowsv1.ParameterSchema{
					"foo": {Type: testworkflowsv1.ParameterTypeInteger},
				},
				Pod: &testworkflowsv1.PodConfig{
					ServiceAccountName: "{{config.foo}}",
				},
			},
		},
	}, cfg)

	assert.Error(t, err)
	assert.Contains(t, err.Error(), "config.foo: error")
	assert.Contains(t, err.Error(), "error while converting value to number")
}

func TestApplyConfigTestWorkflowTemplate(t *testing.T) {
	cfg := map[string]intstr.IntOrString{
		"foo":    {Type: intstr.Int, IntVal: 30},
		"bar":    {Type: intstr.String, StrVal: "some value"},
		"baz":    {Type: intstr.String, StrVal: "some {{ 30 }} value"},
		"foobar": {Type: intstr.String, StrVal: "some {{ unknown(300) }} value"},
	}
	want := &testworkflowsv1.TestWorkflowTemplate{
		Description: "{{some description here }}",
		Spec: testworkflowsv1.TestWorkflowTemplateSpec{
			TestWorkflowSpecBase: testworkflowsv1.TestWorkflowSpecBase{
				Pod: &testworkflowsv1.PodConfig{
					ServiceAccountName: "abra 30",
					Labels: map[string]string{
						"some value-key": "some 30 value",
					},
				},
			},
			Steps: []testworkflowsv1.IndependentStep{
				{
					StepBase: testworkflowsv1.StepBase{
						Container: &testworkflowsv1.ContainerConfig{
							WorkingDir: common.Ptr("some {{unknown(300)}} value {{another(500)}}"),
						},
					},
				},
			},
		},
	}
	got, err := ApplyWorkflowTemplateConfig(&testworkflowsv1.TestWorkflowTemplate{
		Description: "{{some description here }}",
		Spec: testworkflowsv1.TestWorkflowTemplateSpec{
			TestWorkflowSpecBase: testworkflowsv1.TestWorkflowSpecBase{
				Pod: &testworkflowsv1.PodConfig{
					ServiceAccountName: "abra {{config.foo}}",
					Labels: map[string]string{
						"{{config.bar}}-key": "{{config.baz}}",
					},
				},
			},
			Steps: []testworkflowsv1.IndependentStep{
				{
					StepBase: testworkflowsv1.StepBase{
						Container: &testworkflowsv1.ContainerConfig{
							WorkingDir: common.Ptr("{{config.foobar}} {{another(500)}}"),
						},
					},
				},
			},
		},
	}, cfg)

	assert.NoError(t, err)
	assert.Equal(t, want, got)
}