use uri from provider string (#227)

nil-go · Mar 10, 2024 · e10026b · e10026b
1 parent 8e289e4
commit e10026b
Show file tree

Hide file tree

Showing 17 changed files with 31 additions and 34 deletions.
diff --git a/examples/aws/example_test.go b/examples/aws/example_test.go
@@ -47,10 +47,10 @@ func Example() {
 	// Output:
 	// AppConfig
 	//
-	// konf.source has value[AppConfig] that is loaded by loader[AppConfig:konf/test/config.yaml].
+	// konf.source has value[AppConfig] that is loaded by loader[appconfig://konf/config.yaml].
 	// Here are other value(loader)s:
 	//   - S3(s3://konf-test/config.yaml)
-	//   - Embedded FS(fs:config/config.yaml)
+	//   - Embedded FS(fs:///config/config.yaml)
 }
 
 func loadConfig() {

diff --git a/examples/azure/example_test.go b/examples/azure/example_test.go
@@ -50,7 +50,7 @@ func Example() {
 	// konf.source has value[App Configuration] that is loaded by loader[https://konftest.azconfig.io].
 	// Here are other value(loader)s:
 	//   - Blob Storage(https://konftest.blob.core.windows.net/konf-test/config.yaml)
-	//   - Embedded FS(fs:config/config.yaml)
+	//   - Embedded FS(fs:///config/config.yaml)
 }
 
 func loadConfig() {

diff --git a/examples/gcp/example_test.go b/examples/gcp/example_test.go
@@ -47,10 +47,10 @@ func Example() {
 	// Output:
 	// Secret Manager
 	//
-	// konf.source has value[Secret Manager] that is loaded by loader[SecretManager:konf-test].
+	// konf.source has value[Secret Manager] that is loaded by loader[secret-manager://konf-test].
 	// Here are other value(loader)s:
 	//   - GCS(gs://konf-test/config.yaml)
-	//   - Embedded FS(fs:config/config.yaml)
+	//   - Embedded FS(fs:///config/config.yaml)
 }
 
 func loadConfig() {

diff --git a/provider/appconfig/appconfig.go b/provider/appconfig/appconfig.go
@@ -105,7 +105,7 @@ func (a *AppConfig) Status(onStatus func(bool, error)) {
 }
 
 func (a *AppConfig) String() string {
-	return "AppConfig:" + a.client.application + "/" + a.client.environment + "/" + a.client.profile
+	return "appconfig://" + a.client.application + "/" + a.client.profile
 }
 
 type clientProxy struct {

diff --git a/provider/appconfig/appconfig_test.go b/provider/appconfig/appconfig_test.go
@@ -383,5 +383,5 @@ func TestAppConfig_String(t *testing.T) {
 	t.Parallel()
 
 	loader := appconfig.New("app", "env", "profile")
-	assert.Equal(t, "AppConfig:app/env/profile", loader.String())
+	assert.Equal(t, "appconfig://app/profile", loader.String())
 }
diff --git a/provider/env/env.go b/provider/env/env.go
@@ -61,9 +61,5 @@ func (e Env) Load() (map[string]any, error) {
 }
 
 func (e Env) String() string {
-	if e.prefix == "" {
-		return "env"
-	}
-
-	return "env:" + e.prefix
+	return "env:" + e.prefix + "*"
 }
diff --git a/provider/env/env_test.go b/provider/env/env_test.go
@@ -96,11 +96,11 @@ func TestEnv_String(t *testing.T) {
 		{
 			description: "with prefix",
 			prefix:      "P_",
-			expected:    "env:P_",
+			expected:    "env:P_*",
 		},
 		{
 			description: "no prefix",
-			expected:    "env",
+			expected:    "env:*",
 		},
 	}
 

diff --git a/provider/file/file.go b/provider/file/file.go
@@ -14,6 +14,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"path/filepath"
 )
 
 // File is a Provider that loads configuration from a OS file.
@@ -57,5 +58,10 @@ func (f *File) Load() (map[string]any, error) {
 }
 
 func (f *File) String() string {
-	return "file:" + f.path
+	path, err := filepath.Abs(f.path)
+	if err != nil {
+		path = "file:///" + f.path
+	}
+
+	return "file://" + path
 }
diff --git a/provider/file/file_test.go b/provider/file/file_test.go
@@ -5,6 +5,7 @@ package file_test
 
 import (
 	"errors"
+	"path/filepath"
 	"testing"
 
 	"github.com/nil-go/konf/provider/file"
@@ -76,5 +77,7 @@ func TestFile_Load(t *testing.T) {
 func TestFile_String(t *testing.T) {
 	t.Parallel()
 
-	assert.Equal(t, "file:config.json", file.New("config.json").String())
+	path, err := filepath.Abs("config.json")
+	assert.NoError(t, err)
+	assert.Equal(t, "file://"+path, file.New("config.json").String())
 }
diff --git a/provider/flag/flag.go b/provider/flag/flag.go
@@ -115,11 +115,7 @@ func isZeroValue(flg *flag.Flag) bool {
 }
 
 func (f Flag) String() string {
-	if f.prefix == "" {
-		return "flag"
-	}
-
-	return "flag:" + f.prefix
+	return "flag:" + f.prefix + "*"
 }
 
 type konf interface {

diff --git a/provider/flag/flag_test.go b/provider/flag/flag_test.go
@@ -126,11 +126,11 @@ func TestFlag_String(t *testing.T) {
 		{
 			description: "with prefix",
 			prefix:      "P_",
-			expected:    "flag:P_",
+			expected:    "flag:P_*",
 		},
 		{
 			description: "no prefix",
-			expected:    "flag",
+			expected:    "flag:*",
 		},
 	}
 

diff --git a/provider/fs/fs.go b/provider/fs/fs.go
@@ -63,5 +63,5 @@ func (f FS) Load() (map[string]any, error) {
 }
 
 func (f FS) String() string {
-	return "fs:" + f.path
+	return "fs:///" + f.path
 }
diff --git a/provider/fs/fs_test.go b/provider/fs/fs_test.go
@@ -110,5 +110,5 @@ func TestFS_Load(t *testing.T) {
 func TestFS_String(t *testing.T) {
 	t.Parallel()
 
-	assert.Equal(t, "fs:config.json", kfs.New(fstest.MapFS{}, "config.json").String())
+	assert.Equal(t, "fs:///config.json", kfs.New(fstest.MapFS{}, "config.json").String())
 }
diff --git a/provider/pflag/pflag.go b/provider/pflag/pflag.go
@@ -210,11 +210,7 @@ func flagVal(set *pflag.FlagSet, flag *pflag.Flag) (any, error) {
 }
 
 func (f PFlag) String() string {
-	if f.prefix == "" {
-		return "pflag"
-	}
-
-	return "pflag:" + f.prefix
+	return "pflag:" + f.prefix + "*"
 }
 
 type konf interface {

diff --git a/provider/pflag/pflag_test.go b/provider/pflag/pflag_test.go
@@ -131,11 +131,11 @@ func TestPFlag_String(t *testing.T) {
 		{
 			description: "with prefix",
 			prefix:      "P_",
-			expected:    "pflag:P_",
+			expected:    "pflag:P_*",
 		},
 		{
 			description: "no prefix",
-			expected:    "pflag",
+			expected:    "pflag:*",
 		},
 	}
 

diff --git a/provider/secretmanager/secretmanager.go b/provider/secretmanager/secretmanager.go
@@ -115,7 +115,7 @@ func (m *SecretManager) Status(onStatus func(bool, error)) {
 }
 
 func (m *SecretManager) String() string {
-	return "SecretManager:" + m.client.project
+	return "secret-manager://" + m.client.project
 }
 
 type clientProxy struct {

diff --git a/provider/secretmanager/secretmanager_test.go b/provider/secretmanager/secretmanager_test.go
@@ -269,7 +269,7 @@ func TestSecretManager_String(t *testing.T) {
 	t.Parallel()
 
 	loader := secretmanager.New(secretmanager.WithProject("test"))
-	assert.Equal(t, "SecretManager:test", loader.String())
+	assert.Equal(t, "secret-manager://test", loader.String())
 }
 
 type secretManagerService struct {