/*
* Weblounge: Web Content Management System
* Copyright (c) 2003 - 2011 The Weblounge Team
* http://entwinemedia.com/weblounge
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package ch.entwine.weblounge.test.harness.content;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import ch.entwine.weblounge.common.impl.testing.IntegrationTestBase;
import ch.entwine.weblounge.common.impl.util.TestUtils;
import ch.entwine.weblounge.common.url.UrlUtils;
import ch.entwine.weblounge.test.util.TestSiteUtils;
import org.apache.http.Header;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.DefaultHttpClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import javax.servlet.http.HttpServletResponse;
/**
* Integration test for file serving capabilities.
*/
public class FilesTest extends IntegrationTestBase {
/** The logger */
private static final Logger logger = LoggerFactory.getLogger(FilesTest.class);
/** Path to the image resource */
private static final String path = "/test/document";
/** File size of the English version */
private static final long sizeEnglish = 73642L;
/** Mime type of the English version */
private static final String mimetypeEnglish = "image/jpeg; charset=utf-8";
/** File name of the English version */
private static final String filenameEnglish = "porsche.jpg";
/** File size of the German version */
private static final long sizeGerman = 88723L;
/** Mime type of the German version */
private static final String mimetypeGerman = "image/jpeg; charset=utf-8";
/** File name of the German version */
private static final String filenameGerman = "porsche.jpg";
/** Resource identifier */
private static final String resourceId = "6bc19990-8f99-4873-a813-71b6dfac22ad";
/** File id */
protected String fileId = null;
/** File path */
protected String filePath = null;
/** Modification date parser */
private static final SimpleDateFormat lastModifiedDateFormat = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss zzz", Locale.US);
/**
* Creates a new instance of the images test.
*/
public FilesTest() {
super("Files Test", WEBLOUNGE_CONTENT_TEST_GROUP);
}
/**
* {@inheritDoc}
*
* @see ch.entwine.weblounge.testing.kernel.IntegrationTest#execute(java.lang.String)
*/
@Override
public void execute(String serverUrl)
throws Exception {
logger.info("Preparing test of file request handler");
testGetDocument(serverUrl);
testGetDocumentById(serverUrl);
testGetDocumentByIdAndName(serverUrl);
testGetDocumentByPathLanguage(serverUrl);
testGetDocumentByHeaderLanguage(serverUrl);
}
/**
* Tests the whether the original document is returned.
*
* @param serverUrl
* the base url
* @throws Exception
* if an exception occurs
*/
private void testGetDocument(String serverUrl) throws Exception {
HttpClient httpClient = null;
String url = UrlUtils.concat(serverUrl, path);
HttpGet request = new HttpGet(url);
request.setHeader("Accept-Language", "de");
httpClient = new DefaultHttpClient();
String eTagValue = null;
Date modificationDate = null;
try {
logger.info("Requesting original document from {}", request.getURI());
HttpResponse response = TestUtils.request(httpClient, request, null);
assertEquals(HttpServletResponse.SC_OK, response.getStatusLine().getStatusCode());
assertTrue("No content received", response.getEntity().getContentLength() > 0);
// Test general headers
assertEquals(1, response.getHeaders("Content-Type").length);
assertEquals(mimetypeGerman, response.getHeaders("Content-Type")[0].getValue());
assertEquals(sizeGerman, response.getEntity().getContentLength());
assertEquals(1, response.getHeaders("Content-Disposition").length);
assertEquals("inline; filename=" + filenameGerman, response.getHeaders("Content-Disposition")[0].getValue());
// Test ETag header
Header eTagHeader = response.getFirstHeader("ETag");
assertNotNull(eTagHeader);
assertNotNull(eTagHeader.getValue());
eTagValue = eTagHeader.getValue();
// Test Last-Modified header
Header modifiedHeader = response.getFirstHeader("Last-Modified");
assertNotNull(modifiedHeader);
modificationDate = lastModifiedDateFormat.parse(modifiedHeader.getValue());
// Consume the content
response.getEntity().consumeContent();
} finally {
httpClient.getConnectionManager().shutdown();
}
TestSiteUtils.testETagHeader(request, eTagValue, logger, null);
TestSiteUtils.testModifiedHeader(request, modificationDate, logger, null);
}
/**
* Tests for the special <code>/weblounge-files</code> uri prefix that is
* provided by the file request handler.
*
* @param serverUrl
* the base url
* @throws Exception
* if an exception occurs
*/
private void testGetDocumentById(String serverUrl) throws Exception {
HttpClient httpClient = null;
String url = UrlUtils.concat(serverUrl, "weblounge-files", resourceId);
HttpGet request = new HttpGet(url);
request.setHeader("Accept-Language", "de");
httpClient = new DefaultHttpClient();
String eTagValue = null;
Date modificationDate = null;
try {
logger.info("Requesting German document version from {}", request.getURI());
HttpResponse response = TestUtils.request(httpClient, request, null);
assertEquals(HttpServletResponse.SC_OK, response.getStatusLine().getStatusCode());
assertTrue("No content received", response.getEntity().getContentLength() > 0);
// Test general headers
assertEquals(1, response.getHeaders("Content-Type").length);
assertEquals(mimetypeGerman, response.getHeaders("Content-Type")[0].getValue());
assertEquals(sizeGerman, response.getEntity().getContentLength());
assertEquals(1, response.getHeaders("Content-Disposition").length);
assertEquals("inline; filename=" + filenameGerman, response.getHeaders("Content-Disposition")[0].getValue());
// Test ETag header
Header eTagHeader = response.getFirstHeader("ETag");
assertNotNull(eTagHeader);
assertNotNull(eTagHeader.getValue());
eTagValue = eTagHeader.getValue();
// Test Last-Modified header
Header modifiedHeader = response.getFirstHeader("Last-Modified");
assertNotNull(modifiedHeader);
modificationDate = lastModifiedDateFormat.parse(modifiedHeader.getValue());
// Consume the content
response.getEntity().consumeContent();
} finally {
httpClient.getConnectionManager().shutdown();
}
TestSiteUtils.testETagHeader(request, eTagValue, logger, null);
TestSiteUtils.testModifiedHeader(request, modificationDate, logger, null);
}
/**
* Tests for the special <code>/weblounge-files</code> uri prefix that is
* provided by the file request handler. The handler should be able to respond
* to these requests:
* <ul>
* <li>/weblounge-files/<id></li>
* <li>/weblounge-files/<id>/</li>
* <li>/weblounge-files/<id>/<filename></li>
* </ul>
*
* @param serverUrl
* the base url
* @throws Exception
* if an exception occurs
*/
private void testGetDocumentByIdAndName(String serverUrl) throws Exception {
HttpClient httpClient = null;
String url = UrlUtils.concat(serverUrl, "weblounge-files", resourceId, filenameGerman);
HttpGet request = new HttpGet(url);
request.setHeader("Accept-Language", "de");
httpClient = new DefaultHttpClient();
try {
logger.info("Requesting German document version from {}", request.getURI());
HttpResponse response = TestUtils.request(httpClient, request, null);
assertEquals(HttpServletResponse.SC_OK, response.getStatusLine().getStatusCode());
assertTrue("No content received", response.getEntity().getContentLength() > 0);
// Test general headers
assertEquals(1, response.getHeaders("Content-Type").length);
assertEquals(mimetypeGerman, response.getHeaders("Content-Type")[0].getValue());
assertEquals(sizeGerman, response.getEntity().getContentLength());
assertEquals(1, response.getHeaders("Content-Disposition").length);
assertEquals("inline; filename=" + filenameGerman, response.getHeaders("Content-Disposition")[0].getValue());
// Consume the content
response.getEntity().consumeContent();
} finally {
httpClient.getConnectionManager().shutdown();
}
}
/**
* Tests requests that send the required language as part of the request url.
*
* @param serverUrl
* the base url
* @throws Exception
* if an exception occurs
*/
private void testGetDocumentByPathLanguage(String serverUrl) throws Exception {
HttpClient httpClient = null;
// English
String englishUrl = UrlUtils.concat(serverUrl, path, "en");
HttpGet request = new HttpGet(englishUrl);
httpClient = new DefaultHttpClient();
String eTagValue = null;
Date modificationDate = null;
try {
logger.info("Requesting English document from {}", request.getURI());
HttpResponse response = TestUtils.request(httpClient, request, null);
assertEquals(HttpServletResponse.SC_OK, response.getStatusLine().getStatusCode());
assertTrue("No content received", response.getEntity().getContentLength() > 0);
// Test general headers
assertEquals(1, response.getHeaders("Content-Type").length);
assertEquals(mimetypeEnglish, response.getHeaders("Content-Type")[0].getValue());
assertEquals(sizeEnglish, response.getEntity().getContentLength());
assertEquals(1, response.getHeaders("Content-Disposition").length);
assertEquals("inline; filename=" + filenameEnglish, response.getHeaders("Content-Disposition")[0].getValue());
// Test ETag header
Header eTagHeader = response.getFirstHeader("ETag");
assertNotNull(eTagHeader);
assertNotNull(eTagHeader.getValue());
eTagValue = eTagHeader.getValue();
// Test Last-Modified header
Header modifiedHeader = response.getFirstHeader("Last-Modified");
assertNotNull(modifiedHeader);
modificationDate = lastModifiedDateFormat.parse(modifiedHeader.getValue());
// Consume the content
response.getEntity().consumeContent();
} finally {
httpClient.getConnectionManager().shutdown();
}
TestSiteUtils.testETagHeader(request, eTagValue, logger, null);
TestSiteUtils.testModifiedHeader(request, modificationDate, logger, null);
// German
String germanUrl = UrlUtils.concat(serverUrl, path, "de");
request = new HttpGet(germanUrl);
httpClient = new DefaultHttpClient();
try {
logger.info("Requesting German document from {}", request.getURI());
HttpResponse response = TestUtils.request(httpClient, request, null);
assertEquals(HttpServletResponse.SC_OK, response.getStatusLine().getStatusCode());
assertTrue("No content received", response.getEntity().getContentLength() > 0);
// Test general headers
assertEquals(1, response.getHeaders("Content-Type").length);
assertEquals(mimetypeGerman, response.getHeaders("Content-Type")[0].getValue());
assertEquals(sizeGerman, response.getEntity().getContentLength());
assertEquals(1, response.getHeaders("Content-Disposition").length);
assertEquals("inline; filename=" + filenameGerman, response.getHeaders("Content-Disposition")[0].getValue());
// Test ETag header
Header eTagHeader = response.getFirstHeader("ETag");
assertNotNull(eTagHeader);
assertNotNull(eTagHeader.getValue());
eTagValue = eTagHeader.getValue();
// Test Last-Modified header
Header modifiedHeader = response.getFirstHeader("Last-Modified");
assertNotNull(modifiedHeader);
modificationDate = lastModifiedDateFormat.parse(modifiedHeader.getValue());
// Consume the content
response.getEntity().consumeContent();
} finally {
httpClient.getConnectionManager().shutdown();
}
TestSiteUtils.testETagHeader(request, eTagValue, logger, null);
TestSiteUtils.testModifiedHeader(request, modificationDate, logger, null);
}
/**
* Tests requests that send the required language as part of the
* <code>Accept-Language</code> header.
*
* @param serverUrl
* the base url
* @throws Exception
* if an exception occurs
*/
private void testGetDocumentByHeaderLanguage(String serverUrl)
throws Exception {
HttpClient httpClient = null;
// German
String englishUrl = UrlUtils.concat(serverUrl, path);
HttpGet request = new HttpGet(englishUrl);
request.setHeader("Accept-Language", "en");
httpClient = new DefaultHttpClient();
String eTagValue = null;
Date modificationDate = null;
try {
logger.info("Requesting English document from {}", request.getURI());
HttpResponse response = TestUtils.request(httpClient, request, null);
assertEquals(HttpServletResponse.SC_OK, response.getStatusLine().getStatusCode());
assertTrue("No content received", response.getEntity().getContentLength() > 0);
// Test general headers
assertEquals(1, response.getHeaders("Content-Type").length);
assertEquals(mimetypeEnglish, response.getHeaders("Content-Type")[0].getValue());
assertEquals(sizeEnglish, response.getEntity().getContentLength());
assertEquals(1, response.getHeaders("Content-Disposition").length);
assertEquals("inline; filename=" + filenameEnglish, response.getHeaders("Content-Disposition")[0].getValue());
// Test ETag header
Header eTagHeader = response.getFirstHeader("ETag");
assertNotNull(eTagHeader);
assertNotNull(eTagHeader.getValue());
eTagValue = eTagHeader.getValue();
// Test Last-Modified header
Header modifiedHeader = response.getFirstHeader("Last-Modified");
assertNotNull(modifiedHeader);
modificationDate = lastModifiedDateFormat.parse(modifiedHeader.getValue());
// Consume the content
response.getEntity().consumeContent();
} finally {
httpClient.getConnectionManager().shutdown();
}
TestSiteUtils.testETagHeader(request, eTagValue, logger, null);
TestSiteUtils.testModifiedHeader(request, modificationDate, logger, null);
// German
String germanUrl = UrlUtils.concat(serverUrl, path);
request = new HttpGet(germanUrl);
request.setHeader("Accept-Language", "de");
httpClient = new DefaultHttpClient();
try {
logger.info("Requesting German document from {}", request.getURI());
HttpResponse response = TestUtils.request(httpClient, request, null);
assertEquals(HttpServletResponse.SC_OK, response.getStatusLine().getStatusCode());
assertTrue("No content received", response.getEntity().getContentLength() > 0);
// Test general headers
assertEquals(1, response.getHeaders("Content-Type").length);
assertEquals(mimetypeGerman, response.getHeaders("Content-Type")[0].getValue());
assertEquals(sizeGerman, response.getEntity().getContentLength());
assertEquals(1, response.getHeaders("Content-Disposition").length);
assertEquals("inline; filename=" + filenameGerman, response.getHeaders("Content-Disposition")[0].getValue());
// Test ETag header
Header eTagHeader = response.getFirstHeader("ETag");
assertNotNull(eTagHeader);
assertNotNull(eTagHeader.getValue());
eTagValue = eTagHeader.getValue();
// Test Last-Modified header
Header modifiedHeader = response.getFirstHeader("Last-Modified");
assertNotNull(modifiedHeader);
modificationDate = lastModifiedDateFormat.parse(modifiedHeader.getValue());
// Consume the content
response.getEntity().consumeContent();
} finally {
httpClient.getConnectionManager().shutdown();
}
TestSiteUtils.testETagHeader(request, eTagValue, logger, null);
TestSiteUtils.testModifiedHeader(request, modificationDate, logger, null);
}
}