[gdb/testsuite] Don't leak tuiterm.exp spawn override
authorTom de Vries <tdevries@suse.de>
Fri, 12 Jun 2020 11:29:43 +0000 (13:29 +0200)
committerTom de Vries <tdevries@suse.de>
Fri, 12 Jun 2020 11:29:43 +0000 (13:29 +0200)
In lib/tuiterm.exp the builtin spawn is overridden by a tui-specific version.

After running the first test-case that imports tuiterm.exp, the override
remains active, so it can cause trouble in subsequent test-cases, even if they
do not import tuiterm.exp.  See f.i. commit c8d4f6dfd9 "[gdb/testsuite] Fix
spawn in tuiterm.exp".

Fix this by:
- adding a variable gdb_finish_hooks which is a list of procs to run during
  gdb_finish
- adding a proc tuiterm_env that is used in test-cases instead of
  "load_lib tuiterm.exp".
- letting tuiterm_env:
  - install the tui-specific spawn version, and
  - use the gdb_finish_hooks to schedule restoring the builtin spawn
    version.

Tested on x86_64-linux.

gdb/testsuite/ChangeLog:

2020-06-12  Tom de Vries  <tdevries@suse.de>

* lib/tuiterm.exp (spawn): Rename to ...
(tui_spawn): ... this.
(toplevel): Move rename of spawn ...
(gdb_init_tuiterm): ... here.  New proc.
(gdb_finish_tuiterm): New proc.
* lib/gdb.exp (gdb_finish_hooks): New global var.
(gdb_finish): Handle gdb_finish_hooks.
(tuiterm_env): New proc.
* gdb.python/tui-window.exp: Replace load_lib tuiterm.exp with
tuiterm_env.
* gdb.tui/basic.exp: Same.
* gdb.tui/corefile-run.exp: Same.
* gdb.tui/empty.exp: Same.
* gdb.tui/list-before.exp: Same.
* gdb.tui/list.exp: Same.
* gdb.tui/main.exp: Same.
* gdb.tui/new-layout.exp: Same.
* gdb.tui/regs.exp: Same.
* gdb.tui/resize.exp: Same.
* gdb.tui/tui-layout-asm-short-prog.exp: Same.
* gdb.tui/tui-layout-asm.exp: Same.
* gdb.tui/tui-missing-src.exp: Same.
* gdb.tui/winheight.exp: Same.

17 files changed:
gdb/testsuite/ChangeLog
gdb/testsuite/gdb.python/tui-window.exp
gdb/testsuite/gdb.tui/basic.exp
gdb/testsuite/gdb.tui/corefile-run.exp
gdb/testsuite/gdb.tui/empty.exp
gdb/testsuite/gdb.tui/list-before.exp
gdb/testsuite/gdb.tui/list.exp
gdb/testsuite/gdb.tui/main.exp
gdb/testsuite/gdb.tui/new-layout.exp
gdb/testsuite/gdb.tui/regs.exp
gdb/testsuite/gdb.tui/resize.exp
gdb/testsuite/gdb.tui/tui-layout-asm-short-prog.exp
gdb/testsuite/gdb.tui/tui-layout-asm.exp
gdb/testsuite/gdb.tui/tui-missing-src.exp
gdb/testsuite/gdb.tui/winheight.exp
gdb/testsuite/lib/gdb.exp
gdb/testsuite/lib/tuiterm.exp

