CSHS-CWRA / RavenPy / 16302867127

81%

main: %

Build Type

push

github

Committed by web-flow

Commit Message

Use pooch (#513)

<!-- Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
  - This PR fixes #230 
- [x] (If applicable) Documentation has been added / updated (for bug
fixes / features).
- [x] (If applicable) Tests have been added.
- [x] CHANGELOG.rst has been updated (with summary of main changes).
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added.

### What kind of change does this PR introduce?

* Removes the older, cobbled-together testing data management system for
one based on `pooch`
* Updates several environment variables to use a more consistent naming
system, used by similar projects
* The `pooch` helper function (called "yangtze"; not married to the
name) can now be used to `fetch()` local or remote datasets.
* The `main.yml` workflow now uses caching for testing data to reduce
the synonymous download requests from the various builds.
* A new workflow (`testdata-version.yml`) has been adapted to ensure
that the `raven-testdata` tag is kept up-to-date.

### Does this PR introduce a breaking change?

Absolutely. The testing data management system is completely changed,
and environment variables have been modified. The new system uses a
`pooch` registry that will validate that files have the proper checksum
on `pytest` call, which is much faster than checking remote servers. The
downside is that changes need to be ported to RavenPy when testing data
is changed (the `testdata-version.yml` workflow will help with this).

`SKIP_TEST_DATA` is now unused and obsolete.

### Other information:

The changes here will break the current `raven-testdata` structure (for
the better). The migration will need to happen progressively as multiple
projects (and PAVICS) are reliant on the current `raven-testdata`
structure, so cha... (continued)

Run Details

128 of 258 new or added lines in 5 files covered. (49.61%)

3 existing lines in 2 files now uncovered.

3696 of 4577 relevant lines covered (80.75%)

7.26 hits per line