summaryrefslogtreecommitdiff
path: root/internal/flags/flags_test.go
blob: 93df7b0ffbb0b276701796e773b5f9bc79feb03a (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
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
package flags

import (
	"flag"
	"io"
	"strings"
	"testing"
	"time"
)

// parseForTest builds a fresh FlagSet and parses the given args, returning
// the resulting Config. It avoids touching any global state so tests can run
// in parallel without interfering with each other.
func parseForTest(t *testing.T, args ...string) (Config, error) {
	t.Helper()
	fs := flag.NewFlagSet("ior-test", flag.ContinueOnError)
	fs.SetOutput(io.Discard)
	return parseFromFlagSet(fs, args)
}

func TestParseLiveIntervalAndPID(t *testing.T) {
	cfg, err := parseForTest(t, "-live-interval", "200ms", "-pid", "1234")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}

	if cfg.LiveInterval != 200*time.Millisecond {
		t.Fatalf("live interval = %v, want %v", cfg.LiveInterval, 200*time.Millisecond)
	}
	if cfg.PidFilter != 1234 {
		t.Fatalf("pid filter = %d, want 1234", cfg.PidFilter)
	}
	if got := cfg.GetPidFilter(); got != 1234 {
		t.Fatalf("cfg.GetPidFilter() = %d, want 1234", got)
	}
}

func TestNewFlagsDefaultsAndGetters(t *testing.T) {
	cfg := NewFlags()
	if cfg.GetPidFilter() != -1 {
		t.Fatalf("GetPidFilter() = %d, want -1", cfg.GetPidFilter())
	}
	if cfg.GetTidFilter() != -1 {
		t.Fatalf("GetTidFilter() = %d, want -1", cfg.GetTidFilter())
	}
	if !cfg.GetTUIExportEnable() {
		t.Fatalf("GetTUIExportEnable() = false, want true")
	}
	if cfg.CountField != "count" {
		t.Fatalf("CountField = %q, want count", cfg.CountField)
	}
}

func TestParseLiveDefaults(t *testing.T) {
	cfg, err := parseForTest(t)
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}

	if cfg.LiveInterval != 200*time.Millisecond {
		t.Fatalf("default live interval = %v, want %v", cfg.LiveInterval, 200*time.Millisecond)
	}
}

func TestParseTestFlamesFlag(t *testing.T) {
	cfg, err := parseForTest(t, "--testflames")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if !cfg.TestFlames {
		t.Fatalf("expected --testflames to enable static flamegraph test mode")
	}
}

func TestParseTestLiveFlamesFlag(t *testing.T) {
	cfg, err := parseForTest(t, "--testliveflames")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if !cfg.TestLiveFlames {
		t.Fatalf("expected --testliveflames to enable synthetic live flamegraph test mode")
	}
}

func TestParseFlamegraphOutputFlags(t *testing.T) {
	cfg, err := parseForTest(t, "--flamegraph", "--name", "scenario-run")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if !cfg.FlamegraphOutput {
		t.Fatalf("expected --flamegraph to enable .ior.zst output mode")
	}
	if got, want := cfg.OutputName, "scenario-run"; got != want {
		t.Fatalf("output name = %q, want %q", got, want)
	}
}

func TestParseParquetOutputFlag(t *testing.T) {
	cfg, err := parseForTest(t, "--parquet", "trace-run")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if got, want := cfg.ParquetPath, "trace-run"; got != want {
		t.Fatalf("parquet path = %q, want %q", got, want)
	}
}

func TestParseDefaultCollapsedFieldsOrder(t *testing.T) {
	cfg, err := parseForTest(t)
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}

	want := []string{"comm", "tracepoint", "path"}
	if len(cfg.CollapsedFields) != len(want) {
		t.Fatalf("default collapsed fields len = %d, want %d", len(cfg.CollapsedFields), len(want))
	}
	for i := range want {
		if cfg.CollapsedFields[i] != want[i] {
			t.Fatalf("default collapsed fields[%d] = %q, want %q", i, cfg.CollapsedFields[i], want[i])
		}
	}
}

