2 # this will fail if run with bash!
4 #==================================================================================
5 # Copyright (c) 2019 Nokia
6 # Copyright (c) 2018-2019 AT&T Intellectual Property.
8 # Licensed under the Apache License, Version 2.0 (the "License");
9 # you may not use this file except in compliance with the License.
10 # You may obtain a copy of the License at
12 # http://www.apache.org/licenses/LICENSE-2.0
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS,
16 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 # See the License for the specific language governing permissions and
18 # limitations under the License.
19 #==================================================================================
23 # Mnemonic: unit_test.ksh
24 # Abstract: Execute unit test(s) in the directory and produce a more
25 # meaningful summary than gcov gives by default (exclude
26 # coverage on the unit test functions).
28 # Test files must be named *_test.c, or must explicitly be
29 # supplied on the command line. Functions in the test
30 # files will not be reported on provided that they have
31 # their prototype (all on the SAME line) as:
32 # static type name() {
34 # Functions with coverage less than 80% will be reported as
35 # [LOW] in the output. A file is considered to pass if the
36 # overall execution percentage for the file is >= 80% regardless
37 # of the number of functions that reported low.
39 # Test programmes are built prior to execution. Plan-9 mk is
40 # the preferred builder, but as it's not widly adopted (sigh)
41 # make is assumed and -M will shift to Plan-9. Use -C xxx to
42 # invoke a customised builder.
44 # For a module which does not pass, we will attempt to boost
45 # the coverage by discounting the unexecuted lines which are
46 # inside of if() statements that are checking return from
47 # (m)alloc() calls or are checking for nil pointers as these
48 # cases are likely impossible to drive. When discount testing
49 # is done both the failure message from the original analysis
50 # and a pass/fail message from the discount test are listed,
51 # but only the result of the discount test is taken into
52 # consideration with regard to overall success.
54 # Date: 16 January 2018
55 # Author: E. Scott Daniels
56 # -------------------------------------------------------------------------
59 echo "usage: $0 [-G|-M|-C custom-command-string] [-c cov-target] [-f] [-v] [files]"
60 echo " if -C is used to provide a custom build command then it must "
61 echo " contain a %s which will be replaced with the unit test file name."
62 echo ' e.g.: -C "mk -a %s"'
63 echo " -c allows user to set the target coverage for a module to pass; default is 80"
64 echo " -f forces a discount check (normally done only if coverage < target)"
65 echo " -v will write additional information to the tty and save the disccounted file if discount run or -f given"
68 # read through the given file and add any functions that are static to the
69 # ignored list. Only test and test tools files should be parsed.
71 function add_ignored_func {
78 grep "^static.*(.*).*{" $1 | awk ' # get list of test functions to ignore
90 # Parse the .gcov file and discount any unexecuted lines which are in if()
91 # blocks that are testing the result of alloc/malloc calls, or testing for
92 # nil pointers. The feeling is that these might not be possible to drive
93 # and shoudn't contribute to coverage deficencies.
95 # In verbose mode, the .gcov file is written to stdout and any unexecuted
96 # line which is discounted is marked with ===== replacing the ##### marking
99 # The return value is 0 for pass; non-zero for fail.
100 function discount_an_checks {
103 mct=$( get_mct ${1%.gcov} ) # see if a special coverage target is defined for this
116 awk -v module_cov_target=$mct \
117 -v full_name="${1}" \
118 -v module="${f%.*}" \
121 function spit_line( ) {
127 /-:/ { # skip unexecutable lines
129 seq++ # allow blank lines in a sequence group
134 nexec++ # number of executable lines
139 if( $2+0 != seq+1 ) {
147 if( prev_if && prev_malloc ) {
149 #printf( "allow discount: %s\n", $0 )
151 gsub( "#####", "=====", $0 )
162 /if[(].*alloc.*{/ { # if( (x = malloc( ... )) != NULL ) or if( (p = sym_alloc(...)) != NULL )
170 /if[(].* == NULL/ { # a nil check likely not easily forced if it wasnt driven
179 if( seq+1 == $2+0 && prev_malloc ) { // malloc on previous line
201 net = unexec - discount
202 orig_cov = ((nexec-unexec)/nexec)*100 # original coverage
203 adj_cov = ((nexec-net)/nexec)*100 # coverage after discount
204 pass_fail = adj_cov < module_cov_target ? "FAIL" : "PASS"
205 rc = adj_cov < module_cov_target ? 1 : 0
207 printf( "[%s] %s executable=%d unexecuted=%d discounted=%d net_unex=%d cov=%d% ==> %d%%% target=%d%%\n",
208 pass_fail, full_name ? full_name : module, nexec, unexec, discount, net, orig_cov, adj_cov, module_cov_target )
210 printf( "[%s] %d%% (%d%%) %s\n", pass_fail, adj_cov, orig_cov, full_name ? full_name : module )
218 # Given a file name ($1) see if it is in the ./.targets file. If it is
219 # return the coverage listed, else return (echo) the default $module_cov_target
222 typeset v=$module_cov_target
224 if [[ -f ./.targets ]]
226 grep "^$1 " ./.targets | head -1 | read junk tv
233 # ------------------------------------------------------------------------
235 export C_INCLUDE_PATH="../src/common/include"
238 builder="make -B %s" # default to plain ole make
240 trigger_discount_str="FAIL"
242 while [[ $1 == "-"* ]]
245 -C) builder="$2"; shift;; # custom build command
246 -G) builder="gmake %s";;
247 -M) builder="mk -a %s";; # use plan-9 mk (better, but sadly not widly used)
249 -c) module_cov_target=$2; shift;;
250 -f) force_discounting=1;
251 trigger_discount_str="FAIL|PASS" # check all outcomes for each module
254 -v) (( verbose++ ));;
257 --help) usage; exit 0;;
260 *) echo "unrecognised option: $1" >&2
272 for tfile in *_test.c
283 echo "$tfile --------------------------------------"
284 bcmd=$( printf "$builder" "${tfile%.c}" )
285 if ! $bcmd >/tmp/PID$$.log 2>&1
287 echo "[FAIL] cannot build $tfile"
293 iflist="main sig_clean_exit " # ignore external functions from our tools
294 add_ignored_func $tfile # ignore all static functions in our test driver
295 add_ignored_func test_support.c # ignore all static functions in our test tools
297 if ! ${tfile%.c} >/tmp/PID$$.log 2>&1
299 echo "[FAIL] unit test failed for: $tfile"
306 sed '/^#/ d; /^$/ d; s/^/TARGET: /' ./.targets
307 gcov -f ${tfile%.c} | sed "s/'//g"
309 -v ignore_list="$iflist" \
310 -v module_cov_target=$module_cov_target \
314 nignore = split( ignore_list, ignore, " " )
315 for( i = 1; i <= nignore; i++ ) {
319 exit_code = 0 # assume good
329 /File.*_test/ || /File.*test_/ { # dont report on test files
347 fname = "skipped: " fname # should never see and make it smell if we do
362 if( target[fname] ) {
365 mct = module_cov_target
368 printf( "[INFO] target coverage for %s is %d%%\n", fname, mct )
371 printf( "[FAIL] %3d%% %s\n\n", pct, fname ) # CAUTION: write only 3 things here
374 printf( "[PASS] %3d%% %s\n\n", pct, fname )
378 printf( "[LOW] %3d%% %s\n", pct, fname )
380 printf( "[OK] %3d%% %s\n", pct, fname )
388 ' >/tmp/PID$$.log # capture output to run discount on failures
391 if (( rc || force_discounting )) # didn't pass, or forcing, see if discounting helps
393 egrep "$trigger_discount_str" /tmp/PID$$.log | while read state junk name
395 echo "[INFO] checking to see if discounting improves coverage for $name"
396 if ! discount_an_checks $name.gcov >/tmp/PID$$.disc
400 tail -1 /tmp/PID$$.disc
401 if (( verbose )) # updated file was generated, keep here
403 echo "[INFO] discounted coverage info in: ${tfile##*/}.dcov"
404 mv /tmp/PID$$.disc ${tfile##*/}.dcov