DefaultServletCachingListenerTestCase.java
/*
* JBoss, Home of Professional Open Source.
* Copyright 2021 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.undertow.servlet.test.defaultservlet;
import java.io.IOException;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.concurrent.TimeUnit;
import jakarta.servlet.DispatcherType;
import jakarta.servlet.ServletException;
import io.undertow.server.handlers.PathHandler;
import io.undertow.server.handlers.cache.DirectBufferCache;
import io.undertow.server.handlers.resource.CachingResourceManager;
import io.undertow.server.handlers.resource.PathResourceManager;
import io.undertow.server.session.SecureRandomSessionIdGenerator;
import io.undertow.servlet.Servlets;
import io.undertow.servlet.api.DeploymentInfo;
import io.undertow.servlet.api.DeploymentManager;
import io.undertow.servlet.api.ServletContainer;
import io.undertow.servlet.api.ServletInfo;
import io.undertow.servlet.test.path.ServletPathMappingTestCase;
import io.undertow.servlet.test.util.PathTestServlet;
import io.undertow.servlet.test.util.MessageFilter;
import io.undertow.servlet.test.util.TestClassIntrospector;
import io.undertow.testutils.DefaultServer;
import io.undertow.testutils.HttpClientUtils;
import io.undertow.testutils.TestHttpClient;
import io.undertow.util.FileUtils;
import io.undertow.util.StatusCodes;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.junit.AfterClass;
import org.junit.Assert;
import org.junit.Assume;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.xnio.BufferAllocator;
/**
* <p>Same test case than DefaultServletCachingTestCase but enabling the
* resource change listeners to detect changes in the file system.</p>
*
* @author rmartinc
*/
@RunWith(DefaultServer.class)
public class DefaultServletCachingListenerTestCase {
private static final int MAX_FILE_SIZE = 20;
private static final int MAX_WAIT_TIME = 300000;
private static final int WAIT_TIME = 10000;
public static final String DIR_NAME = "cacheTest";
private static Path tmpDir;
private static final DirectBufferCache dataCache = new DirectBufferCache(1000, 10, 1000 * 10 * 1000, BufferAllocator.DIRECT_BYTE_BUFFER_ALLOCATOR, -1);
@Before
public void before() {
for(Object k : dataCache.getAllKeys()) {
dataCache.remove(k);
}
}
@BeforeClass
public static void setup() throws ServletException, IOException {
tmpDir = Files.createTempDirectory(DIR_NAME);
// assume tmp is in the default file system and watch-service is not the slow polling impl
Assume.assumeTrue("WatchService is going to work OK",
FileSystems.getDefault().equals(tmpDir.getFileSystem()) &&
!FileSystems.getDefault().newWatchService().getClass().getName().equals("sun.nio.fs.PollingWatchService"));
final PathHandler root = new PathHandler();
final ServletContainer container = ServletContainer.Factory.newInstance();
DeploymentInfo builder = new DeploymentInfo()
.setClassIntrospecter(TestClassIntrospector.INSTANCE)
.setClassLoader(ServletPathMappingTestCase.class.getClassLoader())
.setContextPath("/servletContext")
.addWelcomePage("index.html")
.setDeploymentName("servletContext.war")
// PathResourceManager enables the resource change listeners in this test and max-age is infinite/-1
.setResourceManager(new CachingResourceManager(100, MAX_FILE_SIZE, dataCache, new PathResourceManager(tmpDir, 10485760, false, false, true), -1));
builder.addServlet(new ServletInfo("DefaultTestServlet", PathTestServlet.class)
.addMapping("/path/default"))
.addFilter(Servlets.filter("message", MessageFilter.class).addInitParam(MessageFilter.MESSAGE, "FILTER_TEXT "))
.addFilterUrlMapping("message", "*.txt", DispatcherType.REQUEST);
DeploymentManager manager = container.addDeployment(builder);
manager.deploy();
root.addPrefixPath(builder.getContextPath(), manager.start());
DefaultServer.setRootHandler(root);
}
@AfterClass
public static void after() throws IOException{
FileUtils.deleteRecursive(tmpDir);
}
private static boolean waitUntilRefreshed(TestHttpClient client, String uri, int expectedStatus)
throws IOException, InterruptedException {
return waitUntilRefreshed(client, uri, expectedStatus, null);
}
private static boolean waitUntilRefreshed(TestHttpClient client, String uri, int expectedStatus, String expectedResponse)
throws IOException, InterruptedException {
boolean ok = false;
long startTime = System.currentTimeMillis();
while (!ok && System.currentTimeMillis() - startTime < MAX_WAIT_TIME) {
HttpGet get = new HttpGet(uri);
HttpResponse result = client.execute(get);
String response = HttpClientUtils.readResponse(result);
if (result.getStatusLine().getStatusCode() == expectedStatus &&
(expectedResponse == null || expectedResponse.equals(response))) {
ok = true;
} else {
TimeUnit.MILLISECONDS.sleep(WAIT_TIME);
}
}
return ok;
}
@Test
public void testFileExistanceCheckCached() throws IOException, InterruptedException {
TestHttpClient client = new TestHttpClient();
String fileName = new SecureRandomSessionIdGenerator().createSessionId() + ".html";
try {
HttpGet get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/" + fileName);
HttpResponse result = client.execute(get);
Assert.assertEquals(StatusCodes.NOT_FOUND, result.getStatusLine().getStatusCode());
HttpClientUtils.readResponse(result);
Path f = tmpDir.resolve(fileName);
Files.write(f, "hello".getBytes());
Assert.assertTrue("File was not refreshed in " + MAX_WAIT_TIME + "ms",
waitUntilRefreshed(client, DefaultServer.getDefaultServerURL() + "/servletContext/" + fileName, StatusCodes.OK, "hello"));
Files.delete(f);
} finally {
client.getConnectionManager().shutdown();
}
}
@Test
public void testFileContentsCached() throws IOException, InterruptedException {
TestHttpClient client = new TestHttpClient();
String fileName = "hello.html";
Path f = tmpDir.resolve(fileName);
Files.write(f, "hello".getBytes());
try {
for (int i = 0; i < 10; ++i) {
HttpGet get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/" + fileName);
HttpResponse result = client.execute(get);
Assert.assertEquals(StatusCodes.OK, result.getStatusLine().getStatusCode());
String response = HttpClientUtils.readResponse(result);
Assert.assertEquals("hello", response);
}
Files.write(f, "hello world".getBytes());
Assert.assertTrue("File was not refreshed in " + MAX_WAIT_TIME + "ms",
waitUntilRefreshed(client, DefaultServer.getDefaultServerURL() + "/servletContext/" + fileName, StatusCodes.OK, "hello world"));
Files.delete(f);
} finally {
client.getConnectionManager().shutdown();
}
}
@Test
public void testFileContentsCachedWithFilter() throws IOException, InterruptedException {
TestHttpClient client = new TestHttpClient();
String fileName = "hello.txt";
Path f = tmpDir.resolve(fileName);
Files.write(f, "hello".getBytes());
try {
for (int i = 0; i < 10; ++i) {
HttpGet get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/" + fileName);
HttpResponse result = client.execute(get);
Assert.assertEquals(StatusCodes.OK, result.getStatusLine().getStatusCode());
String response = HttpClientUtils.readResponse(result);
Assert.assertEquals("FILTER_TEXT hello", response);
}
Files.write(f, "hello world".getBytes());
Assert.assertTrue("File was not refreshed in " + MAX_WAIT_TIME + "ms",
waitUntilRefreshed(client, DefaultServer.getDefaultServerURL() + "/servletContext/" + fileName, StatusCodes.OK, "FILTER_TEXT hello world"));
Files.delete(f);
} finally {
client.getConnectionManager().shutdown();
}
}
@Test
public void testRangeRequest() throws IOException {
TestHttpClient client = new TestHttpClient();
try {
String fileName = "range.html";
Path f = tmpDir.resolve(fileName);
Files.write(f, "hello".getBytes());
HttpGet get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/range.html");
get.addHeader("range", "bytes=2-3");
HttpResponse result = client.execute(get);
Assert.assertEquals(StatusCodes.PARTIAL_CONTENT, result.getStatusLine().getStatusCode());
String response = HttpClientUtils.readResponse(result);
Assert.assertEquals("ll", response);
} finally {
client.getConnectionManager().shutdown();
}
}
@Test
public void testRangeRequestFileNotInCache() throws IOException {
TestHttpClient client = new TestHttpClient();
try {
String fileName = "range_not_in_cache.html";
Path f = tmpDir.resolve(fileName);
Files.write(f, "hello world and once again hello world".getBytes());
HttpGet get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/range_not_in_cache.html");
get.addHeader("range", "bytes=2-3");
HttpResponse result = client.execute(get);
Assert.assertEquals(StatusCodes.PARTIAL_CONTENT, result.getStatusLine().getStatusCode());
String response = HttpClientUtils.readResponse(result);
Assert.assertEquals("ll", response);
} finally {
client.getConnectionManager().shutdown();
}
}
@Test
public void testWelcomePages() throws IOException, InterruptedException {
TestHttpClient client = new TestHttpClient();
try {
String fileName = "index.html";
String content = "<html></html>";
HttpGet get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/");
HttpResponse result = client.execute(get);
Assert.assertEquals(StatusCodes.FORBIDDEN, result.getStatusLine().getStatusCode());
HttpClientUtils.readResponse(result);
get = new HttpGet(DefaultServer.getDefaultServerURL() + "/servletContext/" + fileName);
result = client.execute(get);
Assert.assertEquals(StatusCodes.NOT_FOUND, result.getStatusLine().getStatusCode());
HttpClientUtils.readResponse(result);
Path f = tmpDir.resolve(fileName);
Files.write(f, content.getBytes());
Assert.assertTrue("File was not refreshed in " + MAX_WAIT_TIME + "ms",
waitUntilRefreshed(client, DefaultServer.getDefaultServerURL() + "/servletContext/" + fileName, StatusCodes.OK, content));
Assert.assertTrue("File was not refreshed in " + MAX_WAIT_TIME + "ms",
waitUntilRefreshed(client, DefaultServer.getDefaultServerURL() + "/servletContext/", StatusCodes.OK, content));
Files.delete(f);
Assert.assertTrue("File was not refreshed in " + MAX_WAIT_TIME + "ms",
waitUntilRefreshed(client, DefaultServer.getDefaultServerURL() + "/servletContext/" + fileName, StatusCodes.NOT_FOUND));
Assert.assertTrue("File was not refreshed in " + MAX_WAIT_TIME + "ms",
waitUntilRefreshed(client, DefaultServer.getDefaultServerURL() + "/servletContext/", StatusCodes.FORBIDDEN));
} finally {
client.getConnectionManager().shutdown();
}
}
}