Changeset 4971

Timestamp:

Jan 30, 2015 12:21:28 PM (9 years ago)

Author:

mmc

Message:

Fixed auto-execution via TOOL_PARAMETERS to produce status output in a
file called rappture.status. This makes it easier for the web service
to monitor progress and know when everything is finished. Also, fixed
auto-execution to move the run file to the data/results directory and
clean up the original driver file.

Location:

branches/1.3

Files:

• gui/apps/execute.tcl (modified) (3 diffs)
• gui/apps/launcher.tcl (modified) (1 diff)
• gui/scripts/tool.tcl (modified) (1 diff)
• lang/tcl/scripts/task.tcl (modified) (6 diffs)

branches/1.3/gui/apps/execute.tcl

@@ -67 +67 @@
 set toolobj [Rappture::library $toolxml]
 set TaskObj [Rappture::Task ::#auto $toolobj $installdir]
+set LogFid ""
 
-# tasks in execute mode run quietly and don't try to save results
-$TaskObj configure -jobstats "" -resultdir ""
+# Define some things that we need for logging status...
+# ----------------------------------------------------------------------
+proc log_output {message} {
+    global LogFid
+
+    if {$LogFid ne ""} {
+        #
+        # Scan through and pick out any =RAPPTURE-PROGRESS=> messages.
+        #
+        set percent ""
+        while {[regexp -indices \
+                {=RAPPTURE-PROGRESS=> *([-+]?[0-9]+) +([^\n]*)(\n|$)} $message \
+                 match percent mesg]} {
+
+            foreach {i0 i1} $percent break
+            set percent [string range $message $i0 $i1]
+
+            foreach {i0 i1} $mesg break
+            set mesg [string range $message $i0 $i1]
+
+            foreach {i0 i1} $match break
+            set message [string replace $message $i0 $i1]
+        }
+        if {$percent ne ""} {
+            # report the last percent progress found
+            log_append progress "$percent% - $mesg"
+        }
+    }
+}
+
+# Actually write to the log file
+proc log_append {level message} {
+    global LogFid
+
+    if {$LogFid ne ""} {
+        set date [clock format [clock seconds] -format {%Y-%m-%dT%H:%M:%S%z}]
+        set host [info hostname]
+        puts $LogFid "$date $host rappture [pid] \[$level\] $message"
+        flush $LogFid
+    }
+}
+
+# Actually write to the log file
+proc log_stats {args} {
+    set line ""
+    foreach {key val} $args {
+        append line "$key=$val "
+    }
+    log_append usage $line
+}
+
+# Parse command line options to see 
+# ----------------------------------------------------------------------
+Rappture::getopts argv params {
+    value -status ""
+    value -output ""
+    value -cleanup no
+}
+
+if {$params(-status) ne ""} {
+    set LogFid [open $params(-status) w]
+    $TaskObj configure -logger {log_append status} -jobstats log_stats
+}
+
+if {$params(-output) eq ""} {
+    # no output? then run quietly and don't try to save results
+    $TaskObj configure -jobstats "" -resultdir ""
+}
 
 # Transfer input values from driver to TaskObj, and then run.
@@ -80 +147 @@
         lappend args $path [$driverobj get $path.current]
     }
+}
+
+if {$params(-status) ne ""} {
+    # recording status? then look through output for progress messages
+    lappend args -output log_output
 }
 
@@ -95 +167 @@
     $runxml put output.status failed
 }
-$runxml put output.time [clock format [clock seconds]]
 
