Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tests to improve code coverage of viz module 馃И #74

Closed
sduquemesa opened this issue Jun 1, 2022 · 1 comment
Closed

Add tests to improve code coverage of viz module 馃И #74

sduquemesa opened this issue Jun 1, 2022 · 1 comment
Labels
good first issue Good for newcomers workflow & tests CI tests have been modified and/or new workflows were added

Comments

@sduquemesa
Copy link
Contributor

sduquemesa commented Jun 1, 2022

This issue has been tagged for a bounty during unitaryHACK.

Tasks

  • Create a new set of unit tests (potentially in test_viz.py) that covers all possible configuration options of the functions on the viz module. To see the current coverage of the module check codecov.

Explanation

The viz utility module contains helper functions to draw various graphs and generate plots using Matplotlib. This module provides several ways to personalize and configure the resulting figures via the use of function parameters.

The complete set of possible configurations has not been added to the FlamingPy test suite.

Requirements

  • Instead of using image comparison to evaluate the output of the functions of the module I would instead recommend using mocking to mock matplotlib's methods and check that appropriate calls with appropriate arguments are passed to those (mocked) methods.
  • The implementation of this test should cover >99% of the viz module.
@sduquemesa sduquemesa changed the title Add test to improve code coverage of viz module Add tests to improve code coverage of viz module 馃И Jun 1, 2022
@soosub soosub mentioned this issue Jun 1, 2022
9 tasks
@nariman87 nariman87 added the good first issue Good for newcomers label Jun 1, 2022
@nariman87 nariman87 added the workflow & tests CI tests have been modified and/or new workflows were added label Jun 2, 2022
@bestquark bestquark added the unitaryhack-bounty An issue that is tagged for unitaryHACK with possible bounties label Jun 2, 2022
@nariman87 nariman87 removed the unitaryhack-bounty An issue that is tagged for unitaryHACK with possible bounties label Jun 27, 2022
@nariman87
Copy link
Contributor

We can archive this till we work on different backends or next HACK competitions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers workflow & tests CI tests have been modified and/or new workflows were added
Projects
None yet
Development

No branches or pull requests

3 participants