Merged
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
23 changes: 16 additions & 7 deletions compose/cli/log_printer.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,11 +13,18 @@
class LogPrinter(object):
"""Print logs from many containers to a single output stream."""

def __init__(self, containers, output=sys.stdout, monochrome=False, cascade_stop=False):
def __init__(self,
containers,
output=sys.stdout,
monochrome=False,
cascade_stop=False,
log_args=None):
log_args = log_args or {}
self.containers = containers
self.output = utils.get_output_stream(output)
self.monochrome = monochrome
self.cascade_stop = cascade_stop
self.log_args = log_args

def run(self):
if not self.containers:
Expand All@@ -41,7 +48,7 @@ def no_color(text):
for color_func, container in zip(color_funcs, self.containers):
generator_func = get_log_generator(container)
prefix = color_func(build_log_prefix(container, prefix_width))
yield generator_func(container, prefix, color_func)
yield generator_func(container, prefix, color_func, self.log_args)


def build_log_prefix(container, prefix_width):
Expand All@@ -64,28 +71,30 @@ def get_log_generator(container):
return build_no_log_generator


def build_no_log_generator(container, prefix, color_func):
def build_no_log_generator(container, prefix, color_func, log_args):
"""Return a generator that prints a warning about logs and waits for
container to exit.
"""
yield "{} WARNING: no logs are available with the '{}' log driver\n".format(
prefix,
container.log_driver)
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def build_log_generator(container, prefix, color_func):
def build_log_generator(container, prefix, color_func, log_args):
# if the container doesn't have a log_stream we need to attach to container
# before log printer starts running
if container.log_stream is None:
stream = container.attach(stdout=True, stderr=True, stream=True, logs=True)
stream = container.logs(stdout=True, stderr=True, stream=True, **log_args)
line_generator = split_buffer(stream)
else:
line_generator = split_buffer(container.log_stream)

for line in line_generator:
yield prefix + line
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def wait_on_exit(container):
Expand Down
26 changes: 21 additions & 5 deletions compose/cli/main.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,13 +328,28 @@ def logs(self, project, options):
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output.
-t, --timestamps Show timestamps.
--tail="all" Number of lines to show from the end of the logs
for each container.
"""
containers = project.containers(service_names=options['SERVICE'], stopped=True)

monochrome = options['--no-color']
tail = options['--tail']
if tail is not None:
if tail.isdigit():
tail = int(tail)
elif tail != 'all':
raise UserError("tail flag must be all or a number")
log_args = {
'follow': options['--follow'],
'tail': tail,
'timestamps': options['--timestamps']
}
print("Attaching to", list_containers(containers))
LogPrinter(containers, monochrome=monochrome).run()
LogPrinter(containers, monochrome=monochrome, log_args=log_args).run()

def pause(self, project, options):
"""
Expand DownExpand Up@@ -660,7 +675,8 @@ def up(self, project, options):

if detached:
return
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop)
log_args = {'follow': True}
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop, log_args)
print("Attaching to", list_containers(log_printer.containers))
log_printer.run()

Expand DownExpand Up@@ -758,13 +774,13 @@ def remove_container(force=False):
sys.exit(exit_code)


def build_log_printer(containers, service_names, monochrome, cascade_stop):
def build_log_printer(containers, service_names, monochrome, cascade_stop, log_args):
if service_names:
containers = [
container
for container in containers if container.service in service_names
]
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop)
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop, log_args=log_args)


@contextlib.contextmanager
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/logs.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,11 @@ parent = "smn_compose_cli"
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output
-t, --timestamps Show timestamps
--tail Number of lines to show from the end of the logs
for each container.
```

Displays log output from services.
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
PyYAML==3.11
cached-property==1.2.0
docker-py==1.7.2
dockerpty==0.4.1
docopt==0.6.1
enum34==1.0.4
git+https://github.com/docker/docker-py.git@81d8caaf36159bf1accd86eab2e157bf8dd071a9#egg=docker-py
jsonschema==2.5.1
requests==2.7.0
six==1.7.3
Expand Down
38 changes: 38 additions & 0 deletions tests/acceptance/cli_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ def test_up_attached(self):

assert 'simple_1 | simple' in result.stdout
assert 'another_1 | another' in result.stdout
assert 'simple_1 exited with code 0' in result.stdout
assert 'another_1 exited with code 0' in result.stdout

@v2_only()
def test_up(self):
Expand DownExpand Up@@ -1141,6 +1143,42 @@ def test_unpause_no_containers(self):
def test_logs_invalid_service_name(self):
self.dispatch(['logs', 'madeupname'], returncode=1)

def test_logs_follow(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f'])

assert result.stdout.count('\n') == 5
assert 'simple' in result.stdout
assert 'another' in result.stdout
assert 'exited with code 0' in result.stdout

def test_logs_unfollow(self):
self.base_dir = 'tests/fixtures/logs-composefile'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs'])

assert result.stdout.count('\n') >= 1
assert 'exited with code 0' not in result.stdout

def test_logs_timestamps(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f', '-t'], None)

self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')

def test_logs_tail(self):
self.base_dir = 'tests/fixtures/logs-tail-composefile'
self.dispatch(['up'], None)

result = self.dispatch(['logs', '--tail', '2'], None)

assert result.stdout.count('\n') == 3

def test_kill(self):
self.dispatch(['up', '-d'], None)
service = self.project.get_service('simple')
Expand Down
6 changes: 6 additions & 0 deletions tests/fixtures/logs-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
simple:
image: busybox:latest
command: sh -c "echo hello && sleep 200"
another:
image: busybox:latest
command: sh -c "echo test"
3 changes: 3 additions & 0 deletions tests/fixtures/logs-tail-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
simple:
image: busybox:latest
command: sh -c "echo a && echo b && echo c && echo d"
14 changes: 12 additions & 2 deletions tests/unit/cli/log_printer_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ def build_mock_container(reader):
name_without_project='web_1',
has_api_logs=True,
log_stream=None,
attach=reader,
logs=reader,
wait=mock.Mock(return_value=0),
)

Expand All@@ -39,14 +39,23 @@ def reader(*args, **kwargs):
class TestLogPrinter(object):

def test_single_container(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()
LogPrinter([mock_container], output=output_stream, log_args={'follow': True}).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines + "container exited line"
assert output_stream.flush.call_count == 3

def test_single_container_without_stream(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines
assert output_stream.flush.call_count == 2

def test_monochrome(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream, monochrome=True).run()
assert '\033[' not in output_stream.getvalue()
Expand DownExpand Up@@ -86,3 +95,4 @@ def test_generator_with_no_logs(self, mock_container, output_stream):

output = output_stream.getvalue()
assert "WARNING: no logs are available with the 'none' log driver\n" in output
assert "exited with code" not in output
4 changes: 2 additions & 2 deletions tests/unit/cli/main_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ def test_build_log_printer(self):
mock_container('another', 1),
]
service_names = ['web', 'db']
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers[:3])

def test_build_log_printer_all_services(self):
Expand All@@ -43,7 +43,7 @@ def test_build_log_printer_all_services(self):
mock_container('other', 1),
]
service_names = []
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers)


Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
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
23 changes: 16 additions & 7 deletions compose/cli/log_printer.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,11 +13,18 @@
class LogPrinter(object):
"""Print logs from many containers to a single output stream."""

def __init__(self, containers, output=sys.stdout, monochrome=False, cascade_stop=False):
def __init__(self,
containers,
output=sys.stdout,
monochrome=False,
cascade_stop=False,
log_args=None):
log_args = log_args or {}
self.containers = containers
self.output = utils.get_output_stream(output)
self.monochrome = monochrome
self.cascade_stop = cascade_stop
self.log_args = log_args

def run(self):
if not self.containers:
Expand All@@ -41,7 +48,7 @@ def no_color(text):
for color_func, container in zip(color_funcs, self.containers):
generator_func = get_log_generator(container)
prefix = color_func(build_log_prefix(container, prefix_width))
yield generator_func(container, prefix, color_func)
yield generator_func(container, prefix, color_func, self.log_args)


def build_log_prefix(container, prefix_width):
Expand All@@ -64,28 +71,30 @@ def get_log_generator(container):
return build_no_log_generator


def build_no_log_generator(container, prefix, color_func):
def build_no_log_generator(container, prefix, color_func, log_args):
"""Return a generator that prints a warning about logs and waits for
container to exit.
"""
yield "{} WARNING: no logs are available with the '{}' log driver\n".format(
prefix,
container.log_driver)
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def build_log_generator(container, prefix, color_func):
def build_log_generator(container, prefix, color_func, log_args):
# if the container doesn't have a log_stream we need to attach to container
# before log printer starts running
if container.log_stream is None:
stream = container.attach(stdout=True, stderr=True, stream=True, logs=True)
stream = container.logs(stdout=True, stderr=True, stream=True, **log_args)
line_generator = split_buffer(stream)
else:
line_generator = split_buffer(container.log_stream)

for line in line_generator:
yield prefix + line
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def wait_on_exit(container):
Expand Down
26 changes: 21 additions & 5 deletions compose/cli/main.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,13 +328,28 @@ def logs(self, project, options):
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output.
-t, --timestamps Show timestamps.
--tail="all" Number of lines to show from the end of the logs
for each container.
"""
containers = project.containers(service_names=options['SERVICE'], stopped=True)

monochrome = options['--no-color']
tail = options['--tail']
if tail is not None:
if tail.isdigit():
tail = int(tail)
elif tail != 'all':
raise UserError("tail flag must be all or a number")
log_args = {
'follow': options['--follow'],
'tail': tail,
'timestamps': options['--timestamps']
}
print("Attaching to", list_containers(containers))
LogPrinter(containers, monochrome=monochrome).run()
LogPrinter(containers, monochrome=monochrome, log_args=log_args).run()

def pause(self, project, options):
"""
Expand DownExpand Up@@ -660,7 +675,8 @@ def up(self, project, options):

if detached:
return
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop)
log_args = {'follow': True}
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop, log_args)
print("Attaching to", list_containers(log_printer.containers))
log_printer.run()

Expand DownExpand Up@@ -758,13 +774,13 @@ def remove_container(force=False):
sys.exit(exit_code)


def build_log_printer(containers, service_names, monochrome, cascade_stop):
def build_log_printer(containers, service_names, monochrome, cascade_stop, log_args):
if service_names:
containers = [
container
for container in containers if container.service in service_names
]
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop)
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop, log_args=log_args)


@contextlib.contextmanager
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/logs.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,11 @@ parent = "smn_compose_cli"
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output
-t, --timestamps Show timestamps
--tail Number of lines to show from the end of the logs
for each container.
```

