Add a commented configuration file

Author: remyleone

scw/config.go

@@ -1,9 +1,12 @@
 package scw
 
 import (
+	"bytes"
+	"fmt"
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"text/template"
 
 	"github.com/scaleway/scaleway-sdk-go/internal/auth"
 	"github.com/scaleway/scaleway-sdk-go/internal/errors"
@@ -16,6 +19,50 @@ const (
 	defaultConfigPermission = 0600
 )
 
+const configFileTemplate = `
+# Scaleway configuration file
+#
+# You need an Access Key and a Token to connect to Scaleway API.
+# Generate your token at the following address: https://console.scaleway.com/account/credentials
+
+# An Access Key is a token identifier.
+{{ if .AccessKey }}access_key: {{.AccessKey}}{{ else }}# access_key: SCW11111111111111111{{ end }}
+
+# The Secret Key is the value that can be used to authenticate against the API (the value used in X-Auth-Token HTTP-header).
+# The secret MUST stay secret and not given to anyone or published online.
+{{ if .SecretKey }}secret_key: {{ .SecretKey }}{{ else }}# secret_key: 11111111-1111-1111-1111-111111111111{{ end }}
+
+# Your organization ID is the identifier of your account inside Scaleway infrastructure.
+{{ if .DefaultOrganizationID }}default_organization_id: {{ .DefaultOrganizationID }}{{ else }}# default_organization_id: 11111111-1111-1111-1111-111111111111{{ end }}
+
+# A Region is represented as a Geographical area such as France (Paris) or the Netherlands (Amsterdam).
+# It can contain multiple Availability Zones.
+# Example of Region: fr-par, nl-ams
+{{ if .DefaultRegion }}default_region: {{ .DefaultRegion }}{{ else }}# default_region: fr-par{{ end }}
+
+# A region can be split in many Availability Zones (AZ).
+# Latency between multiple AZ of the same region are low as they have a common network layer.
+# Example of Zones: fr-par-1, nl-ams-1
+{{ if .DefaultZone }}default_zone: {{.DefaultZone}}{{ else }}# default_zone: fr-par-1{{ end }}
+
+# Scaleway CLI also supports profiles that will have a different set of credentials.
+# You can define a CLI profile using the following syntax:
+{{ if gt (len .Profiles) 0 }}{{ range $k,$v := .Profiles }}
+{{ $k }}:
+  {{ if $v.AccessKey }}access_key: {{ $v.AccessKey }}{{ else }}# access_key: SCW11111111111111111{{ end }}
+  {{ if $v.DefaultOrganizationID }}default_organization_id: {{ $v.DefaultOrganizationID }}{{ else }}# default_organization_id: 11111111-1111-1111-1111-111111111111{{ end }}
+  {{ if $v.DefaultZone }}default_zone: {{ $v.DefaultZone }}{{ else }}# default_zone: fr-par-1{{ end }}
+  {{ if $v.DefaultRegion }}default_region: {{ $v.DefaultRegion }}{{ else }}# default_region: fr-par{{ end }}
+{{ end }}
+{{ else }}
+# myProfile:
+#   access_key: 11111111-1111-1111-1111-111111111111
+#   organization_id: 11111111-1111-1111-1111-111111111111
+#   default_zone: fr-par-1
+#   default_region: fr-par
+{{ end }}
+`
+
 type Config struct {
 	Profile       `yaml:",inline"`
 	ActiveProfile *string             `yaml:"active_profile,omitempty"`
@@ -149,13 +196,31 @@ func (c *Config) Save() error {
 	return c.SaveTo(GetConfigPath())
 }
 
+func (c *Config) ConfigFile() ([]byte, error) {
+	tmpl, err := template.New("configuration").Parse(configFileTemplate)
+	if err != nil {
+		fmt.Print(err)
+		return nil, err
+	}
+
+	var buf bytes.Buffer
+	err = tmpl.Execute(&buf, c)
+	if err != nil {
+		fmt.Println(err)
+		return nil, err
+	}
+	fmt.Println(buf.String())
+
+	return buf.Bytes(), nil
+}
+
 // SaveTo will save the config to the given path. This action will
 // overwrite the previous file when it exists.
 func (c *Config) SaveTo(path string) error {
 	path = filepath.Clean(path)
 
-	// STEP 1: marshal config
-	file, err := yaml.Marshal(c)
+	// STEP 1: Render the configuration file as a file
+	file, err := c.ConfigFile()
 	if err != nil {
 		return err
 	}

scw/config_test.go

@@ -518,3 +518,70 @@ secret_key: 6f6e6574-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 	testhelpers.Equals(t, v2ValidSecretKey2, *p.SecretKey)
 
 }
+
+func TestConfigFileWithFullProfile(t *testing.T) {
+	var c = &Config{
+		Profile: Profile{
+			AccessKey: s(v2ValidAccessKey),
+			SecretKey: s(v2ValidSecretKey),
+		},
+		ActiveProfile: s(v2ValidProfile),
+		Profiles: map[string]*Profile{
+			v2ValidProfile: {
+				AccessKey: s(v2ValidAccessKey2),
+				SecretKey: s(v2ValidSecretKey2),
+			},
+		},
+	}
+
+	dump, err := c.ConfigFile()
+	if err != nil {
+		panic(err)
+	}
+
+	var newConfig = &Config{}
+	newConfig, err = unmarshalConfV2(dump)
+	if err != nil {
+		panic(err)
+	}
+
+	testhelpers.Equals(t, c, newConfig)
+}
+
+func TestConfigFileWithEmptyProfile(t *testing.T) {
+	var c = &Config{}
+
+	dump, err := c.ConfigFile()
+	if err != nil {
+		panic(err)
+	}
+
+	var newConfig = &Config{}
+	newConfig, err = unmarshalConfV2(dump)
+	if err != nil {
+		panic(err)
+	}
+
+	testhelpers.Equals(t, c, newConfig)
+}
+
+func TestConfigFileWithPartialProfile(t *testing.T) {
+	var c = &Config{
+		Profile: Profile{
+			AccessKey: s(v2ValidAccessKey),
+		},
+	}
+
+	dump, err := c.ConfigFile()
+	if err != nil {
+		panic(err)
+	}
+
+	var newConfig = &Config{}
+	newConfig, err = unmarshalConfV2(dump)
+	if err != nil {
+		panic(err)
+	}
+
+	testhelpers.Equals(t, c, newConfig)
+}