✨ integrates Dynamic ENUM Metadata within Rules

Summary:
This commit revolutionizes our approach to handling ENUM metadata for
rule input structures by embedding this metadata directly within each
rule's definition. By leveraging the `EnumProvider` interface and
utilizing reflection, we've created a system where rules self-describe
their ENUM fields, enhancing the API's flexibility and maintainability.

The `GetRuleStruct` API endpoint is now capable of dynamically generating
responses that include both the input structure and ENUM options, directly
derived from the rule definitions themselves.

Key Changes:
- **Introduced `EnumProvider` Interface**:
Allows rule structs to define their own ENUM options, centralizing this
information within the rule implementations.

- **Enhanced Rule Descriptors**:
Rule descriptors are streamlined to focus on factory methods and input
struct types, with ENUM metadata being provided by the rules themselves
through the `EnumProvider` interface.

- **Dynamic ENUM Metadata Retrieval**:
The `GetRuleStruct` function dynamically extracts ENUM metadata from
rules that implement the `EnumProvider`, ensuring the API response
includes relevant ENUM options for frontend UI generation.

- **API Response Enhancement**:
Adjusted the API to provide a response that includes the rule's input
structure, possible ENUM values, and the rule instance representation,
all derived dynamically to support extensible and maintainable rule
definitions.

api/rule_handlers.go

