Skip to content

Add per-host capability to shell plugin #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kbuley wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Add per-host capability to shell plugin #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3890593
Add per-host capability to shell plugin
kbuley Nov 1, 2017
02b73f1
Update documentation to match new host option in the shell plugin
kbuley Nov 1, 2017
1c43358
Merge branch 'feature/shell-per-host-documentation' of github.com:kbu…
kbuley Nov 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ Shell tasks support an extended syntax as well, which provides more fine-grained

| Option | Values | Default Value | Required | Description |
| --- | --- | --- | --- | --- |
| `host` | `string` | - | No | The hostname of the machine this script should be executed on. Not supplying a host will result in the shell command executing on every host.<br><br>The hostname '-' can be specified as a default target that will match all hosts. |
| `command` | `string` | - | Yes | The command to be run. |
| `description` | `string` | - | No | A human-readable description. |
| `stdin` | `true`, `false` | `false` | No | Specifies if the standard input stream is enabled. |
Expand Down
29 changes: 21 additions & 8 deletions snowsaw/plugins/shell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
import os
import subprocess
import snowsaw
from socket import gethostname



class Shell(snowsaw.Plugin):
Expand Down Expand Up @@ -40,22 +42,33 @@ def _process_commands(self, data):
stdout = None
if item.get("stderr", defaults.get("stderr", False)) is True:
stderr = None
host = item.get("host", None)
elif isinstance(item, list):
cmd = item[0]
msg = item[1] if len(item) > 1 else None
else:
cmd = item
msg = None
if msg is None:
self._log.lowinfo(cmd)
else:
self._log.lowinfo('{} [{}]'.format(msg, cmd))
executable = os.environ.get("SHELL")
ret = subprocess.call(cmd, shell=True, stdin=stdin, stdout=stdout, stderr=stderr, cwd=self._context.snowblock_dir(),
shouldExecute = False
if host is None:
shouldExecute = True
elif host == gethostname():
shouldExecute = True
elif host == "-":
shouldExecute = True
if shouldExecute:
if msg is None:
self._log.lowinfo(cmd)
else:
self._log.lowinfo('{} [{}]'.format(msg, cmd))
ret = subprocess.call(cmd, shell=True, stdin=stdin, stdout=stdout, stderr=stderr, cwd=self._context.snowblock_dir(),
executable=executable)
if ret != 0:
success = False
self._log.warning("Command [{}] failed".format(cmd))
if ret != 0:
success = False
self._log.warning("Command [{}] failed".format(cmd))
else:
self._log.lowinfo("Skipping command [{}]".format(cmd))
if success:
self._log.info("=> All commands have been executed")
else:
Expand Down