grom72 · grom72 · Feb 21, 2024 · Mar 22, 2024
diff --git a/CODING_STYLE.md b/CODING_STYLE.md
@@ -80,9 +80,9 @@ log level for most frequently called routines.
 
 ### Unit tests
 - There **must** be unit tests provided for each new function/module added.
-- Test scripts **must** start with `#!/usr/bin/env <shell>` for portability between Linux and FreeBSD.
+- Test scripts **must** start with `#!/usr/bin/env <shell>`.
 - Please, see [this](https://github.com/pmem/pmdk/blob/master/src/test/README)
-and [that](https://github.com/pmem/pmdk/blob/master/src/test/unittest/README)
+and [that](https://github.com/pmem/pmdk/blob/master/src/test/_unittest/README)
 document to get familiar with
 our test framework and the guidelines on how to write and run unit tests.
 

diff --git a/src/test/Makefile b/src/test/Makefile
@@ -11,7 +11,7 @@
 include ../common.inc
 
 TEST_DEPS = \
-	unittest\
+	_unittest\
 	tools
 
 OBJ_DEPS = \
@@ -406,5 +406,5 @@ SUPP_SYNC_FILES=$(shell echo *.supp | sed s/supp/$(SYNC_EXT)/g)
 
 .PHONY: all check clean clobber cstyle pcheck pcheck-log pcheck-obj\
 	 pcheck-other pcheck-pmem pcheck-pmempool\
-	 test unittest tools format pcheck-libpmempool pycheck\
+	 test _unittest tools format pcheck-libpmempool pycheck\
 	 pcheck-local $(TESTS_BUILD)
diff --git a/src/test/Makefile.inc b/src/test/Makefile.inc
@@ -23,7 +23,7 @@ EX_LIBPMEM2=$(EXAMPLES_DIR)/libpmem2
 EX_LIBPMEMOBJ=$(EXAMPLES_DIR)/libpmemobj
 EX_PMREORDER=$(EXAMPLES_DIR)/pmreorder
 
-UT = ../unittest/libut.a
+UT = ../_unittest/libut.a
 LIBS += $(UT) $(LIBUUID)
 
 ifeq ($(USE_LIBUNWIND),y)
@@ -457,7 +457,7 @@ extract_funcs = $(shell \
         print "-Wl,--wrap=" $$2 \
     }' $(1) )
 
-INCS += -I../unittest -I$(TOP)/src/include -I$(TOP)/src/common -I$(TOP)/src/core
+INCS += -I../_unittest -I$(TOP)/src/include -I$(TOP)/src/common -I$(TOP)/src/core
 
 COMMON_FLAGS  = -ggdb
 COMMON_FLAGS += -Wall
@@ -588,7 +588,7 @@ endif
 all: $(TARGET) $(TARGET_STATIC_DEBUG) $(TARGET_STATIC_NONDEBUG)
 
 $(UT):
-	$(MAKE) -C ../unittest
+	$(MAKE) -C ../_unittest
 
 $(TARGET_STATIC_DEBUG): $(TMP_HEADERS) $(OBJS) $(UT) $(STATIC_DEBUG_LIBS) $(EXTRA_DEPS) $(MAKEFILE_DEPS)
 	$(LINKER) -o $@ $(LDFLAGS) $(OBJS) $(STATIC_DEBUG_LIBS) $(LIBS)

diff --git a/src/test/README b/src/test/README
@@ -134,7 +134,7 @@ DETAILS ON HOW TO WRITE UNIT TESTS
 
 A minimal unit test consists of a sub-directory here with an executable called
 TEST0 in it that exits normally when the test passes.  Most tests, however,
-source the file unittest/unittest.sh to use the utility functions for setting
+source the file _unittest/unittest.sh to use the utility functions for setting
 up and checking tests.  Additionally, most unit tests build a local test
 program and call it from the TEST* scripts.
 
@@ -233,7 +233,7 @@ The above call is just like calling open(2), expect the framework checks for
 unexpected errors and halts the unit test if those happen.  The result is
 usually a very short, compact unit test where most of the code is the
 interesting code under test.  A full list of unit test macros is in
-unittest/inittest.h.
+_unittest/inittest.h.
 
 The best way to create a new unit test is to start with an existing one.  The
 test:

diff --git a/src/test/RUNTESTS.py b/src/test/RUNTESTS.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2019-2023, Intel Corporation
+# Copyright 2019-2024, Intel Corporation
 
 """Main script for unit tests execution.
 
@@ -13,11 +13,12 @@
 
 """
 
-# modules from unittest directory are visible from this script
+# modules from _unittest directory are visible from this script
 import sys
 import os
 from os import path
-sys.path.insert(1, path.abspath(path.join(path.dirname(__file__), 'unittest')))
+sys.path.insert(1, path.abspath(path.join(path.dirname(__file__),
+                                          '_unittest')))
 
 # flake8 issues silenced:
 # E402 - import statements not at the top of the file because of adding

diff --git a/src/test/unittest/.gitignore → src/test/_unittest/.gitignore b/src/test/unittest/.gitignore → src/test/_unittest/.gitignore
diff --git a/src/test/unittest/Makefile → src/test/_unittest/Makefile b/src/test/unittest/Makefile → src/test/_unittest/Makefile
@@ -2,7 +2,7 @@
 # Copyright 2014-2024, Intel Corporation
 
 #
-# src/test/unittest/Makefile -- build unittest support library
+# src/test/_unittest/Makefile -- build unittest support library
 #
 
 TOP := $(dir $(lastword $(MAKEFILE_LIST)))../../..

diff --git a/src/test/unittest/README → src/test/_unittest/README b/src/test/unittest/README → src/test/_unittest/README
@@ -1,6 +1,6 @@
 Persistent Memory Development Kit
 
-This is src/test/unittest/README.
+This is src/test/_unittest/README.
 
 This directory contains the unit test framework used by
 the Persistent Memory Development Kit unit tests.

diff --git a/src/test/unittest/badblock.py → src/test/_unittest/badblock.py b/src/test/unittest/badblock.py → src/test/_unittest/badblock.py
diff --git a/src/test/unittest/basetest.py → src/test/_unittest/basetest.py b/src/test/unittest/basetest.py → src/test/_unittest/basetest.py
diff --git a/src/test/unittest/builds.py → src/test/_unittest/builds.py b/src/test/unittest/builds.py → src/test/_unittest/builds.py
diff --git a/src/test/unittest/configurator.py → src/test/_unittest/configurator.py b/src/test/unittest/configurator.py → src/test/_unittest/configurator.py
diff --git a/src/test/unittest/consts.py → src/test/_unittest/consts.py b/src/test/unittest/consts.py → src/test/_unittest/consts.py
diff --git a/src/test/unittest/context.py → src/test/_unittest/context.py b/src/test/unittest/context.py → src/test/_unittest/context.py
diff --git a/src/test/unittest/ctx_filter.py → src/test/_unittest/ctx_filter.py b/src/test/unittest/ctx_filter.py → src/test/_unittest/ctx_filter.py
diff --git a/src/test/unittest/devdax.py → src/test/_unittest/devdax.py b/src/test/unittest/devdax.py → src/test/_unittest/devdax.py
diff --git a/src/test/unittest/futils.py → src/test/_unittest/futils.py b/src/test/unittest/futils.py → src/test/_unittest/futils.py
diff --git a/src/test/unittest/granularity.py → src/test/_unittest/granularity.py b/src/test/unittest/granularity.py → src/test/_unittest/granularity.py
diff --git a/src/test/unittest/poolset.py → src/test/_unittest/poolset.py b/src/test/unittest/poolset.py → src/test/_unittest/poolset.py
diff --git a/src/test/unittest/python_gdb.py → src/test/_unittest/python_gdb.py b/src/test/unittest/python_gdb.py → src/test/_unittest/python_gdb.py
diff --git a/src/test/unittest/requirements.py → src/test/_unittest/requirements.py b/src/test/unittest/requirements.py → src/test/_unittest/requirements.py
diff --git a/src/test/unittest/test_types.py → src/test/_unittest/test_types.py b/src/test/unittest/test_types.py → src/test/_unittest/test_types.py
diff --git a/src/test/unittest/tools.py → src/test/_unittest/tools.py b/src/test/unittest/tools.py → src/test/_unittest/tools.py
diff --git a/src/test/unittest/unittest.h → src/test/_unittest/unittest.h b/src/test/unittest/unittest.h → src/test/_unittest/unittest.h
diff --git a/src/test/unittest/unittest.sh → src/test/_unittest/unittest.sh b/src/test/unittest/unittest.sh → src/test/_unittest/unittest.sh
diff --git a/src/test/unittest/unsafe_shutdown.py → src/test/_unittest/unsafe_shutdown.py b/src/test/unittest/unsafe_shutdown.py → src/test/_unittest/unsafe_shutdown.py
diff --git a/src/test/unittest/ut.c → src/test/_unittest/ut.c b/src/test/unittest/ut.c → src/test/_unittest/ut.c
diff --git a/src/test/unittest/ut_alloc.c → src/test/_unittest/ut_alloc.c b/src/test/unittest/ut_alloc.c → src/test/_unittest/ut_alloc.c
diff --git a/src/test/unittest/ut_backtrace.c → src/test/_unittest/ut_backtrace.c b/src/test/unittest/ut_backtrace.c → src/test/_unittest/ut_backtrace.c
diff --git a/src/test/unittest/ut_fh.c → src/test/_unittest/ut_fh.c b/src/test/unittest/ut_fh.c → src/test/_unittest/ut_fh.c
diff --git a/src/test/unittest/ut_fh.h → src/test/_unittest/ut_fh.h b/src/test/unittest/ut_fh.h → src/test/_unittest/ut_fh.h
diff --git a/src/test/unittest/ut_file.c → src/test/_unittest/ut_file.c b/src/test/unittest/ut_file.c → src/test/_unittest/ut_file.c
diff --git a/src/test/unittest/ut_mt.c → src/test/_unittest/ut_mt.c b/src/test/unittest/ut_mt.c → src/test/_unittest/ut_mt.c
diff --git a/src/test/unittest/ut_mt.h → src/test/_unittest/ut_mt.h b/src/test/unittest/ut_mt.h → src/test/_unittest/ut_mt.h
diff --git a/src/test/unittest/ut_pmem2.h → src/test/_unittest/ut_pmem2.h b/src/test/unittest/ut_pmem2.h → src/test/_unittest/ut_pmem2.h
diff --git a/src/test/unittest/ut_pmem2_config.c → src/test/_unittest/ut_pmem2_config.c b/src/test/unittest/ut_pmem2_config.c → src/test/_unittest/ut_pmem2_config.c
diff --git a/src/test/unittest/ut_pmem2_config.h → src/test/_unittest/ut_pmem2_config.h b/src/test/unittest/ut_pmem2_config.h → src/test/_unittest/ut_pmem2_config.h
diff --git a/src/test/unittest/ut_pmem2_map.c → src/test/_unittest/ut_pmem2_map.c b/src/test/unittest/ut_pmem2_map.c → src/test/_unittest/ut_pmem2_map.c
diff --git a/src/test/unittest/ut_pmem2_map.h → src/test/_unittest/ut_pmem2_map.h b/src/test/unittest/ut_pmem2_map.h → src/test/_unittest/ut_pmem2_map.h
diff --git a/src/test/unittest/ut_pmem2_setup.c → src/test/_unittest/ut_pmem2_setup.c b/src/test/unittest/ut_pmem2_setup.c → src/test/_unittest/ut_pmem2_setup.c
diff --git a/src/test/unittest/ut_pmem2_setup.h → src/test/_unittest/ut_pmem2_setup.h b/src/test/unittest/ut_pmem2_setup.h → src/test/_unittest/ut_pmem2_setup.h
diff --git a/...est/unittest/ut_pmem2_setup_integration.c → ...st/_unittest/ut_pmem2_setup_integration.c b/...est/unittest/ut_pmem2_setup_integration.c → ...st/_unittest/ut_pmem2_setup_integration.c
diff --git a/...est/unittest/ut_pmem2_setup_integration.h → ...st/_unittest/ut_pmem2_setup_integration.h b/...est/unittest/ut_pmem2_setup_integration.h → ...st/_unittest/ut_pmem2_setup_integration.h
diff --git a/src/test/unittest/ut_pmem2_source.c → src/test/_unittest/ut_pmem2_source.c b/src/test/unittest/ut_pmem2_source.c → src/test/_unittest/ut_pmem2_source.c
diff --git a/src/test/unittest/ut_pmem2_source.h → src/test/_unittest/ut_pmem2_source.h b/src/test/unittest/ut_pmem2_source.h → src/test/_unittest/ut_pmem2_source.h
diff --git a/src/test/unittest/ut_pmem2_utils.c → src/test/_unittest/ut_pmem2_utils.c b/src/test/unittest/ut_pmem2_utils.c → src/test/_unittest/ut_pmem2_utils.c
diff --git a/src/test/unittest/ut_pmem2_utils.h → src/test/_unittest/ut_pmem2_utils.h b/src/test/unittest/ut_pmem2_utils.h → src/test/_unittest/ut_pmem2_utils.h
diff --git a/src/test/unittest/ut_pthread.c → src/test/_unittest/ut_pthread.c b/src/test/unittest/ut_pthread.c → src/test/_unittest/ut_pthread.c
diff --git a/src/test/unittest/ut_signal.c → src/test/_unittest/ut_signal.c b/src/test/unittest/ut_signal.c → src/test/_unittest/ut_signal.c
diff --git a/src/test/unittest/utils.py → src/test/_unittest/utils.py b/src/test/unittest/utils.py → src/test/_unittest/utils.py
diff --git a/src/test/unittest/valgrind.py → src/test/_unittest/valgrind.py b/src/test/unittest/valgrind.py → src/test/_unittest/valgrind.py
diff --git a/src/test/arch_flags/TEST0 b/src/test/arch_flags/TEST0
@@ -1,12 +1,12 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2015-2019, Intel Corporation
+# Copyright 2015-2024, Intel Corporation
 
 #
 # src/test/arch_flags/TEST0 -- unit test for util_get_arch_flags function
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 

diff --git a/src/test/checksum/TEST0 b/src/test/checksum/TEST0
@@ -1,12 +1,12 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2014-2019, Intel Corporation
+# Copyright 2014-2024, Intel Corporation
 
 #
 # src/test/checksum/TEST0 -- unit test for checksum
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 

diff --git a/src/test/compat_incompat_features/TEST0 b/src/test/compat_incompat_features/TEST0
@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017-2023, Intel Corporation
+# Copyright 2017-2024, Intel Corporation
 #
 #
 # compat_incompat_features/TEST0 -- test for compat/incompat feature flags
 #
 # check if pool opens when compat flags are equal and nonzero
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type	medium
 require_fs_type		any

diff --git a/src/test/compat_incompat_features/TEST1 b/src/test/compat_incompat_features/TEST1
@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017-2023, Intel Corporation
+# Copyright 2017-2024, Intel Corporation
 #
 #
 # compat_incompat_features/TEST1 -- test for compat/incompat feature flags
 #
 # check if pool fails to open when compat flags differ between parts
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type	medium
 require_fs_type		any

diff --git a/src/test/compat_incompat_features/TEST2 b/src/test/compat_incompat_features/TEST2
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017-2023, Intel Corporation
+# Copyright 2017-2024, Intel Corporation
 #
 #
 # compat_incompat_features/TEST2 -- test for compat/incompat feature flags
@@ -9,7 +9,7 @@
 # than poolset options
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type	medium
 require_fs_type		any

diff --git a/src/test/compat_incompat_features/TEST3 b/src/test/compat_incompat_features/TEST3
@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017-2023, Intel Corporation
+# Copyright 2017-2024, Intel Corporation
 #
 #
 # compat_incompat_features/TEST3 -- test for compat/incompat feature flags
 #
 # check if pool fails to open when incompat flags differ between parts
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type	medium
 require_fs_type		any

diff --git a/src/test/compat_incompat_features/TEST4 b/src/test/compat_incompat_features/TEST4
@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017-2023, Intel Corporation
+# Copyright 2017-2024, Intel Corporation
 #
 #
 # compat_incompat_features/TEST4 -- test for compat/incompat feature flags
 #
 # check if pool fails to open when incompat flags do not match poolset options
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type	medium
 require_fs_type		any

diff --git a/src/test/ctl_cow/TEST0 b/src/test/ctl_cow/TEST0
@@ -7,7 +7,7 @@
 # for obj pool
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 require_command md5sum

diff --git a/src/test/ctl_cow/TEST3 b/src/test/ctl_cow/TEST3
@@ -7,7 +7,7 @@
 # on Device DAX when copy_on_write.at_open=1 fails
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 require_dax_devices 1

diff --git a/src/test/ctl_prefault/TEST0 b/src/test/ctl_prefault/TEST0
@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2018-2023, Intel Corporation
+# Copyright 2018-2024, Intel Corporation
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type short
 

diff --git a/src/test/daxio/TEST0 b/src/test/daxio/TEST0
@@ -1,12 +1,12 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2018-2019, Intel Corporation
+# Copyright 2018-2024, Intel Corporation
 #
 #
 # daxio/TEST0 -- test for daxio utility; basic functionality
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 require_fs_type any

diff --git a/src/test/daxio/TEST1 b/src/test/daxio/TEST1
@@ -1,12 +1,12 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2018-2019, Intel Corporation
+# Copyright 2018-2024, Intel Corporation
 #
 #
 # daxio/TEST1 -- test for daxio utility; negative scenarios
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 require_fs_type any

diff --git a/src/test/daxio/TEST2 b/src/test/daxio/TEST2
@@ -1,11 +1,11 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2018-2019, Intel Corporation
+# Copyright 2018-2024, Intel Corporation
 #
 #
 # daxio/TEST2 -- test for daxio utility; move data between two devices
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 require_fs_type any

diff --git a/src/test/daxio/TEST3 b/src/test/daxio/TEST3
@@ -1,13 +1,13 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2018-2019, Intel Corporation
+# Copyright 2018-2024, Intel Corporation
 #
 #
 # daxio/TEST3 -- test for daxio utility; exactly the same as TEST0,
 #                but using various size units (KB, KiB, K, B, ...)
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 require_fs_type any

diff --git a/src/test/ex_libpmem/TEST0 b/src/test/ex_libpmem/TEST0
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 #
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2015-2023, Intel Corporation
+# Copyright 2015-2024, Intel Corporation
 #
 # Copyright (c) 2016, Microsoft Corporation. All rights reserved.
 #
@@ -38,7 +38,7 @@
 # src/test/ex_libpmem/TEST0 -- unit test for libpmem examples
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 

diff --git a/src/test/ex_libpmem/TEST1 b/src/test/ex_libpmem/TEST1
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 #
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2015-2019, Intel Corporation
+# Copyright 2015-2024, Intel Corporation
 #
 # Copyright (c) 2016, Microsoft Corporation. All rights reserved.
 #
@@ -38,7 +38,7 @@
 # src/test/ex_libpmem/TEST1 -- unit test for libpmem examples
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 

diff --git a/src/test/ex_libpmemobj/TEST0 b/src/test/ex_libpmemobj/TEST0
@@ -6,7 +6,7 @@
 # src/test/ex_libpmemobj/TEST0 -- unit test for libpmemobj examples
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 require_build_type debug nondebug

diff --git a/src/test/ex_libpmemobj/TEST1 b/src/test/ex_libpmemobj/TEST1
@@ -6,7 +6,7 @@
 # src/test/ex_libpmemobj/TEST1 -- unit test for libpmemobj examples
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium
 

diff --git a/src/test/ex_libpmemobj/TEST15 b/src/test/ex_libpmemobj/TEST15
@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2015-2023, Intel Corporation
+# Copyright 2015-2024, Intel Corporation
 
 #
 # src/test/ex_libpmemobj/TEST15 -- unit test for libpmemobj examples
 # This test is not run on GH Actions, as it requires
 # connecting a terminal to standard output.
 #
 
-. ../unittest/unittest.sh
+. ../_unittest/unittest.sh
 
 require_test_type medium