Displays log output from services.
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
PyYAML==3.11
cached-property==1.2.0
docker-py==1.7.2
dockerpty==0.4.1
docopt==0.6.1
enum34==1.0.4
git+https://github.com/docker/docker-py.git@81d8caaf36159bf1accd86eab2e157bf8dd071a9#egg=docker-py
jsonschema==2.5.1
requests==2.7.0
six==1.7.3
Expand Down
38 changes: 38 additions & 0 deletions tests/acceptance/cli_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ def test_up_attached(self):

assert 'simple_1 | simple' in result.stdout
assert 'another_1 | another' in result.stdout
assert 'simple_1 exited with code 0' in result.stdout
assert 'another_1 exited with code 0' in result.stdout

@v2_only()
def test_up(self):
Expand DownExpand Up@@ -1141,6 +1143,42 @@ def test_unpause_no_containers(self):
def test_logs_invalid_service_name(self):
self.dispatch(['logs', 'madeupname'], returncode=1)

def test_logs_follow(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f'])

assert result.stdout.count('\n') == 5
assert 'simple' in result.stdout
assert 'another' in result.stdout
assert 'exited with code 0' in result.stdout

def test_logs_unfollow(self):
self.base_dir = 'tests/fixtures/logs-composefile'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs'])

assert result.stdout.count('\n') >= 1
assert 'exited with code 0' not in result.stdout

def test_logs_timestamps(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f', '-t'], None)

self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')

def test_logs_tail(self):
self.base_dir = 'tests/fixtures/logs-tail-composefile'
self.dispatch(['up'], None)

result = self.dispatch(['logs', '--tail', '2'], None)

assert result.stdout.count('\n') == 3

def test_kill(self):
self.dispatch(['up', '-d'], None)
service = self.project.get_service('simple')
Expand Down
6 changes: 6 additions & 0 deletions tests/fixtures/logs-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
simple:
image: busybox:latest
command: sh -c "echo hello && sleep 200"
another:
image: busybox:latest
command: sh -c "echo test"
3 changes: 3 additions & 0 deletions tests/fixtures/logs-tail-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
simple:
image: busybox:latest
command: sh -c "echo a && echo b && echo c && echo d"
14 changes: 12 additions & 2 deletions tests/unit/cli/log_printer_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ def build_mock_container(reader):
name_without_project='web_1',
has_api_logs=True,
log_stream=None,
attach=reader,
logs=reader,
wait=mock.Mock(return_value=0),
)

Expand All@@ -39,14 +39,23 @@ def reader(*args, **kwargs):
class TestLogPrinter(object):

def test_single_container(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()
LogPrinter([mock_container], output=output_stream, log_args={'follow': True}).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines + "container exited line"
assert output_stream.flush.call_count == 3

def test_single_container_without_stream(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines
assert output_stream.flush.call_count == 2

def test_monochrome(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream, monochrome=True).run()
assert '\033[' not in output_stream.getvalue()
Expand DownExpand Up@@ -86,3 +95,4 @@ def test_generator_with_no_logs(self, mock_container, output_stream):

output = output_stream.getvalue()
assert "WARNING: no logs are available with the 'none' log driver\n" in output
assert "exited with code" not in output
4 changes: 2 additions & 2 deletions tests/unit/cli/main_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ def test_build_log_printer(self):
mock_container('another', 1),
]
service_names = ['web', 'db']
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers[:3])

def test_build_log_printer_all_services(self):
Expand All@@ -43,7 +43,7 @@ def test_build_log_printer_all_services(self):
mock_container('other', 1),
]
service_names = []
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers)


Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
23 changes: 16 additions & 7 deletions compose/cli/log_printer.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,11 +13,18 @@
class LogPrinter(object):
"""Print logs from many containers to a single output stream."""

