Removing SmartList & adding coverage - Githubissues

terrapower / armi

An open-source nuclear reactor analysis automation framework that helps design teams increase efficiency and quality

https://terrapower.github.io/armi/

Apache License 2.0

233 stars 90 forks source link

Removing SmartList & adding coverage #1992

Closed john-science closed 3 weeks ago

john-science commented 3 weeks ago

What is the change?

Added a bunch of code coverage to textProcessors.py.
- Moved unit tests for textProcessors.py from test_interfaces.py.
- Removed testProcessors.py::SmartList from the API.
I added --fail-under=90.

Why is the change being made?

Last night, I was trying to add code coverage to textProcessors.py, on general principles.

And I noticed two strange things:

Half the test for textProcessors.py were in test_interface.py for now reason. So I moved those into textProcessors.py.
The class SmartList in textProcessors.py was totally broken. I found multiple bugs in that class and it's usage while trying to write tests for it that prove it has not worked in at least four years. So, it is unused and I removed it.

Notes

I tested the --fail-under flag in another branch and it worked.
@opotowsky I was able to show that this change does not affect downstream tests (jenkins 249)

Checklist

[x] This PR has only one purpose or idea.
[x] Tests have been added/updated to verify any new/changed code.

[x] The code style follows good practices.
[x] The commit message(s) follow good practices.

[x] The release notes have been updated if necessary.
[x] The documentation is still up-to-date in the doc folder.
[x] The dependencies are still up-to-date in pyproject.toml.