Clean up of tests and conversion to tcltest 2. Target has been to get init and

cleanup code out of the test body and into the -setup/-cleanup stanzas.

1 files changed, 123 insertions, 134 deletions

diff --git a/tests/compile.test b/tests/compile.test
index 4f4c53e..51cf64c 100644
--- a/tests/compile.test
+++ b/tests/compile.test
@@ -1,17 +1,17 @@
-# This file contains tests for the files tclCompile.c, tclCompCmds.c
-# and tclLiteral.c
+# This file contains tests for the files tclCompile.c, tclCompCmds.c and
+# tclLiteral.c
 #
-# This file contains a collection of tests for one or more of the Tcl
-# built-in commands.  Sourcing this file into Tcl runs the tests and
-# generates output for errors.  No output means no errors were found.
+# This file contains a collection of tests for one or more of the Tcl built-in
+# commands. Sourcing this file into Tcl runs the tests and generates output
+# for errors. No output means no errors were found.
 #
 # Copyright (c) 1997 by Sun Microsystems, Inc.
 # Copyright (c) 1998-1999 by Scriptics Corporation.
 #
-# See the file "license.terms" for information on usage and redistribution
-# of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+# See the file "license.terms" for information on usage and redistribution of
+# this file, and for a DISCLAIMER OF ALL WARRANTIES.
 #
-# RCS: @(#) $Id: compile.test,v 1.52 2010/11/03 00:59:22 kennykb Exp $
+# RCS: @(#) $Id: compile.test,v 1.53 2011/01/01 15:14:43 dkf Exp $
 
 package require tcltest 2
 namespace import -force ::tcltest::*
@@ -28,10 +28,11 @@ catch {namespace delete test_ns_compile}
 catch {unset x}
 catch {unset y}
 catch {unset a}
