feat: add warning message if multiple variable sources

Author: Mélanie Marques

core/bootstrap.go

@@ -236,7 +236,12 @@ func Bootstrap(config *BootstrapConfig) (exitCode int, result any, err error) {
 	// Run checks after command has been executed
 	defer func() { // if we plan to remove defer, do not forget logger is not set until cobra pre init func
 		// Check CLI new version and api key expiration date
-		runAfterCommandChecks(ctx, config.BuildInfo.checkVersion, checkAPIKey)
+		runAfterCommandChecks(
+			ctx,
+			config.BuildInfo.checkVersion,
+			checkAPIKey,
+			checkIfMultipleVariableSources,
+		)
 	}()
 
 	if !config.DisableAliases {

core/checks.go

@@ -1,20 +1,27 @@
 package core
 
 import (
+	"bytes"
 	"context"
 	"fmt"
 	"os"
 	"path/filepath"
+	"reflect"
 	"time"
 
 	iam "github.com/scaleway/scaleway-sdk-go/api/iam/v1alpha1"
+	"github.com/scaleway/scaleway-sdk-go/scw"
 )
 
 var (
 	apiKeyExpireTime        = 24 * time.Hour
 	lastChecksFileLocalName = "last-cli-checks"
 )
 
+const (
+	defaultCredentialSource = "environment variable"
+)
+
 type AfterCommandCheckFunc func(ctx context.Context)
 
 // wasFileModifiedLast24h checks whether the file has been updated during last 24 hours.
@@ -105,3 +112,43 @@ func checkAPIKey(ctx context.Context) {
 		ExtractLogger(ctx).Warningf("Current api key expires in %s\n", expiresIn)
 	}
 }
+
+// checkIfMultipleVariableSources return an informative message during the CLI initialization
+// if there are multiple sources of configuration that could confuse the user
+func checkIfMultipleVariableSources(ctx context.Context) {
+	config, err := scw.LoadConfigFromPath(ExtractConfigPath(ctx))
+	if err != nil {
+		return
+	}
+
+	activeProfile, err := config.GetActiveProfile()
+	if err != nil {
+		return
+	}
+
+	profileEnv := scw.LoadEnvProfile()
+
+	vFile := reflect.ValueOf(activeProfile).Elem()
+	vEnv := reflect.ValueOf(profileEnv).Elem()
+	t := vFile.Type()
+
+	var buffer bytes.Buffer
+	buffer.WriteString("Checking multiple variable sources: \n")
+
+	for i := range t.NumField() {
+		valFile := vFile.Field(i)
+		valEnv := vEnv.Field(i)
+
+		if !valFile.IsNil() && !valEnv.IsNil() {
+			if valFile.Elem().String() != valEnv.Elem().String() {
+				buffer.WriteString(fmt.Sprintf(
+					"- Variable '%s' is defined in both config.yaml and environment with different values. Using: %s.\n",
+					t.Field(i).Name,
+					defaultCredentialSource,
+				))
+			}
+		}
+	}
+
+	ExtractLogger(ctx).Warning(buffer.String())
+}