Add enabled property to output dsl (#5008) [ci fast]

Signed-off-by: Paolo Di Tommaso <[email protected]>
nextflow-io · May 19, 2024 · 284415b · 284415b
1 parent eb97831
commit 284415b
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 5 deletions.
diff --git a/modules/nextflow/src/main/groovy/nextflow/extension/PublishOp.groovy b/modules/nextflow/src/main/groovy/nextflow/extension/PublishOp.groovy
@@ -84,7 +84,7 @@ class PublishOp {
     }
 
     protected void onComplete(nope) {
-        if( indexOpts && indexRecords.size() > 0 ) {
+        if( indexOpts && indexRecords.size() > 0 && publisher.enabled ) {
             log.trace "Saving records to index file: ${indexRecords}"
             new CsvWriter(header: indexOpts.header, sep: indexOpts.sep).apply(indexRecords, indexOpts.path)
             session.notifyFilePublish(indexOpts.path)

diff --git a/modules/nextflow/src/main/groovy/nextflow/script/OutputDsl.groovy b/modules/nextflow/src/main/groovy/nextflow/script/OutputDsl.groovy
@@ -17,7 +17,6 @@
 package nextflow.script
 
 import java.nio.file.Path
-import java.nio.file.Paths
 
 import groovy.transform.CompileStatic
 import groovy.util.logging.Slf4j
@@ -27,7 +26,6 @@ import nextflow.extension.CH
 import nextflow.extension.MixOp
 import nextflow.extension.PublishOp
 import nextflow.file.FileHelper
-
 /**
  * Implements the DSL for publishing workflow outputs
  *
@@ -83,6 +81,10 @@ class OutputDsl {
         setDefault('tags', value)
     }
 
+    void enabled( boolean value ) {
+        setDefault('enabled', value)
+    }
+
     private void setDefault(String name, Object value) {
         if( defaults.containsKey(name) )
             throw new ScriptRuntimeException("Default `${name}` option cannot be defined more than once in the workflow publish definition")
@@ -203,14 +205,18 @@ class OutputDsl {
             setOption('tags', value)
         }
 
+        void enabled( boolean value ) {
+            setOption('enabled', value)
+        }
+
         private void setOption(String name, Object value) {
             if( opts.containsKey(name) )
                 throw new ScriptRuntimeException("Publish option `${name}` cannot be defined more than once for a given target")
             opts[name] = value
         }
 
         Map getOptions() {
-            opts
+            return opts
         }
 
     }
@@ -246,7 +252,7 @@ class OutputDsl {
         }
 
         Map getOptions() {
-            opts
+            return opts
         }
 
     }

diff --git a/modules/nextflow/src/test/groovy/nextflow/script/OutputDslTest.groovy b/modules/nextflow/src/test/groovy/nextflow/script/OutputDslTest.groovy
@@ -82,4 +82,60 @@ class OutputDslTest extends Specification {
         root?.deleteDir()
     }
 
+    def 'should set options' () {
+        when:
+        def dsl1 = new OutputDsl()
+        then:
+        dsl1.@defaults == [:]
+
+        when:
+        def dsl2 = new OutputDsl()
+        and:
+        dsl2.contentType('simple/text')
+        dsl2.ignoreErrors(true)
+        dsl2.mode('someMode')
+        dsl2.overwrite(true)
+        dsl2.storageClass('someClass')
+        dsl2.tags([foo:'1',bar:'2'])
+        dsl2.enabled(true)
+        then:
+        dsl2.@defaults == [
+            contentType:'simple/text',
+            ignoreErrors: true,
+            mode: 'someMode',
+            overwrite: true,
+            storageClass: 'someClass',
+            tags: [foo:'1',bar:'2'],
+            enabled: true
+        ]
+    }
+
+    def 'should set target dsl' () {
+        when:
+        def dsl1 = new OutputDsl.TargetDsl()
+        then:
+        dsl1.getOptions() == [:]
+
+        when:
+        def dsl2 = new OutputDsl.TargetDsl()
+        and:
+        dsl2.contentType('simple/text')
+        dsl2.ignoreErrors(true)
+        dsl2.mode('someMode')
+        dsl2.overwrite(true)
+        dsl2.storageClass('someClass')
+        dsl2.tags([foo:'1',bar:'2'])
+        dsl2.enabled(true)
+        then:
+        dsl2.getOptions() == [
+            contentType:'simple/text',
+            ignoreErrors: true,
+            mode: 'someMode',
+            overwrite: true,
+            storageClass: 'someClass',
+            tags: [foo:'1',bar:'2'],
+            enabled: true
+        ]
+    }
+
 }