function-sdk-go/response/result_test.go

/*
Copyright 2023 The Crossplane 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 response_test

import (
	"errors"
	"testing"

	"github.com/google/go-cmp/cmp"
	"google.golang.org/protobuf/testing/protocmp"
	"k8s.io/utils/ptr"

	v1 "github.com/crossplane/function-sdk-go/proto/v1"
	"github.com/crossplane/function-sdk-go/response"
)

func TestResult(t *testing.T) {
	type testFn func(*v1.RunFunctionResponse)
	type args struct {
		fns []testFn
	}
	type want struct {
		results []*v1.Result
	}
	cases := map[string]struct {
		reason string
		args   args
		want   want
	}{
		"CreateBasicRecords": {
			reason: "Correctly adds results to the response.",
			args: args{
				fns: []testFn{
					func(rsp *v1.RunFunctionResponse) {
						response.Normal(rsp, "this is a test normal result")
					},
					func(rsp *v1.RunFunctionResponse) {
						response.Normalf(rsp, "this is a test normal %s result", "formatted")
					},
					func(rsp *v1.RunFunctionResponse) {
						response.Warning(rsp, errors.New("this is a test warning result"))
					},
					func(rsp *v1.RunFunctionResponse) {
						response.Fatal(rsp, errors.New("this is a test fatal result"))
					},
				},
			},
			want: want{
				results: []*v1.Result{
					{
						Severity: v1.Severity_SEVERITY_NORMAL,
						Message:  "this is a test normal result",
						Target:   v1.Target_TARGET_COMPOSITE.Enum(),
					},
					{
						Severity: v1.Severity_SEVERITY_NORMAL,
						Message:  "this is a test normal formatted result",
						Target:   v1.Target_TARGET_COMPOSITE.Enum(),
					},
					{
						Severity: v1.Severity_SEVERITY_WARNING,
						Message:  "this is a test warning result",
						Target:   v1.Target_TARGET_COMPOSITE.Enum(),
					},
					{
						Severity: v1.Severity_SEVERITY_FATAL,
						Message:  "this is a test fatal result",
						Target:   v1.Target_TARGET_COMPOSITE.Enum(),
					},
				},
			},
		},
		"SetTargets": {
			reason: "Correctly sets targets on result and adds it to the response.",
			args: args{
				fns: []testFn{
					func(rsp *v1.RunFunctionResponse) {
						response.Warning(rsp, errors.New("this is a test warning result targeting the composite")).TargetComposite()
					},
					func(rsp *v1.RunFunctionResponse) {
						response.Warning(rsp, errors.New("this is a test fatal result targeting both")).TargetCompositeAndClaim()
					},
				},
			},
			want: want{
				results: []*v1.Result{
					{
						Severity: v1.Severity_SEVERITY_WARNING,
						Message:  "this is a test warning result targeting the composite",
						Target:   v1.Target_TARGET_COMPOSITE.Enum(),
					},
					{
						Severity: v1.Severity_SEVERITY_WARNING,
						Message:  "this is a test fatal result targeting both",
						Target:   v1.Target_TARGET_COMPOSITE_AND_CLAIM.Enum(),
					},
				},
			},
		},
		"SetReason": {
			reason: "Correctly sets reason on result and adds it to the response.",
			args: args{
				fns: []testFn{
					func(rsp *v1.RunFunctionResponse) {
						response.Normal(rsp, "this is a test normal result targeting the composite").WithReason("TestReason")
					},
					func(rsp *v1.RunFunctionResponse) {
						response.Warning(rsp, errors.New("this is a test warning result targeting the composite")).WithReason("TestReason")
					},
				},
			},
			want: want{
				results: []*v1.Result{
					{
						Severity: v1.Severity_SEVERITY_NORMAL,
						Message:  "this is a test normal result targeting the composite",
						Target:   v1.Target_TARGET_COMPOSITE.Enum(),
						Reason:   ptr.To("TestReason"),
					},
					{
						Severity: v1.Severity_SEVERITY_WARNING,
						Message:  "this is a test warning result targeting the composite",
						Target:   v1.Target_TARGET_COMPOSITE.Enum(),
						Reason:   ptr.To("TestReason"),
					},
				},
			},
		},
		"ChainOptions": {
			reason: "Can chain result options together.",
			args: args{
				fns: []testFn{
					func(rsp *v1.RunFunctionResponse) {
						response.Normal(rsp, "this is a test normal result targeting the composite and claim").
							WithReason("TestReason").
							TargetCompositeAndClaim()
					},
					func(rsp *v1.RunFunctionResponse) {
						response.Warning(rsp, errors.New("this is a test warning result targeting the composite and claim")).
							TargetCompositeAndClaim().
							WithReason("TestReason")
					},
				},
			},
			want: want{
				results: []*v1.Result{
					{
						Severity: v1.Severity_SEVERITY_NORMAL,
						Message:  "this is a test normal result targeting the composite and claim",
						Target:   v1.Target_TARGET_COMPOSITE_AND_CLAIM.Enum(),
						Reason:   ptr.To("TestReason"),
					},
					{
						Severity: v1.Severity_SEVERITY_WARNING,
						Message:  "this is a test warning result targeting the composite and claim",
						Target:   v1.Target_TARGET_COMPOSITE_AND_CLAIM.Enum(),
						Reason:   ptr.To("TestReason"),
					},
				},
			},
		},
	}
	for name, tc := range cases {
		t.Run(name, func(t *testing.T) {
			rsp := &v1.RunFunctionResponse{}
			for _, f := range tc.args.fns {
				f(rsp)
			}

			if diff := cmp.Diff(tc.want.results, rsp.GetResults(), protocmp.Transform()); diff != "" {
				t.Errorf("\n%s\nFrom(...): -want, +got:\n%s", tc.reason, diff)
			}

		})
	}
}