/**
* The MIT License (MIT)
*
* Copyright (c) 2014-2017 Yegor Bugayenko
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.takes.http;
import com.google.common.base.Joiner;
import com.jcabi.http.request.JdkRequest;
import com.jcabi.http.response.RestResponse;
import com.jcabi.matchers.RegexMatchers;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.URI;
import java.util.Collections;
import java.util.concurrent.atomic.AtomicReference;
import org.hamcrest.MatcherAssert;
import org.hamcrest.Matchers;
import org.junit.Ignore;
import org.junit.Test;
import org.takes.Request;
import org.takes.Response;
import org.takes.Take;
import org.takes.facets.fork.FkRegex;
import org.takes.facets.fork.TkFork;
import org.takes.rq.RqHeaders;
import org.takes.rq.RqSocket;
import org.takes.tk.TkText;
/**
* Test case for {@link BkBasic}.
*
* @author Dmitry Zaytsev (dmitry.zaytsev@gmail.com)
* @version $Id: 3af32df4de1bbfa132fe3591774d4cd4f7137f37 $
* @since 0.15.2
* @checkstyle ClassDataAbstractionCouplingCheck (500 lines)
* @checkstyle MultipleStringLiteralsCheck (500 lines)
* @todo #516:15min Move header names from BkBasic to public constants.
* Reusable header names will help in many situations. For example - in new
* integration tests.
*/
@SuppressWarnings(
{
"PMD.ExcessiveImports",
"PMD.TooManyMethods"
})
public final class BkBasicTest {
/**
* Carriage return constant.
*/
private static final String CRLF = "\r\n";
/**
* POST header constant.
*/
private static final String POST = "POST / HTTP/1.1";
/**
* Host header constant.
*/
private static final String HOST = "Host:localhost";
/**
* BkBasic can handle socket data.
*
* @throws IOException If some problem inside
*/
@Test
public void handlesSocket() throws IOException {
final MkSocket socket = BkBasicTest.createMockSocket();
final ByteArrayOutputStream baos = socket.bufferedOutput();
final String hello = "Hello World";
new BkBasic(new TkText(hello)).accept(socket);
MatcherAssert.assertThat(
baos.toString(),
Matchers.containsString(hello)
);
}
/**
* BkBasic can return HTTP status 404 when accessing invalid URL.
*
* @throws IOException if any I/O error occurs.
*/
@Test
public void returnsProperResponseCodeOnInvalidUrl() throws IOException {
new FtRemote(
new TkFork(
new FkRegex("/path/a", new TkText("a")),
new FkRegex("/path/b", new TkText("b"))
)
).exec(
new FtRemote.Script() {
@Override
public void exec(final URI home) throws IOException {
new JdkRequest(String.format("%s/path/c", home))
.fetch()
.as(RestResponse.class)
.assertStatus(HttpURLConnection.HTTP_NOT_FOUND);
}
}
);
}
/**
* BkBasic produces headers with addresses without slashes.
*
* @throws IOException If some problem inside
*/
@Test
public void addressesInHeadersAddedWithoutSlashes() throws IOException {
final Socket socket = BkBasicTest.createMockSocket();
final AtomicReference<Request> ref = new AtomicReference<>();
new BkBasic(
new Take() {
@Override
public Response act(final Request req) {
ref.set(req);
return new Response() {
@Override
public Iterable<String> head() throws IOException {
return Collections.singletonList("HTTP/1.1 200 OK");
}
@Override
public InputStream body() throws IOException {
return req.body();
}
};
}
}
).accept(socket);
final Request request = ref.get();
final RqHeaders.Smart smart = new RqHeaders.Smart(
new RqHeaders.Base(request)
);
MatcherAssert.assertThat(
smart.single(
"X-Takes-LocalAddress",
""
),
Matchers.not(
Matchers.containsString("/")
)
);
MatcherAssert.assertThat(
smart.single(
"X-Takes-RemoteAddress",
""
),
Matchers.not(
Matchers.containsString("/")
)
);
MatcherAssert.assertThat(
new RqSocket(request).getLocalAddress(),
Matchers.notNullValue()
);
MatcherAssert.assertThat(
new RqSocket(request).getRemoteAddress(),
Matchers.notNullValue()
);
}
/**
* BkBasic can handle two requests in one connection.
*
* @throws Exception If some problem inside
*/
@Test
public void handlesTwoRequestInOneConnection() throws Exception {
final String text = "Hello Twice!";
final ByteArrayOutputStream output = new ByteArrayOutputStream();
final ServerSocket server = new ServerSocket(0);
try {
new Thread(
new Runnable() {
@Override
public void run() {
try {
new BkBasic(new TkText(text)).accept(
server.accept()
);
} catch (final IOException exception) {
throw new IllegalStateException(exception);
}
}
}
).start();
final Socket socket = new Socket(
server.getInetAddress(),
server.getLocalPort()
);
try {
socket.getOutputStream().write(
Joiner.on(BkBasicTest.CRLF).join(
BkBasicTest.POST,
BkBasicTest.HOST,
"Content-Length: 11",
"",
"Hello First",
BkBasicTest.POST,
BkBasicTest.HOST,
"Content-Length: 12",
"",
"Hello Second"
).getBytes()
);
final InputStream input = socket.getInputStream();
// @checkstyle MagicNumber (1 line)
final byte[] buffer = new byte[4096];
for (int count = input.read(buffer); count != -1;
count = input.read(buffer)) {
output.write(buffer, 0, count);
}
} finally {
socket.close();
}
} finally {
server.close();
}
MatcherAssert.assertThat(
output.toString(),
RegexMatchers.containsPattern(
String.format("(?s)%s.*?%s", text, text)
)
);
}
/**
* BkBasic can return HTTP status 411 when a persistent connection request
* has no Content-Length.
*
* @throws Exception If some problem inside
*/
@Ignore
@Test
public void returnsProperResponseCodeOnNoContentLength() throws Exception {
final ByteArrayOutputStream output = new ByteArrayOutputStream();
final ServerSocket server = new ServerSocket(0);
final String text = "Say hello!";
try {
new Thread(
new Runnable() {
@Override
public void run() {
try {
new BkBasic(new TkText("411 Test")).accept(
server.accept()
);
} catch (final IOException exception) {
throw new IllegalStateException(exception);
}
}
}
).start();
final Socket socket = new Socket(
server.getInetAddress(),
server.getLocalPort()
);
try {
socket.getOutputStream().write(
Joiner.on(BkBasicTest.CRLF).join(
BkBasicTest.POST,
BkBasicTest.HOST,
"",
text
).getBytes()
);
final InputStream input = socket.getInputStream();
// @checkstyle MagicNumber (1 line)
final byte[] buffer = new byte[4096];
for (int count = input.read(buffer); count != -1;
count = input.read(buffer)) {
output.write(buffer, 0, count);
}
} finally {
socket.close();
}
} finally {
server.close();
}
MatcherAssert.assertThat(
output.toString(),
Matchers.containsString("HTTP/1.1 411 Length Required")
);
}
/**
* BkBasic can accept no content-length on closed connection.
*
* @throws Exception If some problem inside
*/
@Ignore
@Test
public void acceptsNoContentLengthOnClosedConnection() throws Exception {
final String text = "Close Test";
final ByteArrayOutputStream output = new ByteArrayOutputStream();
final ServerSocket server = new ServerSocket(0);
final String greetings = "Hi everyone";
try {
new Thread(
new Runnable() {
@Override
public void run() {
try {
new BkBasic(new TkText(text)).accept(
server.accept()
);
} catch (final IOException exception) {
throw new IllegalStateException(exception);
}
}
}
).start();
final Socket socket = new Socket(
server.getInetAddress(),
server.getLocalPort()
);
try {
socket.getOutputStream().write(
Joiner.on(BkBasicTest.CRLF).join(
BkBasicTest.POST,
BkBasicTest.HOST,
"Connection: Close",
"",
greetings
).getBytes()
);
final InputStream input = socket.getInputStream();
// @checkstyle MagicNumber (1 line)
final byte[] buffer = new byte[4096];
for (int count = input.read(buffer); count != -1;
count = input.read(buffer)) {
output.write(buffer, 0, count);
}
} finally {
socket.close();
}
} finally {
server.close();
}
MatcherAssert.assertThat(
output.toString(),
Matchers.containsString(text)
);
}
/**
* Creates Socket mock for reuse.
*
* @return Prepared Socket mock
* @throws IOException If some problem inside
*/
private static MkSocket createMockSocket() throws IOException {
return new MkSocket(
new ByteArrayInputStream(
Joiner.on(BkBasicTest.CRLF).join(
"GET / HTTP/1.1",
BkBasicTest.HOST,
"Content-Length: 2",
"",
"hi"
).getBytes()
)
);
}
}