Merge pull request #1619 from matthdsm/modules/md5sum

new modules : md5sum / sha256sum

modules/md5sum/main.nf

@@ -0,0 +1,35 @@
+process MD5SUM {
+    tag "$meta.id"
+    label 'process_low'
+
+    conda (params.enable_conda ? "conda-forge::coreutils=9.1" : null)
+    container "${ workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container ?
+        'https://depot.galaxyproject.org/singularity/ubuntu:20.04' :
+        'ubuntu:20.04' }"
+
+    input:
+    tuple val(meta), path(file)
+
+    output:
+    tuple val(meta), path("*.md5"), emit: checksum
+    path "versions.yml"           , emit: versions
+
+    when:
+    task.ext.when == null || task.ext.when
+
+    script:
+    def args = task.ext.args ?: ''
+    def prefix = task.ext.prefix ?: "${meta.id}"
+
+    """
+    md5sum \\
+        $args \\
+        ${file} \\
+        > ${file}.md5
+
+    cat <<-END_VERSIONS > versions.yml
+    "${task.process}":
+        md5sum: \$(echo \$(md5sum --version 2>&1 | head -n 1| sed 's/^.*) //;' ))
+    END_VERSIONS
+    """
+}

modules/md5sum/meta.yml

@@ -0,0 +1,39 @@
+name: "md5sum"
+description: Create an MD5 (128-bit) checksum
+keywords:
+  - checksum
+tools:
+  - "md5sum":
+      description: Create an MD5 (128-bit) checksum
+      homepage: "https://www.gnu.org"
+      documentation: "https://man7.org/linux/man-pages/man1/md5sum.1.html"
+      licence: GPLv3+
+
+input:
+  - meta:
+      type: map
+      description: |
+        Groovy Map containing sample information
+        e.g. [ id:'test', single_end:false ]
+  - file:
+      type: file
+      description: Any file
+      pattern: "*.*"
+
+output:
+  - meta:
+      type: map
+      description: |
+        Groovy Map containing sample information
+        e.g. [ id:'test', single_end:false ]
+  - versions:
+      type: file
+      description: File containing software versions
+      pattern: "versions.yml"
+  - checksum:
+      type: file
+      description: File containing checksum
+      pattern: "*.md5"
+
+authors:
+  - "@matthdsm"

modules/shasum/main.nf

@@ -0,0 +1,35 @@
+process SHASUM {
+    tag "$meta.id"
+    label 'process_low'
+
+    conda (params.enable_conda ? "conda-forge::coreutils=9.1" : null)
+    container "${ workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container ?
+        'https://depot.galaxyproject.org/singularity/ubuntu:20.04' :
+        'ubuntu:20.04' }"
+
+    input:
+    tuple val(meta), path(file)
+
+    output:
+    tuple val(meta), path("*.sha256"), emit: checksum
+    path "versions.yml"           , emit: versions
+
+    when:
+    task.ext.when == null || task.ext.when
+
+    script:
+    def args = task.ext.args ?: ''
+    def prefix = task.ext.prefix ?: "${meta.id}"
+
+    """
+    sha256sum \\
+        $args \\
+        ${file} \\
+        > ${file}.sha256
+
+    cat <<-END_VERSIONS > versions.yml
+    "${task.process}":
+        sha256sum: \$(echo \$(sha256sum --version 2>&1 | head -n 1| sed 's/^.*) //;' ))
+    END_VERSIONS
+    """
+}

modules/shasum/meta.yml

@@ -0,0 +1,40 @@
+name: "shasum"
+description: Print SHA256 (256-bit) checksums.
+keywords:
+  - checksum
+  - sha256
+tools:
+  - "md5sum":
+      description: Create an SHA256 (256-bit) checksum.
+      homepage: "https://www.gnu.org"
+      documentation: "https://linux.die.net/man/1/shasum"
+      licence: GPLv3+
+
+input:
+  - meta:
+      type: map
+      description: |
+        Groovy Map containing sample information
+        e.g. [ id:'test', single_end:false ]
+  - file:
+      type: file
+      description: Any file
+      pattern: "*.*"
+
+output:
+  - meta:
+      type: map
+      description: |
+        Groovy Map containing sample information
+        e.g. [ id:'test', single_end:false ]
+  - versions:
+      type: file
+      description: File containing software versions
+      pattern: "versions.yml"
+  - checksum:
+      type: file
+      description: File containing checksum
+      pattern: "*.sha256"
+
+authors:
+  - "@matthdsm"

