+
Skip to content

General: Update CI to test template pipelines with nf-test #3559

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

Merged
merged 20 commits into from
May 8, 2025

Conversation

mirpedrol
Copy link
Member

@mirpedrol mirpedrol commented May 5, 2025

When testing a new template pipeline, test it by running it and with nf-test.
When creating a pipeline skipping features, test it only with nf-test
Close #3497
Global issue #2994

Note

The fresh created pipeline will fail nf-test CI since we don't have a snapshot file.
Should we consider running nf-test to generate the snapshot after creating the pipeline?
Can't be added through template because it will be different depending on the steps skipped.
Snapshots are tracked now!

@mirpedrol mirpedrol mentioned this pull request May 5, 2025
12 tasks
@mashehu
Copy link
Contributor

mashehu commented May 6, 2025

hmm, might be overkill to also make sure the outputs are stable... just testing that nf-test is running should be good enough.

@mirpedrol
Copy link
Member Author

hmm, might be overkill to also make sure the outputs are stable... just testing that nf-test is running should be good enough.

I think it's good to check the outputs, it will help us avoid errors like we had some versions ago where we didn't have an output directory at all, but didn't notice because the pipeline was running and Nextflow didn't throw an error.
But with this PR we are not checking the outputs because we don't have a snapshot, we are only generating a new snapshot.

@mashehu
Copy link
Contributor

mashehu commented May 6, 2025

true. okay, then let's create one snapshot per feature and track it in git?

@mirpedrol
Copy link
Member Author

That would be great! What do you mean by "track it in git"? how would you do it?

@mashehu
Copy link
Contributor

mashehu commented May 6, 2025

generate them once locally and have them in the repo.

@mirpedrol mirpedrol force-pushed the ci-nf-test branch 7 times, most recently from 636879c to a9ad0de Compare May 6, 2025 12:04
@mirpedrol
Copy link
Member Author

mirpedrol commented May 6, 2025

TODO:

  • Generate snapshots for feature templates to test
  • Generate snapshot when creating a pipeline (separate PR)

@mirpedrol mirpedrol force-pushed the ci-nf-test branch 2 times, most recently from a04be96 to f444218 Compare May 7, 2025 10:21
Copy link

codecov bot commented May 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.48%. Comparing base (8bc4305) to head (cb296bb).
Report is 37 commits behind head on dev.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mirpedrol mirpedrol force-pushed the ci-nf-test branch 7 times, most recently from 886536c to 206258a Compare May 7, 2025 12:26
@mirpedrol mirpedrol force-pushed the ci-nf-test branch 6 times, most recently from d3353f9 to f9b42cd Compare May 7, 2025 13:33
@mirpedrol
Copy link
Member Author

snapshots added! Could you have another look @mashehu ?

Copy link
Contributor

Choose a reason for hiding this comment

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

is __snapshots__ a standard directory name for snapshots?

Copy link
Member Author

Choose a reason for hiding this comment

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

no, I did some research to see how people call these directories but didn't fine any standard. Would you rename it?

Copy link
Contributor

Choose a reason for hiding this comment

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

I would call it snapshots or maybe .snapshots. the double underscore feels too pythony.

mirpedrol and others added 2 commits May 8, 2025 12:40
Co-authored-by: Matthias Hörtenhuber <mashehu@users.noreply.github.com>
@mirpedrol mirpedrol merged commit bf71309 into nf-core:dev May 8, 2025
97 checks passed
@mirpedrol mirpedrol deleted the ci-nf-test branch May 8, 2025 11:36
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
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载