feat(meta): warn the user if there are multiple variable sources used

Author: Gnoale

internal/meta/meta.go

@@ -1,11 +1,14 @@
 package meta
 
 import (
+	"bytes"
 	"context"
 	"errors"
 	"fmt"
 	"net/http"
 	"os"
+	"strings"
+	"text/tabwriter"
 
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -24,6 +27,7 @@ const (
 )
 
 type CredentialsSource struct {
+	Variables     map[string][]string
 	AccessKey     string
 	SecretKey     string
 	ProjectID     string
@@ -73,6 +77,41 @@ func (m Meta) ZoneSource() string {
 	return m.credentialsSource.DefaultZone
 }
 
+// HasMultipleVariableSources return an informative message during the Provider initialization
+// if there are multiple sources of configuration that could confuse the user
+//
+// Variable			AvailableSources									Using
+// SCW_ACCESS_KEY	Active Profile in config.yaml, Environment variable	Environment variable
+// SCW_SECRET_KEY	Active Profile in config.yaml, Environment variable	Environment variable
+func (m Meta) HasMultipleVariableSources() (bool, string) {
+	multiple := false
+
+	variables := []string{scw.ScwAccessKeyEnv, scw.ScwSecretKeyEnv, scw.ScwDefaultProjectIDEnv, scw.ScwDefaultRegionEnv, scw.ScwDefaultZoneEnv}
+
+	w := new(tabwriter.Writer)
+	buf := &bytes.Buffer{}
+	w.Init(buf, 0, 8, 0, '\t', 0)
+
+	fmt.Fprintln(w, "Variable\tAvailableSources\tUsing") //nolint:errcheck
+
+	for _, variable := range variables {
+		values, ok := m.credentialsSource.Variables[variable]
+		if ok {
+			if len(values) > 1 {
+				fmt.Fprintf(w, "%s\t%s\t%s\n", variable, strings.Join(values, ", "), values[len(values)-1]) //nolint:errcheck
+
+				multiple = true
+			}
+		}
+	}
+
+	if err := w.Flush(); err != nil {
+		panic(err)
+	}
+
+	return multiple, buf.String()
+}
+
 type Config struct {
 	ProviderSchema      *schema.ResourceData
 	HTTPClient          *http.Client
@@ -270,29 +309,39 @@ func GetCredentialsSource(defaultZoneProfile, activeProfile, providerProfile, en
 		},
 	}
 	credentialsSource := &CredentialsSource{}
+	credentialsSource.Variables = map[string][]string{}
 
 	for _, pair := range profilesInOrder {
 		source := pair.Source
 		profile := pair.Profile
 
 		if profile.AccessKey != nil {
 			credentialsSource.AccessKey = source
+			credentialsSource.Variables[scw.ScwAccessKeyEnv] = append(credentialsSource.Variables[scw.ScwAccessKeyEnv], source)
 		}
 
 		if profile.SecretKey != nil {
 			credentialsSource.SecretKey = source
+			credentialsSource.Variables[scw.ScwSecretKeyEnv] = append(credentialsSource.Variables[scw.ScwSecretKeyEnv], source)
 		}
 
 		if profile.DefaultProjectID != nil {
 			credentialsSource.ProjectID = source
+			credentialsSource.Variables[scw.ScwDefaultProjectIDEnv] = append(credentialsSource.Variables[scw.ScwDefaultProjectIDEnv], source)
 		}
 
 		if profile.DefaultRegion != nil {
 			credentialsSource.DefaultRegion = source
+			if source != CredentialsSourceDefault {
+				credentialsSource.Variables[scw.ScwDefaultRegionEnv] = append(credentialsSource.Variables[scw.ScwDefaultRegionEnv], source)
+			}
 		}
 
 		if profile.DefaultZone != nil {
 			credentialsSource.DefaultZone = source
+			if source != CredentialsSourceDefault {
+				credentialsSource.Variables[scw.ScwDefaultZoneEnv] = append(credentialsSource.Variables[scw.ScwDefaultZoneEnv], source)
+			}
 		}
 	}
 

internal/provider/provider.go

@@ -355,7 +355,17 @@ func Provider(config *Config) plugin.ProviderFunc {
 				return nil, diag.FromErr(err)
 			}
 
-			return m, nil
+			var diags diag.Diagnostics
+
+			if ok, message := m.HasMultipleVariableSources(); ok {
+				diags = append(diags, diag.Diagnostic{
+					Severity: diag.Warning,
+					Summary:  "Multiple credential sources detected",
+					Detail:   message,
+				})
+			}
+
+			return m, diags
 		}
 
 		return p