fix plugin-config

Author: sp-yduck

cloud/scheduler/plugins/registry.go

@@ -15,12 +15,12 @@ import (
 )
 
 type PluginConfigs struct {
-	filterPlugins map[string]pluginConfig `yaml:"filters"`
-	scorePlugins  map[string]pluginConfig `yaml:"scores"`
-	vmidPlugins   map[string]pluginConfig `yaml:"vmids"`
+	FilterPlugins map[string]PluginConfig `yaml:"filters,omitempty"`
+	ScorePlugins  map[string]PluginConfig `yaml:"scores,omitempty"`
+	VMIDPlugins   map[string]PluginConfig `yaml:"vmids,omitempty"`
 }
 
-type pluginConfig struct {
+type PluginConfig struct {
 	Enable bool                   `yaml:"enable,omitempty"`
 	Config map[string]interface{} `yaml:"config,omitempty"`
 }
@@ -45,14 +45,14 @@ func (r *PluginRegistry) VMIDPlugins() []framework.VMIDPlugin {
 
 func NewRegistry(configs PluginConfigs) PluginRegistry {
 	r := PluginRegistry{
-		filterPlugins: NewNodeFilterPlugins(configs.filterPlugins),
-		scorePlugins:  NewNodeScorePlugins(configs.scorePlugins),
-		vmidPlugins:   NewVMIDPlugins(configs.vmidPlugins),
+		filterPlugins: NewNodeFilterPlugins(configs.FilterPlugins),
+		scorePlugins:  NewNodeScorePlugins(configs.ScorePlugins),
+		vmidPlugins:   NewVMIDPlugins(configs.VMIDPlugins),
 	}
 	return r
 }
 
-func NewNodeFilterPlugins(config map[string]pluginConfig) []framework.NodeFilterPlugin {
+func NewNodeFilterPlugins(config map[string]PluginConfig) []framework.NodeFilterPlugin {
 	pls := []framework.NodeFilterPlugin{
 		&nodename.NodeName{},
 		&overcommit.CPUOvercommit{},
@@ -70,7 +70,7 @@ func NewNodeFilterPlugins(config map[string]pluginConfig) []framework.NodeFilter
 	return plugins
 }
 
-func NewNodeScorePlugins(config map[string]pluginConfig) []framework.NodeScorePlugin {
+func NewNodeScorePlugins(config map[string]PluginConfig) []framework.NodeScorePlugin {
 	pls := []framework.NodeScorePlugin{
 		&random.Random{},
 		&noderesource.NodeResource{},
@@ -86,7 +86,7 @@ func NewNodeScorePlugins(config map[string]pluginConfig) []framework.NodeScorePl
 	return plugins
 }
 
-func NewVMIDPlugins(config map[string]pluginConfig) []framework.VMIDPlugin {
+func NewVMIDPlugins(config map[string]PluginConfig) []framework.VMIDPlugin {
 	pls := []framework.VMIDPlugin{
 		&idrange.Range{},
 		&regex.Regex{},
@@ -104,7 +104,7 @@ func NewVMIDPlugins(config map[string]pluginConfig) []framework.VMIDPlugin {
 
 // Read config file and unmarshal it to PluginConfig type
 func GetPluginConfigFromFile(path string) (PluginConfigs, error) {
-	config := PluginConfigs{}
+	var config PluginConfigs
 	if path == "" {
 		return config, nil
 	}

cloud/scheduler/plugins/registry_test.go

@@ -0,0 +1,69 @@
+package plugins_test
+
+import (
+	"os"
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/sp-yduck/cluster-api-provider-proxmox/cloud/scheduler/plugins"
+)
+
+func TestPlugins(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Plugins Suite")
+}
+
+var _ = Describe("GetPluginConfigFromFile", Label("unit", "scheduler"), func() {
+	path := "./test-plugin-config.yaml"
+	BeforeEach(func() {
+		content := `scores:
+  Random:
+    enable: false`
+		err := stringToFile(content, path)
+		Expect(err).ToNot(HaveOccurred())
+	})
+
+	AfterEach(func() {
+		err := rm(path)
+		Expect(err).NotTo(HaveOccurred())
+	})
+
+	Context("with empty file path", func() {
+		path := ""
+		It("should not error", func() {
+			config, err := plugins.GetPluginConfigFromFile(path)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(config).To(Equal(plugins.PluginConfigs{}))
+		})
+	})
+
+	Context("with non-empty file path", func() {
+		It("should not error", func() {
+			config, err := plugins.GetPluginConfigFromFile(path)
+			Expect(err).NotTo(HaveOccurred())
+			scores := map[string]plugins.PluginConfig{}
+			scores["Random"] = plugins.PluginConfig{Enable: false}
+			Expect(config).To(Equal(plugins.PluginConfigs{ScorePlugins: scores}))
+		})
+	})
+
+	Context("with wrong file path", func() {
+		It("shold error", func() {
+			path := "./wrong-plugin-config.yaml"
+			config, err := plugins.GetPluginConfigFromFile(path)
+			Expect(err).To(HaveOccurred())
+			Expect(config).To(Equal(plugins.PluginConfigs{}))
+		})
+	})
+})
+
+func stringToFile(str string, path string) error {
+	b := []byte(str)
+	return os.WriteFile(path, b, 0666)
+}
+
+func rm(path string) error {
+	return os.Remove(path)
+}

cloud/scheduler/scheduler.go

@@ -42,6 +42,7 @@ func NewManager(params SchedulerParams) (*Manager, error) {
 		return nil, fmt.Errorf("failed to read plugin config: %v", err)
 	}
 	params.pluginconfigs = config
+	params.Logger.Info(fmt.Sprintf("load plugin config: %v", config))
 	return &Manager{ctx: context.Background(), params: params, table: table}, nil
 }
 

cloud/scheduler/scheduler_test.go

@@ -14,11 +14,29 @@ import (
 )
 
 var _ = Describe("NewManager", Label("unit", "scheduler"), func() {
-	It("should not error", func() {
-		params := scheduler.SchedulerParams{}
-		manager, err := scheduler.NewManager(params)
-		Expect(err).NotTo(HaveOccurred())
-		Expect(manager).NotTo(BeNil())
+	Context("with empty params", func() {
+		It("should not error", func() {
+			params := scheduler.SchedulerParams{}
+			manager, err := scheduler.NewManager(params)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(manager).NotTo(BeNil())
+		})
+	})
+	Context("with only logger", func() {
+		It("should not error", func() {
+			params := scheduler.SchedulerParams{Logger: zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true))}
+			manager, err := scheduler.NewManager(params)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(manager).NotTo(BeNil())
+		})
+	})
+	Context("with plugin-config", func() {
+		It("should not error", func() {
+			params := scheduler.SchedulerParams{PluginConfigFile: ""}
+			manager, err := scheduler.NewManager(params)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(manager).NotTo(BeNil())
+		})
 	})
 })
 

cmd/main.go

@@ -62,7 +62,7 @@ func main() {
 	flag.BoolVar(&enableLeaderElection, "leader-elect", false,
 		"Enable leader election for controller manager. "+
 			"Enabling this will ensure there is only one active controller manager.")
-	flag.StringVar(&pluginConfig, "scheduler-plugin-config", "/etc/qemu-scheduler/plugin-config.yaml", "The config file path for qemu-scheduler plugins")
+	flag.StringVar(&pluginConfig, "scheduler-plugin-config", "", "The config file path for qemu-scheduler plugins")
 	opts := zap.Options{
 		Development: true,
 	}