-
-test compile-1.1 {TclCompileString: look up cmds in proc ns, not current ns} {
+
+test compile-1.1 {TclCompileString: look up cmds in proc ns, not current ns} -setup {
     catch {namespace delete test_ns_compile}
     catch {unset x}
+} -body {
     set x 123
     namespace eval test_ns_compile {
         proc set {args} {
@@ -43,63 +44,70 @@ test compile-1.1 {TclCompileString: look up cmds in proc ns, not current ns} {
         }
     }
     list [test_ns_compile::p] [set x]
-} {{123 test_ns_compile::set} {123 test_ns_compile::set}}
+} -result {{123 test_ns_compile::set} {123 test_ns_compile::set}}
 test compile-1.2 {TclCompileString, error result is reset if TclGetLong determines word isn't an integer} {
     proc p {x} {info commands 3m}
     list [catch {p} msg] $msg
 } {1 {wrong # args: should be "p x"}}
-test compile-2.1 {TclCompileDollarVar: global scalar name with ::s} {
+
+test compile-2.1 {TclCompileDollarVar: global scalar name with ::s} -setup {
     catch {unset x}
+} -body {
     set x 123
-    list $::x [expr {[lsearch -exact [info globals] x] != 0}]
-} {123 1}
-test compile-2.2 {TclCompileDollarVar: global scalar name with ::s} {
+    list $::x [expr {"x" in [info globals]}]
+} -result {123 1}
+test compile-2.2 {TclCompileDollarVar: global scalar name with ::s} -setup {
     catch {unset y}
+} -body {
     proc p {} {
         set ::y 789
         return $::y
     }
-    list [p] $::y [expr {[lsearch -exact [info globals] y] != 0}]
-} {789 789 1}
-test compile-2.3 {TclCompileDollarVar: global array name with ::s} {
+    list [p] $::y [expr {"y" in [info globals]}]
+} -result {789 789 1}
+test compile-2.3 {TclCompileDollarVar: global array name with ::s} -setup {
     catch {unset a}
+} -body {
     set ::a(1) 2
-    list $::a(1) [set ::a($::a(1)) 3] $::a(2) [expr {[lsearch -exact [info globals] a] != 0}]
-} {2 3 3 1}
-test compile-2.4 {TclCompileDollarVar: global scalar name with ::s} {
+    list $::a(1) [set ::a($::a(1)) 3] $::a(2) [expr {"a" in [info globals]}]
+} -result {2 3 3 1}
+test compile-2.4 {TclCompileDollarVar: global scalar name with ::s} -setup {
     catch {unset a}
+} -body {
     proc p {} {
         set ::a(1) 1
         return $::a($::a(1))
     }
-    list [p] $::a(1) [expr {[lsearch -exact [info globals] a] != 0}]
-} {1 1 1}
-test compile-2.5 {TclCompileDollarVar: global array, called as ${arrName(0)}} {
+    list [p] $::a(1) [expr {"a" in [info globals]}]
+} -result {1 1 1}
+test compile-2.5 {TclCompileDollarVar: global array, called as ${arrName(0)}} -setup {
     catch {unset a}
+} -body {
     proc p {} {
 	global a
         set a(1) 1
         return ${a(1)}$::a(1)$a(1)
     }
-    list [p] $::a(1) [expr {[lsearch -exact [info globals] a] != 0}]
-} {111 1 1}
+    list [p] $::a(1) [expr {"a" in [info globals]}]
+} -result {111 1 1}
 
-test compile-3.1 {TclCompileCatchCmd: only catch cmds with scalar vars are compiled inline} {
+test compile-3.1 {TclCompileCatchCmd: only catch cmds with scalar vars are compiled inline} -setup {
     catch {unset a}
+} -body {
     set a(1) xyzzyx
     proc p {} {
         global a
         catch {set x 123} a(1)
     }
     list [p] $a(1)
-} {0 123}
+} -result {0 123}
 test compile-3.2 {TclCompileCatchCmd: non-local variables} {
     set ::foo 1
     proc catch-test {} {
 	catch {set x 3} ::foo
     }
     catch-test
-    set ::foo
+    return $::foo
 } 3
 test compile-3.3 {TclCompileCatchCmd: overagressive compiling [bug 219184]} {
     proc catch-test {str} {
@@ -107,7 +115,7 @@ test compile-3.3 {TclCompileCatchCmd: overagressive compiling [bug 219184]} {
 	error BAD
     }
     catch {catch-test error} ::foo
-    set ::foo
+    return $::foo
 } {GOOD}
 test compile-3.4 {TclCompileCatchCmd: bcc'ed [return] is caught} {
     proc foo {} {
@@ -158,7 +166,6 @@ test compile-3.6 {TclCompileCatchCmd: error in storing result [Bug 3098302]} {*}
     -cleanup {namespace delete catchtest}
 }
 
-
 test compile-4.1 {TclCompileForCmd: command substituted test expression} {
     set i 0
     set j 0
@@ -187,29 +194,32 @@ test compile-5.2 {TclCompileForeachCmd: non-local variables} {
     set ::foo
 } 3
 
-test compile-6.1 {TclCompileSetCmd: global scalar names with ::s} {
+test compile-6.1 {TclCompileSetCmd: global scalar names with ::s} -setup {
     catch {unset x}
     catch {unset y}
+} -body {
     set x 123
     proc p {} {
         set ::y 789
         return $::y
     }
-    list $::x [expr {[lsearch -exact [info globals] x] != 0}] \
-         [p] $::y [expr {[lsearch -exact [info globals] y] != 0}]
-} {123 1 789 789 1}
-test compile-6.2 {TclCompileSetCmd: global array names with ::s} {
+    list $::x [expr {"x" in [info globals]}] \
+         [p] $::y [expr {"y" in [info globals]}]
+} -result {123 1 789 789 1}
+test compile-6.2 {TclCompileSetCmd: global array names with ::s} -setup {
     catch {unset a}
+} -body {
     set ::a(1) 2
     proc p {} {
         set ::a(1) 1
         return $::a($::a(1))
     }
-    list $::a(1) [p] [set ::a($::a(1)) 3] $::a(1) [expr {[lsearch -exact [info globals] a] != 0}]
-} {2 1 3 3 1}
-test compile-6.3 {TclCompileSetCmd: namespace var names with ::s} {
+    list $::a(1) [p] [set ::a($::a(1)) 3] $::a(1) [expr {"a" in [info globals]}]
+} -result {2 1 3 3 1}
+test compile-6.3 {TclCompileSetCmd: namespace var names with ::s} -setup {
     catch {namespace delete test_ns_compile}
     catch {unset x}
+} -body {
     namespace eval test_ns_compile {
         variable v hello
         variable arr
@@ -217,7 +227,7 @@ test compile-6.3 {TclCompileSetCmd: namespace var names with ::s} {
 	set ::test_ns_compile::arr(1) 123
     }
     list $::x $::test_ns_compile::arr(1)
-} {hello 123}
+} -result {hello 123}
 
 test compile-7.1 {TclCompileWhileCmd: command substituted test expression} {
     set i 0
@@ -258,53 +268,45 @@ test compile-10.1 {BLACKBOX: exception stack overflow} {
     }
 } {}
 
-test compile-11.1 {Tcl_Append*: ensure Tcl_ResetResult is used properly} {
-    proc p {} {
+test compile-11.1 {Tcl_Append*: ensure Tcl_ResetResult is used properly} -body {
+    apply {{} {
 	# shared object - Interp result && Var 'r'
 	set r [list foobar]
 	# command that will add error to result
 	lindex a bogus
-    }
-    list [catch {p} msg] $msg
-} {1 {bad index "bogus": must be integer?[+-]integer? or end?[+-]integer?}}
-test compile-11.2 {Tcl_Append*: ensure Tcl_ResetResult is used properly} {
-    proc p {} { set r [list foobar] ; string index a bogus }
-    list [catch {p} msg] $msg
-} {1 {bad index "bogus": must be integer?[+-]integer? or end?[+-]integer?}}
+    }}
+} -returnCodes error -result {bad index "bogus": must be integer?[+-]integer? or end?[+-]integer?}
+test compile-11.2 {Tcl_Append*: ensure Tcl_ResetResult is used properly} -body {
+    apply {{} { set r [list foobar] ; string index a bogus }}
+} -returnCodes error -result {bad index "bogus": must be integer?[+-]integer? or end?[+-]integer?}
 test compile-11.3 {Tcl_Append*: ensure Tcl_ResetResult is used properly} -body {
-    proc p {} { set r [list foobar] ; string index a 0o9 }
-    list [catch {p} msg] $msg
-} -match glob -result {1 {*invalid octal number*}}
-test compile-11.4 {Tcl_Append*: ensure Tcl_ResetResult is used properly} {
-    proc p {} { set r [list foobar] ; array set var {one two many} }
-    list [catch {p} msg] $msg
-} {1 {list must have an even number of elements}}
-test compile-11.5 {Tcl_Append*: ensure Tcl_ResetResult is used properly} {
-    proc p {} { set r [list foobar] ; incr foo bar baz}
-    list [catch {p} msg] $msg
-} {1 {wrong # args: should be "incr varName ?increment?"}}
-test compile-11.6 {Tcl_Append*: ensure Tcl_ResetResult is used properly} {
-    proc p {} { set r [list foobar] ; incr}
-    list [catch {p} msg] $msg
-} {1 {wrong # args: should be "incr varName ?increment?"}}
+    apply {{} { set r [list foobar] ; string index a 0o9 }}
+} -returnCodes error -match glob -result {*invalid octal number*}
+test compile-11.4 {Tcl_Append*: ensure Tcl_ResetResult is used properly} -body {
+    apply {{} { set r [list foobar] ; array set var {one two many} }}
+} -returnCodes error -result {list must have an even number of elements}
+test compile-11.5 {Tcl_Append*: ensure Tcl_ResetResult is used properly} -body {
+    apply {{} { set r [list foobar] ; incr foo bar baz}}
+} -returnCodes error -result {wrong # args: should be "incr varName ?increment?"}
+test compile-11.6 {Tcl_Append*: ensure Tcl_ResetResult is used properly} -body {
+    apply {{} { set r [list foobar] ; incr}}
+} -returnCodes error -result {wrong # args: should be "incr varName ?increment?"}
 test compile-11.7 {Tcl_Append*: ensure Tcl_ResetResult is used properly} -body {
-    proc p {} { set r [list foobar] ; expr !a }
-    p
+    apply {{} { set r [list foobar] ; expr !a }}
 } -returnCodes error -match glob -result *
 test compile-11.8 {Tcl_Append*: ensure Tcl_ResetResult is used properly} -body {
-    proc p {} { set r [list foobar] ; expr {!a} }
-    p
+    apply {{} { set r [list foobar] ; expr {!a} }}
 } -returnCodes error -match glob -result *
-test compile-11.9 {Tcl_Append*: ensure Tcl_ResetResult is used properly} {
-    proc p {} { set r [list foobar] ; llength "\{" }
+test compile-11.9 {Tcl_Append*: ensure Tcl_ResetResult is used properly} -body {
+    apply {{} { set r [list foobar] ; llength "\{" }}
     list [catch {p} msg] $msg
-} {1 {unmatched open brace in list}}
+} -returnCodes error -result {unmatched open brace in list}
 
 # 
 # Special section for tests of tclLiteral.c
 # The following tests check for incorrect memory handling in
-# TclReleaseLiteral. They are only effective when tcl is compiled 
-# with TCL_MEM_DEBUG
+# TclReleaseLiteral. They are only effective when tcl is compiled with
+# TCL_MEM_DEBUG
 #
 # Special test for leak on interp delete [Bug 467523]. 
 test compile-12.1 {testing literal leak on interp delete} -setup {
@@ -328,9 +330,9 @@ test compile-12.1 {testing literal leak on interp delete} -setup {
     rename getbytes {}
     unset -nocomplain end i tmp leakedBytes
 } -result 0
-# Special test for a memory error in a preliminary fix of [Bug 467523]. 
-# It requires executing a helpfile.  Presumably the child process is
-# used because when this test fails, it crashes.
+# Special test for a memory error in a preliminary fix of [Bug 467523].  It
+# requires executing a helpfile.  Presumably the child process is used because
+# when this test fails, it crashes.
 test compile-12.2 {testing error on literal deletion} -constraints {memory exec} -body {
     set sourceFile [makeFile {
 	for {set i 0} {$i < 5} {incr i} {
@@ -355,29 +357,28 @@ test compile-12.3 {check for a buffer overrun} -body {
 test compile-12.4 {TclCleanupLiteralTable segfault} -body {
     # Tcl Bug 1001997
     # Here, we're trying to test a case that causes a crash in
-    # TclCleanupLiteralTable.  The conditions that we're trying to
-    # establish are:
-    # - TclCleanupLiteralTable is attempting to clean up a bytecode
-    #   object in the literal table.
-    # - The bytecode object in question contains the only reference
-    #   to another literal.
+    # TclCleanupLiteralTable.  The conditions that we're trying to establish
+    # are:
+    # - TclCleanupLiteralTable is attempting to clean up a bytecode object in
+    #   the literal table.
+    # - The bytecode object in question contains the only reference to another
+    #   literal.
     # - The literal in question is in the same hash bucket as the bytecode
     #   object, and immediately follows it in the chain.
-    # Since newly registered literals are added at the FRONT of the
-    # bucket chains, and since the bytecode object is registered before
-    # its literals, this is difficult to achieve.  What we do is:
-    #  (a) do a [namespace eval] of a string that's calculated to
-    #      hash into the same bucket as a literal that it contains.
-    #      In this case, the script and the variable 'bugbug' 
-    #      land in the same bucket.
-    #  (b) do a [namespace eval] of a string that contains enough
-    #      literals to force TclRegisterLiteral to rebuild the global
-    #      literal table.  The newly created hash buckets will contain
-    #      the literals, IN REVERSE ORDER, thus putting the bytecode
-    #      immediately ahead of 'bugbug' and 'bug4345bug'.  The bytecode
-    #      object will contain the only references to those two literals.
-    #  (c) Delete the interpreter to invoke TclCleanupLiteralTable
-    #      and tickle the bug.
+    # Since newly registered literals are added at the FRONT of the bucket
+    # chains, and since the bytecode object is registered before its literals,
+    # this is difficult to achieve.  What we do is:
+    #  (a) do a [namespace eval] of a string that's calculated to hash into
+    #      the same bucket as a literal that it contains.  In this case, the
+    #      script and the variable 'bugbug' land in the same bucket.
+    #  (b) do a [namespace eval] of a string that contains enough literals to
+    #      force TclRegisterLiteral to rebuild the global literal table.  The
+    #      newly created hash buckets will contain the literals, IN REVERSE
+    #      ORDER, thus putting the bytecode immediately ahead of 'bugbug' and
+    #      'bug4345bug'.  The bytecode object will contain the only references
+    #      to those two literals.
+    #  (c) Delete the interpreter to invoke TclCleanupLiteralTable and tickle
+    #      the bug.
     proc foo {} {
 	set i [interp create]
 	$i eval {
@@ -411,9 +412,8 @@ test compile-12.4 {TclCleanupLiteralTable segfault} -body {
     rename foo {}
 } -result ok
 
-# Special test for underestimating the maxStackSize required for a
-# compiled command. A failure will cause a segfault in the child 
-# process.
+# Special test for underestimating the maxStackSize required for a compiled
+# command. A failure will cause a segfault in the child process.
 test compile-13.1 {testing underestimate of maxStackSize in list cmd} {exec} {
     set body {set x [list}
     for {set i 0} {$i < 3000} {incr i} {
@@ -424,8 +424,8 @@ test compile-13.1 {testing underestimate of maxStackSize in list cmd} {exec} {
     list [catch {exec [interpreter] << $script} msg] $msg
 } {0 OK}
 
-# Special test for compiling tokens from a copy of the source
-# string [Bug #599788]
+# Special test for compiling tokens from a copy of the source string. [Bug
+# 599788]
 test compile-14.1 {testing errors in element name; segfault?} {} {
      catch {set a([error])} msg1
      catch {set bubba([join $abba $jubba]) $vol} msg2
@@ -434,34 +434,19 @@ test compile-14.1 {testing errors in element name; segfault?} {} {
 
 # Tests compile-15.* cover Tcl Bug 633204
 test compile-15.1 {proper TCL_RETURN code from [return]} {
-    proc p {} {catch return}
-    set result [p]
-    rename p {}
-    set result
+    apply {{} {catch return}}
 } 2
 test compile-15.2 {proper TCL_RETURN code from [return]} {
-    proc p {} {catch {return foo}}
-    set result [p]
-    rename p {}
-    set result
+    apply {{} {catch {return foo}}}
 } 2
 test compile-15.3 {proper TCL_RETURN code from [return]} {
-    proc p {} {catch {return $::tcl_library}}
-    set result [p]
-    rename p {}
-    set result
+    apply {{} {catch {return $::tcl_library}}}
 } 2
 test compile-15.4 {proper TCL_RETURN code from [return]} {
-    proc p {} {catch {return [info library]}}
-    set result [p]
-    rename p {}
-    set result
+    apply {{} {catch {return [info library]}}}
 } 2
 test compile-15.5 {proper TCL_RETURN code from [return]} {
-    proc p {} {catch {set a 1}; return}
-    set result [p]
-    rename p {}
-    set result
+    apply {{} {catch {set a 1}; return}}
 } ""
 
 for {set noComp 0} {$noComp <= 1} {incr noComp} {
@@ -536,17 +521,16 @@ test compile-16.17.$noComp {TclCompileScript: word expansion} $constraints {
     run {list {*}x y z}
 } {x y z}
 
-# These tests note that expansion can in theory cause the number of
-# arguments to a command to exceed INT_MAX, which is as big as objc
-# is allowed to get.
+# These tests note that expansion can in theory cause the number of arguments
+# to a command to exceed INT_MAX, which is as big as objc is allowed to get.
 #
-# In practice, it seems we will run out of memory before we confront
-# this issue.  Note that compiled operations run out of memory at
-# smaller objc values than direct string evaluation.
+# In practice, it seems we will run out of memory before we confront this
+# issue. Note that compiled operations run out of memory at smaller objc
+# values than direct string evaluation.
 #
-# These tests are constrained as knownBug because they are likely
-# to cause memory allocation panics somewhere, and we don't want
-# panics in the test suite.
+# These tests are constrained as knownBug because they are likely to cause
+# memory allocation panics somewhere, and we don't want panics in the test
+# suite.
 #
 test compile-16.18.$noComp {TclCompileScript: word expansion} -body {
     proc LongList {} {return [lrepeat [expr {1<<10}] x]}
@@ -608,8 +592,8 @@ test compile-16.26.$noComp {TclCompileScript: word expansion, protected backslas
 } {a {\n} b}
 }	;# End of noComp loop
 
-# These tests are messy because it wrecks the interpreter it runs in!
-# They demonstrate issues arising from [FRQ 1101710]
+# These tests are messy because it wrecks the interpreter it runs in!  They
+# demonstrate issues arising from [FRQ 1101710]
 test compile-17.1 {Command interpretation binding for compiled code} -constraints knownBug -setup {
     set i [interp create]
 } -body {
@@ -723,7 +707,7 @@ test compile-18.19 {disassembler - basics} -setup {
     foo destroy
 } -match glob -result *
 # TODO sometime - check that bytecode from tbcload is *not* disassembled.
-
+
 # cleanup
 catch {rename p ""}
 catch {namespace delete test_ns_compile}
@@ -732,3 +716,8 @@ catch {unset y}
 catch {unset a}
 ::tcltest::cleanupTests
 return
+
+# Local Variables:
+# mode: tcl
+# fill-column: 78
+# End: