Improve utility function coverage with type hints and comprehensive tests

[Copilot]

Summary: Improve Coverage of Utility Functions ✅

Type Hints and Docstrings ✅

• Analyze existing utility functions in utils.py and metadata.py
• Add missing return type hint to _merge_defaults
• Add missing type hints to setup_logdir_link (parameters and return type)
• Add comprehensive docstring to _merge_defaults
• Add type hints to get_vtx_simconfig in metadata.py

Test Coverage Improvements ✅

utils.py coverage: 52% → 90% (+38%)

• Add tests for _merge_defaults function (dict merging logic)
• Add tests for setup_logdir_link function (symlink creation)
• Add tests for hash_dict function (JSON serialization)
• Add improved tests for get_hit_tier_name with proper fixtures
• Add tests for lookup_dataflow_config with fixtures for both config formats
• Add tests for init_generated_pars_db function with par directories for both config formats
• Add tests for extract_integer in metadata module

Improved Tests with Fixtures ✅

• Created tier_test_data fixture with setups.l200 structure matching production config
• Created tier_test_data_direct fixture with direct paths structure for legacy support
• Used dbetto.utils.write_dict for cleaner config file creation
• Added par directories (par, par_hit, par_pht) to both fixtures
• Test get_hit_tier_name for both config formats
• Test lookup_dataflow_config for both config formats with proper variable substitution
• Test init_generated_pars_db for both config formats (full par database and tier-specific databases)

Code Quality Validation ✅

• All 16 tests pass successfully in test_utils.py (added 3 new tests for direct format)
• Pre-commit linting checks pass (ruff, trailing whitespace)
• No breaking changes introduced
• Both config formats tested: setups.l200.paths and direct paths

Key Improvements

Module	Before	After	Change
utils.py	52%	90%	+38%
metadata.py	71%	72%	+1%

Original prompt

I would like to improve the coverage of simple utilty functions in this repository. In doing this I would also like to check if all functions have the proper type hints and docstrings.
Please give me suggestions on tests to add, and make a PR with your proposals

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[tdixon97]

I was seeing how it works Sent from Outlook for Android<https://aka.ms/AAb9ysg>

…

________________________________ From: Luigi Pertoldi ***@***.***> Sent: Monday, February 2, 2026 8:49:50 PM To: legend-exp/legend-simflow ***@***.***> Cc: Toby Dixon ***@***.***>; Assign ***@***.***> Subject: Re: [legend-exp/legend-simflow] Improve utility function coverage with type hints and comprehensive tests (PR #81) ⚠ Caution: External sender @gipert commented on this pull request.

________________________________ On TEST_COVERAGE_IMPROVEMENTS.md<#81 (comment)>: wtf is this — Reply to this email directly, view it on GitHub<#81 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ANSET424OZ24ATWUJOXYHAD4J6Z65AVCNFSM6AAAAACTXDERAGVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZTONBRGY2DSMJTGM>. You are receiving this because you were assigned.Message ID: ***@***.***>

[gipert]

looks good except for this useless markdown file

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.33%. Comparing base (4779a44) to head (0096e4c).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #81      +/-   ##
==========================================
+ Coverage   61.98%   63.33%   +1.35%     
==========================================
  Files          19       19              
  Lines        1331     1331              
==========================================
+ Hits          825      843      +18     
+ Misses        506      488      -18     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[tdixon97]

@copilot you should see that the config can be instead

setups:
      l200:
           paths:
               ...

In addition you should see that some other keys like

paths:
    par_hit: $_/generated/par/hit
    par_pht: $_/generated/par/pht

can be present, add them and use it to test init_generated_pars_db

[Copilot]

@copilot you should see that the config can be instead

...

Updated in e55c430. The fixture now uses the setups.l200.paths structure and includes par, par_hit, and par_pht paths with corresponding directories. Added comprehensive test for init_generated_pars_db that validates:

• Full par database (tier=None)
• Hit tier par database (tier="hit")
• Pht tier par database (tier="pht")

[tdixon97]

@copilot you should see that the config can be instead

...

Updated in e55c430. The fixture now uses the setups.l200.paths structure and includes par, par_hit, and par_pht paths with corresponding directories. Added comprehensive test for init_generated_pars_db that validates:

* Full par database (tier=None)

* Hit tier par database (tier="hit")

* Pht tier par database (tier="pht")

@copilot please test both formats

[Copilot]

@copilot you should see that the config can be instead

...
...

Added in 38d95d5. Created tier_test_data_direct fixture for the direct paths format and added 3 new tests:

• test_lookup_dataflow_config_direct_format
• test_get_hit_tier_name_direct_format
• test_init_generated_pars_db_direct_format

Both config formats are now fully tested (16 tests total).

Now addressed

[Copilot]

Pull request overview

This pull request enhances utility function coverage by adding type hints, comprehensive docstrings, and extensive tests for several utility functions in the legendsimflow package. The changes improve code maintainability and increase test coverage from 52% to 90% for utils.py and from 71% to 72% for metadata.py.

Changes:

• Added type hints and comprehensive docstrings to _merge_defaults, setup_logdir_link, and get_vtx_simconfig functions
• Added 13 new tests covering dictionary merging, symlink creation, hash generation, tier name detection, parameter database initialization, and integer extraction
• Created two test fixtures (tier_test_data and tier_test_data_direct) to support testing both config formats (with and without setups.l200 wrapper)

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File	Description
workflow/src/legendsimflow/utils.py	Added type hints and docstring to _merge_defaults; added type hints and expanded docstring for setup_logdir_link
workflow/src/legendsimflow/metadata.py	Added type hints to get_vtx_simconfig function
tests/test_utils.py	Added 13 new test functions and 2 fixtures covering utility functions for both config formats
tests/test_metadata.py	Added test for extract_integer function with multiple test cases

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.