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 the -h option is provided @XREMOTE_HOST is ignored.
61 If the -i option is provided, all the files are installed and
62 scripts run in the specified directory on the remote host, but the
63 main executable and post-run commands are ignored
65 If no argument is provided to @XREMOTE_HOST, and the -h option is
66 not specified, the environment variable \$XREMOTE_HOST is used
69 Contact <francois@fleuret.org> for comments.
75 function cleanup_remote_tmp () {
76 if [[ "${REMOTE_HOST}" ]] && [[ "${REMOTE_DIR}" ]] && [[ ! "${ARG_DIR}" ]]
78 echo "xremote: Clean up remote workdir."
82 ######################################################################
84 while [[ "$1" =~ ^- ]]
91 echo "xremote: remote forced to ${ARG_HOST}"
97 echo "xremote: remote dir set to ${ARG_DIR}"
101 echo "Unknown option $1"
108 ######################################################################
110 [[ -a "$1" ]] || (help && exit 1)
112 main="$(basename "$1")"
118 trap cleanup_remote_tmp EXIT
120 ######################################################################
125 if [[ "${line}" =~ '@XREMOTE' ]]
128 label=$(echo "${line}" | sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/')
129 value=$(echo "${line}" | sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/')
134 check_remote_is_defined
135 [[ "${REMOTE_EXEC}" ]] && (exit "Remote executable already defined!" >&2 && exit 1)
136 REMOTE_EXEC="${value}"
140 check_remote_is_defined
141 echo "xremote: ${value}"
142 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
146 check_remote_is_defined
147 echo "xremote: -- sending files --------------------------------------------"
148 tar ch ${value} | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mxv"
152 [[ "${REMOTE_DIR}" ]] && (exit "Remote host already defined!" >&2 && exit 1)
153 REMOTE_HOST="${ARG_HOST}" # Host given in argument has priority
154 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${value}"
155 [[ "${REMOTE_HOST}" ]] || REMOTE_HOST="${XREMOTE_HOST}"
156 [[ "${REMOTE_HOST}" ]] || (echo "xremote: No remote host specified." >&2 && exit 1)
157 if [[ "${ARG_DIR}" ]]
159 ssh </dev/null "${REMOTE_HOST}" "mkdir -p \"${ARG_DIR}\""
160 REMOTE_DIR="${ARG_DIR}"
162 REMOTE_DIR="$(ssh </dev/null "${REMOTE_HOST}" mktemp -d /tmp/xremote_\$\(whoami\)_from_"$(hostname)_$(date +%Y%m%d_%H%M%S)".XXXXXX)"
164 echo "xremote: target is ${REMOTE_HOST}"
171 ######################################################################
173 check_remote_is_defined
175 tar c "${main}" | ssh "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar mx"
177 if [[ "${ARG_DIR}" ]]
179 echo "xremote: everything has been set up in ${REMOTE_HOST}:${ARG_DIR}"
183 echo "xremote: -- running the executable -----------------------------------"
185 if [[ "${REMOTE_EXEC}" ]]
187 REMOTE_COMMAND="${REMOTE_EXEC} ${main}"
189 REMOTE_COMMAND="./${main}"
192 ######################################################################
194 # I find this slightly ugly ...
197 quoted_args="${quoted_args} \"${s}\""
200 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${REMOTE_COMMAND} ${quoted_args}"
202 ######################################################################
204 # Disable globbing to keep wildcards for the remote side
206 echo "xremote: -- retrieving files -----------------------------------------"
212 if [[ "${line}" =~ '@XREMOTE' ]]
214 label=$(echo "${line}" | sed -e 's/^.*@XREMOTE_\([^:]*\):.*$/\1/')
215 value=$(echo "${line}" | sed -e 's/^.*@XREMOTE_[^:]*: *\(.*\)$/\1/')
218 check_remote_is_defined
219 echo "xremote: ${value}"
220 ssh < /dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && ${value}"
224 check_remote_is_defined
225 ssh </dev/null "${REMOTE_HOST}" "cd \"${REMOTE_DIR}\" && tar 2>/dev/null c ${value}" | tar mxv
233 echo "xremote: -- finished -------------------------------------------------"
235 ######################################################################