Skip to content

Factor out common test helpers into own file and remove flakiness #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
afritzler merged 10 commits into from
May 23, 2025
Merged

Factor out common test helpers into own file and remove flakiness #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2aa1cf7
Unit Test helpers
nagadeesh-nagaraja May 14, 2025
a392644
Unit Test helpers 2
nagadeesh-nagaraja May 15, 2025
539812a
Test helper 3
nagadeesh-nagaraja May 15, 2025
cfa2275
Test helper 4
nagadeesh-nagaraja May 16, 2025
33b4011
Test helper 5, reduce calls to redfishmock
nagadeesh-nagaraja May 19, 2025
59b0044
Update unit test to use Mockups
nagadeesh-nagaraja May 20, 2025
6fe1fba
revert unit test mockup call reductions
nagadeesh-nagaraja May 21, 2025
e141842
Update the claimServer eventHandler for serverClaimRef
nagadeesh-nagaraja May 22, 2025
fdd60a7
Review comments 1
nagadeesh-nagaraja May 22, 2025
fbb24a5
Remove extended timeout in serverClaim and update resource name
nagadeesh-nagaraja May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions bmc/mockup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// SPDX-FileCopyrightText: 2025 SAP SE or an SAP affiliate company and IronCore contributors
// SPDX-License-Identifier: Apache-2.0

package bmc

// 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
}

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.PendingBIOSSetting = map[string]map[string]any{}
}

func (r *RedfishMockUps) ResetBIOSSettings() {
r.BIOSSettingAttr = map[string]map[string]any{
"abc": {"type": "string", "reboot": false, "value": "bar"},
"fooreboot": {"type": "integer", "reboot": true, "value": 123},
}
r.PendingBIOSSetting = map[string]map[string]any{}
}

func (r *RedfishMockUps) ResetPendingBIOSSetting() {
r.PendingBIOSSetting = map[string]map[string]any{}
}

func InitMockUp() {
UnitTestMockUps = &RedfishMockUps{}
UnitTestMockUps.InitializeDefaults()
}

var UnitTestMockUps *RedfishMockUps
115 changes: 54 additions & 61 deletions bmc/redfish_local.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,17 @@ package bmc
import (
"context"
"fmt"
"time"

"github.com/stmcginnis/gofish/redfish"
ctrl "sigs.k8s.io/controller-runtime"
)

var _ BMC = (*RedfishLocalBMC)(nil)

var defaultMockedBIOSSetting = map[string]map[string]any{
"abc": {"type": "string", "reboot": false, "value": "bar"},
"fooreboot": {"type": "integer", "reboot": true, "value": 123},
}

var pendingMockedBIOSSetting = map[string]map[string]any{}

// RedfishLocalBMC is an implementation of the BMC interface for Redfish.
type RedfishLocalBMC struct {
*RedfishBMC
StoredBIOSSettingData map[string]map[string]any
StoredBMCSettingData map[string]map[string]any
}

// NewRedfishLocalBMCClient creates a new RedfishLocalBMC with the given connection details.
Expand All @@ -39,40 +32,57 @@ func NewRedfishLocalBMCClient(
}