func TestParseInvalidCollapsedFieldReturnsError(t *testing.T) {
	_, err := parseForTest(t, "-fields", "comm,invalid")
	if err == nil {
		t.Fatalf("expected parse error for invalid collapsed field")
	}
	if !strings.Contains(err.Error(), "invalid field for collapse: invalid") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParseInvalidCountFieldReturnsError(t *testing.T) {
	_, err := parseForTest(t, "-count", "invalid")
	if err == nil {
		t.Fatalf("expected parse error for invalid count field")
	}
	if !strings.Contains(err.Error(), "invalid count field: invalid") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParseInvalidTracepointRegexReturnsError(t *testing.T) {
	_, err := parseForTest(t, "-tps", "[")
	if err == nil {
		t.Fatalf("expected parse error for invalid tracepoint regex")
	}
	if !strings.Contains(err.Error(), "unable to compile regex") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParseDefaultTraceDimensionsFSOnly(t *testing.T) {
	cfg, err := parseForTest(t)
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if !cfg.TracepointSelector.ShouldAttach("sys_enter_openat") {
		t.Fatal("expected openat attached by default")
	}
	if cfg.TracepointSelector.ShouldAttach("sys_enter_nanosleep") {
		t.Fatal("expected nanosleep excluded by default")
	}
}

func TestParseTraceFamiliesFlag(t *testing.T) {
	cfg, err := parseForTest(t, "-trace-families", "Time")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if !cfg.TracepointSelector.ShouldAttach("sys_enter_nanosleep") {
		t.Fatal("expected nanosleep attached for Time family")
	}
	if cfg.TracepointSelector.ShouldAttach("sys_enter_openat") {
		t.Fatal("expected openat excluded when only Time family enabled")
	}
}

func TestParseTraceKindsFlag(t *testing.T) {
	cfg, err := parseForTest(t, "-trace-kinds", "sleep")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if !cfg.TracepointSelector.ShouldAttach("sys_enter_nanosleep") {
		t.Fatal("expected nanosleep attached for sleep kind")
	}
	if cfg.TracepointSelector.ShouldAttach("sys_enter_openat") {
		t.Fatal("expected openat excluded for sleep-only selector")
	}
}

func TestParseTraceSyscallsFlag(t *testing.T) {
	cfg, err := parseForTest(t, "-trace-syscalls", "openat")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if !cfg.TracepointSelector.ShouldAttach("sys_enter_openat") || !cfg.TracepointSelector.ShouldAttach("sys_exit_openat") {
		t.Fatal("expected openat enter/exit attached")
	}
	if cfg.TracepointSelector.ShouldAttach("sys_enter_write") {
		t.Fatal("expected write excluded when only openat enabled")
	}
}

func TestParseTraceDimensionsUnionAndExclusions(t *testing.T) {
	cfg, err := parseForTest(t,
		"-trace-families", "Time",
		"-trace-syscalls", "openat",
		"-no-trace-syscalls", "openat",
	)
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if cfg.TracepointSelector.ShouldAttach("sys_enter_openat") {
		t.Fatal("expected openat excluded by no-trace-syscalls")
	}
	if !cfg.TracepointSelector.ShouldAttach("sys_enter_nanosleep") {
		t.Fatal("expected nanosleep still attached from trace-families")
	}
}

func TestParseTraceFamiliesRejectsUnknown(t *testing.T) {
	_, err := parseForTest(t, "-trace-families", "Nope")
	if err == nil {
		t.Fatal("expected parse error")
	}
	if !strings.Contains(err.Error(), "invalid syscall family") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParseTraceKindsRejectsUnknown(t *testing.T) {
	_, err := parseForTest(t, "-trace-kinds", "not-a-kind")
	if err == nil {
		t.Fatal("expected parse error")
	}
	if !strings.Contains(err.Error(), "invalid syscall kind") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParseTraceSyscallsRejectsUnknown(t *testing.T) {
	_, err := parseForTest(t, "-trace-syscalls", "definitely_not_syscall")
	if err == nil {
		t.Fatal("expected parse error")
	}
	if !strings.Contains(err.Error(), "invalid syscall in trace selector") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParseResetTimerDefault(t *testing.T) {
	cfg, err := parseForTest(t)
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if cfg.ResetTimer != DefaultResetTimer {
		t.Fatalf("default reset timer = %v, want %v", cfg.ResetTimer, DefaultResetTimer)
	}
}

func TestParseResetTimerOverride(t *testing.T) {
	cfg, err := parseForTest(t, "-resetTimer", "45s")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if cfg.ResetTimer != 45*time.Second {
		t.Fatalf("reset timer = %v, want 45s", cfg.ResetTimer)
	}
}

func TestParseResetTimerZeroDisables(t *testing.T) {
	cfg, err := parseForTest(t, "-resetTimer", "0")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if cfg.ResetTimer != 0 {
		t.Fatalf("reset timer = %v, want 0 (disabled)", cfg.ResetTimer)
	}
}

func TestParseResetTimerNegativeReturnsError(t *testing.T) {
	_, err := parseForTest(t, "-resetTimer", "-5s")
	if err == nil {
		t.Fatalf("expected parse error for negative reset timer")
	}
	if !strings.Contains(err.Error(), "invalid resetTimer") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParseDurationNegativeReturnsError(t *testing.T) {
	_, err := parseForTest(t, "-duration", "-1")
	if err == nil {
		t.Fatalf("expected parse error for negative duration")
	}
	if !strings.Contains(err.Error(), "invalid duration") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParseDurationZeroReturnsError(t *testing.T) {
	_, err := parseForTest(t, "-duration", "0")
	if err == nil {
		t.Fatalf("expected parse error for zero duration")
	}
	if !strings.Contains(err.Error(), "invalid duration") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParseDurationPositiveAccepted(t *testing.T) {
	cfg, err := parseForTest(t, "-duration", "60")
	if err != nil {
		t.Fatalf("parse returned unexpected error: %v", err)
	}
	if cfg.Duration != 60 {
		t.Fatalf("duration = %d, want 60", cfg.Duration)
	}
}

func TestParseNegativeMapSizeReturnsError(t *testing.T) {
	// A negative mapSize wraps to a huge uint32 when cast in resizeBPFMaps,
	// causing a confusing BPF load failure. Parse must catch it early.
	_, err := parseForTest(t, "-mapSize", "-1")
	if err == nil {
		t.Fatalf("expected parse error for negative mapSize")
	}
	if !strings.Contains(err.Error(), "invalid mapSize") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParseZeroMapSizeReturnsError(t *testing.T) {
	// A zero mapSize would allocate an empty BPF ring buffer, which is
	// equally invalid. Parse must catch it early.
	_, err := parseForTest(t, "-mapSize", "0")
	if err == nil {
		t.Fatalf("expected parse error for zero mapSize")
	}
	if !strings.Contains(err.Error(), "invalid mapSize") {
		t.Fatalf("unexpected error: %v", err)
	}
}

func TestParsePositiveMapSizeAccepted(t *testing.T) {
	cfg, err := parseForTest(t, "-mapSize", "8192")
	if err != nil {
		t.Fatalf("parse returned unexpected error: %v", err)
	}
	if cfg.EventMapSize != 8192 {
		t.Fatalf("EventMapSize = %d, want 8192", cfg.EventMapSize)
	}
}

func TestParseTUIFastRefreshDefault(t *testing.T) {
	// Default should be 250ms — the high-frequency refresh cadence used by
	// the flamegraph and stream tabs when no explicit flag is provided.
	cfg, err := parseForTest(t)
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if cfg.TUIFastRefreshInterval != 250*time.Millisecond {
		t.Fatalf("default TUIFastRefreshInterval = %v, want 250ms", cfg.TUIFastRefreshInterval)
	}
}

func TestParseTUIFastRefreshOverride(t *testing.T) {
	// An explicit -tui-fast-refresh value must be respected and stored on cfg.
	cfg, err := parseForTest(t, "-tui-fast-refresh", "100ms")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if cfg.TUIFastRefreshInterval != 100*time.Millisecond {
		t.Fatalf("TUIFastRefreshInterval = %v, want 100ms", cfg.TUIFastRefreshInterval)
	}
}

func TestParseTUIFastRefreshZeroDisables(t *testing.T) {
	// A zero value is valid and means "disable high-frequency refresh",
	// falling back to the default Bubble Tea tick rate.
	cfg, err := parseForTest(t, "-tui-fast-refresh", "0")
	if err != nil {
		t.Fatalf("parse returned error: %v", err)
	}
	if cfg.TUIFastRefreshInterval != 0 {
		t.Fatalf("TUIFastRefreshInterval = %v, want 0 (disabled)", cfg.TUIFastRefreshInterval)
	}
}