Increase Python code coverage

There are a few reasons why coverage is low; the reasons vary. This issue exists to list and track the completion of tasks relating to increasing code coverage. I think the next realistic goal is to take coverage above 80%. In general, we need to mark error cases we cannot trigger on our own with pragma: no cover.

Dead Code

Coverage is 0% on dead code… Some code is “public” and must go through a deprecation cycle, but the rest can be removed.

• xunit_reporter.py
  • update_testsuite
  • update_testsuites
  • add_log
  • add_failure
  • The entire File class
• utils.py
  • reject_remaining_kwargs
  • get_python_integer_types
  • main script part

Untested, potential code baggage

This stuff isn’t tested, likely because it’s not a very useful feature and/or undocumented.

• utils.py
  • pack
  • unpack, and the associated code in handle.py

Untested

• memdebug.py and MEM_CHECK=1 is never tested in CI.
• scheduler.py
  • COCOTB_SCHEDULER_DEBUG=1 is never run in CI, so a lot of statements are missed
  • COCOTB_ENABLE_PROFILING=1 is never run in CI, so a lot of statements are missed
• regression.py
  • COVERAGE=1 is never run in CI, so a lot of statements are missed
  • actually failing tests are untested.
• handle.py
  • just a lot of stuff, it has a pretty large interface and most of it isn’t useful, so it isn’t tested
• binary.py
  • All of the logic and arithmetic functionality are untested
  • in general bigEndian=True isn’t well tested
• cocotb.hooks are untested. This affects scheduler.py and decorators.py
• Testbenching components are all low.
  • scoreboard has some untested features
  • bus
    • drive, capture, sample, and <= are unused on the base classe
  • drivers
    • OBP is untested
    • XGMIII is untested
    • AXI4Slave is untested
    • optional signals and some features in AvalonDriver are untested
  • monitors
    • XGMII is untested
  • generators
    • packet.py is untested

Other

• __init__.py
  • initialize_testbench isn’t covered. This could be because the coverage is started in this function, there is likely some way around this.
• config.py is untested. It isn’t meant to be used in the Python environment by the user. This file should probably not be in the cocotb package.

[ktbarrett]

Hooks were removed: #2508 The testbenching components were removed: #2289 _initialize_testbench is now covered as well as it can be: #2400 removed dead code from xunit_reporter.py: #2200 Removed dead code from utils: #2228.

[cmarqu]

The C++ coverage setup is now tracked in #2088.