github.com/kubevela/workflow@v0.6.0/pkg/utils/test_utils_test.go

/*
Copyright 2021 The KubeVela Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package utils

import (
	"fmt"
	"testing"

	"github.com/stretchr/testify/require"
	"k8s.io/apimachinery/pkg/api/errors"
	"k8s.io/apimachinery/pkg/runtime/schema"
)

func TestAlreadyExistMatcher(t *testing.T) {
	type want struct {
		success bool
		err     error
	}

	cases := map[string]struct {
		input interface{}
		want  want
	}{
		"Matches": {
			input: errors.NewAlreadyExists(schema.GroupResource{
				Group:    "g",
				Resource: "r",
			}, "name"),
			want: want{
				success: true,
				err:     nil,
			},
		},
		"Does not match": {
			input: errors.NewNotFound(schema.GroupResource{
				Group:    "g",
				Resource: "r",
			}, "name"),
			want: want{
				success: false,
				err:     nil,
			},
		},
		"Does not match nil": {
			input: nil,
			want: want{
				success: false,
				err:     nil,
			},
		},
	}
	matcher := AlreadyExistMatcher{}
	for name, tc := range cases {
		r := require.New(t)
		success, err := matcher.Match(tc.input)
		t.Log(fmt.Sprint("Running test: ", name))
		r.Equal(tc.want.success, success)
		if tc.want.err == nil {
			r.NoError(err)
		} else {
			r.Error(tc.want.err, err)
		}
	}

	// Error messages
	r := require.New(t)
	r.Equal("Expected\n    <string>: myerror\nto be already exist", matcher.FailureMessage("myerror"))
	r.Equal("Expected\n    <string>: myerror\nnot to be already exist", matcher.NegatedFailureMessage("myerror"))
}

func TestNotFoundMatcher(t *testing.T) {
	type want struct {
		success bool
		err     error
	}

	cases := map[string]struct {
		input interface{}
		want  want
	}{
		"Does not matche": {
			input: errors.NewAlreadyExists(schema.GroupResource{
				Group:    "g",
				Resource: "r",
			}, "name"),
			want: want{
				success: false,
				err:     nil,
			},
		},
		"Matches": {
			input: errors.NewNotFound(schema.GroupResource{
				Group:    "g",
				Resource: "r",
			}, "name"),
			want: want{
				success: true,
				err:     nil,
			},
		},
		"Does not match nil": {
			input: nil,
			want: want{
				success: false,
				err:     nil,
			},
		},
	}

	matcher := NotFoundMatcher{}
	for name, tc := range cases {
		r := require.New(t)
		success, err := matcher.Match(tc.input)
		t.Log(fmt.Sprint("Running test: ", name))
		r.Equal(tc.want.success, success)
		if tc.want.err == nil {
			r.NoError(err)
		} else {
			r.Equal(tc.want.err, err)
		}
	}

	// Error messages
	r := require.New(t)
	r.Equal("Expected\n    <string>: myerror\nto be not found", matcher.FailureMessage("myerror"))
	r.Equal("Expected\n    <string>: myerror\nnot to be not found", matcher.NegatedFailureMessage("myerror"))
}

func TestErrorMatcher(t *testing.T) {
	type input struct {
		expected error
		input    error
	}

	type want struct {
		success               bool
		err                   error
		failureMessage        string
		negatedFailureMessage string
	}

	cases := map[string]struct {
		input input
		want  want
	}{
		"Matches": {
			input: input{
				expected: fmt.Errorf("my error"),
				input:    fmt.Errorf("my error"),
			},
			want: want{
				success:               true,
				err:                   nil,
				failureMessage:        "Expected\n    <string>: my error\nto equal\n    <string>: my error",
				negatedFailureMessage: "Expected\n    <string>: my error\nnot to equal\n    <string>: my error",
			},
		},
		"Matches nil": {
			input: input{
				expected: nil,
				input:    nil,
			},
			want: want{
				success:               true,
				err:                   nil,
				failureMessage:        "Expected\n    <nil>: nil\nto equal\n    <nil>: nil",
				negatedFailureMessage: "Expected\n    <nil>: nil\nnot to equal\n    <nil>: nil",
			},
		},
		"Does not match": {
			input: input{
				expected: fmt.Errorf("my error"),
				input:    fmt.Errorf("my other error"),
			},
			want: want{
				success:               false,
				err:                   nil,
				failureMessage:        "Expected\n    <string>: my other error\nto equal\n    <string>: my error",
				negatedFailureMessage: "Expected\n    <string>: my other error\nnot to equal\n    <string>: my error",
			},
		},
		"Does not match nil": {
			input: input{
				expected: fmt.Errorf("my error"),
				input:    nil,
			},
			want: want{
				success:               false,
				err:                   nil,
				failureMessage:        "Expected\n    <nil>: nil\nto equal\n    <string>: my error",
				negatedFailureMessage: "Expected\n    <nil>: nil\nnot to equal\n    <string>: my error",
			},
		},
	}
	for name, tc := range cases {
		r := require.New(t)
		matcher := ErrorMatcher{
			ExpectedError: tc.input.expected,
		}
		success, err := matcher.Match(tc.input.input)
		t.Log(fmt.Sprint("Running test: ", name))
		r.Equal(tc.want.success, success)
		if tc.want.err == nil {
			r.NoError(err)
		} else {
			r.Equal(tc.want.err, err)
		}

		r.Equal(tc.want.failureMessage, matcher.FailureMessage(tc.input.input))
		r.Equal(tc.want.negatedFailureMessage, matcher.NegatedFailureMessage(tc.input.input))
	}
}