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

[FIX] Package pipeline-catalog as data files in CLI installation #379

Merged
merged 9 commits into from
Nov 7, 2024

Conversation

alyssadai
Copy link
Contributor

@alyssadai alyssadai commented Nov 6, 2024

Changes proposed in this pull request:

  • pipeline-catalog submodule moved into bagel module so that it ends up inside the package directory after installation
    • pipeline-catalog wouldn't be automatically included in the installation since it's not a module (no __init__.py), so we additionally must update the package config file to include this subdirectory as additional package data
  • for separation of concerns, test suite moved out of bagel module, and test data submodules (neurobagel_examples, bids-examples) moved under tests/
  • for CI tests, CLI is no longer installed in editable mode to more closely replicate production env

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR has a label for the release changelog or skip-release (to be applied by maintainers only)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

@alyssadai alyssadai added the pr-patch Incremental feature improvement, will increment patch version when merged (0.0.+1) label Nov 6, 2024
Copy link

codecov bot commented Nov 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.37%. Comparing base (e4897ba) to head (a436386).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #379      +/-   ##
==========================================
- Coverage   98.37%   98.37%   -0.01%     
==========================================
  Files          16       16              
  Lines         983      982       -1     
==========================================
- Hits          967      966       -1     
  Misses         16       16              

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

@alyssadai alyssadai added the release Create a release when this PR is merged label Nov 6, 2024
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 11709023670

Details

  • 5 of 5 (100.0%) changed or added relevant lines in 2 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.001%) to 98.371%

Totals Coverage Status
Change from base Build 11691648696: -0.001%
Covered Lines: 966
Relevant Lines: 982

💛 - Coveralls

@alyssadai alyssadai marked this pull request as ready for review November 6, 2024 19:15
@surchs surchs requested review from rmanaem and surchs and removed request for rmanaem November 7, 2024 00:35
Copy link
Contributor

@surchs surchs left a comment

Choose a reason for hiding this comment

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

Thanks @alyssadai for fixing this.

I understand that my guess of dev-mode install didn't fix it, so having a test here that would have caught the original bug is tricky. So let's do this: let's merge the fix without the test, but please create an issue to find a way to run the tests on the installed package. My guess is that the CLIRunner we use to "call" the CLI as if we used it from the command line is the limitation here, but I'm sure there is a way to force it to run on the installed CLI (even something silly like making an actual system call with subprocess or something - but I'm sure something smarter must exist too).

In any case: thanks for the fix 🧑‍🍳

.gitmodules Show resolved Hide resolved
tests/test_cli_bids.py Show resolved Hide resolved
@alyssadai alyssadai merged commit edf59d7 into main Nov 7, 2024
13 checks passed
@alyssadai alyssadai deleted the package-pipeline-catalog branch November 7, 2024 03:01
Copy link
Contributor

neurobagel-bot bot commented Nov 7, 2024

🚀 PR was released in v0.3.3 🚀

@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-patch Incremental feature improvement, will increment patch version when merged (0.0.+1) release Create a release when this PR is merged released This issue/pull request has been released.
Projects
None yet
3 participants