Changelog from 1.11.1 :
- Fix a relative import in fabric.network to be
correctly/consistently absolute instead.
- Implement sudo-specific password caching.
This can be used to work around issues where over-eager submission of
env.password at login time causes authentication problems
(e.g. during two-factor auth).
Upstream changes:
=================
1.10.2 2015-06-19
-----------------
[Bug] #1273: Fix issue with ssh/config not having a cross-platform default
path. Thanks to @SamuelMarks for catch & patch.
[Bug] #1286: (also #971, #1032) Recursively unwrap decorators instead of
only unwrapping a single decorator level, when obtaining task docstrings.
Thanks to Avishai Ish-Shalom for the original report & Max Kovgan for the
patch.
[Bug] #1289: Fix 'NameError: free variable referenced before assignment
in enclosing scope'. Thanks to @SamuelMarks for catch & patch.
[Bug] #980: (also #1312) Redirect output of cd to /dev/null so users
enabling bash's CDPATH (or similar features in other shells) don't have
polluted output captures. Thanks to Alex North-Keys for the original report &
Steve Ivy for the fix.
[Bug] #1305: (also #1313) Fix a couple minor issues with the operation of &
demo code for the JobQueue class. Thanks to @dioh and Horst Gutmann for the
report & Cameron Lane for the patch.
[Bug] #1318: Update functionality added in #1213 so abort error messages
don't get printed twice (once by us, once by sys.exit) but the annotated
exception error message is retained. Thanks to Felix Almeida for the report.
1.10.1 2014-12-19
-----------------
[Bug] #1226: Update get to ensure that env.user has access to tempfiles
before changing permissions. Also corrected permissions from 404 to 0400 to
match comment. Patch by Curtis Mattoon; original report from Daniel Watkins.
[Support] #1229: Add some missing API doc hyperlink references. Thanks to
Tony Narlock.
[Support] #958: Remove the Git SHA portion of our version string
generation; it was rarely useful & occasionally caused issues for users with
non-Git-based source checkouts.
[Bug] #1180: Fix issue with unicode steam outputs crashing if stream
encoding type is None. Thanks to @joekiller for catch & patch.
[Bug] #1228: Update the CommandTimeout class so it has a useful str instead
of appearing blank when caught by Fabric's top level exception handling.
Catch & patch from Tomaz Muraus.
[Support] #1213: Add useful exception message to the implicit SystemExit
raised by Fabric's use of sys.exit inside the abort function. This allows
client code catching SystemExit to have better introspection into the error.
Thanks to Ioannis Panousis.
[Bug] #1019: (also #1022, #1186) Fix is a tty tests in
environments where streams (eg sys.stdout) have been replaced with objects
lacking a .isatty() method. Thanks to Miki Tebeka for the original report, Lele
Long for a subsequent patch, and Julien Phalip for the final/merged patch.
[Bug] #1201: Don't naively glob all get targets - only glob actual
directories. This avoids incorrectly yielding permission errors in edge cases
where a requested file is within a directory lacking the read permission bit.
Thanks to Sassa Nf for the original report.
1.10.0 2014-09-04
-----------------
[Feature] #975: Fabric can now be invoked via python -m fabric in addition
to the typical use of the fab entrypoint. Patch courtesy of Jason Coombs.
(Python 2.7 only)
[Feature] #1090: Add option to skip unknown tasks. Credit goes to Jonas
Lundberg.
[Feature] #1098: Add support for dict style roledefs. Thanks to Jonas
Lundberg.
[Feature] #700: Added use_sudo and temp_dir params to get. This allows
downloading files normally not accessible to the user using sudo. Thanks to
Jason Coombs for initial report and to Alex Plugaru for the patch (#1121).
[Bug] #1188: Update local to close non-pipe file descriptors in the child
process so subsequent calls to local aren't blocked on e.g.
already-connected network sockets. Thanks to Tolbkni Kao for catch & patch.
Upstream changes:
-----------------
[Bug] #1167: Add Jinja to test_requires in setup.py for the couple of newish tests that now require it. Thanks to Kubilay Kocak for the catch.
[Bug] #600: Clear out connection caches in full when prepping parallel-execution subprocesses. This avoids corner cases causing hangs/freezes due to client/socket reuse. Thanks to Ruslan Lutsenko for the initial report and Romain Chossart for the suggested fix.
[Bug] #1026: Fix a typo preventing quiet operation of is_link. Caught by @dongweiming.
[Bug] #1059: Update IPv6 support to work with link-local address formats. Fix courtesy of @obormot.
[Bug] #1096: Encode Unicode text appropriately for its target stream object to avoid issues on non-ASCII systems. Thanks to Toru Uetani for the original patch.
[Bug] #852: Fix to respect template_dir for non Jinja2 templates in upload_template. Thanks to Adam Kowalski for the patch and Alex Plugaru for the initial test case.
[Bug] #1134: Skip bad hosts when the tasks are executed in parallel. Thanks to Igor Maravić @i-maravic.
[Bug] #1146: Fix a bug where upload_template failed to honor lcd when mirror_local_mode is True. Thanks to Laszlo Marai for catch & patch.
[Bug] #1147: Use stat instead of lstat when testing directory-ness in the SFTP module. This allows recursive downloads to avoid recursing into symlinks unexpectedly. Thanks to Igor Kalnitsky for the patch.
[Bug] #1165: Prevent infinite loop condition when a gateway host is enabled & the same host is in the regular target host list. Thanks to @CzBiX for catch & patch.
Upstream changes:
-----------------
1.9.0 2014-06-08
[Bug] #965: Tweak IO flushing behavior when in linewise
(& thus parallel) mode so interwoven output is less frequent.
Thanks to @akidata for catch & patch.
[Feature] #741: Add env.prompts dictionary, allowing users to set
up custom prompt responses (similar to the built-in sudo prompt
auto-responder.) Thanks to Nigel Owens and David Halter for the patch.
[Feature] #1082: Add pty passthrough kwarg to upload_template.
[Support]: Modified packaging data to reflect that Fabric requires
Paramiko < 1.13 (which dropped Python 2.5 support.)
[Support] #1105: Enhance setup.py to allow Paramiko 1.13+ under
Python 2.6+. Thanks to to @Arfrever for catch & patch.
[Support] #1106: Fix a misleading/ambiguous example snippet in the fab
usage docs to be clearer. Thanks to @zed.
[Feature] #1101: Reboot operation now supports custom command.
Thanks to Jonas Lejon.
[Feature] #938: Add an env var env.effective_roles specifying roles used
in the currently executing command. Thanks to Piotr Betkier for the patch.
[Feature] #1078: Add .command and .real_command attributes to local
return value.
Thanks to Alexander Teves (@alexanderteves) and Konrad Hałas (@konradhalas).
1.8.4 2014-06-08
[Support] #1105: Enhance setup.py to allow Paramiko 1.13+ under Python
2.6+. Thanks to to @Arfrever for catch & patch.
[Bug] #898: Treat paths that begin with tilde “~”
as absolute paths instead of relative.
Thanks to Alex Plugaru for the patch and Dan Craig for the suggestion.
1.8.3 2014-03-21
[Support]: Modified packaging data to reflect that Fabric requires
Paramiko < 1.13 (which dropped Python 2.5 support.)
pkgsrc changes:
---------------
FETCH_USING= curl. Yes, I know it's a hack, but at least it works on the
NetBSD version installed on my laptop.
upstream changes:
-----------------
1.8.2 2014-02-14
[Bug] #1046: Fix typo preventing use of ProxyCommand in some
situations. Thanks to Keith Yang.
[Bug] #917: Correct an issue with put(use_sudo=True, mode=xxx) where
the chmod was trying to apply to the wrong location.
Thanks to Remco (@nl5887) for catch & patch.
[Bug] #955: Quote directories created as part of put‘s
recursive directory uploads when use_sudo=True so directories with shell
meta-characters (such as spaces) work correctly. Thanks to John Harris for the catch.
1.8.1 2013-12-24
[Bug] #948: Handle connection failures due to server load and try
connecting to hosts a number of times specified in env.connection_attempts.
[Bug] #957: Fix bug preventing use of env.gateway with targets requiring
password authentication. Thanks to Daniel González, @Bengrunt and @adrianbn for their bug reports.
[Bug] #956: Fix pty size detection when running inside Emacs.
Thanks to @akitada for catch & patch.
either because they themselves are not ready or because a
dependency isn't. This is annotated by
PYTHON_VERSIONS_INCOMPATIBLE= 33 # not yet ported as of x.y.z
or
PYTHON_VERSIONS_INCOMPATIBLE= 33 # py-foo, py-bar
respectively, please use the same style for other packages,
and check during updates.
Use versioned_dependencies.mk where applicable.
Use REPLACE_PYTHON instead of handcoded alternatives, where applicable.
Reorder Makefile sections into standard order, where applicable.
Remove PYTHON_VERSIONS_INCLUDE_3X lines since that will be default
with the next commit.
Whitespace cleanups and other nits corrected, where necessary.
pkgsrc changes:
---------------
FETCH_USING=curl, pypi serves files over https now.
upstream changes:
-----------------
1.8.0 2013-09-20
[Feature] #910: Added a keyword argument to rsync_project to configure the
default options. Thanks to @moorepants for the patch.
[Support] #984: Make this changelog easier to read! Now with per-release
sections, generated automatically from the old timeline source format.
[Feature] #931: Allow overriding of abort behavior via a custom
exception-returning callable set as env.abort_exception.
Thanks to Chris Rose for the patch.
pkgsrc changes:
---------------
FETCH_USING=curl, as PyPi moved to https only.
Upstream changes:
-----------------
2013-07-26: released Fabric 1.7.0
2013-07-26: released Fabric 1.6.2
[Feature] #925: Added contrib.files.is_link. Thanks to @jtangas for the
patch.
[Feature] #922: Task argument strings are now displayed when using fab -d.
Thanks to Kevin Qiu for the patch.
[Bug] #912: Leaving template_dir un-specified when using upload_template
in Jinja mode used to cause 'NoneType' has no attribute 'startswith'
errors. This has been fixed. Thanks to Erick Yellott for catch & to
Erick Yellott + Kevin Williams for patches.
[Feature] #924: Add new env var option colorize_errors to enable
coloring errors and warnings. Thanks to Aaron Meurer for the patch.
[Bug] #593: Non-ASCII character sets in Jinja templates rendered
within upload_template would cause UnicodeDecodeError when uploaded.
This has been addressed by encoding as utf-8 prior to upload.
Thanks to Sébastien Fievet for the catch.
[Feature] #908: Support loading SSH keys from memory.
Thanks to Caleb Groom for the patch.
[Bug] #171: Added missing cross-references from env variables
documentation to corresponding command-line options.
Thanks to Daniel D. Beck for the contribution.
[Bug] #884: The password cache feature was not working correctly with
password-requiring SSH gateway connections.
That’s fixed now. Thanks to Marco Nenciarini for the catch.
[Feature] #826: Enable sudo extraction of compressed archive via use_sudo
kwarg in upload_project. Thanks to @abec for the patch.
[Bug] #694: Allow users to work around ownership issues in the default
remote login directory: add temp_dir kwarg for explicit specification of
which “bounce” folder to use when calling put with
use_sudo=True.
Thanks to Devin Bayer for the report & Dieter Plaetinck / Jesse Myers for
suggesting the workaround.
[Bug] #882: Fix a get bug regarding spaces in remote working directory names.
Thanks to Chris Rose for catch & patch.
Upstream changes:
-----------------
[Bug] #868: Substantial speedup of parallel tasks by removing an unnecessary
blocking timeout in the JobQueue loop. Thanks to Simo Kinnunen for the patch.
[Bug] #328: lcd was no longer being correctly applied to upload_template; this
has been fixed. Thanks to Joseph Lawson for the catch.
[Bug] #870: Changes to shell env var escaping highlighted some extraneous and
now damaging whitespace in with path():. This has been removed and a regression
test added.
[Bug] #871: Use of string mode values in put(local, remote, mode="NNNN") would
sometimes cause Unsupported operand errors. This has been fixed.
[Bug] #84: Fixed problem with missing -r flag in Mac OS X sed version. Thanks
to Konrad Hałas for the patch.
[Bug] #861: Gracefully handle situations where users give a single string
literal to env.hosts. Thanks to Bill Tucker for catch & patch.
[Bug] #367: Expand paths with tilde inside (contrib.files). Thanks to Konrad
Hałas for catch & patch.
[Feature] #845: Downstream synchronization option implemented for
rsync_project. Thanks to Antonio Barrero for the patch.
pkgsrc changes:
---------------
- Update dependency to py-paramiko to 1.10.0
upstream changes:
-----------------
2013-03-01: released Fabric 1.6.0
2013-03-01: released Fabric 1.5.4
[Bug] #844: Account for SSH config overhaul in Paramiko 1.10 by e.g.
updating treatment of IdentityFile to handle multiple values.
This and related SSH config parsing changes are backwards
incompatible; we are including them in this release because they do fix
incorrect, off-spec behavior.
[Bug] #843: Ensure string pool_size values get run through int() before
deriving final result (stdlib min() has odd behavior here...).
Thanks to Chris Kastorff for the catch.
[Bug] #839: Fix bug in rsync_project where IPv6 address were not always
correctly detected. Thanks to Antonio Barrero for catch & patch.
[Bug] #587: Warn instead of aborting when env.use_ssh_config is True but
the configured SSH conf file doesn't exist. This allows multi-user
fabfiles to enable SSH config without causing hard stops for users lacking
SSH configs. Thanks to Rodrigo Pimentel for the report.
[Feature] #821: Add remote_tunnel to allow reverse SSH tunneling
(exposing locally-visible network ports to the remote end).
Thanks to Giovanni Bajo for the patch.
[Feature] #823: Add env.remote_interrupt which controls whether Ctrl-C is
forwarded to the remote end or is captured locally
(previously, only the latter behavior was implemented).
Thanks to Geert Jansen for the patch.
Upstream changes:
-----------------
[Bug] #806: Force strings given to getpass during password prompts to be
ASCII, to prevent issues on some platforms when Unicode is encountered.
Thanks to Alex Louden for the patch.
[Feature] #805: Update shell_env to play nice with Windows (7, at least)
systems. Thanks to Fernando Macedo for the patch.
[Bug] #654: Parallel runs whose sum total of returned data was large
(e.g. large return values from the task, or simply a large number of hosts
in the host list) were causing frustrating hangs. This has been fixed.
[Bug] #791: Cast reboot`s wait parameter to a numeric type in case the
caller submitted a string by mistake. Thanks to Thomas Schreiber for the
patch.
Upstream changes:
-----------------
[Bug] #766: Use the variable name of a new-style fabric.tasks.Task subclass
object when the object name attribute is undefined.
Thanks to @todddeluca for the patch.
[Bug] #604: Fixed wrong treatment of backslashes in put operation when
uploading directory tree on Windows. Thanks to Jason Coombs for the catch
and @diresys & Oliver Janik for the patch. for the patch.
[Bug] #792: The newish shell_env context manager was incorrectly omitted
from the fabric.api import endpoint. This has been remedied.
Thanks to Vishal Rana for the catch.
[Bug] #775: Shell escaping was incorrectly applied to the value of $PATH
updates in our shell environment handling, causing (at the very least)
local binary paths to become inoperable in certain situations.
This has been fixed.
Added current host string to prompt abort error messages.
pkgsrc changes:
---------------
Switch back to security/py-paramiko, now that security/py-ssh has been merged
back into paramiko.
upstream changes:
-----------------
2012-11-15: released Fabric 1.5.1
[Bug] #776: Fixed serious-but-non-obvious bug in direct-tcpip driven gatewaying
(e.g. that triggered by -g or env.gateway.) Should work correctly now.
[Bug] #771: Sphinx autodoc helper unwrap_tasks didn't play nice with
@task(name=xxx) in some situations. This has been fixed.
2012-11-06: released Fabric 1.5.0
2012-11-06: released Fabric 1.4.4
[Feature] #38: (also #698) Implement both SSH-level and
ProxyCommand-based gatewaying for SSH traffic. (This is distinct from
tunneling non-SSH traffic over the SSH connection, which is #78 and not
implemented yet.)
Thanks in no particular order to Erwin Bolwidt, Oskari Saarenmaa,
Steven Noonan, Vladimir Lazarenko, Lincoln de Sousa, Valentino
Volonghi, Olle Lundberg and Github user @acrish for providing the
original patches to both Fabric and Paramiko.
[Feature] #684: (also #569) Update how task wraps task functions to
preserve additional metadata; this allows decorated functions to play
nice with Sphinx autodoc. Thanks to Jaka Hudoklin for catch & patch.
[Support] #103: (via #748) Long standing Sphinx autodoc issue requiring
error-prone duplication of function signatures in our API docs has been
fixed. Thanks to Alex Morega for the patch.
[Bug] #767: Fix (and add test for) regression re: having linewise
output automatically activate when parallelism is in effect. Thanks to
Alexander Fortin and Dustin McQuay for the bug reports.
[Bug] #736: Ensure context managers that build env vars play nice with
contextlib.nested by deferring env var reference to entry time, not
call time. Thanks to Matthew Tretter for catch & patch.
[Feature] #763: Add --initial-password-prompt to allow prefilling the
password cache at the start of a run. Great for sudo-powered parallel
runs.
[Feature] #665: (and #629) Update upload_template to have a more useful
return value, namely that of its internal put call. Thanks to Miquel
Torres for the catch & Rodrigue Alcazar for the patch.
[Feature] #578: Add name argument to task (docs) to allow overriding of
the default "function name is task name" behavior. Thanks to Daniel
Simmons for catch & patch.
[Feature] #761: Allow advanced users to parameterize fabric.main.main()
to force loading of specific fabfiles.
[Bug] #749: Gracefully work around calls to fabric.version on systems
lacking /bin/sh (which causes an OSError in subprocess.Popen calls.)
[Feature] #723: Add the group= argument to sudo. Thanks to Antti
Kaihola for the pull request.
[Feature] #725: Updated local to allow override of which local shell is
used. Thanks to Mustafa Khattab.
[Bug] #704: Fix up a bunch of Python 2.x style print statements to be
forwards compatible. Thanks to Francesco Del Degan for the patch.
[Feature] #491: (also [Feature] #385:) IPv6 host string support. Thanks
to Max Arnold for the patch.
[Feature] #699: Allow name attribute on file-like objects for get/put.
Thanks to Peter Lyons for the pull request.
[Bug] #711: get would fail when filenames had % in their path. Thanks
to John Begeman
[Bug] #702: require failed to test for "empty" values in the env keys
it checks (e.g. require('a-key-whose-value-is-an-empty-list') would
register a successful result instead of alerting that the value was in
fact empty. This has been fixed, thanks to Rich Schumacher.
[Bug] #718: isinstance(foo, Bar) is used in main instead of type(foo)
== Bar in order to fix some edge cases. Thanks to Mikhail Korobov.
[Bug] #693: Fixed edge case where abort driven failures within parallel
tasks could result in a top level exception (a KeyError) regarding
error handling. Thanks to Marcin Ku#mi#ski for the report.
[Support] #681: Fixed outdated docstring for runs_once which claimed it
would get run multiple times in parallel mode. That behavior was fixed
in an earlier release but the docs were not updated. Thanks to Jan
Brauer for the catch.
Upstream changes:
-----------------
2012-07-06: released Fabric 1.4.3
2012-07-06: released Fabric 1.3.8
[Bug] #671: reject_unknown_hosts sometimes resulted in a password prompt
instead of an abort. This has been fixed. Thanks to Roy Smith for the report.
[Bug] #659: Update docs to reflect that local currently honors env.path. Thanks
to @floledermann for the catch.
[Bug] #652: Show available commands when aborting on invalid command names.
[Support] #651: Added note about nesting with statements on Python 2.6+. Thanks
to Jens Rantil for the patch.
[Bug] #649: Don?t swallow non-abort-driven exceptions in parallel mode. Fabric
correctly printed such exceptions, and returned them from execute, but did not
actually cause the child or parent processes to halt with a nonzero status.
This has been fixed. execute now also honors env.warn_only so users may still
opt to call it by hand and inspect the returned exceptions, instead of
encountering a hard stop. Thanks to Matt Robenolt for the catch.
[Support] #645: Update Sphinx docs to work well when run out of a source
tarball as opposed to a Git checkout. Thanks again to @Arfrever for the catch.
[Support] #640: (also #644) Update packaging manifest so sdist tarballs include
all necessary test & doc files. Thanks to Mike Gilbert and @Arfrever for catch
& patch.
[Support] #634: Clarified that lcd does no special handling re: the user?s
current working directory, and thus relative paths given to it will be relative
to os.getcwd(). Thanks to @techtonik for the catch.
Upstream changes:
-----------------
:release:`1.4.2 <2012-05-07>`
:release:`1.3.7 <2012-05-07>`
🐛`562` Agent forwarding would error out or freeze when multiple uses of the
forwarded agent were used per remote invocation (e.g. a single
~fabric.operations.run command resulting in multiple Git or SVN checkouts.)
This has been fixed thanks to Steven McDonald and GitHub user @lynxis.
:support:`626` Clarity updates to the tutorial. Thanks to GitHub user m4z for
the patches.
🐛`625` ~fabric.context_managers.hide/~fabric.context_managers.show did not
correctly restore prior display settings if an exception was raised inside the
block. This has been fixed.
🐛`624` Login password prompts did not always display the username being
authenticated for. This has been fixed. Thanks to Nick Zalutskiy for catch &
patch.
🐛`617` Fix the clean_revert behavior of ~fabric.context_managers.settings
so it doesn't KeyError for newly created settings keys. Thanks to Chris
Streeter for the catch.
:feature:`615` Updated ~fabric.operations.sudo to honor the new setting
:ref:`env.sudo_user <sudo_user>` as a default for its user kwarg.
🐛`616` Add port number to the error message displayed upon connection
failures.
🐛`609` (and :issue:`564`) Document and clean up :ref:`env.sudo_prefix
<sudo_prefix>` so it can be more easily modified by users facing uncommon use
cases. Thanks to GitHub users 3point2 for the cleanup and SirScott for the
documentation catch.
🐛`610` Change detection of env.key_filename's type (added as part of SSH
config support in 1.4) so it supports arbitrary iterables. Thanks to Brandon
Rhodes for the catch.
Upstream changes:
-----------------
2012-04-04: released Fabric 1.4.1
2012-04-04: released Fabric 1.3.6
[Bug] #608: Add capture kwarg to rsync_project to aid in debugging rsync
problems.
[Bug] #607: Allow local to display stdout/stderr when it warns/aborts, if it
was capturing them.
[Bug] #395: Added an FAQ entry detailing how to handle init scripts which
misbehave when a pseudo-tty is allocated.
[Bug] #568: execute allowed too much of its internal state changes (to
variables such as env.host_string and env.parallel) to persist after execution
completed; this caused a number of different incorrect behaviors. execute has
been overhauled to clean up its own state changes - while preserving any state
changes made by the task being executed.
[Bug] #584: upload_project did not take explicit remote directory location into
account when untarring, and now uses cd to address this. Thanks to Ben Burry
for the patch.
[Bug] #458: with_settings did not perfectly match settings, re: ability to
inline additional context managers. This has been corrected. Thanks to Rory
Geoghegan for the patch.
[Bug] #499: contrib.files.first used an outdated function signature in its
wrapped exists call. This has been fixed. Thanks to Massimiliano Torromeo for
catch & patch.
[Bug] #551: --list output now detects terminal window size and truncates (or
doesn't truncate) accordingly. Thanks to Horacio G. de Oro for the initial pull
request.
[Bug] #572: Parallel task aborts (as oppposed to unhandled exceptions) now
correctly print their abort messages instead of tracebacks, and cause the
parent process to exit with the correct (nonzero) return code. Thanks to Ian
Langworth for the catch.
[Bug] #306: Remote paths now use posixpath for a separator. Thanks to Jason
Coombs for the patch.
2012-02-13: released Fabric 1.4.0
2012-02-13: released Fabric 1.3.5
2012-02-13: released Fabric 1.2.6
2012-02-13: released Fabric 1.1.8
[Bug] #495: Fixed documentation example showing how to subclass Task. Thanks to
Brett Haydon for the catch and Mark Merritt for the patch.
[Bug] #410: Fixed a bug where using the task decorator inside/under another
decorator such as hosts could cause that task to become invalid when invoked by
name (due to how old-style vs new-style tasks are detected.) Thanks to Dan
Colish for the initial patch.
[Feature] #559: rsync_project now allows users to append extra SSH-specific
arguments to rsync`s --rsh flag.
[Feature] #138: env.port may now be written to at fabfile module level to set a
default nonstandard port number. Previously this value was read-only.
[Feature] #3: Fabric can now load a subset of SSH config functionality directly
from your local ~/.ssh/config if env.use_ssh_config is set to True. See
Leveraging native SSH config files for details. Thanks to Kirill Pinchuk for
the initial patch.
[Feature] #12: Added the ability to try connecting multiple times to
temporarily-down remote systems, instead of immediately failing. (Default
behavior is still to only try once.) See env.timeout and
env.connection_attempts for controlling both connection timeouts and total
number of attempts. reboot has also been overhauled (but practically deprecated
- see its updated docs.)
[Feature] #474: execute now allows you to access the executed task's return
values, by itself returning a dictionary whose keys are the host strings
executed against.
[Bug] #487: Overhauled the regular expression escaping performed in append and
contains to try and handle more corner cases. Thanks to Neilen Marais for the
patch.
[Support] #532: Reorganized and cleaned up the output of fab --help.
[Feature] #8: Added --skip-bad-hosts/env.skip_bad_hosts option to allow
skipping past temporarily down/unreachable hosts.
[Feature] #13: Env vars may now be set at runtime via the new --set
command-line flag.
[Feature] #506: A new output alias, commands, has been added, which allows
hiding remote stdout and local "running command X" output lines.
[Feature] #72: SSH agent forwarding support has made it into Fabric's SSH
library, and hooks for using it have been added (disabled by default; use -A or
env.forward_agent to enable.) Thanks to Ben Davis for porting an existing
Paramiko patch to ssh and providing the necessary tweak to Fabric.
pkgsrc changes:
- Adjust dependency chain. Now depends on security/py-ssh instead of
security/py-paramiko.
Upstream changes:
The main new feature in Fabric 1.3.x is parallel tasks execution support
(invoked by fab -P).
Releases at the same time in the 1.2.x and 1.3.x branches, including the
same bugfixes.
Changes since the latest release in the 1.2.x branch (1.2.5), included in
branch 1.3:
2012-01-12: released Fabric 1.3.4
[Bug] #492: @parallel did not automatically trigger linewise output, as was
intended. This has been fixed. Thanks to Brandon Huey for the catch.
[Bug] #510: Parallel mode is incompatible with user input, such as
password/hostname prompts, and was causing cryptic Operation not supported
by device errors when such prompts needed to be displayed. This behavior
has been updated to cleanly and obviously abort instead.
[Bug] #494: Fixed regression bug affecting some env values such as env.port
under parallel mode. Symptoms included rsync_project bailing out due to a
None port value when run under @parallel. Thanks to Rob Terhaar for the
report.
[Bug] #339: Don't show imported colors members in --list output. Thanks to
Nick Trew for the report.
Upstream changes:
2011-11-23: released Fabric 1.2.5
2011-11-23: released Fabric 1.1.7
[Bug] #441: Specifying a task module as a task on the command line no
longer blows up but presents the usual "no task by that name" error
message instead. Thanks to Mitchell Hashimoto for the catch.
[Bug] #475: Allow escaping of equals signs in per-task args/kwargs.
[Bug] #450: Improve traceback display when handling "ImportError"s
for dependencies. Thanks to David Wolever for the patches.
[Bug] #446: Add QNX to list of secondary-case sed targets. Thanks to
Rodrigo Madruga for the tip.
[Bug] #443: exists didn't expand tildes; now it does. Thanks to
Riccardo Magliocchetti for the patch.
[Bug] #437: with_settings now correctly preserves the wrapped
function's docstring and other attributes. Thanks to Eric Buckley for the
catch and Luke Plant for the patch.
[Bug] #400: Handle corner case of systems where pwd.getpwuid raises KeyError
for the user's UID instead of returning a valid string. Thanks to Dougal
Matthews for the catch.
[Bug] #397: Some poorly behaved objects in third party modules triggered
exceptions during Fabric's "classic or new-style task?" test. A fix has
been added which tries to work around these.
[Bug] #341: append incorrectly failed to detect that the line(s) given
already existed in files hidden to the remote user, and continued appending
every time it ran. This has been fixed. Thanks to Dominique Peretti for the
catch and Martin Vilcans for the patch.
[Bug] #342: Combining cd with put and its use_sudo keyword caused an
unrecoverable error. This has been fixed. Thanks to Egor M for the report.
[Bug] #482: Parallel mode should imply linewise output; omission of this
behavior was an oversight.
[Bug] #230: Fix regression re: combo of no fabfile & arbitrary command use.
Thanks to Ali Saifee for the catch.
Upstream changes:
2011-11-07: released Fabric 1.2.4
[Support] #459: Update our setup.py files to note that PyCrypto released
2.4.1, which fixes the setuptools problems.
[Support] #467: (also #468, #469) Handful of documentation clarification
weaks. Thanks to Paul Hoffman for the patches.
Upstream changes since 1.2.2:
🐛`323` ~fabric.operations.put forgot how to expand leading tildes in
the remote file path. This has been corrected. Thanks to Piet Delport for
the catch.
🐛`182` During display of remote stdout/stderr, Fabric occasionally
printed extraneous line prefixes (which in turn sometimes overwrote wrapped
text.) This has been fixed.
🐛`430` Tasks decorated with ~fabric.decorators.runs_once printed
extraneous 'Executing...' status lines on subsequent invocations. This is
noisy at best and misleading at worst, and has been corrected. Thanks to
Jacob Kaplan-Moss for the report.
Update to 1.3 will require a new Python ssh library - forked from paramiko.
Full changelog is: https://github.com/fabric/fabric/blob/1.2.2/docs/changelog.rst
Changelog:
:release:`1.2.2 <2011-09-01>`
:release:`1.1.4 <2011-09-01>`
:release:`1.0.4 <2011-09-01>`
🐛`252` ~fabric.context_managers.settings would silently fail to set env values for keys which did not exist outside the context manager block. It now works as expected. Thanks to Will Maier for the catch and suggested solution.
:support:`393` Fixed a typo in an example code snippet in the task docs. Thanks to Hugo Garza for the catch.
🐛`396` :option:`--shortlist` broke after the addition of :option:`--list-format <-F>` and no longer displayed the short list format correctly. This has been fixed.
🐛`373` Re-added missing functionality preventing :ref:`host exclusion <excluding-hosts>` from working correctly.
🐛`303` Updated terminal size detection to correctly skip over non-tty stdout, such as when running fab taskname | other_command.
:release:`1.2.1 <2011-08-21>`
:release:`1.1.3 <2011-08-21>`
:release:`1.0.3 <2011-08-21>`
🐛`417` :ref:`abort-on-prompts` would incorrectly abort when set to True, even if both password and host were defined. This has been fixed. Thanks to Valerie Ishida for the report.
:support:`416` Updated documentation to reflect move from Redmine to Github.
🐛`389` Fixed/improved error handling when Paramiko import fails. Thanks to Brian Luft for the catch.
Upstream changelog:
=========
* :release:`1.2.0 <2011-07-12>`
* :feature:`22` Enhanced `@task <fabric.decorators.task>` to add :ref:`aliasing
<task-aliases>`, :ref:`per-module default tasks <default-tasks>`, and
:ref:`control over the wrapping task class <task-decorator-and-classes>`.
Thanks to Travis Swicegood for the initial work and collaboration.
* 🐛`380` Improved unicode support when testing objects for being
string-like. Thanks to Jiri Barton for catch & patch.
* :support:`382` Experimental overhaul of changelog formatting & process to
make supporting multiple lines of development less of a hassle.
* :release:`1.1.2 <2011-07-07>` (see below for details)
* :release:`1.0.2 <2011-06-24>` (see below for details)
Prehistory
==========
The content below this section comes from older versions of Fabric which wrote
out changelogs to individual, undated files. They have been concatenated and
preserved here for historical reasons, and may not be in strict chronological
order.
----
Changes in version 1.1.2 (2011-07-07)
=====================================
Bugfixes
--------
* :issue:`375`: The logic used to separate tasks from modules when running
``fab --list`` incorrectly considered task classes implementing the mapping
interface to be modules, not individual tasks. This has been corrected.
Thanks to Vladimir Mihailenco for the catch.
Upstream changes highlights:
Many, many bugfixes.
In release 1.1, highlights are
* #76: New-style tasks have been added. With the addition of the task
decorator and the Task class, you can now "opt-in" and explicitly mark task
functions as tasks, and Fabric will ignore the rest. The original behavior (now
referred to as "classic" tasks) will still take effect if no new-style tasks are
found. Major thanks to Travis Swicegood for the original implementation.
* #56: Namespacing is now possible: Fabric will crawl imported module
objects looking for new-style task objects and build a dotted hierarchy (tasks
named e.g. web.deploy or db.migrations.run), allowing for greater organization.
See Namespaces for details. Thanks again to Travis Swicegood.
Upstream changes:
Bugfixes
* #301: Fixed a bug in local?s behavior when capture=False and output.stdout
(or .stderr) was also False. Thanks to Chris Rose for the catch.
* #310: Update edge case in put where using the mode kwarg alongside
use_sudo=True runs a hidden sudo command. The mode kwarg needs to be octal but
was being interpolated in the sudo call as a string/integer. Thanks to Adam
Ernst for the catch and suggested fix.
* #311: append was supposed to have its partial kwarg's default flipped from
True to False. However, only the documentation was altered. This has been fixed.
Thanks to Adam Ernst for bringing it to our attention.
* #312: Tweak internal I/O related loops to prevent high CPU usage and poor
screen-printing behavior on some systems. Thanks to Kirill Pinchuk for the
initial patch.
* #320: Some users reported problems with dropped input, particularly while
entering sudo passwords. This was fixed via the same change as for #312.
Documentation
* Added a missing entry for env.path in the usage documentation.
Pkgsrc changes:
- Confirm it's working with python27
Upstream changes:
Changes in version 1.0
This page lists all changes made to Fabric in its 1.0.0 release.
Highlights
* #7: run/sudo now allow full interactivity with the remote end. You can
interact with remote prompts and similar interfaces, making certain tasks much
easier, and freeing you from the need to find noninteractive solutions if you
don't want to. See Interaction with remote programs for more on these changes.
* put and get received many updates, including but not limited to: recursion,
globbing, inline sudo capability, and increased control over local file paths.
See the individual ticket line-items below for details. Erich Heine (sophacles
on IRC) played a large part in implementing and/or collecting these changes and
deserves much of the credit.
* Added functionality for loading fabfiles which are Python packages
(directories) instead of just modules (single files). This allows for easier
organization of nontrivial fabfiles and paves the way for task namespacing in
the near future. See Fabfile discovery for details.
* #185: Mostly of interest to those contributing to Fabric itself, Fabric
now leverages Paramiko to provide a stub SSH and SFTP server for use during runs
of our test suite. This makes quick, configurable full-stack testing of Fabric
(and, to an extent, user fabfiles) possible.
Backwards-incompatible changes
The below changes are backwards incompatible and have the potential to break
your 0.9.x based fabfiles!
* contains and append previously had the filename argument in the second
position, whereas all other functions in the contrib.files module had filename
as the first argument. These two functions have been brought in line with the
rest of the module.
* sed now escapes single-quotes and parentheses in addition to forward
slashes, in its before and after kwargs. Related to, but not entirely contained
within, #159.
* The user and pty kwargs in sudo's signature have had their order swapped
around to more closely match run.
* As part of the changes made in #7, run and sudo have had the default value
of their pty kwargs changed from False to True. This, plus the addition of the
combine_stderr kwarg/env var, may result in significant behavioral changes in
remote programs which operate differently when attached to a tty.
* #61: put and get now honor the remote current-working-directory changes
applied by cd. Previously they would always treat relative remote paths as being
relative to the remote home directory.
* #79: get now allows increased control over local filenames when downloading
single or multiple files. This is backwards incompatible because the default
path/filename for downloaded files has changed. Thanks to Juha Mustonen, Erich
Heine and Max Arnold for brainstorming solutions.
* #88: local has changed the default value of its capture kwarg, from True
to False. This was changed in order to be more intuitive, at the cost of no
longer defaulting to the same rich return value as in run/sudo (which is still
available by specifying capture=True.)
* #121: put will no longer automatically attempt to mirror local file modes.
Instead, you?ll need to specify mirror_local_mode=True to get this behavior.
Thanks to Paul Smith for a patch covering part of this change.
* #172: append has changed the default value of its partial kwarg from True
to False in order to be safer/more intuitive.
* #221: runs_once now memoizes the wrapped task's return value and returns
that value on subsequent invocations, instead of returning None. Thanks to Jacob
Kaplan-Moss and Travis Swicegood for catch + patch.
Feature additions
* Prerelease versions of Fabric (starting with the 1.0 prereleases) will now
print the Git SHA1 hash of the current checkout, if the user is working off of a
Git clone of the Fabric source code repository.
* Added path context manager for modifying commands? effective $PATH.
* Added convenience .succeeded attribute to the return values of
run/sudo/local which is simply the opposite of the .failed attribute. (This
addition has also been backported to Fabric's 0.9 series.)
* Refactored SSH disconnection code out of the main fab loop into
disconnect_all, allowing library users to avoid problems with non-fabfile Python
scripts hanging after execution finishes.
* #2: Added use_sudo kwarg to put to allow uploading of files to privileged
locations. Thanks to Erich Heine and IRC user npmap for suggestions and patches.
* #23: Added prefix context manager for easier management of persistent state
across commands.
* #27: Added environment variable (always_use_pty) and command-line flag
(--no-pty) for global control over the run/sudo pty argument.
* #28: Allow shell-style globbing in get. Thanks to Erich Heine and Max Arnold.
* #55: run, sudo and local now provide access to their standard error (stderr)
as an attribute on the return value, alongside e.g. .failed.
* #148: local now returns the same 'rich' string object as run/sudo do, so
that it is a string containing the command's stdout (if capture=True) or the
empty string (if capture=False) which exposes the .failed and .return_code
attributes, and so forth.
* #151: Added a puts utility function, which allows greater control over
fabfile-generated (as opposed to Fabric-generated) output. Also added fastprint,
an alias to puts allowing for convenient unbuffered, non-newline-terminated
printing.
* #192: Added per-user/host password cache to assist in multi-connection
scenarios.
* #193: When requesting a remote pseudo-terminal, use the invoking terminal's
dimensions instead of going with the default.
* #217: get/put now accept file-like objects as well as local file paths for
their local_path arguments.
* #245: Added the lcd context manager for controlling local's current working
directory and put/get's local working directories.
* #274: put/get now have return values which may be iterated over to access
the paths of files uploaded remotely or downloaded locally, respectively. These
return values also allow access to .failed and .succeeded attributes, just like
run and friends. (In this case, .failed is actually a list itself containing any
paths which failed to transfer, which naturally acts as a boolean as well.)
Bugfixes
* N/A
Documentation updates
* API, tutorial and usage docs updated with the above new features.
* README now makes the Python 2.5+ requirement up front and explicit; some
folks were still assuming it would run on Python 2.4.
* Added a link to Python?s documentation for string interpolation in
upload_template's docstring.
Changes in version 0.9.5
The following changes were implemented in Fabric 0.9.5:
Bugfixes
* #264: Fix edge case in reboot by gracefully clearing connection cache.
* #268: Allow for @ symbols in usernames, which is valid on some systems.
Fabric's host-string parser now splits username and hostname at the last @
found instead of the first.
Very minor release.
pkgsrc changes:
- switch MASTER_SITES to pypi.python.org
upstream changes:
* Added documentation for using Fabric as a library.
* Mentioned our Twitter account on the main docs page.
* #290: Added escape kwarg to append to allow control over previously automatic single-quote escaping.
Pkgsrc changes:
- add depends to py-crypto
Upstream changes:
0.9.3
=====
Feature additions
* #255: Added stderr and succeeded attributes to local.
* #254: Backported the .stderr and .succeeded attributes on run/sudo return
values, from the Git master/pre-1.0 branch. Please see those functions? API
docs for details.
Bugfixes
* #228: We discovered that the pip + PyCrypto installation problem was limited
to Python 2.5 only, and have updated our setup.py accordingly.
* #230: Arbitrary or remainder commands (fab <opts> -- <run command here>) will
no longer blow up when invoked with no fabfile present. Thanks to IRC user
orkaa for the report.
* #242: Empty string values in task CLI args now parse correctly. Thanks to
Aaron Levy for the catch + patch.
Documentation updates
* #239: Fixed typo in execution usage docs. Thanks to Pradeep Gowda and Turicas
for the catch.
0.9.2
=====
Feature additions
* The reboot operation has been added, providing a way for Fabric to issue a
reboot command and then reconnect after the system has restarted.
* python setup.py test now runs Fabric?s test suite (provided you have all the
prerequisites from the requirements.txt installed). Thanks to Eric Holscher for
the patch.
* Added functionality for loading fabfiles which are Python packages
(directories) instead of just modules (single files.) See Fabfile discovery.
* Added output lines informing the user of which tasks are being executed (e.g.
[myserver] Executing task 'foo'.)
* Added support for lazy (callable) role definition values in env.roledefs.
* Added contrib.django module with basic Django integration.
* env.local_user was added, providing easy and permanent access to the local
system username, even if an alternate remote username has been specified.
* #29: Added support for arbitrary command-line-driven anonymous tasks via
fab [options] -- [shell command]. See Arbitrary remote shell commands.
* #52: Full tracebacks during aborts are now displayed if the user has opted to
see debug-level output.
* #101: Added colors module with basic color output support. (#101 is still
open: we plan to leverage the new module in Fabric?s own output in the future.)
* #137: Commas used to separate per-task arguments may now be escaped with a
backslash. Thanks to Erich Heine for the patch.
* #144: hosts (and roles) will now expand a single, iterable argument instead of
requiring one to use e.g. @hosts(*iterable).
* #151: Added a puts utility function, which allows greater control over
fabfile-generated (as opposed to Fabric-generated) output. Also added fastprint,
an alias to puts allowing for convenient unbuffered, non-newline-terminated
printing.
* #208: Users rolling their own shell completion or who otherwise find
themselves performing text manipulation on the output of --list may now use
--shortlist to get a plain, newline-separated list of task names.
Bugfixes
* The interactive ?what host to connect to?? prompt now correctly updates the
appropriate environment variables (hostname, username, port) based on user input.
* Fixed a bug where Fabric?s own internal fabfile would pre-empt the user?s
fabfile due to a PYTHONPATH order issue. User fabfiles are now always loaded at
the front of the PYTHONPATH during import.
* Disabled some DeprecationWarnings thrown by Paramiko when that library is
imported into Fabric under Python 2.6.
* #44, #63: Modified rsync_project to honor the SSH port and identity file
settings. Thanks to Mitch Matuson and Morgan Goose.
* #123: Removed Cygwin from the ?are we on Windows? test; now, only Python
installs whose sys.platform says 'win32' will use Windows-only code paths
(e.g. importing of pywin32).
Documentation updates
* Added a few new items to the FAQ.
* #173: Simple but rather embarrassing typo fix in README. Thanks to Ted Nyman
for the catch.
* #194: Added a note to the install docs about a possible edge case some
Windows 64-bit Python users may encounter.
* #216: Overhauled the process backgrounding FAQ to include additional
techniques and be more holistic.
Packaging updates
* #86, #158: Removed the bundled Paramiko 1.7.4 and updated the setup.py to
require Paramiko >=1.7.6. This lets us skip the known-buggy Paramiko 1.7.5 while
getting some much needed bugfixes in Paramiko 1.7.6.
========================
Changes in version 0.9.1
========================
The following changes were implemented in Fabric 0.9.1:
Feature additions
=================
:issue:`82`: `~fabric.contrib.files.append` now offers a `partial` kwarg
allowing control over whether the "don't append if given text already exists"
test looks for exact matches or not. Thanks to Jonas Nockert for the catch
and discussion.
:issue:`112`: `fab --list` now prints out the fabfile's module-level
docstring as a header, if there is one.
:issue:`141`: Added some more CLI args/env vars to allow user configuration
of the Paramiko `connect` call -- specifically :ref:`no_agent` and
:ref:`no_keys`.
Bugfixes
========
:issue:`75`: `fab`, when called with no arguments or (useful) options, now
prints help, even when no fabfile can be found. Previously, calling `fab`
in a location with no fabfile would complain about the lack of fabfile
instead of displaying help.
:issue:`130`: Context managers now correctly clean up `env` if they
encounter an exception. Thanks to Carl Meyer for catch + patch.
:issue:`132`: `~fabric.operations.local` now calls `strip` on its stdout,
matching the behavior of `~fabric.operations.run`/`~fabric.operations.sudo`.
Thanks to Carl Meyer again on this one.
:issue:`166`: `~fabric.context_managers.cd` now correctly overwrites
`env.cwd` when given an absolute path, instead of naively appending its
argument to `env.cwd`'s previous value.
Documentation updates
=====================
A number of small to medium documentation tweaks were made which had no
specific Redmine ticket. The largest of these is the addition of :doc:`the
FAQ <../faq>` to the Sphinx documentation instead of storing it as a
source-only text file. (Said FAQ was also slightly expanded with new FAQs.)
:issue:`17`: Added :ref:`note to FAQ <faq-daemonize>` re: use of `dtach` as
alternative to `screen`. Thanks to Erich Heine for the tip.
:issue:`64`: Updated :ref:`installation docs <downloads>` to clarify where
package maintainers should be downloading tarballs from. Thanks to James
Pearson for providing the necessary perspective.
:issue:`95`: Added a link to a given version's changelog on the PyPI page
(technically, to the `setup.py` `long_description` field).
:issue:`110`: Alphabetized :ref:`the CLI argument command reference
<command-line-options>`. Thanks to Erich Heine.
:issue:`120`: Tweaked documentation, help strings to make it more obvious
that fabfiles are simply Python modules.
:issue:`127`: Added :ref:`note to install docs <pypm>` re: ActiveState's
PyPM. Thanks to Sridhar Ratnakumar for the tip.
Fabric is a Python library and command-line tool for streamlining the use
of SSH for application deployment or systems administration tasks.
It provides a basic suite of operations for executing local or remote shell
commands (normally or via sudo) and uploading/downloading files, as well as
auxiliary functionality such as prompting the running user for input, or
aborting execution.