def __init__(self, containers, output=sys.stdout, monochrome=False, cascade_stop=False):
def __init__(self,
containers,
output=sys.stdout,
monochrome=False,
cascade_stop=False,
log_args=None):
log_args = log_args or {}
self.containers = containers
self.output = utils.get_output_stream(output)
self.monochrome = monochrome
self.cascade_stop = cascade_stop
self.log_args = log_args

def run(self):
if not self.containers:
Expand All@@ -41,7 +48,7 @@ def no_color(text):
for color_func, container in zip(color_funcs, self.containers):
generator_func = get_log_generator(container)
prefix = color_func(build_log_prefix(container, prefix_width))
yield generator_func(container, prefix, color_func)
yield generator_func(container, prefix, color_func, self.log_args)


def build_log_prefix(container, prefix_width):
Expand All@@ -64,28 +71,30 @@ def get_log_generator(container):
return build_no_log_generator


def build_no_log_generator(container, prefix, color_func):
def build_no_log_generator(container, prefix, color_func, log_args):
"""Return a generator that prints a warning about logs and waits for
container to exit.
"""
yield "{} WARNING: no logs are available with the '{}' log driver\n".format(
prefix,
container.log_driver)
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def build_log_generator(container, prefix, color_func):
def build_log_generator(container, prefix, color_func, log_args):
# if the container doesn't have a log_stream we need to attach to container
# before log printer starts running
if container.log_stream is None:
stream = container.attach(stdout=True, stderr=True, stream=True, logs=True)
stream = container.logs(stdout=True, stderr=True, stream=True, **log_args)
line_generator = split_buffer(stream)
else:
line_generator = split_buffer(container.log_stream)

for line in line_generator:
yield prefix + line
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def wait_on_exit(container):
Expand Down
26 changes: 21 additions & 5 deletions compose/cli/main.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,13 +328,28 @@ def logs(self, project, options):
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output.
-t, --timestamps Show timestamps.
--tail="all" Number of lines to show from the end of the logs
for each container.
"""
containers = project.containers(service_names=options['SERVICE'], stopped=True)

monochrome = options['--no-color']
tail = options['--tail']
if tail is not None:
if tail.isdigit():
tail = int(tail)
elif tail != 'all':
raise UserError("tail flag must be all or a number")
log_args = {
'follow': options['--follow'],
'tail': tail,
'timestamps': options['--timestamps']
}
print("Attaching to", list_containers(containers))
LogPrinter(containers, monochrome=monochrome).run()
LogPrinter(containers, monochrome=monochrome, log_args=log_args).run()

def pause(self, project, options):
"""
Expand DownExpand Up@@ -660,7 +675,8 @@ def up(self, project, options):

if detached:
return
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop)
log_args = {'follow': True}
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop, log_args)
print("Attaching to", list_containers(log_printer.containers))
log_printer.run()

Expand DownExpand Up@@ -758,13 +774,13 @@ def remove_container(force=False):
sys.exit(exit_code)


def build_log_printer(containers, service_names, monochrome, cascade_stop):
def build_log_printer(containers, service_names, monochrome, cascade_stop, log_args):
if service_names:
containers = [
container
for container in containers if container.service in service_names
]
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop)
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop, log_args=log_args)


@contextlib.contextmanager
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/logs.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,11 @@ parent = "smn_compose_cli"
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output
-t, --timestamps Show timestamps
--tail Number of lines to show from the end of the logs
for each container.
```

Displays log output from services.
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
PyYAML==3.11
cached-property==1.2.0
docker-py==1.7.2
dockerpty==0.4.1
docopt==0.6.1
enum34==1.0.4
git+https://github.com/docker/docker-py.git@81d8caaf36159bf1accd86eab2e157bf8dd071a9#egg=docker-py
jsonschema==2.5.1
requests==2.7.0
six==1.7.3
Expand Down
38 changes: 38 additions & 0 deletions tests/acceptance/cli_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ def test_up_attached(self):

assert 'simple_1 | simple' in result.stdout
assert 'another_1 | another' in result.stdout
assert 'simple_1 exited with code 0' in result.stdout
assert 'another_1 exited with code 0' in result.stdout

@v2_only()
def test_up(self):
Expand DownExpand Up@@ -1141,6 +1143,42 @@ def test_unpause_no_containers(self):
def test_logs_invalid_service_name(self):
self.dispatch(['logs', 'madeupname'], returncode=1)

def test_logs_follow(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f'])

assert result.stdout.count('\n') == 5
assert 'simple' in result.stdout
assert 'another' in result.stdout
assert 'exited with code 0' in result.stdout

def test_logs_unfollow(self):
self.base_dir = 'tests/fixtures/logs-composefile'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs'])

assert result.stdout.count('\n') >= 1
assert 'exited with code 0' not in result.stdout

def test_logs_timestamps(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f', '-t'], None)

self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')

def test_logs_tail(self):
self.base_dir = 'tests/fixtures/logs-tail-composefile'
self.dispatch(['up'], None)

result = self.dispatch(['logs', '--tail', '2'], None)

assert result.stdout.count('\n') == 3

def test_kill(self):
self.dispatch(['up', '-d'], None)
service = self.project.get_service('simple')
Expand Down
6 changes: 6 additions & 0 deletions tests/fixtures/logs-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
simple:
image: busybox:latest
command: sh -c "echo hello && sleep 200"
another:
image: busybox:latest
command: sh -c "echo test"
3 changes: 3 additions & 0 deletions tests/fixtures/logs-tail-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
simple:
image: busybox:latest
command: sh -c "echo a && echo b && echo c && echo d"
14 changes: 12 additions & 2 deletions tests/unit/cli/log_printer_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ def build_mock_container(reader):
name_without_project='web_1',
has_api_logs=True,
log_stream=None,
attach=reader,
logs=reader,
wait=mock.Mock(return_value=0),
)

Expand All@@ -39,14 +39,23 @@ def reader(*args, **kwargs):
class TestLogPrinter(object):

def test_single_container(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()
LogPrinter([mock_container], output=output_stream, log_args={'follow': True}).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines + "container exited line"
assert output_stream.flush.call_count == 3

def test_single_container_without_stream(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines
assert output_stream.flush.call_count == 2

def test_monochrome(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream, monochrome=True).run()
assert '\033[' not in output_stream.getvalue()
Expand DownExpand Up@@ -86,3 +95,4 @@ def test_generator_with_no_logs(self, mock_container, output_stream):

output = output_stream.getvalue()
assert "WARNING: no logs are available with the 'none' log driver\n" in output
assert "exited with code" not in output
4 changes: 2 additions & 2 deletions tests/unit/cli/main_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ def test_build_log_printer(self):
mock_container('another', 1),
]
service_names = ['web', 'db']
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers[:3])

def test_build_log_printer_all_services(self):
Expand All@@ -43,7 +43,7 @@ def test_build_log_printer_all_services(self):
mock_container('other', 1),
]
service_names = []
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers)


Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
23 changes: 16 additions & 7 deletions compose/cli/log_printer.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,11 +13,18 @@
class LogPrinter(object):
"""Print logs from many containers to a single output stream."""

def __init__(self, containers, output=sys.stdout, monochrome=False, cascade_stop=False):
def __init__(self,
containers,
output=sys.stdout,
monochrome=False,
cascade_stop=False,
log_args=None):
log_args = log_args or {}
self.containers = containers
self.output = utils.get_output_stream(output)
self.monochrome = monochrome
self.cascade_stop = cascade_stop
self.log_args = log_args

def run(self):
if not self.containers:
Expand All@@ -41,7 +48,7 @@ def no_color(text):
for color_func, container in zip(color_funcs, self.containers):
generator_func = get_log_generator(container)
prefix = color_func(build_log_prefix(container, prefix_width))
yield generator_func(container, prefix, color_func)
yield generator_func(container, prefix, color_func, self.log_args)


def build_log_prefix(container, prefix_width):
Expand All@@ -64,28 +71,30 @@ def get_log_generator(container):
return build_no_log_generator


def build_no_log_generator(container, prefix, color_func):
def build_no_log_generator(container, prefix, color_func, log_args):
"""Return a generator that prints a warning about logs and waits for
container to exit.
"""
yield "{} WARNING: no logs are available with the '{}' log driver\n".format(
prefix,
container.log_driver)
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def build_log_generator(container, prefix, color_func):
def build_log_generator(container, prefix, color_func, log_args):
# if the container doesn't have a log_stream we need to attach to container
# before log printer starts running
if container.log_stream is None:
stream = container.attach(stdout=True, stderr=True, stream=True, logs=True)
stream = container.logs(stdout=True, stderr=True, stream=True, **log_args)
line_generator = split_buffer(stream)
else:
line_generator = split_buffer(container.log_stream)

for line in line_generator:
yield prefix + line
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def wait_on_exit(container):
Expand Down
26 changes: 21 additions & 5 deletions compose/cli/main.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,13 +328,28 @@ def logs(self, project, options):
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output.
-t, --timestamps Show timestamps.
--tail="all" Number of lines to show from the end of the logs
for each container.
"""
containers = project.containers(service_names=options['SERVICE'], stopped=True)

monochrome = options['--no-color']
tail = options['--tail']
if tail is not None:
if tail.isdigit():
tail = int(tail)
elif tail != 'all':
raise UserError("tail flag must be all or a number")
log_args = {
'follow': options['--follow'],
'tail': tail,
'timestamps': options['--timestamps']
}
print("Attaching to", list_containers(containers))
LogPrinter(containers, monochrome=monochrome).run()
LogPrinter(containers, monochrome=monochrome, log_args=log_args).run()

def pause(self, project, options):
"""
Expand DownExpand Up@@ -660,7 +675,8 @@ def up(self, project, options):

if detached:
return
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop)
log_args = {'follow': True}
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop, log_args)
print("Attaching to", list_containers(log_printer.containers))
log_printer.run()

Expand DownExpand Up@@ -758,13 +774,13 @@ def remove_container(force=False):
sys.exit(exit_code)


def build_log_printer(containers, service_names, monochrome, cascade_stop):
def build_log_printer(containers, service_names, monochrome, cascade_stop, log_args):
if service_names:
containers = [
container
for container in containers if container.service in service_names
]
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop)
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop, log_args=log_args)


@contextlib.contextmanager
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/logs.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,11 @@ parent = "smn_compose_cli"
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output
-t, --timestamps Show timestamps
--tail Number of lines to show from the end of the logs
for each container.
```

