1DEJAGNU-REPORT-CARD(1) User's Reference Manual DEJAGNU-REPORT-CARD(1)
2
4 dejagnu report card — summarize results from testing multiple tools
5
7 dejagnu report card [⟨option⟩ | ⟨tool⟩ | ⟨file⟩] ...
8
10 The dejagnu report card command displays results from testing multiple
11 tools in a tabular format. The produced table lists, for each tool (and
12 if multiple passes were run, each pass) the number of tests passed,
13 failed, unsupported, unresolved, and untested. Tests that are expected
14 to fail are counted in separate columns from tests expected to pass, but
15 "known" failures and "expected" failures are summarized together. If a
16 test generated warnings or errors, a tag ‘!W!’ or ‘!E!’ is appended at
17 the end of the relevant line.
18 Aside from options, the argument list may include tool or file names.
20 The dejagnu report card command prefers to read DejaGnu summary files and
21 will translate names accordingly:
22 *.sum Used as-is.
24 *.log Rewritten to *.sum with the same stem.
26 *. The string sum is appended to select a summary file. This pro‐
28 cessing is done for convenience when using Readline file name com‐
29 pletion in a shell, which will complete to the dot.
30 * Taken as a tool name; .sum is appended.
32
34 -v, --verbose Emit additional output describing the operation of
35 dejagnu report card itself.
36
38 The dejagnu report card command produces its output by reading the sum‐
39 mary files produced by DejaGnu and counting "PASS", "FAIL", etc.
40 If no names are given as arguments, all files matching *.sum in the cur‐
42 rent directory are read.
43
45 A simple example from DejaGnu's own testsuite
46 $ dejagnu report card
47 __________________________________________________
48 / PASS FAIL ?PASS ?FAIL UNSUP UNRES UNTEST
49 |--------------------------------------------------
50 launcher | 52 0 0 0 0 0 0
51 libdejagnu | 5 0 0 0 0 0 0
52 runtest | 135 0 0 0 0 0 0
53 |--------------------------------------------------
54 | 192 0 0 0 0 0 0
55 \__________________________________________________
56 Three tools were tested, with a total of 192 tests, all expected to pass.
58 In this example, all tests did pass, so all other columns are zero. The
59 ‘?PASS’ and ‘?FAIL’ columns count tests known or expected to fail that
60 either unexpectedly passed or failed as expected. The remaining three
61 columns count the exceptional results for unsupported tests, unresolved
62 tests and stub tests that simply declare themselves untested.
63 The same example after tests were added for dejagnu-report-card
69 $ dejagnu report-card
70 __________________________________________________
71 / PASS FAIL ?PASS ?FAIL UNSUP UNRES UNTEST
72 |--------------------------------------------------
73 launcher | 52 0 0 0 0 0 0
74 libdejagnu | 5 0 0 0 0 0 0
75 report-card / awk | 36 0 0 0 0 0 0
76 report-card / sh | 36 0 0 0 0 0 0
77 report-card / tcl | 36 0 0 0 0 0 0
78 runtest | 135 0 0 0 0 0 0
79 |--------------------------------------------------
80 awk | 36 0 0 0 0 0 0
81 sh | 36 0 0 0 0 0 0
82 tcl | 36 0 0 0 0 0 0
83 |--------------------------------------------------
84 | 300 0 0 0 0 0 0
85 \__________________________________________________
86 The ‘report-card’ tool has been added, with three passes, one for each
88 implementation. (The shell and Tcl implementations were later dropped to
89 reduce future maintenance burden.) As before, all tests passed as ex‐
90 pected. The interesting difference from the previous example is the use
91 of DejaGnu's multipass testing feature and the additional per-pass sum‐
92 mary lines added. For this example, only the ‘report-card’ tool uses
93 multipass testing, so each pass total is simply the count of tests for
94 ‘report-card’ instead of a distinct total.
95 Also note that the command used to invoke dejagnu report card is slightly
97 different here. The dejagnu(1) launcher will also accept multiple words
98 joined with dashes into a single argument. This allows individual words
99 in a command name to be separated with either dashes or spaces on the
100 command line interchangeably.
101
103 dejagnu(1) runtest(1)
104 The full documentation for DejaGnu is maintained as a Texinfo manual. If
106 the info program is properly installed at your site, the command info
107 dejagnu should give you access to the complete manual.
108
110 Jacob Bachmeyer
111GNU December 31, 2018 GNU