@@ -56,24 +56,38 @@ func getHostnameRuleByCategory(category string) (rules.HostnameRule, error) {
 // @Router			/rules/:rule [get]
 func GetRuleStruct(c *gin.Context) {
 	ruleName := c.Param("rule")
-
 	descriptor, exists := rules.RulesRegistry[ruleName]
 	if !exists {
 		c.JSON(http.StatusNotFound, gin.H{"error": "Rule not found"})
 		return
 	}
 
-	// Create instances of the rule and its input struct
+	// Create an instance of the rule struct for output
 	ruleInstance := descriptor.Factory()
-	inputInstance := reflect.New(reflect.TypeOf(ruleInstance).Elem()).Interface()
 
-	// Serialize instances to JSON
+	// Check if the rule instance implements EnumProvider for ENUM metadata
+	enumProvider, implements := ruleInstance.(rules.EnumProvider)
+	var enumInfo map[string][]string
+	if implements {
+		// Retrieve ENUM metadata from the rule instance
+		enumMetadata := enumProvider.EnumOptions()
+		enumInfo = make(map[string][]string)
+		for _, meta := range enumMetadata {
+			enumInfo[meta.FieldName] = meta.Values
+		}
+	}
+
+	// Serialize the rule instance to JSON for output
 	ruleJSON, err := rules.StructToJSON(ruleInstance)
 	if err != nil {
 		c.JSON(http.StatusInternalServerError, gin.H{"error": "Error serializing rule struct"})
 		return
 	}
 
+	// Create an instance of the input struct for serialization
+	inputInstance := reflect.New(descriptor.InputStruct).Elem().Interface()
+
+	// Serialize the input struct instance to JSON
 	inputJSON, err := rules.StructToJSON(inputInstance)
 	if err != nil {
 		c.JSON(http.StatusInternalServerError, gin.H{"error": "Error serializing input struct"})
@@ -81,7 +95,8 @@ func GetRuleStruct(c *gin.Context) {
 	}
 
 	c.JSON(http.StatusOK, gin.H{
-		"input":  inputJSON,
+		"input":  inputJSON, // Input struct with possible ENUM values
-		"output": ruleJSON,
+		"enums":  enumInfo,  // ENUM metadata if available
+		"output": ruleJSON,  // Serialized rule instance
 	})
 }

rules/enum.go

@@ -0,0 +1,25 @@
+// Copyright 2024 Florian Beisel
+//
+// 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 rules
+
+type EnumFieldMetadata struct {
+	FieldName string
+	Values    []string
+}
+
+// EnumProvider interface that rules should implement if they provide enum values.
+type EnumProvider interface {
+	EnumOptions() []EnumFieldMetadata
+}

rules/registry.go

@@ -14,21 +14,26 @@
 
 package rules
 
+import "reflect"
+
 type RuleFactoryFunc func() HostnameRule
 
 type RuleDescriptor struct {
 	Description string
 	Factory     RuleFactoryFunc
+	InputStruct reflect.Type
 }
 
 var RulesRegistry = map[string]RuleDescriptor{
 	"notebook": {
 		Description: "Generates hostnames for notebooks.",
 		Factory:     func() HostnameRule { return &NotebookRule{} },
+		InputStruct: reflect.TypeOf(NotebookRuleInput{}),
 	},
 	"server": {
 		Description: "Generates hostnames for servers.",
 		Factory:     func() HostnameRule { return &ServerRule{} },
+		InputStruct: reflect.TypeOf(ServerRuleInput{}),
 	},
 	// ... other rules ...
 }

rules/server.go

@@ -43,6 +43,16 @@ type ServerRuleInput struct {
 	Responsible string `json:"Responsible"`
 }
 
+func (sr *ServerRule) EnumOptions() []EnumFieldMetadata {
+	return []EnumFieldMetadata{
+		{
+			FieldName: "OrgUnit",
+			Values:    []string{"IDG", "IDE", "SSG"},
+		},
+		// Add more fields as necessary
+	}
+}
+
 // Ensure that ServerRule implements HostnameRule interface
 var _ HostnameRule = &ServerRule{}
 
@@ -108,32 +118,32 @@ func (sr *ServerRule) Generate(params map[string]interface{}) (string, []byte, e
 
 }
 
-//	@Summary		Generate hostname for category "notebook"
+// @Summary		Generate hostname for category "notebook"
-//	@Description	Generates a hostname for a notebook based on dynamic rules.
+// @Description	Generates a hostname for a notebook based on dynamic rules.
-//	@ID				insert-server-hostname
+// @ID				insert-server-hostname
-//	@Accept			json
+// @Accept			json
-//	@Produce		json
+// @Produce		json
-//	@Tags			Generating Hostnames
+// @Tags			Generating Hostnames
-//	@Param			body	body		ServerRuleInput					true	"Input data to generate hostname"
+// @Param			body	body		ServerRuleInput					true	"Input data to generate hostname"
-//	@Success		200		{object}	models.SimpleHostnameResponse	"Hostname"
+// @Success		200		{object}	models.SimpleHostnameResponse	"Hostname"
-//	@Router			/api/server [post]
+// @Router			/api/server [post]
-//	@Security		Bearer
+// @Security		Bearer
 func (nr *ServerRule) Insert(category string, params map[string]interface{}) (string, error) {
 	// Generate the hostname
 
 	return nr.baseInsert(nr, category, params)
 }
 
-//	@Summary		Update hostname for category "notebook"
+// @Summary		Update hostname for category "notebook"
-//	@Description	Generates a new hostname for a notebook based on dynamic rules.
+// @Description	Generates a new hostname for a notebook based on dynamic rules.
-//	@ID				update-server-hostname
+// @ID				update-server-hostname
-//	@Accept			json
+// @Accept			json
-//	@Produce		json
+// @Produce		json
-//	@Tags			Manipulate existing Hostnames
+// @Tags			Manipulate existing Hostnames
-//	@Param			body	body		ServerRuleInput					true	"Input data to generate hostname"
+// @Param			body	body		ServerRuleInput					true	"Input data to generate hostname"
-//	@Success		200		{object}	models.SimpleHostnameResponse	"Hostname"
+// @Success		200		{object}	models.SimpleHostnameResponse	"Hostname"
-//	@Router			/api/server [put]
+// @Router			/api/server [put]
-//	@Security		Bearer
+// @Security		Bearer
 func (nr *ServerRule) Update(category string, oldhostname string, params map[string]interface{}) (string, error) {
 	return nr.baseUpdate(nr, category, oldhostname, params)
 }