func (r RedfishLocalBMC) PowerOn(ctx context.Context, systemUUID string) error {
system, err := r.getSystemByUUID(ctx, systemUUID)
if err != nil {
return fmt.Errorf("failed to get system: %w", err)
}
system.PowerState = redfish.OnPowerState
systemURI := fmt.Sprintf("/redfish/v1/Systems/%s", system.ID)
if err := system.Patch(systemURI, system); err != nil {
return fmt.Errorf("failed to set power state %s for system %s: %w", redfish.OnPowerState, systemUUID, err)
}

// mock the bmc update here
if len(pendingMockedBIOSSetting) > 0 {
go func() {
time.Sleep(250 * time.Millisecond)
system, err := r.getSystemByUUID(ctx, systemUUID)
if err != nil {
log := ctrl.LoggerFrom(ctx)
log.V(1).Error(err, "failed to get system")
return
}
system.PowerState = redfish.OnPowerState
system.RawData = nil
systemURI := fmt.Sprintf("/redfish/v1/Systems/%s", system.ID)
if err := system.Patch(systemURI, system); err != nil {
log := ctrl.LoggerFrom(ctx)
log.V(1).Error(err, "failed to Patch system to power on", "systemUUID", systemUUID)
return
}

for key, data := range pendingMockedBIOSSetting {
if _, ok := defaultMockedBIOSSetting[key]; ok {
defaultMockedBIOSSetting[key] = data
// mock the bmc update here
if len(UnitTestMockUps.PendingBIOSSetting) > 0 {
time.Sleep(150 * time.Millisecond)
for key, data := range UnitTestMockUps.PendingBIOSSetting {
if _, ok := UnitTestMockUps.BIOSSettingAttr[key]; ok {
UnitTestMockUps.BIOSSettingAttr[key] = data
}
}
UnitTestMockUps.ResetPendingBIOSSetting()
}
pendingMockedBIOSSetting = map[string]map[string]any{}
r.StoredBIOSSettingData = defaultMockedBIOSSetting
}
}()
return nil
}

func (r RedfishLocalBMC) PowerOff(ctx context.Context, systemUUID string) error {
system, err := r.getSystemByUUID(ctx, systemUUID)
if err != nil {
return fmt.Errorf("failed to get system: %w", err)
}
system.PowerState = redfish.OffPowerState
systemURI := fmt.Sprintf("/redfish/v1/Systems/%s", system.ID)
if err := system.Patch(systemURI, system); err != nil {
return fmt.Errorf("failed to set power state %s for system %s: %w", redfish.OffPowerState, systemUUID, err)
}

go func() {
time.Sleep(250 * time.Millisecond)
system, err := r.getSystemByUUID(ctx, systemUUID)
if err != nil {
log := ctrl.LoggerFrom(ctx)
log.V(1).Error(err, "failed to get system")
return
}
system.PowerState = redfish.OffPowerState
system.RawData = nil
systemURI := fmt.Sprintf("/redfish/v1/Systems/%s", system.ID)
if err := system.Patch(systemURI, system); err != nil {
log := ctrl.LoggerFrom(ctx)
log.V(1).Error(err, "failed to Patch system to power off", "systemUUID", systemUUID)
return
}
}()
return nil
}

Expand All @@ -83,13 +93,13 @@ func (r *RedfishLocalBMC) GetBiosPendingAttributeValues(
redfish.SettingsAttributes,
error,
) {
if len(pendingMockedBIOSSetting) == 0 {
if len(UnitTestMockUps.PendingBIOSSetting) == 0 {
return redfish.SettingsAttributes{}, nil
}

result := make(redfish.SettingsAttributes, len(pendingMockedBIOSSetting))
result := make(redfish.SettingsAttributes, len(UnitTestMockUps.PendingBIOSSetting))

for key, data := range pendingMockedBIOSSetting {
for key, data := range UnitTestMockUps.PendingBIOSSetting {
result[key] = data["value"]
}

Expand All @@ -102,40 +112,26 @@ func (r *RedfishLocalBMC) SetBiosAttributesOnReset(
systemUUID string,
attributes redfish.SettingsAttributes,
) error {
if len(defaultMockedBIOSSetting) == 0 {
defaultMockedBIOSSetting = map[string]map[string]any{}
}

pendingMockedBIOSSetting = map[string]map[string]any{}
UnitTestMockUps.ResetPendingBIOSSetting()
for key, attrData := range attributes {
if AttributesData, ok := defaultMockedBIOSSetting[key]; ok {
if AttributesData, ok := UnitTestMockUps.BIOSSettingAttr[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.
pendingMockedBIOSSetting[key] = map[string]any{
UnitTestMockUps.PendingBIOSSetting[key] = map[string]any{
"type": AttributesData["type"],
"reboot": AttributesData["reboot"],
"value": attrData,
}
}
}
}
r.StoredBIOSSettingData = defaultMockedBIOSSetting

return nil
}

func (r *RedfishLocalBMC) getMockedBIOSSettingData() map[string]map[string]any {

if len(r.StoredBIOSSettingData) > 0 {
return r.StoredBIOSSettingData
}
return defaultMockedBIOSSetting

}

func (r *RedfishLocalBMC) GetBiosAttributeValues(
ctx context.Context,
systemUUID string,
Expand All @@ -149,16 +145,14 @@ func (r *RedfishLocalBMC) GetBiosAttributeValues(
return nil, nil
}

mockedAttributes := r.getMockedBIOSSettingData()

filteredAttr, err := r.getFilteredBiosRegistryAttributes(false, false)
if err != nil {
return nil, err
}
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.BIOSSettingAttr[name]; ok {
result[name] = AttributesData["value"]
}
}
Expand All @@ -173,12 +167,11 @@ func (r *RedfishLocalBMC) getFilteredBiosRegistryAttributes(
map[string]RegistryEntryAttributes,
error,
) {
mockedAttributes := r.getMockedBIOSSettingData()
filtered := make(map[string]RegistryEntryAttributes)
if len(mockedAttributes) == 0 {
if len(UnitTestMockUps.BIOSSettingAttr) == 0 {
return filtered, fmt.Errorf("no bmc setting attributes found")
}
for name, AttributesData := range mockedAttributes {
for name, AttributesData := range UnitTestMockUps.BIOSSettingAttr {
data := RegistryEntryAttributes{}
data.AttributeName = name
data.Immutable = immutable
Expand Down
Loading
Loading