integrate smarteole example into ci #45
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Uses GitHub LFS
samuelwnaylor
force-pushed
the
lfs
branch
10 times, most recently
from
6ba621d to
1fa3ccf
Compare
samuelwnaylor
force-pushed
the
lfs
branch
2 times, most recently
from
fc2f1bb to
d7a2f96
Compare
aclerc
approved these changes
Jan 21, 2025
| @@ -44,6 +44,8 @@ Use `poe all` to run all required pre-push commands (make sure the virtual envir | |||
| ## Running tests | |||
| Install dev dependencies and use `poe test` to run unit tests (make sure the virtual environment is activated) | |||
|
|
|||
| For convenience when developing locally, run `poe test-fast` to avoid running the tests marked as slow. | |||
There was a problem hiding this comment.
nice, thanks for adding this!
| ) | ||
| smarteole_data = SmarteoleData(scada_df=scada_df, metadata_df=metadata_df, toggle_df=toggle_df) | ||
|
|
||
| main_smarteole_analysis( |
There was a problem hiding this comment.
This calls assert_frame_equal internally. Seems fine to me. Maybe worth bubbling up a boolean output so an explicit assert is shown in the test, but I'm not sure if that's an improvement.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
About the change
The
examples/smarteole_example.pyis an essential test to ensurewind-upgets the intended 'correct' answers. Before this PR, there was already acheck_results=Trueargument that could be passed to theprint_smarteole_resultsfunction in order to assert the results are as expected. This PR, integrates this essential test into thepytesttest suite ofwind-up. This also means that the smarteole example will be run in github actions, which removes the need to manually runexamples/smarteole_example.pythat has been done historically when checking PRs.Related issue
Closes #21
Notes
poetask,test-fast, that avoids tests marked as slow (currently only smarteole).