19 Commits

Author SHA1 Message Date
Angus Lees
9d28946395 Make ProcessExecutionError picklable
Serialising/deserialising exceptions in python follows the protocol
defined by pickle.  It relies on the base Exception.__init__ setting
self.args, and later resurrects exceptions with class(*args).

This change rewrites processutils.ProcessExecutionError so it survives a
pickle.dumps/loads round-trip.

Change-Id: I9b8d104f60df868be7b808c72c932d08f1752777
2016-02-19 15:52:23 +11:00
Victor Stinner
b2e78569c5 Add prlimit parameter to execute()
Add a new oslo_concurrency.prlimit module which is written to be used
on the command line:

    python -m oslo_concurrency.prlimit --rss=RSS -- program arg1 ...

This module calls setrlimit() to restrict the resources and then
executes the program. Its command line is written to be the same than
the Linux prlimit system program.

Add a new ProcessLimits class processutils: resource limits on a
process.

Add an optional prlimit parameter to process_utils.execute(). If the
parameter is used, wrap the command through the new oslo_concurrency
prlimit wrapper.

Linux provides a prlimit command line tool which implements the same
feature (and even more), but it requires util-linux v2.21, and
OpenStack targets other operating systems like Solaris and FreeBSD.

Change-Id: Ib40aa62958ab9c157a2bd51d7ff3edb445556285
Related-Bug: 1449062
2016-01-28 15:00:06 +01:00
Victor Stinner
e01418018f Use versionadded and versionchanged in doc
Document in which version new types and functions were added using
".. versionadded:: x.y". Document changes using
".. versionchanged:: x.y."

For watchdog module, add the versionadded tag in the module top
docstring, not on each type/function.

Add docstring to ssh_execute().

I used "git blame" + "git tag --contains=SHA1" to find these version,
and then I checked manually each version.

Change-Id: I56a7d8a4335833e9b49eedab026d20adfeedf942
2015-11-05 13:31:40 +01:00
Joshua Harlow
ed7472e954 Use int enumerations for log error constants
Change-Id: Iac6f4d860c220c653bbae17e7b1d69249259bd88
2015-09-01 12:49:08 -07:00
Davanum Srinivas
36fb964f0c Allow preexec_fn method for processutils.execute
If the user specifies preexec_fn, we should call that in
our existing _subprocess_setup. On windows, we silently
drop this preexec_fn as subprocess.Popen raises a ValueError
if we do pass it in.

Change-Id: I0176c66fa2de001aa14f0d928d06fd894de55511
2015-07-07 10:12:58 -07:00
Daniel P. Berrange
ab78480659 processutils: ensure on_completion callback is always called
If the subprocess.Popen.communicate method raises an exception,
the on_completion callback is never invoked. If a caller is
trying to use on_execute + on_completion to track lifecycle
of a process this creates a problem, as they cannot reliably
detect completion.

Change-Id: I22b2d7bde8797276f7670bc289d915dab5122481
Closes-bug: #1470868
2015-07-02 17:34:57 +01:00
Joshua Harlow
a0fabfc688 Use better timing mechanisms instead of time.time()
To ensure we show accurate timing information about
lock acqusition and release times use a timing mechanism
which can not/should not move backwards.

Change-Id: I9559b20cf7de67fc474e6e17eda23791ecc4122e
2015-06-22 10:34:30 -07:00
Tony Breeds
d8307005bf Add 2 callbacks to processutils.execute()
Add optional on_execute and on_completion callbacks to allow callers of
procesutils.execute() to track process completion asynchronously.

This could be used to cache the pid of long running tasks associated
with an instance and then clear the cache when the process completes.
While the tasks are running should it be required the pid retrieved and
the process can be signaled.

Co-Authored-By: abhishekkekane <abhishek.kekane@nttdata.com>
Change-Id: Ifc23325eddb523f6449ba06a2deb0885a8a7009d
2015-06-17 10:39:36 +10:00
Victor Stinner
4d7dce2ea8 Add binary parameter to execute and ssh_execute
Add an optional binary parameter to execute() and ssh_execute()
functions of oslo_concurrency.processutils. If binary is True, stdout
and stderr are returned as byte strings on Python 2 and Python 3.