tests/config/pytest_modules.yml

@@ -1058,10 +1058,6 @@ krona/kronadb:
   - modules/krona/kronadb/**
   - tests/modules/krona/kronadb/**
 
-krona/ktupdatetaxonomy:
-  - modules/krona/ktupdatetaxonomy/**
-  - tests/modules/krona/ktupdatetaxonomy/**
-
 krona/ktimporttaxonomy:
   - modules/krona/ktimporttaxonomy/**
   - tests/modules/krona/ktimporttaxonomy/**
@@ -1070,6 +1066,10 @@ krona/ktimporttext:
   - modules/krona/ktimporttext/**
   - tests/modules/krona/ktimporttext/**
 
+krona/ktupdatetaxonomy:
+  - modules/krona/ktupdatetaxonomy/**
+  - tests/modules/krona/ktupdatetaxonomy/**
+
 last/dotplot:
   - modules/last/dotplot/**
   - tests/modules/last/dotplot/**
@@ -1190,6 +1190,10 @@ maxbin2:
   - modules/maxbin2/**
   - tests/modules/maxbin2/**
 
+md5sum:
+  - modules/md5sum/**
+  - tests/modules/md5sum/**
+
 medaka:
   - modules/medaka/**
   - tests/modules/medaka/**
@@ -1735,6 +1739,10 @@ seqwish/induce:
   - modules/seqwish/induce/**
   - tests/modules/seqwish/induce/**
 
+shasum:
+  - modules/shasum/**
+  - tests/modules/shasum/**
+
 shigatyper:
   - modules/shigatyper/**
   - tests/modules/shigatyper/**

tests/modules/md5sum/main.nf

@@ -0,0 +1,15 @@
+#!/usr/bin/env nextflow
+
+nextflow.enable.dsl = 2
+
+include { MD5SUM } from '../../../modules/md5sum/main.nf'
+
+workflow test_md5sum {
+    
+    input = [
+        [ id:'test', single_end:false ], // meta map
+        file(params.test_data['sarscov2']['illumina']['test_paired_end_bam'], checkIfExists: true)
+    ]
+
+    MD5SUM ( input )
+}

tests/modules/md5sum/nextflow.config

@@ -0,0 +1,3 @@
+process {
+    publishDir = { "${params.outdir}/${task.process.tokenize(':')[-1].tokenize('_')[0].toLowerCase()}" }
+}

tests/modules/md5sum/test.yml

@@ -0,0 +1,8 @@
+- name: md5sum test_md5sum
+  command: nextflow run tests/modules/md5sum -entry test_md5sum -c tests/config/nextflow.config
+  tags:
+    - md5sum
+  files:
+    - path: output/md5sum/test.paired_end.bam.md5
+      md5sum: 1163095be8fdfb2acb3cc6c027389c4b
+    - path: output/md5sum/versions.yml

tests/modules/shasum/main.nf

@@ -0,0 +1,15 @@
+#!/usr/bin/env nextflow
+
+nextflow.enable.dsl = 2
+
+include { SHASUM } from '../../../modules/shasum/main.nf'
+
+workflow test_shasum {
+    
+    input = [
+        [ id:'test', single_end:false ], // meta map
+        file(params.test_data['sarscov2']['illumina']['test_paired_end_bam'], checkIfExists: true)
+    ]
+
+    SHASUM ( input )
+}

tests/modules/shasum/nextflow.config

@@ -0,0 +1,5 @@
+process {
+
+    publishDir = { "${params.outdir}/${task.process.tokenize(':')[-1].tokenize('_')[0].toLowerCase()}" }
+    
+}

tests/modules/shasum/test.yml

@@ -0,0 +1,8 @@
+- name: shasum test_shasum
+  command: nextflow run tests/modules/shasum -entry test_shasum -c tests/config/nextflow.config
+  tags:
+    - shasum
+  files:
+    - path: output/shasum/test.paired_end.bam.sha256
+      md5sum: 138a19e100f09fc975ea1b717da9b6dd
+    - path: output/shasum/versions.yml