feat!: drop yaml v2 support

Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
spf13 · Jan 19, 2023 · e42b933 · e42b933
1 parent 9e46b76
commit e42b933
Show file tree

Hide file tree

Showing 10 changed files with 89 additions and 272 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -44,7 +44,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
         go: ['1.16', '1.17', '1.18', '1.19']
-        tags: ['', 'viper_yaml2', 'viper_toml1']
+        tags: ['', 'viper_toml1']
     env:
       GOFLAGS: -mod=readonly
 

diff --git a/go.mod b/go.mod
@@ -17,7 +17,6 @@ require (
 	github.com/stretchr/testify v1.8.1
 	github.com/subosito/gotenv v1.4.1
 	gopkg.in/ini.v1 v1.67.0
-	gopkg.in/yaml.v2 v2.4.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 

diff --git a/internal/encoding/yaml/codec.go b/internal/encoding/yaml/codec.go
@@ -1,6 +1,6 @@
 package yaml
 
-// import "gopkg.in/yaml.v2"
+import "gopkg.in/yaml.v3"
 
 // Codec implements the encoding.Encoder and encoding.Decoder interfaces for YAML encoding.
 type Codec struct{}

diff --git a/internal/encoding/yaml/codec_test.go b/internal/encoding/yaml/codec_test.go
@@ -5,6 +5,93 @@ import (
 	"testing"
 )
 
+// original form of the data
+const original = `# key-value pair
+key: value
+list:
+    - item1
+    - item2
+    - item3
+map:
+    key: value
+
+# nested
+# map
+nested_map:
+    map:
+        key: value
+        list:
+            - item1
+            - item2
+            - item3
+`
+
+// encoded form of the data
+const encoded = `key: value
+list:
+    - item1
+    - item2
+    - item3
+map:
+    key: value
+nested_map:
+    map:
+        key: value
+        list:
+            - item1
+            - item2
+            - item3
+`
+
+// decoded form of the data
+//
+// in case of YAML it's slightly different from Viper's internal representation
+// (eg. map is decoded into a map with interface key)
+var decoded = map[string]interface{}{
+	"key": "value",
+	"list": []interface{}{
+		"item1",
+		"item2",
+		"item3",
+	},
+	"map": map[string]interface{}{
+		"key": "value",
+	},
+	"nested_map": map[string]interface{}{
+		"map": map[string]interface{}{
+			"key": "value",
+			"list": []interface{}{
+				"item1",
+				"item2",
+				"item3",
+			},
+		},
+	},
+}
+
+// Viper's internal representation
+var data = map[string]interface{}{
+	"key": "value",
+	"list": []interface{}{
+		"item1",
+		"item2",
+		"item3",
+	},
+	"map": map[string]interface{}{
+		"key": "value",
+	},
+	"nested_map": map[string]interface{}{
+		"map": map[string]interface{}{
+			"key": "value",
+			"list": []interface{}{
+				"item1",
+				"item2",
+				"item3",
+			},
+		},
+	},
+}
+
 func TestCodec_Encode(t *testing.T) {
 	codec := Codec{}
 

diff --git a/internal/encoding/yaml/yaml2.go b/internal/encoding/yaml/yaml2.go
diff --git a/internal/encoding/yaml/yaml2_test.go b/internal/encoding/yaml/yaml2_test.go
diff --git a/internal/encoding/yaml/yaml3.go b/internal/encoding/yaml/yaml3.go
diff --git a/internal/encoding/yaml/yaml3_test.go b/internal/encoding/yaml/yaml3_test.go
diff --git a/viper_yaml2_test.go b/viper_yaml2_test.go
diff --git a/viper_yaml3_test.go → viper_yaml_test.go b/viper_yaml3_test.go → viper_yaml_test.go
@@ -1,6 +1,3 @@
-//go:build !viper_yaml2
-// +build !viper_yaml2
-
 package viper
 
 var yamlExample = []byte(`Hacker: true