Displays log output from services.
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
PyYAML==3.11
cached-property==1.2.0
docker-py==1.7.2
dockerpty==0.4.1
docopt==0.6.1
enum34==1.0.4
git+https://github.com/docker/docker-py.git@81d8caaf36159bf1accd86eab2e157bf8dd071a9#egg=docker-py
jsonschema==2.5.1
requests==2.7.0
six==1.7.3
Expand Down
38 changes: 38 additions & 0 deletions tests/acceptance/cli_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ def test_up_attached(self):

assert 'simple_1 | simple' in result.stdout
assert 'another_1 | another' in result.stdout
assert 'simple_1 exited with code 0' in result.stdout
assert 'another_1 exited with code 0' in result.stdout

@v2_only()
def test_up(self):
Expand DownExpand Up@@ -1141,6 +1143,42 @@ def test_unpause_no_containers(self):
def test_logs_invalid_service_name(self):
self.dispatch(['logs', 'madeupname'], returncode=1)

def test_logs_follow(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f'])

assert result.stdout.count('\n') == 5
assert 'simple' in result.stdout
assert 'another' in result.stdout
assert 'exited with code 0' in result.stdout

def test_logs_unfollow(self):
self.base_dir = 'tests/fixtures/logs-composefile'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs'])

assert result.stdout.count('\n') >= 1
assert 'exited with code 0' not in result.stdout

def test_logs_timestamps(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f', '-t'], None)

self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')

def test_logs_tail(self):
self.base_dir = 'tests/fixtures/logs-tail-composefile'
self.dispatch(['up'], None)

result = self.dispatch(['logs', '--tail', '2'], None)

assert result.stdout.count('\n') == 3

def test_kill(self):
self.dispatch(['up', '-d'], None)
service = self.project.get_service('simple')
Expand Down
6 changes: 6 additions & 0 deletions tests/fixtures/logs-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
simple:
image: busybox:latest
command: sh -c "echo hello && sleep 200"
another:
image: busybox:latest
command: sh -c "echo test"
3 changes: 3 additions & 0 deletions tests/fixtures/logs-tail-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
simple:
image: busybox:latest
command: sh -c "echo a && echo b && echo c && echo d"
14 changes: 12 additions & 2 deletions tests/unit/cli/log_printer_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ def build_mock_container(reader):
name_without_project='web_1',
has_api_logs=True,
log_stream=None,
attach=reader,
logs=reader,
wait=mock.Mock(return_value=0),
)

Expand All@@ -39,14 +39,23 @@ def reader(*args, **kwargs):
class TestLogPrinter(object):

def test_single_container(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()
LogPrinter([mock_container], output=output_stream, log_args={'follow': True}).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines + "container exited line"
assert output_stream.flush.call_count == 3

def test_single_container_without_stream(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines
assert output_stream.flush.call_count == 2

def test_monochrome(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream, monochrome=True).run()
assert '\033[' not in output_stream.getvalue()
Expand DownExpand Up@@ -86,3 +95,4 @@ def test_generator_with_no_logs(self, mock_container, output_stream):

output = output_stream.getvalue()
assert "WARNING: no logs are available with the 'none' log driver\n" in output
assert "exited with code" not in output
4 changes: 2 additions & 2 deletions tests/unit/cli/main_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ def test_build_log_printer(self):
mock_container('another', 1),
]
service_names = ['web', 'db']
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers[:3])

def test_build_log_printer_all_services(self):
Expand All@@ -43,7 +43,7 @@ def test_build_log_printer_all_services(self):
mock_container('other', 1),
]
service_names = []
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers)


Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
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
23 changes: 16 additions & 7 deletions compose/cli/log_printer.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,11 +13,18 @@
class LogPrinter(object):
"""Print logs from many containers to a single output stream."""

def __init__(self, containers, output=sys.stdout, monochrome=False, cascade_stop=False):
def __init__(self,
containers,
output=sys.stdout,
monochrome=False,
cascade_stop=False,
log_args=None):
log_args = log_args or {}
self.containers = containers
self.output = utils.get_output_stream(output)
self.monochrome = monochrome
self.cascade_stop = cascade_stop
self.log_args = log_args

