Allow -n | --dryrun for submission rocoto commands

lib/workflowmgr/cobaltbatchsystem.rb

@@ -188,11 +188,17 @@ def submit(task)
       WorkflowMgr.stderr("Submitting #{task.attributes[:name]} using #{cmd} --mode script #{tf.path} with input {{#{input}}}",4)
 
       # Run the submit command
-      output=`#{cmd} --mode script #{tf.path} 2>&1`.chomp()
+      if WorkflowMgr::DRYRUN > 0
+        output="This is a dryrun"
+      else
+        output=`#{cmd} --mode script #{tf.path} 2>&1`.chomp()
+      end
 
       # Parse the output of the submit command
       if output=~/^(\d+)$/
         return $1,output
+      elsif output=~/^This is a dryrun/
+        return $1,output
       else
         return nil,output
       end

lib/workflowmgr/lsfbatchsystem.rb

@@ -318,14 +318,20 @@ def submit(task)
       tf.flush()
 
       # Run the submit command script
-      output=`/bin/sh #{tf.path} 2>&1`.chomp
+      if WorkflowMgr::DRYRUN > 0
+        output="This is a dryrun"
+      else
+        output=`/bin/sh #{tf.path} 2>&1`.chomp
+      end
 
       WorkflowMgr.log("Submitted #{task.attributes[:name]} using '/bin/sh #{tf.path} 2>&1' with input {{#{envstr + cmd}}}")
       WorkflowMgr.stderr("Submitted #{task.attributes[:name]} using '/bin/sh #{tf.path} 2>&1' with input {{#{envstr + cmd}}}",4)
 
       # Parse the output of the submit command
       if output=~/Job <(\d+)> is submitted to (default )*queue/
         return $1,output
+      elsif output=~/^This is a dryrun/
+        return $1,output
       else
         return nil,output
       end

lib/workflowmgr/lsfcraybatchsystem.rb

@@ -187,14 +187,20 @@ def submit(task)
       tf.flush()
 
       # Run the submit command script
-      output=`/bin/sh #{tf.path} 2>&1`.chomp
+      if WorkflowMgr::DRYRUN > 0
+        output="This is a dryrun"
+      else
+        output=`/bin/sh #{tf.path} 2>&1`.chomp
+      end
 
       WorkflowMgr.log("Submitted #{task.attributes[:name]} using '/bin/sh #{tf.path} 2>&1' with input {{#{envstr + cmd}}}")
       WorkflowMgr.stderr("Submitted #{task.attributes[:name]} using '/bin/sh #{tf.path} 2>&1' with input {{#{envstr + cmd}}}",4)
 
       # Parse the output of the submit command
       if output=~/Job <(\d+)> is submitted to (default )*queue/
         return $1,output
+      elsif output=~/^This is a dryrun/
+        return $1,output
       else
         return nil,output
       end

lib/workflowmgr/moabbatchsystem.rb

@@ -195,11 +195,17 @@ def submit(task)
       WorkflowMgr.stderr("Submitting #{task.attributes[:name]} using #{cmd} < #{tf.path} with input {{#{input}}}",4)
 
       # Run the submit command
-      output=`#{cmd} < #{tf.path} 2>&1`.chomp()
+      if WorkflowMgr::DRYRUN > 0
+        output="This is a dryrun"
+      else
+        output=`#{cmd} < #{tf.path} 2>&1`.chomp()
+      end
 
       # Parse the output of the submit command
       if output=~/^((\w+\.)*\d+)$/
         return $1,output
+      elsif output=~/^This is a dryrun/
+        return $1,output
       else
         return nil,output
       end

lib/workflowmgr/pbsprobatchsystem.rb

@@ -217,11 +217,17 @@ def submit(task)
       WorkflowMgr.stderr("Submitting #{task.attributes[:name]} using #{cmd} < #{tf.path} with input {{#{input}}}",4)
 
       # Run the submit command
-      output=`#{cmd} < #{tf.path} 2>&1`.chomp()
+      if WorkflowMgr::DRYRUN > 0
+        output="This is a dryrun"
+      else
+        output=`#{cmd} < #{tf.path} 2>&1`.chomp()
+      end
 
       # Parse the output of the submit command
       if output=~/^(\d+)(\.[a-zA-Z0-9-]+)*$/
         return $1,output
+      elsif output=~/^This is a dryrun/
+        return $1,output
       else
         return nil,output
       end

lib/workflowmgr/reportoption.rb

@@ -17,6 +17,7 @@ class ReportOption
     attr_reader :database
     attr_reader :workflowdoc
     attr_reader :verbose
+    attr_reader :dryrun
 
     ##########################################
     #
@@ -28,6 +29,7 @@ def initialize(args)
       @database=nil
       @workflowdoc=nil
       @verbose=0
+      @dryrun=0
       parse(args)
 
     end  # initialize
@@ -72,6 +74,12 @@ def parse(args)
           WorkflowMgr.const_set("VERBOSE",@verbose)
         end
 
