Backend unit tests: (mld_polyz_unpack/_c)

- Add test infrastructure in Makefile and scripts/tests
- Update build rules in test/mk/ for component testing

- Create test_unit.c and implement unit tests for
  mld_polyz_unpack and mld_polyz_unpack_c

Signed-off-by: willieyz <willie.zhao@chelpis.com>

Author: willieyz

Makefile

@@ -2,14 +2,14 @@
 # Copyright (c) The mldsa-native project authors
 # SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT
 
-.PHONY: func kat acvp stack \
-	func_44 kat_44 acvp_44 stack_44 \
-	func_65 kat_65 acvp_65 stack_65 \
-	func_87 kat_87 acvp_87 stack_87 \
-	run_func run_kat run_acvp run_stack \
-	run_func_44 run_kat_44 run_stack_44 \
-	run_func_65 run_kat_65 run_stack_65 \
-	run_func_87 run_kat_87 run_stack_87 \
+.PHONY: func kat acvp stack unit \
+	func_44 kat_44 acvp_44 stack_44 unit_44 \
+	func_65 kat_65 acvp_65 stack_65 unit_65 \
+	func_87 kat_87 acvp_87 stack_87 unit_87 \
+	run_func run_kat run_acvp run_stack run_unit \
+	run_func_44 run_kat_44 run_stack_44 run_unit_44 \
+	run_func_65 run_kat_65 run_stack_65 run_unit_65 \
+	run_func_87 run_kat_87 run_stack_87 run_unit_87 \
 	bench_44 bench_65 bench_87 bench \
 	run_bench_44 run_bench_65 run_bench_87 run_bench \
 	bench_components_44 bench_components_65 bench_components_87 bench_components \
@@ -49,7 +49,7 @@ quickcheck: test
 build: func kat acvp
 	$(Q)echo "  Everything builds fine!"
 
-test: run_kat run_func run_acvp
+test: run_kat run_func run_acvp run_unit
 	$(Q)echo "  Everything checks fine!"
 
 run_kat_44: kat_44
@@ -68,6 +68,14 @@ run_func_87: func_87
 	$(W) $(MLDSA87_DIR)/bin/test_mldsa87
 run_func: run_func_44 run_func_65 run_func_87
 
+run_unit_44: unit_44
+	$(W) $(MLDSA44_DIR)/bin/test_unit44
+run_unit_65: unit_65
+	$(W) $(MLDSA65_DIR)/bin/test_unit65
+run_unit_87: unit_87
+	$(W) $(MLDSA87_DIR)/bin/test_unit87
+run_unit: run_unit_44 run_unit_65 run_unit_87
+
 run_acvp: acvp
 	EXEC_WRAPPER="$(EXEC_WRAPPER)" python3 ./test/acvp_client.py $(if $(ACVP_VERSION),--version $(ACVP_VERSION))
 
@@ -79,6 +87,14 @@ func_87: $(MLDSA87_DIR)/bin/test_mldsa87
 	$(Q)echo "  FUNC       ML-DSA-87:  $^"
 func: func_44 func_65 func_87
 
+unit_44:  $(MLDSA44_DIR)/bin/test_unit44
+	$(Q)echo "  UNIT       ML-DSA-44:   $^"
+unit_65:  $(MLDSA65_DIR)/bin/test_unit65
+	$(Q)echo "  UNIT       ML-DSA-65:   $^"
+unit_87: $(MLDSA87_DIR)/bin/test_unit87
+	$(Q)echo "  UNIT       ML-DSA-87:  $^"
+unit: unit_44 unit_65 unit_87
+
 kat_44: $(MLDSA44_DIR)/bin/gen_KAT44
 	$(Q)echo "  KAT        ML-DSA-44:   $^"
 kat_65: $(MLDSA65_DIR)/bin/gen_KAT65

scripts/tests

@@ -211,6 +211,7 @@ class TEST_TYPES(Enum):
     CUSTOM_BACKEND = 16
     MULTILEVEL_BUILD = 17
     MULTILEVEL_BUILD_NATIVE = 18
+    UNIT = 19
 
     def is_benchmark(self):
         return self in [TEST_TYPES.BENCH, TEST_TYPES.BENCH_COMPONENTS]
@@ -283,6 +284,8 @@ class TEST_TYPES(Enum):
             return "Example (multilevel build)"
         if self == TEST_TYPES.MULTILEVEL_BUILD_NATIVE:
             return "Example (multilevel build, native)"
