CI Test Clean Up: Mock USGS, Acoustic Tolerances #404
Merged
Conversation
This file contains hidden or 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
ssolson
changed the title
Contributor
Author
|
@akeeste this is ready for review |
akeeste
approved these changes
Jun 24, 2025
Comment on lines
+136
to
142
| df = river.io.usgs.request_usgs_data( | ||
| station="15515500", | ||
| parameter="00060", | ||
| start_date="2009-08-01", | ||
| end_date="2009-08-10", | ||
| options={"data_type": "Instantaneous"}, | ||
| options={"data_type": "Instantaneous", "clear_cache": True}, | ||
| ) |
Contributor
There was a problem hiding this comment.
With this mocking set-up, will this function call to river.io.usgs.request_usgs_data() still attempt to hit the USGS API once even though we don't test its output, or is that also skipped?
Contributor
Author
There was a problem hiding this comment.
Hey Adam The short answer is no, the usgs API is not hit.
The key line is:
@patch("mhkit.river.io.usgs.requests.get")
The process is:
- The @patch decorator replaces the requests.get function with a mock object before the test runs
- The mock is configured to return a fake response with status code 200 and the mock payload
- When request_usgs_data() is called, it will internally call requests.get()
- The mock intercepts this call and returns the fake response instead of making a real HTTP request
- The real USGS API is never contacted
Contributor
There was a problem hiding this comment.
Got it, that makes sense. I see the call to requests.get() within usgs.io.request_usgs_data() now. Thanks!
akeeste
pushed a commit
to akeeste/MHKiT-Python
that referenced
this pull request
Sep 30, 2025
## Summary
1. Replaced live USGS API calls with mock calls in tests to prevent
failures in GitHub Actions due to repeated API connectivity issues. This
ensures the functions are still invoked without being dependent on
external API availability.
2. Adjusted acoustic module test tolerances to account for minor
floating-point discrepancies. These discrepancies likely stem from:
- Over-precise stored constants created in older environments.
- Cumulative rounding errors from sequential operations (e.g.,
band_aggregate followed by time_aggregate).
- Changes in behavior in newer versions of NumPy, Pandas, or xarray.
#### Justification for Tolerance Adjustment
- A tolerance of 1e-5 is acceptable since decibel outputs are typically
displayed with only two decimal places.
- Numerical differences at this scale (1e-6 to 1e-5) are common due to
aggregation method variations
Merged
akeeste
added a commit
to akeeste/MHKiT-Python
that referenced
this pull request
Sep 30, 2025
akeeste
added a commit
that referenced
this pull request
Sep 30, 2025
To resolve some intermittent tests failing when using conda and 3.11, this PR bumps some acoustics tolerances to 1e-5 as reasoned in #404
akeeste
added a commit
that referenced
this pull request
Sep 30, 2025
v1.0.0 # MHKiT v1.0.0 ## New Features * Sound Exposure Level by @jmcvey3 in #388 * Add discharge function to MHKiT by @jmcvey3 in #385 ## Functionality enhancements * Fix for corrupted Nortek files by @jmcvey3 in #372 * Update integral length scale function by @jmcvey3 in #376 * Fix ever-changing RDI RiverPro depth bin ranges by @jmcvey3 in #378 * Allow clean functions to handle _avg variables by @jmcvey3 in #377 * IEC TS 62600 updates by @akeeste in #382 * MLER explanation updates/corrections by @rgcoe in #393 * Improve Nortek2 index file creator functions by @jmcvey3 in #397 * Read Sentinel V specific data packets by @jmcvey3 in #396 * Short list of VMDAS updates by @jmcvey3 in #405 * Allow user to specify universal Kolmogorov constant for TKE dissipation rate function by @jmcvey3 in #406 * Nortek Dual Profile Dataset Rotation by @jmcvey3 in #414 ## Source code improvements * Lint Tidal by @ssolson in #386 * Lint river module by @ssolson in #389 * Lint hindcast by @ssolson in #398 * Modernize Package Configuration by @ssolson in #400 * Configure specific warnings by @ssolson in #401 ## Bug fixes * Avoid failing to scan very large files by @jmcvey3 in #371 * Acoustics SPL bugfix by @jmcvey3 in #379 * DOLfYN/RDI: Set `fs` to NaN when typical calculation methods yield error (#408) by @simmsa in #409 ## Testing and Continuous Integration Updates * Fix Jupyter Notebook tests running Python 3.13 by @ssolson in #380 * CI Test Clean Up: Mock USGS, Acoustic Tolerances by @ssolson in #404 * Speed up tests with concurrency checks to prevent duplicate workflows on PRs from develop into main or from main into develop by @akeeste * Define MPLBACKEND to decrease intermittent matplotlib errors in tests by @akeeste ## Documentation and Examples * Add WEC-Sim power performance example by @akeeste in #395 * Update dolfyn function docstrings and associated notebooks by @jmcvey3 in #412 * Update examples by @akeeste in #417 * Update installation instructions in README.md by @akeeste * Adjust acoustics test tolerances by @akeeste in #420 **Full Changelog**: v0.9.0...v1.0.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Justification for Tolerance Adjustment