Skip to content

Valgrind support added for unittests #12064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions UNITTESTS/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ if (COVERAGE)

endif(COVERAGE)

if (VALGRIND)
find_program(MEMORYCHECK_COMMAND valgrind)
endif(VALGRIND)

####################
# UNIT TESTS
####################
Expand Down Expand Up @@ -196,6 +200,7 @@ foreach(testfile ${unittest-file-list})
if (unittest-test-sources)
# Create the executable.
add_executable(${TEST_SUITE_NAME} ${unittest-test-sources})

target_include_directories(${TEST_SUITE_NAME} PRIVATE
${unittest-includes})
target_compile_options(${TEST_SUITE_NAME} PRIVATE
Expand Down
6 changes: 4 additions & 2 deletions UNITTESTS/mbed_unittest.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,15 @@ def _mbed_unittest_test(options, cwd, pwd):
tool.create_makefiles(path_to_src=src_path,
generator=options.cmake_generator,
coverage_output_type=options.coverage,
debug=options.debug_build)
debug=options.debug_build,
valgrind=options.valgrind)

# Build tests
tool.build_tests()

if options.run_only:
tool.run_tests(filter_regex=options.test_regex)
tool.run_tests(filter_regex=options.test_regex,
valgrind=options.valgrind)

# If code coverage generation:
if options.coverage:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ TEST_F(SlicingBlockModuleTest, slice_in_middle)
EXPECT_EQ(0, memcmp(buf, magic, BLOCK_SIZE));
bd.read(buf, BLOCK_SIZE * 3, BLOCK_SIZE);
EXPECT_EQ(0, memcmp(buf, magic, BLOCK_SIZE));

delete[] program;
}

TEST_F(SlicingBlockModuleTest, slice_at_the_end)
Expand All @@ -143,6 +145,8 @@ TEST_F(SlicingBlockModuleTest, slice_at_the_end)
//Verify that blocks before and after the slicing blocks are not touched
bd.read(buf, BLOCK_SIZE * 7, BLOCK_SIZE);
EXPECT_EQ(0, memcmp(buf, magic, BLOCK_SIZE));

delete[] program;
}

TEST_F(SlicingBlockModuleTest, over_write)
Expand All @@ -163,6 +167,8 @@ TEST_F(SlicingBlockModuleTest, over_write)

//Program a test value to address that is one pass the device size
EXPECT_EQ(slice.program(program, 2 * BLOCK_SIZE, BLOCK_SIZE), BD_ERROR_DEVICE_ERROR);

delete[] buf;
delete[] program;
}

Expand Down
7 changes: 7 additions & 0 deletions UNITTESTS/unit_test/get_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@ def get_cmake_tool():

return _get_program(["cmake"])

def get_valgrind_tool():
"""
Get Valgrind program
"""

return _get_program(["valgrind"])

def get_cxx_tool():
"""
Get C++ compiler
Expand Down
5 changes: 5 additions & 0 deletions UNITTESTS/unit_test/options.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,11 @@ def get_options_parser():
help="Build directory. Default: UNITTESTS/build/",
dest="build")

parser.add_argument("--valgrind",
help="Use Valgrind when running executables",
action="store_true",
dest="valgrind")

parser.add_argument("--new",
action="append",
help="Source file from which to generate test files. E.g. rtos/Semaphore.cpp",
Expand Down
32 changes: 25 additions & 7 deletions UNITTESTS/unit_test/test.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
from .get_tools import get_make_tool, \
get_cmake_tool, \
get_cxx_tool, \
get_c_tool
get_c_tool, \
get_valgrind_tool
from .settings import DEFAULT_CMAKE_GENERATORS

class UnitTestTool(object):
Expand Down Expand Up @@ -59,7 +60,8 @@ def create_makefiles(self,
path_to_src=None,
generator=None,
coverage_output_type=None,
debug=False):
debug=False,
valgrind=False):
"""
Create Makefiles and prepare targets with CMake.

Expand Down Expand Up @@ -94,6 +96,17 @@ def create_makefiles(self,
if coverage_output_type:
args.append("-DCOVERAGE:STRING=%s" % coverage_output_type)

if valgrind:
valgrind = get_valgrind_tool()
if valgrind is None:
logging.error(
"No Valgrind found in Path. Install all the required tools.\n")
sys.exit(1)
args.append("-DVALGRIND=1")
args.append("-DMEMORYCHECK_COMMAND_OPTIONS=\"--track-origins=yes\" \"--leak-check=full\" \"--show-reachable=yes\" \"--error-exitcode=1\"")
else:
args.append("-DVALGRIND=0")

if path_to_src is not None:
args.append(path_to_src)

Expand All @@ -118,7 +131,7 @@ def build_tests(self):
"Building unit tests failed.",
"Unit tests built successfully.")

def run_tests(self, filter_regex=None):
def run_tests(self, filter_regex=None, valgrind=False):
"""
Run unit tests.

Expand All @@ -127,11 +140,16 @@ def run_tests(self, filter_regex=None):
"""

args = [self.make_program, "test"]

if filter_regex:
args.append("ARGS=-R %s -V -D ExperimentalTest" % filter_regex)
if valgrind:
if filter_regex:
args.append("ARGS=-R %s -V -D ExperimentalMemCheck" % filter_regex)
else:
args.append("ARGS=-V -D ExperimentalMemCheck")
else:
args.append("ARGS=-V -D ExperimentalTest")
if filter_regex:
args.append("ARGS=-R %s -V -D ExperimentalTest" % filter_regex)
else:
args.append("ARGS=-V -D ExperimentalTest")

if logging.getLogger().getEffectiveLevel() == logging.DEBUG:
args.append("VERBOSE=1")
Expand Down