RtContainerTestCase.java

/**
 * 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 com.amihaiemil.docker.mock.AssertRequest;
import com.amihaiemil.docker.mock.Condition;
import com.amihaiemil.docker.mock.Response;
import org.apache.http.HttpStatus;
import org.apache.http.client.HttpClient;
import org.hamcrest.MatcherAssert;
import org.hamcrest.Matchers;
import org.junit.Test;
import org.mockito.Mockito;
import javax.json.Json;
import javax.json.JsonObject;
import java.io.IOException;
import java.net.URI;
import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.when;

/**
 * Unit tests for RtContainer.
 * @author Mihai Andronache (amihaiemil@gmail.com)
 * @version $Id$
 * @since 0.0.1
 */
public final class RtContainerTestCase {

    /**
     * RtContainer can return its id.
     */
    @Test
    public void returnsId() {
        final Container container = new RtContainer(
            Json.createObjectBuilder().add("Id", "123id456").build(),
            Mockito.mock(HttpClient.class),
            URI.create("unix://localhost:80/1.30/containers/123id456"),
            Mockito.mock(Docker.class)
        );
        MatcherAssert.assertThat(
            container.containerId(),
            Matchers.equalTo("123id456")
        );
    }

    /**
     * RtContainer can return its parent Docker.
     */
    @Test
    public void returnsDocker() {
        final Docker parent = Mockito.mock(Docker.class);
        MatcherAssert.assertThat(
            new RtContainer(
                Json.createObjectBuilder().add("Id", "123id456").build(),
                Mockito.mock(HttpClient.class),
                URI.create("unix://localhost:80/1.30/containers/123id456"),
                parent
            ).docker(),
            Matchers.is(parent)
        );
    }
    
