Skip to content
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

Jump to bottom

Shuffle hardware inventory for tinkerbell before reservation #8264

Merged
merged 2 commits into from
Jul 23, 2024
Merged

Shuffle hardware inventory for tinkerbell before reservation #8264

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ef7112
shuffle hardware inventory for tinkerbell before reservation
Jun 8, 2024
85a4cae
Account for mutexes during shuffle and move it to struct method
Jul 8, 2024
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
11 changes: 11 additions & 0 deletions internal/test/e2e/run.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package e2e

import (
"fmt"
"math/rand"
"os"
"regexp"
"sort"
Expand Down Expand Up @@ -217,6 +218,9 @@ func RunTests(conf instanceRunConf, inventoryCatalogue map[string]*hardwareCatal
} else {
hardwareCatalogue = inventoryCatalogue[nonAirgappedHardware]
}
conf.Logger.Info("Shuffling hardware inventory for tinkerbell")
// shuffle hardware to introduce randomness during hardware reservation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I would expand more on why randomness is desired. We don't do this to introduce randomness, we do this to avoid picking up the same machines on every run. Randomness is just the mechanism to achieve that goal.

shuffleHardwareInventory(hardwareCatalogue)
err = reserveTinkerbellHardware(&conf, hardwareCatalogue)
if err != nil {
return "", nil, err
Expand Down Expand Up @@ -592,3 +596,10 @@ func logTinkerbellTestHardwareInfo(conf *instanceRunConf, action string) {
}
conf.Logger.V(1).Info(action+" hardware for TestRunner", "hardwarePool", strings.Join(hardwareInfo, ", "))
}

func shuffleHardwareInventory(invCatalogue *hardwareCatalogue) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: why the use of inventory and catalogue? aren't they representing the same thing?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not make this a method in hardwareCatalogue? It's manipulating the internal extructure, it seems like a good idea to abstract that in a method instead of exposing it like this.

I fact, don't you need to use the mutex? If I'm not mistaken the hardwareCatalogue is shared between runner threads and all of them are going to try to call this method concurrently.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! I should have seen this.

random := rand.New(rand.NewSource(time.Now().UnixNano()))
random.Shuffle(len(invCatalogue.hws), func(i, j int) {
invCatalogue.hws[i], invCatalogue.hws[j] = invCatalogue.hws[j], invCatalogue.hws[i]
})
}
Loading