DEJAGNU-REPORT-CARD(1)

✨ dejagnu report card ✨

okay bestie, welcome to the manual page for DEJAGNU-REPORT-CARD(1) — yes it's a section 1 command, yes it lives in LOCAL, and yes it's about to make your test results look gorgeous. sit down, hydrate, let's go 💖

🌸 NAME 🌸

dejagnu report card — summarize results from testing multiple tools

🦋 SYNOPSIS 🦋

dejagnu report card [⟨option⟩ | ⟨tool⟩ | ⟨file⟩] ...

💅 DESCRIPTION 💅

so the dejagnu report card command shows you the results from testing multiple tools in a cute lil' tabular format. the table it produces lists, for each tool (and if multiple passes were run, for each pass too 👀), the number of tests passed, failed, unsupported, unresolved, and untested.

here's the tea tho: tests that are expected to fail get counted in separate columns from tests expected to pass — but "known" failures and "expected" failures are summarized together. and if a test generated warnings or errors, a tag !W! or !E! gets appended at the end of the relevant line. little flag, big info 🚩

🎀 args, bestie, args

aside from options, your argument list can include tool names or file names. and dejagnu report card prefers to read DejaGnu summary files, so it'll translate names accordingly:

• *.sum — used as-is. no notes, it's already perfect 💅
• *.log — rewritten to *.sum with the same stem.
• *. — the string sum is appended, to select a summary file. this processing is done for convenience when using Readline file name completion in a shell, which will complete to the dot. (iykyk 😌)
• * — taken as a tool name; .sum is appended.

✨ OPTIONS ✨

• -v, --verbose — emit additional output describing the operation of dejagnu report card itself. it's giving "narrating my own life" energy and honestly? we love that for it 🫶

🍓 FILES 🍓

the dejagnu report card command produces its output by reading the summary files produced by DejaGnu and counting "PASS", "FAIL", etc. literally just vibes and tally marks 📊

if no names are given as arguments, all files matching *.sum in the current directory are read. so it just. reads the room. iconic.

🌈 EXAMPLES 🌈

💖 A simple example from DejaGnu's own testsuite

$ dejagnu report card
             __________________________________________________
            /    PASS   FAIL  ?PASS  ?FAIL  UNSUP  UNRES UNTEST
            |--------------------------------------------------
  launcher  |      52      0      0      0      0      0      0
libdejagnu  |       5      0      0      0      0      0      0
   runtest  |     135      0      0      0      0      0      0
            |--------------------------------------------------
            |     192      0      0      0      0      0      0
            \__________________________________________________

three tools were tested, with a total of 192 tests, all expected to pass. in this example, all tests did pass, so all the other columns are zero — clean sweep, no crumbs 🧹✨

the ?PASS and ?FAIL columns count tests known or expected to fail that either unexpectedly passed or failed as expected. and the remaining three columns count the exceptional results for unsupported tests, unresolved tests, and stub tests that simply declare themselves untested.

🦄 The same example after tests were added for dejagnu-report-card

$ dejagnu report-card
                    __________________________________________________
                   /    PASS   FAIL  ?PASS  ?FAIL  UNSUP  UNRES UNTEST
                   |--------------------------------------------------
   launcher        |      52      0      0      0      0      0      0
 libdejagnu        |       5      0      0      0      0      0      0
report-card / awk  |      36      0      0      0      0      0      0
report-card / sh   |      36      0      0      0      0      0      0
report-card / tcl  |      36      0      0      0      0      0      0
    runtest        |     135      0      0      0      0      0      0
                   |--------------------------------------------------
              awk  |      36      0      0      0      0      0      0
              sh   |      36      0      0      0      0      0      0
              tcl  |      36      0      0      0      0      0      0
                   |--------------------------------------------------
                   |     300      0      0      0      0      0      0
                   \__________________________________________________

the report-card tool has been added, with three passes, one for each implementation. (the shell and Tcl implementations were later dropped to reduce future maintenance burden — rip to them, gone but not forgotten 🙈). as before, all tests passed as expected.

the interesting difference from the previous example is the use of DejaGnu's multipass testing feature and the additional per-pass summary lines added. for this example, only the report-card tool uses multipass testing, so each pass total is simply the count of tests for report-card instead of a distinct total.

also note that the command used to invoke dejagnu report card is slightly different here. the dejagnu(1) launcher will also accept multiple words joined with dashes into a single argument. this allows individual words in a command name to be separated with either dashes or spaces on the command line interchangeably. slay 💅

👑 SEE ALSO 👑

dejagnu(1) runtest(1)

the full documentation for DejaGnu is maintained as a Texinfo manual. if the info program is properly installed at your site, the command info dejagnu should give you access to the complete manual. go read it, bestie, it's free knowledge 📚

💜 AUTHORS 💜

Jacob Bachmeyer

and that's the whole page, no cap. this lil' baddie is part of GNU, and this particular version is dated December 31, 2018 — filed under DEJAGNU-REPORT-CARD(1) if you ever need to find it again. mwah, take care of your tests 🎀💖