internal: use be for tests

Author: nalgeon

Makefile

@@ -1,4 +1,4 @@
-.PHONY: build images
+.PHONY: build
 
 # Development
 
@@ -12,14 +12,16 @@ setup:
 	@go mod download
 
 lint:
-	@golangci-lint run --print-issued-lines=false --out-format=colored-line-number ./...
+	@golangci-lint run ./...
+	@echo "✓ lint"
 
 vet:
 	@go vet ./...
+	@echo "✓ vet"
 
 test:
-	@go test ./... -v
-
+	@go test ./...
+	@echo "✓ test"
 
 build:
 	@go build -ldflags "-X main.commit=$(build_rev) -X main.date=$(build_date)" -o build/codapi -v cmd/main.go

go.mod

@@ -1,3 +1,7 @@
 module github.com/nalgeon/codapi
 
-go 1.21
+go 1.23.0
+
+toolchain go1.24.0
+
+require github.com/nalgeon/be v0.1.0

go.sum

@@ -0,0 +1,2 @@
+github.com/nalgeon/be v0.1.0 h1:3h7GPMkzFaRIr2T7BRyUSc6K63cmmv82P6+h5mm9Wvg=
+github.com/nalgeon/be v0.1.0/go.mod h1:PMwMuBLopwKJkSHnr2qHyLcZYUTqNejN7A8RAqNWO3E=

internal/config/config_test.go

