aboutsummaryrefslogtreecommitdiff
path: root/lib/ssh.exp
blob: 3c7b840f6f9e394b9ee091dcdb53440002dd3e70 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# Copyright (C) 2016-2019, 2020 Free Software Foundation, Inc.
#
# This file is part of DejaGnu.
#
# DejaGnu 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.
#
# DejaGnu 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 DejaGnu; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.

# Connect using ssh(1).

set ssh_initialized "no"
set ssh_useropts " -o ControlPersist=yes -o ControlMaster=auto -o ControlPath=\"/tmp/ssh-%r@%h:%p\""

# Default to the ssh and scp in the user's path.
set SSH ssh
set SCP scp

# Download SRCFILE to DESTFILE on DESTHOST.
#
proc ssh_download {desthost srcfile destfile} {
    global SSH SCP ssh_initialized timeout

    set ssh_port ""
    set ssh_user ""
    set ssh_useropts ""
    set name ""
    set hostname ""

    if {[board_info $desthost exists scp_prog]} {
	set SCP [board_info $desthost scp_prog]
    }

    if {[board_info $desthost exists ssh_prog]} {
	set SSH [board_info $desthost ssh_prog]
    }

    # The default user name is the person running the tests
    if {[board_info $desthost exists username]} {
	set ssh_user "[board_info $desthost username]@"
    }

    if {[board_info $desthost exists ssh_opts]} {
	append ssh_useropts " [board_info $desthost ssh_opts]"
    }

    # The default SSH port is 22
    if {[board_info $desthost exists port]} {
	set ssh_port "[board_info $desthost port]"
    } else {
	set ssh_port 22
    }

    if {[board_info $desthost exists name]} {
	set name [board_info $desthost name]
    }

    if {[board_info $desthost exists hostname]} {
	set hostname [board_info $desthost hostname]
    } else {
	set hostname $desthost
    }

    append ssh_useropts " -o ControlPersist=yes -o ControlMaster=auto -o ControlPath=/tmp/ssh-%r@%h:%p"

    set ret [local_exec "$SCP -P $ssh_port $ssh_useropts $srcfile $ssh_user$hostname:$destfile" "" "" $timeout]
    set status [lindex $ret 0]
    set output [lindex $ret 1]
    if { $status == 0 } {
	set ssh_initialized "yes"
	verbose "Copied $srcfile to $desthost:$destfile" 2
	return $destfile
    } else {
	verbose "Download via ssh to $desthost failed."
	return ""
    }
}

proc ssh_upload {desthost srcfile destfile} {
    global SSH SCP

    if {[board_info $desthost exists scp_prog]} {
	set SCP [board_info $desthost scp_prog]
    }

    if {[board_info $desthost exists username]} {
	set ssh_user "[board_info $desthost username]@"
    } else {
	set ssh_user ""
    }

    if {[board_info $desthost exists name]} {
	set desthost [board_info $desthost name]
    }

    if {[board_info $desthost exists hostname]} {
	set desthost [board_info $desthost hostname]
    }

    set status [catch "exec $SCP $ssh_user$desthost:$srcfile $destfile" output]
    if { $status == 0 } {
	verbose "Copied $desthost:$srcfile to $destfile" 2
	return $destfile
    } else {
	verbose "Upload from $desthost failed, $output."
	return ""
    }
}

# Execute CMD on BOARDNAME.
#
proc ssh_exec { boardname program pargs inp outp } {
    global SSH timeout

    set ssh_port ""
    set scp_port ""
    set ssh_user ""
    set ssh_useropts ""
    set name ""
    set hostname ""

    verbose "Executing on $boardname: $program $pargs"

    if {![board_info $boardname exists ssh_prog]} {
	set SSH ssh
    } else {
	set SSH [board_info $boardname ssh_prog]
    }

    if {[board_info $boardname exists username]} {
	set ssh_user "[board_info $boardname username]@"
    } else {
	set ssh_user ""
    }

    if {[board_info $boardname exists ssh_useropts]} {
	append ssh_useropts " [board_info $boardname ssh_opts]"
    }

    if {[board_info $boardname exists name]} {
	set boardname [board_info $boardname name]
    }

    if {[board_info $boardname exists hostname]} {
	set hostname [board_info $boardname hostname]
    } else {
	set hostname $boardname
    }

    if {[board_info $boardname  exists port]} {
	append ssh_useropts " -p [board_info $boardname port]"
    }

    append ssh_useropts " -o ControlPersist=yes -o ControlMaster=auto -o ControlPath=\"/tmp/ssh-%r@%h:%p\""

    # If CMD sends any output to stderr, exec will think it failed.
    # More often than not that will be true, but it doesn't catch the
    # case where there is no output but the exit code is non-zero.
    if { $inp eq "" } {
	set inp "/dev/null"
    }

    # We use && here, as otherwise the echo always works, which makes it look
    # like execution succeeded when in reality it failed.
    set ret [local_exec "$SSH $ssh_useropts $ssh_user$hostname sh -c '$program $pargs 2>&1 && echo XYZ\\\${?}ZYX \\; rm -f $program'" $inp $outp $timeout]
    set status [lindex $ret 0]
    set output [lindex $ret 1]

    verbose "$SSH status is $status, output is $output"

    # `status' doesn't mean much here other than ssh worked ok.
    # What we want is whether $program ran ok.  Return $status
    # if the program timed out, status will be 1 indicating that
    # ssh ran and failed.  If ssh fails, we will get FAIL rather
    # than UNRESOLVED - this will help the problem be noticed.
    if { $status != 0 } {
	regsub "XYZ(\[0-9\]*)ZYX\n?" $output "" output
	return [list $status "$SSH to $boardname failed for $program, $output"]
    }
    if { [regexp "XYZ(\[0-9\]*)ZYX" $output junk status] == 0 } {
	set status ""
    }
    verbose "ssh_exec: status:$status text:$output" 4
    if { $status eq "" } {
	return [list -1 "Couldn't parse $SSH output, $output."]
    }
    regsub "XYZ(\[0-9\]*)ZYX\n?" $output "" output
    return [list [expr {$status != 0}] $output]
}

proc ssh_close { desthost } {
    global SSH ssh_initialized

    verbose "Closing the SSH connection to $desthost"

    set ssh_port ""
    set scp_port ""
    set ssh_user ""
    set ssh_useropts ""
    set name ""
    set hostname ""

    if {[board_info $desthost exists username]} {
	set ssh_useropts "-l [board_info $desthost username]"
	set ssh_user "[board_info $desthost username]@"
    } else {
	set ssh_user ""
	set ssh_useropts ""
    }

    if {[board_info $desthost exists hostname]} {
	set hostname [board_info $desthost hostname]
    }

    if {[board_info $desthost exists ssh_opts]} {
	append ssh_useropts " [board_info $desthost ssh_opts]"
    }

    if {[board_info $desthost exists port]} {
	set ssh_port " -p [board_info $desthost port]"
    } else {
	set ssh_port ""
    }

    set args "$ssh_user$hostname $ssh_port"

   # Kill the remote server
    set status [catch "exec ssh $ssh_port -o ControlPath=/tmp/ssh-%r@%h:%p -O exit $args"]
    set ssh_initialized "no"

     return ""
}