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.

Sign up for GitHub

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

Jump to bottom

Automate dashboard scaffolding Part 1 #176

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Automate dashboard scaffolding Part 1 #176

wants to merge 18 commits into from

Conversation

iantei
Copy link
Contributor

@iantei iantei commented Nov 27, 2024 •
edited
Loading

This is part of series of PRs to automate the public dashboard.

In this PR, the focus is on testing certain functionality in scaffolding.py
The following have been tested for:

1. Approach direct function calls tests, instead of using mock.patch - to simplify
2. Tests mapping_lables for PURPOSE, REPLACED_MODE
3. Tests mapping_color_surveys
4. Tests get_quality_text()
5. Tests get_quality_text_sensed()
6. Tests get_quality_text_numerator()
7. Tests get_file_suffix()
8. Update unit tests for unit_conversion. Update distance column in the before_df and after_df data frame

iantei added 17 commits October 29, 2024 15:08
@iantei
Add pytest and coverage as additional dependencies for the automated …
bd64a99 
…unit test and test coverage
@iantei
Enable running of plots.py from pytest, aside from Notebook
de3d126
@iantei
Add Git Action workflow
0f3099e
@iantei
Add docker-compose file for automated unit testing
5d8548a
@iantei
Initial unit test cases for plots.py
5995589
@iantei
Add extra line at the end
63867f4
@iantei
Simplify import of parent directory with the use of PYTHONPATH=../.. …
bba61b6 
…since emission is two directory above the current test_*.py files directory. Used importlib as the parent directory has - in saved-notebooks.
@iantei
Initial test cases for scaffolding.py
e590384 
- Executes all the unit test files available in the tests directory
- Test get_time_query() with the use of patch for LocalData and TimeComponentQuery
- Basic test case to assert cases for MODE mapping to en-translations
@iantei
Fix run for tests with docker-compose in test_with_docker.yml
b9e30cc
@iantei
Remove mock.patch, and use direct function calls instead. mock.patch …
0b1fe21 
…adds unnecessary layer of complication over direct function calling. Both TimeComponentQuery and LocalDate calls inside get_time_query are straight forward, and would not need mocking.
@iantei
Update unit test cases for PURPOSE, REPLACED_MODE for mapping_labels …
3ddd56b 
…function in scaffolding.py
@iantei
Update unit test for mapping_color_surveys
31f6082
@iantei
Update unit tests for get_quality_text()
d86fbe2
@iantei
Update unit tests for get_quality_text_sensed()
1258944
@iantei
Update unit tests for get_quality_text_numerator()
6cca577
@iantei
Update unit tests for get_file_suffix()
8952810
@iantei
Update unit tests for unit_conversions. Update distance column in the…
aaf7a9e 
… before_df and after_df dataframe.
@iantei iantei changed the title Automate dashboard scaffolding - 2 Automate dashboard scaffolding Part 2 Dec 5, 2024
@iantei iantei changed the title Automate dashboard scaffolding Part 2 Automate dashboard scaffolding Part 1 Dec 5, 2024
@iantei
Copy link
Contributor Author

iantei commented Feb 4, 2025 

tests/test_plots.py::TestCalculatePct::test_calculate_pct_basic PASSED                                                                          [  5%]
tests/test_plots.py::TestCalculatePct::test_calculate_pct_empty PASSED                                                                          [ 10%]
tests/test_plots.py::TestCalculatePct::test_calculate_pct_single PASSED                                                                         [ 15%]
tests/test_plots.py::TestMergeSmallEntries::test_merge_small_entries_basic PASSED                                                               [ 21%]
tests/test_plots.py::TestMergeSmallEntries::test_merge_small_entries_no_small PASSED                                                            [ 26%]
tests/test_plots.py::TestMergeSmallEntries::test_merge_small_entries_some_small PASSED                                                          [ 31%]
tests/test_scaffolding.py::test_get_time_query PASSED                                                                                           [ 36%]
tests/test_scaffolding.py::test_mapping_labels PASSED                                                                                           [ 42%]
tests/test_scaffolding.py::test_mapping_color_surveys PASSED                                                                                    [ 47%]
tests/test_scaffolding.py::test_mapping_color_surveys_empty PASSED                                                                              [ 52%]
tests/test_scaffolding.py::test_get_quality_text PASSED                                                                                         [ 57%]
tests/test_scaffolding.py::test_get_quality_text_include_test_users PASSED                                                                      [ 63%]
tests/test_scaffolding.py::test_get_quality_text_include_mode_of_interest PASSED                                                                [ 68%]
tests/test_scaffolding.py::test_get_quality_text_sensed PASSED                                                                                  [ 73%]
tests/test_scaffolding.py::test_get_quality_text_sensed_include_test_users PASSED                                                               [ 78%]
tests/test_scaffolding.py::test_get_quality_text_numerator PASSED                                                                               [ 84%]
tests/test_scaffolding.py::test_get_quality_text_numerator_include_test_users PASSED                                                            [ 89%]
tests/test_scaffolding.py::test_get_file_suffix PASSED                                                                                          [ 94%]
tests/test_scaffolding.py::test_unit_conversions PASSED                                                                                         [100%]

@iantei iantei marked this pull request as ready for review February 4, 2025 19:37
@iantei
Copy link
Contributor Author

iantei commented Feb 4, 2025

Current coverage report:

plots.py                                                            303    248    18%
scaffolding.py                                                      345    248    28%

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
OpenPATH Tasks Overview
Status: PRs for review by peers
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@iantei