@@ -1,9 +1,10 @@
 package config
 
 import (
-	"reflect"
 	"strings"
 	"testing"
+
+	"github.com/nalgeon/be"
 )
 
 func TestConfig_BoxNames(t *testing.T) {
@@ -16,9 +17,7 @@ func TestConfig_BoxNames(t *testing.T) {
 
 	want := []string{"go", "python"}
 	got := cfg.BoxNames()
-	if !reflect.DeepEqual(got, want) {
-		t.Errorf("BoxNames: expected %v, got %v", want, got)
-	}
+	be.Equal(t, got, want)
 }
 
 func TestConfig_CommandNames(t *testing.T) {
@@ -36,9 +35,7 @@ func TestConfig_CommandNames(t *testing.T) {
 
 	want := []string{"go", "python"}
 	got := cfg.CommandNames()
-	if !reflect.DeepEqual(got, want) {
-		t.Errorf("CommandNames: expected %v, got %v", want, got)
-	}
+	be.Equal(t, got, want)
 }
 
 func TestConfig_ToJSON(t *testing.T) {
@@ -60,9 +57,7 @@ func TestConfig_ToJSON(t *testing.T) {
 	}
 
 	got := cfg.ToJSON()
-	if !strings.Contains(got, `"pool_size": 8`) {
-		t.Error("ToJSON: expected pool_size = 8")
-	}
+	be.True(t, strings.Contains(got, `"pool_size": 8`))
 }
 
 func Test_setBoxDefaults(t *testing.T) {
@@ -83,45 +78,19 @@ func Test_setBoxDefaults(t *testing.T) {
 		Files: []string{"config.py"},
 	}
 	setBoxDefaults(box, defs)
-	if box.Image != "" {
-		t.Error("Image: should not set default value")
-	}
-	if box.Runtime != defs.Runtime {
-		t.Errorf("Runtime: expected %s, got %s", defs.Runtime, box.Runtime)
-	}
-	if box.CPU != defs.CPU {
-		t.Errorf("CPU: expected %d, got %d", defs.CPU, box.CPU)
-	}
-	if box.Memory != defs.Memory {
-		t.Errorf("Memory: expected %d, got %d", defs.Memory, box.Memory)
-	}
-	if box.Storage != defs.Storage {
-		t.Errorf("Storage: expected %s, got %s", defs.Storage, box.Storage)
-	}
-	if box.Network != defs.Network {
-		t.Errorf("Network: expected %s, got %s", defs.Network, box.Network)
-	}
-	if box.Volume != defs.Volume {
-		t.Errorf("Volume: expected %s, got %s", defs.Volume, box.Volume)
-	}
-	if !reflect.DeepEqual(box.Tmpfs, defs.Tmpfs) {
-		t.Errorf("Tmpfs: expected %v, got %v", defs.Tmpfs, box.Tmpfs)
-	}
-	if !reflect.DeepEqual(box.CapAdd, defs.CapAdd) {
-		t.Errorf("CapAdd: expected %v, got %v", defs.CapAdd, box.CapAdd)
-	}
-	if !reflect.DeepEqual(box.CapDrop, defs.CapDrop) {
-		t.Errorf("CapDrop: expected %v, got %v", defs.CapDrop, box.CapDrop)
-	}
-	if !reflect.DeepEqual(box.Ulimit, defs.Ulimit) {
-		t.Errorf("Ulimit: expected %v, got %v", defs.Ulimit, box.Ulimit)
-	}
-	if box.NProc != defs.NProc {
-		t.Errorf("NProc: expected %d, got %d", defs.NProc, box.NProc)
-	}
-	if len(box.Files) != 0 {
-		t.Error("Files: should not set default value")
-	}
+	be.Equal(t, box.Image, "")
+	be.Equal(t, box.Runtime, defs.Runtime)
+	be.Equal(t, box.CPU, defs.CPU)
+	be.Equal(t, box.Memory, defs.Memory)
+	be.Equal(t, box.Storage, defs.Storage)
+	be.Equal(t, box.Network, defs.Network)
+	be.Equal(t, box.Volume, defs.Volume)
+	be.Equal(t, box.Tmpfs, defs.Tmpfs)
+	be.Equal(t, box.CapAdd, defs.CapAdd)
+	be.Equal(t, box.CapDrop, defs.CapDrop)
+	be.Equal(t, box.Ulimit, defs.Ulimit)
+	be.Equal(t, box.NProc, defs.NProc)
+	be.Equal(t, len(box.Files), 0)
 }
 
 func Test_setStepDefaults(t *testing.T) {
@@ -136,22 +105,10 @@ func Test_setStepDefaults(t *testing.T) {
 	}
 
 	setStepDefaults(step, defs)
-	if step.Box != "" {
-		t.Error("Box: should not set default value")
-	}
-	if step.User != defs.User {
-		t.Errorf("User: expected %s, got %s", defs.User, step.User)
-	}
-	if step.Action != defs.Action {
-		t.Errorf("Action: expected %s, got %s", defs.Action, step.Action)
-	}
-	if len(step.Command) != 0 {
-		t.Error("Command: should not set default value")
-	}
-	if step.Timeout != defs.Timeout {
-		t.Errorf("Timeout: expected %d, got %d", defs.Timeout, step.Timeout)
-	}
-	if step.NOutput != defs.NOutput {
-		t.Errorf("NOutput: expected %d, got %d", defs.NOutput, step.NOutput)
-	}
+	be.Equal(t, step.Box, "")
+	be.Equal(t, step.User, defs.User)
+	be.Equal(t, step.Action, defs.Action)
+	be.Equal(t, len(step.Command), 0)
+	be.Equal(t, step.Timeout, defs.Timeout)
+	be.Equal(t, step.NOutput, defs.NOutput)
 }

internal/config/load_test.go

@@ -2,46 +2,24 @@ package config
 
 import (
 	"testing"
+
+	"github.com/nalgeon/be"
 )
 
 func TestRead(t *testing.T) {
 	cfg, err := Read("testdata")
-	if err != nil {
-		t.Fatalf("unexpected error: %v", err)
-	}
-
-	if cfg.PoolSize != 8 {
-		t.Errorf("PoolSize: expected 8, got %d", cfg.PoolSize)
-	}
-	if !cfg.Verbose {
-		t.Error("Verbose: expected true")
-	}
-	if cfg.Box.Memory != 64 {
-		t.Errorf("Box.Memory: expected 64, got %d", cfg.Box.Memory)
-	}
-	if cfg.Step.User != "sandbox" {
-		t.Errorf("Step.User: expected sandbox, got %s", cfg.Step.User)
-	}
+	be.Err(t, err, nil)
+	be.Equal(t, cfg.PoolSize, 8)
+	be.Equal(t, cfg.Verbose, true)
+	be.Equal(t, cfg.Box.Memory, 64)
+	be.Equal(t, cfg.Step.User, "sandbox")
 
 	// alpine box
-	if _, ok := cfg.Boxes["custom-alpine"]; !ok {
-		t.Error("Boxes: missing my/alpine box")
-	}
-	if cfg.Boxes["custom-alpine"].Image != "custom/alpine" {
-		t.Errorf(
-			"Boxes[custom-alpine]: expected custom/alpine image, got %s",
-			cfg.Boxes["custom-alpine"].Image,
-		)
-	}
+	be.True(t, cfg.Boxes["custom-alpine"] != nil)
+	be.Equal(t, cfg.Boxes["custom-alpine"].Image, "custom/alpine")
 
 	// python box
-	if _, ok := cfg.Boxes["python"]; !ok {
-		t.Error("Boxes: missing python box")
-	}
-	if _, ok := cfg.Commands["python"]; !ok {
-		t.Error("Commands: missing python sandbox")
-	}
-	if _, ok := cfg.Commands["python"]["run"]; !ok {
-		t.Error("Commands[python]: missing run command")
-	}
+	be.True(t, cfg.Boxes["python"] != nil)
+	be.True(t, cfg.Commands["python"] != nil)
+	be.True(t, cfg.Commands["python"]["run"] != nil)
 }

internal/engine/docker.go

@@ -47,7 +47,7 @@ func (e *Docker) Exec(req Request) Execution {
 		err = NewExecutionError("create temp dir", err)
 		return Fail(req.ID, err)
 	}
-	defer os.RemoveAll(dir)
+	defer func() { _ = os.RemoveAll(dir) }()
 
 	// if the command entry point file is not defined,
 	// there is no need to store request files in the temp directory
@@ -339,7 +339,7 @@ func expandVars(command []string, name string) []string {
 	expanded := make([]string, len(command))
 	copy(expanded, command)
 	for i, cmd := range expanded {
-		expanded[i] = strings.Replace(cmd, ":name", name, -1)
+		expanded[i] = strings.ReplaceAll(cmd, ":name", name)
 	}
 	return expanded
 }