fake_cni_plugin.go

/*
Copyright 2017 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 testing

import (
	"fmt"
	"math/rand"
	"strconv"
	"sync"
	"time"

	"github.com/kubernetes-incubator/cri-o/pkg/ocicni"
)

// CNIPluginArgument is arguments used to call CNI related functions.
type CNIPluginArgument struct {
	NetnsPath   string
	Namespace   string
	Name        string
	ContainerID string
}

// FakeCNIPlugin is a fake plugin used for test.
type FakeCNIPlugin struct {
	sync.Mutex
	called []CalledDetail
	errors map[string]error
	IPMap  map[CNIPluginArgument]string
}

// getError get error for call
func (f *FakeCNIPlugin) getError(op string) error {
	err, ok := f.errors[op]
	if ok {
		delete(f.errors, op)
		return err
	}
	return nil
}

// InjectError inject error for call
func (f *FakeCNIPlugin) InjectError(fn string, err error) {
	f.Lock()
	defer f.Unlock()
	f.errors[fn] = err
}

// InjectErrors inject errors for calls
func (f *FakeCNIPlugin) InjectErrors(errs map[string]error) {
	f.Lock()
	defer f.Unlock()
	for fn, err := range errs {
		f.errors[fn] = err
	}
}

// ClearErrors clear errors for call
func (f *FakeCNIPlugin) ClearErrors() {
	f.Lock()
	defer f.Unlock()
	f.errors = make(map[string]error)
}

func (f *FakeCNIPlugin) appendCalled(name string, argument interface{}) {
	call := CalledDetail{Name: name, Argument: argument}
	f.called = append(f.called, call)
}

// GetCalledNames get names of call
func (f *FakeCNIPlugin) GetCalledNames() []string {
	f.Lock()
	defer f.Unlock()
	names := []string{}
	for _, detail := range f.called {
		names = append(names, detail.Name)
	}
	return names
}

// GetCalledDetails get detail of each call.
func (f *FakeCNIPlugin) GetCalledDetails() []CalledDetail {
	f.Lock()
	defer f.Unlock()
	// Copy the list and return.
	return append([]CalledDetail{}, f.called...)
}

// SetFakePodNetwork sets the given IP for given arguments.
func (f *FakeCNIPlugin) SetFakePodNetwork(netnsPath string, namespace string, name string, containerID string, ip string) {
	f.Lock()
	defer f.Unlock()
	arg := CNIPluginArgument{netnsPath, namespace, name, containerID}
	f.IPMap[arg] = ip
}

// NewFakeCNIPlugin create a FakeCNIPlugin.
func NewFakeCNIPlugin() ocicni.CNIPlugin {
	return &FakeCNIPlugin{
		errors: make(map[string]error),
		IPMap:  make(map[CNIPluginArgument]string),
	}
}

// Name return the name of fake CNI plugin.
func (f *FakeCNIPlugin) Name() string {
	return "fake-CNI-plugin"
}

// SetUpPod setup the network of PodSandbox.
func (f *FakeCNIPlugin) SetUpPod(netnsPath string, namespace string, name string, containerID string) error {
	f.Lock()
	defer f.Unlock()
	arg := CNIPluginArgument{netnsPath, namespace, name, containerID}
	f.appendCalled("SetUpPod", arg)
	if err := f.getError("SetUpPod"); err != nil {
		return err
	}
	f.IPMap[arg] = generateIP()
	return nil
}

// TearDownPod teardown the network of PodSandbox.
func (f *FakeCNIPlugin) TearDownPod(netnsPath string, namespace string, name string, containerID string) error {
	f.Lock()
	defer f.Unlock()
	arg := CNIPluginArgument{netnsPath, namespace, name, containerID}
	f.appendCalled("TearDownPod", arg)
	if err := f.getError("TearDownPod"); err != nil {
		return err
	}
	_, ok := f.IPMap[arg]
	if !ok {
		return fmt.Errorf("failed to find the IP")
	}
	delete(f.IPMap, arg)
	return nil
}

// GetContainerNetworkStatus get the status of network.
func (f *FakeCNIPlugin) GetContainerNetworkStatus(netnsPath string, namespace string, name string, containerID string) (string, error) {
	f.Lock()
	defer f.Unlock()
	arg := CNIPluginArgument{netnsPath, namespace, name, containerID}
	f.appendCalled("GetContainerNetworkStatus", arg)
	if err := f.getError("GetContainerNetworkStatus"); err != nil {
		return "", err
	}
	ip, ok := f.IPMap[arg]
	if !ok {
		return "", fmt.Errorf("failed to find the IP")
	}
	return ip, nil
}

// Status get the status of the plugin.
func (f *FakeCNIPlugin) Status() error {
	f.Lock()
	defer f.Unlock()
	f.appendCalled("Status", nil)
	return f.getError("Status")
}

func generateIP() string {
	rand.Seed(time.Now().Unix())
	p1 := strconv.Itoa(rand.Intn(266))
	p2 := strconv.Itoa(rand.Intn(266))
	p3 := strconv.Itoa(rand.Intn(266))
	p4 := strconv.Itoa(rand.Intn(266))
	return p1 + "." + p2 + "." + p3 + "." + p4
}