Move PluginExecAware to nextflow module

Signed-off-by: Ben Sherman <bentshermann@gmail.com>

Author: bentsherman

docs/plugins/developing-plugins.mdx

@@ -148,7 +148,7 @@ Plugins can define custom CLI commands that are executable with the `nextflow pl
 To implement a plugin-specific command, implement the `PluginExecAware` interface in your plugin entry point (the class that extends `BasePlugin`). Alternatively, implement the `PluginAbstractExec` trait, which provides an abstract implementation with some boilerplate code. This trait requires you to implement the `getCommands()` and `exec()` methods. For example:
 
 ```groovy
-import nextflow.cli.PluginAbstractExec
+import nextflow.plugin.cli.PluginAbstractExec
 import nextflow.plugin.BasePlugin
 
 class MyPlugin extends BasePlugin implements PluginAbstractExec {

…y/nextflow/cli/PluginAbstractExec.groovy …low/plugin/cli/PluginAbstractExec.groovymodules/nf-cli-v1/src/main/groovy/nextflow/cli/PluginAbstractExec.groovy renamed to modules/nextflow/src/main/groovy/nextflow/plugin/cli/PluginAbstractExec.groovy modules/nf-cli-v1/src/main/groovy/nextflow/cli/PluginAbstractExec.groovy renamed to modules/nextflow/src/main/groovy/nextflow/plugin/cli/PluginAbstractExec.groovy

@@ -14,16 +14,15 @@
  * limitations under the License.
  */
 
-package nextflow.cli
-
-import java.nio.file.Paths
+package nextflow.plugin.cli
 
 import groovy.transform.CompileStatic
 import nextflow.Session
-import nextflow.config.ConfigCmdAdapter
+import nextflow.SysEnv
 import nextflow.exception.AbortOperationException
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
+
 import static PluginExecAware.CMD_SEP
 
 /**
@@ -37,23 +36,13 @@ trait PluginAbstractExec implements PluginExecAware {
     private static Logger log = LoggerFactory.getLogger(PluginAbstractExec)
 
     private Session session
-    private Launcher launcher
 
     Session getSession() { session }
 
-    Launcher getLauncher() { launcher }
-
     abstract List<String> getCommands()
 
     @Override
-    final int exec(Launcher launcher1, String pluginId, String cmd, List<String> args) {
-        this.launcher = launcher1
-        // create the config
-        final config = new ConfigCmdAdapter()
-                .setOptions(launcher1.options)
-                .setBaseDir(Paths.get('.'))
-                .build()
-
+    final int exec(String pluginId, String cmd, List<String> args) {
         if( !cmd || cmd !in getCommands() ) {
             def msg = cmd ? "Invalid command '$pluginId:$cmd' - usage: nextflow plugin ${pluginId}${CMD_SEP}<command>" : "Usage: nextflow plugin ${pluginId}${CMD_SEP}<command>"
             msg += "\nAvailable commands:"
@@ -63,7 +52,8 @@ trait PluginAbstractExec implements PluginExecAware {
         }
 
         // create the session object
-        this.session = new Session(config)
+        this.session = new Session(getConfig())
+
         // invoke the command
         try {
             exec(cmd, args)
@@ -77,7 +67,16 @@ trait PluginAbstractExec implements PluginExecAware {
         return 0
     }
 
-    abstract int exec(String cmd, List<String> args)
+    private Map getConfig() {
+        final result = [
+            workDir: SysEnv.get('NXF_WORK') ?: 'work'
+        ]
+        final cloudCachePath = SysEnv.get('NXF_CLOUDCACHE_PATH')
+        if( cloudCachePath )
+            result.cloudcache = [ enabled: true, path: cloudCachePath ]
+        return result
+    }
 
+    abstract int exec(String cmd, List<String> args)
 
 }

…oovy/nextflow/cli/PluginExecAware.groovy …xtflow/plugin/cli/PluginExecAware.groovymodules/nf-cli-v1/src/main/groovy/nextflow/cli/PluginExecAware.groovy renamed to modules/nextflow/src/main/groovy/nextflow/plugin/cli/PluginExecAware.groovy modules/nf-cli-v1/src/main/groovy/nextflow/cli/PluginExecAware.groovy renamed to modules/nextflow/src/main/groovy/nextflow/plugin/cli/PluginExecAware.groovy

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package nextflow.cli
+package nextflow.plugin.cli
 
 /**
  * Define the interface for plugin commands
@@ -25,6 +25,6 @@ interface PluginExecAware {
 
     static final String CMD_SEP = ':'
 
-    int exec(Launcher launcher, String pluginId, String cmd, List<String> args)
+    int exec(String pluginId, String cmd, List<String> args)
 
 }

modules/nf-cli-v1/src/main/groovy/nextflow/cli/CmdPlugin.groovy

@@ -16,8 +16,6 @@
 
 package nextflow.cli
 
-import static nextflow.cli.PluginExecAware.CMD_SEP
-
 import java.nio.file.Path
 
 import com.beust.jcommander.DynamicParameter
@@ -27,8 +25,11 @@ import groovy.transform.CompileStatic
 import nextflow.exception.AbortOperationException
 import nextflow.plugin.PluginRef
 import nextflow.plugin.Plugins
+import nextflow.plugin.cli.PluginExecAware
 import nextflow.plugin.util.PluginRefactor
 import org.eclipse.jgit.api.Git
+
+import static nextflow.plugin.cli.PluginExecAware.CMD_SEP
 /**
  * Plugin manager command
  *
@@ -220,7 +221,7 @@ class CmdPlugin extends CmdBase implements UsageAware {
             }
             args.addAll(mapped)
             // execute plugin command
-            final ret = plugin.exec(getLauncher(), target, cmd, args)
+            final ret = plugin.exec(target, cmd, args)
             // use explicit exit to invoke the system shutdown hooks
             System.exit(ret)
         }

plugins/nf-tower/src/main/io/seqera/tower/plugin/CacheCommand.groovy

@@ -19,7 +19,7 @@ package io.seqera.tower.plugin
 import groovy.transform.CompileStatic
 import groovy.util.logging.Slf4j
 import nextflow.SysEnv
-import nextflow.cli.PluginAbstractExec
+import nextflow.plugin.cli.PluginAbstractExec
 /**
  * Implements nextflow cache and restore commands
  *
@@ -59,10 +59,11 @@ class CacheCommand implements PluginAbstractExec {
     }
 
     protected void cacheRestore() {
-        if( !getSession().cloudCachePath ) {
+        final env = SysEnv.get()
+        if( !env.get('NXF_CLOUDCACHE_PATH') ) {
             log.debug "Running Nextflow cache restore"
             // legacy cache manager
-            new CacheManager(System.getenv()).restoreCacheFiles()
+            new CacheManager(env).restoreCacheFiles()
         }
         else {
             // this command is only kept for backward compatibility

plugins/nf-tower/src/main/io/seqera/tower/plugin/TowerPlugin.groovy

@@ -21,7 +21,7 @@ import groovy.util.logging.Slf4j
 import io.seqera.tower.plugin.fs.SeqeraFileSystemProvider
 import nextflow.file.FileHelper
 import nextflow.plugin.BasePlugin
-import nextflow.cli.PluginExecAware
+import nextflow.plugin.cli.PluginExecAware
 import org.pf4j.PluginWrapper
 /**
  * Seqera Platform plugin

plugins/nf-wave/build.gradle

@@ -49,7 +49,7 @@ configurations {
 }
 
 dependencies {
-    compileOnly project(':nf-cli-v1')
+    compileOnly project(':nextflow')
     compileOnly 'org.slf4j:slf4j-api:2.0.17'
     compileOnly 'org.pf4j:pf4j:3.14.1'
     compileOnly 'io.seqera:lib-trace:0.1.0'

plugins/nf-wave/src/main/io/seqera/wave/plugin/WavePlugin.groovy

@@ -17,8 +17,8 @@
 package io.seqera.wave.plugin
 
 import io.seqera.wave.plugin.cli.WaveCmdEntry
-import nextflow.cli.PluginExecAware
 import nextflow.plugin.BasePlugin
+import nextflow.plugin.cli.PluginExecAware
 import org.pf4j.PluginWrapper
 /**
  * Wave plugin entrypoint

plugins/nf-wave/src/main/io/seqera/wave/plugin/cli/WaveCmdEntry.groovy

@@ -25,9 +25,9 @@ import groovy.util.logging.Slf4j
 import io.seqera.wave.plugin.ContainerConfig
 import io.seqera.wave.plugin.packer.Packer
 import io.seqera.wave.plugin.util.BasicCliOpts
-import nextflow.cli.PluginAbstractExec
 import nextflow.exception.AbortOperationException
 import nextflow.io.BucketParser
+import nextflow.plugin.cli.PluginAbstractExec
 /**
  * Implements Wave CLI tool
  *