mirror of
https://github.com/valitydev/salt.git
synced 2024-11-06 08:35:21 +00:00
Move giant eventlisten.sh example out of the state.event docstring
This is more interesting than directly useful and doesn't need to clutter the docs.
This commit is contained in:
Seth House
parent
09798fe470
commit
af44413db1
@ -170,95 +170,10 @@ def event(tagmatch='*', count=-1, quiet=False, sock_dir=None, pretty=False):
|
||||
echo $data | jq -colour-output .
|
||||
done
|
||||
|
||||
The following example monitors Salt's event bus in a background process
|
||||
watching for returns for a given job. Requires a POSIX environment and jq
|
||||
<http://stedolan.github.io/jq/>.
|
||||
.. seealso::
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
#!/bin/sh
|
||||
# Usage: ./eventlisten.sh '*' test.sleep 10
|
||||
|
||||
# Mimic fnmatch from the Python stdlib.
|
||||
fnmatch() { case "$2" in $1) return 0 ;; *) return 1 ;; esac ; }
|
||||
count() { printf '%s\n' "$#" ; }
|
||||
|
||||
listen() {
|
||||
events='events'
|
||||
mkfifo $events
|
||||
exec 3<>$events # Hold the fd open.
|
||||
|
||||
# Start listening to events before starting the command to avoid race
|
||||
# conditions.
|
||||
salt-run state.event count=-1 >&3 &
|
||||
events_pid=$!
|
||||
|
||||
(
|
||||
timeout=$(( 60 * 60 ))
|
||||
sleep $timeout
|
||||
kill -s USR2 $$
|
||||
) &
|
||||
timeout_pid=$!
|
||||
|
||||
# Give the runner a few to connect to the event bus.
|
||||
printf 'Subscribing to the Salt event bus...\n'
|
||||
sleep 4
|
||||
|
||||
trap '
|
||||
excode=$?; trap - EXIT;
|
||||
exec 3>&-
|
||||
kill '"${timeout_pid}"'
|
||||
kill '"${events_pid}"'
|
||||
rm '"${events}"'
|
||||
exit
|
||||
echo $excode
|
||||
' INT TERM EXIT
|
||||
|
||||
trap '
|
||||
printf '\''Timeout reached; exiting.\n'\''
|
||||
exit 4
|
||||
' USR2
|
||||
|
||||
# Run the command and get the JID.
|
||||
jid=$(salt --async "$@")
|
||||
jid="${jid#*: }" # Remove leading text up to the colon.
|
||||
|
||||
# Create the event tags to listen for.
|
||||
start_tag="salt/job/${jid}/new"
|
||||
ret_tag="salt/job/${jid}/ret/*"
|
||||
|
||||
# ``read`` will block when no events are going through the bus.
|
||||
printf 'Waiting for tag %s\n' "$ret_tag"
|
||||
while read -r tag data; do
|
||||
if fnmatch "$start_tag" "$tag"; then
|
||||
minions=$(printf '%s\n' "${data}" | jq -r '.["minions"][]')
|
||||
num_minions=$(count $minions)
|
||||
printf 'Waiting for %s minions.\n' "$num_minions"
|
||||
continue
|
||||
fi
|
||||
|
||||
if fnmatch "$ret_tag" "$tag"; then
|
||||
mid="${tag##*/}"
|
||||
printf 'Got return for %s.\n' "$mid"
|
||||
printf 'Pretty-printing event: %s\n' "$tag"
|
||||
printf '%s\n' "$data" | jq .
|
||||
|
||||
minions="$(printf '%s\n' "$minions" | sed -e '/'"$mid"'/d')"
|
||||
num_minions=$(count $minions)
|
||||
if [ $((num_minions)) -eq 0 ]; then
|
||||
printf 'All minions returned.\n'
|
||||
break
|
||||
else
|
||||
printf 'Remaining minions: %s\n' "$num_minions"
|
||||
fi
|
||||
else
|
||||
printf 'Skipping tag: %s\n' "$tag"
|
||||
continue
|
||||
fi
|
||||
done <&3
|
||||
}
|
||||
|
||||
listen "$@"
|
||||
See :glob:`tests/eventlisten.sh` for an example of usage within a shell
|
||||
script.
|
||||
'''
|
||||
sevent = salt.utils.event.get_event(
|
||||
'master',
|
||||
|
||||
88
tests/eventlisten.sh
Normal file
88
tests/eventlisten.sh
Normal file
@ -0,0 +1,88 @@
|
||||
#!/bin/sh
|
||||
#
|
||||
# The following example monitors Salt's event bus in a background process
|
||||
# watching for returns for a given job. Requires a POSIX environment and jq
|
||||
# <http://stedolan.github.io/jq/>.
|
||||
#
|
||||
# Usage: ./eventlisten.sh '*' test.sleep 10
|
||||
|
||||
# Mimic fnmatch from the Python stdlib.
|
||||
fnmatch() { case "$2" in $1) return 0 ;; *) return 1 ;; esac ; }
|
||||
count() { printf '%s\n' "$#" ; }
|
||||
|
||||
listen() {
|
||||
events='events'
|
||||
mkfifo $events
|
||||
exec 3<>$events # Hold the fd open.
|
||||
|
||||
# Start listening to events before starting the command to avoid race
|
||||
# conditions.
|
||||
salt-run state.event count=-1 >&3 &
|
||||
events_pid=$!
|
||||
|
||||
(
|
||||
timeout=$(( 60 * 60 ))
|
||||
sleep $timeout
|
||||
kill -s USR2 $$
|
||||
) &
|
||||
timeout_pid=$!
|
||||
|
||||
# Give the runner a few to connect to the event bus.
|
||||
printf 'Subscribing to the Salt event bus...\n'
|
||||
sleep 4
|
||||
|
||||
trap '
|
||||
excode=$?; trap - EXIT;
|
||||
exec 3>&-
|
||||
kill '"${timeout_pid}"'
|
||||
kill '"${events_pid}"'
|
||||
rm '"${events}"'
|
||||
exit
|
||||
echo $excode
|
||||
' INT TERM EXIT
|
||||
|
||||
trap '
|
||||
printf '\''Timeout reached; exiting.\n'\''
|
||||
exit 4
|
||||
' USR2
|
||||
|
||||
# Run the command and get the JID.
|
||||
jid=$(salt --async "$@")
|
||||
jid="${jid#*: }" # Remove leading text up to the colon.
|
||||
|
||||
# Create the event tags to listen for.
|
||||
start_tag="salt/job/${jid}/new"
|
||||
ret_tag="salt/job/${jid}/ret/*"
|
||||
|
||||
# ``read`` will block when no events are going through the bus.
|
||||
printf 'Waiting for tag %s\n' "$ret_tag"
|
||||
while read -r tag data; do
|
||||
if fnmatch "$start_tag" "$tag"; then
|
||||
minions=$(printf '%s\n' "${data}" | jq -r '.["minions"][]')
|
||||
num_minions=$(count $minions)
|
||||
printf 'Waiting for %s minions.\n' "$num_minions"
|
||||
continue
|
||||
fi
|
||||
|
||||
if fnmatch "$ret_tag" "$tag"; then
|
||||
mid="${tag##*/}"
|
||||
printf 'Got return for %s.\n' "$mid"
|
||||
printf 'Pretty-printing event: %s\n' "$tag"
|
||||
printf '%s\n' "$data" | jq .
|
||||
|
||||
minions="$(printf '%s\n' "$minions" | sed -e '/'"$mid"'/d')"
|
||||
num_minions=$(count $minions)
|
||||
if [ $((num_minions)) -eq 0 ]; then
|
||||
printf 'All minions returned.\n'
|
||||
break
|
||||
else
|
||||
printf 'Remaining minions: %s\n' "$num_minions"
|
||||
fi
|
||||
else
|
||||
printf 'Skipping tag: %s\n' "$tag"
|
||||
continue
|
||||
fi
|
||||
done <&3
|
||||
}
|
||||
|
||||
listen "$@"
|
||||
Loading…
Reference in New Issue
Block a user