kubernetes/pkg/kubelet/deviceplugin/utils.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 deviceplugin

import (
	"fmt"
	"strings"

	pluginapi "k8s.io/kubernetes/pkg/kubelet/apis/deviceplugin/v1alpha1"
)

// CloneDevice clones a pluginapi.Device
func CloneDevice(d *pluginapi.Device) *pluginapi.Device {
	return &pluginapi.Device{
		ID:     d.ID,
		Health: d.Health,
	}

}

func copyDevices(devs map[string]*pluginapi.Device) []*pluginapi.Device {
	var clones []*pluginapi.Device

	for _, d := range devs {
		clones = append(clones, CloneDevice(d))
	}

	return clones
}

// GetDevice returns the Device if a boolean signaling if the device was found or not
func GetDevice(d *pluginapi.Device, devs []*pluginapi.Device) (*pluginapi.Device, bool) {
	name := DeviceKey(d)

	for _, d := range devs {
		if DeviceKey(d) != name {
			continue
		}

		return d, true
	}

	return nil, false
}

// IsResourceNameValid returns an error if the resource is invalid,
func IsResourceNameValid(resourceName string) error {
	if resourceName == "" {
		return fmt.Errorf(pluginapi.ErrEmptyResourceName)
	}

	if strings.ContainsAny(resourceName, pluginapi.InvalidChars) {
		return fmt.Errorf(pluginapi.ErrInvalidResourceName)
	}

	return nil
}

// DeviceKey returns the Key of a device
func DeviceKey(d *pluginapi.Device) string {
	return d.ID
}