When Nova will be ported to Python 3, binary=True will be needed to get
binary outputs (like an encryption key, see the bug #1410348).

Add new tests.

This changeset does not change the default behaviour.

Change-Id: I283cadf04781942b65f211237070cc2354939cdb
Related-Bug: 1410348
2015-04-19 01:17:43 +02:00
Victor Stinner
c05c8c37be Port processutils to Python 3
On Python 3, execute() and ssh_execute() now return stdout and stderr as
Unicode. os.fsdecode() is used to stdout and stderr, it uses the locale
encoding with the surrogateescape error handler.
subprocess.Popen(universal_encoding=True) uses the same encoding and
error handler.

This change breaks the backward compatibility, but I believe that
Unicode is more convinient in Python 3 and it is what users expect. In
practice, there is no known (OpenStack) application compatible with
Python 3 using oslo_concurrency.processutils yet.

Add new tests.

This changeset does not change the behaviour on Python 2, only Python 3
is impacted.

Change-Id: Ibb510642c1440e2fbe7ad53d797bc7c32a3cbddf
2015-04-18 00:11:28 +02:00
Jenkins
2f510962ab Merge "processutils: execute(): fix option incompatibility" 2015-02-17 18:38:41 +00:00
Csaba Henk
c20a86d550 processutils: execute(): fix option incompatibility
Issue: simultaneous usage of 'shell' and 'run_as_root' options led
to error.

Cause: it's actually a concealed TypeError: in 'shell'
mode the command argument is assumed to be a string, elsewhere
a list/tuple.

Fix: the command editing implied by 'run_as_root' is performed
with care taken of above tacit type assumption.

Change-Id: Iaba33e6fda67793ae2874ba278c990271ee5e47f
Closes-Bug: #1382873
2015-02-14 02:00:04 +01:00
Davanum Srinivas
3d6e372ea4 Ability to set working directory
Currently folks end up using os.chdir() (see bug listed below) as
we are not exposing the subprocess.Popen's cwd parameter. It's
better to add a cwd parameter in processutils.execute so folks
do not have to issue chdir() before and after the processutils.
execute and there's less scope for problem as documented in
the bug.

Closes-Bug: #1414530
Change-Id: Ia4c77593c0f8301e059b349290e8663614a7ccfd
2015-02-13 16:17:55 -05:00
Doug Hellmann
da8176dbdf Update Oslo imports to remove namespace package
Change-Id: I4ec9b2a310471e4e07867073e9577731ac34027d
Blueprint: drop-namespace-packages
2015-01-21 18:00:50 -05:00
Jenkins
f034bd2877 Merge "Revert "Port processutils to Python 3"" 2015-01-14 00:43:37 +00:00
Doug Hellmann
acb55ef279 Revert "Port processutils to Python 3"
This reverts commit 7c7493feb53429577efca2c4b0380af03ddc149b.

This change breaks the API of execute() and breaks nova's tests.

Closes-Bug: #1410348
Change-Id: I33fa9b4e6099f521e0de3cb4585016fd694c4548
2015-01-13 17:54:43 +00:00
Sean Dague
234b007b75 make time format for processutils match lockutils
Lockutils uses %0.3fs for time format, which gives us a convenient
time in milliseconds. Process utils was an unbounded string which
gives us times like:

CMD "cat /proc/31599/cmdline" returned: 0 in 0.00526595115662s execute

The super long time strings are mostly confusing, and millisecond
accuracy should be sufficient for processutils.

Change-Id: I57f21b18ab060a36c3d88b0c5a94430eafeb02a2
2015-01-07 08:18:56 -05:00
Victor Stinner
7c7493feb5 Port processutils to Python 3
Add encoding and errors parameters to execute() and ssh_execute(). By
default, use the locale encoding in strict mode on Python 2, or the
locale encoding with the 'surrogateescape' error handler on Python 3.

Fix also unit tests to use bytes strings for stdin, stdout and stderr.

Without this change, tests are failing with Python 3 when run with:
PYTHON="python -bb" testr run

Using -bb, Python 3 raises a TypeError when a bytes string is casted
to a text string, which occurred in many places.

Change-Id: I655d5abf932c9a104e3ab487e23c372377f7096a
2014-12-12 00:09:55 +01:00
Doug Hellmann
bca4a0d827 Move out of the oslo namespace package
Move the public API out of oslo.concurrency to oslo_concurrency. Retain
the ability to import from the old namespace package for backwards
compatibility for this release cycle.

bp/drop-namespace-packages

Change-Id: I20d1647b1c3ef8cab3b69eccfe168eeb01703b72
2014-11-14 17:17:25 -05:00