def run(self):
if not self.containers:
Expand All@@ -41,7 +48,7 @@ def no_color(text):
for color_func, container in zip(color_funcs, self.containers):
generator_func = get_log_generator(container)
prefix = color_func(build_log_prefix(container, prefix_width))
yield generator_func(container, prefix, color_func)
yield generator_func(container, prefix, color_func, self.log_args)


def build_log_prefix(container, prefix_width):
Expand All@@ -64,28 +71,30 @@ def get_log_generator(container):
return build_no_log_generator


def build_no_log_generator(container, prefix, color_func):
def build_no_log_generator(container, prefix, color_func, log_args):
"""Return a generator that prints a warning about logs and waits for
container to exit.
"""
yield "{} WARNING: no logs are available with the '{}' log driver\n".format(
prefix,
container.log_driver)
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def build_log_generator(container, prefix, color_func):
def build_log_generator(container, prefix, color_func, log_args):
# if the container doesn't have a log_stream we need to attach to container
# before log printer starts running
if container.log_stream is None:
stream = container.attach(stdout=True, stderr=True, stream=True, logs=True)
stream = container.logs(stdout=True, stderr=True, stream=True, **log_args)
line_generator = split_buffer(stream)
else:
line_generator = split_buffer(container.log_stream)

for line in line_generator:
yield prefix + line
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def wait_on_exit(container):
Expand Down
26 changes: 21 additions & 5 deletions compose/cli/main.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,13 +328,28 @@ def logs(self, project, options):
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output.
-t, --timestamps Show timestamps.
--tail="all" Number of lines to show from the end of the logs
for each container.
"""
containers = project.containers(service_names=options['SERVICE'], stopped=True)

monochrome = options['--no-color']
tail = options['--tail']
if tail is not None:
if tail.isdigit():
tail = int(tail)
elif tail != 'all':
raise UserError("tail flag must be all or a number")
log_args = {
'follow': options['--follow'],
'tail': tail,
'timestamps': options['--timestamps']
}
print("Attaching to", list_containers(containers))
LogPrinter(containers, monochrome=monochrome).run()
LogPrinter(containers, monochrome=monochrome, log_args=log_args).run()

def pause(self, project, options):
"""
Expand DownExpand Up@@ -660,7 +675,8 @@ def up(self, project, options):

if detached:
return
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop)
log_args = {'follow': True}
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop, log_args)
print("Attaching to", list_containers(log_printer.containers))
log_printer.run()

Expand DownExpand Up@@ -758,13 +774,13 @@ def remove_container(force=False):
sys.exit(exit_code)


def build_log_printer(containers, service_names, monochrome, cascade_stop):
def build_log_printer(containers, service_names, monochrome, cascade_stop, log_args):
if service_names:
containers = [
container
for container in containers if container.service in service_names
]
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop)
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop, log_args=log_args)


@contextlib.contextmanager
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/logs.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,11 @@ parent = "smn_compose_cli"
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output
-t, --timestamps Show timestamps
--tail Number of lines to show from the end of the logs
for each container.
```

Displays log output from services.
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
PyYAML==3.11
cached-property==1.2.0
docker-py==1.7.2
dockerpty==0.4.1
docopt==0.6.1
enum34==1.0.4
git+https://github.com/docker/docker-py.git@81d8caaf36159bf1accd86eab2e157bf8dd071a9#egg=docker-py
jsonschema==2.5.1
requests==2.7.0
six==1.7.3
Expand Down
38 changes: 38 additions & 0 deletions tests/acceptance/cli_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ def test_up_attached(self):

assert 'simple_1 | simple' in result.stdout
assert 'another_1 | another' in result.stdout
assert 'simple_1 exited with code 0' in result.stdout
assert 'another_1 exited with code 0' in result.stdout

@v2_only()
def test_up(self):
Expand DownExpand Up@@ -1141,6 +1143,42 @@ def test_unpause_no_containers(self):
def test_logs_invalid_service_name(self):
self.dispatch(['logs', 'madeupname'], returncode=1)

def test_logs_follow(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f'])

assert result.stdout.count('\n') == 5
assert 'simple' in result.stdout
assert 'another' in result.stdout
assert 'exited with code 0' in result.stdout

def test_logs_unfollow(self):
self.base_dir = 'tests/fixtures/logs-composefile'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs'])

assert result.stdout.count('\n') >= 1
assert 'exited with code 0' not in result.stdout

def test_logs_timestamps(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f', '-t'], None)

self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')

def test_logs_tail(self):
self.base_dir = 'tests/fixtures/logs-tail-composefile'
self.dispatch(['up'], None)

result = self.dispatch(['logs', '--tail', '2'], None)

assert result.stdout.count('\n') == 3

def test_kill(self):
self.dispatch(['up', '-d'], None)
service = self.project.get_service('simple')
Expand Down
6 changes: 6 additions & 0 deletions tests/fixtures/logs-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
simple:
image: busybox:latest
command: sh -c "echo hello && sleep 200"
another:
image: busybox:latest
command: sh -c "echo test"
3 changes: 3 additions & 0 deletions tests/fixtures/logs-tail-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
simple:
image: busybox:latest
command: sh -c "echo a && echo b && echo c && echo d"
14 changes: 12 additions & 2 deletions tests/unit/cli/log_printer_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ def build_mock_container(reader):
name_without_project='web_1',
has_api_logs=True,
log_stream=None,
attach=reader,
logs=reader,
wait=mock.Mock(return_value=0),
)

Expand All@@ -39,14 +39,23 @@ def reader(*args, **kwargs):
class TestLogPrinter(object):

def test_single_container(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()
LogPrinter([mock_container], output=output_stream, log_args={'follow': True}).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines + "container exited line"
assert output_stream.flush.call_count == 3

def test_single_container_without_stream(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines
assert output_stream.flush.call_count == 2

def test_monochrome(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream, monochrome=True).run()
assert '\033[' not in output_stream.getvalue()
Expand DownExpand Up@@ -86,3 +95,4 @@ def test_generator_with_no_logs(self, mock_container, output_stream):

output = output_stream.getvalue()
assert "WARNING: no logs are available with the 'none' log driver\n" in output
assert "exited with code" not in output
4 changes: 2 additions & 2 deletions tests/unit/cli/main_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ def test_build_log_printer(self):
mock_container('another', 1),
]
service_names = ['web', 'db']
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers[:3])

def test_build_log_printer_all_services(self):
Expand All@@ -43,7 +43,7 @@ def test_build_log_printer_all_services(self):
mock_container('other', 1),
]
service_names = []
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers)


Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
23 changes: 16 additions & 7 deletions compose/cli/log_printer.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,11 +13,18 @@
class LogPrinter(object):
"""Print logs from many containers to a single output stream."""

def __init__(self, containers, output=sys.stdout, monochrome=False, cascade_stop=False):
def __init__(self,
containers,
output=sys.stdout,
monochrome=False,
cascade_stop=False,
log_args=None):
log_args = log_args or {}
self.containers = containers
self.output = utils.get_output_stream(output)
self.monochrome = monochrome
self.cascade_stop = cascade_stop
self.log_args = log_args

def run(self):
if not self.containers:
Expand All@@ -41,7 +48,7 @@ def no_color(text):
for color_func, container in zip(color_funcs, self.containers):
generator_func = get_log_generator(container)
prefix = color_func(build_log_prefix(container, prefix_width))
yield generator_func(container, prefix, color_func)
yield generator_func(container, prefix, color_func, self.log_args)


def build_log_prefix(container, prefix_width):
Expand All@@ -64,28 +71,30 @@ def get_log_generator(container):
return build_no_log_generator


def build_no_log_generator(container, prefix, color_func):
def build_no_log_generator(container, prefix, color_func, log_args):
"""Return a generator that prints a warning about logs and waits for
container to exit.
"""
yield "{} WARNING: no logs are available with the '{}' log driver\n".format(
prefix,
container.log_driver)
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def build_log_generator(container, prefix, color_func):
def build_log_generator(container, prefix, color_func, log_args):
# if the container doesn't have a log_stream we need to attach to container
# before log printer starts running
if container.log_stream is None:
stream = container.attach(stdout=True, stderr=True, stream=True, logs=True)
stream = container.logs(stdout=True, stderr=True, stream=True, **log_args)
line_generator = split_buffer(stream)
else:
line_generator = split_buffer(container.log_stream)

for line in line_generator:
yield prefix + line
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def wait_on_exit(container):
Expand Down
26 changes: 21 additions & 5 deletions compose/cli/main.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,13 +328,28 @@ def logs(self, project, options):
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output.
-t, --timestamps Show timestamps.
--tail="all" Number of lines to show from the end of the logs
for each container.
"""
containers = project.containers(service_names=options['SERVICE'], stopped=True)

monochrome = options['--no-color']
tail = options['--tail']
if tail is not None:
if tail.isdigit():
tail = int(tail)
elif tail != 'all':
raise UserError("tail flag must be all or a number")
log_args = {
'follow': options['--follow'],
'tail': tail,
'timestamps': options['--timestamps']
}
print("Attaching to", list_containers(containers))
LogPrinter(containers, monochrome=monochrome).run()
LogPrinter(containers, monochrome=monochrome, log_args=log_args).run()

def pause(self, project, options):
"""
Expand DownExpand Up@@ -660,7 +675,8 @@ def up(self, project, options):

if detached:
return
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop)
log_args = {'follow': True}
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop, log_args)
print("Attaching to", list_containers(log_printer.containers))
log_printer.run()

Expand DownExpand Up@@ -758,13 +774,13 @@ def remove_container(force=False):
sys.exit(exit_code)


def build_log_printer(containers, service_names, monochrome, cascade_stop):
def build_log_printer(containers, service_names, monochrome, cascade_stop, log_args):
if service_names:
containers = [
container
for container in containers if container.service in service_names
]
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop)
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop, log_args=log_args)


@contextlib.contextmanager
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/logs.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,11 @@ parent = "smn_compose_cli"
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output
-t, --timestamps Show timestamps
--tail Number of lines to show from the end of the logs
for each container.
```

