Skip to content

Update ConfigureRegion for new global OAS server format #356

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
merged 1 commit into from
Mar 20, 2024
Merged

Update ConfigureRegion for new global OAS server format #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions core/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ import (
"github.com/stackitcloud/stackit-sdk-go/core/clients"
)

const (
global = "global"
)

// contextKeys are used to identify the type of value in the context.
// Since these are string, it is possible to get a short description of the
// context key for logging and debugging using key.String().
Expand Down Expand Up @@ -480,12 +484,12 @@ func ConfigureRegion(cfg *Configuration) error {
}

if cfg.Region == "" {
// Check token
// Check region
envVarRegion, _ := os.LookupEnv("STACKIT_REGION")
cfg.Region = envVarRegion
}

if oasRegion.DefaultValue != "" {
if oasRegion.DefaultValue != "" && oasRegion.DefaultValue != global {
if cfg.Region == "" {
return fmt.Errorf("no region was provided, available regions are: %s", availableRegions)
}
Expand All @@ -503,7 +507,9 @@ func ConfigureRegion(cfg *Configuration) error {
// Region is not available.
return fmt.Errorf("the provided region is not available for this API, available regions are: %s", availableRegions)
}
// Global API. The provided region is ignored
// Global API. The provided region is ignored.
// If the url is a template, generated using deprecated config.json, the region variable is replaced
// If the url is already configured, there is no region variable and it remains the same
cfgUrl := strings.Replace(servers[0].URL, "{region}", "", -1)
cfg.Servers = ServerConfigurations{
{
Expand Down
52 changes: 50 additions & 2 deletions core/config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func TestConfigureRegion(t *testing.T) {
isValid: true,
},
{
desc: "valid_global",
desc: "valid_deprecated_global",
cfg: &Configuration{
Region: "",
Servers: ServerConfigurations{
Expand All @@ -65,7 +65,55 @@ func TestConfigureRegion(t *testing.T) {
isValid: true,
},
{
desc: "valid_global_with_specified_region",
desc: "valid_global_empty_default",
cfg: &Configuration{
Region: "",
Servers: ServerConfigurations{
ServerConfiguration{
URL: "https://some-api.api.stackit.cloud",
Variables: map[string]ServerVariable{
"region": {
DefaultValue: "",
EnumValues: []string{},
},
},
},
},
},
regionEnvVar: "",
expectedServers: ServerConfigurations{
ServerConfiguration{
URL: "https://some-api.api.stackit.cloud",
},
},
isValid: true,
},
{
desc: "valid_global_default",
cfg: &Configuration{
Region: "",
Servers: ServerConfigurations{
ServerConfiguration{
URL: "https://some-api.api.stackit.cloud",
Variables: map[string]ServerVariable{
"region": {
DefaultValue: "global",
EnumValues: []string{},
},
},
},
},
},
regionEnvVar: "",
expectedServers: ServerConfigurations{
ServerConfiguration{
URL: "https://some-api.api.stackit.cloud",
},
},
isValid: true,
},
{
desc: "valid_deprecated_global_with_specified_region",
cfg: &Configuration{
Region: "eu01",
Servers: ServerConfigurations{
Expand Down