Merge with latest Unit test helpers

Author: nagadeesh-nagaraja

bmc/mockup.go

@@ -3,18 +3,29 @@
 
 package bmc
 
+import "github.com/stmcginnis/gofish/redfish"
+
 // RedfishLocalBMC is an implementation of the BMC interface for Redfish.
 type RedfishMockUps struct {
 	BIOSSettingAttr    map[string]map[string]any
 	PendingBIOSSetting map[string]map[string]any
+
+	BMCSettingAttr    map[string]map[string]any
+	PendingBMCSetting map[string]map[string]any
 }
 
 func (r *RedfishMockUps) InitializeDefaults() {
 	r.BIOSSettingAttr = map[string]map[string]any{
 		"abc":       {"type": "string", "reboot": false, "value": "bar"},
 		"fooreboot": {"type": "integer", "reboot": true, "value": 123},
 	}
+	r.BMCSettingAttr = map[string]map[string]any{
+		"abc":       {"type": redfish.StringAttributeType, "reboot": false, "value": "bar"},
+		"fooreboot": {"type": redfish.IntegerAttributeType, "reboot": true, "value": 123},
+	}
 	r.PendingBIOSSetting = map[string]map[string]any{}
+
+	r.PendingBMCSetting = map[string]map[string]any{}
 }
 
 func (r *RedfishMockUps) ResetBIOSSettings() {
@@ -29,6 +40,18 @@ func (r *RedfishMockUps) ResetPendingBIOSSetting() {
 	r.PendingBIOSSetting = map[string]map[string]any{}
 }
 
+func (r *RedfishMockUps) ResetPendingBMCSetting() {
+	r.PendingBMCSetting = map[string]map[string]any{}
+}
+
+func (r *RedfishMockUps) ResetBMCSettings() {
+	r.BMCSettingAttr = map[string]map[string]any{
+		"abc":       {"type": redfish.StringAttributeType, "reboot": false, "value": "bar"},
+		"fooreboot": {"type": redfish.IntegerAttributeType, "reboot": true, "value": 123},
+	}
+	r.PendingBMCSetting = map[string]map[string]any{}
+}
+
 func InitMockUp() {
 	UnitTestMockUps = &RedfishMockUps{}
 	UnitTestMockUps.InitializeDefaults()

bmc/redfish_local.go

@@ -15,13 +15,6 @@ import (
 
 var _ BMC = (*RedfishLocalBMC)(nil)
 
-var defaultMockedBMCSetting = map[string]map[string]any{
-	"abc":       {"type": redfish.StringAttributeType, "reboot": false, "value": "bar"},
-	"fooreboot": {"type": redfish.IntegerAttributeType, "reboot": true, "value": 123},
-}
-
-var PendingMockedBMCSetting = map[string]map[string]any{}
-
 // RedfishLocalBMC is an implementation of the BMC interface for Redfish.
 type RedfishLocalBMC struct {
 	*RedfishBMC
@@ -211,20 +204,18 @@ func (r *RedfishLocalBMC) ResetManager(ctx context.Context, UUID string, resetTy
 
 	// mock the bmc update here with timed delay
 	go func() {
-		if len(PendingMockedBMCSetting) > 0 {
-			time.Sleep(1 * time.Second)
-			for key, data := range PendingMockedBMCSetting {
-				if _, ok := defaultMockedBMCSetting[key]; ok {
-					defaultMockedBMCSetting[key] = data
+		if len(UnitTestMockUps.PendingBMCSetting) > 0 {
+			time.Sleep(150 * time.Millisecond)
+			for key, data := range UnitTestMockUps.PendingBMCSetting {
+				if _, ok := UnitTestMockUps.BMCSettingAttr[key]; ok {
+					UnitTestMockUps.BMCSettingAttr[key] = data
 				}
 			}
-			PendingMockedBMCSetting = map[string]map[string]any{}
-			r.StoredBMCSettingData = defaultMockedBMCSetting
+			UnitTestMockUps.ResetPendingBMCSetting()
 		}
 	}()
 
 	return nil
-
 }
 
 // mock SetBiosAttributesOnReset sets given bios attributes for unit testing.
@@ -237,39 +228,25 @@ func (r *RedfishLocalBMC) SetBMCAttributesImediately(
 	for name, value := range attributes {
 		attrs[name] = value
 	}
-	if len(defaultMockedBMCSetting) == 0 {
-		defaultMockedBMCSetting = map[string]map[string]any{}
-	}
 
 	for key, attrData := range attributes {
-		if AttributesData, ok := defaultMockedBMCSetting[key]; ok {
+		if AttributesData, ok := UnitTestMockUps.BMCSettingAttr[key]; ok {
 			if reboot, ok := AttributesData["reboot"]; ok && !reboot.(bool) {
 				// if reboot not needed, set the attribute immediately.
 				AttributesData["value"] = attrData
 			} else {
 				// if reboot needed, set the attribute at next power on.
-				PendingMockedBMCSetting[key] = map[string]any{
+				UnitTestMockUps.PendingBMCSetting[key] = map[string]any{
 					"type":   AttributesData["type"],
 					"reboot": AttributesData["reboot"],
 					"value":  attrData,
 				}
 			}
 		}
 	}
-	r.StoredBMCSettingData = defaultMockedBMCSetting
-
 	return nil
 }
 
-func (r *RedfishLocalBMC) getMockedBMCSettingData() map[string]map[string]any {
-
-	if len(r.StoredBMCSettingData) > 0 {
-		return r.StoredBMCSettingData
-	}
-	return defaultMockedBMCSetting
-
-}
-
 func (r *RedfishLocalBMC) GetBMCAttributeValues(
 	ctx context.Context,
 	UUID string,
@@ -278,21 +255,17 @@ func (r *RedfishLocalBMC) GetBMCAttributeValues(
 	result redfish.SettingsAttributes,
 	err error,
 ) {
-
 	if len(attributes) == 0 {
 		return
 	}
-
-	mockedAttributes := r.getMockedBMCSettingData()
-
 	filteredAttr, err := r.getFilteredBMCRegistryAttributes(false, false)
 	if err != nil {
 		return
 	}
 	result = make(redfish.SettingsAttributes, len(attributes))
 	for _, name := range attributes {
 		if _, ok := filteredAttr[name]; ok {
-			if AttributesData, ok := mockedAttributes[name]; ok {
+			if AttributesData, ok := UnitTestMockUps.BMCSettingAttr[name]; ok {
 				result[name] = AttributesData["value"]
 			}
 		}
@@ -307,13 +280,13 @@ func (r *RedfishLocalBMC) GetBMCPendingAttributeValues(
 	redfish.SettingsAttributes,
 	error,
 ) {
-	if len(PendingMockedBMCSetting) == 0 {
+	if len(UnitTestMockUps.PendingBMCSetting) == 0 {
 		return redfish.SettingsAttributes{}, nil
 	}
 
-	result := make(redfish.SettingsAttributes, len(PendingMockedBMCSetting))
+	result := make(redfish.SettingsAttributes, len(UnitTestMockUps.PendingBMCSetting))
 
-	for key, data := range PendingMockedBMCSetting {
+	for key, data := range UnitTestMockUps.PendingBMCSetting {
 		result[key] = data["value"]
 	}
 
@@ -327,12 +300,11 @@ func (r *RedfishLocalBMC) getFilteredBMCRegistryAttributes(
 	filtered map[string]redfish.Attribute,
 	err error,
 ) {
-	mockedAttributes := r.getMockedBMCSettingData()
 	filtered = make(map[string]redfish.Attribute)
-	if len(mockedAttributes) == 0 {
+	if len(UnitTestMockUps.BMCSettingAttr) == 0 {
 		return filtered, fmt.Errorf("no bmc setting attributes found")
 	}
-	for name, AttributesData := range mockedAttributes {
+	for name, AttributesData := range UnitTestMockUps.BMCSettingAttr {
 		data := redfish.Attribute{}
 		data.AttributeName = name
 		data.Immutable = immutable

internal/controller/biossettings_controller_test.go

@@ -16,8 +16,6 @@ import (
 
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-
-	"github.com/ironcore-dev/metal-operator/bmc"
 )
 
 var _ = Describe("BIOSSettings Controller", func() {
@@ -256,7 +254,7 @@ var _ = Describe("BIOSSettings Controller", func() {
 			metautils.SetAnnotation(serverClaim, metalv1alpha1.ServerMaintenanceApprovalKey, "true")
 		})).Should(Succeed())
 
-		By("Ensuring that the biosSettings resource has started bios setting updated")
+		By("Ensuring that the biosSettings resource has started bios setting update")
 		Eventually(Object(biosSettings)).Should(SatisfyAll(
 			HaveField("Status.State", metalv1alpha1.BIOSSettingsStateInProgress),
 			HaveField("Status.UpdateSettingState", metalv1alpha1.BIOSSettingUpdateState("")),
@@ -365,7 +363,7 @@ var _ = Describe("BIOSSettings Controller", func() {
 			metautils.SetAnnotation(serverClaim, metalv1alpha1.ServerMaintenanceApprovalKey, "true")
 		})).Should(Succeed())
 
-		By("Ensuring that the biosSettings resource has started bios setting updated")
+		By("Ensuring that the biosSettings resource has started bios setting update")
 		Eventually(Object(biosSettings)).Should(SatisfyAll(
 			HaveField("Status.State", metalv1alpha1.BIOSSettingsStateInProgress),
 			HaveField("Status.UpdateSettingState", metalv1alpha1.BIOSSettingUpdateState("")),
@@ -447,7 +445,7 @@ var _ = Describe("BIOSSettings Controller", func() {
 				Name:      biosSettings.Name,
 			},
 		}
-		checkServerMaintenanceGranted(serverMaintenance, server)
+		Eventually(Get(serverMaintenance)).Should(Succeed())
 
 		By("Ensuring that the Maintenance resource has been referenced by biosSettings")
 		Eventually(Object(biosSettings)).Should(SatisfyAny(

internal/controller/bmcsettings_controller_test.go

@@ -81,7 +81,7 @@ var _ = Describe("BMCSettings Controller", func() {
 
 	AfterEach(func(ctx SpecContext) {
 		DeleteAllMetalResources(ctx, ns.Name)
-		bmcPkg.PendingMockedBMCSetting = map[string]map[string]any{}
+		bmcPkg.UnitTestMockUps.ResetBMCSettings()
 	})
 
 	It("should successfully patch BMCSettings reference to referred BMC", func(ctx SpecContext) {
@@ -208,7 +208,8 @@ var _ = Describe("BMCSettings Controller", func() {
 
 		// put server in reserved state. and create a bmc setting in Ownerapproved which needs reboot.
 		// this is needed to check the states traversed.
-		serverClaim := transitionServerToReserved(ctx, ns, server, metalv1alpha1.PowerOff)
+		serverClaim := BuildServerClaim(ctx, k8sClient, *server, ns.Name, nil, metalv1alpha1.PowerOff, "foo:bar")
+		TransistionServerToReserveredState(ctx, k8sClient, serverClaim, server, ns.Name)
 
 		By("Creating a BMCSetting")
 		bmcSettings := &metalv1alpha1.BMCSettings{
@@ -360,7 +361,7 @@ var _ = Describe("BMCSettings Controller", func() {
 				Name:      fmt.Sprintf("%s-%s", BMCSettings.Name, server.Name),
 			},
 		}
-		checkServerMaintenanceGranted(serverMaintenance, server)
+		Eventually(Get(serverMaintenance)).Should(Succeed())
 
 		By("Ensuring that the BMCSettings resource hasmoved to next state")
 		Eventually(Object(BMCSettings)).Should(SatisfyAny(