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

Update coverage call, don't install in editable mode in testing #188

Merged
merged 6 commits into from
May 1, 2024

Conversation

rly
Copy link
Contributor

@rly rly commented Apr 29, 2024

Motivation

Analogous to hdmf-dev/hdmf#1107

https://setuptools.pypa.io/en/latest/userguide/development_mode.html says

Editable installs are not a perfect replacement for regular installs in a test environment. When in doubt, please test your projects as installed via a regular wheel. There are tools in the Python ecosystem, like tox or nox, that can help you with that (when used with appropriate configuration).

We use editable installs in testing in a couple places, mostly to help coverage find the sources, but we can configure that in pyproject.toml instead.

How to test the behavior?

Run all GitHub actions

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running ruff from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

@codecov-commenter
Copy link

codecov-commenter commented Apr 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.42%. Comparing base (5fd5c58) to head (5e64119).

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #188      +/-   ##
==========================================
- Coverage   86.05%   84.42%   -1.64%     
==========================================
  Files           5        5              
  Lines        1162     1162              
  Branches      287      287              
==========================================
- Hits         1000      981      -19     
- Misses        107      126      +19     
  Partials       55       55              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


- name: Install optional dependencies
if: ${{ matrix.opt_req }}
run: python -m pip install -r requirements-opt.txt
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The testing matrix was set up to test and report coverage with both optional requirements installed and not installed. Testing with the optional requirements takes a lot longer because of the streaming test.

@rly rly marked this pull request as ready for review April 29, 2024 22:13
@rly rly requested a review from mavaylon1 April 29, 2024 22:13
@rly rly enabled auto-merge (squash) April 29, 2024 22:16
@rly rly merged commit 65f7a8b into dev May 1, 2024
23 checks passed
@rly rly deleted the no_editable branch May 1, 2024 23:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants