File: components_test.go

package info (click to toggle)
golang-github-mmcloughlin-avo 0.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 15,024 kB
  • sloc: xml: 71,029; asm: 14,862; sh: 194; makefile: 21; ansic: 11
file content (229 lines) | stat: -rw-r--r-- 5,408 bytes parent folder | download
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
package gotypes

import (
	"errors"
	"go/token"
	"go/types"
	"strings"
	"testing"

	"github.com/mmcloughlin/avo/operand"
	"github.com/mmcloughlin/avo/reg"
)

func TestBasicKindsArePrimitive(t *testing.T) {
	kinds := []types.BasicKind{
		types.Bool,
		types.Int,
		types.Int8,
		types.Int16,
		types.Int32,
		types.Int64,
		types.Uint,
		types.Uint8,
		types.Uint16,
		types.Uint32,
		types.Uint64,
		types.Uintptr,
		types.Float32,
		types.Float64,
	}
	for _, k := range kinds {
		AssertPrimitive(t, types.Typ[k])
	}
}

func TestPointersArePrimitive(t *testing.T) {
	typ := types.NewPointer(types.Typ[types.Uint32])
	AssertPrimitive(t, typ)
}

func AssertPrimitive(t *testing.T, typ types.Type) {
	t.Helper()
	c := NewComponent(typ, operand.NewParamAddr("primitive", 0))
	if _, err := c.Resolve(); err != nil {
		t.Errorf("expected type %s to be primitive: got error '%s'", typ, err)
	}
}

func TestComponentErrors(t *testing.T) {
	comp := NewComponent(types.Typ[types.Uint32], operand.Mem{})
	cases := []struct {
		Component      Component
		ErrorSubstring string
	}{
		{comp.Base(), "only slices and strings"},
		{comp.Len(), "only slices and strings"},
		{comp.Cap(), "only slices have"},
		{comp.Real(), "only complex"},
		{comp.Imag(), "only complex"},
		{comp.Index(42), "not array type"},
		{comp.Field("a"), "not struct type"},
		{comp.Dereference(reg.R12), "not pointer type"},
	}
	for _, c := range cases {
		_, err := c.Component.Resolve()
		if err == nil {
			t.Fatal("expected error")
		}
		if !strings.Contains(err.Error(), c.ErrorSubstring) {
			t.Fatalf("error message %q; expected substring %q", err.Error(), c.ErrorSubstring)
		}
	}
}

func TestComponentErrorChaining(t *testing.T) {
	// Build a component with an error.
	comp := NewComponent(types.Typ[types.Uint32], operand.Mem{}).Index(3)
	_, expect := comp.Resolve()
	if expect == nil {
		t.Fatal("expected error")
	}

	// Confirm that the error is preserved through chaining operations.
	cases := []Component{
		comp.Dereference(reg.R13),
		comp.Base(),
		comp.Len(),
		comp.Cap(),
		comp.Real(),
		comp.Imag(),
		comp.Index(42),
		comp.Field("field"),
	}
	for _, c := range cases {
		_, err := c.Resolve()
		if !errors.Is(err, expect) {
			t.Fatal("chaining should preserve error")
		}
	}
}

func TestComponentDeconstruction(t *testing.T) {
	cases := []struct {
		Name   string
		Type   types.Type
		Chain  func(Component) Component
		Param  string
		Offset int
	}{
		{
			Name:   "slice_base",
			Type:   types.NewSlice(types.Typ[types.Uint64]),
			Chain:  func(c Component) Component { return c.Base() },
			Param:  "base",
			Offset: 0,
		},
		{
			Name:   "slice_len",
			Type:   types.NewSlice(types.Typ[types.Uint64]),
			Chain:  func(c Component) Component { return c.Len() },
			Param:  "len",
			Offset: 8,
		},
		{
			Name:   "slice_cap",
			Type:   types.NewSlice(types.Typ[types.Uint64]),
			Chain:  func(c Component) Component { return c.Cap() },
			Param:  "cap",
			Offset: 16,
		},
		{
			Name:   "string_base",
			Type:   types.Typ[types.String],
			Chain:  func(c Component) Component { return c.Base() },
			Param:  "base",
			Offset: 0,
		},
		{
			Name:   "slice_len",
			Type:   types.Typ[types.String],
			Chain:  func(c Component) Component { return c.Len() },
			Param:  "len",
			Offset: 8,
		},
		{
			Name:   "complex64_real",
			Type:   types.Typ[types.Complex64],
			Chain:  func(c Component) Component { return c.Real() },
			Param:  "real",
			Offset: 0,
		},
		{
			Name:   "complex64_imag",
			Type:   types.Typ[types.Complex64],
			Chain:  func(c Component) Component { return c.Imag() },
			Param:  "imag",
			Offset: 4,
		},
		{
			Name:   "complex128_real",
			Type:   types.Typ[types.Complex128],
			Chain:  func(c Component) Component { return c.Real() },
			Param:  "real",
			Offset: 0,
		},
		{
			Name:   "complex128_imag",
			Type:   types.Typ[types.Complex128],
			Chain:  func(c Component) Component { return c.Imag() },
			Param:  "imag",
			Offset: 8,
		},
		{
			Name:   "array",
			Type:   types.NewArray(types.Typ[types.Uint32], 7),
			Chain:  func(c Component) Component { return c.Index(3) },
			Param:  "3",
			Offset: 12,
		},
		{
			Name: "struct",
			Type: types.NewStruct([]*types.Var{
				types.NewField(token.NoPos, nil, "Byte", types.Typ[types.Byte], false),
				types.NewField(token.NoPos, nil, "Uint64", types.Typ[types.Uint64], false),
			}, nil),
			Chain:  func(c Component) Component { return c.Field("Uint64") },
			Param:  "Uint64",
			Offset: 8,
		},
	}

	// For every test case, generate the same case but when the type is wrapped in
	// a named type.
	n := len(cases)
	for i := 0; i < n; i++ {
		wrapped := cases[i]
		wrapped.Name += "_wrapped"
		wrapped.Type = types.NewNamed(
			types.NewTypeName(token.NoPos, nil, "wrapped", nil),
			wrapped.Type,
			nil,
		)
		cases = append(cases, wrapped)
	}

	for _, c := range cases {
		c := c // avoid scopelint error
		t.Run(c.Name, func(t *testing.T) {
			t.Log(c.Type)
			base := operand.NewParamAddr("test", 0)
			comp := NewComponent(c.Type, base)
			comp = c.Chain(comp)

			b, err := comp.Resolve()
			if err != nil {
				t.Fatal(err)
			}

			expectname := "test_" + c.Param
			if b.Addr.Symbol.Name != expectname {
				t.Errorf("parameter name %q; expected %q", b.Addr.Symbol.Name, expectname)
			}

			if b.Addr.Disp != c.Offset {
				t.Errorf("offset %d; expected %d", b.Addr.Disp, c.Offset)
			}
		})
	}
}