summaryrefslogtreecommitdiff
path: root/util/codecs/json_test.go
blob: 18745c7f6ec277a1b1f971a8add04f1f105405ab (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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
// Copyright (C) 2019-2024 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.

package codecs

import (
	"bytes"
	"os"
	"path"
	"testing"
	"time"

	"github.com/stretchr/testify/require"

	"github.com/algorand/go-algorand/test/partitiontest"
)

type testValue struct {
	Bool   bool
	String string
	Int    int
}

func TestIsDefaultValue(t *testing.T) {
	partitiontest.PartitionTest(t)
	t.Parallel()

	a := require.New(t)

	v := testValue{
		Bool:   true,
		String: "default",
		Int:    1,
	}
	def := testValue{
		Bool:   true,
		String: "default",
		Int:    2,
	}

	objectValues := createValueMap(v)
	defaultValues := createValueMap(def)

	a.True(isDefaultValue("Bool", objectValues, defaultValues))
	a.True(isDefaultValue("String", objectValues, defaultValues))
	a.False(isDefaultValue("Int", objectValues, defaultValues))
	a.True(isDefaultValue("Missing", objectValues, defaultValues))
}

func TestSaveObjectToFile(t *testing.T) {
	partitiontest.PartitionTest(t)
	t.Parallel()

	type TestType struct {
		A uint64
		B string
	}

	obj := TestType{1024, "test"}

	// prettyFormat = false
	{
		filename := path.Join(t.TempDir(), "test.json")
		SaveObjectToFile(filename, obj, false)
		data, err := os.ReadFile(filename)
		require.NoError(t, err)
		expected := `{"A":1024,"B":"test"}
`
		require.Equal(t, expected, string(data))
	}

	// prettyFormat = true
	{
		filename := path.Join(t.TempDir(), "test.json")
		SaveObjectToFile(filename, obj, true)
		data, err := os.ReadFile(filename)
		require.NoError(t, err)
		expected := `{
	"A": 1024,
	"B": "test"
}
`
		require.Equal(t, expected, string(data))
	}

}

func TestWriteNonDefaultValue(t *testing.T) {
	partitiontest.PartitionTest(t)
	t.Parallel()

	type TestType struct {
		Version       uint32
		Archival      bool
		GossipFanout  int
		NetAddress    string
		ReconnectTime time.Duration
	}

	defaultObject := TestType{
		Version:       1,
		Archival:      true,
		GossipFanout:  50,
		NetAddress:    "Denver",
		ReconnectTime: 60 * time.Second,
	}

	testcases := []struct {
		name   string
		in     TestType
		out    string
		ignore []string
	}{
		{
			name: "all defaults",
			in:   defaultObject,
			out: `{
}`,
		}, {
			name: "some defaults",
			in: TestType{
				Version:       1,
				Archival:      false,
				GossipFanout:  25,
				NetAddress:    "Denver",
				ReconnectTime: 60 * time.Nanosecond,
			},
			out: `{
	"Archival": false,
	"GossipFanout": 25,
	"ReconnectTime": 60
}`,
		}, {
			name:   "ignore",
			in:     defaultObject,
			ignore: []string{"Version", "Archival", "GossipFanout", "NetAddress", "ReconnectTime"},
			out: `{
	"Version": 1,
	"Archival": true,
	"GossipFanout": 50,
	"NetAddress": "Denver",
	"ReconnectTime": 60000000000
}`,
		},
	}

	for _, tc := range testcases {
		tc := tc
		t.Run(tc.name, func(t *testing.T) {
			t.Parallel()
			a := require.New(t)
			var writer bytes.Buffer
			err := WriteNonDefaultValues(&writer, tc.in, defaultObject, tc.ignore)
			a.NoError(err)
			a.Equal(tc.out, writer.String())
		})
	}
}