+        if self == TEST_TYPES.UNIT:
+            return "Unit Test"
 
     def make_dir(self):
         if self == TEST_TYPES.BASIC:
@@ -346,6 +349,8 @@ class TEST_TYPES(Enum):
             return ""
         if self == TEST_TYPES.MULTILEVEL_BUILD_NATIVE:
             return ""
+        if self == TEST_TYPES.UNIT:
+            return "unit"
 
     def make_run_target(self, scheme):
         t = self.make_target()
@@ -632,6 +637,19 @@ class Tests:
 
         self.check_fail()
 
+    def unit(self):
+        def _unit(opt):
+            self._compile_schemes(TEST_TYPES.UNIT, opt)
+            if self.args.run:
+                self._run_schemes(TEST_TYPES.UNIT, opt)
+
+        if self.do_no_opt():
+            _unit(False)
+        if self.do_opt():
+            _unit(True)
+
+        self.check_fail()
+
     def acvp(self):
         def _acvp(opt):
             self._compile_schemes(TEST_TYPES.ACVP, opt)
@@ -765,6 +783,7 @@ class Tests:
         acvp = self.args.acvp
         examples = self.args.examples
         stack = self.args.stack
+        unit = self.args.unit
 
         def _all(opt):
             if func is True:
@@ -775,6 +794,8 @@ class Tests:
                 self._compile_schemes(TEST_TYPES.ACVP, opt)
             if stack is True:
                 self._compile_schemes(TEST_TYPES.STACK, opt)
+            if unit is True:
+                self._compile_schemes(TEST_TYPES.UNIT, opt)
 
             if self.args.check_namespace is True:
                 p = subprocess.run(
@@ -796,6 +817,8 @@ class Tests:
                 self._run_scheme(TEST_TYPES.ACVP, opt, None)
             if stack is True:
                 self._run_schemes(TEST_TYPES.STACK, opt, suppress_output=False)
+            if unit is True:
+                self._run_schemes(TEST_TYPES.UNIT, opt)
 
         if self.do_no_opt():
             _all(False)
@@ -1104,6 +1127,14 @@ def cli():
         "--no-acvp", action="store_false", dest="acvp", help="Do not run acvp test"
     )
 
+    unit_group = all_parser.add_mutually_exclusive_group()
+    unit_group.add_argument(
+        "--unit", action="store_true", dest="unit", help="Run unit test", default=True
+    )
+    unit_group.add_argument(
+        "--no-unit", action="store_false", dest="unit", help="Do not run unit test"
+    )
+
     examples_group = all_parser.add_mutually_exclusive_group()
     examples_group.add_argument(
         "--examples",
@@ -1333,6 +1364,13 @@ def cli():
         "kat", help="Run the kat tests for all parameter sets", parents=[common_parser]
     )
 
