nf-core / nf-core/tools

Add a test to linting to check generating a DAG and execution report works

Open
#1,852 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of feature

Sometimes custom containers are used for modules. While the main tool may be installed correctly, Nextflow needs tools like ps installed in the container for execution tracing and so on. It would be good to have a linting test that activates tracing to make sure the auxilliary tools are also present in the software environment. It may be as simple as adding the -with-dag, etc command line options to the module test command.

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

No file or existing test is named; start by locating the linting test implementation and the module test command it invokes. Run the current linting tests, then verify that enabling DAG and execution-report tracing checks custom-container auxiliary tools and that the test passes when those tools are available.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devtools, testing-qa
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.