Changeset 2055

Timestamp:

Jan 19, 2011, 7:49:28 PM (14 years ago)

Author:

braffert

Message:

Regression tester: cleaning up and adding comments

Location:

trunk/tester

Files:

• test.tcl (modified) (3 diffs)
• testtree.tcl (modified) (5 diffs)
• testview.tcl (modified) (5 diffs)

trunk/tester/test.tcl

@@ -115 +115 @@
 # USAGE: getInputs
 #
-# TODO
+# Returns a list of key value pairs for all inputs given in the test xml.
+# Each key is the path to the input element, and each key is its current
+# value. 
 # -----------------------------------------------------------------------
 itcl::body Rappture::Tester::Test::getInputs {{path input}} {
@@ -149 +151 @@
 # USAGE: getOutputs
 #
-# TODO
+# Returns a list of key value pairs for all outputs in the runfile
+# generated by the last run of the test.  Each key is the path to the
+# element, and each value is its status (ok, diff, added, or missing).
+# Throws an error if the test has not been ran.
 # ----------------------------------------------------------------------
 itcl::body Rappture::Tester::Test::getOutputs {{path output}} {
@@ -158 +163 @@
     foreach child [$_runobj children $path] {
         set fullpath $path.$child
-        if {$fullpath != "output.time" && $fullpath != "output.user" && $fullpath != "output.status"} {
+        if {$fullpath != "output.time" && $fullpath != "output.user" \
+            && $fullpath != "output.status"} {
             if {[lsearch $fullpath [getDiffs]] != -1} {
                 set status diff
             } elseif {[lsearch $fullpath [getAdded]] != -1} {
                 set status added
-            #} elseif {[lsearch $fullpath [getMissing]] != -1} {
-            #    set status missing
             } else {
                 if {[$_runobj get $fullpath] != ""} {

trunk/tester/testtree.tcl

@@ -38 +38 @@
 
     constructor {args} { #defined later }
+    destructor { #defined later }
 
     public method getTest {args}
@@ -117 +118 @@
 }
 
-# TODO: destructor
-
-# ----------------------------------------------------------------------
-# Repopulate tree if test directory or toolxml have been changed.
+# ----------------------------------------------------------------------
+# DESTRUCTOR
+# ----------------------------------------------------------------------
+itcl::body Rappture::Tester::TestTree::destructor {} {
+    foreach id [getLeaves] {
+        itcl::delete object [getTest $id]
+    }
+}
+
+# ----------------------------------------------------------------------
+# CONFIGURATION OPTION: -testdir
+#
+# Location of the directory containing a set of test xml files.
+# Repopulate the tree if -testdir option is changed, but only if
+# -toolxml has already been defined.
 # ----------------------------------------------------------------------
 itcl::configbody Rappture::Tester::TestTree::testdir {
@@ -128 +140 @@
 }
 
+# ----------------------------------------------------------------------
+# CONFIGURATION OPTION: -toolxml
+#
+# Location of the tool.xml for the tool being tested.  Repopulate the
+# tree if -toolxml is changed, but only if -testdir has already been
+# defined.
 itcl::configbody Rappture::Tester::TestTree::toolxml {
     if {$itk_option(-testdir) != ""} {
@@ -135 +153 @@
 
 # ----------------------------------------------------------------------
+# CONFIGURATION OPTION: -selectcommand
+#
 # Forward the TestTree's selectcommand to the treeview, but tack on the
 # updateLabel method to keep the label refreshed when selection is
@@ -256 +276 @@
 # ----------------------------------------------------------------------
 itcl::body Rappture::Tester::TestTree::populate {} {
-    # TODO: Delete existing test objects
+    foreach id [getLeaves] {
+        itcl::delete object [getTest $id]
+    }
     $itk_component(treeview) delete 0
     # TODO: add an appropriate icon

trunk/tester/testview.tcl

@@ -4 +4 @@
 #  Entire right hand side of the regression tester.  Displays the
 #  golden test results, and compares them to the new results if the test
-#  has been ran.  The -test configuration option is used to provide a
-#  Test object to display.
+#  has been ran.  Also show tree representation of all inputs and
+#  outputs.  The -test configuration option is used to provide a Test
+#  object to display.
 # ======================================================================
 #  AUTHOR:  Ben Rafferty, Purdue University
@@ -122 +123 @@
 
 # ----------------------------------------------------------------------
+# CONFIGURATION OPTION: -test
+#
 # When the -test configuration option is modified, update the display
 # accordingly.  The data passed in should be a Test object, or an empty 
@@ -202 +205 @@
 # ----------------------------------------------------------------------
 # USAGE: updateResults
+
+# Used internally to update the results tab according to the test
+# currently specified by the -test configuration option.  Show the
+# golden results contained in the test xml, and if the the test has been
+# ran, show the new results as well.
 # ----------------------------------------------------------------------
 itcl::body Rappture::Tester::TestView::updateResults {} {
@@ -218 +226 @@
 }
 
+# ----------------------------------------------------------------------
+# USAGE: updateInputs
+#
+# Used internally to update the inputs tab according to the test
+# currently specified by the -test configuration option.  Shows a tree
+# representation of all inputs given in the test xml and their given
+# values.
+# ----------------------------------------------------------------------
 itcl::body Rappture::Tester::TestView::updateInputs {} {
     $itk_component(inputs) delete 0
@@ -230 +246 @@
 }
 
+# ----------------------------------------------------------------------
+# USAGE: updateOutputs
+#
+# Used internally to update the outputs tab according to the test
+# currently specified by the -test configuration option.  Shows a tree
+# representation of all outputs in the runfile generated by the last run
+# of the test, along with their status (ok, diff, added, or missing).
+# Disable the outputs tab if test has not been ran, or resulted in an
+# error.
+# ----------------------------------------------------------------------
 itcl::body Rappture::Tester::TestView::updateOutputs {} {
     $itk_component(outputs) delete 0