Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 'errors' file handling to test harness #867

Merged
merged 2 commits into from
Sep 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 88 additions & 21 deletions pkg/test/step.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
k8serrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/discovery"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand Down Expand Up @@ -194,6 +195,22 @@ func (s *Step) GetTimeout() int {
return timeout
}

func list(cl client.Client, gvk schema.GroupVersionKind, namespace string) ([]unstructured.Unstructured, error) {
list := unstructured.UnstructuredList{}
list.SetGroupVersionKind(gvk)

listOptions := []client.ListOption{}
if namespace != "" {
listOptions = append(listOptions, client.InNamespace(namespace))
}

if err := cl.List(context.TODO(), &list, listOptions...); err != nil {
return []unstructured.Unstructured{}, err
}

return list.Items, nil
}

// CheckResource checks if the expected resource's state in Kubernetes is correct.
func (s *Step) CheckResource(expected runtime.Object, namespace string) []error {
cl, err := s.Client(false)
Expand All @@ -215,35 +232,21 @@ func (s *Step) CheckResource(expected runtime.Object, namespace string) []error

gvk := expected.GetObjectKind().GroupVersionKind()

actuals := []*unstructured.Unstructured{}
actuals := []unstructured.Unstructured{}

if name != "" {
actual := &unstructured.Unstructured{}
actual := unstructured.Unstructured{}
actual.SetGroupVersionKind(gvk)

err = cl.Get(context.TODO(), client.ObjectKey{
Namespace: namespace,
Name: name,
}, actual)
}, &actual)

actuals = append(actuals, actual)
} else {
actual := &unstructured.UnstructuredList{}
actual.SetGroupVersionKind(gvk)

listOptions := []client.ListOption{}

if namespace != "" {
listOptions = append(listOptions, client.InNamespace(namespace))
}

err = cl.List(context.TODO(), actual, listOptions...)

for index := range actual.Items {
actuals = append(actuals, &actual.Items[index])
}

if len(actual.Items) == 0 {
actuals, err = list(cl, gvk, namespace)
if len(actuals) == 0 {
testErrors = append(testErrors, fmt.Errorf("no resources matched of kind: %s", gvk.String()))
}
}
Expand All @@ -260,7 +263,7 @@ func (s *Step) CheckResource(expected runtime.Object, namespace string) []error
tmpTestErrors := []error{}

if err := testutils.IsSubset(expectedObj, actual.UnstructuredContent()); err != nil {
diff, diffErr := testutils.PrettyDiff(expected, actual)
diff, diffErr := testutils.PrettyDiff(expected, &actual)
if diffErr == nil {
tmpTestErrors = append(tmpTestErrors, errors.New(diff))
} else {
Expand All @@ -280,14 +283,78 @@ func (s *Step) CheckResource(expected runtime.Object, namespace string) []error
return testErrors
}

// Check checks if the resources defined in Asserts are in the correct state.
// CheckResourceAbsent checks if the expected resource's state is absent in Kubernetes.
func (s *Step) CheckResourceAbsent(expected runtime.Object, namespace string) error {
cl, err := s.Client(false)
if err != nil {
return err
}

dClient, err := s.DiscoveryClient()
if err != nil {
return err
}

name, namespace, err := testutils.Namespaced(dClient, expected, namespace)
if err != nil {
return err
}

gvk := expected.GetObjectKind().GroupVersionKind()

var actuals []unstructured.Unstructured

if name != "" {
actual := unstructured.Unstructured{}
actual.SetGroupVersionKind(gvk)

if err := cl.Get(context.TODO(), client.ObjectKey{
Namespace: namespace,
Name: name,
}, &actual); err != nil {
if k8serrors.IsNotFound(err) {
return nil
}

return err
}

actuals = []unstructured.Unstructured{actual}
} else {
actuals, err = list(cl, gvk, namespace)
if err != nil {
return err
}
}

expectedObj, err := runtime.DefaultUnstructuredConverter.ToUnstructured(expected)
if err != nil {
return err
}

for _, actual := range actuals {
if err := testutils.IsSubset(expectedObj, actual.UnstructuredContent()); err == nil {
return fmt.Errorf("resource matched of kind: %s", gvk.String())
}
}

return nil
}

// Check checks if the resources defined in Asserts and Errors are in the correct state.
func (s *Step) Check(namespace string) []error {
testErrors := []error{}

for _, expected := range s.Asserts {
testErrors = append(testErrors, s.CheckResource(expected, namespace)...)
}

for _, expected := range s.Errors {
if testError := s.CheckResourceAbsent(expected, namespace); testError != nil {
testErrors = append(testErrors, testError)
}
}

return testErrors
}

Expand Down
48 changes: 48 additions & 0 deletions pkg/test/step_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,54 @@ func TestCheckResource(t *testing.T) {
}
}

func TestCheckResourceAbsent(t *testing.T) {
for _, test := range []struct {
name string
actual runtime.Object
expected runtime.Object
shouldError bool
}{
{
name: "resource matches",
actual: testutils.NewPod("hello", ""),
expected: testutils.NewPod("hello", ""),
shouldError: true,
},
{
name: "resource mis-match",
actual: testutils.NewPod("hello", ""),
expected: testutils.WithSpec(testutils.NewPod("hello", ""), map[string]interface{}{"invalid": "key"}),
},
{
name: "resource does not exist",
actual: testutils.NewPod("other", ""),
expected: testutils.NewPod("hello", ""),
},
} {
t.Run(test.name, func(t *testing.T) {
fakeDiscovery := testutils.FakeDiscoveryClient()
namespace := "world"

_, _, err := testutils.Namespaced(fakeDiscovery, test.actual, namespace)
assert.Nil(t, err)

step := Step{
Logger: testutils.NewTestLogger(t, ""),
Client: func(bool) (client.Client, error) { return fake.NewFakeClient(test.actual), nil },
DiscoveryClient: func() (discovery.DiscoveryInterface, error) { return fakeDiscovery, nil },
}

error := step.CheckResourceAbsent(test.expected, namespace)

if test.shouldError {
assert.NotNil(t, error)
} else {
assert.Nil(t, error)
}
})
}
}

func TestRun(t *testing.T) {
for _, test := range []struct {
testName string
Expand Down
7 changes: 7 additions & 0 deletions test/integration/first-operator-test/01-errors.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
apiVersion: kudo.dev/v1alpha1
kind: Instance
metadata:
name: first-operator
spec:
parameters:
replicas: "2"