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.

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

Automated cherry pick of #15618: switched credentials reading order #15619

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 23 additions & 13 deletions upup/pkg/fi/cloudup/scaleway/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,26 +99,35 @@ func checkCredentials(accessKey, secretKey, projectID string) []error {
}

func CreateValidScalewayProfile() (*scw.Profile, error) {
profile := &scw.Profile{
AccessKey: fi.PtrTo(os.Getenv("SCW_ACCESS_KEY")),
SecretKey: fi.PtrTo(os.Getenv("SCW_SECRET_KEY")),
DefaultProjectID: fi.PtrTo(os.Getenv("SCW_DEFAULT_PROJECT_ID")),
}
var profile scw.Profile

// If the profile is REDACTED, we're running integration tests so no need to return any credentials
if profileName := os.Getenv("SCW_PROFILE"); profileName == "REDACTED" {
return profile, nil
return &profile, nil
}

// If SCW_PROFILE is set, we load the credentials from the profile rather than from the environment
p, err := getScalewayProfile()
// We load the credentials form the profile first
profileFromScwConfig, err := getScalewayProfile()
if err != nil {
return nil, err
}
if p != nil {
profile.AccessKey = p.AccessKey
profile.SecretKey = p.SecretKey
profile.DefaultProjectID = p.DefaultProjectID
// We load the credentials from the environment second
var profileFromEnv scw.Profile
if accessKey := os.Getenv("SCW_ACCESS_KEY"); accessKey != "" {
profileFromEnv.AccessKey = &accessKey
}
if secretKey := os.Getenv("SCW_SECRET_KEY"); secretKey != "" {
profileFromEnv.SecretKey = &secretKey
}
if projectID := os.Getenv("SCW_DEFAULT_PROJECT_ID"); projectID != "" {
profileFromEnv.DefaultProjectID = &projectID
}

// We merge the profiles: the environment will override the values from the profile
if profileFromScwConfig == nil {
profile = profileFromEnv
} else {
profile = *scw.MergeProfiles(profileFromScwConfig, &profileFromEnv)
}

// We check that the profile has an access key, a secret key and a default project ID
Expand All @@ -131,5 +140,6 @@ func CreateValidScalewayProfile() (*scw.Profile, error) {
}
return nil, fmt.Errorf(errMsg)
}
return profile, nil

return &profile, nil
}
182 changes: 182 additions & 0 deletions upup/pkg/fi/cloudup/scaleway/utils_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
/*
Copyright 2023 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package scaleway

import (
"errors"
"fmt"
"os"
"testing"

"k8s.io/kops/upup/pkg/fi"
"sigs.k8s.io/yaml"
)

type ScalewayProfile struct {
AccessKey string `json:"access_key"`
SecretKey string `json:"secret_key"`
DefaultProjectID string `json:"default_project_id"`
}

func createScalewayConfigFile() error {
scalewayDefaultProfile := ScalewayProfile{
AccessKey: "SCWAAAAAAAAAAAAAAAAA",
SecretKey: "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
DefaultProjectID: "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
}
scalewayProfiles := map[string]ScalewayProfile{
"default": scalewayDefaultProfile,
}
scalewayConfigFile := map[string]map[string]ScalewayProfile{
"profiles": scalewayProfiles,
}

out, err := yaml.Marshal(scalewayConfigFile)
if err != nil {
return fmt.Errorf("error marshalling yaml file: %w", err)
}
err = os.WriteFile("./scw_config_test.yaml", out, 0644)
if err != nil {
return fmt.Errorf("error writing yaml file: %w", err)
}
return nil
}

func TestCreateValidScalewayProfile(t *testing.T) {
tests := []struct {
testDescription string
loadConfigFile bool
environment map[string]string
expectedConfig ScalewayProfile
}{
{
testDescription: "Only environment set",
loadConfigFile: false,
environment: map[string]string{
"SCW_ACCESS_KEY": "SCWBBBBBBBBBBBBBBBBB",
"SCW_SECRET_KEY": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"SCW_DEFAULT_PROJECT_ID": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
},
expectedConfig: ScalewayProfile{
AccessKey: "SCWBBBBBBBBBBBBBBBBB",
SecretKey: "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
DefaultProjectID: "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
},
},
{
testDescription: "Only profile set",
loadConfigFile: true,
environment: map[string]string{
"SCW_PROFILE": "default",
"SCW_CONFIG_PATH": "./scw_config_test.yaml",
},
expectedConfig: ScalewayProfile{
AccessKey: "SCWAAAAAAAAAAAAAAAAA",
SecretKey: "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
DefaultProjectID: "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
},
},
{
testDescription: "Environment should override profile's default project ID",
loadConfigFile: true,
environment: map[string]string{
"SCW_PROFILE": "default",
"SCW_CONFIG_PATH": "./scw_config_test.yaml",
"SCW_DEFAULT_PROJECT_ID": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
},
expectedConfig: ScalewayProfile{
AccessKey: "SCWAAAAAAAAAAAAAAAAA",
SecretKey: "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
DefaultProjectID: "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
},
},
{
testDescription: "Environment should override whole profile",
loadConfigFile: true,
environment: map[string]string{
"SCW_PROFILE": "default",
"SCW_CONFIG_PATH": "./scw_config_test.yaml",
"SCW_ACCESS_KEY": "SCWBBBBBBBBBBBBBBBBB",
"SCW_SECRET_KEY": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"SCW_DEFAULT_PROJECT_ID": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
},
expectedConfig: ScalewayProfile{
AccessKey: "SCWBBBBBBBBBBBBBBBBB",
SecretKey: "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
DefaultProjectID: "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
},
},
{
testDescription: "Empty profile for integration tests",
loadConfigFile: false,
environment: map[string]string{
"SCW_PROFILE": "REDACTED",
},
expectedConfig: ScalewayProfile{},
},
}

for _, test := range tests {
t.Run(test.testDescription, func(t *testing.T) {
if test.loadConfigFile {
err := createScalewayConfigFile()
if err != nil {
t.Fatal(err)
}
}

for k, v := range test.environment {
err := os.Setenv(k, v)
if err != nil {
t.Error(err)
}
}

defer t.Cleanup(func() {
// Delete config file
err := os.Remove("./scw_config_test.yaml")
if err != nil {
if !errors.Is(err, os.ErrNotExist) {
t.Fatalf("error deleting yaml file: %v", err)
}
}
// Unset environment variables
envToUnset := []string{"SCW_PROFILE", "SCW_CONFIG_PATH", "SCW_ACCESS_KEY", "SCW_SECRET_KEY", "SCW_DEFAULT_PROJECT_ID"}
for _, key := range envToUnset {
err := os.Unsetenv(key)
if err != nil {
t.Fatalf("error unsetting environment: %v", err)
}
}
})

actualProfile, err := CreateValidScalewayProfile()
if err != nil {
t.Error(err)
}
actualConfig := ScalewayProfile{
AccessKey: fi.ValueOf(actualProfile.AccessKey),
SecretKey: fi.ValueOf(actualProfile.SecretKey),
DefaultProjectID: fi.ValueOf(actualProfile.DefaultProjectID),
}

if actualConfig != test.expectedConfig {
t.Errorf("config differs, expected %+v, got %+v", test.expectedConfig, actualConfig)
}
})
}
}
6 changes: 6 additions & 0 deletions upup/pkg/fi/cloudup/scalewaytasks/loadbalancer.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package scalewaytasks

import (
"fmt"
"os"
"strings"

"k8s.io/klog/v2"
Expand Down Expand Up @@ -88,6 +89,11 @@ func (l *LoadBalancer) Find(context *fi.CloudupContext) (*LoadBalancer, error) {
}

func (l *LoadBalancer) FindAddresses(context *fi.CloudupContext) ([]string, error) {
// Skip if we're running integration tests
if profileName := os.Getenv("SCW_PROFILE"); profileName == "REDACTED" {
return nil, nil
}

cloud := context.T.Cloud.(scaleway.ScwCloud)
lbService := cloud.LBService()

Expand Down
Loading