Skip to content

Commit 83de6cc

Browse files
committed
Use t.Fatalf instead of panic
The function is designed for testing. Passing testing.TB makes the intention more clear.
1 parent 940a4bb commit 83de6cc

File tree

4 files changed

+29
-29
lines changed

4 files changed

+29
-29
lines changed

fctesting/utils.go

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,23 +47,23 @@ func RequiresRoot(t testing.TB) {
4747
}
4848
}
4949

50-
func newLogger() *log.Logger {
50+
func newLogger(t testing.TB) *log.Logger {
5151
str := os.Getenv(logLevelEnvName)
52-
if str != "" {
53-
logLevel, err := log.ParseLevel(str)
54-
if err != nil {
55-
panic(err)
56-
}
57-
return &log.Logger{
58-
Out: os.Stdout,
59-
Level: logLevel,
60-
}
61-
} else {
52+
if str == "" {
6253
return log.New()
6354
}
55+
56+
logLevel, err := log.ParseLevel(str)
57+
if err != nil {
58+
t.Fatalf("Failed to parse '%s' as Log Level: %v", str, err)
59+
}
60+
return &log.Logger{
61+
Out: os.Stdout,
62+
Level: logLevel,
63+
}
6464
}
6565

6666
// NewLogEntry creates log.Entry. The level is specified by "FC_TEST_LOG_LEVEL" environment variable
67-
func NewLogEntry() *log.Entry {
68-
return log.NewEntry(newLogger())
67+
func NewLogEntry(t testing.TB) *log.Entry {
68+
return log.NewEntry(newLogger(t))
6969
}

firecracker_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ func TestClient(t *testing.T) {
4242
PathOnHost: String(filepath.Join(testDataPath, "drive-2.img")),
4343
}
4444

45-
client := NewClient(socketpath, fctesting.NewLogEntry(), true)
45+
client := NewClient(socketpath, fctesting.NewLogEntry(t), true)
4646
deadlineCtx, deadlineCancel := context.WithTimeout(ctx, 250*time.Millisecond)
4747
defer deadlineCancel()
4848
if err := waitForAliveVMM(deadlineCtx, client); err != nil {

handlers_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ func TestHandlerListRun(t *testing.T) {
148148

149149
ctx := context.Background()
150150
m := &Machine{
151-
logger: fctesting.NewLogEntry(),
151+
logger: fctesting.NewLogEntry(t),
152152
}
153153
if err := h.Run(ctx, m); err != bazErr {
154154
t.Errorf("expected an error, but received %v", err)
@@ -613,8 +613,8 @@ func TestHandlers(t *testing.T) {
613613
// resetting called for the next test
614614
called = ""
615615

616-
client := NewClient(socketpath, fctesting.NewLogEntry(), true, WithOpsClient(&c.Client))
617-
m, err := NewMachine(ctx, c.Config, WithClient(client), WithLogger(fctesting.NewLogEntry()))
616+
client := NewClient(socketpath, fctesting.NewLogEntry(t), true, WithOpsClient(&c.Client))
617+
m, err := NewMachine(ctx, c.Config, WithClient(client), WithLogger(fctesting.NewLogEntry(t)))
618618
if err != nil {
619619
t.Fatalf("failed to create machine: %v", err)
620620
}

machine_test.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ func TestNewMachine(t *testing.T) {
8686
ChrootStrategy: NewNaiveChrootStrategy("path", "kernel-image-path"),
8787
},
8888
},
89-
WithLogger(fctesting.NewLogEntry()))
89+
WithLogger(fctesting.NewLogEntry(t)))
9090
if err != nil {
9191
t.Fatalf("failed to create new machine: %v", err)
9292
}
@@ -241,7 +241,7 @@ func TestJailerMicroVMExecution(t *testing.T) {
241241
WithStderr(os.Stderr).
242242
Build(ctx)
243243

244-
m, err := NewMachine(ctx, cfg, WithProcessRunner(cmd), WithLogger(fctesting.NewLogEntry()))
244+
m, err := NewMachine(ctx, cfg, WithProcessRunner(cmd), WithLogger(fctesting.NewLogEntry(t)))
245245
if err != nil {
246246
t.Fatalf("failed to create new machine: %v", err)
247247
}
@@ -304,7 +304,7 @@ func TestMicroVMExecution(t *testing.T) {
304304
WithBin(getFirecrackerBinaryPath()).
305305
Build(ctx)
306306

307-
m, err := NewMachine(ctx, cfg, WithProcessRunner(cmd), WithLogger(fctesting.NewLogEntry()))
307+
m, err := NewMachine(ctx, cfg, WithProcessRunner(cmd), WithLogger(fctesting.NewLogEntry(t)))
308308
if err != nil {
309309
t.Fatalf("failed to create new machine: %v", err)
310310
}
@@ -368,7 +368,7 @@ func TestStartVMM(t *testing.T) {
368368
WithSocketPath(cfg.SocketPath).
369369
WithBin(getFirecrackerBinaryPath()).
370370
Build(ctx)
371-
m, err := NewMachine(ctx, cfg, WithProcessRunner(cmd), WithLogger(fctesting.NewLogEntry()))
371+
m, err := NewMachine(ctx, cfg, WithProcessRunner(cmd), WithLogger(fctesting.NewLogEntry(t)))
372372
if err != nil {
373373
t.Fatalf("failed to create new machine: %v", err)
374374
}
@@ -416,7 +416,7 @@ func TestStartVMMOnce(t *testing.T) {
416416
WithSocketPath(cfg.SocketPath).
417417
WithBin(getFirecrackerBinaryPath()).
418418
Build(ctx)
419-
m, err := NewMachine(ctx, cfg, WithProcessRunner(cmd), WithLogger(fctesting.NewLogEntry()))
419+
m, err := NewMachine(ctx, cfg, WithProcessRunner(cmd), WithLogger(fctesting.NewLogEntry(t)))
420420
if err != nil {
421421
t.Fatalf("unexpected error: %v", err)
422422
}
@@ -626,7 +626,7 @@ func TestWaitForSocket(t *testing.T) {
626626

627627
m := Machine{
628628
cfg: Config{SocketPath: filename},
629-
logger: fctesting.NewLogEntry(),
629+
logger: fctesting.NewLogEntry(t),
630630
}
631631

632632
go func() {
@@ -638,13 +638,13 @@ func TestWaitForSocket(t *testing.T) {
638638
}()
639639

640640
// Socket file created, HTTP request succeeded
641-
m.client = NewClient(filename, fctesting.NewLogEntry(), true, WithOpsClient(&okClient))
641+
m.client = NewClient(filename, fctesting.NewLogEntry(t), true, WithOpsClient(&okClient))
642642
if err := m.waitForSocket(500*time.Millisecond, errchan); err != nil {
643643
t.Errorf("waitForSocket returned unexpected error %s", err)
644644
}
645645

646646
// Socket file exists, HTTP request failed
647-
m.client = NewClient(filename, fctesting.NewLogEntry(), true, WithOpsClient(&errClient))
647+
m.client = NewClient(filename, fctesting.NewLogEntry(t), true, WithOpsClient(&errClient))
648648
if err := m.waitForSocket(500*time.Millisecond, errchan); err != context.DeadlineExceeded {
649649
t.Error("waitforSocket did not return an expected timeout error")
650650
}
@@ -699,7 +699,7 @@ func TestLogFiles(t *testing.T) {
699699
},
700700
}
701701
ctx := context.Background()
702-
client := NewClient("socket-path", fctesting.NewLogEntry(), true, WithOpsClient(&opClient))
702+
client := NewClient("socket-path", fctesting.NewLogEntry(t), true, WithOpsClient(&opClient))
703703

704704
stdoutPath := filepath.Join(testDataPath, "stdout.log")
705705
stderrPath := filepath.Join(testDataPath, "stderr.log")
@@ -728,7 +728,7 @@ func TestLogFiles(t *testing.T) {
728728
cfg,
729729
WithClient(client),
730730
WithProcessRunner(cmd),
731-
WithLogger(fctesting.NewLogEntry()),
731+
WithLogger(fctesting.NewLogEntry(t)),
732732
)
733733
if err != nil {
734734
t.Fatalf("failed to create new machine: %v", err)
@@ -779,7 +779,7 @@ func TestCaptureFifoToFile(t *testing.T) {
779779
t.Fatalf("Failed to create fifo file: %v", err)
780780
}
781781

782-
if err := captureFifoToFile(fctesting.NewLogEntry(), fifoPath, fifo); err != nil {
782+
if err := captureFifoToFile(fctesting.NewLogEntry(t), fifoPath, fifo); err != nil {
783783
t.Errorf("Unexpected error: %v", err)
784784
}
785785

@@ -874,7 +874,7 @@ func TestPID(t *testing.T) {
874874
DisableValidation: true,
875875
}
876876

877-
m, err := NewMachine(context.Background(), cfg)
877+
m, err := NewMachine(context.Background(), cfg, WithLogger(fctesting.NewLogEntry(t)))
878878
if err != nil {
879879
t.Errorf("expected no error during create machine, but received %v", err)
880880
}

0 commit comments

Comments
 (0)