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.

Sign up for GitHub

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

documenting clientset unit tests #17

Merged
merged 2 commits into from
Aug 4, 2022
Merged

documenting clientset unit tests #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22183e5
dummy1
hellt Aug 3, 2022
db8c3f8
added comments and use cmp.Diff
hellt Aug 4, 2022
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
63 changes: 38 additions & 25 deletions api/clientset/v1alpha1/srlinux_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ import (
"fmt"
"io"
"net/http"
"reflect"
"testing"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/h-fam/errdiff"
"github.com/kr/pretty"
srlinuxv1 "github.com/srl-labs/srl-controller/api/types/v1alpha1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
Expand Down Expand Up @@ -63,8 +63,14 @@ var (
Version: "2",
},
}

// ignoreTypeMetaOpt is cmpopt option that is used to discard TypeMeta field
// when comparing Srlinux structs. This is required since fakeRest server will never populate
// those fields, and those fields may be present in the test's want object.
ignoreTypeMetaOpt = cmpopts.IgnoreFields(srlinuxv1.Srlinux{}, "TypeMeta")
)

// setUp creates a Srlinux clientset and patches its rest and dynamic clients.
func setUp(t *testing.T) (*Clientset, *restfake.RESTClient) {
t.Helper()

Expand All @@ -81,8 +87,11 @@ func setUp(t *testing.T) (*Clientset, *restfake.RESTClient) {
t.Fatalf("NewForConfig() failed: %v", err)
}

// objects will be added to the object tracker when the fake dynamic interface is created,
// this allows to unit test methods that require processing of unstructured data.
objs := []runtime.Object{obj1, obj2}
cs.restClient = fakeClient

f := dynamicfake.NewSimpleDynamicClient(scheme.Scheme, objs...)
f.PrependReactor("get", "*", func(action ktest.Action) (bool, runtime.Object, error) {
gAction := action.(ktest.GetAction)
Expand Down Expand Up @@ -141,13 +150,18 @@ func TestCreate(t *testing.T) {
}}

for _, tt := range tests {
fakeClient.Err = nil
fakeClient.Err = nil // set Err to nil on each case start
// if we expect an error to be returned from the rest server
// we set the fake rest client error to it
// thus it will be returned for every rest call to that server.
if tt.wantErr != "" {
fakeClient.Err = fmt.Errorf(tt.wantErr)
}

fakeClient.Resp = tt.resp

// rest unit tests keep no state on the server side
// instead, whatever we want to be returned we populate as a resp.Body
if tt.want != nil {
b, _ := json.Marshal(tt.want)
tt.resp.Body = io.NopCloser(bytes.NewReader(b))
Expand All @@ -156,16 +170,17 @@ func TestCreate(t *testing.T) {
t.Run(tt.desc, func(t *testing.T) {
tc := cs.Srlinux("foo")
got, err := tc.Create(context.Background(), tt.want)

if s := errdiff.Substring(err, tt.wantErr); s != "" {
t.Fatalf("unexpected error: %s", s)
}

if tt.wantErr != "" {
return
}
want := tt.want.DeepCopy()
want.TypeMeta = metav1.TypeMeta{}
if !reflect.DeepEqual(got, want) {
t.Fatalf("Create(%+v) failed: diff\n%s", tt.want, pretty.Diff(got, want))

if s := cmp.Diff(got, tt.want, ignoreTypeMetaOpt); s != "" {
t.Fatalf("Create failed.\nGot: %+v\nWant: %+v\nDiff\n%s", got, tt.want, s)
}
})
}
Expand Down Expand Up @@ -217,8 +232,8 @@ func TestList(t *testing.T) {
return
}

if !reflect.DeepEqual(got, tt.want) {
t.Fatalf("List() failed: got %v, want %v", got, tt.want)
if s := cmp.Diff(got, tt.want, ignoreTypeMetaOpt); s != "" {
t.Fatalf("List failed.\nGot: %+v\nWant: %+v\nDiff\n%s", got, tt.want, s)
}
})
}
Expand Down Expand Up @@ -268,10 +283,8 @@ func TestGet(t *testing.T) {
return
}

want := tt.want.DeepCopy()
want.TypeMeta = metav1.TypeMeta{}
if !reflect.DeepEqual(got, want) {
t.Fatalf("Get() failed: got %v, want %v", got, want)
if s := cmp.Diff(got, tt.want, ignoreTypeMetaOpt); s != "" {
t.Fatalf("Get failed.\nGot: %+v\nWant: %+v\nDiff\n%s", got, tt.want, s)
}
})
}
Expand Down Expand Up @@ -304,10 +317,12 @@ func TestDelete(t *testing.T) {

t.Run(tt.desc, func(t *testing.T) {
tc := cs.Srlinux("foo")

err := tc.Delete(context.Background(), "obj1", metav1.DeleteOptions{})
if s := errdiff.Substring(err, tt.wantErr); s != "" {
t.Fatalf("unexpected error: %s", s)
}

if tt.wantErr != "" {
return
}
Expand Down Expand Up @@ -352,9 +367,9 @@ func TestWatch(t *testing.T) {
return
}

e := <-w.ResultChan()
if !reflect.DeepEqual(e, tt.want) {
t.Fatalf("Watch() failed: got %v, want %v", e, tt.want)
got := <-w.ResultChan()
if s := cmp.Diff(got, tt.want); s != "" {
t.Fatalf("Watch failed.\nGot: %+v\nWant: %+v\nDiff\n%s", got, tt.want, s)
}
})
}
Expand All @@ -372,11 +387,11 @@ func TestUnstructured(t *testing.T) {
in: "missingObj",
wantErr: `"missingObj" not found`,
}, {
desc: "Valid Node",
desc: "Valid Node 1",
in: obj1.GetObjectMeta().GetName(),
want: obj1,
}, {
desc: "Valid Node",
desc: "Valid Node 2",
in: obj2.GetObjectMeta().GetName(),
want: obj2,
}}
Expand All @@ -398,8 +413,8 @@ func TestUnstructured(t *testing.T) {
t.Fatalf("failed to turn response into a topology: %v", err)
}

if !reflect.DeepEqual(uObj1, tt.want) {
t.Fatalf("Unstructured(%q) failed: got %+v, want %+v", tt.in, uObj1, tt.want)
if s := cmp.Diff(uObj1, tt.want); s != "" {
t.Fatalf("Unstructured (%q) failed.\nGot: %+v\nWant: %+v\nDiff\n%s", tt.in, uObj1, tt.want, s)
}
})
}
Expand All @@ -426,7 +441,7 @@ func TestUpdate(t *testing.T) {
},
wantErr: "doesnotexist",
}, {
desc: "Valid Topology",
desc: "Valid Node",
want: obj1,
}}