Displays log output from services.
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
PyYAML==3.11
cached-property==1.2.0
docker-py==1.7.2
dockerpty==0.4.1
docopt==0.6.1
enum34==1.0.4
git+https://github.com/docker/docker-py.git@81d8caaf36159bf1accd86eab2e157bf8dd071a9#egg=docker-py
jsonschema==2.5.1
requests==2.7.0
six==1.7.3
Expand Down
38 changes: 38 additions & 0 deletions tests/acceptance/cli_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ def test_up_attached(self):

assert 'simple_1 | simple' in result.stdout
assert 'another_1 | another' in result.stdout
assert 'simple_1 exited with code 0' in result.stdout
assert 'another_1 exited with code 0' in result.stdout

@v2_only()
def test_up(self):
Expand DownExpand Up@@ -1141,6 +1143,42 @@ def test_unpause_no_containers(self):
def test_logs_invalid_service_name(self):
self.dispatch(['logs', 'madeupname'], returncode=1)

def test_logs_follow(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f'])

assert result.stdout.count('\n') == 5
assert 'simple' in result.stdout
assert 'another' in result.stdout
assert 'exited with code 0' in result.stdout

def test_logs_unfollow(self):
self.base_dir = 'tests/fixtures/logs-composefile'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs'])

assert result.stdout.count('\n') >= 1
assert 'exited with code 0' not in result.stdout

def test_logs_timestamps(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f', '-t'], None)

self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')

def test_logs_tail(self):
self.base_dir = 'tests/fixtures/logs-tail-composefile'
self.dispatch(['up'], None)

result = self.dispatch(['logs', '--tail', '2'], None)

assert result.stdout.count('\n') == 3

def test_kill(self):
self.dispatch(['up', '-d'], None)
service = self.project.get_service('simple')
Expand Down
6 changes: 6 additions & 0 deletions tests/fixtures/logs-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
simple:
image: busybox:latest
command: sh -c "echo hello && sleep 200"
another:
image: busybox:latest
command: sh -c "echo test"
3 changes: 3 additions & 0 deletions tests/fixtures/logs-tail-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
simple:
image: busybox:latest
command: sh -c "echo a && echo b && echo c && echo d"
14 changes: 12 additions & 2 deletions tests/unit/cli/log_printer_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ def build_mock_container(reader):
name_without_project='web_1',
has_api_logs=True,
log_stream=None,
attach=reader,
logs=reader,
wait=mock.Mock(return_value=0),
)

Expand All@@ -39,14 +39,23 @@ def reader(*args, **kwargs):
class TestLogPrinter(object):

def test_single_container(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()
LogPrinter([mock_container], output=output_stream, log_args={'follow': True}).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines + "container exited line"
assert output_stream.flush.call_count == 3

def test_single_container_without_stream(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines
assert output_stream.flush.call_count == 2

def test_monochrome(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream, monochrome=True).run()
assert '\033[' not in output_stream.getvalue()
Expand DownExpand Up@@ -86,3 +95,4 @@ def test_generator_with_no_logs(self, mock_container, output_stream):

output = output_stream.getvalue()
assert "WARNING: no logs are available with the 'none' log driver\n" in output
assert "exited with code" not in output
4 changes: 2 additions & 2 deletions tests/unit/cli/main_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ def test_build_log_printer(self):
mock_container('another', 1),
]
service_names = ['web', 'db']
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers[:3])

def test_build_log_printer_all_services(self):
Expand All@@ -43,7 +43,7 @@ def test_build_log_printer_all_services(self):
mock_container('other', 1),
]
service_names = []
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers)


Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
23 changes: 16 additions & 7 deletions compose/cli/log_printer.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,11 +13,18 @@
class LogPrinter(object):
"""Print logs from many containers to a single output stream."""

def __init__(self, containers, output=sys.stdout, monochrome=False, cascade_stop=False):
def __init__(self,
containers,
output=sys.stdout,
monochrome=False,
cascade_stop=False,
log_args=None):
log_args = log_args or {}
self.containers = containers
self.output = utils.get_output_stream(output)
self.monochrome = monochrome
self.cascade_stop = cascade_stop
self.log_args = log_args

def run(self):
if not self.containers:
Expand All@@ -41,7 +48,7 @@ def no_color(text):
for color_func, container in zip(color_funcs, self.containers):
generator_func = get_log_generator(container)
prefix = color_func(build_log_prefix(container, prefix_width))
yield generator_func(container, prefix, color_func)
yield generator_func(container, prefix, color_func, self.log_args)