-$runxml put tool.version.rappture.version $::Rappture::version
-$runxml put tool.version.rappture.revision $::Rappture::build
-
-if {[info exists tcl_platform(user)]} {
-    $runxml put output.user $::tcl_platform(user)
+# Handle output
+# ----------------------------------------------------------------------
+switch -- $params(-output) {
+    "" {
+        # no output file -- write to stdout
+        puts "<?xml version=\"1.0\"?>\n[$runxml xml]"
+    }
+    "@default" {
+        # do the usual Rappture thing -- move to results dir
+        # but ignore any errors if it fails
+        catch {$TaskObj save $runxml}
+    }
+    default {
+        # save to the specified file
+        $TaskObj save $runxml $params(-output)
+    }
 }
 
-puts "<?xml version=\"1.0\"?>\n[$runxml xml]"
+if {$params(-cleanup)} {
+    file delete -force -- $driverxml
+}
+
+log_append status "exit $status"
 exit $status

branches/1.3/gui/apps/launcher.tcl

@@ -213 +213 @@
             set mainscript [file join $dir execute.tcl]
             set reqpkgs ""
+
+            # When executing from TOOL_PARAMETERS file directives,
+            # report status, clean up, and save output to data/results.
+            # This helps the web services interface do its thing.
+            set alist [list \
+                -output @default \
+                -status rappture.status \
+                -cleanup yes]
         }
         "" - "-input" {

branches/1.3/gui/scripts/tool.tcl

@@ -31 +31 @@
     public method run {args} {
         sync  ;# sync all widget values to XML
-        eval $_task run $args
+
+        foreach {status result} [eval $_task run $args] break
+        if {$status == 0} {
+            # move good results to the data/results directory
+            $_task save $result
+        }
+
+        return [list $status $result]
     }
     public method abort {} {

branches/1.3/lang/tcl/scripts/task.tcl

@@ -32 +32 @@
     public method reset {}
     public method xml {args}
+    public method save {xmlobj {name ""}}
 
     protected method _mkdir {dir}
@@ -39 +40 @@
     private variable _xmlobj ""      ;# XML object with inputs/outputs
     private variable _origxml ""     ;# copy of original XML (for reset)
+    private variable _lastrun ""     ;# name of last run file
     private variable _installdir ""  ;# installation directory for this tool
     private variable _outputcb ""    ;# callback for tool output
@@ -215 +217 @@
 
         # starting job...
+        set _lastrun ""
         _log run started
         Rappture::rusage mark
@@ -353 +356 @@
         set result [string trim $job(output)]
         if {[regexp {=RAPPTURE-RUN=>([^\n]+)} $result match file]} {
+            set _lastrun $file
+
             set status [catch {Rappture::library $file} result]
             if {$status == 0} {
@@ -366 +371 @@
             }
 
-            # if there's a results_directory defined in the resources
-            # file, then move the run.xml file there for storage
-            set rdir ""
-            if {$resultdir eq "@default"} {
-                if {[info exists _resources(-resultdir)]} {
-                    set rdir $_resources(-resultdir)
-                } else {
-                    set rdir "."
-                }
-            } elseif {$resultdir ne ""} {
-                set rdir $resultdir
-            }
-
-            if {$status == 0 && $rdir ne ""} {
-                catch {
-                    file delete -force -- $file
-                    if {![file exists $rdir]} {
-                        _mkdir $rdir
-                    }
-                    set tail [file tail $file]
-                    set fid [open [file join $rdir $tail] w]
-                    puts $fid "<?xml version=\"1.0\"?>"
-                    puts $fid [$result xml]
-                    close $fid
-                }
-            } else {
-                # don't keep the file
-                file delete -force -- $file
-            }
+            file delete -force -- $file
         } else {
             set status 1
@@ -475 +452 @@
 
 # ----------------------------------------------------------------------
+# USAGE: save <xmlobj> ?<filename>?
+#
+# Used by clients to save the contents of an <xmlobj> representing
+# a run out to the given file.  If <filename> is not specified, then
+# it uses the -resultsdir and other settings to do what Rappture
+# would normally do with the output.
+# ----------------------------------------------------------------------
+itcl::body Rappture::Task::save {xmlobj {filename ""}} {
+    if {$filename eq ""} {
+        # if there's a results_directory defined in the resources
+        # file, then move the run.xml file there for storage
+        set rdir ""
+        if {$resultdir eq "@default"} {
+            if {[info exists _resources(-resultdir)]} {
+                set rdir $_resources(-resultdir)
+            } else {
+                set rdir "."
+            }
+        } elseif {$resultdir ne ""} {
+            set rdir $resultdir
+        }
+
+        # use the runfile name generated by the last run
+        if {$_lastrun ne ""} {
+            set filename [file join $rdir $_lastrun]
+        } else {
+            set filename [file join $rdir run.xml]
+        }
+    }
+
+    # add any last-minute metadata
+    $xmlobj put output.time [clock format [clock seconds]]
+
+    $xmlobj put tool.version.rappture.version $::Rappture::version
+    $xmlobj put tool.version.rappture.revision $::Rappture::build
+
+    if {[info exists ::tcl_platform(user)]} {
+        $xmlobj put output.user $::tcl_platform(user)
+    }
+
+    # save the output
+    set rdir [file dirname $filename]
+    if {![file exists $rdir]} {
+        _mkdir $rdir
+    }
+
+    set fid [open $filename w]
+    puts $fid "<?xml version=\"1.0\"?>"
+    puts $fid [$xmlobj xml]
+    close $fid
+
+    _log output saved in $filename
+}
+
+# ----------------------------------------------------------------------
 # USAGE: _output <data>
 #