Merge pull request #2120 from felixfontein/mapstructure

Use mapstructure to (de-)serialize internal metadata; move metadata processing from specific stores to general place

Author: felixfontein

go.mod

@@ -20,6 +20,7 @@ require (
 	github.com/blang/semver v3.5.1+incompatible
 	github.com/fatih/color v1.19.0
 	github.com/getsops/gopgagent v0.0.0-20241224165529-7044f28e491e
+	github.com/go-viper/mapstructure/v2 v2.5.0
 	github.com/google/go-cmp v0.7.0
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
 	github.com/goware/prefixer v0.0.0-20160118172347-395022866408
@@ -100,7 +101,6 @@ require (
 	github.com/go-jose/go-jose/v4 v4.1.4 // indirect
 	github.com/go-logr/logr v1.4.3 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
-	github.com/go-viper/mapstructure/v2 v2.5.0 // indirect
 	github.com/goccy/go-yaml v1.19.2 // indirect
 	github.com/golang-jwt/jwt/v5 v5.3.1 // indirect
 	github.com/google/s2a-go v0.1.9 // indirect

stores/dotenv/store.go

@@ -3,17 +3,13 @@ package dotenv //import "github.com/getsops/sops/v3/stores/dotenv"
 import (
 	"bytes"
 	"fmt"
-	"sort"
 	"strings"
 
 	"github.com/getsops/sops/v3"
 	"github.com/getsops/sops/v3/config"
 	"github.com/getsops/sops/v3/stores"
 )
 
-// SopsPrefix is the prefix for all metadatada entry keys
-const SopsPrefix = stores.SopsMetadataKey + "_"
-
 // Store handles storage of dotenv data
 type Store struct {
 	config config.DotenvStoreConfig
@@ -33,47 +29,15 @@ func (store *Store) LoadEncryptedFile(in []byte) (sops.Tree, error) {
 	if err != nil {
 		return sops.Tree{}, err
 	}
-
-	var resultBranch sops.TreeBranch
-	mdMap := make(map[string]interface{})
-	for _, item := range branches[0] {
-		switch key := item.Key.(type) {
-		case string:
-			if strings.HasPrefix(key, SopsPrefix) {
-				key = key[len(SopsPrefix):]
-				mdMap[key] = item.Value
-			} else {
-				resultBranch = append(resultBranch, item)
-			}
-		case sops.Comment:
-			resultBranch = append(resultBranch, item)
-		default:
-			panic(fmt.Sprintf("Unexpected type: %T (value %#v)", key, key))
-		}
-	}
-	if len(mdMap) == 0 {
-		return sops.Tree{}, sops.MetadataNotFound
-	}
-
-	stores.DecodeNewLines(mdMap)
-	err = stores.DecodeNonStrings(mdMap)
-	if err != nil {
-		return sops.Tree{}, err
-	}
-	metadata, err := stores.UnflattenMetadata(mdMap)
+	branches, metadata, err := stores.ExtractMetadata(branches, stores.MetadataOpts{
+		Flatten: stores.MetadataFlattenFull,
+	})
 	if err != nil {
 		return sops.Tree{}, err
 	}
-	internalMetadata, err := metadata.ToInternal()
-	if err != nil {
-		return sops.Tree{}, err
-	}
-
 	return sops.Tree{
-		Branches: sops.TreeBranches{
-			resultBranch,
-		},
-		Metadata: internalMetadata,
+		Branches: branches,
+		Metadata: metadata,
 	}, nil
 }
 
@@ -111,29 +75,13 @@ func (store *Store) LoadPlainFile(in []byte) (sops.TreeBranches, error) {
 // EmitEncryptedFile returns the encrypted file's bytes corresponding to a sops
 // runtime object
 func (store *Store) EmitEncryptedFile(in sops.Tree) ([]byte, error) {
-	metadata := stores.MetadataFromInternal(in.Metadata)
-	mdItems, err := stores.FlattenMetadata(metadata)
+	branches, err := stores.SerializeMetadata(in, stores.MetadataOpts{
+		Flatten: stores.MetadataFlattenFull,
+	})
 	if err != nil {
-		return nil, err
-	}
-
-	stores.EncodeNonStrings(mdItems)
-	stores.EncodeNewLines(mdItems)
-
-	var keys []string
-	for k := range mdItems {
-		keys = append(keys, k)
-	}
-	sort.Strings(keys)
-
-	for _, key := range keys {
-		var value = mdItems[key]
-		if value == nil {
-			continue
-		}
-		in.Branches[0] = append(in.Branches[0], sops.TreeItem{Key: SopsPrefix + key, Value: value})
+		return nil, fmt.Errorf("Error marshaling metadata: %s", err)
 	}
-	return store.EmitPlainFile(in.Branches)
+	return store.EmitPlainFile(branches)
 }
 
 // EmitPlainFile returns the plaintext file's bytes corresponding to a sops
@@ -188,7 +136,7 @@ func IsComplexValue(v interface{}) bool {
 func (store *Store) HasSopsTopLevelKey(branch sops.TreeBranch) bool {
 	for _, b := range branch {
 		if key, ok := b.Key.(string); ok {
-			if strings.HasPrefix(key, SopsPrefix) {
+			if strings.HasPrefix(key, stores.SopsPrefix) {
 				return true
 			}
 		}