add test cases for scheduler

Author: sp-yduck

cloud/scheduler/framework/cycle_state.go

@@ -8,6 +8,7 @@ import (
 type CycleState struct {
 	completed bool
 	err       error
+	messages  map[string]string
 	result    SchedulerResult
 }
 
@@ -18,7 +19,7 @@ type SchedulerResult struct {
 }
 
 func NewCycleState() CycleState {
-	return CycleState{completed: false, err: nil}
+	return CycleState{completed: false, err: nil, messages: map[string]string{}}
 }
 
 func (c *CycleState) SetComplete() {
@@ -37,6 +38,14 @@ func (c *CycleState) Error() error {
 	return c.err
 }
 
+func (c *CycleState) SetMessage(pluginName, message string) {
+	c.messages[pluginName] = message
+}
+
+func (c *CycleState) Messages() map[string]string {
+	return c.messages
+}
+
 func (c *CycleState) QEMU() *api.VirtualMachine {
 	return c.result.instance.VM
 }

cloud/scheduler/framework/suite_test.go

@@ -0,0 +1,45 @@
+package framework_test
+
+import (
+	"os"
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	"github.com/sp-yduck/proxmox-go/proxmox"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+)
+
+var (
+	proxmoxSvc *proxmox.Service
+)
+
+func TestFrameworks(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Scheduler Framework Suite")
+}
+
+var _ = BeforeSuite(func() {
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
+
+	if GinkgoLabelFilter() != "unit" {
+		By("setup proxmox client to do integration test")
+		url := os.Getenv("PROXMOX_URL")
+		user := os.Getenv("PROXMOX_USER")
+		password := os.Getenv("PROXMOX_PASSWORD")
+		tokenid := os.Getenv("PROXMOX_TOKENID")
+		secret := os.Getenv("PROXMOX_SECRET")
+
+		authConfig := proxmox.AuthConfig{
+			Username: user,
+			Password: password,
+			TokenID:  tokenid,
+			Secret:   secret,
+		}
+		param := proxmox.NewParams(url, authConfig, proxmox.ClientConfig{InsecureSkipVerify: true})
+		var err error
+		proxmoxSvc, err = proxmox.GetOrCreateService(param)
+		Expect(err).NotTo(HaveOccurred())
+	}
+})

cloud/scheduler/framework/types_test.go

@@ -0,0 +1,21 @@
+package framework_test
+
+import (
+	"context"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/sp-yduck/cluster-api-provider-proxmox/cloud/scheduler/framework"
+)
+
+var _ = Describe("GetNodeInfoList", Label("integration", "framework"), func() {
+	ctx := context.Background()
+
+	It("should not error", func() {
+		nodes, err := framework.GetNodeInfoList(ctx, proxmoxSvc)
+		Expect(err).To(BeNil())
+		Expect(len(nodes)).ToNot(Equal(0))
+	})
+
+})

cloud/scheduler/framework/utils.go

@@ -4,7 +4,8 @@ import "context"
 
 type CtxKey string
 
-// bind map's key-value to context key-value
+// bind map's key-value to context key-value.
+// type of key is translated to CtxKey type
 func ContextWithMap(ctx context.Context, m map[string]string) context.Context {
 	for key, value := range m {
 		ctx = context.WithValue(ctx, CtxKey(key), value)

cloud/scheduler/framework/utils_test.go

@@ -0,0 +1,39 @@
+package framework_test
+
+import (
+	"context"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/sp-yduck/cluster-api-provider-proxmox/cloud/scheduler/framework"
+)
+
+var _ = Describe("ContextWithMap", Label("unit", "framework"), func() {
+	c := context.Background()
+
+	Context("input empty map", func() {
+		It("should not panic", func() {
+			m := map[string]string{}
+			ctx := framework.ContextWithMap(c, m)
+			Expect(ctx).To(Equal(c))
+		})
+	})
+
+	Context("input nil", func() {
+		It("should not panic", func() {
+			ctx := framework.ContextWithMap(c, nil)
+			Expect(ctx).To(Equal(c))
+		})
+	})
+
+	Context("input random map", func() {
+		It("should get map's key-value", func() {
+			m := map[string]string{}
+			m["abc"] = "ABC"
+			ctx := framework.ContextWithMap(c, m)
+			Expect(ctx.Value("abc")).ToNot(Equal("ABC"))
+			Expect(ctx.Value(framework.CtxKey("abc"))).To(Equal("ABC"))
+		})
+	})
+})

cloud/scheduler/plugins/idrange/export_test.go

@@ -0,0 +1,7 @@
+package idrange
+
+import "context"
+
+func FindVMIDRange(ctx context.Context) (int, int, error) {
+	return findVMIDRange(ctx)
+}

cloud/scheduler/plugins/idrange/idrange.go

@@ -31,10 +31,11 @@ func (pl *Range) PluginKey() framework.CtxKey {
 
 // select minimum id being not used in specified range
 // range is specified in ctx value (key=vmid.qemu-scheduler/range)
-func (pl *Range) Select(ctx context.Context, state *framework.CycleState, config api.VirtualMachineCreateOptions, nextid int, usedID map[int]bool) (int, error) {
+func (pl *Range) Select(ctx context.Context, state *framework.CycleState, _ api.VirtualMachineCreateOptions, nextid int, usedID map[int]bool) (int, error) {
 	start, end, err := findVMIDRange(ctx)
 	if err != nil {
-		return 0, nil
+		state.SetMessage(pl.Name(), "no idrange is specified, use nextid.")
+		return nextid, nil
 	}
 	for i := start; i <= end; i++ {
 		_, used := usedID[i]

cloud/scheduler/plugins/idrange/idrange_test.go

@@ -0,0 +1,60 @@
+package idrange_test
+
+import (
+	"context"
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/sp-yduck/cluster-api-provider-proxmox/cloud/scheduler/framework"
+	"github.com/sp-yduck/cluster-api-provider-proxmox/cloud/scheduler/plugins/idrange"
+)
+
+func TestIDRange(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "idrange plugin")
+}
+
+var _ = Describe("findVMIDRange", Label("unit", "plugins"), func() {
+	ctx := context.Background()
+
+	Context("no 'vmid.qemu-scheduler/range' key in the context", func() {
+		It("should error", func() {
+			start, end, err := idrange.FindVMIDRange(ctx)
+			Expect(start).To(Equal(0))
+			Expect(end).To(Equal(0))
+			Expect(err.Error()).To(Equal("no vmid range is specified"))
+		})
+	})
+
+	Context("specify invalid range (start)", func() {
+		It("should error", func() {
+			c := context.WithValue(ctx, framework.CtxKey(idrange.VMIDRangeKey), "a-10")
+			start, end, err := idrange.FindVMIDRange(c)
+			Expect(start).To(Equal(0))
+			Expect(end).To(Equal(0))
+			Expect(err.Error()).To(ContainSubstring("invalid range is specified"))
+		})
+	})
+
+	Context("specify invalid range (end)", func() {
+		It("should error", func() {
+			c := context.WithValue(ctx, framework.CtxKey(idrange.VMIDRangeKey), "10-b")
+			start, end, err := idrange.FindVMIDRange(c)
+			Expect(start).To(Equal(0))
+			Expect(end).To(Equal(0))
+			Expect(err.Error()).To(ContainSubstring("invalid range is specified"))
+		})
+	})
+
+	Context("specify valid range", func() {
+		It("should not error", func() {
+			c := context.WithValue(ctx, framework.CtxKey(idrange.VMIDRangeKey), "10-20")
+			start, end, err := idrange.FindVMIDRange(c)
+			Expect(start).To(Equal(10))
+			Expect(end).To(Equal(20))
+			Expect(err).ToNot(HaveOccurred())
+		})
+	})
+})

cloud/scheduler/plugins/random/random.go

@@ -23,7 +23,8 @@ func (pl *Random) Name() string {
 	return Name
 }
 
-// return random score: 0 <= n < 100
+// return random score: 0 <= n < 100.
+// just a sample plugin
 func (pl *Random) Score(ctx context.Context, state *framework.CycleState, config api.VirtualMachineCreateOptions, nodeInfo *framework.NodeInfo) (int64, *framework.Status) {
 	src := rand.NewSource(time.Now().Unix())
 	r := rand.New(src)

cloud/scheduler/plugins/regex/node_regex.go

@@ -25,10 +25,10 @@ func (pl *NodeRegex) Name() string {
 }
 
 // regex is specified in ctx value (key=node.qemu-scheduler/regex)
-func (pl *NodeRegex) Filter(ctx context.Context, _ *framework.CycleState, config api.VirtualMachineCreateOptions, nodeInfo *framework.NodeInfo) *framework.Status {
+func (pl *NodeRegex) Filter(ctx context.Context, state *framework.CycleState, config api.VirtualMachineCreateOptions, nodeInfo *framework.NodeInfo) *framework.Status {
 	reg, err := findNodeRegex(ctx)
 	if err != nil {
-
+		state.SetMessage(pl.Name(), "no valid regex is specified, skip")
 		return &framework.Status{}
 	}
 	if !reg.MatchString(nodeInfo.Node().Node) {