increase test coverage of metadata DebugUtils

[tcoratger]

Checklist

• Linked to Github Issue
• Unit tests added
• Integration tests added.
• This change requires new documentation.
  • Documentation has been added/updated.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.42%. Comparing base (44d4208) to head (a09adcf).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #616      +/-   ##
==========================================
+ Coverage   88.76%   90.42%   +1.66%     
==========================================
  Files         121      121              
  Lines       35627    36263     +636     
==========================================
+ Hits        31624    32791    +1167     
+ Misses       4003     3472     -531     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Oppen]

Two things:

1. Most of the comments in the tests are superfluous, I'd rather keep the tests compact unless the comments actually clarify something;
2. The tests seem to test code generation is successful, but not the behavior of that code.

What I would expect from these tests is this:

1. They do test code generation.
2. They test the generated code behaves as expected (that is, a print writes to stdout, maybe check if you can override it with a buffer).
3. The active_map actually fits its purpose: we need to see both that:

• It doesn't have the function marked as active before calling code generation.
• The symbol is not emitted if we don't call that function.
• It marks the function as active afterwards.
• Successive calls don't emit the symbols twice.

[azteca1998]

This module is for debugging, and it's not intended to even be compiled in normal builds so there's no need to test it more than we already do every time we need to use it. That said, any extra testing is appreciated.

[edg-l]

The debug utils module is only used when debugging bugs internally in cairo native, as @azteca1998 pointed out I also don't think the tests are necesary for now