Skip to content

Add stub blocks to all local modules#368

Open
Tabea01 wants to merge 11 commits intonf-core:devfrom
Tabea01:feat/add-stubs-local-modules
Open

Add stub blocks to all local modules#368
Tabea01 wants to merge 11 commits intonf-core:devfrom
Tabea01:feat/add-stubs-local-modules

Conversation

@Tabea01
Copy link
Copy Markdown

@Tabea01 Tabea01 commented May 5, 2026

Closes #367

What was done

  • Added stub blocks to all 6 local modules: sra_ids_to_runinfo,
    sra_runinfo_to_ftp, sra_fastq_ftp, aspera_cli, sra_to_samplesheet,
    and multiqc_mappings_config
  • Added .filter { it.size() > 0 } before splitCsv in workflows/fetchngs.nf
    to handle empty TSV files (prevents a missing header error in stub mode)

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/fetchngs branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 5, 2026

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit dadca1f

+| ✅ 202 tests passed       |+
#| ❔  13 tests were ignored |#
!| ❗   2 tests had warnings |!
Details

❗ Test warnings:

❔ Tests ignored:

  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: assets/multiqc_config.yml
  • files_exist - File is ignored: conf/igenomes.config
  • files_exist - File is ignored: conf/igenomes_ignored.config
  • files_exist - File is ignored: conf/modules.config
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: assets/sendmail_template.txt
  • files_unchanged - File ignored due to lint config: assets/nf-core-fetchngs_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-fetchngs_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-fetchngs_logo_dark.png
  • multiqc_config - multiqc_config
  • modules_config - modules_config

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.2
  • Run at 2026-05-07 12:33:26

@Tabea01 Tabea01 marked this pull request as ready for review May 5, 2026 12:53
Copy link
Copy Markdown

@famosab famosab left a comment

Choose a reason for hiding this comment

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

Looks good, do you plan to add stub tests somewhere to test? (ideally local modules should have tests and there you could have the stub test as well)

if you already have tests for local modules then add the stub tests now, if not then do it in the pr when you add the tests

Comment thread modules/local/aspera_cli/main.nf Outdated
stub:
if (meta.single_end) {
"""
echo "" | gzip > ${meta.id}.fastq.gz
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I know thats how its described in the docs but actually you do not even need the quotes.

Suggested change
echo "" | gzip > ${meta.id}.fastq.gz
echo | gzip > ${meta.id}.fastq.gz

Comment thread modules/local/aspera_cli/main.nf Outdated
Comment on lines +67 to +68
echo "" | gzip > ${meta.id}_1.fastq.gz
echo "" | gzip > ${meta.id}_2.fastq.gz
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
echo "" | gzip > ${meta.id}_1.fastq.gz
echo "" | gzip > ${meta.id}_2.fastq.gz
echo | gzip > ${meta.id}_1.fastq.gz
echo | gzip > ${meta.id}_2.fastq.gz

Comment thread modules/local/sra_fastq_ftp/main.nf Outdated
stub:
if (meta.single_end) {
"""
echo "" | gzip > ${meta.id}.fastq.gz
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
echo "" | gzip > ${meta.id}.fastq.gz
echo | gzip > ${meta.id}.fastq.gz

Comment thread modules/local/sra_fastq_ftp/main.nf Outdated
Comment on lines +60 to +61
echo "" | gzip > ${meta.id}_1.fastq.gz
echo "" | gzip > ${meta.id}_2.fastq.gz
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
echo "" | gzip > ${meta.id}_1.fastq.gz
echo "" | gzip > ${meta.id}_2.fastq.gz
echo | gzip > ${meta.id}_1.fastq.gz
echo | gzip > ${meta.id}_2.fastq.gz


stub:
"""
touch ${runinfo.toString().tokenize(".")[0]}.runinfo_ftp.tsv
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

do you have that info if its just a stub?

@Tabea01
Copy link
Copy Markdown
Author

Tabea01 commented May 5, 2026

@famosab Good point! I'll add stub test cases to each of the local modules in this PR.

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.

2 participants