Use network backing info for debug network (vmware#1181)

* Remove network argument to portlayer

This removes the network argument from the portlayer. It is replaced with
direct access to the extraconfig data. This is specifically to add a debug
network to support our debug NIC. It should be removed anyway eventually,
however the other arguments also need this migration so it was a useful
testbed.

* Update vm test to use generated VM name

One of our tests was using deadbeef for a VM name that gets created on a
datastore. That's caused issues with concurrent testing so is updated to
use the UUID of the guest running the test.
Will likely error if the runner isn't a VM.

Fixes: 1180

.gitignore

@@ -1,4 +1,5 @@
 .vagrant/
+.vscode/
 .cover/
 bin/
 binary/

lib/apiservers/portlayer/restapi/configure_port_layer.go

@@ -75,7 +75,6 @@ func configureAPI(api *operations.PortLayerAPI) http.Handler {
 		ClusterPath:    options.PortLayerOptions.ClusterPath,
 		PoolPath:       options.PortLayerOptions.PoolPath,
 		DatastorePath:  options.PortLayerOptions.DatastorePath,
-		NetworkPath:    options.PortLayerOptions.NetworkPath,
 	}
 
 	sess, err := session.NewSession(sessionconfig).Create(ctx)

lib/apiservers/portlayer/restapi/handlers/interaction_handlers.go

@@ -62,7 +62,6 @@ func (i *InteractionHandlersImpl) Configure(api *operations.PortLayerAPI, _ *Han
 		ClusterPath:    options.PortLayerOptions.ClusterPath,
 		PoolPath:       options.PortLayerOptions.PoolPath,
 		DatastorePath:  options.PortLayerOptions.DatastorePath,
-		NetworkPath:    options.PortLayerOptions.NetworkPath,
 	}
 
 	interactionSession, err = session.NewSession(sessionconfig).Create(ctx)

lib/apiservers/portlayer/restapi/handlers/storage_handlers.go

@@ -57,7 +57,6 @@ func (handler *StorageHandlersImpl) Configure(api *operations.PortLayerAPI, hand
 		ClusterPath:    options.PortLayerOptions.ClusterPath,
 		PoolPath:       options.PortLayerOptions.PoolPath,
 		DatastorePath:  options.PortLayerOptions.DatastorePath,
-		NetworkPath:    options.PortLayerOptions.NetworkPath,
 	}
 
 	storageSession, err = session.NewSession(sessionconfig).Create(ctx)

lib/apiservers/portlayer/restapi/options/options.go

@@ -27,7 +27,6 @@ type PortLayerOptionsType struct {
 	ClusterPath    string `long:"cluster" default:"" description:"Cluster path" env:"CS_PATH" required:"true"`
 	PoolPath       string `long:"pool" default:"" description:"Resource pool path" env:"POOL_PATH" required:"true"`
 	DatastorePath  string `long:"datastore" default:"/ha-datacenter/datastore/*" description:"Datastore path" env:"DS_PATH" required:"true"`
-	NetworkPath    string `long:"network" default:"/ha-datacenter/network/*" description:"Network path" env:"NET_PATH" required:"true"`
 
 	VCHName string `long:"vch" default:"" description:"VCH name" env:"VCH_NAME" required:"true"`
 

lib/install/management/appliance.go

@@ -17,7 +17,6 @@ package management
 import (
 	"fmt"
 	"strconv"
-	"strings"
 	"time"
 
 	log "github.com/Sirupsen/logrus"
@@ -416,7 +415,6 @@ func (d *Dispatcher) createAppliance(conf *metadata.VirtualContainerHostConfigSp
 	},
 	)
 
-	netname := strings.Split(conf.Networks["client"].Network.ID, "-")[1]
 	conf.AddComponent("port-layer", &metadata.SessionConfig{
 		Cmd: metadata.Cmd{
 			Path: "/sbin/port-layer-server",
@@ -431,7 +429,6 @@ func (d *Dispatcher) createAppliance(conf *metadata.VirtualContainerHostConfigSp
 				"--cluster=" + settings.ClusterPath,
 				"--pool=" + settings.ResourcePoolPath,
 				"--datastore=" + conf.ImageStores[0].Host,
-				"--network=" + fmt.Sprintf("/%s/network/%s", settings.DatacenterName, netname),
 				"--vch=" + conf.ExecutorConfig.Name,
 			},
 		},

lib/portlayer/exec/config.go

@@ -46,4 +46,8 @@ type Configuration struct {
 
 	// Allow custom naming convention for containerVMs
 	ContainerNameConvention string
+
+	// FIXME: temporary work around for injecting network path of debug nic
+	Networks     map[string]*metadata.NetworkEndpoint `vic:"0.1" scope:"read-only" key:"init/networks"`
+	DebugNetwork object.NetworkReference
 }

lib/portlayer/exec/handle.go

@@ -17,9 +17,9 @@ package exec
 import (
 	"crypto/rand"
 	"encoding/hex"
+	"errors"
 	"fmt"
 	"net"
-	"strings"
 	"sync"
 	"time"
 
@@ -196,6 +196,13 @@ func (h *Handle) Create(ctx context.Context, sess *session.Session, config *Cont
 
 	URI := fmt.Sprintf("tcp://%s:%d", ips[0], serialOverLANPort)
 
+	//FIXME: remove debug network
+	backing, err := Config.DebugNetwork.EthernetCardBackingInfo(ctx)
+	if err != nil {
+		detail := fmt.Sprintf("unable to generate backing info for debug network - this code can be removed once network mapping/dhcp client are available: %s", err)
+		log.Error(detail)
+		return errors.New(detail)
+	}
 	specconfig := &spec.VirtualMachineConfigSpecConfig{
 		// FIXME: hardcoded values
 		NumCPUs:  2,
@@ -211,7 +218,7 @@ func (h *Handle) Create(ctx context.Context, sess *session.Session, config *Cont
 		// FIXME: hardcoded value
 		BootMediaPath: sess.Datastore.Path(fmt.Sprintf("%s/bootstrap.iso", config.VCHName)),
 		VMPathName:    fmt.Sprintf("[%s]", sess.Datastore.Name()),
-		NetworkName:   strings.Split(sess.Network.Reference().Value, "-")[1],
+		DebugNetwork:  backing,
 
 		ImageStoreName: config.ImageStoreName,
 

lib/portlayer/portlayer.go

@@ -59,6 +59,22 @@ func Init(ctx context.Context, sess *session.Session) error {
 		return err
 	}
 	exec.Config.ResourcePool = r.(*object.ResourcePool)
+	//FIXME: temporary injection of debug network for debug nic
+	ne := exec.Config.Networks["client"]
+	if ne == nil {
+		detail := fmt.Sprintf("could not get client network reference for debug nic - this code can be removed once network mapping/dhcp client is present")
+		log.Errorf(detail)
+		return err
+	}
+	nr := new(types.ManagedObjectReference)
+	nr.FromString(ne.Network.ID)
+	r, err = f.ObjectReference(ctx, *nr)
+	if err != nil {
+		detail := fmt.Sprintf("could not get client network reference from %s: %s", nr.String(), err)
+		log.Errorf(detail)
+		return err
+	}
+	exec.Config.DebugNetwork = r.(object.NetworkReference)
 
 	extraconfig.Decode(source, &network.Config)
 	log.Debugf("Decoded VCH config for network: %#v", network.Config)

lib/spec/network.go

@@ -62,11 +62,7 @@ func NewVirtualE1000() *types.VirtualE1000 {
 func (s *VirtualMachineConfigSpec) addVirtualNIC(device types.BaseVirtualDevice) *VirtualMachineConfigSpec {
 	device.GetVirtualDevice().Key = s.generateNextKey()
 
-	device.GetVirtualDevice().Backing = &types.VirtualEthernetCardNetworkBackingInfo{
-		VirtualDeviceDeviceBackingInfo: types.VirtualDeviceDeviceBackingInfo{
-			DeviceName: s.NetworkName(),
-		},
-	}
+	device.GetVirtualDevice().Backing = s.DebugNetwork()
 	return s.AddVirtualDevice(device)
 }
 

lib/spec/spec.go

@@ -63,8 +63,8 @@ type VirtualMachineConfigSpecConfig struct {
 	// URI of the network serial port
 	ConnectorURI string
 
-	// Name of the network
-	NetworkName string
+	// Network backing info
+	DebugNetwork types.BaseVirtualDeviceBackingInfo
 
 	// Name of the image store
 	ImageStoreName string
@@ -231,10 +231,10 @@ func (s *VirtualMachineConfigSpec) VMPathName() string {
 }
 
 // NetworkName returns the network name
-func (s *VirtualMachineConfigSpec) NetworkName() string {
+func (s *VirtualMachineConfigSpec) DebugNetwork() types.BaseVirtualDeviceBackingInfo {
 	defer trace.End(trace.Begin(s.config.ID))
 
-	return s.config.NetworkName
+	return s.config.DebugNetwork
 }
 
 // ConnectorURI returns the connector URI

pkg/vsphere/test/test.go

@@ -17,11 +17,12 @@ package test
 import (
 	"fmt"
 	"math/rand"
-	"strings"
 	"testing"
 	"time"
 
+	log "github.com/Sirupsen/logrus"
 	"github.com/vmware/govmomi/object"
+	"github.com/vmware/vic/lib/guest"
 	"github.com/vmware/vic/lib/spec"
 	"github.com/vmware/vic/pkg/vsphere/session"
 	"github.com/vmware/vic/pkg/vsphere/test/env"
@@ -52,18 +53,29 @@ func Session(ctx context.Context, t *testing.T) *session.Session {
 
 // SpecConfig returns a spec.VirtualMachineConfigSpecConfig struct
 func SpecConfig(session *session.Session) *spec.VirtualMachineConfigSpecConfig {
+	backing, err := session.Network.EthernetCardBackingInfo(context.TODO())
+	if err != nil {
+		log.Errorf("unable to get backing info for test network: %s", err)
+		return nil
+	}
+
+	uuid, err := guest.UUID()
+	if err != nil {
+		log.Errorf("unable to get UUID for guest - used for VM name: %s", err)
+		return nil
+	}
 	return &spec.VirtualMachineConfigSpecConfig{
 		NumCPUs:       2,
 		MemoryMB:      2048,
 		VMForkEnabled: true,
 
 		ConnectorURI: "tcp://1.2.3.4:9876",
 
-		ID:            "deadbeef",
+		ID:            uuid,
 		Name:          "zombie_attack",
 		BootMediaPath: session.Datastore.Path("brainz.iso"),
 		VMPathName:    fmt.Sprintf("[%s]", session.Datastore.Name()),
-		NetworkName:   strings.Split(session.Network.Reference().Value, "-")[1],
+		DebugNetwork:  backing,
 	}
 }
 

pkg/vsphere/vm/vm_test.go

@@ -140,10 +140,15 @@ func TestVMAttributes(t *testing.T) {
 	// Wrap the result with our version of VirtualMachine
 	vm := NewVirtualMachine(ctx, session, *moref)
 
+	uuid, err := guest.UUID()
+	if err != nil {
+		t.Fatalf("unable to get UUID for guest - used for VM name: %s", err)
+	}
+
 	if folder, err := vm.FolderName(ctx); err != nil {
 		t.Fatalf("ERROR: %s", err)
 	} else {
-		assert.Equal(t, "deadbeef", folder)
+		assert.Equal(t, uuid, folder)
 	}
 
 	_, err = tasks.WaitForResult(ctx, func(ctx context.Context) (tasks.ResultWaiter, error) {