3 #########################################################################
4 # This program is free software: you can redistribute it and/or modify #
5 # it under the terms of the version 3 of the GNU General Public License #
6 # as published by the Free Software Foundation. #
8 # This program is distributed in the hope that it will be useful, but #
9 # WITHOUT ANY WARRANTY; without even the implied warranty of #
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU #
11 # General Public License for more details. #
13 # You should have received a copy of the GNU General Public License #
14 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
16 # Written by and Copyright (C) Francois Fleuret #
17 # Contact <francois@fleuret.org> for comments & bug reports #
18 #########################################################################
24 ######################################################################
26 function check_remote_is_defined () {
27 if [[ "${REMOTE_HOST}" ]] && [[ "${REMOTE_DIR}" ]]
31 echo "@XREMOTE_HOST should come first." >&2
38 xremote.sh [-h <remote_host>] [-i <remote_dir>] <script> [script arguments]
40 This script takes a script as argument and executes it remotely in a
41 temporary directory on a ssh-accessible server.
43 It parses the script first to find embedded arguments which define
44 the hostname on which to run, the files to send, the files to get
45 back when the execution is over, and commands to execute before
46 running the executable remotely.
48 These arguments can appear multiple times, except the one that
49 specifies the remote host.
53 @XREMOTE_HOST: elk.fleuret.org
54 @XREMOTE_EXEC: python3
55 @XREMOTE_SEND: main.cf
57 @XREMOTE_PRE: ln -s /home/fleuret/data/pytorch ./data
59 If a file with the same name as the script with the .xremote
60 extension appended to it exists, arguments will be read from it by
63 If the -h option is provided @XREMOTE_HOST is ignored.
65 If the -i option is provided, all the files are installed and
66 scripts run in the specified directory on the remote host, but the
67 main executable and post-run commands are ignored
69 If no argument is provided to @XREMOTE_HOST, and the -h option is
70 not specified, the environment variable \$XREMOTE_HOST is used
73 Contact <francois@fleuret.org> for comments.
79 function cleanup_remote_tmp () {
80 if [[ "${REMOTE_HOST}" ]] && [[ "${REMOTE_DIR}" ]] && [[ ! "${ARG_DIR}" ]]
82 echo "xremote: Clean up remote workdir."
86 ######################################################################
88 while [[ "$1" =~ ^- ]]
95 echo "xremote: remote forced to ${ARG_HOST}"
101 echo "xremote: remote dir set to ${ARG_DIR}"
105 echo "Unknown option $1"
112 ######################################################################
114 [[ -a "$1" ]] || (help && echo >&2 "Cannot find $1" && exit 1)
118 main="$(basename "$1")"
119 main_config="${main}.xremote"
121 if [[ -f "${main_config}" ]]
123 echo "xremote: found ${main_config}"
125 main_config="${main}"
130 trap cleanup_remote_tmp EXIT
132 ######################################################################
137 if [[ "${line}" =~ '@XREMOTE' ]]
140 label=$(echo "${line}" | sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/')
141 value=$(echo "${line}" | sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/')
146 check_remote_is_defined
147 [[ "${REMOTE_EXEC}" ]] && (exit "Remote executable already defined!" >&2 && exit 1)
148 REMOTE_EXEC="${value}"
152 check_remote_is_defined
153 echo "xremote: ${value}"
154 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
158 check_remote_is_defined
159 echo "xremote: -- sending files --------------------------------------------"
160 tar ch ${value} | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mxv"
164 [[ "${REMOTE_DIR}" ]] && (exit "Remote host already defined!" >&2 && exit 1)
165 REMOTE_HOST="${ARG_HOST}" # Host given in argument has priority
166 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${value}"
167 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${XREMOTE_HOST}"
168 [[ "${REMOTE_HOST}" ]] || (echo "xremote: No remote host specified." >&2 && exit 1)
169 if [[ "${ARG_DIR}" ]]
171 ssh </dev/null "${REMOTE_HOST}" "mkdir -p \"${ARG_DIR}\""
172 REMOTE_DIR="${ARG_DIR}"
174 REMOTE_DIR="$(ssh </dev/null "${REMOTE_HOST}" mktemp -d /tmp/xremote_\$\(whoami\)_from_"$(hostname)_$(date +%Y%m%d_%H%M%S)".XXXXXX)"
176 echo "xremote: target is ${REMOTE_HOST}"
181 done < "${main_config}"
183 ######################################################################
185 check_remote_is_defined
187 tar c "${main}" | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mx"
189 if [[ "${ARG_DIR}" ]]
191 echo "xremote: everything has been set up in ${REMOTE_HOST}:${ARG_DIR}"
195 echo "xremote: -- running the executable -----------------------------------"
197 if [[ "${REMOTE_EXEC}" ]]
199 REMOTE_COMMAND="${REMOTE_EXEC} ${main}"
201 REMOTE_COMMAND="./${main}"
204 ######################################################################
206 # I find this slightly ugly ...
210 quoted_args="${quoted_args} \"${s}\""
213 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${REMOTE_COMMAND} ${quoted_args}"
215 ######################################################################
217 # Disable globbing to keep wildcards for the remote side
219 echo "xremote: -- retrieving files -----------------------------------------"
225 if [[ "${line}" =~ '@XREMOTE' ]]
227 label=$(echo "${line}" | sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/')
228 value=$(echo "${line}" | sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/')
231 check_remote_is_defined
232 echo "xremote: ${value}"
233 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
237 check_remote_is_defined
238 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar 2>/dev/null c ${value}" | tar mxv
243 done < "${main_config}"
247 echo "xremote: -- finished -------------------------------------------------"
249 ######################################################################