mirror of
https://github.com/jimeh/go-render.git
synced 2026-02-19 11:26:39 +00:00
feat(deps): replace yaml.v3 with goccy/go-yaml library
Replace yaml.v3 with goccy/go-yaml, as the former is now unmaintained. Also upgrade minimum Go version to 1.21.0 and update testify to v1.10.0. Add support for configuring encoder options in YAML renderer to provide more flexibility in YAML output formatting. Include new options for sequence indentation and automatic integer conversion. Implement support for both yaml.InterfaceMarshaler and yaml.BytesMarshaler interfaces with appropriate test cases. Rename mock implementation to clarify interface implementation.
This commit is contained in:
340
yaml_test.go
340
yaml_test.go
@@ -1,43 +1,58 @@
|
||||
package render
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"errors"
|
||||
"testing"
|
||||
|
||||
"github.com/goccy/go-yaml"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"gopkg.in/yaml.v3"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
type mockYAMLMarshaler struct {
|
||||
func ptr[T any](v T) *T {
|
||||
return &v
|
||||
}
|
||||
|
||||
type mockYAMLInterfaceMarshaler struct {
|
||||
val any
|
||||
err error
|
||||
}
|
||||
|
||||
var _ yaml.Marshaler = (*mockYAMLMarshaler)(nil)
|
||||
var _ yaml.InterfaceMarshaler = (*mockYAMLInterfaceMarshaler)(nil)
|
||||
|
||||
func (m *mockYAMLMarshaler) MarshalYAML() (any, error) {
|
||||
func (m *mockYAMLInterfaceMarshaler) MarshalYAML() (any, error) {
|
||||
return m.val, m.err
|
||||
}
|
||||
|
||||
type mockYAMLBytesMarshaler struct {
|
||||
val []byte
|
||||
err error
|
||||
}
|
||||
|
||||
var _ yaml.BytesMarshaler = (*mockYAMLBytesMarshaler)(nil)
|
||||
|
||||
func (m *mockYAMLBytesMarshaler) MarshalYAML() ([]byte, error) {
|
||||
return m.val, m.err
|
||||
}
|
||||
|
||||
func TestYAML_Render(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
indent int
|
||||
value any
|
||||
want string
|
||||
wantErr string
|
||||
wantErrIs []error
|
||||
wantPanic string
|
||||
name string
|
||||
encoderOptions []yaml.EncodeOption
|
||||
indent int
|
||||
value any
|
||||
want string
|
||||
writeErr error
|
||||
wantErr string
|
||||
wantErrIs []error
|
||||
}{
|
||||
{
|
||||
name: "simple object default indent",
|
||||
name: "simple object",
|
||||
value: map[string]int{"age": 30},
|
||||
want: "age: 30\n",
|
||||
},
|
||||
{
|
||||
name: "nested structure",
|
||||
indent: 0, // This will use the default indent of 2 spaces
|
||||
name: "nested object",
|
||||
value: map[string]any{
|
||||
"user": map[string]any{
|
||||
"age": 30,
|
||||
@@ -47,7 +62,44 @@ func TestYAML_Render(t *testing.T) {
|
||||
want: "user:\n age: 30\n name: John Doe\n",
|
||||
},
|
||||
{
|
||||
name: "simple object custom indent",
|
||||
name: "sequences",
|
||||
value: map[string]any{
|
||||
"items": map[string]any{
|
||||
"books": []string{
|
||||
"The Great Gatsby",
|
||||
"1984",
|
||||
},
|
||||
},
|
||||
},
|
||||
want: "items:\n books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "sequences without IndentSequence",
|
||||
encoderOptions: []yaml.EncodeOption{
|
||||
yaml.IndentSequence(false),
|
||||
},
|
||||
value: map[string]any{
|
||||
"items": map[string]any{
|
||||
"books": []string{
|
||||
"The Great Gatsby",
|
||||
"1984",
|
||||
},
|
||||
},
|
||||
},
|
||||
want: "items:\n books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "custom AutoInt encoder option",
|
||||
encoderOptions: []yaml.EncodeOption{
|
||||
yaml.AutoInt(),
|
||||
},
|
||||
value: map[string]any{
|
||||
"age": 1.0,
|
||||
},
|
||||
want: "age: 1\n",
|
||||
},
|
||||
{
|
||||
name: "nested object with custom indent",
|
||||
indent: 4,
|
||||
value: map[string]any{
|
||||
"user": map[string]any{
|
||||
@@ -58,46 +110,86 @@ func TestYAML_Render(t *testing.T) {
|
||||
want: "user:\n age: 30\n name: John Doe\n",
|
||||
},
|
||||
{
|
||||
name: "implements yaml.Marshaler",
|
||||
value: &mockYAMLMarshaler{val: map[string]int{"age": 30}},
|
||||
name: "sequences with custom indent",
|
||||
indent: 4,
|
||||
value: map[string]any{
|
||||
"items": map[string]any{
|
||||
"books": []string{
|
||||
"The Great Gatsby",
|
||||
"1984",
|
||||
},
|
||||
},
|
||||
},
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "sequences with custom indent and without IndentSequence",
|
||||
indent: 4,
|
||||
encoderOptions: []yaml.EncodeOption{
|
||||
yaml.IndentSequence(false),
|
||||
},
|
||||
value: map[string]any{
|
||||
"items": map[string]any{
|
||||
"books": []string{
|
||||
"The Great Gatsby",
|
||||
"1984",
|
||||
},
|
||||
},
|
||||
},
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "implements yaml.InterfaceMarshaler",
|
||||
value: &mockYAMLInterfaceMarshaler{val: map[string]int{"age": 30}},
|
||||
want: "age: 30\n",
|
||||
},
|
||||
{
|
||||
name: "error from yaml.Marshaler",
|
||||
value: &mockYAMLMarshaler{err: errors.New("mock error")},
|
||||
name: "error from yaml.InterfaceMarshaler",
|
||||
value: &mockYAMLInterfaceMarshaler{
|
||||
err: errors.New("mock error"),
|
||||
},
|
||||
wantErr: "render: failed: mock error",
|
||||
wantErrIs: []error{Err, ErrFailed},
|
||||
},
|
||||
{
|
||||
name: "implements yaml.BytesMarshaler",
|
||||
value: &mockYAMLBytesMarshaler{val: []byte("age: 30\n")},
|
||||
want: "age: 30\n",
|
||||
},
|
||||
{
|
||||
name: "error from yaml.BytesMarshaler",
|
||||
value: &mockYAMLBytesMarshaler{err: errors.New("mock error")},
|
||||
wantErr: "render: failed: mock error",
|
||||
wantErrIs: []error{Err, ErrFailed},
|
||||
},
|
||||
{
|
||||
name: "yaml format with error writing to writer",
|
||||
writeErr: errors.New("write error!!1"),
|
||||
value: map[string]int{"age": 30},
|
||||
wantErr: "render: failed: yaml: write error: write error!!1",
|
||||
wantErrIs: []error{Err, ErrFailed},
|
||||
},
|
||||
{
|
||||
name: "invalid value",
|
||||
indent: 0,
|
||||
value: make(chan int),
|
||||
wantPanic: "cannot marshal type: chan int",
|
||||
wantErr: "render: failed: unknown value type chan int",
|
||||
wantErrIs: []error{Err, ErrFailed},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
j := &YAML{
|
||||
Indent: tt.indent,
|
||||
Indent: tt.indent,
|
||||
EncodeOptions: tt.encoderOptions,
|
||||
}
|
||||
|
||||
var buf bytes.Buffer
|
||||
var err error
|
||||
var panicRes any
|
||||
func() {
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
panicRes = r
|
||||
}
|
||||
}()
|
||||
err = j.Render(&buf, tt.value)
|
||||
}()
|
||||
w := &mockWriter{WriteErr: tt.writeErr}
|
||||
|
||||
got := buf.String()
|
||||
err := j.Render(w, tt.value)
|
||||
got := w.String()
|
||||
|
||||
if tt.wantPanic != "" {
|
||||
assert.Equal(t, tt.wantPanic, panicRes)
|
||||
}
|
||||
if tt.wantErr != "" {
|
||||
assert.EqualError(t, err, tt.wantErr)
|
||||
}
|
||||
@@ -105,8 +197,7 @@ func TestYAML_Render(t *testing.T) {
|
||||
assert.ErrorIs(t, err, e)
|
||||
}
|
||||
|
||||
if tt.wantPanic == "" &&
|
||||
tt.wantErr == "" && len(tt.wantErrIs) == 0 {
|
||||
if tt.wantErr == "" && len(tt.wantErrIs) == 0 {
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, tt.want, got)
|
||||
}
|
||||
@@ -119,3 +210,172 @@ func TestYAML_Formats(t *testing.T) {
|
||||
|
||||
assert.Equal(t, []string{"yaml", "yml"}, h.Formats())
|
||||
}
|
||||
|
||||
func TestYAML_DefaultIndent(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
defaultVal *int
|
||||
indent int
|
||||
encoderOptions []yaml.EncodeOption
|
||||
want string
|
||||
}{
|
||||
{
|
||||
name: "do not set default, indent, or encoder options",
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "custom default takes precedence over default",
|
||||
defaultVal: ptr(4),
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "indent takes precedence over default",
|
||||
indent: 4,
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "encoder option takes precedence over default",
|
||||
encoderOptions: []yaml.EncodeOption{
|
||||
yaml.Indent(4),
|
||||
},
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "indent takes precedence over custom default",
|
||||
defaultVal: ptr(4),
|
||||
indent: 3,
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "encoder option takes precedence over indent",
|
||||
indent: 4,
|
||||
encoderOptions: []yaml.EncodeOption{
|
||||
yaml.Indent(3),
|
||||
},
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "encoder option takes precedence over indent and " +
|
||||
"custom default",
|
||||
defaultVal: ptr(5),
|
||||
indent: 4,
|
||||
encoderOptions: []yaml.EncodeOption{
|
||||
yaml.Indent(3),
|
||||
},
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
// Capture and restore the original default value.
|
||||
originalDefault := YAMLDefaultIndent
|
||||
t.Cleanup(func() { YAMLDefaultIndent = originalDefault })
|
||||
|
||||
if tt.defaultVal != nil {
|
||||
YAMLDefaultIndent = *tt.defaultVal
|
||||
}
|
||||
|
||||
y := &YAML{
|
||||
Indent: tt.indent,
|
||||
EncodeOptions: tt.encoderOptions,
|
||||
}
|
||||
w := &mockWriter{}
|
||||
|
||||
value := map[string]any{
|
||||
"items": map[string]any{
|
||||
"books": []string{
|
||||
"The Great Gatsby",
|
||||
"1984",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
err := y.Render(w, value)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, tt.want, w.String())
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestYAML_DefaultIndentSequence(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
defaultVal *bool
|
||||
encoderOptions []yaml.EncodeOption
|
||||
want string
|
||||
}{
|
||||
{
|
||||
name: "do not set default or encoder options",
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "set default to true",
|
||||
defaultVal: ptr(true),
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "set default to true and encoder option to false",
|
||||
defaultVal: ptr(true),
|
||||
encoderOptions: []yaml.EncodeOption{
|
||||
yaml.IndentSequence(false),
|
||||
},
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "set default to false",
|
||||
defaultVal: ptr(false),
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
{
|
||||
name: "set default to false and encoder option to true",
|
||||
defaultVal: ptr(false),
|
||||
encoderOptions: []yaml.EncodeOption{
|
||||
yaml.IndentSequence(true),
|
||||
},
|
||||
want: "items:\n " +
|
||||
"books:\n - The Great Gatsby\n - \"1984\"\n",
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
// Capture and restore the original default value.
|
||||
originalDefault := YAMLDefaultIndentSequence
|
||||
t.Cleanup(func() { YAMLDefaultIndentSequence = originalDefault })
|
||||
|
||||
if tt.defaultVal != nil {
|
||||
YAMLDefaultIndentSequence = *tt.defaultVal
|
||||
}
|
||||
|
||||
y := &YAML{
|
||||
EncodeOptions: tt.encoderOptions,
|
||||
}
|
||||
w := &mockWriter{}
|
||||
|
||||
value := map[string]any{
|
||||
"items": map[string]any{
|
||||
"books": []string{
|
||||
"The Great Gatsby",
|
||||
"1984",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
err := y.Render(w, value)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, tt.want, w.String())
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user