    /**
     * RtContainer can return info about itself.
     * @throws Exception If something goes wrong.
     */
    @Test
    public void inspectsItself() throws Exception {
        final Container container = new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_OK,
                    Json.createObjectBuilder()
                        .add("Id", "123")
                        .add("Image", "some/image")
                        .add("Name", "boring_euclid")
                        .build().toString()
                ),
                new Condition(
                    "Method should be a GET",
                    req -> req.getRequestLine().getMethod().equals("GET")
                ),
                new Condition(
                    "Resource path must be /{id}/json",
                    req -> req.getRequestLine().getUri().endsWith("/123/json")
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        );
        final JsonObject info = container.inspect();
        MatcherAssert.assertThat(info.keySet(), Matchers.hasSize(3));
        MatcherAssert.assertThat(
            info.getString("Id"), Matchers.equalTo("123")
        );
        MatcherAssert.assertThat(
            info.getString("Image"), Matchers.equalTo("some/image")
        );
        MatcherAssert.assertThat(
            info.getString("Name"), Matchers.equalTo("boring_euclid")
        );
    }

    /**
     * RtContainer.inspect() throws URE because the HTTP Response's status
     * is not 200 OK.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void inspectsNotFound() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(HttpStatus.SC_NOT_FOUND)
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).inspect();
    }

    /**
     * RtContainer can start with no problem.
     * @throws Exception If something goes wrong.
     */
    @Test
    public void startsOk() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NO_CONTENT
                ),
                new Condition(
                    "Method should be a POST",
                    req -> req.getRequestLine().getMethod().equals("POST")
                ),
                new Condition(
                    "Resource path must be /{id}/start",
                    req -> req.getRequestLine().getUri().endsWith("/123/start")
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).start();
    }

    /**
     * RtContainer throws URE if it receives server error on start.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void startsWithServerError() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_INTERNAL_SERVER_ERROR
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).start();
    }

    /**
     * RtContainer throws URE if it receives "Not Found" on start.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void startsWithNotFound() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NOT_FOUND
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).start();
    }

    /**
     * RtContainer throws URE if it receives "Not Modified" on start.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void startsWithNotModified() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NOT_MODIFIED
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).start();
    }

    /**
     * RtContainer can stop with no problem.
     * @throws Exception If something goes wrong.
     */
    @Test
    public void stopsOk() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NO_CONTENT
                ),
                new Condition(
                    "Method should be a POST",
                    req -> req.getRequestLine().getMethod().equals("POST")
                ),
                new Condition(
                    "Resource path must be /{id}/stop",
                    req -> req.getRequestLine().getUri().endsWith("/123/stop")
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).stop();
    }

    /**
     * RtContainer throws URE if it receives server error on stop.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void stopsWithServerError() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_INTERNAL_SERVER_ERROR
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).stop();
    }

    /**
     * RtContainer throws URE if it receives "Not Found" on stop.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void stopsWithNotFound() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NOT_FOUND
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).stop();
    }

    /**
     * RtContainer throws URE if it receives "Not Modified" on stop.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void stopsWithNotModified() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NOT_MODIFIED
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).stop();
    }

    /**
     * Wellformed request for the restart command.
     * @throws Exception If something goes wrong.
     */
    @Test
    public void restartsOk() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "9403").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NO_CONTENT
                ),
                new Condition(
                    "Method should be a POST",
                    req -> req.getRequestLine().getMethod().equals("POST")
                ),
                new Condition(
                    "Resource path must be /{id}/restart",
                    req -> req.getRequestLine()
                        .getUri().endsWith("/9403/restart")
                )
            ),
            URI.create("http://localhost:80/1.30/containers/9403"),
            Mockito.mock(Docker.class)
        ).restart();
    }

    /**
     * RtContainer throws UnexpectedResponseException if it receives server
     * error 500 on restart.
     * @throws Exception The UnexpectedResponseException.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void restartWithServerError() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_INTERNAL_SERVER_ERROR
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).restart();
    }

    /**
     * RtContainer throws UnexpectedResponseException if it receives 404 error
     * on restart.
     * @throws Exception The UnexpectedResponseException.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void restartsWithNotFound() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NOT_FOUND
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).restart();
    }

    /**
     * RtContainer can be killed with no problem.
     * @throws Exception If something goes wrong.
     */
    @Test
    public void killedOk() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NO_CONTENT
                ),
                new Condition(
                    "Method should be a POST",
                    req -> req.getRequestLine().getMethod().equals("POST")
                ),
                new Condition(
                    "Resource path must be /{id}/kill",
                    req -> req.getRequestLine().getUri().endsWith("/123/kill")
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).kill();
    }

    /**
     * RtContainer throws URE if it receives server error on kill.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void killedWithServerError() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_INTERNAL_SERVER_ERROR
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).kill();
    }

    /**
     * RtContainer throws URE if it receives "Not Found" on kill.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void killedWithNotFound() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NOT_FOUND
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).kill();
    }
    
    /**
     * RtContainer can be renamed with no problem.
     * @throws Exception If something goes wrong.
     */
    @Test
    public void renamedOk() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NO_CONTENT
                ),
                new Condition(
                    "Method should be a POST",
                    req -> req.getRequestLine().getMethod().equals("POST")
                ),
                new Condition(
                    "Resource path must be /{id}/rename?name=test",
                    req -> req.getRequestLine().getUri().endsWith(
                        "/123/rename?name=test"
                    )
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).rename("test");
    }
    
    /**
     * RtContainer throws URE if it receives "Not Found" on rename.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void renameWithNotFound() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NOT_FOUND
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).rename("test");
    }
    
    /**
     * RtContainer throws URE if it receives server error on rename.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void renameWithServerError() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_INTERNAL_SERVER_ERROR
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).rename("newname");
    }
    
    /**
     * RtContainer throws URE if it receives conflict on rename.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void renameWithConflict() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_CONFLICT
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).rename("duplicate");
    }
    
    /**
     * RtContainer can be removed with no problem.
     * @throws Exception If something goes wrong.
     */
    @Test
    public void removeOk() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NO_CONTENT
                ),
                new Condition(
                    "Method should be a DELETE",
                    req -> req.getRequestLine().getMethod().equals("DELETE")
                ),
                new Condition(
                    "Resource path must be /123?v=false&force=false&link=false",
                    req -> req.getRequestLine().getUri().endsWith(
                        "/123?v=false&force=false&link=false"
                    )
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).remove();
    }
    
    /**
     * RtContainer throws URE if it receives BAD REQUEST on remove.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void removeWithBadParameter() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_BAD_REQUEST
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).remove();
    }
    
    /**
     * RtContainer throws URE if it receives NOT FOUND on remove.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void removeWithNotFound() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_NOT_FOUND
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).remove();
    }
    
    /**
     * RtContainer throws URE if it receives a conflict on remove.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void removeWithConflict() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_CONFLICT
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).remove();
    }
    
    /**
     * RtContainer throws URE if it receives a server error on remove.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void removeWithServerError() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_INTERNAL_SERVER_ERROR
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).remove();
    }
    
    /**
     * RtContainer can return its logs.
     */
    @Test
    public void getsLogs() {
        MatcherAssert.assertThat(
            new RtContainer(
                Json.createObjectBuilder().build(),
                new AssertRequest(
                    new Response(
                        HttpStatus.SC_OK
                    )
                ),
                URI.create("http://localhost:80/1.30/containers/123"),
                Mockito.mock(Docker.class)
            ).logs(),
            Matchers.notNullValue()
        );
    }

    /**
     * RtContainer can wait with no problem.
     * @throws Exception If something goes wrong.
     */
    @Test
    public void waitsOk() throws Exception {
        int retval = new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_OK,
                    Json.createObjectBuilder()
                        .add("StatusCode", 0)
                        .build().toString()
                ),
                new Condition(
                    "Method should be a POST",
                    req -> req.getRequestLine().getMethod().equals("POST")
                ),
            new Condition(
                "Resource path must be /123/wait",
                req ->  req.getRequestLine().getUri().endsWith("/wait")
            )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).waitOn(null);
        assertEquals(0, retval);
    }

    /**
     * RtContainer can wait with a condition.
     * @throws Exception If something goes wrong.
     */
    @Test
    public void waitsOkWithCondition() throws Exception {
        int retval = new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_OK,
                    Json.createObjectBuilder()
                        .add("StatusCode", 0)
                        .build().toString()
                ),
                new Condition(
                    "Method should be a POST",
                    req -> req.getRequestLine().getMethod().equals("POST")
                ),
            new Condition(
                "Resource path must be /123/wait",
                req -> req.getRequestLine().getUri().endsWith("ition=next-exit")
            )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).waitOn("next-exit");
        assertEquals(0, retval);
    }

    /**
     * RtContainer throws URE if it receives a server error on remove.
     * @throws Exception If something goes wrong.
     */
    @Test(expected = UnexpectedResponseException.class)
    public void waitWithServerError() throws Exception {
        new RtContainer(
            Json.createObjectBuilder().build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_INTERNAL_SERVER_ERROR
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).waitOn(null);
    }

    /**
     * Can create Exec.
     * @throws Exception If something goes wrong.
     */
    @Test
    public void createTest() throws Exception {
        final JsonObject json = Json.createObjectBuilder()
            .add("Cmd", Json.createArrayBuilder().add("date").build())
            .add("Tty", "true")
            .add("AttachStdin", "true")
            .build();

        RtContainer rtContainer = new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_CREATED,
                    Json.createObjectBuilder()
                        .add("Id", "01e1564097")
                        .build().toString()
                ),
                new Condition(
                    "Method should be a POST",
                    req -> req.getRequestLine().getMethod().equals("POST")
                ),
                new Condition(
                    "Resource path must be /123/exec",
                    req -> req.getRequestLine().getUri().endsWith("/123/exec")
                )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        );
        when(rtContainer.docker().execs()).thenReturn(
            new RtExecs(
                new AssertRequest(
                    new Response(
                        HttpStatus.SC_OK,
                        "{\"Id\": \"exec123\"}"
                    ),
                    new Condition(
                        "must send a GET request",
                        req -> "GET".equals(req.getRequestLine().getMethod())
                    ),
                    new Condition(
                        "resource URL should end with '/exec123/json'",
                        req -> req.getRequestLine()
                            .getUri().endsWith("/exec123/json")
                    )
                ),
                URI.create("http://localhost/exec"),
                Mockito.mock(Docker.class)
            )
        );
        rtContainer.exec(json);
    }

    /**
     * Must fail if docker responds with error code 500.
     * @throws IOException due to code 500
     */
    @Test(expected = UnexpectedResponseException.class)
    public void execWithServerError() throws IOException {
        final JsonObject json = Json.createObjectBuilder()
            .add("Tty", "true")
            .add("AttachStdin", "true")
            .build();

        new RtContainer(
            Json.createObjectBuilder().add("Id", "123").build(),
            new AssertRequest(
                new Response(
                    HttpStatus.SC_INTERNAL_SERVER_ERROR
                ),
                new Condition(
                    "Method should be a POST",
                    req -> req.getRequestLine().getMethod().equals("POST")
                ),
                new Condition(
                    "Resource path must be /123/exec",
                    req -> req.getRequestLine().getUri().endsWith("/123/exec")
            )
            ),
            URI.create("http://localhost:80/1.30/containers/123"),
            Mockito.mock(Docker.class)
        ).exec(json);
    }
}