feat: add more useful util funcs

Author: avirtopeanu-ionos

shared/fileconfiguration/fileconfiguration.go

@@ -2,13 +2,39 @@ package fileconfiguration
 
 import (
 	"fmt"
-	"gopkg.in/yaml.v3"
 	"os"
 	"path/filepath"
 
+	"gopkg.in/yaml.v3"
+
 	"github.com/ionos-cloud/sdk-go-bundle/shared"
 )
 
+// Usage:
+//   // Load from default file
+//   cfg, err := fileconfiguration.New("")
+//   // From explicit path:
+//   cfg, err := fileconfiguration.New("/path/to/config")
+//   // From env:
+//   cfg, err := fileconfiguration.NewFromEnv()
+//
+//   // Read profiles list:
+//   profiles := fileconfiguration.ReadProfilesFromFile()
+//   // Switch/get current profile:
+//   prof := cfg.GetCurrentProfile()
+//   // Get environment names:
+//   envs := cfg.GetEnvironmentNames()
+//   // Get profile names:
+//   profs := cfg.GetProfileNames()
+//
+//   // Get endpoint for regionless API:
+//   ep := cfg.GetProductOverrides("psql")
+//   // Get endpoint for region-specific API:
+//   ep := cfg.GetProductLocationOverrides("dns", "de/fra")
+//   // Get endpoint for region-specific API with fallback to global endpoint: (combine the two funcs above)
+//   ep := cfg.GetOverride("dns", "de/fra")
+//   ep := cfg.GetOverride("psql", "")
+
 // products that do not have a location and will override the endpoint that is used globally
 const (
 	Autoscaling             = "autoscaling"
@@ -169,19 +195,51 @@ func NewFromEnv() (*FileConfig, error) {
 	return New(os.Getenv(shared.IonosFilePathEnvVar))
 }
 
+// GetProfileNames returns a list of profile names from the loaded configuration
+func (f *FileConfig) GetProfileNames() []string {
+	names := make([]string, len(f.Profiles))
+	for i, p := range f.Profiles {
+		names[i] = p.Name
+	}
+	return names
+}
+
+// GetEnvironmentNames returns a list of environment names from the loaded configuration
+func (f *FileConfig) GetEnvironmentNames() []string {
+	names := make([]string, len(f.Environments))
+	for i, e := range f.Environments {
+		names[i] = e.Name
+	}
+	return names
+}
+
+// GetOverride returns the endpoint for a specific product and location
+// with fallback to the global endpoint if no location is found.
+//
+// It is a helper function combining GetProductLocationOverrides and GetProductOverrides
+func (f *FileConfig) GetOverride(productName, location string) *Endpoint {
+	if locEp := f.GetProductLocationOverrides(productName, location); locEp != nil {
+		return locEp
+	}
+	if prod := f.GetProductOverrides(productName); prod != nil && len(prod.Endpoints) > 0 {
+		return &prod.Endpoints[0]
+	}
+	return nil
+}
+
 // GetCurrentProfile returns the current profile from the loaded configuration
 // if the current profile is not set, it returns nil
 // if the current profile is set and found in the loaded configuration, it returns the profile
-func (fileConfig *FileConfig) GetCurrentProfile() *Profile {
+func (f *FileConfig) GetCurrentProfile() *Profile {
 	currentProfile := os.Getenv(shared.IonosCurrentProfileEnvVar)
 	if currentProfile == "" {
-		currentProfile = fileConfig.CurrentProfile
+		currentProfile = f.CurrentProfile
 	}
 	if currentProfile == "" {
 		shared.SdkLogger.Printf("[WARN] no current profile set")
 		return nil
 	}
-	for _, profile := range fileConfig.Profiles {
+	for _, profile := range f.Profiles {
 		if profile.Name == currentProfile {
 			if shared.SdkLogLevel.Satisfies(shared.Debug) {
 				shared.SdkLogger.Printf("[DEBUG] using profile %s", profile.Name)
@@ -195,20 +253,20 @@ func (fileConfig *FileConfig) GetCurrentProfile() *Profile {
 	return nil
 }
 
-func (fileConfig *FileConfig) GetEnvForCurrentProfile() string {
-	if fileConfig == nil {
+func (f *FileConfig) GetEnvForCurrentProfile() string {
+	if f == nil {
 		return ""
 	}
-	if currentProfile := fileConfig.GetCurrentProfile(); currentProfile != nil {
+	if currentProfile := f.GetCurrentProfile(); currentProfile != nil {
 		return currentProfile.Environment
 	}
 	return ""
 }
 
 // GetProductOverrides returns the overrides for a specific product for the current environment
 // if no current environment is found, the first environment is used for the product that matches productName is returned
-func (fileConfig *FileConfig) GetProductOverrides(productName string) *Product {
-	if fileConfig == nil {
+func (f *FileConfig) GetProductOverrides(productName string) *Product {
+	if f == nil {
 		return nil
 	}
 	if productName == "" {
@@ -217,8 +275,8 @@ func (fileConfig *FileConfig) GetProductOverrides(productName string) *Product {
 		}
 		return nil
 	}
-	currentEnv := fileConfig.GetEnvForCurrentProfile()
-	for _, environment := range fileConfig.Environments {
+	currentEnv := f.GetEnvForCurrentProfile()
+	for _, environment := range f.Environments {
 		if currentEnv != "" && environment.Name != currentEnv {
 			continue
 		}
@@ -235,11 +293,11 @@ func (fileConfig *FileConfig) GetProductOverrides(productName string) *Product {
 }
 
 // GetProductLocationOverrides returns the overrides for a specific product and location for the current environment
-func (fileConfig *FileConfig) GetProductLocationOverrides(productName, location string) *Endpoint {
-	if fileConfig == nil {
+func (f *FileConfig) GetProductLocationOverrides(productName, location string) *Endpoint {
+	if f == nil {
 		return nil
 	}
-	product := fileConfig.GetProductOverrides(productName)
+	product := f.GetProductOverrides(productName)
 	if product == nil || len(product.Endpoints) == 0 {
 		return nil
 	}