kubernetes/pkg/kubelet/dockershim/docker_service_test.go

//go:build !dockerless
// +build !dockerless

/*
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 dockershim

import (
	"errors"
	"math/rand"
	"testing"
	"time"

	"github.com/blang/semver"
	dockertypes "github.com/docker/docker/api/types"
	"github.com/golang/mock/gomock"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	runtimeapi "k8s.io/cri-api/pkg/apis/runtime/v1"
	"k8s.io/kubernetes/pkg/kubelet/checkpointmanager"
	containertest "k8s.io/kubernetes/pkg/kubelet/container/testing"
	"k8s.io/kubernetes/pkg/kubelet/dockershim/libdocker"
	"k8s.io/kubernetes/pkg/kubelet/dockershim/network"
	nettest "k8s.io/kubernetes/pkg/kubelet/dockershim/network/testing"
	"k8s.io/kubernetes/pkg/kubelet/util/cache"
	testingclock "k8s.io/utils/clock/testing"
)

type mockCheckpointManager struct {
	checkpoint map[string]*PodSandboxCheckpoint
}

func (ckm *mockCheckpointManager) CreateCheckpoint(checkpointKey string, checkpoint checkpointmanager.Checkpoint) error {
	ckm.checkpoint[checkpointKey] = checkpoint.(*PodSandboxCheckpoint)
	return nil
}

func (ckm *mockCheckpointManager) GetCheckpoint(checkpointKey string, checkpoint checkpointmanager.Checkpoint) error {
	*(checkpoint.(*PodSandboxCheckpoint)) = *(ckm.checkpoint[checkpointKey])
	return nil
}

func (ckm *mockCheckpointManager) RemoveCheckpoint(checkpointKey string) error {
	_, ok := ckm.checkpoint[checkpointKey]
	if ok {
		delete(ckm.checkpoint, "moo")
	}
	return nil
}

func (ckm *mockCheckpointManager) ListCheckpoints() ([]string, error) {
	var keys []string
	for key := range ckm.checkpoint {
		keys = append(keys, key)
	}
	return keys, nil
}

func newMockCheckpointManager() checkpointmanager.CheckpointManager {
	return &mockCheckpointManager{checkpoint: make(map[string]*PodSandboxCheckpoint)}
}

func newTestDockerService() (*dockerService, *libdocker.FakeDockerClient, *testingclock.FakeClock) {
	fakeClock := testingclock.NewFakeClock(time.Time{})
	c := libdocker.NewFakeDockerClient().WithClock(fakeClock).WithVersion("1.11.2", "1.23").WithRandSource(rand.NewSource(0))
	pm := network.NewPluginManager(&network.NoopNetworkPlugin{})
	ckm := newMockCheckpointManager()
	return &dockerService{
		client:            c,
		os:                &containertest.FakeOS{},
		network:           pm,
		checkpointManager: ckm,
		networkReady:      make(map[string]bool),
		dockerRootDir:     "/docker/root/dir",
	}, c, fakeClock
}

func newTestDockerServiceWithVersionCache() (*dockerService, *libdocker.FakeDockerClient, *testingclock.FakeClock) {
	ds, c, fakeClock := newTestDockerService()
	ds.versionCache = cache.NewObjectCache(
		func() (interface{}, error) {
			return ds.getDockerVersion()
		},
		time.Hour*10,
	)
	return ds, c, fakeClock
}

// TestStatus tests the runtime status logic.
func TestStatus(t *testing.T) {
	ds, fDocker, _ := newTestDockerService()

	assertStatus := func(expected map[string]bool, status *runtimeapi.RuntimeStatus) {
		conditions := status.GetConditions()
		assert.Equal(t, len(expected), len(conditions))
		for k, v := range expected {
			for _, c := range conditions {
				if k == c.Type {
					assert.Equal(t, v, c.Status)
				}
			}
		}
	}

	// Should report ready status if version returns no error.
	statusResp, err := ds.Status(getTestCTX(), &runtimeapi.StatusRequest{})
	require.NoError(t, err)
	assertStatus(map[string]bool{
		runtimeapi.RuntimeReady: true,
		runtimeapi.NetworkReady: true,
	}, statusResp.Status)

	// Should not report ready status if version returns error.
	fDocker.InjectError("version", errors.New("test error"))
	statusResp, err = ds.Status(getTestCTX(), &runtimeapi.StatusRequest{})
	assert.NoError(t, err)
	assertStatus(map[string]bool{
		runtimeapi.RuntimeReady: false,
		runtimeapi.NetworkReady: true,
	}, statusResp.Status)

	// Should not report ready status is network plugin returns error.
	ctrl := gomock.NewController(t)
	defer ctrl.Finish()
	mockPlugin := nettest.NewMockNetworkPlugin(ctrl)
	ds.network = network.NewPluginManager(mockPlugin)
	mockPlugin.EXPECT().Status().Return(errors.New("network error"))
	statusResp, err = ds.Status(getTestCTX(), &runtimeapi.StatusRequest{})
	assert.NoError(t, err)
	assertStatus(map[string]bool{
		runtimeapi.RuntimeReady: true,
		runtimeapi.NetworkReady: false,
	}, statusResp.Status)
}

func TestVersion(t *testing.T) {
	ds, _, _ := newTestDockerService()

	expectedVersion := &dockertypes.Version{Version: "1.11.2", APIVersion: "1.23.0"}
	v, err := ds.getDockerVersion()
	require.NoError(t, err)
	assert.Equal(t, expectedVersion, v)

	expectedAPIVersion := &semver.Version{Major: 1, Minor: 23, Patch: 0}
	apiVersion, err := ds.getDockerAPIVersion()
	require.NoError(t, err)
	assert.Equal(t, expectedAPIVersion, apiVersion)
}

func TestAPIVersionWithCache(t *testing.T) {
	ds, _, _ := newTestDockerServiceWithVersionCache()

	expected := &semver.Version{Major: 1, Minor: 23, Patch: 0}
	version, err := ds.getDockerAPIVersion()
	require.NoError(t, err)
	assert.Equal(t, expected, version)
}