def build_log_prefix(container, prefix_width):
Expand All@@ -64,28 +71,30 @@ def get_log_generator(container):
return build_no_log_generator


def build_no_log_generator(container, prefix, color_func):
def build_no_log_generator(container, prefix, color_func, log_args):
"""Return a generator that prints a warning about logs and waits for
container to exit.
"""
yield "{} WARNING: no logs are available with the '{}' log driver\n".format(
prefix,
container.log_driver)
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def build_log_generator(container, prefix, color_func):
def build_log_generator(container, prefix, color_func, log_args):
# if the container doesn't have a log_stream we need to attach to container
# before log printer starts running
if container.log_stream is None:
stream = container.attach(stdout=True, stderr=True, stream=True, logs=True)
stream = container.logs(stdout=True, stderr=True, stream=True, **log_args)
line_generator = split_buffer(stream)
else:
line_generator = split_buffer(container.log_stream)

for line in line_generator:
yield prefix + line
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def wait_on_exit(container):
Expand Down
26 changes: 21 additions & 5 deletions compose/cli/main.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,13 +328,28 @@ def logs(self, project, options):
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output.
-t, --timestamps Show timestamps.
--tail="all" Number of lines to show from the end of the logs
for each container.
"""
containers = project.containers(service_names=options['SERVICE'], stopped=True)

monochrome = options['--no-color']
tail = options['--tail']
if tail is not None:
if tail.isdigit():
tail = int(tail)
elif tail != 'all':
raise UserError("tail flag must be all or a number")
log_args = {
'follow': options['--follow'],
'tail': tail,
'timestamps': options['--timestamps']
}
print("Attaching to", list_containers(containers))
LogPrinter(containers, monochrome=monochrome).run()
LogPrinter(containers, monochrome=monochrome, log_args=log_args).run()

def pause(self, project, options):
"""
Expand DownExpand Up@@ -660,7 +675,8 @@ def up(self, project, options):

if detached:
return
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop)
log_args = {'follow': True}
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop, log_args)
print("Attaching to", list_containers(log_printer.containers))
log_printer.run()

Expand DownExpand Up@@ -758,13 +774,13 @@ def remove_container(force=False):
sys.exit(exit_code)


def build_log_printer(containers, service_names, monochrome, cascade_stop):
def build_log_printer(containers, service_names, monochrome, cascade_stop, log_args):
if service_names:
containers = [
container
for container in containers if container.service in service_names
]
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop)
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop, log_args=log_args)


@contextlib.contextmanager
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/logs.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,11 @@ parent = "smn_compose_cli"
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output
-t, --timestamps Show timestamps
--tail Number of lines to show from the end of the logs
for each container.
```

Displays log output from services.
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
PyYAML==3.11
cached-property==1.2.0
docker-py==1.7.2
dockerpty==0.4.1
docopt==0.6.1
enum34==1.0.4
git+https://github.com/docker/docker-py.git@81d8caaf36159bf1accd86eab2e157bf8dd071a9#egg=docker-py
jsonschema==2.5.1
requests==2.7.0
six==1.7.3
Expand Down
38 changes: 38 additions & 0 deletions tests/acceptance/cli_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ def test_up_attached(self):

assert 'simple_1 | simple' in result.stdout
assert 'another_1 | another' in result.stdout
assert 'simple_1 exited with code 0' in result.stdout
assert 'another_1 exited with code 0' in result.stdout

@v2_only()
def test_up(self):
Expand DownExpand Up@@ -1141,6 +1143,42 @@ def test_unpause_no_containers(self):
def test_logs_invalid_service_name(self):
self.dispatch(['logs', 'madeupname'], returncode=1)

def test_logs_follow(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f'])

assert result.stdout.count('\n') == 5
assert 'simple' in result.stdout
assert 'another' in result.stdout
assert 'exited with code 0' in result.stdout

def test_logs_unfollow(self):
self.base_dir = 'tests/fixtures/logs-composefile'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs'])

assert result.stdout.count('\n') >= 1
assert 'exited with code 0' not in result.stdout

def test_logs_timestamps(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f', '-t'], None)

self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')

def test_logs_tail(self):
self.base_dir = 'tests/fixtures/logs-tail-composefile'
self.dispatch(['up'], None)

result = self.dispatch(['logs', '--tail', '2'], None)

assert result.stdout.count('\n') == 3

def test_kill(self):
self.dispatch(['up', '-d'], None)
service = self.project.get_service('simple')
Expand Down
6 changes: 6 additions & 0 deletions tests/fixtures/logs-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
simple:
image: busybox:latest
command: sh -c "echo hello && sleep 200"
another:
image: busybox:latest
command: sh -c "echo test"
3 changes: 3 additions & 0 deletions tests/fixtures/logs-tail-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
simple:
image: busybox:latest
command: sh -c "echo a && echo b && echo c && echo d"
14 changes: 12 additions & 2 deletions tests/unit/cli/log_printer_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ def build_mock_container(reader):
name_without_project='web_1',
has_api_logs=True,
log_stream=None,
attach=reader,
logs=reader,
wait=mock.Mock(return_value=0),
)

Expand All@@ -39,14 +39,23 @@ def reader(*args, **kwargs):
class TestLogPrinter(object):

def test_single_container(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()
LogPrinter([mock_container], output=output_stream, log_args={'follow': True}).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines + "container exited line"
assert output_stream.flush.call_count == 3

def test_single_container_without_stream(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines
assert output_stream.flush.call_count == 2

def test_monochrome(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream, monochrome=True).run()
assert '\033[' not in output_stream.getvalue()
Expand DownExpand Up@@ -86,3 +95,4 @@ def test_generator_with_no_logs(self, mock_container, output_stream):

output = output_stream.getvalue()
assert "WARNING: no logs are available with the 'none' log driver\n" in output
assert "exited with code" not in output
4 changes: 2 additions & 2 deletions tests/unit/cli/main_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ def test_build_log_printer(self):
mock_container('another', 1),
]
service_names = ['web', 'db']
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers[:3])

def test_build_log_printer_all_services(self):
Expand All@@ -43,7 +43,7 @@ def test_build_log_printer_all_services(self):
mock_container('other', 1),
]
service_names = []
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers)


Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
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
23 changes: 16 additions & 7 deletions compose/cli/log_printer.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,11 +13,18 @@
class LogPrinter(object):
"""Print logs from many containers to a single output stream."""

def __init__(self, containers, output=sys.stdout, monochrome=False, cascade_stop=False):
def __init__(self,
containers,
output=sys.stdout,
monochrome=False,
cascade_stop=False,
log_args=None):
log_args = log_args or {}
self.containers = containers
self.output = utils.get_output_stream(output)
self.monochrome = monochrome
self.cascade_stop = cascade_stop
self.log_args = log_args

def run(self):
if not self.containers:
Expand All@@ -41,7 +48,7 @@ def no_color(text):
for color_func, container in zip(color_funcs, self.containers):
generator_func = get_log_generator(container)
prefix = color_func(build_log_prefix(container, prefix_width))
yield generator_func(container, prefix, color_func)
yield generator_func(container, prefix, color_func, self.log_args)


def build_log_prefix(container, prefix_width):
Expand All@@ -64,28 +71,30 @@ def get_log_generator(container):
return build_no_log_generator


def build_no_log_generator(container, prefix, color_func):
def build_no_log_generator(container, prefix, color_func, log_args):
"""Return a generator that prints a warning about logs and waits for
container to exit.
"""
yield "{} WARNING: no logs are available with the '{}' log driver\n".format(
prefix,
container.log_driver)
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def build_log_generator(container, prefix, color_func):
def build_log_generator(container, prefix, color_func, log_args):
# if the container doesn't have a log_stream we need to attach to container
# before log printer starts running
if container.log_stream is None:
stream = container.attach(stdout=True, stderr=True, stream=True, logs=True)
stream = container.logs(stdout=True, stderr=True, stream=True, **log_args)
line_generator = split_buffer(stream)
else:
line_generator = split_buffer(container.log_stream)

for line in line_generator:
yield prefix + line
yield color_func(wait_on_exit(container))
if log_args.get('follow'):
yield color_func(wait_on_exit(container))


def wait_on_exit(container):
Expand Down
26 changes: 21 additions & 5 deletions compose/cli/main.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -328,13 +328,28 @@ def logs(self, project, options):
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output.
-t, --timestamps Show timestamps.
--tail="all" Number of lines to show from the end of the logs
for each container.
"""
containers = project.containers(service_names=options['SERVICE'], stopped=True)

monochrome = options['--no-color']
tail = options['--tail']
if tail is not None:
if tail.isdigit():
tail = int(tail)
elif tail != 'all':
raise UserError("tail flag must be all or a number")
log_args = {
'follow': options['--follow'],
'tail': tail,
'timestamps': options['--timestamps']
}
print("Attaching to", list_containers(containers))
LogPrinter(containers, monochrome=monochrome).run()
LogPrinter(containers, monochrome=monochrome, log_args=log_args).run()

def pause(self, project, options):
"""
Expand DownExpand Up@@ -660,7 +675,8 @@ def up(self, project, options):

if detached:
return
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop)
log_args = {'follow': True}
log_printer = build_log_printer(to_attach, service_names, monochrome, cascade_stop, log_args)
print("Attaching to", list_containers(log_printer.containers))
log_printer.run()

Expand DownExpand Up@@ -758,13 +774,13 @@ def remove_container(force=False):
sys.exit(exit_code)


def build_log_printer(containers, service_names, monochrome, cascade_stop):
def build_log_printer(containers, service_names, monochrome, cascade_stop, log_args):
if service_names:
containers = [
container
for container in containers if container.service in service_names
]
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop)
return LogPrinter(containers, monochrome=monochrome, cascade_stop=cascade_stop, log_args=log_args)


@contextlib.contextmanager
Expand Down
6 changes: 5 additions & 1 deletion docs/reference/logs.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,11 @@ parent = "smn_compose_cli"
Usage: logs [options] [SERVICE...]

Options:
--no-color Produce monochrome output.
--no-color Produce monochrome output.
-f, --follow Follow log output
-t, --timestamps Show timestamps
--tail Number of lines to show from the end of the logs
for each container.
```

