summaryrefslogtreecommitdiffhomepage
path: root/types/jsonx/json_test.go
blob: 0f2a646c40d6dab18afc1f5b2326b390019e7145 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
// Copyright (c) Tailscale Inc & AUTHORS
// SPDX-License-Identifier: BSD-3-Clause

package jsonx

import (
	"errors"
	"testing"

	"github.com/go-json-experiment/json"
	"github.com/go-json-experiment/json/jsontext"
	"github.com/google/go-cmp/cmp"
	"tailscale.com/types/ptr"
)

type Interface interface {
	implementsInterface()
}

type Foo string

func (Foo) implementsInterface() {}

type Bar int

func (Bar) implementsInterface() {}

type Baz struct{ Fizz, Buzz string }

func (*Baz) implementsInterface() {}

var interfaceCoders = MakeInterfaceCoders(map[string]Interface{
	"Foo": Foo(""),
	"Bar": (*Bar)(nil),
	"Baz": (*Baz)(nil),
})

type InterfaceWrapper struct{ Interface }

func (w InterfaceWrapper) MarshalJSONTo(enc *jsontext.Encoder) error {
	return interfaceCoders.Marshal(enc, &w.Interface)
}

func (w *InterfaceWrapper) UnmarshalJSONFrom(dec *jsontext.Decoder) error {
	return interfaceCoders.Unmarshal(dec, &w.Interface)
}

func TestInterfaceCoders(t *testing.T) {
	var opts json.Options = json.JoinOptions(
		json.WithMarshalers(json.MarshalToFunc(interfaceCoders.Marshal)),
		json.WithUnmarshalers(json.UnmarshalFromFunc(interfaceCoders.Unmarshal)),
	)

	errSkipMarshal := errors.New("skip marshal")
	makeFiller := func() InterfaceWrapper {
		return InterfaceWrapper{&Baz{"fizz", "buzz"}}
	}

	for _, tt := range []struct {
		label              string
		wantVal            InterfaceWrapper
		wantJSON           string
		wantMarshalError   error
		wantUnmarshalError error
	}{{
		label:    "Null",
		wantVal:  InterfaceWrapper{},
		wantJSON: `null`,
	}, {
		label:    "Foo",
		wantVal:  InterfaceWrapper{Foo("hello")},
		wantJSON: `{"Foo":"hello"}`,
	}, {
		label:    "BarPointer",
		wantVal:  InterfaceWrapper{ptr.To(Bar(5))},
		wantJSON: `{"Bar":5}`,
	}, {
		label:   "BarValue",
		wantVal: InterfaceWrapper{Bar(5)},
		// NOTE: We could handle BarValue just like BarPointer,
		// but round-trip marshal/unmarshal would not be identical.
		wantMarshalError: errUnknownTypeName,
	}, {
		label:    "Baz",
		wantVal:  InterfaceWrapper{&Baz{"alpha", "omega"}},
		wantJSON: `{"Baz":{"Fizz":"alpha","Buzz":"omega"}}`,
	}, {
		label:              "Unknown",
		wantVal:            makeFiller(),
		wantJSON:           `{"Unknown":[1,2,3]}`,
		wantMarshalError:   errSkipMarshal,
		wantUnmarshalError: errUnknownTypeName,
	}, {
		label:              "Empty",
		wantVal:            makeFiller(),
		wantJSON:           `{}`,
		wantMarshalError:   errSkipMarshal,
		wantUnmarshalError: errNonSingularValue,
	}, {
		label:              "Duplicate",
		wantVal:            InterfaceWrapper{Foo("hello")}, // first entry wins
		wantJSON:           `{"Foo":"hello","Bar":5}`,
		wantMarshalError:   errSkipMarshal,
		wantUnmarshalError: errNonSingularValue,
	}} {
		t.Run(tt.label, func(t *testing.T) {
			if tt.wantMarshalError != errSkipMarshal {
				switch gotJSON, err := json.Marshal(&tt.wantVal); {
				case !errors.Is(err, tt.wantMarshalError):
					t.Fatalf("json.Marshal(%v) error = %v, want %v", tt.wantVal, err, tt.wantMarshalError)
				case string(gotJSON) != tt.wantJSON:
					t.Fatalf("json.Marshal(%v) = %s, want %s", tt.wantVal, gotJSON, tt.wantJSON)
				}
				switch gotJSON, err := json.Marshal(&tt.wantVal.Interface, opts); {
				case !errors.Is(err, tt.wantMarshalError):
					t.Fatalf("json.Marshal(%v) error = %v, want %v", tt.wantVal, err, tt.wantMarshalError)
				case string(gotJSON) != tt.wantJSON:
					t.Fatalf("json.Marshal(%v) = %s, want %s", tt.wantVal, gotJSON, tt.wantJSON)
				}
			}

			if tt.wantJSON != "" {
				gotVal := makeFiller()
				if err := json.Unmarshal([]byte(tt.wantJSON), &gotVal); !errors.Is(err, tt.wantUnmarshalError) {
					t.Fatalf("json.Unmarshal(%v) error = %v, want %v", tt.wantJSON, err, tt.wantUnmarshalError)
				}
				if d := cmp.Diff(gotVal, tt.wantVal); d != "" {
					t.Fatalf("json.Unmarshal(%v):\n%s", tt.wantJSON, d)
				}
				gotVal = makeFiller()
				if err := json.Unmarshal([]byte(tt.wantJSON), &gotVal.Interface, opts); !errors.Is(err, tt.wantUnmarshalError) {
					t.Fatalf("json.Unmarshal(%v) error = %v, want %v", tt.wantJSON, err, tt.wantUnmarshalError)
				}
				if d := cmp.Diff(gotVal, tt.wantVal); d != "" {
					t.Fatalf("json.Unmarshal(%v):\n%s", tt.wantJSON, d)
				}
			}
		})
	}
}