f215096715
In https://github.com/kubernetes/kubernetes/pull/88372, we added the ability to inject errors to the `FakeImageService`. Use this ability to test the error paths executed by the `kubeGenericRuntimeManager` when underlying `ImageService` calls fail. I don't foresee this change having a huge impact, but it should set a good precedent for test coverage, and should the failure case behavior become more "interesting" or risky in the future, we already will have the scaffolding in place with which we can expand the tests.
260 lines
8.4 KiB
Go
260 lines
8.4 KiB
Go
/*
|
|
Copyright 2016 The Kubernetes 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 kuberuntime
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"k8s.io/api/core/v1"
|
|
"k8s.io/apimachinery/pkg/util/sets"
|
|
runtimeapi "k8s.io/cri-api/pkg/apis/runtime/v1alpha2"
|
|
"k8s.io/kubernetes/pkg/credentialprovider"
|
|
kubecontainer "k8s.io/kubernetes/pkg/kubelet/container"
|
|
)
|
|
|
|
func TestPullImage(t *testing.T) {
|
|
_, _, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
imageRef, err := fakeManager.PullImage(kubecontainer.ImageSpec{Image: "busybox"}, nil, nil)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, "busybox", imageRef)
|
|
|
|
images, err := fakeManager.ListImages()
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 1, len(images))
|
|
assert.Equal(t, images[0].RepoTags, []string{"busybox"})
|
|
}
|
|
|
|
func TestPullImageWithError(t *testing.T) {
|
|
_, fakeImageService, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
fakeImageService.InjectError("PullImage", fmt.Errorf("test-error"))
|
|
imageRef, err := fakeManager.PullImage(kubecontainer.ImageSpec{Image: "busybox"}, nil, nil)
|
|
assert.Error(t, err)
|
|
assert.Equal(t, "", imageRef)
|
|
|
|
images, err := fakeManager.ListImages()
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 0, len(images))
|
|
}
|
|
|
|
func TestListImages(t *testing.T) {
|
|
_, fakeImageService, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
images := []string{"1111", "2222", "3333"}
|
|
expected := sets.NewString(images...)
|
|
fakeImageService.SetFakeImages(images)
|
|
|
|
actualImages, err := fakeManager.ListImages()
|
|
assert.NoError(t, err)
|
|
actual := sets.NewString()
|
|
for _, i := range actualImages {
|
|
actual.Insert(i.ID)
|
|
}
|
|
|
|
assert.Equal(t, expected.List(), actual.List())
|
|
}
|
|
|
|
func TestListImagesWithError(t *testing.T) {
|
|
_, fakeImageService, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
fakeImageService.InjectError("ListImages", fmt.Errorf("test-failure"))
|
|
|
|
actualImages, err := fakeManager.ListImages()
|
|
assert.Error(t, err)
|
|
assert.Nil(t, actualImages)
|
|
}
|
|
|
|
func TestGetImageRef(t *testing.T) {
|
|
_, fakeImageService, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
image := "busybox"
|
|
fakeImageService.SetFakeImages([]string{image})
|
|
imageRef, err := fakeManager.GetImageRef(kubecontainer.ImageSpec{Image: image})
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, image, imageRef)
|
|
}
|
|
|
|
func TestGetImageRefImageNotAvailableLocally(t *testing.T) {
|
|
_, _, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
image := "busybox"
|
|
|
|
imageRef, err := fakeManager.GetImageRef(kubecontainer.ImageSpec{Image: image})
|
|
assert.NoError(t, err)
|
|
|
|
imageNotAvailableLocallyRef := ""
|
|
assert.Equal(t, imageNotAvailableLocallyRef, imageRef)
|
|
}
|
|
|
|
func TestGetImageRefWithError(t *testing.T) {
|
|
_, fakeImageService, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
image := "busybox"
|
|
|
|
fakeImageService.InjectError("ImageStatus", fmt.Errorf("test-error"))
|
|
|
|
imageRef, err := fakeManager.GetImageRef(kubecontainer.ImageSpec{Image: image})
|
|
assert.Error(t, err)
|
|
assert.Equal(t, "", imageRef)
|
|
}
|
|
|
|
func TestRemoveImage(t *testing.T) {
|
|
_, fakeImageService, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
_, err = fakeManager.PullImage(kubecontainer.ImageSpec{Image: "busybox"}, nil, nil)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 1, len(fakeImageService.Images))
|
|
|
|
err = fakeManager.RemoveImage(kubecontainer.ImageSpec{Image: "busybox"})
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 0, len(fakeImageService.Images))
|
|
}
|
|
|
|
func TestRemoveImageNoOpIfImageNotLocal(t *testing.T) {
|
|
_, _, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
err = fakeManager.RemoveImage(kubecontainer.ImageSpec{Image: "busybox"})
|
|
assert.NoError(t, err)
|
|
}
|
|
|
|
func TestRemoveImageWithError(t *testing.T) {
|
|
_, fakeImageService, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
_, err = fakeManager.PullImage(kubecontainer.ImageSpec{Image: "busybox"}, nil, nil)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 1, len(fakeImageService.Images))
|
|
|
|
fakeImageService.InjectError("RemoveImage", fmt.Errorf("test-failure"))
|
|
|
|
err = fakeManager.RemoveImage(kubecontainer.ImageSpec{Image: "busybox"})
|
|
assert.Error(t, err)
|
|
assert.Equal(t, 1, len(fakeImageService.Images))
|
|
}
|
|
|
|
func TestImageStats(t *testing.T) {
|
|
_, fakeImageService, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
const imageSize = 64
|
|
fakeImageService.SetFakeImageSize(imageSize)
|
|
images := []string{"1111", "2222", "3333"}
|
|
fakeImageService.SetFakeImages(images)
|
|
|
|
actualStats, err := fakeManager.ImageStats()
|
|
assert.NoError(t, err)
|
|
expectedStats := &kubecontainer.ImageStats{TotalStorageBytes: imageSize * uint64(len(images))}
|
|
assert.Equal(t, expectedStats, actualStats)
|
|
}
|
|
|
|
func TestImageStatsWithError(t *testing.T) {
|
|
_, fakeImageService, fakeManager, err := createTestRuntimeManager()
|
|
assert.NoError(t, err)
|
|
|
|
fakeImageService.InjectError("ListImages", fmt.Errorf("test-failure"))
|
|
|
|
actualImageStats, err := fakeManager.ImageStats()
|
|
assert.Error(t, err)
|
|
assert.Nil(t, actualImageStats)
|
|
}
|
|
|
|
func TestPullWithSecrets(t *testing.T) {
|
|
// auth value is equivalent to: "username":"passed-user","password":"passed-password"
|
|
dockerCfg := map[string]map[string]string{"index.docker.io/v1/": {"email": "passed-email", "auth": "cGFzc2VkLXVzZXI6cGFzc2VkLXBhc3N3b3Jk"}}
|
|
dockercfgContent, err := json.Marshal(dockerCfg)
|
|
if err != nil {
|
|
t.Errorf("unexpected error: %v", err)
|
|
}
|
|
|
|
dockerConfigJSON := map[string]map[string]map[string]string{"auths": dockerCfg}
|
|
dockerConfigJSONContent, err := json.Marshal(dockerConfigJSON)
|
|
if err != nil {
|
|
t.Errorf("unexpected error: %v", err)
|
|
}
|
|
|
|
tests := map[string]struct {
|
|
imageName string
|
|
passedSecrets []v1.Secret
|
|
builtInDockerConfig credentialprovider.DockerConfig
|
|
expectedAuth *runtimeapi.AuthConfig
|
|
}{
|
|
"no matching secrets": {
|
|
"ubuntu",
|
|
[]v1.Secret{},
|
|
credentialprovider.DockerConfig(map[string]credentialprovider.DockerConfigEntry{}),
|
|
nil,
|
|
},
|
|
"default keyring secrets": {
|
|
"ubuntu",
|
|
[]v1.Secret{},
|
|
credentialprovider.DockerConfig(map[string]credentialprovider.DockerConfigEntry{
|
|
"index.docker.io/v1/": {Username: "built-in", Password: "password", Provider: nil},
|
|
}),
|
|
&runtimeapi.AuthConfig{Username: "built-in", Password: "password"},
|
|
},
|
|
"default keyring secrets unused": {
|
|
"ubuntu",
|
|
[]v1.Secret{},
|
|
credentialprovider.DockerConfig(map[string]credentialprovider.DockerConfigEntry{
|
|
"extraneous": {Username: "built-in", Password: "password", Provider: nil},
|
|
}),
|
|
nil,
|
|
},
|
|
"builtin keyring secrets, but use passed": {
|
|
"ubuntu",
|
|
[]v1.Secret{{Type: v1.SecretTypeDockercfg, Data: map[string][]byte{v1.DockerConfigKey: dockercfgContent}}},
|
|
credentialprovider.DockerConfig(map[string]credentialprovider.DockerConfigEntry{
|
|
"index.docker.io/v1/": {Username: "built-in", Password: "password", Provider: nil},
|
|
}),
|
|
&runtimeapi.AuthConfig{Username: "passed-user", Password: "passed-password"},
|
|
},
|
|
"builtin keyring secrets, but use passed with new docker config": {
|
|
"ubuntu",
|
|
[]v1.Secret{{Type: v1.SecretTypeDockerConfigJson, Data: map[string][]byte{v1.DockerConfigJsonKey: dockerConfigJSONContent}}},
|
|
credentialprovider.DockerConfig(map[string]credentialprovider.DockerConfigEntry{
|
|
"index.docker.io/v1/": {Username: "built-in", Password: "password", Provider: nil},
|
|
}),
|
|
&runtimeapi.AuthConfig{Username: "passed-user", Password: "passed-password"},
|
|
},
|
|
}
|
|
for description, test := range tests {
|
|
builtInKeyRing := &credentialprovider.BasicDockerKeyring{}
|
|
builtInKeyRing.Add(test.builtInDockerConfig)
|
|
_, fakeImageService, fakeManager, err := customTestRuntimeManager(builtInKeyRing)
|
|
require.NoError(t, err)
|
|
|
|
_, err = fakeManager.PullImage(kubecontainer.ImageSpec{Image: test.imageName}, test.passedSecrets, nil)
|
|
require.NoError(t, err)
|
|
fakeImageService.AssertImagePulledWithAuth(t, &runtimeapi.ImageSpec{Image: test.imageName}, test.expectedAuth, description)
|
|
}
|
|
}
|