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

feat: export Scaleway environment variable constants #400

Merged
merged 1 commit into from
Apr 30, 2020
Merged

feat: export Scaleway environment variable constants #400

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
26 changes: 13 additions & 13 deletions scw/client_option_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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,
Expand Down
8 changes: 4 additions & 4 deletions scw/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions scw/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand Down
34 changes: 17 additions & 17 deletions scw/env.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 {
Expand All @@ -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 = &region
}

zone, _, envExist := getEnv(scwDefaultZoneEnv)
zone, _, envExist := getEnv(ScwDefaultZoneEnv)
if envExist {
p.DefaultZone = &zone
}
Expand Down
14 changes: 7 additions & 7 deletions scw/env_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
8 changes: 4 additions & 4 deletions scw/load_config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
6 changes: 3 additions & 3 deletions scw/path.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) != "":
Expand All @@ -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()
}
Expand Down