nexmon – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 #! /bin/sh
2 # Copyright (C) 2011-2013 Free Software Foundation, Inc.
3 #
4 # This program is free software; you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation; either version 2, or (at your option)
7 # any later version.
8 #
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16  
17 # As a special exception to the GNU General Public License, if you
18 # distribute this file as part of a program that contains a
19 # configuration script generated by Autoconf, you may include it under
20 # the same distribution terms that you use for the rest of that program.
21  
22 # This file is maintained in Automake, please report
23 # bugs to <bug-automake@gnu.org> or send patches to
24 # <automake-patches@gnu.org>.
25  
26 scriptversion=2011-12-27.17; # UTC
27  
28 # Make unconditional expansion of undefined variables an error. This
29 # helps a lot in preventing typo-related bugs.
30 set -u
31  
32 me=tap-driver.sh
33  
34 fatal ()
35 {
36 echo "$me: fatal: $*" >&2
37 exit 1
38 }
39  
40 usage_error ()
41 {
42 echo "$me: $*" >&2
43 print_usage >&2
44 exit 2
45 }
46  
47 print_usage ()
48 {
49 cat <<END
50 Usage:
51 tap-driver.sh --test-name=NAME --log-file=PATH --trs-file=PATH
52 [--expect-failure={yes|no}] [--color-tests={yes|no}]
53 [--enable-hard-errors={yes|no}] [--ignore-exit]
54 [--diagnostic-string=STRING] [--merge|--no-merge]
55 [--comments|--no-comments] [--] TEST-COMMAND
56 The \`--test-name', \`--log-file' and \`--trs-file' options are mandatory.
57 END
58 }
59  
60 # TODO: better error handling in option parsing (in particular, ensure
61 # TODO: $log_file, $trs_file and $test_name are defined).
62 test_name= # Used for reporting.
63 log_file= # Where to save the result and output of the test script.
64 trs_file= # Where to save the metadata of the test run.
65 expect_failure=0
66 color_tests=0
67 merge=0
68 ignore_exit=0
69 comments=0
70 diag_string='#'
71 while test $# -gt 0; do
72 case $1 in
73 --help) print_usage; exit $?;;
74 --version) echo "$me $scriptversion"; exit $?;;
75 --test-name) test_name=$2; shift;;
76 --log-file) log_file=$2; shift;;
77 --trs-file) trs_file=$2; shift;;
78 --color-tests) color_tests=$2; shift;;
79 --expect-failure) expect_failure=$2; shift;;
80 --enable-hard-errors) shift;; # No-op.
81 --merge) merge=1;;
82 --no-merge) merge=0;;
83 --ignore-exit) ignore_exit=1;;
84 --comments) comments=1;;
85 --no-comments) comments=0;;
86 --diagnostic-string) diag_string=$2; shift;;
87 --) shift; break;;
88 -*) usage_error "invalid option: '$1'";;
89 esac
90 shift
91 done
92  
93 test $# -gt 0 || usage_error "missing test command"
94  
95 case $expect_failure in
96 yes) expect_failure=1;;
97 *) expect_failure=0;;
98 esac
99  
100 if test $color_tests = yes; then
101 init_colors='
102 color_map["red"]="" # Red.
103 color_map["grn"]="" # Green.
104 color_map["lgn"]="" # Light green.
105 color_map["blu"]="" # Blue.
106 color_map["mgn"]="" # Magenta.
107 color_map["std"]="" # No color.
108 color_for_result["ERROR"] = "mgn"
109 color_for_result["PASS"] = "grn"
110 color_for_result["XPASS"] = "red"
111 color_for_result["FAIL"] = "red"
112 color_for_result["XFAIL"] = "lgn"
113 color_for_result["SKIP"] = "blu"'
114 else
115 init_colors=''
116 fi
117  
118 # :; is there to work around a bug in bash 3.2 (and earlier) which
119 # does not always set '$?' properly on redirection failure.
120 # See the Autoconf manual for more details.
121 :;{
122 (
123 # Ignore common signals (in this subshell only!), to avoid potential
124 # problems with Korn shells. Some Korn shells are known to propagate
125 # to themselves signals that have killed a child process they were
126 # waiting for; this is done at least for SIGINT (and usually only for
127 # it, in truth). Without the `trap' below, such a behaviour could
128 # cause a premature exit in the current subshell, e.g., in case the
129 # test command it runs gets terminated by a SIGINT. Thus, the awk
130 # script we are piping into would never seen the exit status it
131 # expects on its last input line (which is displayed below by the
132 # last `echo $?' statement), and would thus die reporting an internal
133 # error.
134 # For more information, see the Autoconf manual and the threads:
135 # <http://lists.gnu.org/archive/html/bug-autoconf/2011-09/msg00004.html>
136 # <http://mail.opensolaris.org/pipermail/ksh93-integration-discuss/2009-February/004121.html>
137 trap : 1 3 2 13 15
138 if test $merge -gt 0; then
139 exec 2>&1
140 else
141 exec 2>&3
142 fi
143 "$@"
144 echo $?
145 ) | LC_ALL=C ${AM_TAP_AWK-awk} \
146 -v me="$me" \
147 -v test_script_name="$test_name" \
148 -v log_file="$log_file" \
149 -v trs_file="$trs_file" \
150 -v expect_failure="$expect_failure" \
151 -v merge="$merge" \
152 -v ignore_exit="$ignore_exit" \
153 -v comments="$comments" \
154 -v diag_string="$diag_string" \
155 '
156 # FIXME: the usages of "cat >&3" below could be optimized when using
157 # FIXME: GNU awk, and/on on systems that supports /dev/fd/.
158  
159 # Implementation note: in what follows, `result_obj` will be an
160 # associative array that (partly) simulates a TAP result object
161 # from the `TAP::Parser` perl module.
162  
163 ## ----------- ##
164 ## FUNCTIONS ##
165 ## ----------- ##
166  
167 function fatal(msg)
168 {
169 print me ": " msg | "cat >&2"
170 exit 1
171 }
172  
173 function abort(where)
174 {
175 fatal("internal error " where)
176 }
177  
178 # Convert a boolean to a "yes"/"no" string.
179 function yn(bool)
180 {
181 return bool ? "yes" : "no";
182 }
183  
184 function add_test_result(result)
185 {
186 if (!test_results_index)
187 test_results_index = 0
188 test_results_list[test_results_index] = result
189 test_results_index += 1
190 test_results_seen[result] = 1;
191 }
192  
193 # Whether the test script should be re-run by "make recheck".
194 function must_recheck()
195 {
196 for (k in test_results_seen)
197 if (k != "XFAIL" && k != "PASS" && k != "SKIP")
198 return 1
199 return 0
200 }
201  
202 # Whether the content of the log file associated to this test should
203 # be copied into the "global" test-suite.log.
204 function copy_in_global_log()
205 {
206 for (k in test_results_seen)
207 if (k != "PASS")
208 return 1
209 return 0
210 }
211  
212 # FIXME: this can certainly be improved ...
213 function get_global_test_result()
214 {
215 if ("ERROR" in test_results_seen)
216 return "ERROR"
217 if ("FAIL" in test_results_seen || "XPASS" in test_results_seen)
218 return "FAIL"
219 all_skipped = 1
220 for (k in test_results_seen)
221 if (k != "SKIP")
222 all_skipped = 0
223 if (all_skipped)
224 return "SKIP"
225 return "PASS";
226 }
227  
228 function stringify_result_obj(result_obj)
229 {
230 if (result_obj["is_unplanned"] || result_obj["number"] != testno)
231 return "ERROR"
232  
233 if (plan_seen == LATE_PLAN)
234 return "ERROR"
235  
236 if (result_obj["directive"] == "TODO")
237 return result_obj["is_ok"] ? "XPASS" : "XFAIL"
238  
239 if (result_obj["directive"] == "SKIP")
240 return result_obj["is_ok"] ? "SKIP" : COOKED_FAIL;
241  
242 if (length(result_obj["directive"]))
243 abort("in function stringify_result_obj()")
244  
245 return result_obj["is_ok"] ? COOKED_PASS : COOKED_FAIL
246 }
247  
248 function decorate_result(result)
249 {
250 color_name = color_for_result[result]
251 if (color_name)
252 return color_map[color_name] "" result "" color_map["std"]
253 # If we are not using colorized output, or if we do not know how
254 # to colorize the given result, we should return it unchanged.
255 return result
256 }
257  
258 function report(result, details)
259 {
260 if (result ~ /^(X?(PASS|FAIL)|SKIP|ERROR)/)
261 {
262 msg = ": " test_script_name
263 add_test_result(result)
264 }
265 else if (result == "#")
266 {
267 msg = " " test_script_name ":"
268 }
269 else
270 {
271 abort("in function report()")
272 }
273 if (length(details))
274 msg = msg " " details
275 # Output on console might be colorized.
276 print decorate_result(result) msg
277 # Log the result in the log file too, to help debugging (this is
278 # especially true when said result is a TAP error or "Bail out!").
279 print result msg | "cat >&3";
280 }
281  
282 function testsuite_error(error_message)
283 {
284 report("ERROR", "- " error_message)
285 }
286  
287 function handle_tap_result()
288 {
289 details = result_obj["number"];
290 if (length(result_obj["description"]))
291 details = details " " result_obj["description"]
292  
293 if (plan_seen == LATE_PLAN)
294 {
295 details = details " # AFTER LATE PLAN";
296 }
297 else if (result_obj["is_unplanned"])
298 {
299 details = details " # UNPLANNED";
300 }
301 else if (result_obj["number"] != testno)
302 {
303 details = sprintf("%s # OUT-OF-ORDER (expecting %d)",
304 details, testno);
305 }
306 else if (result_obj["directive"])
307 {
308 details = details " # " result_obj["directive"];
309 if (length(result_obj["explanation"]))
310 details = details " " result_obj["explanation"]
311 }
312  
313 report(stringify_result_obj(result_obj), details)
314 }
315  
316 # `skip_reason` should be empty whenever planned > 0.
317 function handle_tap_plan(planned, skip_reason)
318 {
319 planned += 0 # Avoid getting confused if, say, `planned` is "00"
320 if (length(skip_reason) && planned > 0)
321 abort("in function handle_tap_plan()")
322 if (plan_seen)
323 {
324 # Error, only one plan per stream is acceptable.
325 testsuite_error("multiple test plans")
326 return;
327 }
328 planned_tests = planned
329 # The TAP plan can come before or after *all* the TAP results; we speak
330 # respectively of an "early" or a "late" plan. If we see the plan line
331 # after at least one TAP result has been seen, assume we have a late
332 # plan; in this case, any further test result seen after the plan will
333 # be flagged as an error.
334 plan_seen = (testno >= 1 ? LATE_PLAN : EARLY_PLAN)
335 # If testno > 0, we have an error ("too many tests run") that will be
336 # automatically dealt with later, so do not worry about it here. If
337 # $plan_seen is true, we have an error due to a repeated plan, and that
338 # has already been dealt with above. Otherwise, we have a valid "plan
339 # with SKIP" specification, and should report it as a particular kind
340 # of SKIP result.
341 if (planned == 0 && testno == 0)
342 {
343 if (length(skip_reason))
344 skip_reason = "- " skip_reason;
345 report("SKIP", skip_reason);
346 }
347 }
348  
349 function extract_tap_comment(line)
350 {
351 if (index(line, diag_string) == 1)
352 {
353 # Strip leading `diag_string` from `line`.
354 line = substr(line, length(diag_string) + 1)
355 # And strip any leading and trailing whitespace left.
356 sub("^[ \t]*", "", line)
357 sub("[ \t]*$", "", line)
358 # Return what is left (if any).
359 return line;
360 }
361 return "";
362 }
363  
364 # When this function is called, we know that line is a TAP result line,
365 # so that it matches the (perl) RE "^(not )?ok\b".
366 function setup_result_obj(line)
367 {
368 # Get the result, and remove it from the line.
369 result_obj["is_ok"] = (substr(line, 1, 2) == "ok" ? 1 : 0)
370 sub("^(not )?ok[ \t]*", "", line)
371  
372 # If the result has an explicit number, get it and strip it; otherwise,
373 # automatically assing the next progresive number to it.
374 if (line ~ /^[0-9]+$/ || line ~ /^[0-9]+[^a-zA-Z0-9_]/)
375 {
376 match(line, "^[0-9]+")
377 # The final `+ 0` is to normalize numbers with leading zeros.
378 result_obj["number"] = substr(line, 1, RLENGTH) + 0
379 line = substr(line, RLENGTH + 1)
380 }
381 else
382 {
383 result_obj["number"] = testno
384 }
385  
386 if (plan_seen == LATE_PLAN)
387 # No further test results are acceptable after a "late" TAP plan
388 # has been seen.
389 result_obj["is_unplanned"] = 1
390 else if (plan_seen && testno > planned_tests)
391 result_obj["is_unplanned"] = 1
392 else
393 result_obj["is_unplanned"] = 0
394  
395 # Strip trailing and leading whitespace.
396 sub("^[ \t]*", "", line)
397 sub("[ \t]*$", "", line)
398  
399 # This will have to be corrected if we have a "TODO"/"SKIP" directive.
400 result_obj["description"] = line
401 result_obj["directive"] = ""
402 result_obj["explanation"] = ""
403  
404 if (index(line, "#") == 0)
405 return # No possible directive, nothing more to do.
406  
407 # Directives are case-insensitive.
408 rx = "[ \t]*#[ \t]*([tT][oO][dD][oO]|[sS][kK][iI][pP])[ \t]*"
409  
410 # See whether we have the directive, and if yes, where.
411 pos = match(line, rx "$")
412 if (!pos)
413 pos = match(line, rx "[^a-zA-Z0-9_]")
414  
415 # If there was no TAP directive, we have nothing more to do.
416 if (!pos)
417 return
418  
419 # Let`s now see if the TAP directive has been escaped. For example:
420 # escaped: ok \# SKIP
421 # not escaped: ok \\# SKIP
422 # escaped: ok \\\\\# SKIP
423 # not escaped: ok \ # SKIP
424 if (substr(line, pos, 1) == "#")
425 {
426 bslash_count = 0
427 for (i = pos; i > 1 && substr(line, i - 1, 1) == "\\"; i--)
428 bslash_count += 1
429 if (bslash_count % 2)
430 return # Directive was escaped.
431 }
432  
433 # Strip the directive and its explanation (if any) from the test
434 # description.
435 result_obj["description"] = substr(line, 1, pos - 1)
436 # Now remove the test description from the line, that has been dealt
437 # with already.
438 line = substr(line, pos)
439 # Strip the directive, and save its value (normalized to upper case).
440 sub("^[ \t]*#[ \t]*", "", line)
441 result_obj["directive"] = toupper(substr(line, 1, 4))
442 line = substr(line, 5)
443 # Now get the explanation for the directive (if any), with leading
444 # and trailing whitespace removed.
445 sub("^[ \t]*", "", line)
446 sub("[ \t]*$", "", line)
447 result_obj["explanation"] = line
448 }
449  
450 function get_test_exit_message(status)
451 {
452 if (status == 0)
453 return ""
454 if (status !~ /^[1-9][0-9]*$/)
455 abort("getting exit status")
456 if (status < 127)
457 exit_details = ""
458 else if (status == 127)
459 exit_details = " (command not found?)"
460 else if (status >= 128 && status <= 255)
461 exit_details = sprintf(" (terminated by signal %d?)", status - 128)
462 else if (status > 256 && status <= 384)
463 # We used to report an "abnormal termination" here, but some Korn
464 # shells, when a child process die due to signal number n, can leave
465 # in $? an exit status of 256+n instead of the more standard 128+n.
466 # Apparently, both behaviours are allowed by POSIX (2008), so be
467 # prepared to handle them both. See also Austing Group report ID
468 # 0000051 <http://www.austingroupbugs.net/view.php?id=51>
469 exit_details = sprintf(" (terminated by signal %d?)", status - 256)
470 else
471 # Never seen in practice.
472 exit_details = " (abnormal termination)"
473 return sprintf("exited with status %d%s", status, exit_details)
474 }
475  
476 function write_test_results()
477 {
478 print ":global-test-result: " get_global_test_result() > trs_file
479 print ":recheck: " yn(must_recheck()) > trs_file
480 print ":copy-in-global-log: " yn(copy_in_global_log()) > trs_file
481 for (i = 0; i < test_results_index; i += 1)
482 print ":test-result: " test_results_list[i] > trs_file
483 close(trs_file);
484 }
485  
486 BEGIN {
487  
488 ## ------- ##
489 ## SETUP ##
490 ## ------- ##
491  
492 '"$init_colors"'
493  
494 # Properly initialized once the TAP plan is seen.
495 planned_tests = 0
496  
497 COOKED_PASS = expect_failure ? "XPASS": "PASS";
498 COOKED_FAIL = expect_failure ? "XFAIL": "FAIL";
499  
500 # Enumeration-like constants to remember which kind of plan (if any)
501 # has been seen. It is important that NO_PLAN evaluates "false" as
502 # a boolean.
503 NO_PLAN = 0
504 EARLY_PLAN = 1
505 LATE_PLAN = 2
506  
507 testno = 0 # Number of test results seen so far.
508 bailed_out = 0 # Whether a "Bail out!" directive has been seen.
509  
510 # Whether the TAP plan has been seen or not, and if yes, which kind
511 # it is ("early" is seen before any test result, "late" otherwise).
512 plan_seen = NO_PLAN
513  
514 ## --------- ##
515 ## PARSING ##
516 ## --------- ##
517  
518 is_first_read = 1
519  
520 while (1)
521 {
522 # Involutions required so that we are able to read the exit status
523 # from the last input line.
524 st = getline
525 if (st < 0) # I/O error.
526 fatal("I/O error while reading from input stream")
527 else if (st == 0) # End-of-input
528 {
529 if (is_first_read)
530 abort("in input loop: only one input line")
531 break
532 }
533 if (is_first_read)
534 {
535 is_first_read = 0
536 nextline = $0
537 continue
538 }
539 else
540 {
541 curline = nextline
542 nextline = $0
543 $0 = curline
544 }
545 # Copy any input line verbatim into the log file.
546 print | "cat >&3"
547 # Parsing of TAP input should stop after a "Bail out!" directive.
548 if (bailed_out)
549 continue
550  
551 # TAP test result.
552 if ($0 ~ /^(not )?ok$/ || $0 ~ /^(not )?ok[^a-zA-Z0-9_]/)
553 {
554 testno += 1
555 setup_result_obj($0)
556 handle_tap_result()
557 }
558 # TAP plan (normal or "SKIP" without explanation).
559 else if ($0 ~ /^1\.\.[0-9]+[ \t]*$/)
560 {
561 # The next two lines will put the number of planned tests in $0.
562 sub("^1\\.\\.", "")
563 sub("[^0-9]*$", "")
564 handle_tap_plan($0, "")
565 continue
566 }
567 # TAP "SKIP" plan, with an explanation.
568 else if ($0 ~ /^1\.\.0+[ \t]*#/)
569 {
570 # The next lines will put the skip explanation in $0, stripping
571 # any leading and trailing whitespace. This is a little more
572 # tricky in truth, since we want to also strip a potential leading
573 # "SKIP" string from the message.
574 sub("^[^#]*#[ \t]*(SKIP[: \t][ \t]*)?", "")
575 sub("[ \t]*$", "");
576 handle_tap_plan(0, $0)
577 }
578 # "Bail out!" magic.
579 # Older versions of prove and TAP::Harness (e.g., 3.17) did not
580 # recognize a "Bail out!" directive when preceded by leading
581 # whitespace, but more modern versions (e.g., 3.23) do. So we
582 # emulate the latter, "more modern" behaviour.
583 else if ($0 ~ /^[ \t]*Bail out!/)
584 {
585 bailed_out = 1
586 # Get the bailout message (if any), with leading and trailing
587 # whitespace stripped. The message remains stored in `$0`.
588 sub("^[ \t]*Bail out![ \t]*", "");
589 sub("[ \t]*$", "");
590 # Format the error message for the
591 bailout_message = "Bail out!"
592 if (length($0))
593 bailout_message = bailout_message " " $0
594 testsuite_error(bailout_message)
595 }
596 # Maybe we have too look for dianogtic comments too.
597 else if (comments != 0)
598 {
599 comment = extract_tap_comment($0);
600 if (length(comment))
601 report("#", comment);
602 }
603 }
604  
605 ## -------- ##
606 ## FINISH ##
607 ## -------- ##
608  
609 # A "Bail out!" directive should cause us to ignore any following TAP
610 # error, as well as a non-zero exit status from the TAP producer.
611 if (!bailed_out)
612 {
613 if (!plan_seen)
614 {
615 testsuite_error("missing test plan")
616 }
617 else if (planned_tests != testno)
618 {
619 bad_amount = testno > planned_tests ? "many" : "few"
620 testsuite_error(sprintf("too %s tests run (expected %d, got %d)",
621 bad_amount, planned_tests, testno))
622 }
623 if (!ignore_exit)
624 {
625 # Fetch exit status from the last line.
626 exit_message = get_test_exit_message(nextline)
627 if (exit_message)
628 testsuite_error(exit_message)
629 }
630 }
631  
632 write_test_results()
633  
634 exit 0
635  
636 } # End of "BEGIN" block.
637 '
638  
639 # TODO: document that we consume the file descriptor 3 :-(
640 } 3>"$log_file"
641  
642 test $? -eq 0 || fatal "I/O or internal error"
643  
644 # Local Variables:
645 # mode: shell-script
646 # sh-indentation: 2
647 # eval: (add-hook 'write-file-hooks 'time-stamp)
648 # time-stamp-start: "scriptversion="
649 # time-stamp-format: "%:y-%02m-%02d.%02H"
650 # time-stamp-time-zone: "UTC"
651 # time-stamp-end: "; # UTC"
652 # End: