Skip to content

Commit

Permalink
logs stdout, stderr and integration tests
Browse files Browse the repository at this point in the history
  • Loading branch information
amihaiemil committed Jan 3, 2019
1 parent c338a37 commit 06cba76
Show file tree
Hide file tree
Showing 3 changed files with 105 additions and 8 deletions.
18 changes: 13 additions & 5 deletions src/main/java/com/amihaiemil/docker/RtLogs.java
Expand Up @@ -43,10 +43,11 @@
* Since the class should be immutable, the parameters should come in the ctor
* and appended to the requests when they are performed. Let's leave this part
* for v0.0.3 or later, it's not urgent now.
* @todo #130:30min Write some ITCase for the fetch() method. We might have to
* implement the stream decoding (in case TTY is disabled when the Container
* is created), as explained here, in "Stream format" paragraph:
* https://docs.docker.com/engine/api/v1.37/#operation/ContainerAttach
* @todo @256:30min Apparently, either stderr or stdout are mandatory params
* when reading the logs. At the moment, we specify both as "true", but we
* should give the user the option to chose. Let's implement Logs.stderr(),
* Logs.stdout() and Logs.all() -- all 3 methods should return Logs. As usual,
* RtLogs should remain immutable.
*/
final class RtLogs implements Logs {

Expand Down Expand Up @@ -79,7 +80,12 @@ final class RtLogs implements Logs {

@Override
public String fetch() throws IOException, UnexpectedResponseException {
final HttpGet fetch = new HttpGet(this.baseUri.toString());
final HttpGet fetch = new HttpGet(
new UncheckedUriBuilder(this.baseUri.toString())
.addParameter("stdout", "true")
.addParameter("stderr", "true")
.build()
);
try {
return this.client.execute(
fetch,
Expand All @@ -101,6 +107,8 @@ public Reader follow()
final HttpGet follow = new HttpGet(
new UncheckedUriBuilder(this.baseUri.toString())
.addParameter("follow", "true")
.addParameter("stdout", "true")
.addParameter("stderr", "true")
.build()
);
return this.client.execute(
Expand Down
89 changes: 89 additions & 0 deletions src/test/java/com/amihaiemil/docker/RtLogsITCase.java
@@ -0,0 +1,89 @@
/**
* Copyright (c) 2018-2019, Mihai Emil Andronache
* All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1)Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2)Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3)Neither the name of docker-java-api nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.amihaiemil.docker;

import org.apache.commons.io.IOUtils;
import org.hamcrest.MatcherAssert;
import org.hamcrest.Matchers;
import org.junit.Ignore;
import org.junit.Test;

import java.io.File;

/**
* Integration tests for {@link RtLogs}.
* @author Mihai Andronache (amihaiemil@gmail.com)
* @version $Id#
* @since 0.0.7
* @todo #256:30min Fix the IT case for follow(), it is currently failing.
* We might have to implement the stream decoding (in case TTY is disabled
* when the Container is created), as explained here, in "Stream format"
* paragraph:
* https://docs.docker.com/engine/api/v1.37/#operation/ContainerAttach
*/
public final class RtLogsITCase {

/**
* RtLogs can fetch the Container's logs (return them as a String).
* @throws Exception If something goes wrong.
*/
@Test
public void fetchesLogs() throws Exception {
final Container container = new LocalDocker(
new File("/var/run/docker.sock")
).images().pull("hello-world", "latest").run();
final String logs = container.logs().fetch();
MatcherAssert.assertThat(
logs,
Matchers.not(Matchers.isEmptyOrNullString())
);
MatcherAssert.assertThat(
logs.trim(),
Matchers.startsWith("Hello from Docker!")
);
}

/**
* RtLogs can follow the Container's logs (return them as a Reader).
* @throws Exception If something goes wrong.
*/
@Test
@Ignore
public void followsLogs() throws Exception {
final Container container = new LocalDocker(
new File("/var/run/docker.sock")
).images().pull("hello-world", "latest").run();
final String logs = IOUtils.toString(container.logs().follow());
MatcherAssert.assertThat(
logs,
Matchers.not(Matchers.isEmptyOrNullString())
);
MatcherAssert.assertThat(
logs.trim(),
Matchers.startsWith("Hello from Docker!")
);
}
}
6 changes: 3 additions & 3 deletions src/test/java/com/amihaiemil/docker/RtLogsTestCase.java
Expand Up @@ -86,7 +86,7 @@ public void followsLogs() throws Exception {
new Condition(
"Resource path must be /123/logs?follow=true",
req -> req.getRequestLine().getUri().endsWith(
"/123/logs?follow=true"
"/123/logs?follow=true&stdout=true&stderr=true"
)
)
),
Expand Down Expand Up @@ -122,7 +122,7 @@ public void fetchesLogs() throws Exception {
new Condition(
"Resource path must be /123/logs",
req -> req.getRequestLine().getUri().endsWith(
"/123/logs"
"/123/logs?stdout=true&stderr=true"
)
)
),
Expand Down Expand Up @@ -155,7 +155,7 @@ public void toStringFetch() {
new Condition(
"Resource path must be /123/logs",
req -> req.getRequestLine().getUri().endsWith(
"/123/logs"
"/123/logs?stdout=true&stderr=true"
)
)
),
Expand Down

0 comments on commit 06cba76

Please sign in to comment.