refactor: enhance resource pool handling (#665)

Author: tenthirtyam

builder/vsphere/driver/resource_pool.go

@@ -8,6 +8,7 @@ import (
 	"errors"
 	"fmt"
 	"log"
+	"strings"
 
 	"github.com/vmware/govmomi/find"
 	"github.com/vmware/govmomi/object"
@@ -34,29 +35,47 @@ func (d *VCenterDriver) NewResourcePool(ref *types.ManagedObjectReference) *Reso
 // pool or a vApp if the specified pool is not found. Returns a ResourcePool
 // object or an error if neither the specified nor default pool is accessible.
 func (d *VCenterDriver) FindResourcePool(cluster string, host string, name string) (*ResourcePool, error) {
+	name = strings.TrimSpace(name)
+
 	var res string
 	if cluster != "" {
 		res = cluster
 	} else {
 		res = host
 	}
 
-	resourcePath := fmt.Sprintf("%v/Resources/%v", res, name)
+	var resourcePath string
+	switch {
+	case name == "":
+		resourcePath = fmt.Sprintf("%v/Resources", res)
+	case strings.HasPrefix(name, "/"):
+		resourcePath = name
+	default:
+		resourcePath = fmt.Sprintf("%v/Resources/%v", res, name)
+	}
+
 	p, err := d.Finder.ResourcePool(d.Ctx, resourcePath)
 	if err != nil {
-		log.Printf("[WARN] %s not found. Looking for default resource pool.", resourcePath)
+		log.Printf("[WARN] %s not found. Attempting to use default resource pool.", resourcePath)
+
 		dp, dperr := d.Finder.DefaultResourcePool(d.Ctx)
 		var notFoundError *find.NotFoundError
 		if errors.As(dperr, &notFoundError) {
 			vapp, verr := d.Finder.VirtualApp(d.Ctx, name)
 			if verr != nil {
-				return nil, err
+				return nil, fmt.Errorf("could not resolve '%s': %w", name, verr)
 			}
 			dp = vapp.ResourcePool
+		} else if dperr != nil {
+			return nil, fmt.Errorf("error finding default resource pool: %w", dperr)
 		}
 		p = dp
 	}
 
+	if p == nil {
+		return nil, fmt.Errorf("resource pool '%s' resolved to nil", resourcePath)
+	}
+
 	return &ResourcePool{
 		pool:   p,
 		driver: d,

builder/vsphere/driver/resource_pool_test.go

@@ -17,17 +17,63 @@ func TestVCenterDriver_FindResourcePool(t *testing.T) {
 	}
 	defer sim.Close()
 
-	res, err := sim.driver.FindResourcePool("", "DC0_H0", "")
-	if err != nil {
-		t.Fatalf("unexpected error: '%s'", err)
-	}
-	if res == nil {
-		t.Fatalf("unexpected result: expected '%v', but returned 'nil'", res)
-	}
-	expectedResourcePool := "Resources"
-	if res.pool.Name() != expectedResourcePool {
-		t.Fatalf("unexpected result: expected '%s', but returned '%s'", expectedResourcePool, res.pool.Name())
-	}
+	t.Run("empty name with host", func(t *testing.T) {
+		res, err := sim.driver.FindResourcePool("", "DC0_H0", "")
+		if err != nil {
+			t.Fatalf("unexpected error: '%s'", err)
+		}
+		if res == nil {
+			t.Fatalf("unexpected result: expected resource pool, but returned 'nil'")
+		}
+		expectedResourcePool := "Resources"
+		if res.pool.Name() != expectedResourcePool {
+			t.Fatalf("unexpected result: expected '%s', but returned '%s'", expectedResourcePool, res.pool.Name())
+		}
+	})
+
+	t.Run("empty name with cluster", func(t *testing.T) {
+		res, err := sim.driver.FindResourcePool("DC0_C0", "", "")
+		if err != nil {
+			t.Fatalf("unexpected error: '%s'", err)
+		}
+		if res == nil {
+			t.Fatalf("unexpected result: expected resource pool, but returned 'nil'")
+		}
+		if res.pool.Name() != "Resources" {
+			t.Fatalf("unexpected result: expected 'Resources', but returned '%s'", res.pool.Name())
+		}
+	})
+
+	t.Run("relative path", func(t *testing.T) {
+		res, err := sim.driver.FindResourcePool("DC0_C0", "", "foo")
+
+		if err == nil {
+			t.Fatalf("expected error when using unknown relative resource pool path 'foo', but got none")
+		}
+		if res != nil {
+			t.Fatalf("unexpected result: expected no resource pool for unknown path 'foo', but got one")
+		}
+	})
+
+	t.Run("absolute path", func(t *testing.T) {
+		res, err := sim.driver.FindResourcePool("", "", "/DC0/host/DC0_H0/Resources")
+		if err != nil {
+			t.Fatalf("unexpected error: '%s'", err)
+		}
+		if res == nil || res.pool == nil {
+			t.Fatalf("unexpected result: expected resource pool, but returned 'nil'")
+		}
+	})
+
+	t.Run("whitespace trimming", func(t *testing.T) {
+		res, err := sim.driver.FindResourcePool("", "DC0_H0", "  ")
+		if err != nil {
+			t.Fatalf("unexpected error: '%s'", err)
+		}
+		if res == nil {
+			t.Fatalf("unexpected result: expected resource pool, but returned 'nil'")
+		}
+	})
 }
 
 func TestVCenterDriver_FindResourcePoolStandaloneESX(t *testing.T) {