Displays log output from services.
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
PyYAML==3.11
cached-property==1.2.0
docker-py==1.7.2
dockerpty==0.4.1
docopt==0.6.1
enum34==1.0.4
git+https://github.com/docker/docker-py.git@81d8caaf36159bf1accd86eab2e157bf8dd071a9#egg=docker-py
jsonschema==2.5.1
requests==2.7.0
six==1.7.3
Expand Down
38 changes: 38 additions & 0 deletions tests/acceptance/cli_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,6 +398,8 @@ def test_up_attached(self):

assert 'simple_1 | simple' in result.stdout
assert 'another_1 | another' in result.stdout
assert 'simple_1 exited with code 0' in result.stdout
assert 'another_1 exited with code 0' in result.stdout

@v2_only()
def test_up(self):
Expand DownExpand Up@@ -1141,6 +1143,42 @@ def test_unpause_no_containers(self):
def test_logs_invalid_service_name(self):
self.dispatch(['logs', 'madeupname'], returncode=1)

def test_logs_follow(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f'])

assert result.stdout.count('\n') == 5
assert 'simple' in result.stdout
assert 'another' in result.stdout
assert 'exited with code 0' in result.stdout

def test_logs_unfollow(self):
self.base_dir = 'tests/fixtures/logs-composefile'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs'])

assert result.stdout.count('\n') >= 1
assert 'exited with code 0' not in result.stdout

def test_logs_timestamps(self):
self.base_dir = 'tests/fixtures/echo-services'
self.dispatch(['up', '-d'], None)

result = self.dispatch(['logs', '-f', '-t'], None)

self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')

def test_logs_tail(self):
self.base_dir = 'tests/fixtures/logs-tail-composefile'
self.dispatch(['up'], None)

result = self.dispatch(['logs', '--tail', '2'], None)

assert result.stdout.count('\n') == 3

def test_kill(self):
self.dispatch(['up', '-d'], None)
service = self.project.get_service('simple')
Expand Down
6 changes: 6 additions & 0 deletions tests/fixtures/logs-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
simple:
image: busybox:latest
command: sh -c "echo hello && sleep 200"
another:
image: busybox:latest
command: sh -c "echo test"
3 changes: 3 additions & 0 deletions tests/fixtures/logs-tail-composefile/docker-compose.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
simple:
image: busybox:latest
command: sh -c "echo a && echo b && echo c && echo d"
14 changes: 12 additions & 2 deletions tests/unit/cli/log_printer_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ def build_mock_container(reader):
name_without_project='web_1',
has_api_logs=True,
log_stream=None,
attach=reader,
logs=reader,
wait=mock.Mock(return_value=0),
)

Expand All@@ -39,14 +39,23 @@ def reader(*args, **kwargs):
class TestLogPrinter(object):

def test_single_container(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()
LogPrinter([mock_container], output=output_stream, log_args={'follow': True}).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines + "container exited line"
assert output_stream.flush.call_count == 3

def test_single_container_without_stream(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream).run()

output = output_stream.getvalue()
assert 'hello' in output
assert 'world' in output
# Call count is 2 lines
assert output_stream.flush.call_count == 2

def test_monochrome(self, output_stream, mock_container):
LogPrinter([mock_container], output=output_stream, monochrome=True).run()
assert '\033[' not in output_stream.getvalue()
Expand DownExpand Up@@ -86,3 +95,4 @@ def test_generator_with_no_logs(self, mock_container, output_stream):

output = output_stream.getvalue()
assert "WARNING: no logs are available with the 'none' log driver\n" in output
assert "exited with code" not in output
4 changes: 2 additions & 2 deletions tests/unit/cli/main_test.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ def test_build_log_printer(self):
mock_container('another', 1),
]
service_names = ['web', 'db']
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers[:3])

def test_build_log_printer_all_services(self):
Expand All@@ -43,7 +43,7 @@ def test_build_log_printer_all_services(self):
mock_container('other', 1),
]
service_names = []
log_printer = build_log_printer(containers, service_names, True, False)
log_printer = build_log_printer(containers, service_names, True, False, {'follow': True})
self.assertEqual(log_printer.containers, containers)


Expand Down