mirror of
https://github.com/kubevela/kubevela.git
synced 2026-02-14 10:00:06 +00:00
Feat(appfile): Add comprehensive unit tests for appfile and component package (#6908)
* feat(appfile): Add comprehensive unit tests for appfile package This commit significantly enhances the test coverage for the `pkg/appfile` package by adding a comprehensive suite of new unit tests. These tests improve the reliability of core application parsing, generation, and validation logic. Key additions include: - **Parsing:** New tests for policy parsing, legacy application revision handling, and dynamic component loading. - **Manifest Generation:** Added coverage for `GenerateComponentManifests` and `GeneratePolicyManifests` to ensure correctness of generated resources. - **OAM Contracts:** New tests for `SetOAMContract` and `setWorkloadRefToTrait` to verify OAM label and reference injection. - **Template & Context:** Added tests for loading templates from revisions (`LoadTemplateFromRevision`) and preparing the process context (`PrepareProcessContext`). - **Validation:** Enhanced validation tests for component parameters and uniqueness of output names. As part of this effort, the existing tests were also migrated from Ginkgo to the standard `testing` package with `testify/assert` to maintain consistency across the codebase. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> * refactor(pkg/component): Migrate ref-objects tests to standard Go testing and add new test cases This commit refactors the unit tests for `pkg/component/ref-objects` from a Ginkgo-based suite to the standard Go `testing` package. Additionally, new unit test cases have been added to further enhance test coverage and ensure the robustness of the `ref-objects` functionality. Key changes include: - Deletion of `pkg/component/ref_objects_suite_test.go`. - Introduction of `pkg/component/main_test.go` to manage test environment setup and teardown using `TestMain`. - Creation of `pkg/component/ref_objects_test.go` containing all the ref-objects related unit tests, now using standard Go testing functions, along with newly added test cases for improved coverage. This migration improves consistency with other unit tests in the codebase and leverages the native Go testing framework. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> * chore(pkg/component): Reorder imports in ref_objects_test.go This commit reorders the import statements in `pkg/component/ref_objects_test.go` to adhere to standard Go formatting and import grouping conventions. This change improves code readability and consistency. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> --------- Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com>
This commit is contained in:
AshvinBambhaniya2003
committed by
GitHub
GitHub
parent
4b1d1601c8
commit
3f5b698dac
File diff suppressed because it is too large
Load Diff
@@ -24,8 +24,7 @@ import (
|
||||
"testing"
|
||||
|
||||
"github.com/crossplane/crossplane-runtime/pkg/test"
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
workflowv1alpha1 "github.com/kubevela/workflow/api/v1alpha1"
|
||||
"github.com/stretchr/testify/assert"
|
||||
errors2 "k8s.io/apimachinery/pkg/api/errors"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
@@ -34,16 +33,217 @@ import (
|
||||
"sigs.k8s.io/controller-runtime/pkg/client/fake"
|
||||
"sigs.k8s.io/yaml"
|
||||
|
||||
workflowv1alpha1 "github.com/kubevela/workflow/api/v1alpha1"
|
||||
|
||||
"github.com/oam-dev/kubevela/apis/core.oam.dev/common"
|
||||
"github.com/oam-dev/kubevela/apis/types"
|
||||
|
||||
"github.com/oam-dev/kubevela/apis/core.oam.dev/v1alpha1"
|
||||
"github.com/oam-dev/kubevela/apis/core.oam.dev/v1beta1"
|
||||
"github.com/oam-dev/kubevela/apis/types"
|
||||
"github.com/oam-dev/kubevela/pkg/oam/util"
|
||||
common2 "github.com/oam-dev/kubevela/pkg/utils/common"
|
||||
)
|
||||
|
||||
func TestParsePolicies(t *testing.T) {
|
||||
overrideCompDef := &v1beta1.ComponentDefinition{
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "webservice", Namespace: "vela-system"},
|
||||
Spec: v1beta1.ComponentDefinitionSpec{Workload: common.WorkloadTypeDescriptor{Type: "Deployment"}},
|
||||
}
|
||||
customPolicyDef := &v1beta1.PolicyDefinition{
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "custom-policy", Namespace: "vela-system"},
|
||||
Spec: v1beta1.PolicyDefinitionSpec{
|
||||
Schematic: &common.Schematic{
|
||||
CUE: &common.CUE{Template: "parameter: {name: string}"},
|
||||
},
|
||||
},
|
||||
}
|
||||
schemes := runtime.NewScheme()
|
||||
v1beta1.AddToScheme(schemes)
|
||||
|
||||
testcases := []struct {
|
||||
name string
|
||||
appfile *Appfile
|
||||
client client.Client
|
||||
wantErrContain string
|
||||
assertFunc func(*testing.T, *Appfile)
|
||||
}{
|
||||
{
|
||||
name: "policy with nil properties",
|
||||
appfile: &Appfile{
|
||||
app: &v1beta1.Application{
|
||||
Spec: v1beta1.ApplicationSpec{
|
||||
Policies: []v1beta1.AppPolicy{
|
||||
{
|
||||
Name: "gc-policy",
|
||||
Type: v1alpha1.GarbageCollectPolicyType,
|
||||
Properties: nil,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
client: fake.NewClientBuilder().WithScheme(schemes).Build(),
|
||||
wantErrContain: "must not have empty properties",
|
||||
},
|
||||
{
|
||||
name: "debug policy",
|
||||
appfile: &Appfile{
|
||||
app: &v1beta1.Application{
|
||||
Spec: v1beta1.ApplicationSpec{
|
||||
Policies: []v1beta1.AppPolicy{
|
||||
{
|
||||
Name: "debug-policy",
|
||||
Type: v1alpha1.DebugPolicyType,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
client: fake.NewClientBuilder().WithScheme(schemes).Build(),
|
||||
assertFunc: func(t *testing.T, af *Appfile) {
|
||||
assert.True(t, af.Debug)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "override policy fails to get definition",
|
||||
appfile: &Appfile{
|
||||
app: &v1beta1.Application{
|
||||
Spec: v1beta1.ApplicationSpec{
|
||||
Components: []common.ApplicationComponent{
|
||||
{
|
||||
Name: "comp1",
|
||||
Type: "webservice",
|
||||
},
|
||||
},
|
||||
Policies: []v1beta1.AppPolicy{
|
||||
{
|
||||
Name: "override-policy",
|
||||
Type: v1alpha1.OverridePolicyType,
|
||||
Properties: util.Object2RawExtension(v1alpha1.OverridePolicySpec{
|
||||
Components: []v1alpha1.EnvComponentPatch{
|
||||
{
|
||||
Name: "comp1",
|
||||
Type: "webservice",
|
||||
},
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
RelatedComponentDefinitions: make(map[string]*v1beta1.ComponentDefinition),
|
||||
RelatedTraitDefinitions: make(map[string]*v1beta1.TraitDefinition),
|
||||
},
|
||||
client: &test.MockClient{
|
||||
MockGet: func(ctx context.Context, key client.ObjectKey, obj client.Object) error {
|
||||
return fmt.Errorf("get definition error")
|
||||
},
|
||||
},
|
||||
wantErrContain: "get definition error",
|
||||
},
|
||||
{
|
||||
name: "override policy success",
|
||||
appfile: &Appfile{
|
||||
app: &v1beta1.Application{
|
||||
Spec: v1beta1.ApplicationSpec{
|
||||
Components: []common.ApplicationComponent{
|
||||
{
|
||||
Name: "comp1",
|
||||
Type: "webservice",
|
||||
},
|
||||
},
|
||||
Policies: []v1beta1.AppPolicy{
|
||||
{
|
||||
Name: "override-policy",
|
||||
Type: v1alpha1.OverridePolicyType,
|
||||
Properties: util.Object2RawExtension(v1alpha1.OverridePolicySpec{
|
||||
Components: []v1alpha1.EnvComponentPatch{
|
||||
{
|
||||
Name: "comp1",
|
||||
Type: "webservice",
|
||||
},
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
RelatedComponentDefinitions: make(map[string]*v1beta1.ComponentDefinition),
|
||||
RelatedTraitDefinitions: make(map[string]*v1beta1.TraitDefinition),
|
||||
},
|
||||
client: fake.NewClientBuilder().WithScheme(schemes).WithObjects(overrideCompDef).Build(),
|
||||
assertFunc: func(t *testing.T, af *Appfile) {
|
||||
assert.Contains(t, af.RelatedComponentDefinitions, "webservice")
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "custom policy definition not found",
|
||||
appfile: &Appfile{
|
||||
app: &v1beta1.Application{
|
||||
Spec: v1beta1.ApplicationSpec{
|
||||
Policies: []v1beta1.AppPolicy{
|
||||
{
|
||||
Name: "my-policy",
|
||||
Type: "custom-policy",
|
||||
Properties: util.Object2RawExtension(map[string]string{"name": "test"}),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
client: &test.MockClient{
|
||||
MockGet: func(ctx context.Context, key client.ObjectKey, obj client.Object) error {
|
||||
if _, ok := obj.(*v1beta1.PolicyDefinition); ok {
|
||||
return errors2.NewNotFound(v1beta1.Resource("policydefinition"), "custom-policy")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
wantErrContain: "fetch component/policy type of my-policy",
|
||||
},
|
||||
{
|
||||
name: "custom policy success",
|
||||
appfile: &Appfile{
|
||||
app: &v1beta1.Application{
|
||||
Spec: v1beta1.ApplicationSpec{
|
||||
Policies: []v1beta1.AppPolicy{
|
||||
{
|
||||
Name: "my-policy",
|
||||
Type: "custom-policy",
|
||||
Properties: util.Object2RawExtension(map[string]string{"name": "test"}),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
client: fake.NewClientBuilder().WithScheme(schemes).WithObjects(customPolicyDef).Build(),
|
||||
assertFunc: func(t *testing.T, af *Appfile) {
|
||||
assert.Equal(t, 1, len(af.ParsedPolicies))
|
||||
assert.Equal(t, "my-policy", af.ParsedPolicies[0].Name)
|
||||
assert.Equal(t, "custom-policy", af.ParsedPolicies[0].Type)
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range testcases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
p := NewApplicationParser(tc.client)
|
||||
// This function is tested separated, mock it for parsePolicies
|
||||
if tc.appfile.app != nil {
|
||||
tc.appfile.Policies = tc.appfile.app.Spec.Policies
|
||||
}
|
||||
err := p.parsePolicies(context.Background(), tc.appfile)
|
||||
|
||||
if tc.wantErrContain != "" {
|
||||
assert.Error(t, err)
|
||||
assert.Contains(t, err.Error(), tc.wantErrContain)
|
||||
} else {
|
||||
assert.NoError(t, err)
|
||||
if tc.assertFunc != nil {
|
||||
tc.assertFunc(t, tc.appfile)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
var expectedExceptApp = &Appfile{
|
||||
Name: "application-sample",
|
||||
ParsedComponents: []*Component{
|
||||
@@ -81,10 +281,10 @@ var expectedExceptApp = &Appfile{
|
||||
}
|
||||
}
|
||||
|
||||
selector:
|
||||
matchLabels:
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
selector:
|
||||
matchLabels:
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
}
|
||||
|
||||
parameter: {
|
||||
@@ -149,7 +349,7 @@ spec:
|
||||
selector:
|
||||
matchLabels:
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
parameter: {
|
||||
@@ -235,11 +435,11 @@ spec:
|
||||
properties:
|
||||
`
|
||||
|
||||
var _ = Describe("Test application parser", func() {
|
||||
It("Test parse an application", func() {
|
||||
func TestApplicationParser(t *testing.T) {
|
||||
t.Run("Test parse an application", func(t *testing.T) {
|
||||
o := v1beta1.Application{}
|
||||
err := yaml.Unmarshal([]byte(appfileYaml), &o)
|
||||
Expect(err).ShouldNot(HaveOccurred())
|
||||
assert.NoError(t, err)
|
||||
|
||||
// Create a mock client
|
||||
tclient := test.MockClient{
|
||||
@@ -266,24 +466,24 @@ var _ = Describe("Test application parser", func() {
|
||||
}
|
||||
|
||||
appfile, err := NewApplicationParser(&tclient).GenerateAppFile(context.TODO(), &o)
|
||||
Expect(err).ShouldNot(HaveOccurred())
|
||||
Expect(equal(expectedExceptApp, appfile)).Should(BeTrue())
|
||||
assert.NoError(t, err)
|
||||
assert.True(t, equal(expectedExceptApp, appfile))
|
||||
|
||||
notfound := v1beta1.Application{}
|
||||
err = yaml.Unmarshal([]byte(appfileYaml2), ¬found)
|
||||
Expect(err).ShouldNot(HaveOccurred())
|
||||
assert.NoError(t, err)
|
||||
_, err = NewApplicationParser(&tclient).GenerateAppFile(context.TODO(), ¬found)
|
||||
Expect(err).Should(HaveOccurred())
|
||||
assert.Error(t, err)
|
||||
|
||||
By("app with empty policy")
|
||||
t.Log("app with empty policy")
|
||||
emptyPolicy := v1beta1.Application{}
|
||||
err = yaml.Unmarshal([]byte(appfileYamlEmptyPolicy), &emptyPolicy)
|
||||
Expect(err).ShouldNot(HaveOccurred())
|
||||
assert.NoError(t, err)
|
||||
_, err = NewApplicationParser(&tclient).GenerateAppFile(context.TODO(), &emptyPolicy)
|
||||
Expect(err).Should(HaveOccurred())
|
||||
Expect(err.Error()).Should(ContainSubstring("have empty properties"))
|
||||
assert.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "have empty properties")
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
func equal(af, dest *Appfile) bool {
|
||||
if af.Name != dest.Name || len(af.ParsedComponents) != len(dest.ParsedComponents) {
|
||||
@@ -313,29 +513,28 @@ func equal(af, dest *Appfile) bool {
|
||||
return true
|
||||
}
|
||||
|
||||
var _ = Describe("Test application parser", func() {
|
||||
func TestApplicationParserWithLegacyRevision(t *testing.T) {
|
||||
var app v1beta1.Application
|
||||
var apprev v1beta1.ApplicationRevision
|
||||
var wsd v1beta1.WorkflowStepDefinition
|
||||
var expectedExceptAppfile *Appfile
|
||||
var mockClient test.MockClient
|
||||
|
||||
BeforeEach(func() {
|
||||
// prepare WorkflowStepDefinition
|
||||
Expect(common2.ReadYamlToObject("testdata/backport-1-2/wsd.yaml", &wsd)).Should(BeNil())
|
||||
// prepare WorkflowStepDefinition
|
||||
assert.NoError(t, common2.ReadYamlToObject("testdata/backport-1-2/wsd.yaml", &wsd))
|
||||
|
||||
// prepare verify data
|
||||
expectedExceptAppfile = &Appfile{
|
||||
Name: "backport-1-2-test-demo",
|
||||
ParsedComponents: []*Component{
|
||||
{
|
||||
Name: "backport-1-2-test-demo",
|
||||
Type: "webservice",
|
||||
Params: map[string]interface{}{
|
||||
"image": "nginx",
|
||||
},
|
||||
FullTemplate: &Template{
|
||||
TemplateStr: `
|
||||
// prepare verify data
|
||||
expectedExceptAppfile = &Appfile{
|
||||
Name: "backport-1-2-test-demo",
|
||||
ParsedComponents: []*Component{
|
||||
{
|
||||
Name: "backport-1-2-test-demo",
|
||||
Type: "webservice",
|
||||
Params: map[string]interface{}{
|
||||
"image": "nginx",
|
||||
},
|
||||
FullTemplate: &Template{
|
||||
TemplateStr: `
|
||||
output: {
|
||||
apiVersion: "apps/v1"
|
||||
kind: "Deployment"
|
||||
@@ -361,10 +560,10 @@ var _ = Describe("Test application parser", func() {
|
||||
}
|
||||
}
|
||||
|
||||
selector:
|
||||
matchLabels:
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
selector:
|
||||
matchLabels:
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
}
|
||||
|
||||
parameter: {
|
||||
@@ -374,14 +573,14 @@ var _ = Describe("Test application parser", func() {
|
||||
|
||||
cmd?: [...string]
|
||||
}`,
|
||||
},
|
||||
Traits: []*Trait{
|
||||
{
|
||||
Name: "scaler",
|
||||
Params: map[string]interface{}{
|
||||
"replicas": float64(1),
|
||||
},
|
||||
Template: `
|
||||
},
|
||||
Traits: []*Trait{
|
||||
{
|
||||
Name: "scaler",
|
||||
Params: map[string]interface{}{
|
||||
"replicas": float64(1),
|
||||
},
|
||||
Template: `
|
||||
parameter: {
|
||||
// +usage=Specify the number of workload
|
||||
replicas: *1 | int
|
||||
@@ -390,62 +589,59 @@ parameter: {
|
||||
patch: spec: replicas: parameter.replicas
|
||||
|
||||
`,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
WorkflowSteps: []workflowv1alpha1.WorkflowStep{
|
||||
{
|
||||
WorkflowStepBase: workflowv1alpha1.WorkflowStepBase{
|
||||
Name: "apply",
|
||||
Type: "apply-application",
|
||||
},
|
||||
},
|
||||
WorkflowSteps: []workflowv1alpha1.WorkflowStep{
|
||||
{
|
||||
WorkflowStepBase: workflowv1alpha1.WorkflowStepBase{
|
||||
Name: "apply",
|
||||
Type: "apply-application",
|
||||
},
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
// Create mock client
|
||||
mockClient = test.MockClient{
|
||||
MockGet: func(ctx context.Context, key client.ObjectKey, obj client.Object) error {
|
||||
if strings.Contains(key.Name, "unknown") {
|
||||
return &errors2.StatusError{ErrStatus: metav1.Status{Reason: "NotFound", Message: "not found"}}
|
||||
// Create mock client
|
||||
mockClient = test.MockClient{
|
||||
MockGet: func(ctx context.Context, key client.ObjectKey, obj client.Object) error {
|
||||
if strings.Contains(key.Name, "unknown") {
|
||||
return &errors2.StatusError{ErrStatus: metav1.Status{Reason: "NotFound", Message: "not found"}}
|
||||
}
|
||||
switch o := obj.(type) {
|
||||
case *v1beta1.ComponentDefinition:
|
||||
wd, err := util.UnMarshalStringToComponentDefinition(componentDefinition)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
switch o := obj.(type) {
|
||||
case *v1beta1.ComponentDefinition:
|
||||
wd, err := util.UnMarshalStringToComponentDefinition(componentDefinition)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
*o = *wd
|
||||
case *v1beta1.WorkflowStepDefinition:
|
||||
*o = wsd
|
||||
case *v1beta1.ApplicationRevision:
|
||||
*o = apprev
|
||||
default:
|
||||
// skip
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
})
|
||||
*o = *wd
|
||||
case *v1beta1.WorkflowStepDefinition:
|
||||
*o = wsd
|
||||
case *v1beta1.ApplicationRevision:
|
||||
*o = apprev
|
||||
default:
|
||||
// skip
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
When("with apply-application workflowStep", func() {
|
||||
BeforeEach(func() {
|
||||
// prepare application
|
||||
Expect(common2.ReadYamlToObject("testdata/backport-1-2/app.yaml", &app)).Should(BeNil())
|
||||
// prepare application revision
|
||||
Expect(common2.ReadYamlToObject("testdata/backport-1-2/apprev1.yaml", &apprev)).Should(BeNil())
|
||||
})
|
||||
t.Run("with apply-application workflowStep", func(t *testing.T) {
|
||||
// prepare application
|
||||
assert.NoError(t, common2.ReadYamlToObject("testdata/backport-1-2/app.yaml", &app))
|
||||
// prepare application revision
|
||||
assert.NoError(t, common2.ReadYamlToObject("testdata/backport-1-2/apprev1.yaml", &apprev))
|
||||
|
||||
It("Test we can parse an application revision to an appFile 1", func() {
|
||||
t.Run("Test we can parse an application revision to an appFile 1", func(t *testing.T) {
|
||||
|
||||
appfile, err := NewApplicationParser(&mockClient).GenerateAppFile(context.TODO(), &app)
|
||||
Expect(err).ShouldNot(HaveOccurred())
|
||||
Expect(equal(expectedExceptAppfile, appfile)).Should(BeTrue())
|
||||
Expect(len(appfile.WorkflowSteps) > 0 &&
|
||||
len(appfile.RelatedWorkflowStepDefinitions) == len(appfile.AppRevision.Spec.WorkflowStepDefinitions)).Should(BeTrue())
|
||||
assert.NoError(t, err)
|
||||
assert.True(t, equal(expectedExceptAppfile, appfile))
|
||||
assert.True(t, len(appfile.WorkflowSteps) > 0 &&
|
||||
len(appfile.RelatedWorkflowStepDefinitions) == len(appfile.AppRevision.Spec.WorkflowStepDefinitions))
|
||||
|
||||
Expect(len(appfile.WorkflowSteps) > 0 && func() bool {
|
||||
assert.True(t, len(appfile.WorkflowSteps) > 0 && func() bool {
|
||||
this := appfile.RelatedWorkflowStepDefinitions
|
||||
that := appfile.AppRevision.Spec.WorkflowStepDefinitions
|
||||
for i, w := range this {
|
||||
@@ -455,27 +651,25 @@ patch: spec: replicas: parameter.replicas
|
||||
}
|
||||
}
|
||||
return true
|
||||
}()).Should(BeTrue())
|
||||
}())
|
||||
})
|
||||
})
|
||||
|
||||
When("with apply-application and apply-component build-in workflowStep", func() {
|
||||
BeforeEach(func() {
|
||||
// prepare application
|
||||
Expect(common2.ReadYamlToObject("testdata/backport-1-2/app.yaml", &app)).Should(BeNil())
|
||||
// prepare application revision
|
||||
Expect(common2.ReadYamlToObject("testdata/backport-1-2/apprev2.yaml", &apprev)).Should(BeNil())
|
||||
})
|
||||
t.Run("with apply-application and apply-component build-in workflowStep", func(t *testing.T) {
|
||||
// prepare application
|
||||
assert.NoError(t, common2.ReadYamlToObject("testdata/backport-1-2/app.yaml", &app))
|
||||
// prepare application revision
|
||||
assert.NoError(t, common2.ReadYamlToObject("testdata/backport-1-2/apprev2.yaml", &apprev))
|
||||
|
||||
It("Test we can parse an application revision to an appFile 2", func() {
|
||||
t.Run("Test we can parse an application revision to an appFile 2", func(t *testing.T) {
|
||||
|
||||
appfile, err := NewApplicationParser(&mockClient).GenerateAppFile(context.TODO(), &app)
|
||||
Expect(err).ShouldNot(HaveOccurred())
|
||||
Expect(equal(expectedExceptAppfile, appfile)).Should(BeTrue())
|
||||
Expect(len(appfile.WorkflowSteps) > 0 &&
|
||||
len(appfile.RelatedWorkflowStepDefinitions) == len(appfile.AppRevision.Spec.WorkflowStepDefinitions)).Should(BeTrue())
|
||||
assert.NoError(t, err)
|
||||
assert.True(t, equal(expectedExceptAppfile, appfile))
|
||||
assert.True(t, len(appfile.WorkflowSteps) > 0 &&
|
||||
len(appfile.RelatedWorkflowStepDefinitions) == len(appfile.AppRevision.Spec.WorkflowStepDefinitions))
|
||||
|
||||
Expect(len(appfile.WorkflowSteps) > 0 && func() bool {
|
||||
assert.True(t, len(appfile.WorkflowSteps) > 0 && func() bool {
|
||||
this := appfile.RelatedWorkflowStepDefinitions
|
||||
that := appfile.AppRevision.Spec.WorkflowStepDefinitions
|
||||
for i, w := range this {
|
||||
@@ -486,29 +680,25 @@ patch: spec: replicas: parameter.replicas
|
||||
}
|
||||
}
|
||||
return true
|
||||
}()).Should(BeTrue())
|
||||
}())
|
||||
})
|
||||
})
|
||||
|
||||
When("with unknown workflowStep", func() {
|
||||
BeforeEach(func() {
|
||||
// prepare application
|
||||
Expect(common2.ReadYamlToObject("testdata/backport-1-2/app.yaml", &app)).Should(BeNil())
|
||||
// prepare application revision
|
||||
Expect(common2.ReadYamlToObject("testdata/backport-1-2/apprev3.yaml", &apprev)).Should(BeNil())
|
||||
})
|
||||
t.Run("with unknown workflowStep", func(t *testing.T) {
|
||||
// prepare application
|
||||
assert.NoError(t, common2.ReadYamlToObject("testdata/backport-1-2/app.yaml", &app))
|
||||
// prepare application revision
|
||||
assert.NoError(t, common2.ReadYamlToObject("testdata/backport-1-2/apprev3.yaml", &apprev))
|
||||
|
||||
It("Test we can parse an application revision to an appFile 3", func() {
|
||||
t.Run("Test we can parse an application revision to an appFile 3", func(t *testing.T) {
|
||||
|
||||
_, err := NewApplicationParser(&mockClient).GenerateAppFile(context.TODO(), &app)
|
||||
Expect(err).Should(HaveOccurred())
|
||||
Expect(err.Error()).Should(SatisfyAll(
|
||||
ContainSubstring("failed to get workflow step definition apply-application-unknown: not found"),
|
||||
ContainSubstring("failed to parseWorkflowStepsForLegacyRevision")),
|
||||
)
|
||||
assert.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "failed to get workflow step definition apply-application-unknown: not found")
|
||||
assert.Contains(t, err.Error(), "failed to parseWorkflowStepsForLegacyRevision")
|
||||
})
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
func TestParser_parseTraits(t *testing.T) {
|
||||
type args struct {
|
||||
@@ -707,3 +897,145 @@ func TestParser_parseTraitsFromRevision(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseComponentFromRevisionAndClient(t *testing.T) {
|
||||
compDef := &v1beta1.ComponentDefinition{
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "webservice", Namespace: "vela-system"},
|
||||
Spec: v1beta1.ComponentDefinitionSpec{
|
||||
Workload: common.WorkloadTypeDescriptor{Type: "Deployment"},
|
||||
Schematic: &common.Schematic{CUE: &common.CUE{Template: "parameter: {image: string}"}},
|
||||
},
|
||||
}
|
||||
traitDef := &v1beta1.TraitDefinition{
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "scaler", Namespace: "vela-system"},
|
||||
Spec: v1beta1.TraitDefinitionSpec{
|
||||
Schematic: &common.Schematic{CUE: &common.CUE{Template: "parameter: {replicas: int}"}},
|
||||
},
|
||||
}
|
||||
|
||||
appComp := common.ApplicationComponent{
|
||||
Name: "my-comp",
|
||||
Type: "webservice",
|
||||
Properties: util.Object2RawExtension(map[string]string{"image": "nginx"}),
|
||||
Traits: []common.ApplicationTrait{
|
||||
{
|
||||
Type: "scaler",
|
||||
Properties: util.Object2RawExtension(map[string]int{"replicas": 2}),
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
schemes := runtime.NewScheme()
|
||||
v1beta1.AddToScheme(schemes)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
appRev *v1beta1.ApplicationRevision
|
||||
client client.Client
|
||||
wantErr bool
|
||||
assertFunc func(*testing.T, *Component)
|
||||
}{
|
||||
{
|
||||
name: "component and trait found in revision",
|
||||
appRev: &v1beta1.ApplicationRevision{
|
||||
Spec: v1beta1.ApplicationRevisionSpec{
|
||||
ApplicationRevisionCompressibleFields: v1beta1.ApplicationRevisionCompressibleFields{
|
||||
ComponentDefinitions: map[string]*v1beta1.ComponentDefinition{"webservice": compDef},
|
||||
TraitDefinitions: map[string]*v1beta1.TraitDefinition{"scaler": traitDef},
|
||||
},
|
||||
},
|
||||
},
|
||||
client: fake.NewClientBuilder().WithScheme(schemes).Build(),
|
||||
wantErr: false,
|
||||
assertFunc: func(t *testing.T, c *Component) {
|
||||
assert.NotNil(t, c)
|
||||
assert.Equal(t, "my-comp", c.Name)
|
||||
assert.Equal(t, "webservice", c.Type)
|
||||
assert.Equal(t, 1, len(c.Traits))
|
||||
assert.Equal(t, "scaler", c.Traits[0].Name)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "component not in revision, but in cluster",
|
||||
appRev: &v1beta1.ApplicationRevision{
|
||||
Spec: v1beta1.ApplicationRevisionSpec{
|
||||
ApplicationRevisionCompressibleFields: v1beta1.ApplicationRevisionCompressibleFields{
|
||||
TraitDefinitions: map[string]*v1beta1.TraitDefinition{"scaler": traitDef},
|
||||
},
|
||||
},
|
||||
},
|
||||
client: fake.NewClientBuilder().WithScheme(schemes).WithObjects(compDef).Build(),
|
||||
wantErr: false,
|
||||
assertFunc: func(t *testing.T, c *Component) {
|
||||
assert.NotNil(t, c)
|
||||
assert.Equal(t, "webservice", c.Type)
|
||||
assert.Equal(t, 1, len(c.Traits))
|
||||
assert.Equal(t, "scaler", c.Traits[0].Name)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "trait not in revision, but in cluster",
|
||||
appRev: &v1beta1.ApplicationRevision{
|
||||
Spec: v1beta1.ApplicationRevisionSpec{
|
||||
ApplicationRevisionCompressibleFields: v1beta1.ApplicationRevisionCompressibleFields{
|
||||
ComponentDefinitions: map[string]*v1beta1.ComponentDefinition{"webservice": compDef},
|
||||
},
|
||||
},
|
||||
},
|
||||
client: fake.NewClientBuilder().WithScheme(schemes).WithObjects(traitDef).Build(),
|
||||
wantErr: false,
|
||||
assertFunc: func(t *testing.T, c *Component) {
|
||||
assert.NotNil(t, c)
|
||||
assert.Equal(t, "webservice", c.Type)
|
||||
assert.Equal(t, 1, len(c.Traits))
|
||||
assert.Equal(t, "scaler", c.Traits[0].Name)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "component and trait not in revision, but in cluster",
|
||||
appRev: &v1beta1.ApplicationRevision{},
|
||||
client: fake.NewClientBuilder().WithScheme(schemes).WithObjects(compDef, traitDef).Build(),
|
||||
wantErr: false,
|
||||
assertFunc: func(t *testing.T, c *Component) {
|
||||
assert.NotNil(t, c)
|
||||
assert.Equal(t, "webservice", c.Type)
|
||||
assert.Equal(t, 1, len(c.Traits))
|
||||
assert.Equal(t, "scaler", c.Traits[0].Name)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "component not found anywhere",
|
||||
appRev: &v1beta1.ApplicationRevision{},
|
||||
client: fake.NewClientBuilder().WithScheme(schemes).Build(),
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "trait not found anywhere",
|
||||
appRev: &v1beta1.ApplicationRevision{
|
||||
Spec: v1beta1.ApplicationRevisionSpec{
|
||||
ApplicationRevisionCompressibleFields: v1beta1.ApplicationRevisionCompressibleFields{
|
||||
ComponentDefinitions: map[string]*v1beta1.ComponentDefinition{"webservice": compDef},
|
||||
},
|
||||
},
|
||||
},
|
||||
client: fake.NewClientBuilder().WithScheme(schemes).Build(),
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
p := NewApplicationParser(tt.client)
|
||||
comp, err := p.ParseComponentFromRevisionAndClient(context.Background(), appComp, tt.appRev)
|
||||
|
||||
if tt.wantErr {
|
||||
assert.Error(t, err)
|
||||
} else {
|
||||
assert.NoError(t, err)
|
||||
if tt.assertFunc != nil {
|
||||
tt.assertFunc(t, comp)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,77 +0,0 @@
|
||||
/*
|
||||
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 appfile
|
||||
|
||||
import (
|
||||
"path/filepath"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
v1 "k8s.io/api/apps/v1"
|
||||
"k8s.io/apimachinery/pkg/runtime"
|
||||
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
|
||||
"k8s.io/client-go/rest"
|
||||
"sigs.k8s.io/controller-runtime/pkg/client"
|
||||
"sigs.k8s.io/controller-runtime/pkg/envtest"
|
||||
logf "sigs.k8s.io/controller-runtime/pkg/log"
|
||||
"sigs.k8s.io/controller-runtime/pkg/log/zap"
|
||||
|
||||
coreoam "github.com/oam-dev/kubevela/apis/core.oam.dev"
|
||||
// +kubebuilder:scaffold:imports
|
||||
)
|
||||
|
||||
var cfg *rest.Config
|
||||
var scheme *runtime.Scheme
|
||||
var k8sClient client.Client
|
||||
var testEnv *envtest.Environment
|
||||
|
||||
func TestAppFile(t *testing.T) {
|
||||
RegisterFailHandler(Fail)
|
||||
RunSpecs(t, "Cli Suite")
|
||||
}
|
||||
|
||||
var _ = BeforeSuite(func() {
|
||||
logf.SetLogger(zap.New(zap.UseDevMode(true), zap.WriteTo(GinkgoWriter)))
|
||||
By("bootstrapping test environment")
|
||||
useExistCluster := false
|
||||
testEnv = &envtest.Environment{
|
||||
ControlPlaneStartTimeout: time.Minute,
|
||||
ControlPlaneStopTimeout: time.Minute,
|
||||
CRDDirectoryPaths: []string{filepath.Join("..", "..", "charts", "vela-core", "crds")},
|
||||
UseExistingCluster: &useExistCluster,
|
||||
}
|
||||
|
||||
var err error
|
||||
cfg, err = testEnv.Start()
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(cfg).ToNot(BeNil())
|
||||
scheme = runtime.NewScheme()
|
||||
Expect(coreoam.AddToScheme(scheme)).NotTo(HaveOccurred())
|
||||
Expect(clientgoscheme.AddToScheme(scheme)).NotTo(HaveOccurred())
|
||||
Expect(v1.AddToScheme(scheme)).NotTo(HaveOccurred())
|
||||
k8sClient, err = client.New(cfg, client.Options{Scheme: scheme})
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(k8sClient).ToNot(BeNil())
|
||||
})
|
||||
|
||||
var _ = AfterSuite(func() {
|
||||
By("tearing down the test environment")
|
||||
err := testEnv.Stop()
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
})
|
||||
@@ -18,14 +18,19 @@ package appfile
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"cuelang.org/go/cue/cuecontext"
|
||||
"github.com/crossplane/crossplane-runtime/pkg/test"
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"k8s.io/apimachinery/pkg/api/meta"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
|
||||
"k8s.io/apimachinery/pkg/runtime"
|
||||
"k8s.io/apimachinery/pkg/runtime/schema"
|
||||
ktypes "k8s.io/apimachinery/pkg/types"
|
||||
"sigs.k8s.io/controller-runtime/pkg/client"
|
||||
|
||||
@@ -35,6 +40,24 @@ import (
|
||||
oamutil "github.com/oam-dev/kubevela/pkg/oam/util"
|
||||
)
|
||||
|
||||
type fakeRESTMapper struct {
|
||||
meta.RESTMapper
|
||||
}
|
||||
|
||||
func (f fakeRESTMapper) KindFor(resource schema.GroupVersionResource) (schema.GroupVersionKind, error) {
|
||||
if resource.Resource == "deployments" {
|
||||
return schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}, nil
|
||||
}
|
||||
return schema.GroupVersionKind{}, errors.New("no mapping for KindFor")
|
||||
}
|
||||
|
||||
func (f fakeRESTMapper) KindsFor(resource schema.GroupVersionResource) ([]schema.GroupVersionKind, error) {
|
||||
if resource.Resource == "deployments" {
|
||||
return []schema.GroupVersionKind{{Group: "apps", Version: "v1", Kind: "Deployment"}}, nil
|
||||
}
|
||||
return nil, errors.New("no mapping for KindsFor")
|
||||
}
|
||||
|
||||
func TestLoadComponentTemplate(t *testing.T) {
|
||||
cueTemplate := `
|
||||
context: {
|
||||
@@ -385,3 +408,349 @@ spec:
|
||||
t.Fatal("failed load template of trait definition ", diff)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadTemplateFromRevision(t *testing.T) {
|
||||
compDef := v1beta1.ComponentDefinition{
|
||||
TypeMeta: metav1.TypeMeta{
|
||||
Kind: v1beta1.ComponentDefinitionKind,
|
||||
APIVersion: v1beta1.SchemeGroupVersion.String(),
|
||||
},
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "my-comp"},
|
||||
Spec: v1beta1.ComponentDefinitionSpec{
|
||||
Schematic: &common.Schematic{
|
||||
CUE: &common.CUE{Template: "parameter: {name: string}"},
|
||||
},
|
||||
Workload: common.WorkloadTypeDescriptor{
|
||||
Definition: common.WorkloadGVK{APIVersion: "v1", Kind: "Pod"},
|
||||
},
|
||||
},
|
||||
}
|
||||
traitDef := v1beta1.TraitDefinition{
|
||||
TypeMeta: metav1.TypeMeta{
|
||||
Kind: v1beta1.TraitDefinitionKind,
|
||||
APIVersion: v1beta1.SchemeGroupVersion.String(),
|
||||
},
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "my-trait"},
|
||||
Spec: v1beta1.TraitDefinitionSpec{
|
||||
Schematic: &common.Schematic{
|
||||
CUE: &common.CUE{Template: "parameter: {port: int}"},
|
||||
},
|
||||
},
|
||||
}
|
||||
policyDef := v1beta1.PolicyDefinition{
|
||||
TypeMeta: metav1.TypeMeta{
|
||||
Kind: v1beta1.PolicyDefinitionKind,
|
||||
APIVersion: v1beta1.SchemeGroupVersion.String(),
|
||||
},
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "my-policy"},
|
||||
Spec: v1beta1.PolicyDefinitionSpec{
|
||||
Schematic: &common.Schematic{
|
||||
CUE: &common.CUE{Template: "parameter: {replicas: int}"},
|
||||
},
|
||||
},
|
||||
}
|
||||
wfStepDef := v1beta1.WorkflowStepDefinition{
|
||||
TypeMeta: metav1.TypeMeta{
|
||||
Kind: v1beta1.WorkflowStepDefinitionKind,
|
||||
APIVersion: v1beta1.SchemeGroupVersion.String(),
|
||||
},
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "my-step"},
|
||||
Spec: v1beta1.WorkflowStepDefinitionSpec{
|
||||
Schematic: &common.Schematic{
|
||||
CUE: &common.CUE{Template: "parameter: {image: string}"},
|
||||
},
|
||||
},
|
||||
}
|
||||
wlDef := v1beta1.WorkloadDefinition{
|
||||
TypeMeta: metav1.TypeMeta{
|
||||
Kind: v1beta1.WorkloadDefinitionKind,
|
||||
APIVersion: v1beta1.SchemeGroupVersion.String(),
|
||||
},
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "my-workload"},
|
||||
Spec: v1beta1.WorkloadDefinitionSpec{
|
||||
Reference: common.DefinitionReference{
|
||||
Name: "deployments.apps",
|
||||
},
|
||||
Schematic: &common.Schematic{
|
||||
CUE: &common.CUE{Template: "output: {apiVersion: 'apps/v1', kind: 'Deployment'}"},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
appRev := &v1beta1.ApplicationRevision{
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "my-app-rev"},
|
||||
Spec: v1beta1.ApplicationRevisionSpec{
|
||||
ApplicationRevisionCompressibleFields: v1beta1.ApplicationRevisionCompressibleFields{
|
||||
ComponentDefinitions: map[string]*v1beta1.ComponentDefinition{
|
||||
"my-comp": &compDef,
|
||||
},
|
||||
TraitDefinitions: map[string]*v1beta1.TraitDefinition{
|
||||
"my-trait": &traitDef,
|
||||
},
|
||||
PolicyDefinitions: map[string]v1beta1.PolicyDefinition{
|
||||
"my-policy": policyDef,
|
||||
},
|
||||
WorkflowStepDefinitions: map[string]*v1beta1.WorkflowStepDefinition{
|
||||
"my-step": &wfStepDef,
|
||||
},
|
||||
WorkloadDefinitions: map[string]v1beta1.WorkloadDefinition{
|
||||
"my-workload": wlDef,
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
mapper := fakeRESTMapper{}
|
||||
|
||||
testCases := map[string]struct {
|
||||
capName string
|
||||
capType types.CapType
|
||||
apprev *v1beta1.ApplicationRevision
|
||||
checkFunc func(t *testing.T, tmpl *Template, err error)
|
||||
}{
|
||||
"load component definition": {
|
||||
capName: "my-comp",
|
||||
capType: types.TypeComponentDefinition,
|
||||
apprev: appRev,
|
||||
checkFunc: func(t *testing.T, tmpl *Template, err error) {
|
||||
assert.NoError(t, err)
|
||||
assert.NotNil(t, tmpl)
|
||||
assert.Equal(t, "parameter: {name: string}", tmpl.TemplateStr)
|
||||
assert.Equal(t, v1beta1.ComponentDefinitionKind, tmpl.ComponentDefinition.Kind)
|
||||
},
|
||||
},
|
||||
"load trait definition": {
|
||||
capName: "my-trait",
|
||||
capType: types.TypeTrait,
|
||||
apprev: appRev,
|
||||
checkFunc: func(t *testing.T, tmpl *Template, err error) {
|
||||
assert.NoError(t, err)
|
||||
assert.NotNil(t, tmpl)
|
||||
assert.Equal(t, "parameter: {port: int}", tmpl.TemplateStr)
|
||||
assert.Equal(t, v1beta1.TraitDefinitionKind, tmpl.TraitDefinition.Kind)
|
||||
},
|
||||
},
|
||||
"load policy definition": {
|
||||
capName: "my-policy",
|
||||
capType: types.TypePolicy,
|
||||
apprev: appRev,
|
||||
checkFunc: func(t *testing.T, tmpl *Template, err error) {
|
||||
assert.NoError(t, err)
|
||||
assert.NotNil(t, tmpl)
|
||||
assert.Equal(t, "parameter: {replicas: int}", tmpl.TemplateStr)
|
||||
assert.Equal(t, v1beta1.PolicyDefinitionKind, tmpl.PolicyDefinition.Kind)
|
||||
},
|
||||
},
|
||||
"load workflow step definition": {
|
||||
capName: "my-step",
|
||||
capType: types.TypeWorkflowStep,
|
||||
apprev: appRev,
|
||||
checkFunc: func(t *testing.T, tmpl *Template, err error) {
|
||||
assert.NoError(t, err)
|
||||
assert.NotNil(t, tmpl)
|
||||
assert.Equal(t, "parameter: {image: string}", tmpl.TemplateStr)
|
||||
assert.Equal(t, v1beta1.WorkflowStepDefinitionKind, tmpl.WorkflowStepDefinition.Kind)
|
||||
},
|
||||
},
|
||||
"fallback to workload definition": {
|
||||
capName: "my-workload",
|
||||
capType: types.TypeComponentDefinition,
|
||||
apprev: appRev,
|
||||
checkFunc: func(t *testing.T, tmpl *Template, err error) {
|
||||
assert.NoError(t, err)
|
||||
assert.NotNil(t, tmpl)
|
||||
assert.Equal(t, "output: {apiVersion: 'apps/v1', kind: 'Deployment'}", tmpl.TemplateStr)
|
||||
assert.NotNil(t, tmpl.WorkloadDefinition)
|
||||
assert.Equal(t, v1beta1.WorkloadDefinitionKind, tmpl.WorkloadDefinition.Kind)
|
||||
assert.Equal(t, "apps/v1", tmpl.Reference.Definition.APIVersion)
|
||||
assert.Equal(t, "Deployment", tmpl.Reference.Definition.Kind)
|
||||
},
|
||||
},
|
||||
"definition not found": {
|
||||
capName: "not-exist",
|
||||
capType: types.TypeComponentDefinition,
|
||||
apprev: appRev,
|
||||
checkFunc: func(t *testing.T, tmpl *Template, err error) {
|
||||
assert.Error(t, err)
|
||||
assert.Nil(t, tmpl)
|
||||
assert.True(t, IsNotFoundInAppRevision(err))
|
||||
assert.Contains(t, err.Error(), "component definition [not-exist] not found in app revision my-app-rev")
|
||||
},
|
||||
},
|
||||
"nil app revision": {
|
||||
capName: "any",
|
||||
capType: types.TypeComponentDefinition,
|
||||
apprev: nil,
|
||||
checkFunc: func(t *testing.T, tmpl *Template, err error) {
|
||||
assert.Error(t, err)
|
||||
assert.Nil(t, tmpl)
|
||||
assert.Contains(t, err.Error(), "fail to find template for any as app revision is empty")
|
||||
},
|
||||
},
|
||||
"unsupported type": {
|
||||
capName: "any",
|
||||
capType: "unsupported",
|
||||
apprev: appRev,
|
||||
checkFunc: func(t *testing.T, tmpl *Template, err error) {
|
||||
assert.Error(t, err)
|
||||
assert.Nil(t, tmpl)
|
||||
assert.Contains(t, err.Error(), "kind(unsupported) of any not supported")
|
||||
},
|
||||
},
|
||||
"verify revision name": {
|
||||
capName: "my-comp@my-ns",
|
||||
capType: types.TypeComponentDefinition,
|
||||
apprev: appRev,
|
||||
checkFunc: func(t *testing.T, tmpl *Template, err error) {
|
||||
assert.NoError(t, err)
|
||||
assert.NotNil(t, tmpl)
|
||||
assert.Equal(t, "parameter: {name: string}", tmpl.TemplateStr)
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for name, tc := range testCases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
tmpl, err := LoadTemplateFromRevision(tc.capName, tc.capType, tc.apprev, mapper)
|
||||
tc.checkFunc(t, tmpl, err)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestConvertTemplateJSON2Object(t *testing.T) {
|
||||
testCases := map[string]struct {
|
||||
capName string
|
||||
in *runtime.RawExtension
|
||||
schematic *common.Schematic
|
||||
wantCap types.Capability
|
||||
wantErr bool
|
||||
}{
|
||||
"with schematic CUE": {
|
||||
capName: "test-cap",
|
||||
schematic: &common.Schematic{
|
||||
CUE: &common.CUE{Template: "parameter: {name: string}"},
|
||||
},
|
||||
wantCap: types.Capability{
|
||||
Name: "test-cap",
|
||||
CueTemplate: "parameter: {name: string}",
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
"with RawExtension": {
|
||||
capName: "test-cap-2",
|
||||
in: &runtime.RawExtension{
|
||||
Raw: []byte(`{"template": "parameter: {age: int}"}`),
|
||||
},
|
||||
wantCap: types.Capability{
|
||||
Name: "test-cap-2",
|
||||
CueTemplate: "parameter: {age: int}",
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
"with both schematic and RawExtension": {
|
||||
capName: "test-cap-3",
|
||||
in: &runtime.RawExtension{
|
||||
Raw: []byte(`{"description": "test"}`),
|
||||
},
|
||||
schematic: &common.Schematic{
|
||||
CUE: &common.CUE{Template: "parameter: {name: string}"},
|
||||
},
|
||||
wantCap: types.Capability{
|
||||
Name: "test-cap-3",
|
||||
Description: "test",
|
||||
CueTemplate: "parameter: {name: string}",
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
"with invalid JSON in RawExtension": {
|
||||
capName: "test-cap-4",
|
||||
in: &runtime.RawExtension{
|
||||
Raw: []byte(`{"template": "parameter: {age: int}"`),
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
"with no template": {
|
||||
capName: "test-cap-5",
|
||||
in: &runtime.RawExtension{Raw: []byte(`{"description": "test"}`)},
|
||||
wantCap: types.Capability{
|
||||
Name: "test-cap-5",
|
||||
Description: "test",
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
}
|
||||
|
||||
for name, tc := range testCases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
cap, err := ConvertTemplateJSON2Object(tc.capName, tc.in, tc.schematic)
|
||||
if tc.wantErr {
|
||||
assert.Error(t, err)
|
||||
} else {
|
||||
assert.NoError(t, err)
|
||||
if diff := cmp.Diff(tc.wantCap, cap); diff != "" {
|
||||
t.Errorf("ConvertTemplateJSON2Object() (-want, +got):\n%s", diff)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestTemplateAsStatusRequest(t *testing.T) {
|
||||
tmpl := &Template{
|
||||
Health: "isHealth: true",
|
||||
CustomStatus: "message: 'Ready'",
|
||||
Details: "details: 'some details'",
|
||||
}
|
||||
params := map[string]interface{}{
|
||||
"param1": "value1",
|
||||
}
|
||||
statusReq := tmpl.AsStatusRequest(params)
|
||||
|
||||
assert.Equal(t, "isHealth: true", statusReq.Health)
|
||||
assert.Equal(t, "message: 'Ready'", statusReq.Custom)
|
||||
assert.Equal(t, "details: 'some details'", statusReq.Details)
|
||||
assert.Equal(t, params, statusReq.Parameter)
|
||||
}
|
||||
|
||||
func TestIsNotFoundInAppRevision(t *testing.T) {
|
||||
testCases := map[string]struct {
|
||||
err error
|
||||
expected bool
|
||||
}{
|
||||
"component definition not found": {
|
||||
err: fmt.Errorf("component definition [my-comp] not found in app revision [my-app-rev]"),
|
||||
expected: true,
|
||||
},
|
||||
"trait definition not found": {
|
||||
err: fmt.Errorf("trait definition [my-trait] not found in app revision [my-app-rev]"),
|
||||
expected: true,
|
||||
},
|
||||
"policy definition not found": {
|
||||
err: fmt.Errorf("policy definition [my-policy] not found in app revision [my-app-rev]"),
|
||||
expected: true,
|
||||
},
|
||||
"workflow step definition not found": {
|
||||
err: fmt.Errorf("workflow step definition [my-step] not found in app revision [my-app-rev]"),
|
||||
expected: true,
|
||||
},
|
||||
"different error": {
|
||||
err: errors.New("a completely different error"),
|
||||
expected: false,
|
||||
},
|
||||
"nil error": {
|
||||
err: nil,
|
||||
expected: false,
|
||||
},
|
||||
"error with similar text but not exactly": {
|
||||
err: fmt.Errorf("this resource is not found in revision of app"),
|
||||
expected: false,
|
||||
},
|
||||
}
|
||||
|
||||
for name, tc := range testCases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
result := IsNotFoundInAppRevision(tc.err)
|
||||
assert.Equal(t, tc.expected, result)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,83 +0,0 @@
|
||||
/*
|
||||
Copyright 2023 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 appfile
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/runtime"
|
||||
"sigs.k8s.io/controller-runtime/pkg/client/fake"
|
||||
|
||||
"github.com/oam-dev/kubevela/apis/core.oam.dev/common"
|
||||
"github.com/oam-dev/kubevela/apis/core.oam.dev/v1beta1"
|
||||
)
|
||||
|
||||
func TestIsNotFoundInAppFile(t *testing.T) {
|
||||
require.True(t, IsNotFoundInAppFile(fmt.Errorf("ComponentDefinition XXX not found in appfile")))
|
||||
}
|
||||
|
||||
func TestIsNotFoundInAppRevision(t *testing.T) {
|
||||
require.True(t, IsNotFoundInAppRevision(fmt.Errorf("ComponentDefinition XXX not found in app revision")))
|
||||
}
|
||||
|
||||
func TestParseComponentFromRevisionAndClient(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
cli := fake.NewClientBuilder().WithScheme(scheme).Build()
|
||||
p := &Parser{
|
||||
client: cli,
|
||||
tmplLoader: LoadTemplate,
|
||||
}
|
||||
comp := common.ApplicationComponent{
|
||||
Name: "test",
|
||||
Type: "test",
|
||||
Properties: &runtime.RawExtension{Raw: []byte(`{}`)},
|
||||
Traits: []common.ApplicationTrait{{
|
||||
Type: "tr",
|
||||
Properties: &runtime.RawExtension{Raw: []byte(`{}`)},
|
||||
}, {
|
||||
Type: "internal",
|
||||
Properties: &runtime.RawExtension{Raw: []byte(`{}`)},
|
||||
}},
|
||||
}
|
||||
appRev := &v1beta1.ApplicationRevision{}
|
||||
cd := &v1beta1.ComponentDefinition{ObjectMeta: metav1.ObjectMeta{Name: "test"}}
|
||||
td := &v1beta1.TraitDefinition{ObjectMeta: metav1.ObjectMeta{Name: "tr"}}
|
||||
require.NoError(t, cli.Create(ctx, cd))
|
||||
require.NoError(t, cli.Create(ctx, td))
|
||||
appRev.Spec.TraitDefinitions = map[string]*v1beta1.TraitDefinition{"internal": {}}
|
||||
_, err := p.ParseComponentFromRevisionAndClient(ctx, comp, appRev)
|
||||
require.NoError(t, err)
|
||||
|
||||
_comp1 := comp.DeepCopy()
|
||||
_comp1.Type = "bad"
|
||||
_, err = p.ParseComponentFromRevisionAndClient(ctx, *_comp1, appRev)
|
||||
require.Error(t, err)
|
||||
|
||||
_comp2 := comp.DeepCopy()
|
||||
_comp2.Traits[0].Type = "bad"
|
||||
_, err = p.ParseComponentFromRevisionAndClient(ctx, *_comp2, appRev)
|
||||
require.Error(t, err)
|
||||
|
||||
_comp3 := comp.DeepCopy()
|
||||
_comp3.Traits[0].Properties = &runtime.RawExtension{Raw: []byte(`bad`)}
|
||||
_, err = p.ParseComponentFromRevisionAndClient(ctx, *_comp3, appRev)
|
||||
require.Error(t, err)
|
||||
}
|
||||
@@ -17,64 +17,29 @@ limitations under the License.
|
||||
package appfile
|
||||
|
||||
import (
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
"testing"
|
||||
|
||||
"cuelang.org/go/cue"
|
||||
"github.com/stretchr/testify/assert"
|
||||
utilfeature "k8s.io/apiserver/pkg/util/feature"
|
||||
|
||||
"github.com/oam-dev/kubevela/apis/types"
|
||||
"github.com/oam-dev/kubevela/pkg/cue/definition"
|
||||
"github.com/oam-dev/kubevela/pkg/features"
|
||||
)
|
||||
|
||||
var _ = Describe("Test validate CUE schematic Appfile", func() {
|
||||
func TestTrait_EvalContext_OutputNameUniqueness(t *testing.T) {
|
||||
type SubTestCase struct {
|
||||
name string
|
||||
compDefTmpl string
|
||||
traitDefTmpl1 string
|
||||
traitDefTmpl2 string
|
||||
wantErrMsg string
|
||||
}
|
||||
|
||||
DescribeTable("Test validate outputs name unique", func(tc SubTestCase) {
|
||||
Expect("").Should(BeEmpty())
|
||||
wl := &Component{
|
||||
Name: "myweb",
|
||||
Type: "worker",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Traits: []*Trait{
|
||||
{
|
||||
Name: "myscaler",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Template: tc.traitDefTmpl1,
|
||||
engine: definition.NewTraitAbstractEngine("myscaler"),
|
||||
},
|
||||
{
|
||||
Name: "myingress",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Template: tc.traitDefTmpl2,
|
||||
engine: definition.NewTraitAbstractEngine("myingress"),
|
||||
},
|
||||
},
|
||||
FullTemplate: &Template{
|
||||
TemplateStr: tc.compDefTmpl,
|
||||
},
|
||||
engine: definition.NewWorkloadAbstractEngine("myweb"),
|
||||
}
|
||||
|
||||
ctxData := GenerateContextDataFromAppFile(&Appfile{
|
||||
Name: "myapp",
|
||||
Namespace: "test-ns",
|
||||
AppRevisionName: "myapp-v1",
|
||||
}, wl.Name)
|
||||
pCtx, err := newValidationProcessContext(wl, ctxData)
|
||||
Expect(err).Should(BeNil())
|
||||
Eventually(func() string {
|
||||
for _, tr := range wl.Traits {
|
||||
if err := tr.EvalContext(pCtx); err != nil {
|
||||
return err.Error()
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}).Should(ContainSubstring(tc.wantErrMsg))
|
||||
},
|
||||
Entry("Succeed", SubTestCase{
|
||||
testCases := []SubTestCase{
|
||||
{
|
||||
name: "Succeed",
|
||||
compDefTmpl: `
|
||||
output: {
|
||||
apiVersion: "apps/v1"
|
||||
@@ -98,8 +63,9 @@ var _ = Describe("Test validate CUE schematic Appfile", func() {
|
||||
}
|
||||
`,
|
||||
wantErrMsg: "",
|
||||
}),
|
||||
Entry("CompDef and TraitDef have same outputs", SubTestCase{
|
||||
},
|
||||
{
|
||||
name: "CompDef and TraitDef have same outputs",
|
||||
compDefTmpl: `
|
||||
output: {
|
||||
apiVersion: "apps/v1"
|
||||
@@ -123,8 +89,9 @@ var _ = Describe("Test validate CUE schematic Appfile", func() {
|
||||
}
|
||||
`,
|
||||
wantErrMsg: `auxiliary "mysvc1" already exits`,
|
||||
}),
|
||||
Entry("TraitDefs have same outputs", SubTestCase{
|
||||
},
|
||||
{
|
||||
name: "TraitDefs have same outputs",
|
||||
compDefTmpl: `
|
||||
output: {
|
||||
apiVersion: "apps/v1"
|
||||
@@ -148,41 +115,72 @@ var _ = Describe("Test validate CUE schematic Appfile", func() {
|
||||
}
|
||||
`,
|
||||
wantErrMsg: `auxiliary "mysvc1" already exits`,
|
||||
}),
|
||||
)
|
||||
})
|
||||
},
|
||||
}
|
||||
|
||||
var _ = Describe("Test ValidateComponentParams", func() {
|
||||
type ParamTestCase struct {
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
wl := &Component{
|
||||
Name: "myweb",
|
||||
Type: "worker",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Traits: []*Trait{
|
||||
{
|
||||
Name: "myscaler",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Template: tc.traitDefTmpl1,
|
||||
engine: definition.NewTraitAbstractEngine("myscaler"),
|
||||
},
|
||||
{
|
||||
Name: "myingress",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Template: tc.traitDefTmpl2,
|
||||
engine: definition.NewTraitAbstractEngine("myingress"),
|
||||
},
|
||||
},
|
||||
FullTemplate: &Template{
|
||||
TemplateStr: tc.compDefTmpl,
|
||||
},
|
||||
engine: definition.NewWorkloadAbstractEngine("myweb"),
|
||||
}
|
||||
|
||||
ctxData := GenerateContextDataFromAppFile(&Appfile{
|
||||
Name: "myapp",
|
||||
Namespace: "test-ns",
|
||||
AppRevisionName: "myapp-v1",
|
||||
}, wl.Name)
|
||||
pCtx, err := newValidationProcessContext(wl, ctxData)
|
||||
assert.NoError(t, err)
|
||||
|
||||
var evalErr error
|
||||
for _, tr := range wl.Traits {
|
||||
if err := tr.EvalContext(pCtx); err != nil {
|
||||
evalErr = err
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if tc.wantErrMsg != "" {
|
||||
assert.Error(t, evalErr)
|
||||
assert.Contains(t, evalErr.Error(), tc.wantErrMsg)
|
||||
} else {
|
||||
assert.NoError(t, evalErr)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestParser_ValidateComponentParams(t *testing.T) {
|
||||
testCases := []struct {
|
||||
name string
|
||||
compName string
|
||||
template string
|
||||
params map[string]interface{}
|
||||
wantErr string
|
||||
}
|
||||
|
||||
DescribeTable("ValidateComponentParams cases", func(tc ParamTestCase) {
|
||||
wl := &Component{
|
||||
Name: tc.name,
|
||||
Type: "worker",
|
||||
FullTemplate: &Template{TemplateStr: tc.template},
|
||||
Params: tc.params,
|
||||
}
|
||||
app := &Appfile{
|
||||
Name: "myapp",
|
||||
Namespace: "test-ns",
|
||||
}
|
||||
ctxData := GenerateContextDataFromAppFile(app, wl.Name)
|
||||
parser := &Parser{}
|
||||
err := parser.ValidateComponentParams(ctxData, wl, app)
|
||||
if tc.wantErr == "" {
|
||||
Expect(err).To(BeNil())
|
||||
} else {
|
||||
Expect(err).To(HaveOccurred())
|
||||
Expect(err.Error()).To(ContainSubstring(tc.wantErr))
|
||||
}
|
||||
},
|
||||
Entry("valid params and template", ParamTestCase{
|
||||
name: "valid",
|
||||
}{
|
||||
{
|
||||
name: "valid params and template",
|
||||
compName: "valid",
|
||||
template: `
|
||||
parameter: {
|
||||
replicas: int | *1
|
||||
@@ -196,9 +194,10 @@ var _ = Describe("Test ValidateComponentParams", func() {
|
||||
"replicas": 2,
|
||||
},
|
||||
wantErr: "",
|
||||
}),
|
||||
Entry("invalid CUE in template", ParamTestCase{
|
||||
name: "invalid-cue",
|
||||
},
|
||||
{
|
||||
name: "invalid CUE in template",
|
||||
compName: "invalid-cue",
|
||||
template: `
|
||||
parameter: {
|
||||
replicas: int | *1
|
||||
@@ -213,9 +212,10 @@ var _ = Describe("Test ValidateComponentParams", func() {
|
||||
"replicas": 2,
|
||||
},
|
||||
wantErr: "CUE compile error",
|
||||
}),
|
||||
Entry("missing required parameter", ParamTestCase{
|
||||
name: "missing-required",
|
||||
},
|
||||
{
|
||||
name: "missing required parameter",
|
||||
compName: "missing-required",
|
||||
template: `
|
||||
parameter: {
|
||||
replicas: int
|
||||
@@ -227,9 +227,10 @@ var _ = Describe("Test ValidateComponentParams", func() {
|
||||
`,
|
||||
params: map[string]interface{}{},
|
||||
wantErr: "component \"missing-required\": missing parameters: replicas",
|
||||
}),
|
||||
Entry("parameter constraint violation", ParamTestCase{
|
||||
name: "constraint-violation",
|
||||
},
|
||||
{
|
||||
name: "parameter constraint violation",
|
||||
compName: "constraint-violation",
|
||||
template: `
|
||||
parameter: {
|
||||
replicas: int & >0
|
||||
@@ -243,9 +244,10 @@ var _ = Describe("Test ValidateComponentParams", func() {
|
||||
"replicas": -1,
|
||||
},
|
||||
wantErr: "parameter constraint violation",
|
||||
}),
|
||||
Entry("invalid parameter block", ParamTestCase{
|
||||
name: "invalid-param-block",
|
||||
},
|
||||
{
|
||||
name: "invalid parameter block",
|
||||
compName: "invalid-param-block",
|
||||
template: `
|
||||
parameter: {
|
||||
replicas: int | *1
|
||||
@@ -259,6 +261,340 @@ var _ = Describe("Test ValidateComponentParams", func() {
|
||||
"replicas": "not-an-int",
|
||||
},
|
||||
wantErr: "parameter constraint violation",
|
||||
}),
|
||||
)
|
||||
})
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
wl := &Component{
|
||||
Name: tc.compName,
|
||||
Type: "worker",
|
||||
FullTemplate: &Template{TemplateStr: tc.template},
|
||||
Params: tc.params,
|
||||
}
|
||||
app := &Appfile{
|
||||
Name: "myapp",
|
||||
Namespace: "test-ns",
|
||||
}
|
||||
ctxData := GenerateContextDataFromAppFile(app, wl.Name)
|
||||
parser := &Parser{}
|
||||
err := parser.ValidateComponentParams(ctxData, wl, app)
|
||||
if tc.wantErr == "" {
|
||||
assert.NoError(t, err)
|
||||
} else {
|
||||
assert.Error(t, err)
|
||||
assert.Contains(t, err.Error(), tc.wantErr)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidationHelpers(t *testing.T) {
|
||||
t.Run("renderTemplate", func(t *testing.T) {
|
||||
tmpl := "output: {}"
|
||||
expected := "output: {}\ncontext: _\nparameter: _\n"
|
||||
assert.Equal(t, expected, renderTemplate(tmpl))
|
||||
})
|
||||
|
||||
t.Run("cueParamBlock", func(t *testing.T) {
|
||||
t.Run("should handle empty params", func(t *testing.T) {
|
||||
out, err := cueParamBlock(map[string]any{})
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, "parameter: {}", out)
|
||||
})
|
||||
|
||||
t.Run("should handle valid params", func(t *testing.T) {
|
||||
params := map[string]any{"key": "value"}
|
||||
out, err := cueParamBlock(params)
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, `parameter: {"key":"value"}`, out)
|
||||
})
|
||||
|
||||
t.Run("should return error for unmarshallable params", func(t *testing.T) {
|
||||
params := map[string]any{"key": make(chan int)}
|
||||
_, err := cueParamBlock(params)
|
||||
assert.Error(t, err)
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("filterMissing", func(t *testing.T) {
|
||||
t.Run("should filter missing keys", func(t *testing.T) {
|
||||
keys := []string{"a", "b.c", "d"}
|
||||
provided := map[string]any{
|
||||
"a": 1,
|
||||
"b": map[string]any{
|
||||
"c": 2,
|
||||
},
|
||||
}
|
||||
out, err := filterMissing(keys, provided)
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, []string{"d"}, out)
|
||||
})
|
||||
|
||||
t.Run("should handle no missing keys", func(t *testing.T) {
|
||||
keys := []string{"a"}
|
||||
provided := map[string]any{"a": 1}
|
||||
out, err := filterMissing(keys, provided)
|
||||
assert.NoError(t, err)
|
||||
assert.Empty(t, out)
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("requiredFields", func(t *testing.T) {
|
||||
t.Run("should identify required fields", func(t *testing.T) {
|
||||
cueStr := `
|
||||
parameter: {
|
||||
name: string
|
||||
age: int
|
||||
nested: {
|
||||
field1: string
|
||||
field2: bool
|
||||
}
|
||||
}
|
||||
`
|
||||
var r cue.Runtime
|
||||
inst, err := r.Compile("", cueStr)
|
||||
assert.NoError(t, err)
|
||||
val := inst.Value()
|
||||
paramVal := val.LookupPath(cue.ParsePath("parameter"))
|
||||
|
||||
fields, err := requiredFields(paramVal)
|
||||
assert.NoError(t, err)
|
||||
assert.ElementsMatch(t, []string{"name", "age", "nested.field1", "nested.field2"}, fields)
|
||||
})
|
||||
|
||||
t.Run("should ignore optional and default fields", func(t *testing.T) {
|
||||
cueStr := `
|
||||
parameter: {
|
||||
name: string
|
||||
age?: int
|
||||
location: string | *"unknown"
|
||||
nested: {
|
||||
field1: string
|
||||
field2?: bool
|
||||
}
|
||||
}
|
||||
`
|
||||
var r cue.Runtime
|
||||
inst, err := r.Compile("", cueStr)
|
||||
assert.NoError(t, err)
|
||||
val := inst.Value()
|
||||
paramVal := val.LookupPath(cue.ParsePath("parameter"))
|
||||
|
||||
fields, err := requiredFields(paramVal)
|
||||
assert.NoError(t, err)
|
||||
assert.ElementsMatch(t, []string{"name", "nested.field1"}, fields)
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
func TestEnforceRequiredParams(t *testing.T) {
|
||||
var r cue.Runtime
|
||||
cueStr := `
|
||||
parameter: {
|
||||
image: string
|
||||
replicas: int
|
||||
port: int
|
||||
data: {
|
||||
key: string
|
||||
value: string
|
||||
}
|
||||
}
|
||||
`
|
||||
inst, err := r.Compile("", cueStr)
|
||||
assert.NoError(t, err)
|
||||
root := inst.Value()
|
||||
|
||||
t.Run("should pass if all params are provided directly", func(t *testing.T) {
|
||||
params := map[string]any{
|
||||
"image": "nginx",
|
||||
"replicas": 2,
|
||||
"port": 80,
|
||||
"data": map[string]any{
|
||||
"key": "k",
|
||||
"value": "v",
|
||||
},
|
||||
}
|
||||
app := &Appfile{}
|
||||
err := enforceRequiredParams(root, params, app)
|
||||
assert.NoError(t, err)
|
||||
})
|
||||
|
||||
t.Run("should fail if params are missing", func(t *testing.T) {
|
||||
params := map[string]any{
|
||||
"image": "nginx",
|
||||
}
|
||||
app := &Appfile{}
|
||||
err := enforceRequiredParams(root, params, app)
|
||||
assert.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "missing parameters: replicas,port,data.key,data.value")
|
||||
})
|
||||
}
|
||||
|
||||
func TestParser_ValidateCUESchematicAppfile(t *testing.T) {
|
||||
assert.NoError(t, utilfeature.DefaultMutableFeatureGate.Set(string(features.EnableCueValidation)+"=true"))
|
||||
t.Cleanup(func() {
|
||||
assert.NoError(t, utilfeature.DefaultMutableFeatureGate.Set(string(features.EnableCueValidation)+"=false"))
|
||||
})
|
||||
|
||||
t.Run("should validate a valid CUE schematic appfile", func(t *testing.T) {
|
||||
appfile := &Appfile{
|
||||
Name: "test-app",
|
||||
Namespace: "test-ns",
|
||||
ParsedComponents: []*Component{
|
||||
{
|
||||
Name: "my-comp",
|
||||
Type: "worker",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Params: map[string]any{
|
||||
"image": "nginx",
|
||||
},
|
||||
FullTemplate: &Template{
|
||||
TemplateStr: `
|
||||
parameter: {
|
||||
image: string
|
||||
}
|
||||
output: {
|
||||
apiVersion: "apps/v1"
|
||||
kind: "Deployment"
|
||||
spec: {
|
||||
template: {
|
||||
spec: {
|
||||
containers: [{
|
||||
name: "my-container"
|
||||
image: parameter.image
|
||||
}]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
`,
|
||||
},
|
||||
engine: definition.NewWorkloadAbstractEngine("my-comp"),
|
||||
Traits: []*Trait{
|
||||
{
|
||||
Name: "my-trait",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Template: `
|
||||
parameter: {
|
||||
domain: string
|
||||
}
|
||||
patch: {}
|
||||
`,
|
||||
Params: map[string]any{
|
||||
"domain": "example.com",
|
||||
},
|
||||
engine: definition.NewTraitAbstractEngine("my-trait"),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
p := &Parser{}
|
||||
err := p.ValidateCUESchematicAppfile(appfile)
|
||||
assert.NoError(t, err)
|
||||
})
|
||||
|
||||
t.Run("should return error for invalid trait evaluation", func(t *testing.T) {
|
||||
appfile := &Appfile{
|
||||
Name: "test-app",
|
||||
Namespace: "test-ns",
|
||||
ParsedComponents: []*Component{
|
||||
{
|
||||
Name: "my-comp",
|
||||
Type: "worker",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Params: map[string]any{
|
||||
"image": "nginx",
|
||||
},
|
||||
FullTemplate: &Template{
|
||||
TemplateStr: `
|
||||
parameter: {
|
||||
image: string
|
||||
}
|
||||
output: {
|
||||
apiVersion: "apps/v1"
|
||||
kind: "Deployment"
|
||||
}
|
||||
`,
|
||||
},
|
||||
engine: definition.NewWorkloadAbstractEngine("my-comp"),
|
||||
Traits: []*Trait{
|
||||
{
|
||||
Name: "my-trait",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Template: `
|
||||
// invalid CUE template
|
||||
parameter: {
|
||||
domain: string
|
||||
}
|
||||
patch: {
|
||||
invalid: {
|
||||
}
|
||||
`,
|
||||
Params: map[string]any{
|
||||
"domain": "example.com",
|
||||
},
|
||||
engine: definition.NewTraitAbstractEngine("my-trait"),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
p := &Parser{}
|
||||
err := p.ValidateCUESchematicAppfile(appfile)
|
||||
assert.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "cannot evaluate trait \"my-trait\"")
|
||||
})
|
||||
|
||||
t.Run("should return error for missing parameters", func(t *testing.T) {
|
||||
appfile := &Appfile{
|
||||
Name: "test-app",
|
||||
Namespace: "test-ns",
|
||||
ParsedComponents: []*Component{
|
||||
{
|
||||
Name: "my-comp",
|
||||
Type: "worker",
|
||||
CapabilityCategory: types.CUECategory,
|
||||
Params: map[string]any{}, // no params provided
|
||||
FullTemplate: &Template{
|
||||
TemplateStr: `
|
||||
parameter: {
|
||||
image: string
|
||||
}
|
||||
output: {
|
||||
apiVersion: "apps/v1"
|
||||
kind: "Deployment"
|
||||
}
|
||||
`,
|
||||
},
|
||||
engine: definition.NewWorkloadAbstractEngine("my-comp"),
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
p := &Parser{}
|
||||
err := p.ValidateCUESchematicAppfile(appfile)
|
||||
assert.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "missing parameters: image")
|
||||
})
|
||||
|
||||
t.Run("should skip non-CUE components", func(t *testing.T) {
|
||||
appfile := &Appfile{
|
||||
Name: "test-app",
|
||||
Namespace: "test-ns",
|
||||
ParsedComponents: []*Component{
|
||||
{
|
||||
Name: "my-comp",
|
||||
Type: "helm",
|
||||
CapabilityCategory: types.TerraformCategory,
|
||||
},
|
||||
},
|
||||
}
|
||||
p := &Parser{}
|
||||
err := p.ValidateCUESchematicAppfile(appfile)
|
||||
assert.NoError(t, err)
|
||||
})
|
||||
}
|
||||
|
||||
66
pkg/component/main_test.go
Normal file
66
pkg/component/main_test.go
Normal file
@@ -0,0 +1,66 @@
|
||||
/*
|
||||
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 component
|
||||
|
||||
import (
|
||||
"log"
|
||||
"math/rand"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"k8s.io/client-go/rest"
|
||||
"k8s.io/utils/ptr"
|
||||
"sigs.k8s.io/controller-runtime/pkg/client"
|
||||
"sigs.k8s.io/controller-runtime/pkg/envtest"
|
||||
|
||||
pkgcommon "github.com/oam-dev/kubevela/pkg/utils/common"
|
||||
)
|
||||
|
||||
var cfg *rest.Config
|
||||
var k8sClient client.Client
|
||||
var testEnv *envtest.Environment
|
||||
|
||||
func TestMain(m *testing.M) {
|
||||
rand.Seed(time.Now().UnixNano())
|
||||
|
||||
testEnv = &envtest.Environment{
|
||||
ControlPlaneStartTimeout: time.Minute * 3,
|
||||
ControlPlaneStopTimeout: time.Minute,
|
||||
UseExistingCluster: ptr.To(false),
|
||||
CRDDirectoryPaths: []string{"./testdata"},
|
||||
}
|
||||
|
||||
var err error
|
||||
cfg, err = testEnv.Start()
|
||||
if err != nil {
|
||||
log.Fatalf("Failed to start test environment: %v", err)
|
||||
}
|
||||
|
||||
cfg.Timeout = time.Minute * 2
|
||||
k8sClient, err = client.New(cfg, client.Options{Scheme: pkgcommon.Scheme})
|
||||
if err != nil {
|
||||
log.Fatalf("Failed to create new kube client: %v", err)
|
||||
}
|
||||
|
||||
code := m.Run()
|
||||
|
||||
if err = testEnv.Stop(); err != nil {
|
||||
log.Printf("Failed to tear down the test environment: %v", err)
|
||||
}
|
||||
os.Exit(code)
|
||||
}
|
||||
@@ -1,381 +0,0 @@
|
||||
/*
|
||||
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 component
|
||||
|
||||
import (
|
||||
"context"
|
||||
"math/rand"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
rbacv1 "k8s.io/api/rbac/v1"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
|
||||
utilfeature "k8s.io/apiserver/pkg/util/feature"
|
||||
"k8s.io/client-go/rest"
|
||||
featuregatetesting "k8s.io/component-base/featuregate/testing"
|
||||
"k8s.io/utils/ptr"
|
||||
"sigs.k8s.io/controller-runtime/pkg/client"
|
||||
"sigs.k8s.io/controller-runtime/pkg/envtest"
|
||||
|
||||
"github.com/oam-dev/kubevela/apis/core.oam.dev/v1alpha1"
|
||||
"github.com/oam-dev/kubevela/pkg/features"
|
||||
pkgcommon "github.com/oam-dev/kubevela/pkg/utils/common"
|
||||
)
|
||||
|
||||
var cfg *rest.Config
|
||||
var k8sClient client.Client
|
||||
var testEnv *envtest.Environment
|
||||
|
||||
func TestUtils(t *testing.T) {
|
||||
RegisterFailHandler(Fail)
|
||||
RunSpecs(t, "Utils Suite")
|
||||
}
|
||||
|
||||
var _ = BeforeSuite(func() {
|
||||
rand.Seed(time.Now().UnixNano())
|
||||
By("bootstrapping test environment for utils test")
|
||||
|
||||
testEnv = &envtest.Environment{
|
||||
ControlPlaneStartTimeout: time.Minute * 3,
|
||||
ControlPlaneStopTimeout: time.Minute,
|
||||
UseExistingCluster: ptr.To(false),
|
||||
CRDDirectoryPaths: []string{"./testdata"},
|
||||
}
|
||||
|
||||
By("start kube test env")
|
||||
var err error
|
||||
cfg, err = testEnv.Start()
|
||||
Expect(err).ShouldNot(HaveOccurred())
|
||||
Expect(cfg).ToNot(BeNil())
|
||||
|
||||
By("new kube client")
|
||||
cfg.Timeout = time.Minute * 2
|
||||
k8sClient, err = client.New(cfg, client.Options{Scheme: pkgcommon.Scheme})
|
||||
Expect(err).Should(Succeed())
|
||||
})
|
||||
|
||||
var _ = AfterSuite(func() {
|
||||
By("tearing down the test environment")
|
||||
err := testEnv.Stop()
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
})
|
||||
|
||||
var _ = Describe("Test ref-objects functions", func() {
|
||||
It("Test SelectRefObjectsForDispatch", func() {
|
||||
featuregatetesting.SetFeatureGateDuringTest(GinkgoT(), utilfeature.DefaultFeatureGate, features.LegacyObjectTypeIdentifier, true)
|
||||
featuregatetesting.SetFeatureGateDuringTest(GinkgoT(), utilfeature.DefaultFeatureGate, features.DeprecatedObjectLabelSelector, true)
|
||||
By("Create objects")
|
||||
Expect(k8sClient.Create(context.Background(), &corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: "test"}})).Should(Succeed())
|
||||
for _, obj := range []client.Object{&corev1.ConfigMap{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "dynamic",
|
||||
Namespace: "test",
|
||||
},
|
||||
}, &corev1.Service{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "dynamic",
|
||||
Namespace: "test",
|
||||
Generation: int64(5),
|
||||
},
|
||||
Spec: corev1.ServiceSpec{
|
||||
ClusterIP: "10.0.0.254",
|
||||
Ports: []corev1.ServicePort{{Port: 80}},
|
||||
},
|
||||
}, &corev1.ConfigMap{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "by-label-1",
|
||||
Namespace: "test",
|
||||
Labels: map[string]string{"key": "value"},
|
||||
},
|
||||
}, &corev1.ConfigMap{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "by-label-2",
|
||||
Namespace: "test",
|
||||
Labels: map[string]string{"key": "value"},
|
||||
},
|
||||
}, &rbacv1.ClusterRole{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "test-cluster-role",
|
||||
},
|
||||
}} {
|
||||
Expect(k8sClient.Create(context.Background(), obj)).Should(Succeed())
|
||||
}
|
||||
createUnstructured := func(apiVersion string, kind string, name string, namespace string, labels map[string]interface{}) *unstructured.Unstructured {
|
||||
un := &unstructured.Unstructured{
|
||||
Object: map[string]interface{}{
|
||||
"apiVersion": apiVersion,
|
||||
"kind": kind,
|
||||
"metadata": map[string]interface{}{"name": name},
|
||||
},
|
||||
}
|
||||
if namespace != "" {
|
||||
un.SetNamespace(namespace)
|
||||
}
|
||||
if labels != nil {
|
||||
un.Object["metadata"].(map[string]interface{})["labels"] = labels
|
||||
}
|
||||
return un
|
||||
}
|
||||
testcases := map[string]struct {
|
||||
Input v1alpha1.ObjectReferrer
|
||||
compName string
|
||||
appNs string
|
||||
Output []*unstructured.Unstructured
|
||||
Error string
|
||||
Scope string
|
||||
IsService bool
|
||||
IsClusterRole bool
|
||||
}{
|
||||
"normal": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic"},
|
||||
},
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{createUnstructured("v1", "ConfigMap", "dynamic", "test", nil)},
|
||||
},
|
||||
"legacy-type-identifier": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{LegacyObjectTypeIdentifier: v1alpha1.LegacyObjectTypeIdentifier{Kind: "ConfigMap", APIVersion: "v1"}},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic"},
|
||||
},
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{createUnstructured("v1", "ConfigMap", "dynamic", "test", nil)},
|
||||
},
|
||||
"invalid-apiVersion": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{LegacyObjectTypeIdentifier: v1alpha1.LegacyObjectTypeIdentifier{Kind: "ConfigMap", APIVersion: "a/b/v1"}},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic"},
|
||||
},
|
||||
appNs: "test",
|
||||
Error: "invalid APIVersion",
|
||||
},
|
||||
"invalid-type-identifier": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic"},
|
||||
},
|
||||
appNs: "test",
|
||||
Error: "neither resource or apiVersion/kind is set",
|
||||
},
|
||||
"name-and-selector-both-set": {
|
||||
Input: v1alpha1.ObjectReferrer{ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic", LabelSelector: map[string]string{"key": "value"}}},
|
||||
appNs: "test",
|
||||
Error: "invalid object selector for ref-objects, name and labelSelector cannot be both set",
|
||||
},
|
||||
"empty-ref-object-name": {
|
||||
Input: v1alpha1.ObjectReferrer{ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"}},
|
||||
compName: "dynamic",
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{createUnstructured("v1", "ConfigMap", "dynamic", "test", nil)},
|
||||
},
|
||||
"cannot-find-ref-object": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "static"},
|
||||
},
|
||||
appNs: "test",
|
||||
Error: "failed to load ref object",
|
||||
},
|
||||
"modify-service": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "service"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic"},
|
||||
},
|
||||
appNs: "test",
|
||||
IsService: true,
|
||||
},
|
||||
"by-labels": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{LabelSelector: map[string]string{"key": "value"}},
|
||||
},
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{
|
||||
createUnstructured("v1", "ConfigMap", "by-label-1", "test", map[string]interface{}{"key": "value"}),
|
||||
createUnstructured("v1", "ConfigMap", "by-label-2", "test", map[string]interface{}{"key": "value"}),
|
||||
},
|
||||
},
|
||||
"by-deprecated-labels": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{DeprecatedLabelSelector: map[string]string{"key": "value"}},
|
||||
},
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{
|
||||
createUnstructured("v1", "ConfigMap", "by-label-1", "test", map[string]interface{}{"key": "value"}),
|
||||
createUnstructured("v1", "ConfigMap", "by-label-2", "test", map[string]interface{}{"key": "value"}),
|
||||
},
|
||||
},
|
||||
"no-kind-for-resource": {
|
||||
Input: v1alpha1.ObjectReferrer{ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "unknown"}},
|
||||
appNs: "test",
|
||||
Error: "no matches",
|
||||
},
|
||||
"cross-namespace": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic", Namespace: "test"},
|
||||
},
|
||||
appNs: "demo",
|
||||
Output: []*unstructured.Unstructured{createUnstructured("v1", "ConfigMap", "dynamic", "test", nil)},
|
||||
},
|
||||
"cross-namespace-forbidden": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic", Namespace: "test"},
|
||||
},
|
||||
appNs: "demo",
|
||||
Scope: RefObjectsAvailableScopeNamespace,
|
||||
Error: "cannot refer to objects outside the application's namespace",
|
||||
},
|
||||
"cross-cluster": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic", Cluster: "demo"},
|
||||
},
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{createUnstructured("v1", "ConfigMap", "dynamic", "test", nil)},
|
||||
},
|
||||
"cross-cluster-forbidden": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic", Cluster: "demo"},
|
||||
},
|
||||
appNs: "test",
|
||||
Scope: RefObjectsAvailableScopeCluster,
|
||||
Error: "cannot refer to objects outside control plane",
|
||||
},
|
||||
"test-cluster-scope-resource": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "clusterrole"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "test-cluster-role"},
|
||||
},
|
||||
appNs: "test",
|
||||
Scope: RefObjectsAvailableScopeCluster,
|
||||
Output: []*unstructured.Unstructured{createUnstructured("rbac.authorization.k8s.io/v1", "ClusterRole", "test-cluster-role", "", nil)},
|
||||
IsClusterRole: true,
|
||||
},
|
||||
}
|
||||
for name, tt := range testcases {
|
||||
By("Test " + name)
|
||||
if tt.Scope == "" {
|
||||
tt.Scope = RefObjectsAvailableScopeGlobal
|
||||
}
|
||||
RefObjectsAvailableScope = tt.Scope
|
||||
output, err := SelectRefObjectsForDispatch(context.Background(), k8sClient, tt.appNs, tt.compName, tt.Input)
|
||||
if tt.Error != "" {
|
||||
Expect(err).ShouldNot(BeNil())
|
||||
Expect(err.Error()).Should(ContainSubstring(tt.Error))
|
||||
} else {
|
||||
Expect(err).Should(Succeed())
|
||||
if tt.IsService {
|
||||
Expect(output[0].Object["kind"]).Should(Equal("Service"))
|
||||
Expect(output[0].Object["spec"].(map[string]interface{})["clusterIP"]).Should(BeNil())
|
||||
} else {
|
||||
if tt.IsClusterRole {
|
||||
delete(output[0].Object, "rules")
|
||||
}
|
||||
Expect(output).Should(Equal(tt.Output))
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
It("Test AppendUnstructuredObjects", func() {
|
||||
testCases := map[string]struct {
|
||||
Inputs []*unstructured.Unstructured
|
||||
Input *unstructured.Unstructured
|
||||
Outputs []*unstructured.Unstructured
|
||||
}{
|
||||
"overlap": {
|
||||
Inputs: []*unstructured.Unstructured{{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "x", "namespace": "default"},
|
||||
"data": "a",
|
||||
}}, {Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "y", "namespace": "default"},
|
||||
"data": "b",
|
||||
}}},
|
||||
Input: &unstructured.Unstructured{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "y", "namespace": "default"},
|
||||
"data": "c",
|
||||
}},
|
||||
Outputs: []*unstructured.Unstructured{{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "x", "namespace": "default"},
|
||||
"data": "a",
|
||||
}}, {Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "y", "namespace": "default"},
|
||||
"data": "c",
|
||||
}}},
|
||||
},
|
||||
"append": {
|
||||
Inputs: []*unstructured.Unstructured{{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "x", "namespace": "default"},
|
||||
"data": "a",
|
||||
}}, {Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "y", "namespace": "default"},
|
||||
"data": "b",
|
||||
}}},
|
||||
Input: &unstructured.Unstructured{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "z", "namespace": "default"},
|
||||
"data": "c",
|
||||
}},
|
||||
Outputs: []*unstructured.Unstructured{{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "x", "namespace": "default"},
|
||||
"data": "a",
|
||||
}}, {Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "y", "namespace": "default"},
|
||||
"data": "b",
|
||||
}}, {Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "z", "namespace": "default"},
|
||||
"data": "c",
|
||||
}}},
|
||||
},
|
||||
}
|
||||
for name, tt := range testCases {
|
||||
By("Test " + name)
|
||||
Expect(AppendUnstructuredObjects(tt.Inputs, tt.Input)).Should(Equal(tt.Outputs))
|
||||
}
|
||||
})
|
||||
|
||||
})
|
||||
748
pkg/component/ref_objects_test.go
Normal file
748
pkg/component/ref_objects_test.go
Normal file
@@ -0,0 +1,748 @@
|
||||
/*
|
||||
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 component
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"reflect"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
rbacv1 "k8s.io/api/rbac/v1"
|
||||
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
|
||||
"k8s.io/apimachinery/pkg/runtime"
|
||||
"k8s.io/apimachinery/pkg/runtime/schema"
|
||||
utilfeature "k8s.io/apiserver/pkg/util/feature"
|
||||
featuregatetesting "k8s.io/component-base/featuregate/testing"
|
||||
"sigs.k8s.io/controller-runtime/pkg/client"
|
||||
|
||||
"github.com/oam-dev/kubevela/apis/core.oam.dev/common"
|
||||
"github.com/oam-dev/kubevela/apis/core.oam.dev/v1alpha1"
|
||||
"github.com/oam-dev/kubevela/pkg/features"
|
||||
)
|
||||
|
||||
func TestGetLabelSelectorFromRefObjectSelector(t *testing.T) {
|
||||
type args struct {
|
||||
selector v1alpha1.ObjectReferrer
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
args args
|
||||
featureOn bool
|
||||
want map[string]string
|
||||
}{
|
||||
{
|
||||
name: "label selector present",
|
||||
args: args{
|
||||
selector: v1alpha1.ObjectReferrer{
|
||||
ObjectSelector: v1alpha1.ObjectSelector{
|
||||
LabelSelector: map[string]string{"app": "my-app"},
|
||||
},
|
||||
},
|
||||
},
|
||||
want: map[string]string{"app": "my-app"},
|
||||
},
|
||||
{
|
||||
name: "deprecated label selector present and feature on",
|
||||
args: args{
|
||||
selector: v1alpha1.ObjectReferrer{
|
||||
ObjectSelector: v1alpha1.ObjectSelector{
|
||||
DeprecatedLabelSelector: map[string]string{"app": "my-app-deprecated"},
|
||||
},
|
||||
},
|
||||
},
|
||||
featureOn: true,
|
||||
want: map[string]string{"app": "my-app-deprecated"},
|
||||
},
|
||||
{
|
||||
name: "deprecated label selector present and feature off",
|
||||
args: args{
|
||||
selector: v1alpha1.ObjectReferrer{
|
||||
ObjectSelector: v1alpha1.ObjectSelector{
|
||||
DeprecatedLabelSelector: map[string]string{"app": "my-app-deprecated"},
|
||||
},
|
||||
},
|
||||
},
|
||||
featureOn: false,
|
||||
want: nil,
|
||||
},
|
||||
{
|
||||
name: "both present, label selector takes precedence",
|
||||
args: args{
|
||||
selector: v1alpha1.ObjectReferrer{
|
||||
ObjectSelector: v1alpha1.ObjectSelector{
|
||||
LabelSelector: map[string]string{"app": "my-app"},
|
||||
DeprecatedLabelSelector: map[string]string{"app": "my-app-deprecated"},
|
||||
},
|
||||
},
|
||||
},
|
||||
featureOn: true,
|
||||
want: map[string]string{"app": "my-app"},
|
||||
},
|
||||
{
|
||||
name: "no selector",
|
||||
args: args{
|
||||
selector: v1alpha1.ObjectReferrer{},
|
||||
},
|
||||
want: nil,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
featuregatetesting.SetFeatureGateDuringTest(t, utilfeature.DefaultFeatureGate, features.DeprecatedObjectLabelSelector, tt.featureOn)
|
||||
if got := GetLabelSelectorFromRefObjectSelector(tt.args.selector); !reflect.DeepEqual(got, tt.want) {
|
||||
t.Errorf("GetLabelSelectorFromRefObjectSelector() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateRefObjectSelector(t *testing.T) {
|
||||
type args struct {
|
||||
selector v1alpha1.ObjectReferrer
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
args args
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "name only",
|
||||
args: args{
|
||||
selector: v1alpha1.ObjectReferrer{
|
||||
ObjectSelector: v1alpha1.ObjectSelector{
|
||||
Name: "my-obj",
|
||||
},
|
||||
},
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "label selector only",
|
||||
args: args{
|
||||
selector: v1alpha1.ObjectReferrer{
|
||||
ObjectSelector: v1alpha1.ObjectSelector{
|
||||
LabelSelector: map[string]string{"app": "my-app"},
|
||||
},
|
||||
},
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "both name and label selector",
|
||||
args: args{
|
||||
selector: v1alpha1.ObjectReferrer{
|
||||
ObjectSelector: v1alpha1.ObjectSelector{
|
||||
Name: "my-obj",
|
||||
LabelSelector: map[string]string{"app": "my-app"},
|
||||
},
|
||||
},
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "empty selector",
|
||||
args: args{
|
||||
selector: v1alpha1.ObjectReferrer{},
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
if err := ValidateRefObjectSelector(tt.args.selector); (err != nil) != tt.wantErr {
|
||||
t.Errorf("ValidateRefObjectSelector() error = %v, wantErr %v", err, tt.wantErr)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestClearRefObjectForDispatch(t *testing.T) {
|
||||
un := &unstructured.Unstructured{
|
||||
Object: map[string]interface{}{
|
||||
"metadata": map[string]interface{}{
|
||||
"name": "test-obj",
|
||||
"namespace": "default",
|
||||
"resourceVersion": "12345",
|
||||
"generation": int64(1),
|
||||
"uid": "abc-def",
|
||||
"creationTimestamp": "2021-01-01T00:00:00Z",
|
||||
"managedFields": []interface{}{},
|
||||
"ownerReferences": []interface{}{},
|
||||
},
|
||||
"status": map[string]interface{}{
|
||||
"phase": "Available",
|
||||
},
|
||||
},
|
||||
}
|
||||
ClearRefObjectForDispatch(un)
|
||||
|
||||
if un.GetResourceVersion() != "" {
|
||||
t.Errorf("resourceVersion should be cleared")
|
||||
}
|
||||
if un.GetGeneration() != 0 {
|
||||
t.Errorf("generation should be cleared")
|
||||
}
|
||||
if len(un.GetOwnerReferences()) != 0 {
|
||||
t.Errorf("ownerReferences should be cleared")
|
||||
}
|
||||
if un.GetDeletionTimestamp() != nil {
|
||||
t.Errorf("deletionTimestamp should be nil")
|
||||
}
|
||||
if len(un.GetManagedFields()) != 0 {
|
||||
t.Errorf("managedFields should be cleared")
|
||||
}
|
||||
if un.GetUID() != "" {
|
||||
t.Errorf("uid should be cleared")
|
||||
}
|
||||
if _, found, _ := unstructured.NestedFieldNoCopy(un.Object, "metadata", "creationTimestamp"); found {
|
||||
t.Errorf("creationTimestamp should be removed")
|
||||
}
|
||||
if _, found, _ := unstructured.NestedFieldNoCopy(un.Object, "status"); found {
|
||||
t.Errorf("status should be removed")
|
||||
}
|
||||
|
||||
// Test for service
|
||||
svc := &unstructured.Unstructured{
|
||||
Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "Service",
|
||||
"metadata": map[string]interface{}{
|
||||
"name": "test-svc",
|
||||
},
|
||||
"spec": map[string]interface{}{
|
||||
"clusterIP": "1.2.3.4",
|
||||
"clusterIPs": []interface{}{"1.2.3.4"},
|
||||
},
|
||||
},
|
||||
}
|
||||
ClearRefObjectForDispatch(svc)
|
||||
if _, found, _ := unstructured.NestedString(svc.Object, "spec", "clusterIP"); found {
|
||||
t.Errorf("service clusterIP should be removed")
|
||||
}
|
||||
if _, found, _ := unstructured.NestedStringSlice(svc.Object, "spec", "clusterIPs"); found {
|
||||
t.Errorf("service clusterIPs should be removed")
|
||||
}
|
||||
|
||||
// Test for service with ClusterIPNone
|
||||
svcNone := &unstructured.Unstructured{
|
||||
Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "Service",
|
||||
"metadata": map[string]interface{}{
|
||||
"name": "test-svc-none",
|
||||
},
|
||||
"spec": map[string]interface{}{
|
||||
"clusterIP": corev1.ClusterIPNone,
|
||||
},
|
||||
},
|
||||
}
|
||||
ClearRefObjectForDispatch(svcNone)
|
||||
if ip, found, _ := unstructured.NestedString(svcNone.Object, "spec", "clusterIP"); !found || ip != corev1.ClusterIPNone {
|
||||
t.Errorf("service with clusterIP None should not be removed")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSelectRefObjectsForDispatch(t *testing.T) {
|
||||
featuregatetesting.SetFeatureGateDuringTest(t, utilfeature.DefaultFeatureGate, features.LegacyObjectTypeIdentifier, true)
|
||||
featuregatetesting.SetFeatureGateDuringTest(t, utilfeature.DefaultFeatureGate, features.DeprecatedObjectLabelSelector, true)
|
||||
t.Log("Create objects")
|
||||
if err := k8sClient.Create(context.Background(), &corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: "test"}}); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
for _, obj := range []client.Object{&corev1.ConfigMap{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "dynamic",
|
||||
Namespace: "test",
|
||||
},
|
||||
}, &corev1.Service{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "dynamic",
|
||||
Namespace: "test",
|
||||
Generation: int64(5),
|
||||
},
|
||||
Spec: corev1.ServiceSpec{
|
||||
ClusterIP: "10.0.0.254",
|
||||
Ports: []corev1.ServicePort{{Port: 80}},
|
||||
},
|
||||
}, &corev1.ConfigMap{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "by-label-1",
|
||||
Namespace: "test",
|
||||
Labels: map[string]string{"key": "value"},
|
||||
},
|
||||
}, &corev1.ConfigMap{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "by-label-2",
|
||||
Namespace: "test",
|
||||
Labels: map[string]string{"key": "value"},
|
||||
},
|
||||
}, &rbacv1.ClusterRole{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "test-cluster-role",
|
||||
},
|
||||
}} {
|
||||
if err := k8sClient.Create(context.Background(), obj); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
createUnstructured := func(apiVersion string, kind string, name string, namespace string, labels map[string]interface{}) *unstructured.Unstructured {
|
||||
un := &unstructured.Unstructured{
|
||||
Object: map[string]interface{}{"apiVersion": apiVersion,
|
||||
"kind": kind,
|
||||
"metadata": map[string]interface{}{"name": name},
|
||||
},
|
||||
}
|
||||
if namespace != "" {
|
||||
un.SetNamespace(namespace)
|
||||
}
|
||||
if labels != nil {
|
||||
un.Object["metadata"].(map[string]interface{})["labels"] = labels
|
||||
}
|
||||
return un
|
||||
}
|
||||
testcases := map[string]struct {
|
||||
Input v1alpha1.ObjectReferrer
|
||||
compName string
|
||||
appNs string
|
||||
Output []*unstructured.Unstructured
|
||||
Error string
|
||||
Scope string
|
||||
IsService bool
|
||||
IsClusterRole bool
|
||||
}{
|
||||
"normal": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic"},
|
||||
},
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{createUnstructured("v1", "ConfigMap", "dynamic", "test", nil)},
|
||||
},
|
||||
"legacy-type-identifier": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{LegacyObjectTypeIdentifier: v1alpha1.LegacyObjectTypeIdentifier{Kind: "ConfigMap", APIVersion: "v1"}},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic"},
|
||||
},
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{createUnstructured("v1", "ConfigMap", "dynamic", "test", nil)},
|
||||
},
|
||||
"invalid-apiVersion": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{LegacyObjectTypeIdentifier: v1alpha1.LegacyObjectTypeIdentifier{Kind: "ConfigMap", APIVersion: "a/b/v1"}},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic"},
|
||||
},
|
||||
appNs: "test",
|
||||
Error: "invalid APIVersion",
|
||||
},
|
||||
"invalid-type-identifier": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic"},
|
||||
},
|
||||
appNs: "test",
|
||||
Error: "neither resource or apiVersion/kind is set",
|
||||
},
|
||||
"name-and-selector-both-set": {
|
||||
Input: v1alpha1.ObjectReferrer{ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic", LabelSelector: map[string]string{"key": "value"}}},
|
||||
appNs: "test",
|
||||
Error: "invalid object selector for ref-objects, name and labelSelector cannot be both set",
|
||||
},
|
||||
"empty-ref-object-name": {
|
||||
Input: v1alpha1.ObjectReferrer{ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"}},
|
||||
compName: "dynamic",
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{createUnstructured("v1", "ConfigMap", "dynamic", "test", nil)},
|
||||
},
|
||||
"cannot-find-ref-object": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "static"},
|
||||
},
|
||||
appNs: "test",
|
||||
Error: "failed to load ref object",
|
||||
},
|
||||
"modify-service": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "service"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic"},
|
||||
},
|
||||
appNs: "test",
|
||||
IsService: true,
|
||||
},
|
||||
"by-labels": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{LabelSelector: map[string]string{"key": "value"}},
|
||||
},
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{
|
||||
createUnstructured("v1", "ConfigMap", "by-label-1", "test", map[string]interface{}{"key": "value"}),
|
||||
createUnstructured("v1", "ConfigMap", "by-label-2", "test", map[string]interface{}{"key": "value"}),
|
||||
},
|
||||
},
|
||||
"by-deprecated-labels": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{DeprecatedLabelSelector: map[string]string{"key": "value"}},
|
||||
},
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{
|
||||
createUnstructured("v1", "ConfigMap", "by-label-1", "test", map[string]interface{}{"key": "value"}),
|
||||
createUnstructured("v1", "ConfigMap", "by-label-2", "test", map[string]interface{}{"key": "value"}),
|
||||
},
|
||||
},
|
||||
"no-kind-for-resource": {
|
||||
Input: v1alpha1.ObjectReferrer{ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "unknown"}},
|
||||
appNs: "test",
|
||||
Error: "no matches",
|
||||
},
|
||||
"cross-namespace": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic", Namespace: "test"},
|
||||
},
|
||||
appNs: "demo",
|
||||
Output: []*unstructured.Unstructured{createUnstructured("v1", "ConfigMap", "dynamic", "test", nil)},
|
||||
},
|
||||
"cross-namespace-forbidden": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic", Namespace: "test"},
|
||||
},
|
||||
appNs: "demo",
|
||||
Scope: RefObjectsAvailableScopeNamespace,
|
||||
Error: "cannot refer to objects outside the application's namespace",
|
||||
},
|
||||
"cross-cluster": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic", Cluster: "demo"},
|
||||
},
|
||||
appNs: "test",
|
||||
Output: []*unstructured.Unstructured{createUnstructured("v1", "ConfigMap", "dynamic", "test", nil)},
|
||||
},
|
||||
"cross-cluster-forbidden": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "configmap"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "dynamic", Cluster: "demo"},
|
||||
},
|
||||
appNs: "test",
|
||||
Scope: RefObjectsAvailableScopeCluster,
|
||||
Error: "cannot refer to objects outside control plane",
|
||||
},
|
||||
"test-cluster-scope-resource": {
|
||||
Input: v1alpha1.ObjectReferrer{
|
||||
ObjectTypeIdentifier: v1alpha1.ObjectTypeIdentifier{Resource: "clusterrole"},
|
||||
ObjectSelector: v1alpha1.ObjectSelector{Name: "test-cluster-role"},
|
||||
},
|
||||
appNs: "test",
|
||||
Scope: RefObjectsAvailableScopeCluster,
|
||||
Output: []*unstructured.Unstructured{createUnstructured("rbac.authorization.k8s.io/v1", "ClusterRole", "test-cluster-role", "", nil)},
|
||||
IsClusterRole: true,
|
||||
},
|
||||
}
|
||||
for name, tt := range testcases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
if tt.Scope == "" {
|
||||
tt.Scope = RefObjectsAvailableScopeGlobal
|
||||
}
|
||||
RefObjectsAvailableScope = tt.Scope
|
||||
output, err := SelectRefObjectsForDispatch(context.Background(), k8sClient, tt.appNs, tt.compName, tt.Input)
|
||||
if tt.Error != "" {
|
||||
if err == nil {
|
||||
t.Fatalf("expected error, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), tt.Error) {
|
||||
t.Fatalf("expected error message to contain %q, got %q", tt.Error, err.Error())
|
||||
}
|
||||
} else {
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if tt.IsService {
|
||||
if output[0].Object["kind"] != "Service" {
|
||||
t.Fatalf(`expected kind to be "Service", got %q`, output[0].Object["kind"])
|
||||
}
|
||||
if output[0].Object["spec"].(map[string]interface{})["clusterIP"] != nil {
|
||||
t.Fatalf(`expected clusterIP to be nil, got %v`, output[0].Object["spec"].(map[string]interface{})["clusterIP"])
|
||||
}
|
||||
} else {
|
||||
if tt.IsClusterRole {
|
||||
delete(output[0].Object, "rules")
|
||||
}
|
||||
if !reflect.DeepEqual(output, tt.Output) {
|
||||
t.Fatalf("expected output to be %v, got %v", tt.Output, output)
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestReferredObjectsDelegatingClient(t *testing.T) {
|
||||
objs := []*unstructured.Unstructured{
|
||||
{
|
||||
Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{
|
||||
"name": "cm-1",
|
||||
"namespace": "ns-1",
|
||||
"labels": map[string]interface{}{"app": "app-1"},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{
|
||||
"name": "cm-2",
|
||||
"namespace": "ns-1",
|
||||
"labels": map[string]interface{}{"app": "app-2"},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "Secret",
|
||||
"metadata": map[string]interface{}{
|
||||
"name": "secret-1",
|
||||
"namespace": "ns-1",
|
||||
"labels": map[string]interface{}{"app": "app-1"},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
delegatingClient := ReferredObjectsDelegatingClient(k8sClient, objs)
|
||||
|
||||
t.Run("Get", func(t *testing.T) {
|
||||
t.Run("should get existing object", func(t *testing.T) {
|
||||
obj := &unstructured.Unstructured{}
|
||||
obj.SetGroupVersionKind(schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ConfigMap"})
|
||||
err := delegatingClient.Get(context.Background(), client.ObjectKey{Name: "cm-1", Namespace: "ns-1"}, obj)
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if obj.GetName() != "cm-1" {
|
||||
t.Errorf("expected object name cm-1, got %s", obj.GetName())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("should return not found for non-existing object", func(t *testing.T) {
|
||||
obj := &unstructured.Unstructured{}
|
||||
obj.SetGroupVersionKind(schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ConfigMap"})
|
||||
err := delegatingClient.Get(context.Background(), client.ObjectKey{Name: "cm-non-existent", Namespace: "ns-1"}, obj)
|
||||
if !apierrors.IsNotFound(err) {
|
||||
t.Errorf("expected not found error, got %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("should return not found for different kind", func(t *testing.T) {
|
||||
obj := &unstructured.Unstructured{}
|
||||
obj.SetGroupVersionKind(schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Pod"})
|
||||
err := delegatingClient.Get(context.Background(), client.ObjectKey{Name: "cm-1", Namespace: "ns-1"}, obj)
|
||||
if !apierrors.IsNotFound(err) {
|
||||
t.Errorf("expected not found error, got %v", err)
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("List", func(t *testing.T) {
|
||||
t.Run("should list all objects of a kind", func(t *testing.T) {
|
||||
list := &unstructured.UnstructuredList{}
|
||||
list.SetGroupVersionKind(schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ConfigMapList"})
|
||||
err := delegatingClient.List(context.Background(), list)
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if len(list.Items) != 2 {
|
||||
t.Errorf("expected 2 items, got %d", len(list.Items))
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("should list with namespace", func(t *testing.T) {
|
||||
list := &unstructured.UnstructuredList{}
|
||||
list.SetGroupVersionKind(schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ConfigMapList"})
|
||||
err := delegatingClient.List(context.Background(), list, client.InNamespace("ns-1"))
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if len(list.Items) != 2 {
|
||||
t.Errorf("expected 2 items, got %d", len(list.Items))
|
||||
}
|
||||
|
||||
list.Items = []unstructured.Unstructured{}
|
||||
err = delegatingClient.List(context.Background(), list, client.InNamespace("ns-2"))
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if len(list.Items) != 0 {
|
||||
t.Errorf("expected 0 items, got %d", len(list.Items))
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("should list with label selector", func(t *testing.T) {
|
||||
list := &unstructured.UnstructuredList{}
|
||||
list.SetGroupVersionKind(schema.GroupVersionKind{Group: "", Version: "v1", Kind: "ConfigMapList"})
|
||||
err := delegatingClient.List(context.Background(), list, client.MatchingLabels{"app": "app-1"})
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if len(list.Items) != 1 {
|
||||
t.Errorf("expected 1 item, got %d", len(list.Items))
|
||||
}
|
||||
if list.Items[0].GetName() != "cm-1" {
|
||||
t.Errorf("expected cm-1, got %s", list.Items[0].GetName())
|
||||
}
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
func TestAppendUnstructuredObjects(t *testing.T) {
|
||||
testCases := map[string]struct {
|
||||
Inputs []*unstructured.Unstructured
|
||||
Input *unstructured.Unstructured
|
||||
Outputs []*unstructured.Unstructured
|
||||
}{
|
||||
"overlap": {
|
||||
Inputs: []*unstructured.Unstructured{{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "x", "namespace": "default"},
|
||||
"data": "a",
|
||||
}}, {Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "y", "namespace": "default"},
|
||||
"data": "b",
|
||||
}}},
|
||||
Input: &unstructured.Unstructured{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "y", "namespace": "default"},
|
||||
"data": "c",
|
||||
}},
|
||||
Outputs: []*unstructured.Unstructured{{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "x", "namespace": "default"},
|
||||
"data": "a",
|
||||
}}, {Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "y", "namespace": "default"},
|
||||
"data": "c",
|
||||
}}},
|
||||
},
|
||||
"append": {
|
||||
Inputs: []*unstructured.Unstructured{{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "x", "namespace": "default"},
|
||||
"data": "a",
|
||||
}}, {Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "y", "namespace": "default"},
|
||||
"data": "b",
|
||||
}}},
|
||||
Input: &unstructured.Unstructured{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "z", "namespace": "default"},
|
||||
"data": "c",
|
||||
}},
|
||||
Outputs: []*unstructured.Unstructured{{Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "x", "namespace": "default"},
|
||||
"data": "a",
|
||||
}}, {Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "y", "namespace": "default"},
|
||||
"data": "b",
|
||||
}}, {Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{"name": "z", "namespace": "default"},
|
||||
"data": "c",
|
||||
}}},
|
||||
},
|
||||
}
|
||||
for name, tt := range testCases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
got := AppendUnstructuredObjects(tt.Inputs, tt.Input)
|
||||
if !reflect.DeepEqual(got, tt.Outputs) {
|
||||
t.Fatalf("expected output to be %v, got %v", tt.Outputs, got)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestConvertUnstructuredsToReferredObjects(t *testing.T) {
|
||||
uns := []*unstructured.Unstructured{
|
||||
{
|
||||
Object: map[string]interface{}{
|
||||
"apiVersion": "v1",
|
||||
"kind": "ConfigMap",
|
||||
"metadata": map[string]interface{}{
|
||||
"name": "cm-1",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Object: map[string]interface{}{
|
||||
"apiVersion": "apps/v1",
|
||||
"kind": "Deployment",
|
||||
"metadata": map[string]interface{}{
|
||||
"name": "deploy-1",
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
refObjs, err := ConvertUnstructuredsToReferredObjects(uns)
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
if len(refObjs) != 2 {
|
||||
t.Fatalf("expected 2 referred objects, got %d", len(refObjs))
|
||||
}
|
||||
|
||||
for i, un := range uns {
|
||||
raw, err := json.Marshal(un)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to marshal unstructured: %v", err)
|
||||
}
|
||||
expected := common.ReferredObject{
|
||||
RawExtension: runtime.RawExtension{Raw: raw},
|
||||
}
|
||||
if !reflect.DeepEqual(refObjs[i], expected) {
|
||||
t.Errorf("expected refObj %v, got %v", expected, refObjs[i])
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user