Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 17 additions & 19 deletions docker/utils/socket.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def read(socket, n=4096):
poll.poll()

try:
if hasattr(socket, 'recv'):
if hasattr(socket, "recv"):
return socket.recv(n)
if isinstance(socket, pysocket.SocketIO):
return socket.read(n)
Expand All @@ -49,13 +49,15 @@ def read(socket, n=4096):
if e.errno not in recoverable_errors:
raise
except Exception as e:
is_pipe_ended = (isinstance(socket, NpipeSocket) and
len(e.args) > 0 and
e.args[0] == NPIPE_ENDED)
is_pipe_ended = (
isinstance(socket, NpipeSocket)
and len(e.args) > 0
and e.args[0] == NPIPE_ENDED
)
if is_pipe_ended:
# npipes don't support duplex sockets, so we interpret
# a PIPE_ENDED error as a close operation (0-length read).
return ''
return ""
raise


Expand Down Expand Up @@ -85,7 +87,7 @@ def next_frame_header(socket):
except SocketError:
return (-1, -1)

stream, actual = struct.unpack('>BxxxL', data)
stream, actual = struct.unpack(">BxxxL", data)
return (stream, actual)


Expand Down Expand Up @@ -156,22 +158,18 @@ def consume_socket_output(frames, demux=False):

# If the streams are demultiplexed, the generator yields tuples
# (stdout, stderr)
out = [None, None]
for frame in frames:
stdout = []
stderr = []
for stdout_frame, stderr_frame in frames:
# It is guaranteed that for each frame, one and only one stream
# is not None.
assert frame != (None, None)
if frame[0] is not None:
if out[0] is None:
out[0] = frame[0]
else:
out[0] += frame[0]
if stdout_frame:
stdout.append(stdout_frame)
else:
if out[1] is None:
out[1] = frame[1]
else:
out[1] += frame[1]
return tuple(out)
stderr.append(stderr_frame)
stdout = b"".join(stdout) if len(stdout) > 0 else None
stderr = b"".join(stderr) if len(stderr) > 0 else None
return stdout, stderr


def demux_adaptor(stream_id, data):
Expand Down
29 changes: 29 additions & 0 deletions tests/unit/utils_socket_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import unittest

from docker.utils.socket import consume_socket_output


class SocketConsumeOutputTests(unittest.TestCase):
def test_no_demux(self):
frames = [b"frame1", b"frame2", b"frame3"]
result = consume_socket_output(frames, demux=False)
self.assertEqual(result, b"frame1frame2frame3")

def test_demux(self):
frames = [
(b"stdout1", None),
(None, b"stderr1"),
(b"stdout2", None),
(None, b"stderr2"),
]
stdout, stderr = consume_socket_output(frames, demux=True)
self.assertEqual(stdout, b"stdout1stdout2")
self.assertEqual(stderr, b"stderr1stderr2")

def test_empty_frames(self):
result = consume_socket_output([], demux=False)
self.assertEqual(result, b"")

def test_empty_frames_demux(self):
stdout, stderr = consume_socket_output([], demux=True)
self.assertEqual((None, None), (stdout, stderr))