Clean up CMock makefiles and add coverage filtering (#523)

* Cleanup Makefiles

* Add lcovrc configuration file

* Add CMock test build directory to .gitignore

* Add callgraph.py and filtercov.py scripts

* Cleanup list Makefile and update list_utest.c with coverage tags

* Add information about coverage filtering and running single test cases

* Remove -fprofile-exclude-files for compatibility with older versions of gcc.
Fix line endings (change to unix style)

* Lint callgraph.py and filtercov.py. Print and error when no target functions are defined.

* Indent with spaces when possible

* Replace tabs with spaces and enable .RECIPEPREFIX

* Add fake_port.h and related portmacro.h changes

* Fix list makefile when bin directory is not available

* Clean up grouped rules

* Update makesfile.. Add "two_tests" example dir

* Fix memory checker error

* Move common makefile items to subdir.mk and testdir.mk includes

* Update core_checker.py exclusions

* Remove line from portmacro.h that doesn't match core_checker.py
This commit is contained in:
Paul Bartell 2021-03-15 17:01:29 -07:00 committed by GitHub
parent c8fa483b68
commit d7e5f40885
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 1110 additions and 329 deletions

View file

@ -1,98 +1,116 @@
# indent with spaces
.RECIPEPREFIX := $(.RECIPEPREFIX) $(.RECIPEPREFIX)
include makefile.in
# Change to match installed location
export CC ?= /usr/local/bin/gcc
export LD ?= /usr/local/bin/ld
# Add units here when adding a new unit test directory with the same name
UNITS := queue list timers
UNITS += list
#UNITS += queue
#UNITS += timers
include makefile.in
COVINFO := $(BUILD_DIR)/cmock_test.info
LCOV_LIST := $(foreach unit,$(UNITS),$(GENERATED_DIR)/$(unit).info )
.PHONY: all doc clean $(UNITS) directories coverage zero_coverage
.PHONY: run run_formatted run_col_formatted run_col
.PHONY: all doc clean $(UNITS) directories coverage zero_coverage \
run run_formatted run_col_formatted run_col libs execs lcov \
help
all: doc coverage
execs: $(UNITS) | directories
execs: $(UNITS)
$(UNITS) : ${LIB_DIR}/libcmock.so \
${LIB_DIR}/libunity.so \
${LIB_DIR}/libunitymemory.so \
| directories
$(MAKE) -C $@
$(UNITS) : libs | directories
$(MAKE) -C $@
doc: | directories
$(MAKE) -C doc all
SHARED_LIBS := $(addprefix $(LIB_DIR)/,$(addsuffix .so,$(LIBS)))
directories : $(BUILD_DIR) $(GENERATED_DIR) $(COVERAGE_DIR) $(BIN_DIR) $(DOC_DIR) $(LIB_DIR)
libs : $(SHARED_LIBS)
$(BUILD_DIR) :
-mkdir $(BUILD_DIR)
$(GENERATED_DIR) :
-mkdir -p $(GENERATED_DIR)
$(COVERAGE_DIR) :
-mkdir -p $(COVERAGE_DIR)
$(BIN_DIR) :
-mkdir -p $(BIN_DIR)
$(DOC_DIR) :
-mkdir -p $(DOC_DIR)
$(LIB_DIR) :
-mkdir -p $(LIB_DIR)
doc:
$(MAKE) -C doc all
clean:
rm -rf build
rm -rf build
help:
@echo -e 'Usage: $$ make <unit>\n '
@echo -e ' where <unit> is one of: $(UNITS) doc all run run_formatted run_col run_col_formatted coverage'
@echo -e 'Usage: $$ make <unit>\n '
@echo -e ' where <unit> is one of: $(UNITS) doc all run run_formatted run_col run_col_formatted coverage'
$(LIB_DIR)/libcmock.so : ${CMOCK_SRC_DIR}/cmock.c \
${CMOCK_SRC_DIR}/cmock.h \
${LIB_DIR}/libunity.so \
Makefile | directories
${CC} -o $@ -shared -fPIC $< ${INCLUDE_DIR}
${CMOCK_SRC_DIR}/cmock.h \
${LIB_DIR}/libunity.so \
Makefile
mkdir -p $(LIB_DIR)
${CC} -o $@ -shared -fPIC $< ${INCLUDE_DIR}
$(LIB_DIR)/libunity.so : ${UNITY_SRC_DIR}/unity.c \
${UNITY_SRC_DIR}/unity.h \
Makefile | directories
${CC} -o $@ -shared -fPIC $<
${UNITY_SRC_DIR}/unity.h \
Makefile
mkdir -p $(LIB_DIR)
${CC} -o $@ -shared -fPIC $<
$(LIB_DIR)/libunitymemory.so: ${UNITY_EXTRAS_DIR}/memory/src/unity_memory.c \
${UNITY_EXTRAS_DIR}/memory/src/unity_memory.h \
${LIB_DIR}/libunity.so \
Makefile | directories
${CC} -o $@ -shared -fPIC $< ${INCLUDE_DIR}
$(LIB_DIR)/libunitymemory.so: ${UNITY_MEM_DIR}/unity_memory.c \
${UNITY_MEM_DIR}/unity_memory.h \
${LIB_DIR}/libunity.so \
Makefile
mkdir -p $(LIB_DIR)
${CC} -o $@ -shared -fPIC $< ${INCLUDE_DIR}
run : $(UNITS) directories
-rm $(BUILD_DIR)/unit_test_report.txt
for f in $(BIN_DIR)/*; do \
$${f} | tee -a $(BUILD_DIR)/unit_test_report.txt; \
done
cd $(BUILD_DIR) && \
ruby $(UNITY_BIN_DIR)/parse_output.rb -xml \
$(BUILD_DIR)/unit_test_report.txt
$(LIB_DIR)/libcexception.so: ${C_EXCEPTION_SRC_DIR}/CException.c \
${C_EXCEPTION_SRC_DIR}/CException.h
mkdir -p $(LIB_DIR)
${CC} -o $@ -shared -fPIC $< ${INCLUDE_DIR}
run_col : $(UNITS) zero_coverage | directories
for f in $(BIN_DIR)/*; do \
ruby -r $(UNITY_BIN_DIR)/colour_reporter.rb -e "report('`$${f}`')"; done
run : $(UNITS)
mkdir -p $(BUILD_DIR)
rm -f $(BUILD_DIR)/unit_test_report.txt
for f in $(BIN_DIR)/*; do \
$${f} | tee -a $(BUILD_DIR)/unit_test_report.txt; \
done
cd $(BUILD_DIR) && \
ruby $(UNITY_BIN_DIR)/parse_output.rb -xml \
$(BUILD_DIR)/unit_test_report.txt
run_formatted : $(UNITS) zero_coverage | directories
for f in $(BIN_DIR)/*; do \
$${f} > $(BUILD_DIR)/output; \
ruby $(UNITY_BIN_DIR)/parse_output.rb $(BUILD_DIR)/output ; \
done
run_col : $(UNITS) zero_coverage
for f in $(BIN_DIR)/*; do \
ruby -r $(UNITY_BIN_DIR)/colour_reporter.rb -e "report('`$${f}`')"; done
run_col_formatted : $(UNITS) zero_coverage | directories
for f in $(BIN_DIR)/*; do \
$${f} > $(BUILD_DIR)/output; \
ruby -r $(UNITY_BIN_DIR)/colour_reporter.rb \
-e "report('$$(ruby $(UNITY_BIN_DIR)/parse_output.rb \
$(BUILD_DIR)/output)')"; \
done
run_formatted : $(UNITS) zero_coverage
for f in $(BIN_DIR)/*; do \
$${f} > $(BUILD_DIR)/output; \
ruby $(UNITY_BIN_DIR)/parse_output.rb $(BUILD_DIR)/output ; \
done
run_col_formatted : $(UNITS) zero_coverage
for f in $(BIN_DIR)/*; do \
$${f} > $(BUILD_DIR)/output; \
ruby -r $(UNITY_BIN_DIR)/colour_reporter.rb \
-e "report('$$(ruby $(UNITY_BIN_DIR)/parse_output.rb \
$(BUILD_DIR)/output)')"; \
done
zero_coverage :
lcov --zerocounters --directory $(BUILD_DIR)
lcov --zerocounters --directory $(BUILD_DIR) --config-file $(UT_ROOT_DIR)/lcovrc
coverage : run_col
lcov --base-directory . --directory . -c --rc lcov_branch_coverage=1 \
--rc genhtml_branch_coverage=1 -o $(BUILD_DIR)/cmock_test.info
genhtml $(BUILD_DIR)/cmock_test.info --branch-coverage \
--output-directory $(COVERAGE_DIR)
lcov --base-directory $(KERNEL_DIR) --directory $(BUILD_DIR) --capture \
--config-file $(UT_ROOT_DIR)/lcovrc -o $(BUILD_DIR)/cmock_test.info
genhtml $(BUILD_DIR)/cmock_test.info --branch-coverage \
--config-file $(UT_ROOT_DIR)/lcovrc --output-directory $(COVERAGE_DIR)
lcov : $(COVINFO)
# Combine lcov from each test bin into one lcov info file for the suite
$(COVINFO) : $(LCOV_LIST)
lcov $(LCOV_OPTS) -o $@ $(foreach cov,$(LCOV_LIST),--add-tracefile $(cov) )
# Generate lcov for each suite
$(LCOV_LIST) : zero_coverage
$(foreach unit,$(UNITS),\
make -C $(unit) lcov;)
lcovhtml : $(COVINFO)
mkdir -p $(COVERAGE_DIR)
genhtml $(COVINFO) $(LCOV_OPTS) --output-directory $(COVERAGE_DIR) --quiet