testcases.md

@page pTestcases Overview of included tests

This section includes an overview of some of the included test cases, found in the <b>tb/test</b> directory.
The list is not exhaustive, but should provide an indication of where to look for examples on how to use the available configuration knobs.

<table>
  <tr>
    <th> Feature </th>
    <th> Relevant test cases </th>
  </tr>
  <tr>
    <td> Demoting error verbosity </td>
    <td> cl_scb_test_io_std_sbs_print <br> cl_scb_test_ooo_std_dump_orphans </td>
  </tr>
  <tr>
    <td> Full scoreboard dump (all transactions to one file) </td>
    <td> cl_scb_test_io_std_dump </td>
  </tr>
  <tr>
    <td> Split scoreboard dump (each queue in separate files) </td>
    <td> cl_scb_test_io_std_dump_xml_split <br> (in file cl_scb_test_io_std_dump_custom_printer) </td>
  </tr>
  <tr>
    <td> Orphan dumping </td>
    <td> cl_scb_test_ooo_std_dump_orphans <br> cl_scb_test_ooo_std_dump_orphans_xml </td>
  </tr>
  <tr>
    <td> Per-queue printer configuration </td>
    <td> All tests in file cl_scb_test_io_std_dump_custom_printer </td>
  </tr>
  <tr>
    <td> Per-queue comparer configuration </td>
    <td> All tests in cl_scb_test_io_std_comparer_report</td>
  </tr>
  <tr>
    <td> Using the function-based API</td>
    <td> cl_scb_test_io_std_simple </td>
  </tr>
  <tr>
    <td> Using the TLM based connections </td>
    <td> cl_scb_test_ooo_std_tlm</td>
  </tr>
  <tr>
    <td>Printing queue statistics while simulating</td>
    <td>cl_scb_test_io_std_intermediate_dump</td>
  </tr>
  <tr>
    <td>Mutexed add_item calls</td>
    <td>cl_scb_test_io_std_tlm_mutexed</td>
  </tr>
  <tr>
    <td>Using hash (MD5) queues</td>
    <td>cl_scb_test_ooo_md5_simple</td>
  </tr>
  <tr>
    <td>Using multiple queue types in one test</td>
    <td>cl_scb_test_ooo_io_std_simple</td>
  </tr>
  <tr>
    <td>Using the max_search_window configuration knob </td>
    <td>cl_scb_test_ooo_std_max_search_window </td>
  </tr>
  <tr>
    <td>Using filter transforms for transforming seq. items, using custom filters not derived from pk_utils_uvm::filter_trfm</td>
    <td>cl_scb_test_ooo_std_tlm_filter_trfm <br> cl_scbs_test_io_custom_filter_trfm </td>
  </tr>
  <tr>
    <td>Using multiple scoreboards in a test</td>
    <td>cl_scbs_test_io_std_base <br> cl_scbs_test_io_std_cc </td>
  </tr>
  <tr>
    <td>Dumping orphans/scoreboard to XML </td>
    <td>cl_scb_test_ooo_std_dump_orphans_xml <br> cl_scb_test_io_std_dump_xml_split </td>
  </tr>
</table>

XML files generated with the XML printer can be converted into HTML files for easy viewing with the \c generate_html make target.