+    # unit arguments
+    unit_parser = cmd_subparsers.add_parser(
+        "unit",
+        help="Run the unit tests for all parameter sets",
+        parents=[common_parser],
+    )
+
     # stack arguments
     stack_parser = cmd_subparsers.add_parser(
         "stack",
@@ -1377,6 +1415,8 @@ def cli():
         Tests(args).func()
     elif args.cmd == "kat":
         Tests(args).kat()
+    elif args.cmd == "unit":
+        Tests(args).unit()
     elif args.cmd == "stack":
         Tests(args).stack()
     elif args.cmd == "size":

test/mk/components.mk

@@ -14,7 +14,7 @@ ifeq ($(OPT),1)
 	CFLAGS += -DMLD_CONFIG_USE_NATIVE_BACKEND_ARITH -DMLD_CONFIG_USE_NATIVE_BACKEND_FIPS202
 endif
 
-ALL_TESTS = test_mldsa acvp_mldsa bench_mldsa bench_components_mldsa gen_KAT test_stack
+ALL_TESTS = test_mldsa test_unit acvp_mldsa bench_mldsa bench_components_mldsa gen_KAT test_stack
 
 MLDSA44_DIR = $(BUILD_DIR)/mldsa44
 MLDSA65_DIR = $(BUILD_DIR)/mldsa65
@@ -27,13 +27,26 @@ $(MLDSA65_OBJS): CFLAGS += -DMLD_CONFIG_PARAMETER_SET=65
 MLDSA87_OBJS = $(call MAKE_OBJS,$(MLDSA87_DIR),$(SOURCES) $(FIPS202_SRCS))
 $(MLDSA87_OBJS): CFLAGS += -DMLD_CONFIG_PARAMETER_SET=87
 
+# Unit test object files - same sources but with MLD_STATIC_TESTABLE=
+MLDSA44_UNIT_OBJS = $(call MAKE_OBJS,$(MLDSA44_DIR)/unit,$(SOURCES) $(FIPS202_SRCS))
+$(MLDSA44_UNIT_OBJS): CFLAGS += -DMLD_CONFIG_PARAMETER_SET=44 -DMLD_STATIC_TESTABLE= -Wno-missing-prototypes
+MLDSA65_UNIT_OBJS = $(call MAKE_OBJS,$(MLDSA65_DIR)/unit,$(SOURCES) $(FIPS202_SRCS))
+$(MLDSA65_UNIT_OBJS): CFLAGS += -DMLD_CONFIG_PARAMETER_SET=65 -DMLD_STATIC_TESTABLE= -Wno-missing-prototypes
+MLDSA87_UNIT_OBJS = $(call MAKE_OBJS,$(MLDSA87_DIR)/unit,$(SOURCES) $(FIPS202_SRCS))
+$(MLDSA87_UNIT_OBJS): CFLAGS += -DMLD_CONFIG_PARAMETER_SET=87 -DMLD_STATIC_TESTABLE= -Wno-missing-prototypes
 
 CFLAGS += -Imldsa
 
 $(BUILD_DIR)/libmldsa44.a: $(MLDSA44_OBJS)
 $(BUILD_DIR)/libmldsa65.a: $(MLDSA65_OBJS)
 $(BUILD_DIR)/libmldsa87.a: $(MLDSA87_OBJS)
 
+# Unit libraries with exposed internal functions
+$(BUILD_DIR)/libmldsa44_unit.a: $(MLDSA44_UNIT_OBJS)
+$(BUILD_DIR)/libmldsa65_unit.a: $(MLDSA65_UNIT_OBJS)
+$(BUILD_DIR)/libmldsa87_unit.a: $(MLDSA87_UNIT_OBJS)
+
+
 $(BUILD_DIR)/libmldsa.a: $(MLDSA44_OBJS) $(MLDSA65_OBJS) $(MLDSA87_OBJS)
 
 $(MLDSA44_DIR)/bin/bench_mldsa44: CFLAGS += -Itest/hal
@@ -47,6 +60,16 @@ $(MLDSA44_DIR)/bin/test_stack44: CFLAGS += -Imldsa -fstack-usage
 $(MLDSA65_DIR)/bin/test_stack65: CFLAGS += -Imldsa -fstack-usage
 $(MLDSA87_DIR)/bin/test_stack87: CFLAGS += -Imldsa -fstack-usage
 
+$(MLDSA44_DIR)/bin/test_unit44: CFLAGS += -DMLD_STATIC_TESTABLE= -Wno-missing-prototypes
+$(MLDSA65_DIR)/bin/test_unit65: CFLAGS += -DMLD_STATIC_TESTABLE= -Wno-missing-prototypes
+$(MLDSA87_DIR)/bin/test_unit87: CFLAGS += -DMLD_STATIC_TESTABLE= -Wno-missing-prototypes
+
+# Unit library object files compiled with MLD_STATIC_TESTABLE=
+$(MLDSA44_DIR)/unit_%: CFLAGS += -DMLD_STATIC_TESTABLE= -Wno-missing-prototypes
+$(MLDSA65_DIR)/unit_%: CFLAGS += -DMLD_STATIC_TESTABLE= -Wno-missing-prototypes
+$(MLDSA87_DIR)/unit_%: CFLAGS += -DMLD_STATIC_TESTABLE= -Wno-missing-prototypes
+
+
 $(MLDSA44_DIR)/bin/bench_mldsa44: $(MLDSA44_DIR)/test/hal/hal.c.o
 $(MLDSA65_DIR)/bin/bench_mldsa65: $(MLDSA65_DIR)/test/hal/hal.c.o
 $(MLDSA87_DIR)/bin/bench_mldsa87: $(MLDSA87_DIR)/test/hal/hal.c.o
@@ -58,18 +81,30 @@ $(MLDSA44_DIR)/bin/%: CFLAGS += -DMLD_CONFIG_PARAMETER_SET=44
 $(MLDSA65_DIR)/bin/%: CFLAGS += -DMLD_CONFIG_PARAMETER_SET=65
 $(MLDSA87_DIR)/bin/%: CFLAGS += -DMLD_CONFIG_PARAMETER_SET=87
 
-# Link tests with respective library
+# Link tests with respective library (except test_unit which includes sources directly)
 define ADD_SOURCE
 $(BUILD_DIR)/$(1)/bin/$(2)$(shell echo $(1) | tr -d -c 0-9): LDLIBS += -L$(BUILD_DIR) -l$(1)
 $(BUILD_DIR)/$(1)/bin/$(2)$(shell echo $(1) | tr -d -c 0-9): $(BUILD_DIR)/$(1)/test/$(2).c.o $(BUILD_DIR)/lib$(1).a
 endef
 
+
+# Special rule for test_unit - link against unit libraries with exposed internal functions
+define ADD_SOURCE_UNIT
+$(BUILD_DIR)/$(1)/bin/test_unit$(shell echo $(1) | tr -d -c 0-9): LDLIBS += -L$(BUILD_DIR) -l$(1)_unit
+$(BUILD_DIR)/$(1)/bin/test_unit$(shell echo $(1) | tr -d -c 0-9): $(BUILD_DIR)/$(1)/test/test_unit.c.o $(BUILD_DIR)/lib$(1)_unit.a $(call MAKE_OBJS, $(BUILD_DIR)/$(1), $(wildcard test/notrandombytes/*.c))
+endef
+
+
 $(foreach scheme,mldsa44 mldsa65 mldsa87, \
-	$(foreach test,$(ALL_TESTS), \
+	$(foreach test,$(filter-out test_unit,$(ALL_TESTS)), \
 		$(eval $(call ADD_SOURCE,$(scheme),$(test))) \
 	) \
 )
 
+$(foreach scheme,mldsa44 mldsa65 mldsa87, \
+	$(eval $(call ADD_SOURCE_UNIT,$(scheme))) \
+)
+
 $(ALL_TESTS:%=$(MLDSA44_DIR)/bin/%44): $(call MAKE_OBJS, $(MLDSA44_DIR), $(wildcard test/notrandombytes/*.c) $(EXTRA_SOURCES))
 $(ALL_TESTS:%=$(MLDSA65_DIR)/bin/%65): $(call MAKE_OBJS, $(MLDSA65_DIR), $(wildcard test/notrandombytes/*.c) $(EXTRA_SOURCES))
 $(ALL_TESTS:%=$(MLDSA87_DIR)/bin/%87): $(call MAKE_OBJS, $(MLDSA87_DIR), $(wildcard test/notrandombytes/*.c) $(EXTRA_SOURCES))

test/mk/rules.mk

@@ -52,3 +52,34 @@ $(BUILD_DIR)/mldsa87/%.S.o: %.S $(CONFIG)
 	$(Q)echo "  AS      $@"
 	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
 	$(Q)$(CC) -c -o $@ $(CFLAGS) $<
+
+
+$(BUILD_DIR)/mldsa44/unit/%.c.o: %.c $(CONFIG)
+	$(Q)echo "  CC      $@"
+	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
+	$(Q)$(CC) -c -o $@ $(CFLAGS) $<
+
+$(BUILD_DIR)/mldsa44/unit/%.S.o: %.S $(CONFIG)
+	$(Q)echo "  AS      $@"
+	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
+	$(Q)$(CC) -c -o $@ $(CFLAGS) $<
+
+$(BUILD_DIR)/mldsa65/unit/%.c.o: %.c $(CONFIG)
+	$(Q)echo "  CC      $@"
+	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
+	$(Q)$(CC) -c -o $@ $(CFLAGS) $<
+
+$(BUILD_DIR)/mldsa65/unit/%.S.o: %.S $(CONFIG)
+	$(Q)echo "  AS      $@"
+	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
+	$(Q)$(CC) -c -o $@ $(CFLAGS) $<
+
+$(BUILD_DIR)/mldsa87/unit/%.c.o: %.c $(CONFIG)
+	$(Q)echo "  CC      $@"
+	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
+	$(Q)$(CC) -c -o $@ $(CFLAGS) $<
+
+$(BUILD_DIR)/mldsa87/unit/%.S.o: %.S $(CONFIG)
+	$(Q)echo "  AS      $@"
+	$(Q)[ -d $(@D) ] || mkdir -p $(@D)
+	$(Q)$(CC) -c -o $@ $(CFLAGS) $<