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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display summary of loaded entities #12

Open
sarahmish opened this issue Jul 6, 2023 · 0 comments
Open

Display summary of loaded entities #12

sarahmish opened this issue Jul 6, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@sarahmish
Copy link
Collaborator

Currently the validation function in Zephyr shows an error when loading an entityset does not conform to the expected metadata. For example, if turbines entity is missing COD_ELEMENT the following error will be displayed

ValueError: Turbines index column "COD_ELEMENT" missing from data for turbines entity

Rather than erroring out, the validation function should display an entire summary for each entity:

  • whether it passed or not
  • if it did not pass, which columns are missing / have a problem and what is the message

This will look something like unittesting print

Name                                                                      Pass   Fail  Cover
---------------------------------------------------------------------------------------------
turbines                                                                   x      1     90%
work_orders                                                                x      1     95%
notifications                                                              x      1     92%
stoppages                                                                  ✓            100%
alarms                                                                     ✓            100%
pidata                                                                     ✓            100%
---------------------------------------------------------------------------------------------
TOTAL                                                                      6      3     96%

turbines
ValueError: Turbines index column "COD_ELEMENT" missing from data for turbines entity

work_orders
ValueError: Expected index column "COD_ORDER" of work_orders entity is not unique

notifications
ValueError: Missing time index column "DAT_POSTING" from notifications entity

To use Zephyr, the validation above must all pass with 100%.
@sarahmish sarahmish added the enhancement New feature or request label Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant