From 8e1100938d55f41782c06d343082c7d490d73013 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20L=C3=A9one?= Date: Thu, 30 Apr 2020 15:48:23 +0200 Subject: [PATCH] chore: export Scaleway environment variable constants --- scw/client_option_test.go | 26 +++++++++++++------------- scw/config.go | 8 ++++---- scw/config_test.go | 10 +++++----- scw/env.go | 34 +++++++++++++++++----------------- scw/env_test.go | 14 +++++++------- scw/load_config_test.go | 8 ++++---- scw/path.go | 6 +++--- 7 files changed, 53 insertions(+), 53 deletions(-) diff --git a/scw/client_option_test.go b/scw/client_option_test.go index 3ff413538..534019ea6 100644 --- a/scw/client_option_test.go +++ b/scw/client_option_test.go @@ -160,12 +160,12 @@ func TestCombinedClientOptions(t *testing.T) { name: "Complete config file with env variables", env: map[string]string{ "HOME": "{HOME}", - scwAccessKeyEnv: v2ValidAccessKey2, - scwSecretKeyEnv: v2ValidSecretKey2, - scwAPIURLEnv: v2ValidAPIURL2, - scwDefaultOrganizationIDEnv: v2ValidDefaultOrganizationID2, - scwDefaultRegionEnv: v2ValidDefaultRegion2, - scwDefaultZoneEnv: v2ValidDefaultZone2, + ScwAccessKeyEnv: v2ValidAccessKey2, + ScwSecretKeyEnv: v2ValidSecretKey2, + ScwAPIURLEnv: v2ValidAPIURL2, + ScwDefaultOrganizationIDEnv: v2ValidDefaultOrganizationID2, + ScwDefaultRegionEnv: v2ValidDefaultRegion2, + ScwDefaultZoneEnv: v2ValidDefaultZone2, }, files: map[string]string{ ".config/scw/config.yaml": v2CompleteValidConfigFile, @@ -181,13 +181,13 @@ func TestCombinedClientOptions(t *testing.T) { name: "Complete config with active profile env variable and all env variables", env: map[string]string{ "HOME": "{HOME}", - scwActiveProfileEnv: v2ValidProfile, - scwAccessKeyEnv: v2ValidAccessKey, - scwSecretKeyEnv: v2ValidSecretKey, - scwAPIURLEnv: v2ValidAPIURL, - scwDefaultOrganizationIDEnv: v2ValidDefaultOrganizationID, - scwDefaultRegionEnv: v2ValidDefaultRegion, - scwDefaultZoneEnv: v2ValidDefaultZone, + ScwActiveProfileEnv: v2ValidProfile, + ScwAccessKeyEnv: v2ValidAccessKey, + ScwSecretKeyEnv: v2ValidSecretKey, + ScwAPIURLEnv: v2ValidAPIURL, + ScwDefaultOrganizationIDEnv: v2ValidDefaultOrganizationID, + ScwDefaultRegionEnv: v2ValidDefaultRegion, + ScwDefaultZoneEnv: v2ValidDefaultZone, }, files: map[string]string{ ".config/scw/config.yaml": v2CompleteValidConfigFile, diff --git a/scw/config.go b/scw/config.go index f1dd6a914..4c8b0d43a 100644 --- a/scw/config.go +++ b/scw/config.go @@ -227,11 +227,11 @@ func (c *Config) GetProfile(profileName string) (*Profile, error) { // env SCW_PROFILE > config active_profile > config root profile func (c *Config) GetActiveProfile() (*Profile, error) { switch { - case os.Getenv(scwActiveProfileEnv) != "": - logger.Debugf("using active profile from env: %s=%s", scwActiveProfileEnv, os.Getenv(scwActiveProfileEnv)) - return c.GetProfile(os.Getenv(scwActiveProfileEnv)) + case os.Getenv(ScwActiveProfileEnv) != "": + logger.Debugf("using active profile from env: %s=%s", ScwActiveProfileEnv, os.Getenv(ScwActiveProfileEnv)) + return c.GetProfile(os.Getenv(ScwActiveProfileEnv)) case c.ActiveProfile != nil: - logger.Debugf("using active profile from config: active_profile=%s", scwActiveProfileEnv, *c.ActiveProfile) + logger.Debugf("using active profile from config: active_profile=%s", ScwActiveProfileEnv, *c.ActiveProfile) return c.GetProfile(*c.ActiveProfile) default: return &c.Profile, nil diff --git a/scw/config_test.go b/scw/config_test.go index 49b61ec2f..d6cec4cab 100644 --- a/scw/config_test.go +++ b/scw/config_test.go @@ -136,7 +136,7 @@ func TestSaveConfig(t *testing.T) { { name: "Custom-path config", env: map[string]string{ - scwConfigPathEnv: "{HOME}/valid1/test.conf", + ScwConfigPathEnv: "{HOME}/valid1/test.conf", }, files: map[string]string{ "valid1/test.conf": emptyFile, @@ -277,7 +277,7 @@ func TestLoadProfileAndActiveProfile(t *testing.T) { { name: "Custom-path config is empty", // custom config path env: map[string]string{ - scwConfigPathEnv: "{HOME}/valid1/test.conf", + ScwConfigPathEnv: "{HOME}/valid1/test.conf", }, files: map[string]string{ "valid1/test.conf": emptyFile, @@ -286,7 +286,7 @@ func TestLoadProfileAndActiveProfile(t *testing.T) { { name: "Custom-path config with valid V2", env: map[string]string{ - scwConfigPathEnv: "{HOME}/valid3/test.conf", + ScwConfigPathEnv: "{HOME}/valid3/test.conf", }, files: map[string]string{ "valid3/test.conf": v2SimpleValidConfigFile, @@ -389,7 +389,7 @@ func TestLoadProfileAndActiveProfile(t *testing.T) { name: "Complete config with active profile env variable", env: map[string]string{ "HOME": "{HOME}", - scwActiveProfileEnv: v2ValidProfile, + ScwActiveProfileEnv: v2ValidProfile, }, files: map[string]string{ ".config/scw/config.yaml": v2CompleteValidConfigFile, @@ -407,7 +407,7 @@ func TestLoadProfileAndActiveProfile(t *testing.T) { { name: "Err: custom-path config with valid V1", env: map[string]string{ - scwConfigPathEnv: "{HOME}/valid2/test.conf", + ScwConfigPathEnv: "{HOME}/valid2/test.conf", }, files: map[string]string{ "valid2/test.conf": v1ValidConfigFile, diff --git a/scw/env.go b/scw/env.go index 6cb928da9..bbfeee597 100644 --- a/scw/env.go +++ b/scw/env.go @@ -10,16 +10,16 @@ import ( // Environment variables const ( // Up-to-date - scwCacheDirEnv = "SCW_CACHE_DIR" - scwConfigPathEnv = "SCW_CONFIG_PATH" - scwAccessKeyEnv = "SCW_ACCESS_KEY" - scwSecretKeyEnv = "SCW_SECRET_KEY" // #nosec G101 - scwActiveProfileEnv = "SCW_PROFILE" - scwAPIURLEnv = "SCW_API_URL" - scwInsecureEnv = "SCW_INSECURE" - scwDefaultOrganizationIDEnv = "SCW_DEFAULT_ORGANIZATION_ID" - scwDefaultRegionEnv = "SCW_DEFAULT_REGION" - scwDefaultZoneEnv = "SCW_DEFAULT_ZONE" + ScwCacheDirEnv = "SCW_CACHE_DIR" + ScwConfigPathEnv = "SCW_CONFIG_PATH" + ScwAccessKeyEnv = "SCW_ACCESS_KEY" + ScwSecretKeyEnv = "SCW_SECRET_KEY" // #nosec G101 + ScwActiveProfileEnv = "SCW_PROFILE" + ScwAPIURLEnv = "SCW_API_URL" + ScwInsecureEnv = "SCW_INSECURE" + ScwDefaultOrganizationIDEnv = "SCW_DEFAULT_ORGANIZATION_ID" + ScwDefaultRegionEnv = "SCW_DEFAULT_REGION" + ScwDefaultZoneEnv = "SCW_DEFAULT_ZONE" // All deprecated (cli&terraform) terraformAccessKeyEnv = "SCALEWAY_ACCESS_KEY" // used both as access key and secret key @@ -56,22 +56,22 @@ const ( func LoadEnvProfile() *Profile { p := &Profile{} - accessKey, _, envExist := getEnv(scwAccessKeyEnv, terraformAccessKeyEnv) + accessKey, _, envExist := getEnv(ScwAccessKeyEnv, terraformAccessKeyEnv) if envExist { p.AccessKey = &accessKey } - secretKey, _, envExist := getEnv(scwSecretKeyEnv, cliSecretKeyEnv, terraformSecretKeyEnv, terraformAccessKeyEnv) + secretKey, _, envExist := getEnv(ScwSecretKeyEnv, cliSecretKeyEnv, terraformSecretKeyEnv, terraformAccessKeyEnv) if envExist { p.SecretKey = &secretKey } - apiURL, _, envExist := getEnv(scwAPIURLEnv) + apiURL, _, envExist := getEnv(ScwAPIURLEnv) if envExist { p.APIURL = &apiURL } - insecureValue, envKey, envExist := getEnv(scwInsecureEnv, cliTLSVerifyEnv) + insecureValue, envKey, envExist := getEnv(ScwInsecureEnv, cliTLSVerifyEnv) if envExist { insecure, err := strconv.ParseBool(insecureValue) if err != nil { @@ -85,18 +85,18 @@ func LoadEnvProfile() *Profile { p.Insecure = &insecure } - organizationID, _, envExist := getEnv(scwDefaultOrganizationIDEnv, cliOrganizationEnv, terraformOrganizationEnv) + organizationID, _, envExist := getEnv(ScwDefaultOrganizationIDEnv, cliOrganizationEnv, terraformOrganizationEnv) if envExist { p.DefaultOrganizationID = &organizationID } - region, _, envExist := getEnv(scwDefaultRegionEnv, cliRegionEnv, terraformRegionEnv) + region, _, envExist := getEnv(ScwDefaultRegionEnv, cliRegionEnv, terraformRegionEnv) if envExist { region = v1RegionToV2(region) p.DefaultRegion = ®ion } - zone, _, envExist := getEnv(scwDefaultZoneEnv) + zone, _, envExist := getEnv(ScwDefaultZoneEnv) if envExist { p.DefaultZone = &zone } diff --git a/scw/env_test.go b/scw/env_test.go index 404b91a98..e46533d9d 100644 --- a/scw/env_test.go +++ b/scw/env_test.go @@ -25,13 +25,13 @@ func TestLoadEnvProfile(t *testing.T) { { name: "No config with env variables", env: map[string]string{ - scwAccessKeyEnv: v2ValidAccessKey, - scwSecretKeyEnv: v2ValidSecretKey, - scwAPIURLEnv: v2ValidAPIURL, - scwInsecureEnv: "false", - scwDefaultOrganizationIDEnv: v2ValidDefaultOrganizationID, - scwDefaultRegionEnv: v2ValidDefaultRegion, - scwDefaultZoneEnv: v2ValidDefaultZone, + ScwAccessKeyEnv: v2ValidAccessKey, + ScwSecretKeyEnv: v2ValidSecretKey, + ScwAPIURLEnv: v2ValidAPIURL, + ScwInsecureEnv: "false", + ScwDefaultOrganizationIDEnv: v2ValidDefaultOrganizationID, + ScwDefaultRegionEnv: v2ValidDefaultRegion, + ScwDefaultZoneEnv: v2ValidDefaultZone, }, expectedAccessKey: s(v2ValidAccessKey), expectedSecretKey: s(v2ValidSecretKey), diff --git a/scw/load_config_test.go b/scw/load_config_test.go index 255333117..97afd8573 100644 --- a/scw/load_config_test.go +++ b/scw/load_config_test.go @@ -29,7 +29,7 @@ func TestLoad(t *testing.T) { { name: "Custom-path config is empty", // custom config path env: map[string]string{ - scwConfigPathEnv: "{HOME}/valid1/test.conf", + ScwConfigPathEnv: "{HOME}/valid1/test.conf", }, files: map[string]string{ "valid1/test.conf": emptyFile, @@ -39,7 +39,7 @@ func TestLoad(t *testing.T) { { name: "Custom-path config with valid V2", env: map[string]string{ - scwConfigPathEnv: "{HOME}/valid3/test.conf", + ScwConfigPathEnv: "{HOME}/valid3/test.conf", }, files: map[string]string{ "valid3/test.conf": v2SimpleValidConfigFile, @@ -89,14 +89,14 @@ func TestLoad(t *testing.T) { { name: "Err: custom-path config does not exist", env: map[string]string{ - scwConfigPathEnv: "{HOME}/fake/test.conf", + ScwConfigPathEnv: "{HOME}/fake/test.conf", }, expectedError: "scaleway-sdk-go: cannot read config file {HOME}/fake/test.conf: no such file or directory", }, { name: "Err: custom-path config with invalid V2", env: map[string]string{ - scwConfigPathEnv: "{HOME}/invalid1/test.conf", + ScwConfigPathEnv: "{HOME}/invalid1/test.conf", }, files: map[string]string{ "invalid1/test.conf": v2SimpleInvalidConfigFile, diff --git a/scw/path.go b/scw/path.go index 9696c4aeb..bafdfebbf 100644 --- a/scw/path.go +++ b/scw/path.go @@ -31,8 +31,8 @@ var ( func GetCacheDirectory() string { cacheDir := "" switch { - case os.Getenv(scwCacheDirEnv) != "": - cacheDir = os.Getenv(scwCacheDirEnv) + case os.Getenv(ScwCacheDirEnv) != "": + cacheDir = os.Getenv(ScwCacheDirEnv) case os.Getenv(xdgCacheDirEnv) != "": cacheDir = filepath.Join(os.Getenv(xdgCacheDirEnv), "scw") case os.Getenv(unixHomeDirEnv) != "": @@ -54,7 +54,7 @@ func GetCacheDirectory() string { // - $HOME/.config/scw/config.yaml // - $USERPROFILE/.config/scw/config.yaml func GetConfigPath() string { - configPath := os.Getenv(scwConfigPathEnv) + configPath := os.Getenv(ScwConfigPathEnv) if configPath == "" { configPath, _ = getConfigV2FilePath() }