+        # Handle option for dryrun
+        opts.on("-n","--dryrun","Show Workflow Manager commands, but do not execute") do |dryrun|
+          @dryrun=1
+          WorkflowMgr.const_set("DRYRUN",@dryrun)
+        end
+
         # Handle option for version
         opts.on("--version","Show Workflow Manager version") do
           puts "Workflow Manager Version #{WorkflowMgr.version}"
@@ -94,6 +102,9 @@ def parse(args)
           # Set verbose to 0 if not set by options
           WorkflowMgr.const_set("VERBOSE",0) unless WorkflowMgr.const_defined?("VERBOSE")
 
+          # Set dryrun to 0 if not set by options
+          WorkflowMgr.const_set("DRYRUN",0) unless WorkflowMgr.const_defined?("DRYRUN")
+
           # The -d and -w options are mandatory
           raise OptionParser::ParseError,"A database file must be specified" if @database.nil?
           raise OptionParser::ParseError,"A workflow definition file must be specified" if @workflowdoc.nil?

lib/workflowmgr/slurmbatchsystem.rb

@@ -312,11 +312,17 @@ def submit(task)
       WorkflowMgr.stderr("Submitting #{task.attributes[:name]} using #{cmd} < #{tf.path} with input\n{{\n#{input}\n}}", 4)
 
       # Run the submit command
-      output=`#{cmd} < #{tf.path} 2>&1`.chomp()
+      if WorkflowMgr::DRYRUN > 0
+        output="This is a dryrun"
+      else
+        output=`#{cmd} < #{tf.path} 2>&1`.chomp()
+      end
 
       # Parse the output of the submit command
       if output=~/^Submitted batch job (\d+)/
         return $1,output
+      elsif output=~/^This is a dryrun/
+        return $1,output
       elsif output=~/Batch job submission failed: Socket timed out/
 
         WorkflowMgr.stderr("WARNING: '#{output}', looking to see if job was submitted anyway...", 1)

lib/workflowmgr/torquebatchsystem.rb

@@ -176,11 +176,17 @@ def submit(task)
       WorkflowMgr.stderr("Submitting #{task.attributes[:name]} using #{cmd} < #{tf.path} with input {{#{input}}}",4)
 
       # Run the submit command
-      output=`#{cmd} < #{tf.path} 2>&1`.chomp()
+      if WorkflowMgr::DRYRUN > 0
+        output="This is a dryrun"
+      else
+        output=`#{cmd} < #{tf.path} 2>&1`.chomp()
+      end
 
       # Parse the output of the submit command
       if output=~/^(\d+)(\.[a-zA-Z0-9-]+)*$/
         return $1,output
+      elsif output=~/^This is a dryrun/
+        return $1,output
       else
         return nil,output
       end

lib/workflowmgr/workflowengine.rb

@@ -1919,7 +1919,12 @@ def submit_new_jobs
         uri=job.id
         jobid,output=@bqServer.get_submit_status(job.task,job.cycle)
         if output.nil?
-          @logServer.log(job.cycle,"Submission status of #{job.task} is pending at #{job.id}")
+          if WorkflowMgr::DRYRUN > 0
+            @dbServer.delete_jobs([job])
+            @logServer.log(job.cycle,"Submission of #{job.task} was a dryrun!")
+          else
+            @logServer.log(job.cycle,"Submission status of #{job.task} is pending at #{job.id}")
+          end
         else
           if jobid.nil?
             # Delete the job from the database since it failed to submit.  It will be retried next time around.

lib/workflowmgr/workflowoption.rb

@@ -17,6 +17,7 @@ class WorkflowOption
     attr_reader :database
     attr_reader :workflowdoc
     attr_reader :verbose
+    attr_reader :dryrun
 
     ##########################################
     #
@@ -27,6 +28,7 @@ def initialize(args)
       @database=nil
       @workflowdoc=nil
       @verbose=1
+      @dryrun=0
       @more_args=parse(args)
 
     end  # initialize
@@ -74,6 +76,11 @@ def add_opts(opts)
           end
         end
 
+        # Handle option for dryrun
+        opts.on("-n","--dryrun","Show Workflow Manager commands, but do not execute") do |dryrun|
+          @dryrun=1
+        end
+
         # Handle option for version
         opts.on("--version","Show Rocoto version") do
           puts "Rocoto Version #{WorkflowMgr.version}"
@@ -127,6 +134,9 @@ def parse(args)
           # Set verbosity level
           WorkflowMgr.const_set("VERBOSE",@verbose)
 
+          # Set dryrun level
+          WorkflowMgr.const_set("DRYRUN",@dryrun)
+
           # Set workflow id
           WorkflowMgr.const_set("WORKFLOW_ID",File.basename(@workflowdoc))
 

lib/workflowmgr/workflowsubsetoptions.rb

@@ -48,7 +48,7 @@ def add_opts(opts)
       super(opts)
 
       # Override the command usage text
-      opts.banner = "Usage:  #{@name} [-h] [-v #] -d database_file -w workflow_document [-c cycle_list] [-t task_list] [-m metatask_list] [-a]"
+      opts.banner = "Usage:  #{@name} [-h] [-v #] -d database_file -w workflow_document [-c cycle_list] [-t task_list] [-m metatask_list] [-a] [-n]"
 
       # Cycles of interest
       #      C   C,C,C  C:C  :C   C: