nf-core / nf-core/tools

Lint for `assertAll` in `main.nf.test` files

Open
#2,900 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

linting
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Is your feature request related to a problem? Please describe.
Feature has been suggested in https://github.com/nf-core/website/pull/2414#discussion_r1540669481

Basically the nf-test linting should be upgraded to include a check for the assertAll function as a wrapper around all checks per test

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the nf-test linting entry point and the handling of main.nf.test files, then inspect how test checks are identified. Add coverage for requiring assertAll as the wrapper around each test's checks, and verify that linting reports tests that do not follow this pattern.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing-qa, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.