Enable cloud cache based on environment variable (#4160)

Signed-off-by: Ben Sherman <[email protected]>
nextflow-io · Aug 8, 2023 · a66b0e6 · a66b0e6
1 parent ace32d0
commit a66b0e6
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/modules/nf-commons/src/main/nextflow/plugin/PluginsFacade.groovy b/modules/nf-commons/src/main/nextflow/plugin/PluginsFacade.groovy
@@ -371,6 +371,11 @@ class PluginsFacade implements PluginStateListener {
             specs << defaultPlugins.getPlugin('nf-wave')
         }
 
+        // add cloudcache plugin when NXF_CLOUDCACHE_PATH is set
+        if( env.NXF_CLOUDCACHE_PATH ) {
+            specs << defaultPlugins.getPlugin('nf-cloudcache')
+        }
+
         log.debug "Plugins resolved requirement=$specs"
         return specs
     }

diff --git a/modules/nf-commons/src/test/nextflow/plugin/PluginsFacadeTest.groovy b/modules/nf-commons/src/test/nextflow/plugin/PluginsFacadeTest.groovy
@@ -66,6 +66,7 @@ class PluginsFacadeTest extends Specification {
         given:
         def defaults = new DefaultPlugins(plugins: [
                 'nf-amazon': new PluginSpec('nf-amazon', '0.1.0'),
+                'nf-cloudcache': new PluginSpec('nf-cloudcache', '0.1.0'),
                 'nf-google': new PluginSpec('nf-google', '0.1.0'),
                 'nf-tower': new PluginSpec('nf-tower', '0.1.0'),
                 'nf-wave': new PluginSpec('nf-wave', '0.1.0')
@@ -138,6 +139,12 @@ class PluginsFacadeTest extends Specification {
         then:
         result == [ new PluginSpec('nf-google','2.0.0') ]
 
+        when:
+        handler = new PluginsFacade(defaultPlugins: defaults, env: [NXF_CLOUDCACHE_PATH:'xyz'])
+        result = handler.pluginsRequirement([:])
+        then:
+        result == [ new PluginSpec('nf-cloudcache', '0.1.0') ]
+
     }
 
     def 'should return default plugins given config' () {

diff --git a/plugins/nf-cloudcache/src/main/nextflow/cache/CloudCacheStore.groovy b/plugins/nf-cloudcache/src/main/nextflow/cache/CloudCacheStore.groovy
@@ -76,7 +76,7 @@ class CloudCacheStore implements CacheStore {
     private Path defaultBasePath() {
         final basePath = SysEnv.get('NXF_CLOUDCACHE_PATH')
         if( !basePath )
-            throw new IllegalArgumentException("NXF_CLOUDCACHE_PATH must be defined when using the path-based cache store")
+            throw new IllegalArgumentException("NXF_CLOUDCACHE_PATH must be defined when using the cloud cache store")
 
         return basePath as Path
     }