991728400a
Interacting with a long-running asynchronous process requires the use of non-blocking io. This change adds a helper class that can launch a long-running process and read stdout and stderr in a non-blocking fashion via eventlet. This functionality is intended to support monitoring ovsdb via a long-running and root-privileged invocation of ovsdb-client. The complexity of the system interaction in this patch suggested the addition of a functional test that validated actual behaviour. The test was added under the neutron/tests/functional path which is now included in the testr search path. Partial-Bug: #1177973 Change-Id: I9969e556acecf7a9e77d873371cc2ec2647be011
125 lines
4.2 KiB
Python
125 lines
4.2 KiB
Python
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
|
|
# Copyright 2012 Locaweb.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
#
|
|
# @author: Juliano Martinez, Locaweb.
|
|
|
|
import fcntl
|
|
import os
|
|
import shlex
|
|
import socket
|
|
import struct
|
|
import tempfile
|
|
|
|
from eventlet.green import subprocess
|
|
from eventlet import greenthread
|
|
|
|
from neutron.common import utils
|
|
from neutron.openstack.common import log as logging
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def create_process(cmd, root_helper=None, addl_env=None):
|
|
"""Create a process object for the given command.
|
|
|
|
The return value will be a tuple of the process object and the
|
|
list of command arguments used to create it.
|
|
"""
|
|
if root_helper:
|
|
cmd = shlex.split(root_helper) + cmd
|
|
cmd = map(str, cmd)
|
|
|
|
LOG.debug(_("Running command: %s"), cmd)
|
|
env = os.environ.copy()
|
|
if addl_env:
|
|
env.update(addl_env)
|
|
|
|
obj = utils.subprocess_popen(cmd, shell=False,
|
|
stdin=subprocess.PIPE,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE,
|
|
env=env)
|
|
|
|
return obj, cmd
|
|
|
|
|
|
def execute(cmd, root_helper=None, process_input=None, addl_env=None,
|
|
check_exit_code=True, return_stderr=False):
|
|
try:
|
|
obj, cmd = create_process(cmd, root_helper=root_helper,
|
|
addl_env=addl_env)
|
|
_stdout, _stderr = (process_input and
|
|
obj.communicate(process_input) or
|
|
obj.communicate())
|
|
obj.stdin.close()
|
|
m = _("\nCommand: %(cmd)s\nExit code: %(code)s\nStdout: %(stdout)r\n"
|
|
"Stderr: %(stderr)r") % {'cmd': cmd, 'code': obj.returncode,
|
|
'stdout': _stdout, 'stderr': _stderr}
|
|
LOG.debug(m)
|
|
if obj.returncode and check_exit_code:
|
|
raise RuntimeError(m)
|
|
finally:
|
|
# NOTE(termie): this appears to be necessary to let the subprocess
|
|
# call clean something up in between calls, without
|
|
# it two execute calls in a row hangs the second one
|
|
greenthread.sleep(0)
|
|
|
|
return return_stderr and (_stdout, _stderr) or _stdout
|
|
|
|
|
|
def get_interface_mac(interface):
|
|
DEVICE_NAME_LEN = 15
|
|
MAC_START = 18
|
|
MAC_END = 24
|
|
s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
|
|
info = fcntl.ioctl(s.fileno(), 0x8927,
|
|
struct.pack('256s', interface[:DEVICE_NAME_LEN]))
|
|
return ''.join(['%02x:' % ord(char)
|
|
for char in info[MAC_START:MAC_END]])[:-1]
|
|
|
|
|
|
def replace_file(file_name, data):
|
|
"""Replaces the contents of file_name with data in a safe manner.
|
|
|
|
First write to a temp file and then rename. Since POSIX renames are
|
|
atomic, the file is unlikely to be corrupted by competing writes.
|
|
|
|
We create the tempfile on the same device to ensure that it can be renamed.
|
|
"""
|
|
|
|
base_dir = os.path.dirname(os.path.abspath(file_name))
|
|
tmp_file = tempfile.NamedTemporaryFile('w+', dir=base_dir, delete=False)
|
|
tmp_file.write(data)
|
|
tmp_file.close()
|
|
os.chmod(tmp_file.name, 0o644)
|
|
os.rename(tmp_file.name, file_name)
|
|
|
|
|
|
def find_child_pids(pid):
|
|
"""Retrieve a list of the pids of child processes of the given pid."""
|
|
try:
|
|
raw_pids = execute(['ps', '--ppid', pid, '-o', 'pid='])
|
|
except RuntimeError as e:
|
|
# Exception has already been logged by execute
|
|
no_children_found = 'Exit code: 1' in str(e)
|
|
if no_children_found:
|
|
return []
|
|
# Unexpected errors are the responsibility of the caller
|
|
raise
|
|
return [x.strip() for x in raw_pids.split('\n') if x.strip()]
|