default true booleans should not be rendered in YAML

Author: karakanb

pkg/pipeline/pipeline.go

@@ -130,6 +130,10 @@ func (b *DefaultTrueBool) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
+func (b DefaultTrueBool) IsZero() bool {
+	return b.Value == nil || *b.Value == true
+}
+
 func (b DefaultTrueBool) MarshalJSON() ([]byte, error) {
 	if b.Value == nil {
 		return []byte("true"), nil
@@ -158,7 +162,7 @@ func (b *DefaultTrueBool) Bool() bool {
 }
 
 func (b DefaultTrueBool) MarshalYAML() (interface{}, error) {
-	if b.Value == nil {
+	if b.Value == nil || *b.Value {
 		return nil, nil
 	}
 

pkg/pipeline/pipeline_test.go

@@ -1,7 +1,9 @@
 package pipeline_test
 
 import (
+	"bytes"
 	"encoding/json"
+	"gopkg.in/yaml.v3"
 	"log"
 	"os"
 	"path/filepath"
@@ -892,3 +894,54 @@ func BenchmarkClearSpacesAtLineEndings(b *testing.B) {
 		pipeline.ClearSpacesAtLineEndings(content)
 	}
 }
+
+func TestDefaultTrueBool_MarshalYAML(t *testing.T) {
+	t.Parallel()
+
+	type testStruct struct {
+		Field1 string                   `yaml:"field1"`
+		Bool   pipeline.DefaultTrueBool `yaml:"bool,omitempty"`
+	}
+
+	trueVal := true
+	falseVal := false
+
+	tests := []struct {
+		name  string
+		input testStruct
+		want  string
+	}{
+		{
+			name: "true values should be omitted",
+			input: testStruct{
+				Field1: "field1",
+				Bool:   pipeline.DefaultTrueBool{Value: &trueVal},
+			},
+			want: "field1: field1\n",
+		},
+		{
+			name: "false values should be marshalled",
+			input: testStruct{
+				Field1: "field1",
+				Bool:   pipeline.DefaultTrueBool{Value: &falseVal},
+			},
+			want: "field1: field1\nbool: false\n",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			buf := bytes.NewBuffer(nil)
+			enc := yaml.NewEncoder(buf)
+			enc.SetIndent(2)
+
+			err := enc.Encode(tt.input)
+			require.NoError(t, err)
+
+			yamlConfig := buf.Bytes()
+			assert.Equal(t, tt.want, string(yamlConfig))
+		})
+	}
+}