Merge pull request #30830 from sgoveas/bm_util

NO-JIRA: Add a singleton instance for list of nodes

Author: openshift-merge-bot[bot]

test/extended/util/compat_otp/upibaremetalrdu_client.go

@@ -1,13 +1,18 @@
 package compat_otp
 
 import (
+	"bytes"
 	"context"
 	"fmt"
+	"os"
+	"path/filepath"
+	"sync"
 	"time"
 
 	"github.com/gebn/bmc"
 	"github.com/gebn/bmc/pkg/ipmi"
 	o "github.com/onsi/gomega"
+	"gopkg.in/yaml.v3"
 	e2e "k8s.io/kubernetes/test/e2e/framework"
 )
 
@@ -16,6 +21,17 @@ const (
 	BMPoweredOff = "poweredoff"
 )
 
+// RDU2Hosts holds the collection of RDU2 hosts and provides methods to manage them
+type RDU2Hosts struct {
+	hostsMap map[string]*RDU2Host
+	mu       sync.RWMutex
+}
+
+var (
+	rdu2HostsSingleton *RDU2Hosts
+	singletonMu        sync.Mutex
+)
+
 // RDU2Host models the RDU2 host (partial representation)
 type RDU2Host struct {
 	Name             string `yaml:"name"`
@@ -25,6 +41,87 @@ type RDU2Host struct {
 	BmcForwardedPort uint16 `yaml:"bmc_forwarded_port"`
 	Host             string `yaml:"host"`
 	JumpHost         string `yaml:"-"`
+	MacAddress       string `yaml:"mac"`
+	RedfishScheme    string `yaml:"redfish_scheme"`
+	RedfishBaseURI   string `yaml:"redfish_base_uri"`
+}
+
+// newRDU2Hosts creates a new RDU2Hosts instance by reading the hosts.yaml file
+func newRDU2Hosts() (*RDU2Hosts, error) {
+	sharedDir := os.Getenv("SHARED_DIR")
+	if sharedDir == "" {
+		return nil, fmt.Errorf("SHARED_DIR is not set")
+	}
+	hostsFilePath := filepath.Join(sharedDir, "hosts.yaml")
+
+	yamlBytes, err := os.ReadFile(hostsFilePath)
+	if err != nil {
+		return nil, fmt.Errorf("failed to read hosts.yaml: %w", err)
+	}
+
+	// Unmarshal the yaml into a slice of RDU2Host objects
+	var hostsData []RDU2Host
+	dec := yaml.NewDecoder(bytes.NewReader(yamlBytes))
+	dec.KnownFields(true)
+	err = dec.Decode(&hostsData)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse hosts.yaml: %w", err)
+	}
+
+	if len(hostsData) == 0 {
+		return nil, fmt.Errorf("hosts.yaml contains no hosts")
+	}
+
+	// Convert slice to map of name to RDU2Host objects to allow lookup by name
+	hostsMap := make(map[string]*RDU2Host, len(hostsData))
+	for i := range hostsData {
+		if hostsData[i].Name == "" {
+			return nil, fmt.Errorf("hosts.yaml entry at index %d has empty name", i)
+		}
+		if _, exists := hostsMap[hostsData[i].Name]; exists {
+			return nil, fmt.Errorf("duplicate host name %q in hosts.yaml", hostsData[i].Name)
+		}
+		hostsMap[hostsData[i].Name] = &hostsData[i]
+	}
+
+	return &RDU2Hosts{
+		hostsMap: hostsMap,
+	}, nil
+}
+
+// copyMap returns a deep copy of the hosts map to prevent external modifications
+func (r *RDU2Hosts) copyMap() map[string]*RDU2Host {
+	r.mu.RLock()
+	defer r.mu.RUnlock()
+
+	hostsCopy := make(map[string]*RDU2Host, len(r.hostsMap))
+	for k, v := range r.hostsMap {
+		if v == nil {
+			hostsCopy[k] = nil
+			continue
+		}
+		hostCopy := *v
+		hostsCopy[k] = &hostCopy
+	}
+	return hostsCopy
+}
+
+// GetRDU2HostsList returns the singleton instance of RDU2Hosts map
+// It initializes the singleton on first call by reading the hosts.yaml file
+// Returns a copy of the map to prevent external modifications
+func GetRDU2HostsList() (map[string]*RDU2Host, error) {
+	singletonMu.Lock()
+	defer singletonMu.Unlock()
+	if rdu2HostsSingleton != nil {
+		return rdu2HostsSingleton.copyMap(), nil
+	}
+
+	s, err := newRDU2Hosts()
+	if err != nil {
+		return nil, err
+	}
+	rdu2HostsSingleton = s
+	return s.copyMap(), nil
 }
 
 // StopUPIbaremetalInstance power off the BM machine