Expand All @@ -453,10 +468,8 @@ func TestUpdate(t *testing.T) {
return
}

want := tt.want.DeepCopy()
want.TypeMeta = metav1.TypeMeta{}
if !reflect.DeepEqual(got, updateObj) {
t.Fatalf("Update() failed: got %+v, want %+v", got, want)
if s := cmp.Diff(got, updateObj); s != "" {
t.Fatalf("Update failed.\nGot: %+v\nWant: %+v\nDiff\n%s", got, updateObj, s)
}
})
}
Expand Down
2 changes: 0 additions & 2 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ require (
github.com/go-logr/logr v0.4.0
github.com/google/go-cmp v0.5.8
github.com/h-fam/errdiff v1.0.2
github.com/kr/pretty v0.2.1
github.com/onsi/ginkgo v1.16.4
github.com/onsi/gomega v1.13.0
github.com/openconfig/kne v0.1.1
Expand Down Expand Up @@ -41,7 +40,6 @@ require (
github.com/hashicorp/golang-lru v0.5.4 // indirect
github.com/imdario/mergo v0.3.12 // indirect
github.com/json-iterator/go v1.1.11 // indirect
github.com/kr/text v0.2.0 // indirect
github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
github.com/moby/spdystream v0.2.0 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
Expand Down
1 change: 0 additions & 1 deletion go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,6 @@ github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxv
github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/pty v1.1.5/go.mod h1:9r2w37qlBe7rQ6e1fg1S/9xpWHSnaqNdHD3WcMdbPDA=
Expand Down