[gdb/testsuite] Add gdb.testsuite/board-sanity.exp

Add a test-case that tests the sanity of target/host boards.

It contains a number of tests related to remote file manipulation, exercising:
- remote_upload
- remote_download
- remote_file exists
- remote_file delete
which check that these work together as expected.

Tested on x86_64-linux, with all relevant gdb/testsuite/boards/*.exp boards.

For target board remote-stdio-gdbserver.exp, this revealed a trivial problem
with the return value of proc ${board}_file for delete, so fix this.

The test-case shows that the proc ${board}_download in
local-remote-host-native.exp is broken, so remove it.

Likewise for board local-remote-host.exp, so remove proc ${board}_download and
associated ${board}_file.

Tested on x86_64-linux.

4 files changed, 124 insertions, 42 deletions

diff --git a/gdb/testsuite/boards/local-remote-host-native.exp b/gdb/testsuite/boards/local-remote-host-native.exp
index 6409ac4..911310b 100644
--- a/gdb/testsuite/boards/local-remote-host-native.exp
+++ b/gdb/testsuite/boards/local-remote-host-native.exp
@@ -50,14 +50,6 @@ set_board_info rsh_prog /usr/bin/ssh
 set_board_info rcp_prog /usr/bin/scp
 set_board_info file_transfer "rsh"
 
-if { ![info exists HOST_DIR] } {
-    set HOST_DIR [file join [pwd] "remote-host"]
-}
-
-if { $board_type == "host" } {
-    set_board_info gdb_opts "-d \"${HOST_DIR}\""
-}
-
 proc ${board}_spawn { board cmd } {
     global board_info
 
@@ -70,20 +62,6 @@ proc ${board}_spawn { board cmd } {
     return $spawn_id
 }
 
-proc ${board}_download { board src dest } {
-    global HOST_DIR
-
-    if { ![file exists $HOST_DIR] } {
-	file mkdir $HOST_DIR
-    }
-
-    set destfile [file join $HOST_DIR $dest]
-    verbose -log "${board}_download: file copy -force $src $destfile"
-    file copy -force $src $destfile
-
-    return $destfile
-}
-
 if { $board_type == "host" } {
     set GDBFLAGS "${GDBFLAGS} -iex \"set style enabled off\""
 }
diff --git a/gdb/testsuite/boards/local-remote-host.exp b/gdb/testsuite/boards/local-remote-host.exp
index ff74183..e208504 100644
--- a/gdb/testsuite/boards/local-remote-host.exp
+++ b/gdb/testsuite/boards/local-remote-host.exp
@@ -35,25 +35,6 @@ set_board_info rsh_prog /usr/bin/ssh
 set_board_info rcp_prog /usr/bin/scp
 set_board_info file_transfer "rsh"
 
-proc ${board}_file { dest op args } {
-    if { $op == "delete" } {
-	return 0
-    }
-    return [eval [list standard_file $dest $op] $args]
-}
-
-proc ${board}_download { board src dest } {
-
-    # If file name is a relative, convert it to absolute, otherwise file can't
-    # be found on host, because the current directory usually is /home/$USER.
-    # This also bypasses the real download to the host.
-    if { [file pathtype $src] == "relative" } {
-	return [file join [pwd] $src]
-    } else {
-	return $src
-    }
-}
-
 # Like standard_spawn, but force pseudo-tty allocation, with 'ssh -t'.
 
 proc ${board}_spawn { board cmd } {
diff --git a/gdb/testsuite/boards/remote-stdio-gdbserver.exp b/gdb/testsuite/boards/remote-stdio-gdbserver.exp
index 479dfb0..53e40d8 100644
--- a/gdb/testsuite/boards/remote-stdio-gdbserver.exp
+++ b/gdb/testsuite/boards/remote-stdio-gdbserver.exp
@@ -72,7 +72,8 @@ proc get_target_remote_pipe_cmd { } {
 
 proc ${board}_file { dest op args } {
     if { $op == "delete" } {
-	return [remote_exec target "rm -f $args"]
+	set res [remote_exec target "rm -f $args"]
+	return [lindex $res 0]
     }
     return [eval [list standard_file $dest $op] $args]
 }
diff --git a/gdb/testsuite/gdb.testsuite/board-sanity.exp b/gdb/testsuite/gdb.testsuite/board-sanity.exp
new file mode 100644
index 0000000..b2b3690
--- /dev/null
+++ b/gdb/testsuite/gdb.testsuite/board-sanity.exp
@@ -0,0 +1,122 @@
+# Copyright 2023 Free Software Foundation, Inc.
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# The purpose of this test-case is to test the sanity of the used host/target
+# board files.
+
+proc test_remote { remote host_is_target } {
+    global srcdir subdir
+
+    set file board-sanity.exp
+
+    set shell_ok 0
+    set delete_ok 0
+    set exists_ok 1
+
+    if { $host_is_target } {
+	if { $remote == "host" } {
+	    set other_remote "target"
+	} else {
+	    set other_remote "host"
+	}
+    }
+
+    with_test_prefix cleanup-remote {
+	set res [remote_file $remote delete $file]
+	gdb_assert { [lindex $res 0] == $delete_ok } \
+	    "remove $remote copy "
+
+	set res [remote_file $remote exists $file]
+	gdb_assert { $res != $exists_ok } \
+	    "$remote copy does not exist"
+
+	if { $host_is_target } {
+	    set res [remote_file $other_remote exists $file]
+	    gdb_assert { $res != $exists_ok } \
+		"$other_remote copy does not exist"	
+	}
+    }
+
+    with_test_prefix copy-to-remote {
+	set remote_file [remote_download $remote $srcdir/$subdir/$file]
+	gdb_assert { [string equal [file tail $remote_file] $file] == 1} \
+	    "remote_download returns valid value"
+
+	set res [remote_file $remote exists $file]
+	gdb_assert { $res == $exists_ok } \
+	    "$remote copy exists"
+
+	if { $host_is_target } {
+	    set res [remote_file $other_remote exists $file]
+	    gdb_assert { $res == $exists_ok } \
+		"$other_remote copy exists"
+	}
+    }
+
+    with_test_prefix cleanup-build {
+	    # Note: we're not comparing with delete_ok, return value seems to be
+	    # different for build.
+	    set res [remote_file build delete $file]
+	    gdb_assert { [string equal $res ""] } \
+		"remove build copy"
+
+	    set res [remote_file build exists $file]
+	    gdb_assert { $res != $exists_ok } \
+		"build copy does not exist"
+	}
+
+    with_test_prefix copy-from-remote {
+	# Note: we're using $remote_file here instead of $file, otherwise
+	# this breaks with board_info remotedir.
+	set build_file [remote_upload $remote $remote_file]
+	gdb_assert { [string equal [file tail $build_file] $file] == 1 } \
+	    "remote_upload returns valid value"
+	
+	set res [remote_file $remote delete $file]
+	gdb_assert { [string equal $res $delete_ok] == 1 } \
+	    "remove $remote copy"
+
+	set res [remote_file $remote exists $file]
+	gdb_assert { $res != $exists_ok } \
+	    "$remote copy does not exist"
+
+	if { $host_is_target } {
+	    set res [remote_file $other_remote exists $file]
+	    gdb_assert { $res != $exists_ok } \
+		"$other_remote copy does not exist"	
+	}
+
+	set res [remote_file build exists $file]
+	gdb_assert { $res == $exists_ok } \
+	    "build copy exists"
+
+	set res [remote_file $remote delete $file]
+	gdb_assert { $res == $delete_ok } \
+	    "remove build copy"
+    }
+}
+
+# Host_is_target == 1 for local-remote-host-native.exp, if as intended specified
+# with both --target_board and --host_board.
+if { [info exists host_board] } {
+    set host_is_target [string equal $host_board [target_info name]]
+} else {
+    set host_is_target 0
+}
+
+foreach_with_prefix remote {host target} {
+    if { [is_remote $remote] } {
+	test_remote $remote $host_is_target
+    }
+}