index ff834b7e3a0028cd4cb8c113c3b27f15dbdc8ad7..ef36759304f2ba4c8446bc30071ff279cbbfa961 100644 (file)
@@ -1,3 +1,29 @@
+2020-06-12  Tom de Vries  <tdevries@suse.de>
+
+       * lib/tuiterm.exp (spawn): Rename to ...
+       (tui_spawn): ... this.
+       (toplevel): Move rename of spawn ...
+       (gdb_init_tuiterm): ... here.  New proc.
+       (gdb_finish_tuiterm): New proc.
+       * lib/gdb.exp (gdb_finish_hooks): New global var.
+       (gdb_finish): Handle gdb_finish_hooks.
+       (tuiterm_env): New proc.
+       * gdb.python/tui-window.exp: Replace load_lib tuiterm.exp with
+       tuiterm_env.
+       * gdb.tui/basic.exp: Same.
+       * gdb.tui/corefile-run.exp: Same.
+       * gdb.tui/empty.exp: Same.
+       * gdb.tui/list-before.exp: Same.
+       * gdb.tui/list.exp: Same.
+       * gdb.tui/main.exp: Same.
+       * gdb.tui/new-layout.exp: Same.
+       * gdb.tui/regs.exp: Same.
+       * gdb.tui/resize.exp: Same.
+       * gdb.tui/tui-layout-asm-short-prog.exp: Same.
+       * gdb.tui/tui-layout-asm.exp: Same.
+       * gdb.tui/tui-missing-src.exp: Same.
+       * gdb.tui/winheight.exp: Same.
+
 2020-06-12  Tom de Vries  <tdevries@suse.de>
 
        PR testsuite/26110
index 1a4feebe22bf9ce672bbab41311ef28324f44cee..503823a2296d6e45b77890aee275be4631f99e19 100644 (file)
@@ -16,7 +16,7 @@
 # Test a TUI window implemented in Python.
 
 load_lib gdb-python.exp
-load_lib tuiterm.exp
+tuiterm_env
 
 # This test doesn't care about the inferior.
 standard_testfile py-arch.c
index 34e60384c4ede1fbf235173b97119ccd1daf1422..3e013a95151c297cd7c4b40a5b19d766d6cf0f36 100644 (file)
@@ -15,7 +15,7 @@
 
 # Basic TUI tests.
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout.c
 
index 440142f74e8b3e111fd589ca65f1dc460572e923..1878770bdcd146d050a6c49f8b1ed27096aaf5f1 100644 (file)
@@ -18,7 +18,7 @@
 #
 # Ref.: https://bugzilla.redhat.com/show_bug.cgi?id=1765117
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout.c
 
index e5d0228062b32d53ad4103e0138e0d28c84e68a6..89f49d6b7f9a35107732111f878b88d2dae5cfd4 100644 (file)
@@ -15,7 +15,7 @@
 
 # Test TUI resizing with empty windows.
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile
 
index d2f3ef472dd21f9ae146f8ffd282e019d3e90917..9c5eb5655ea93e48ec0bdb9e9a3489036f8a2679 100644 (file)
@@ -15,7 +15,7 @@
 
 # Ensure that "list" before starting the TUI will affect the view.
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout.c
 
index 41cec125d534dcaa3cc62d7c4eeaf335eed244f9..b1e59499c87e13a86cde047d87cad83cd1437215 100644 (file)
@@ -15,7 +15,7 @@
 
 # Ensure that "list" will switch to the source view.
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout.c
 
index ae2393e6e98cba5e32821c80c7da533db26c6f14..fd3c2cd8157b04271998a39edc93e0c667555758 100644 (file)
@@ -15,7 +15,7 @@
 
 # Test that "file" shows "main".
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout.c
 
index b71de7de5fa1e4d4ea676fad04a9ff29316930f7..3ea4dd4069932b9c25a8b200f8c8e145c67eb1a4 100644 (file)
@@ -15,7 +15,7 @@
 
 # Test "tui new-layout".
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout.c
 
index e31a47d47bb832003afce9b212b25313911fa35f..a9296a7d5faabd5bdf86fed9270bc06df73991de 100644 (file)
@@ -15,7 +15,7 @@
 
 # Simple test of TUI register window.
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout.c
 
index 1b3f407a02d2231a78fcec542622f6edbffdccd3..fd1b35088af0ae127b63f4bd9e43953b2cbe3c36 100644 (file)
@@ -15,7 +15,7 @@
 
 # Test TUI resizing.
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout.c
 
