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
|
package trace2
import (
"context"
"fmt"
"os"
"regexp"
"strings"
"testing"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v15/internal/testhelper"
)
type dummyHook struct {
name string
handler func(context.Context, *Trace) error
}
func (h *dummyHook) Name() string {
return h.name
}
func (h *dummyHook) Handle(ctx context.Context, trace *Trace) error {
return h.handler(ctx, trace)
}
func TestManager(t *testing.T) {
t.Parallel()
expectedTrace := strings.TrimSpace(`
| | main | root
| | main | .version
| | main | .start
| | main | .def_repo
| | main | .pack-objects:enumerate-objects
| | main | ..progress:Enumerating objects
| | main | .pack-objects:prepare-pack
| | main | ..progress:Counting objects
| | main | .pack-objects:write-pack-file
| | main | ..progress:Writing objects
| | main | ..data:pack-objects:write_pack_file/wrote
| | main | .data:fsync:fsync/writeout-only
`)
events := testhelper.MustReadFile(t, "testdata/git-pack-objects.event")
for _, tc := range []struct {
desc string
setup func() (bool, []Hook, func(*testing.T, *Manager))
expectedErr error
}{
{
desc: "empty hooks",
setup: func() (bool, []Hook, func(*testing.T, *Manager)) {
return false, nil, nil
},
expectedErr: fmt.Errorf("input hooks are empty"),
},
{
desc: "one hook",
setup: func() (bool, []Hook, func(*testing.T, *Manager)) {
hook := dummyHook{
name: "dummy",
handler: func(ctx context.Context, trace *Trace) error {
require.Equal(t, expectedTrace, trace.Inspect(false))
return nil
},
}
return true, []Hook{&hook}, nil
},
},
{
desc: "multiple hooks",
setup: func() (bool, []Hook, func(*testing.T, *Manager)) {
var dispatched []string
hook1 := dummyHook{
name: "dummy1",
handler: func(ctx context.Context, trace *Trace) error {
dispatched = append(dispatched, "dummy1")
require.Equal(t, expectedTrace, trace.Inspect(false))
return nil
},
}
hook2 := dummyHook{
name: "dummy2",
handler: func(ctx context.Context, trace *Trace) error {
dispatched = append(dispatched, "dummy2")
require.Equal(t, expectedTrace, trace.Inspect(false))
return nil
},
}
return true, []Hook{&hook1, &hook2}, func(t *testing.T, manager *Manager) {
require.Equal(t, []string{"dummy1", "dummy2"}, dispatched)
}
},
},
} {
t.Run(tc.desc, func(t *testing.T) {
activated, hooks, assert := tc.setup()
manager, err := NewManager("1234", hooks)
if tc.expectedErr != nil {
require.Equal(t, tc.expectedErr, err)
return
}
require.NoError(t, err)
envs := []string{"CORRELATION_ID=1234"}
injectedEnvs := manager.Inject(envs)
if activated {
require.Equal(t, "CORRELATION_ID=1234", injectedEnvs[0])
require.Regexp(t, regexp.MustCompile("^GIT_TRACE2_EVENT=.*$"), injectedEnvs[1])
require.Equal(t, "GIT_TRACE2_PARENT_SID=1234", injectedEnvs[2])
require.Equal(t, "GIT_TRACE2_BRIEF=true", injectedEnvs[3])
require.FileExists(t, manager.fd.Name())
require.NoError(t, os.WriteFile(manager.fd.Name(), events, os.ModeAppend))
} else {
require.Equal(t, envs, injectedEnvs)
require.Nil(t, manager.fd)
}
manager.Finish(testhelper.Context(t))
require.NoError(t, manager.Error())
if activated {
require.NoFileExists(t, manager.fd.Name())
}
if assert != nil {
assert(t, manager)
}
})
}
}
func TestManager_tempfileFailures(t *testing.T) {
t.Parallel()
for _, tc := range []struct {
desc string
setup func(*testing.T, *Manager)
expectedError *regexp.Regexp
}{
{
desc: "invalid events",
setup: func(t *testing.T, manager *Manager) {
require.NoError(t, os.WriteFile(manager.fd.Name(), []byte("something invalid"), os.ModeAppend))
},
expectedError: regexp.MustCompile("trace2: parsing events: reading event: decoding event: invalid character 's' looking for beginning of value"),
},
{
desc: "tempfile closed",
setup: func(t *testing.T, manager *Manager) {
require.NoError(t, manager.fd.Close())
},
expectedError: regexp.MustCompile("trace2: parsing events: reading event: decoding event:.*file already closed$"),
},
{
desc: "tempfile removed",
setup: func(t *testing.T, manager *Manager) {
require.NoError(t, os.Remove(manager.fd.Name()))
},
expectedError: regexp.MustCompile("trace2: no events to handle$"),
},
} {
t.Run(tc.desc, func(t *testing.T) {
hook := dummyHook{
name: "dummy",
handler: func(ctx context.Context, trace *Trace) error {
require.Fail(t, "must not trigger handler if event file has troubles")
return nil
},
}
manager, err := NewManager("1234", []Hook{&hook})
require.NoError(t, err)
_ = manager.Inject([]string{})
tc.setup(t, manager)
manager.Finish(testhelper.Context(t))
require.Regexp(t, tc.expectedError, manager.Error().Error())
require.NoFileExists(t, manager.fd.Name())
})
}
}
func TestManager_handlerFailures(t *testing.T) {
t.Parallel()
hook1 := dummyHook{
name: "dummy1",
handler: func(ctx context.Context, trace *Trace) error { return nil },
}
hook2 := dummyHook{
name: "dummy2",
handler: func(ctx context.Context, trace *Trace) error { return fmt.Errorf("something goes wrong") },
}
hook3 := dummyHook{
name: "dummy3",
handler: func(ctx context.Context, trace *Trace) error {
require.Fail(t, "should not trigger the next hook if the prior one fails")
return nil
},
}
manager, err := NewManager("1234", []Hook{&hook1, &hook2, &hook3})
require.NoError(t, err)
_ = manager.Inject([]string{})
events := testhelper.MustReadFile(t, "testdata/git-pack-objects.event")
require.NoError(t, os.WriteFile(manager.fd.Name(), events, os.ModeAppend))
manager.Finish(testhelper.Context(t))
require.Equal(t, `trace2: executing "dummy2" handler: something goes wrong`, manager.Error().Error())
require.NoFileExists(t, manager.fd.Name())
}
|
