VMware vSphere Integrated Containers provider (#206)

* Add Virtual Kubelet provider for VIC

Initial virtual kubelet provider for VMware VIC.  This provider currently
handles creating and starting of a pod VM via the VIC portlayer and persona
server.  Image store handling via the VIC persona server.  This provider
currently requires the feature/wolfpack branch of VIC.

* Added pod stop and delete.  Also added node capacity.

Added the ability to stop and delete pod VMs via VIC.  Also retrieve
node capacity information from the VCH.

* Cleanup and readme file

Some file clean up and added a Readme.md markdown file for the VIC
provider.

* Cleaned up errors, added function comments, moved operation code

1. Cleaned up error handling.  Set standard for creating errors.
2. Added method prototype comments for all interface functions.
3. Moved PodCreator, PodStarter, PodStopper, and PodDeleter to a new folder.

* Add mocking code and unit tests for podcache, podcreator, and podstarter

Used the unit test framework used in VIC to handle assertions in the provider's
unit test.  Mocking code generated using OSS project mockery, which is compatible
with the testify assertion framework.

* Vendored packages for the VIC provider

Requires feature/wolfpack branch of VIC and a few specific commit sha of
projects used within VIC.

* Implementation of POD Stopper and Deleter unit tests (#4)

* Updated files for initial PR

vendor/github.com/vmware/vic/lib/portlayer/logging/logging.go

@@ -0,0 +1,203 @@
+// Copyright 2016 VMware, Inc. All Rights Reserved.
+//
+// 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 logging
+
+import (
+	"context"
+	"fmt"
+	"sync"
+
+	log "github.com/Sirupsen/logrus"
+
+	"strings"
+
+	"github.com/vmware/govmomi/object"
+	"github.com/vmware/govmomi/vim25/types"
+	"github.com/vmware/vic/lib/portlayer/event/collector/vsphere"
+	"github.com/vmware/vic/lib/portlayer/event/events"
+	"github.com/vmware/vic/lib/portlayer/exec"
+	"github.com/vmware/vic/pkg/retry"
+	"github.com/vmware/vic/pkg/trace"
+)
+
+var once sync.Once
+
+func Init(ctx context.Context) error {
+	once.Do(func() {
+		// Subscribe to vm events
+		exec.Config.EventManager.Subscribe(
+			events.NewEventType(vsphere.VMEvent{}).Topic(),
+			"logging",
+			func(ie events.Event) {
+				eventCallback(ie)
+			})
+	})
+	return nil
+}
+
+// listens migrated events and connects the file backed serial ports
+func eventCallback(ie events.Event) {
+	defer trace.End(trace.Begin(""))
+
+	switch ie.String() {
+	case events.ContainerMigrated,
+		events.ContainerMigratedByDrs:
+		op := trace.NewOperation(context.Background(), "LoggingEvent")
+		op.Debugf("Logging processing eventID(%s): %s", ie.EventID(), ie)
+
+		// grab the container from the cache
+		container := exec.Containers.Container(ie.Reference())
+		if container == nil {
+			op.Errorf("Container %s not found. Dropping the event %s from Logging subsystem.", ie.Reference(), ie)
+			return
+		}
+
+		operation := func() error {
+			var err error
+
+			handle := container.NewHandle(op)
+			if handle == nil {
+				err = fmt.Errorf("Handle for %s cannot be created", ie.Reference())
+				log.Error(err)
+				return err
+			}
+			defer handle.Close()
+
+			// set them to true
+			if handle, err = toggle(handle, true); err != nil {
+				op.Errorf("Failed to toggle logging after %s event for container %s: %s", ie, ie.Reference(), err)
+				return err
+			}
+
+			if err = handle.Commit(op, nil, nil); err != nil {
+				op.Errorf("Failed to commit handle after getting %s event for container %s: %s", ie, ie.Reference(), err)
+				return err
+			}
+			return nil
+		}
+
+		if err := retry.Do(operation, exec.IsConcurrentAccessError); err != nil {
+			op.Errorf("Multiple attempts failed to commit handle after getting %s event for container %s: %s", ie, ie.Reference(), err)
+		}
+	}
+
+}
+
+func toggle(handle *exec.Handle, connected bool) (*exec.Handle, error) {
+	defer trace.End(trace.Begin(""))
+
+	// get the virtual device list
+	devices := object.VirtualDeviceList(handle.Config.Hardware.Device)
+
+	// select the virtual serial ports
+	serials := devices.SelectByBackingInfo((*types.VirtualSerialPortFileBackingInfo)(nil))
+	if len(serials) == 0 {
+		return nil, fmt.Errorf("Unable to find a device with desired backing")
+	}
+
+	for i := range serials {
+		serial := serials[i]
+
+		log.Debugf("Found a device with desired backing: %#v", serial)
+
+		c := serial.GetVirtualDevice().Connectable
+		if c.Connected == connected {
+			log.Debugf("Already in the desired state (connected: %t)", connected)
+			continue
+		}
+		log.Debugf("Setting Connected to %t", connected)
+		c.Connected = connected
+
+		config := &types.VirtualDeviceConfigSpec{
+			Device:    serial,
+			Operation: types.VirtualDeviceConfigSpecOperationEdit,
+		}
+		handle.Spec.DeviceChange = append(handle.Spec.DeviceChange, config)
+	}
+	return handle, nil
+}
+
+// Join adds two file backed serial port and configures them
+func Join(h interface{}) (interface{}, error) {
+	defer trace.End(trace.Begin(""))
+
+	handle, ok := h.(*exec.Handle)
+	if !ok {
+		return nil, fmt.Errorf("Type assertion failed for %#+v", handle)
+	}
+
+	var logFilePath string
+
+	VMPathName := handle.Spec.VMPathName()
+	VMName := handle.Spec.Spec().Name
+
+	logFilePath = fmt.Sprintf("%s/%s", VMPathName, VMName)
+	// on non-vsan setup, VMPathName is set to "[datastore_name] containerID/containerID.vmx"
+	if strings.HasSuffix(VMPathName, ".vmx") {
+		idx := strings.LastIndex(VMPathName, "/")
+		logFilePath = VMPathName[:idx]
+	}
+
+	for _, logFile := range []string{"tether.debug", "output.log"} {
+		filename := fmt.Sprintf("%s/%s", logFilePath, logFile)
+		log.Infof("set log file name to: %s", filename)
+
+		// Debug and log serial ports - backed by datastore file
+		serial := &types.VirtualSerialPort{
+			VirtualDevice: types.VirtualDevice{
+				Backing: &types.VirtualSerialPortFileBackingInfo{
+					VirtualDeviceFileBackingInfo: types.VirtualDeviceFileBackingInfo{
+						FileName: filename,
+					},
+				},
+				Connectable: &types.VirtualDeviceConnectInfo{
+					Connected:         true,
+					StartConnected:    true,
+					AllowGuestControl: true,
+				},
+			},
+			YieldOnPoll: true,
+		}
+		config := &types.VirtualDeviceConfigSpec{
+			Device:    serial,
+			Operation: types.VirtualDeviceConfigSpecOperationAdd,
+		}
+		handle.Spec.DeviceChange = append(handle.Spec.DeviceChange, config)
+	}
+
+	return handle, nil
+}
+
+// Bind sets the *Connected fields of the VirtualSerialPort
+func Bind(h interface{}) (interface{}, error) {
+	defer trace.End(trace.Begin(""))
+
+	handle, ok := h.(*exec.Handle)
+	if !ok {
+		return nil, fmt.Errorf("Type assertion failed for %#+v", handle)
+	}
+	return toggle(handle, true)
+}
+
+// Unbind unsets the *Connected fields of the VirtualSerialPort
+func Unbind(h interface{}) (interface{}, error) {
+	defer trace.End(trace.Begin(""))
+
+	handle, ok := h.(*exec.Handle)
+	if !ok {
+		return nil, fmt.Errorf("Type assertion failed for %#+v", handle)
+	}
+	return toggle(handle, false)
+}