index 4aa1ba3046df41fd67b6f6aaeab50c85cc4e220c..50cb61f0faa2927bc4b5e8f2aae2af7c5f108ddb 100644 (file)
@@ -16,7 +16,7 @@
 # Ensure that 'layout asm' can scroll away from the last line of a
 # very short program using a page up sized scroll.
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout-asm-short-prog.S
 
index 257321fec75b17431923e713ab2ea9f4b3af0266..44f7a3a3a4f5cbbdf3d7c8ebacf15de822402b08 100644 (file)
@@ -16,7 +16,7 @@
 # Ensure that 'layout asm' before starting the inferior puts us in the
 # asm layout and displays the disassembly for main.
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout.c
 
index 2d9a851bec199f2e09ad635726ac0b73050cf119..6b5c7fad4c414cf5dbcfa5557b4a9274909c3a19 100644 (file)
@@ -25,7 +25,7 @@
 #    layout must show the contents of f2.c.
 # 7. Going back to main() shall result in no contents again.
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile
 
index 7a17c311ea57e44eb8ad7b528ec8d43754dcf752..8ac55f847236206b631a9ca038b6d38aba7b87c6 100644 (file)
@@ -15,7 +15,7 @@
 
 # Test the "winheight" command.
 
-load_lib "tuiterm.exp"
+tuiterm_env
 
 standard_testfile tui-layout.c
 
index 64e667c20e04846cdd94e921dd7e3bc60fe93ce2..e7fce6fee0ba0b49f088dd96dfa73149f73cc0df 100644 (file)
@@ -25,6 +25,9 @@ if {$tool == ""} {
     exit 2
 }
 
+# List of procs to run in gdb_finish.
+set gdb_finish_hooks [list]
+
 load_lib libgloss.exp
 load_lib cache.exp
 load_lib gdb-utils.exp
@@ -5241,6 +5244,12 @@ proc gdb_finish { } {
        }
        set banned_traced 0
     }
+
+    global gdb_finish_hooks
+    foreach gdb_finish_hook $gdb_finish_hooks {
+       $gdb_finish_hook
+    }
+    set gdb_finish_hooks [list]
 }
 
 global debug_format
@@ -7259,5 +7268,19 @@ proc with_override { name override body } {
     return $result
 }
 
+# Setup tuiterm.exp environment.  To be used in test-cases instead of
+# "load_lib tuiterm.exp".  Calls initialization function and schedules
+# finalization function.
+proc tuiterm_env { } {
+    load_lib tuiterm.exp
+
+    # Do initialization.
+    tuiterm_env_init
+
+    # Schedule finalization.
+    global gdb_finish_hooks
+    lappend gdb_finish_hooks tuiterm_env_finish
+}
+
 # Always load compatibility stuff.
 load_lib future.exp
index 8c9f97af6ec5c035eb63ac19b2d46146911f12d7..44cbc79730adfd2bd568e2c7757c603c66a94cbd 100644 (file)
@@ -19,8 +19,7 @@
 # array; but dejagnu doesn't export this globally.  So, we have to
 # wrap spawn with our own function, so that we can capture this value.
 # The value is later used in calls to stty.
-rename spawn builtin_spawn
-proc spawn {args} {
+proc tuiterm_spawn { args } {
     set result [uplevel builtin_spawn $args]
     global gdb_spawn_name
     upvar spawn_out spawn_out
@@ -32,6 +31,20 @@ proc spawn {args} {
     return $result
 }
 
+# Initialize tuiterm.exp environment.
+proc tuiterm_env_init { } {
+    # Override spawn with tui_spawn.
+    rename spawn builtin_spawn
+    rename tuiterm_spawn spawn
+}
+
+# Finalize tuiterm.exp environment.
+proc tuiterm_env_finish { } {
+    # Restore spawn.
+    rename spawn tuiterm_spawn
+    rename builtin_spawn spawn
+}
+
 namespace eval Term {
     variable _rows
     variable _cols