Skip to content

K
k3s
Commit ad16fbc5 authored by Ed Bartosh's avatar Ed Bartosh
Browse files
Options

kubeadm: wrap runtime tests in a t.Run

Improved runtime tests by using T.Run API: https://golang.org/pkg/testing/#T.Run This should improve the test output and make it more visible which test is doing what.
parent 8246dfa0
Show whitespace changes
Inline Side-by-side
Showing with 51 additions and 37 deletions
cmd/kubeadm/app/util/runtime/runtime_test.go
View file @ ad16fbc5
...@@ -34,32 +34,35 @@ func TestNewContainerRuntime(t *testing.T) { ...@@ -34,32 +34,35 @@ func TestNewContainerRuntime(t *testing.T) {
LookPathFunc: func(cmd string) (string, error) { return "", fmt.Errorf("%s not found", cmd) }, LookPathFunc: func(cmd string) (string, error) { return "", fmt.Errorf("%s not found", cmd) },
} }
cases := []struct { cases := []struct {
name string
execer fakeexec.FakeExec execer fakeexec.FakeExec
criSocket string criSocket string
isDocker bool isDocker bool
isError bool isError bool
}{ }{
{execLookPathOK, kubeadmapiv1alpha3.DefaultCRISocket, true, false}, {"valid: default cri socket", execLookPathOK, kubeadmapiv1alpha3.DefaultCRISocket, true, false},
{execLookPathOK, "unix:///var/run/crio/crio.sock", false, false}, {"valid: cri-o socket url", execLookPathOK, "unix:///var/run/crio/crio.sock", false, false},
{execLookPathOK, "/var/run/crio/crio.sock", false, false}, {"valid: cri-o socket path", execLookPathOK, "/var/run/crio/crio.sock", false, false},
{execLookPathErr, "unix:///var/run/crio/crio.sock", false, true}, {"invalid: no crictl", execLookPathErr, "unix:///var/run/crio/crio.sock", false, true},
} }
for _, tc := range cases { for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
runtime, err := NewContainerRuntime(&tc.execer, tc.criSocket) runtime, err := NewContainerRuntime(&tc.execer, tc.criSocket)
if err != nil { if err != nil {
if !tc.isError { if !tc.isError {
t.Errorf("unexpected NewContainerRuntime error. criSocket: %s, error: %v", tc.criSocket, err) t.Fatalf("unexpected NewContainerRuntime error. criSocket: %s, error: %v", tc.criSocket, err)
} }
continue // expected error occurs, impossible to test runtime further return // expected error occurs, impossible to test runtime further
} }
if tc.isError && err == nil { if tc.isError && err == nil {
t.Errorf("unexpected NewContainerRuntime success. criSocket: %s", tc.criSocket) t.Fatalf("unexpected NewContainerRuntime success. criSocket: %s", tc.criSocket)
} }
isDocker := runtime.IsDocker() isDocker := runtime.IsDocker()
if tc.isDocker != isDocker { if tc.isDocker != isDocker {
t.Errorf("unexpected isDocker() result %v for the criSocket %s", isDocker, tc.criSocket) t.Fatalf("unexpected isDocker() result %v for the criSocket %s", isDocker, tc.criSocket)
} }
})
} }
} }
...@@ -93,18 +96,20 @@ func TestIsRunning(t *testing.T) { ...@@ -93,18 +96,20 @@ func TestIsRunning(t *testing.T) {
} }
cases := []struct { cases := []struct {
name string
criSocket string criSocket string
execer fakeexec.FakeExec execer fakeexec.FakeExec
isError bool isError bool
runCalls int runCalls int
}{ }{
{"unix:///var/run/crio/crio.sock", criExecer, false, 1}, {"valid: CRI-O is running", "unix:///var/run/crio/crio.sock", criExecer, false, 1},
{"unix:///var/run/crio/crio.sock", criExecer, true, 2}, {"invalid: CRI-O is not running", "unix:///var/run/crio/crio.sock", criExecer, true, 2},
{kubeadmapiv1alpha3.DefaultCRISocket, dockerExecer, false, 3}, {"valid: docker is running", kubeadmapiv1alpha3.DefaultCRISocket, dockerExecer, false, 3},
{kubeadmapiv1alpha3.DefaultCRISocket, dockerExecer, true, 4}, {"invalid: docker is not running", kubeadmapiv1alpha3.DefaultCRISocket, dockerExecer, true, 4},
} }
for _, tc := range cases { for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
runtime, err := NewContainerRuntime(&tc.execer, tc.criSocket) runtime, err := NewContainerRuntime(&tc.execer, tc.criSocket)
if err != nil { if err != nil {
t.Fatalf("unexpected NewContainerRuntime error: %v", err) t.Fatalf("unexpected NewContainerRuntime error: %v", err)
...@@ -119,6 +124,7 @@ func TestIsRunning(t *testing.T) { ...@@ -119,6 +124,7 @@ func TestIsRunning(t *testing.T) {
if fcmd.RunCalls != tc.runCalls { if fcmd.RunCalls != tc.runCalls {
t.Errorf("expected %d Run() calls, got %d", tc.runCalls, fcmd.RunCalls) t.Errorf("expected %d Run() calls, got %d", tc.runCalls, fcmd.RunCalls)
} }
})
} }
} }
...@@ -136,19 +142,20 @@ func TestListKubeContainers(t *testing.T) { ...@@ -136,19 +142,20 @@ func TestListKubeContainers(t *testing.T) {
} }
cases := []struct { cases := []struct {
name string
criSocket string criSocket string
isError bool isError bool
}{ }{
{"unix:///var/run/crio/crio.sock", false}, {"valid: list containers using CRI socket url", "unix:///var/run/crio/crio.sock", false},
{"unix:///var/run/crio/crio.sock", true}, {"invalid: list containers using CRI socket url", "unix:///var/run/crio/crio.sock", true},
{kubeadmapiv1alpha3.DefaultCRISocket, false}, {"valid: list containers using docker", kubeadmapiv1alpha3.DefaultCRISocket, false},
} }
for _, tc := range cases { for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
runtime, err := NewContainerRuntime(&execer, tc.criSocket) runtime, err := NewContainerRuntime(&execer, tc.criSocket)
if err != nil { if err != nil {
t.Errorf("unexpected NewContainerRuntime error: %v", err) t.Fatalf("unexpected NewContainerRuntime error: %v", err)
continue
} }
containers, err := runtime.ListKubeContainers() containers, err := runtime.ListKubeContainers()
...@@ -156,7 +163,7 @@ func TestListKubeContainers(t *testing.T) { ...@@ -156,7 +163,7 @@ func TestListKubeContainers(t *testing.T) {
if err == nil { if err == nil {
t.Errorf("unexpected ListKubeContainers success") t.Errorf("unexpected ListKubeContainers success")
} }
continue return
} else if err != nil { } else if err != nil {
t.Errorf("unexpected ListKubeContainers error: %v", err) t.Errorf("unexpected ListKubeContainers error: %v", err)
} }
...@@ -164,6 +171,7 @@ func TestListKubeContainers(t *testing.T) { ...@@ -164,6 +171,7 @@ func TestListKubeContainers(t *testing.T) {
if !reflect.DeepEqual(containers, []string{"k8s_p1", "k8s_p2"}) { if !reflect.DeepEqual(containers, []string{"k8s_p1", "k8s_p2"}) {
t.Errorf("unexpected ListKubeContainers output: %v", containers) t.Errorf("unexpected ListKubeContainers output: %v", containers)
} }
})
} }
} }
...@@ -185,22 +193,23 @@ func TestRemoveContainers(t *testing.T) { ...@@ -185,22 +193,23 @@ func TestRemoveContainers(t *testing.T) {
} }
cases := []struct { cases := []struct {
name string
criSocket string criSocket string
containers []string containers []string
isError bool isError bool
}{ }{
{"unix:///var/run/crio/crio.sock", []string{"k8s_p1", "k8s_p2", "k8s_p3"}, false}, // Test case 1 {"valid: remove containers using CRI", "unix:///var/run/crio/crio.sock", []string{"k8s_p1", "k8s_p2", "k8s_p3"}, false}, // Test case 1
{"unix:///var/run/crio/crio.sock", []string{"k8s_p1", "k8s_p2", "k8s_p3"}, true}, {"invalid: CRI rmp failure", "unix:///var/run/crio/crio.sock", []string{"k8s_p1", "k8s_p2", "k8s_p3"}, true},
{"unix:///var/run/crio/crio.sock", []string{"k8s_p1", "k8s_p2", "k8s_p3"}, true}, {"invalid: CRI stopp failure", "unix:///var/run/crio/crio.sock", []string{"k8s_p1", "k8s_p2", "k8s_p3"}, true},
{kubeadmapiv1alpha3.DefaultCRISocket, []string{"k8s_c1", "k8s_c2", "k8s_c3"}, false}, {"valid: remove containers using docker", kubeadmapiv1alpha3.DefaultCRISocket, []string{"k8s_c1", "k8s_c2", "k8s_c3"}, false},
{kubeadmapiv1alpha3.DefaultCRISocket, []string{"k8s_c1", "k8s_c2", "k8s_c3"}, true}, {"invalid: remove containers using docker", kubeadmapiv1alpha3.DefaultCRISocket, []string{"k8s_c1", "k8s_c2", "k8s_c3"}, true},
} }
for _, tc := range cases { for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
runtime, err := NewContainerRuntime(&execer, tc.criSocket) runtime, err := NewContainerRuntime(&execer, tc.criSocket)
if err != nil { if err != nil {
t.Errorf("unexpected NewContainerRuntime error: %v, criSocket: %s", err, tc.criSocket) t.Fatalf("unexpected NewContainerRuntime error: %v, criSocket: %s", err, tc.criSocket)
continue
} }
err = runtime.RemoveContainers(tc.containers) err = runtime.RemoveContainers(tc.containers)
...@@ -210,6 +219,7 @@ func TestRemoveContainers(t *testing.T) { ...@@ -210,6 +219,7 @@ func TestRemoveContainers(t *testing.T) {
if tc.isError && err == nil { if tc.isError && err == nil {
t.Errorf("unexpected RemoveContnainers success, criSocket: %s, containers: %v", tc.criSocket, tc.containers) t.Errorf("unexpected RemoveContnainers success, criSocket: %s, containers: %v", tc.criSocket, tc.containers)
} }
})
} }
} }
...@@ -228,21 +238,22 @@ func TestPullImage(t *testing.T) { ...@@ -228,21 +238,22 @@ func TestPullImage(t *testing.T) {
} }
cases := []struct { cases := []struct {
name string
criSocket string criSocket string
image string image string
isError bool isError bool
}{ }{
{"unix:///var/run/crio/crio.sock", "image1", false}, {"valid: pull image using CRI", "unix:///var/run/crio/crio.sock", "image1", false},
{"unix:///var/run/crio/crio.sock", "image2", true}, {"invalid: CRI pull error", "unix:///var/run/crio/crio.sock", "image2", true},
{kubeadmapiv1alpha3.DefaultCRISocket, "image1", false}, {"valid: pull image using docker", kubeadmapiv1alpha3.DefaultCRISocket, "image1", false},
{kubeadmapiv1alpha3.DefaultCRISocket, "image2", true}, {"invalide: docer pull error", kubeadmapiv1alpha3.DefaultCRISocket, "image2", true},
} }
for _, tc := range cases { for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
runtime, err := NewContainerRuntime(&execer, tc.criSocket) runtime, err := NewContainerRuntime(&execer, tc.criSocket)
if err != nil { if err != nil {
t.Errorf("unexpected NewContainerRuntime error: %v, criSocket: %s", err, tc.criSocket) t.Fatalf("unexpected NewContainerRuntime error: %v, criSocket: %s", err, tc.criSocket)
continue
} }
err = runtime.PullImage(tc.image) err = runtime.PullImage(tc.image)
...@@ -252,6 +263,7 @@ func TestPullImage(t *testing.T) { ...@@ -252,6 +263,7 @@ func TestPullImage(t *testing.T) {
if tc.isError && err == nil { if tc.isError && err == nil {
t.Errorf("unexpected PullImage success, criSocket: %s, image: %s", tc.criSocket, tc.image) t.Errorf("unexpected PullImage success, criSocket: %s, image: %s", tc.criSocket, tc.image)
} }
})
} }
} }
...@@ -270,21 +282,22 @@ func TestImageExists(t *testing.T) { ...@@ -270,21 +282,22 @@ func TestImageExists(t *testing.T) {
} }
cases := []struct { cases := []struct {
name string
criSocket string criSocket string
image string image string
isError bool isError bool
}{ }{
{"unix:///var/run/crio/crio.sock", "image1", false}, {"valid: test if image exists using CRI", "unix:///var/run/crio/crio.sock", "image1", false},
{"unix:///var/run/crio/crio.sock", "image2", true}, {"invalid: CRI inspecti failure", "unix:///var/run/crio/crio.sock", "image2", true},
{kubeadmapiv1alpha3.DefaultCRISocket, "image1", false}, {"valid: test if image exists using docker", kubeadmapiv1alpha3.DefaultCRISocket, "image1", false},
{kubeadmapiv1alpha3.DefaultCRISocket, "image2", true}, {"invalid: docker inspect failure", kubeadmapiv1alpha3.DefaultCRISocket, "image2", true},
} }
for _, tc := range cases { for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
runtime, err := NewContainerRuntime(&execer, tc.criSocket) runtime, err := NewContainerRuntime(&execer, tc.criSocket)
if err != nil { if err != nil {
t.Errorf("unexpected NewContainerRuntime error: %v, criSocket: %s", err, tc.criSocket) t.Fatalf("unexpected NewContainerRuntime error: %v, criSocket: %s", err, tc.criSocket)
continue
} }
result, err := runtime.ImageExists(tc.image) result, err := runtime.ImageExists(tc.image)
...@@ -297,5 +310,6 @@ func TestImageExists(t *testing.T) { ...@@ -297,5 +310,6 @@ func TestImageExists(t *testing.T) {
if tc.isError && err == nil { if tc.isError && err == nil {
t.Errorf("unexpected ImageExists success, criSocket: %s, image: %s", tc.criSocket, tc.image) t.Errorf("unexpected ImageExists success, criSocket: %s, image: %s", tc.criSocket, tc.image)
} }
})
} }
} }
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment