Skip to content

Preserve YAML inline comments through encrypt/edit roundtrip #2131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
felixfontein merged 4 commits into from
Apr 17, 2026
+157 −53
Merged

Preserve YAML inline comments through encrypt/edit roundtrip #2131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
42f75be
fix: preserve YAML inline comments through encrypt/edit roundtrip
knowald Mar 31, 2026
2fd2adc
test: add nested inline comment roundtrip test
knowald Apr 1, 2026
eddc3ca
fix: preserve trailing inline comments in YAML emit when no items follow
knowald Apr 7, 2026
d85d6d3
Merge branch 'main' into fix/yaml-inline-comment-roundtrip
felixfontein Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions sops.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ type Cipher interface {

// Comment represents a comment in the sops tree for the file formats that actually support them.
type Comment struct {
Value string
Value string
Inline bool
}

// TreeItem is an item inside sops's tree
Expand Down Expand Up @@ -403,7 +404,7 @@ func (branch TreeBranch) walkBranch(in TreeBranch, path []string, commentsStack
in[i].Key = encComment
continue
} else if comment, ok := enc.(string); ok {
in[i].Key = Comment{Value: comment}
in[i].Key = Comment{Value: comment, Inline: c.Inline}
continue
} else {
return nil, fmt.Errorf("walkValue of Comment should be either Comment or string, was %T", enc)
Expand Down
66 changes: 33 additions & 33 deletions sops_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ func TestEncryptedCommentRegex(t *testing.T) {
branches := TreeBranches{
TreeBranch{
TreeItem{
Key: Comment{"sops:enc"},
Key: Comment{Value: "sops:enc"},
Value: nil,
},
TreeItem{
Expand All @@ -367,11 +367,11 @@ func TestEncryptedCommentRegex(t *testing.T) {
Value: "bar",
},
TreeItem{
Key: Comment{"before"},
Key: Comment{Value: "before"},
Value: nil,
},
TreeItem{
Key: Comment{"sops:enc"},
Key: Comment{Value: "sops:enc"},
Value: nil,
},
TreeItem{
Expand All @@ -384,16 +384,16 @@ func TestEncryptedCommentRegex(t *testing.T) {
Key: "array",
Value: []interface{}{
"bar",
Comment{"sops:enc"},
Comment{Value: "sops:enc"},
"baz",
},
},
TreeItem{
Key: Comment{"sops:enc"},
Key: Comment{Value: "sops:enc"},
Value: nil,
},
TreeItem{
Key: Comment{"after"},
Key: Comment{Value: "after"},
Value: nil,
},
TreeItem{
Expand All @@ -408,7 +408,7 @@ func TestEncryptedCommentRegex(t *testing.T) {
tree := Tree{Branches: branches, Metadata: Metadata{EncryptedCommentRegex: "sops:enc"}}
expected := TreeBranch{
TreeItem{
Key: Comment{"sops:enc"},
Key: Comment{Value: "sops:enc"},
Value: nil,
},
TreeItem{
Expand All @@ -423,11 +423,11 @@ func TestEncryptedCommentRegex(t *testing.T) {
Value: "bar",
},
TreeItem{
Key: Comment{"before"},
Key: Comment{Value: "before"},
Value: nil,
},
TreeItem{
Key: Comment{"sops:enc"},
Key: Comment{Value: "sops:enc"},
Value: nil,
},
TreeItem{
Expand All @@ -440,16 +440,16 @@ func TestEncryptedCommentRegex(t *testing.T) {
Key: "array",
Value: []interface{}{
"bar",
Comment{"sops:enc"},
Comment{Value: "sops:enc"},
"zab",
},
},
TreeItem{
Key: Comment{"sops:enc"},
Key: Comment{Value: "sops:enc"},
Value: nil,
},
TreeItem{
Key: Comment{"retfa"},
Key: Comment{Value: "retfa"},
Value: nil,
},
TreeItem{
Expand All @@ -475,7 +475,7 @@ func TestEncryptedCommentRegex(t *testing.T) {
expected[1].Value = "bar"
expected[2].Value.(TreeBranch)[3].Value = "bar"
expected[3].Value.([]interface{})[2] = "baz"
expected[5].Key = Comment{"after"}
expected[5].Key = Comment{Value: "after"}
expected[6].Value = []interface{}{
"bar",
"baz",
Expand All @@ -489,7 +489,7 @@ func TestUnencryptedCommentRegex(t *testing.T) {
branches := TreeBranches{
TreeBranch{
TreeItem{
Key: Comment{"sops:noenc"},
Key: Comment{Value: "sops:noenc"},
Value: nil,
},
TreeItem{
Expand All @@ -504,11 +504,11 @@ func TestUnencryptedCommentRegex(t *testing.T) {
Value: "bar",
},
TreeItem{
Key: Comment{"before"},
Key: Comment{Value: "before"},
Value: nil,
},
TreeItem{
Key: Comment{"sops:noenc"},
Key: Comment{Value: "sops:noenc"},
Value: nil,
},
TreeItem{
Expand All @@ -521,16 +521,16 @@ func TestUnencryptedCommentRegex(t *testing.T) {
Key: "array",
Value: []interface{}{
"bar",
Comment{"sops:noenc"},
Comment{Value: "sops:noenc"},
"baz",
},
},
TreeItem{
Key: Comment{"sops:noenc"},
Key: Comment{Value: "sops:noenc"},
Value: nil,
},
TreeItem{
Key: Comment{"after"},
Key: Comment{Value: "after"},
Value: nil,
},
TreeItem{
Expand All @@ -545,7 +545,7 @@ func TestUnencryptedCommentRegex(t *testing.T) {
tree := Tree{Branches: branches, Metadata: Metadata{UnencryptedCommentRegex: "sops:noenc"}}
expected := TreeBranch{
TreeItem{
Key: Comment{"sops:noenc"},
Key: Comment{Value: "sops:noenc"},
Value: nil,
},
TreeItem{
Expand All @@ -560,11 +560,11 @@ func TestUnencryptedCommentRegex(t *testing.T) {
Value: "rab",
},
TreeItem{
Key: Comment{"erofeb"},
Key: Comment{Value: "erofeb"},
Value: nil,
},
TreeItem{
Key: Comment{"sops:noenc"},
Key: Comment{Value: "sops:noenc"},
Value: nil,
},
TreeItem{
Expand All @@ -577,16 +577,16 @@ func TestUnencryptedCommentRegex(t *testing.T) {
Key: "array",
Value: []interface{}{
"rab",
Comment{"sops:noenc"},
Comment{Value: "sops:noenc"},
"baz",
},
},
TreeItem{
Key: Comment{"sops:noenc"},
Key: Comment{Value: "sops:noenc"},
Value: nil,
},
TreeItem{
Key: Comment{"after"},
Key: Comment{Value: "after"},
Value: nil,
},
TreeItem{
Expand All @@ -610,7 +610,7 @@ func TestUnencryptedCommentRegex(t *testing.T) {
t.Errorf("Decrypting the tree failed: %s", err)
}
expected[2].Value.(TreeBranch)[0].Value = "bar"
expected[2].Value.(TreeBranch)[1].Key = Comment{"before"}
expected[2].Value.(TreeBranch)[1].Key = Comment{Value: "before"}
expected[3].Value.([]interface{})[0] = "bar"
if !reflect.DeepEqual(tree.Branches[0], expected) {
t.Errorf("Trees don't match: \ngot\t\t\t%+v,\nexpected\t\t%+v", tree.Branches[0], expected)
Expand All @@ -621,7 +621,7 @@ func TestUnencryptedCommentRegexFail(t *testing.T) {
branches := TreeBranches{
TreeBranch{
TreeItem{
Key: Comment{"sops:noenc"},
Key: Comment{Value: "sops:noenc"},
Value: nil,
},
TreeItem{
Expand Down Expand Up @@ -936,14 +936,14 @@ func TestEncryptComments(t *testing.T) {
Branches: TreeBranches{
TreeBranch{
TreeItem{
Key: Comment{"foo"},
Key: Comment{Value: "foo"},
Value: nil,
},
TreeItem{
Key: "list",
Value: []interface{}{
"1",
Comment{"bar"},
Comment{Value: "bar"},
"2",
},
},
Expand All @@ -963,14 +963,14 @@ func TestDecryptComments(t *testing.T) {
Branches: TreeBranches{
TreeBranch{
TreeItem{
Key: Comment{"oof"},
Key: Comment{Value: "oof"},
Value: nil,
},
TreeItem{
Key: "list",
Value: []interface{}{
"1",
Comment{"rab"},
Comment{Value: "rab"},
"2",
},
},
Expand All @@ -995,7 +995,7 @@ func TestDecryptUnencryptedComments(t *testing.T) {
TreeBranch{
TreeItem{
// We use `error` to simulate an error decrypting, the fake cipher will error in this case
Key: Comment{"error"},
Key: Comment{Value: "error"},
Value: nil,
},
},
Expand Down Expand Up @@ -1521,7 +1521,7 @@ func TestEmitAsMap(t *testing.T) {
Value: 42,
},
TreeItem{
Key: Comment{"comment"},
Key: Comment{Value: "comment"},
Value: nil,
},
},
Expand Down
Loading
Loading