Merge pull request #1361 from sancppp/ebpf_ut

eBPF unit test: add workload sockops ut

Author: kmesh-bot

hack/run-ebpf-ut.sh

@@ -4,8 +4,8 @@ ROOT_DIR=$(git rev-parse --show-toplevel)
 
 . $ROOT_DIR/hack/utils.sh
 
-DOCKER_EBPF_TEST_COMMAND="make -C /kmesh/test/bpf_ut run"
-LOCAL_EBPF_TEST_COMMAND="make -C $ROOT_DIR/test/bpf_ut run"
+DOCKER_EBPF_TEST_COMMAND="make -C /kmesh/test/bpf_ut clean;make -C /kmesh/test/bpf_ut run"
+LOCAL_EBPF_TEST_COMMAND="make -C $ROOT_DIR/test/bpf_ut clean;make -C $ROOT_DIR/test/bpf_ut run"
 
 function docker_run_ebpf_ut() {
 	local container_id=$1

test/bpf_ut/Makefile

@@ -26,14 +26,15 @@ CLANG_FLAGS += -MD
 
 .PHONY: all clean run
 
-TEST_OBJECTS = xdp_shutdown_in_userspace_test.o xdp_authz_offload_test.o
+all: xdp_shutdown_in_userspace_test.o xdp_authz_offload_test.o workload_sockops_test.o
 
 XDP_FLAGS = -I$(ROOT_DIR)/bpf/kmesh/ -I$(ROOT_DIR)/bpf/kmesh/workload/include -I$(ROOT_DIR)/api/v2-c
-xdp_%.o: xdp_%.c clean
+xdp_%.o: xdp_%.c
 	$(QUIET) $(CLANG) $(CLANG_FLAGS) $(XDP_FLAGS) -c $< -o $@
 
-
-all: $(TEST_OBJECTS)
+WORKLOAD_SOCKOPS_FLAGS = -I$(ROOT_DIR)/bpf/kmesh/ -I$(ROOT_DIR)/bpf/kmesh/probes -I$(ROOT_DIR)/bpf/kmesh/workload/include -I$(ROOT_DIR)/api/v2-c
+workload_sockops_test.o: workload_sockops_test.c
+	$(QUIET) $(CLANG) $(CLANG_FLAGS) $(WORKLOAD_SOCKOPS_FLAGS) -c $< -o $@
 
 clean:
 	$(QUIET) rm -f $(wildcard *.o)
@@ -70,7 +71,6 @@ ifdef BPF_TEST_FILE
 endif
 
 run: all
-	$(QUIET)echo "rebuild and run bpf tests"
 	$(GO) test ./bpftest -bpf-ut-path $(ROOT_DIR)/test/bpf_ut $(BPF_TEST_FLAGS)
 
 -include $(TEST_OBJECTS:.o=.d)

test/bpf_ut/bpftest/bpf_test.go

@@ -38,6 +38,7 @@ import (
 	"google.golang.org/protobuf/proto"
 
 	"kmesh.net/kmesh/pkg/bpf/factory"
+	"kmesh.net/kmesh/pkg/constants"
 	"kmesh.net/kmesh/pkg/logger"
 	"kmesh.net/kmesh/pkg/utils"
 )
@@ -47,17 +48,21 @@ var (
 	dumpCtx  = flag.Bool("dump-ctx", false, "If set, the program context will be dumped after a CHECK and SETUP run.")
 )
 
-type unitTest struct {
+type IunitTest interface {
+	run() func(t *testing.T)
+}
+
+type unitTest_BPF_PROG_TEST_RUN struct {
 	name             string
 	setupInUserSpace func(t *testing.T, coll *ebpf.Collection) // Builds test environment in user space, used for operations that cannot be completed in kernel space (e.g., cannot pass the eBPF verifier)
 }
 
-type unitTests struct {
+type unitTests_BPF_PROG_TEST_RUN struct {
 	objFilename string
-	uts         []unitTest
+	uts         []unitTest_BPF_PROG_TEST_RUN
 }
 
-func (uts *unitTests) run() func(t *testing.T) {
+func (uts *unitTests_BPF_PROG_TEST_RUN) run() func(t *testing.T) {
 	return func(t *testing.T) {
 		for _, ut := range uts.uts {
 			t.Run(ut.name, func(t *testing.T) {
@@ -67,6 +72,27 @@ func (uts *unitTests) run() func(t *testing.T) {
 	}
 }
 
+type unitTest_BUILD_CONTEXT struct {
+	name     string
+	workFunc func(t *testing.T, cgroupPath, elfPath string)
+}
+
+type unitTests_BUILD_CONTEXT struct {
+	objFilename string
+	uts         []unitTest_BUILD_CONTEXT
+}
+
+func (uts *unitTests_BUILD_CONTEXT) run() func(t *testing.T) {
+	return func(t *testing.T) {
+		for _, ut := range uts.uts {
+			t.Run(ut.name, func(t *testing.T) {
+				if ut.workFunc != nil {
+					ut.workFunc(t, constants.Cgroup2Path, uts.objFilename)
+				}
+			})
+		}
+	}
+}
 func TestBPF(t *testing.T) {
 	if testPath == nil || *testPath == "" {
 		t.Skip("Set -bpf-ut-path to run BPF tests")
@@ -81,7 +107,7 @@ func TestBPF(t *testing.T) {
 
 // common functions
 
-func loadAndRunSpec(t *testing.T, objFilename string, tt *unitTest) {
+func loadAndRunSpec(t *testing.T, objFilename string, tt *unitTest_BPF_PROG_TEST_RUN) {
 	elfPath := path.Join(*testPath, objFilename)
 	t.Logf("Running test %s", elfPath)
 
@@ -130,18 +156,16 @@ func loadAndRunSpec(t *testing.T, objFilename string, tt *unitTest) {
 	}
 
 	// Ensure test that has a jump program also has a check program
-	if programs.checkProg == nil {
+	if programs.jumpProg != nil && programs.checkProg == nil {
 		t.Fatalf(
 			"File '%s' contains a jump program in section '%s' but no check program.",
 			elfPath,
 			tt.name,
 		)
 	}
 
-	if !utils.KernelVersionLowerThan5_13() {
-		// TODO: use t.Context() instead of context.Background() when go 1.24 is required
-		logger.StartLogReader(context.Background(), coll.Maps["km_log_event"])
-	}
+	startLogReader(coll)
+
 	if tt.setupInUserSpace != nil {
 		tt.setupInUserSpace(t, coll)
 	}
@@ -150,6 +174,13 @@ func loadAndRunSpec(t *testing.T, objFilename string, tt *unitTest) {
 	subTest(t, programs, coll.Maps[suiteResultMap])
 }
 
+func startLogReader(coll *ebpf.Collection) {
+	if !utils.KernelVersionLowerThan5_13() {
+		// TODO: use t.Context() instead of context.Background() when go 1.24 is required
+		logger.StartLogReader(context.Background(), coll.Maps["km_log_event"])
+	}
+}
+
 // loadAndPrepSpec loads an eBPF Collection Specification from the provided ELF file
 // and prepares it for testing. It disables pinning for all maps to avoid interference
 // between tests. Additionally, it filters out programs that don't support BPF_PROG_RUN,
@@ -177,7 +208,7 @@ func loadAndPrepSpec(t *testing.T, elfPath string) *ebpf.CollectionSpec {
 	for n, p := range spec.Programs {
 		switch p.Type {
 		// https://docs.ebpf.io/linux/syscall/BPF_PROG_TEST_RUN/
-		case ebpf.XDP, ebpf.SchedACT, ebpf.SchedCLS, ebpf.SocketFilter, ebpf.CGroupSKB:
+		case ebpf.XDP, ebpf.SchedACT, ebpf.SchedCLS, ebpf.SocketFilter, ebpf.CGroupSKB, ebpf.SockOps:
 			continue
 		}
 
@@ -192,11 +223,15 @@ func loadAndPrepSpec(t *testing.T, elfPath string) *ebpf.CollectionSpec {
 // based on the provided GlobalBpfConfig. It sets the log level and authorization
 // offload settings.
 func setBpfConfig(t *testing.T, coll *ebpf.Collection, config *factory.GlobalBpfConfig) {
-	if err := coll.Variables["bpf_log_level"].Set(&config.BpfLogLevel); err != nil {
-		t.Fatalf("failed to set bpf_log_level: %v", err)
+	if v, ok := coll.Variables["bpf_log_level"]; ok {
+		if err := v.Set(&config.BpfLogLevel); err != nil {
+			t.Fatalf("failed to set bpf_log_level: %v", err)
+		}
 	}
-	if err := coll.Variables["authz_offload"].Set(&config.AuthzOffload); err != nil {
-		t.Fatalf("failed to set authz_offload: %v", err)
+	if v, ok := coll.Variables["authz_offload"]; ok {
+		if err := v.Set(&config.AuthzOffload); err != nil {
+			t.Fatalf("failed to set authz_offload: %v", err)
+		}
 	}
 }