org.archive.wayback.webapp

Class AccessPointTest

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.archive.wayback.webapp.AccessPointTest

All Implemented Interfaces:

junit.framework.Test

public class AccessPointTest
extends junit.framework.TestCase

unit test for AccessPoint. TODO: this unit test is too complex. it is because AccessPoint class has too much responsibility and many execution paths. some good refactoring of AccessPoint class would help.

Author:

Kenji Nagahashi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AccessPointTest.CaptureSearchMatcher
static class	AccessPointTest.CaptureSearchResultMatcher test CaptureSearchResult equality by file and offset.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STATIC_PREFIX
static String	WEB_PREFIX

Constructor Summary

Constructors

Constructor and Description
AccessPointTest()

Method Summary

Methods

Modifier and Type	Method and Description
static Resource	createSelfRedirectResource(String url, String timestamp)
static Resource	createTest502Resource()
static Resource	createTestHtmlResource(String timestamp, byte[] payloadBytes)
static Resource	createTestHtmlResource(String uri, String timestamp, byte[] payloadBytes)
static Resource	createTestHtmlResource(String uri, String timestamp, byte[] payloadBytes, boolean compressed)
static Resource	createTestRevisitResource(String timestamp, int len, boolean withHeader) Create a test revisit record referring unknown capture of content-length len.
static Resource	createTestRevisitResource(String timestamp, Resource revisited, boolean withHeader) Create a test revisit record referring Resource revisited.
static WaybackRequest	eqCaptureSearchRequest(String url, String replayTimestamp)
static CaptureSearchResult	eqCaptureSearchResult(CaptureSearchResult expected)
protected void	expectRedirect(String expectedRedirectURI) Setup expectation that handleReplay redirects to expectedRedirectURI.
protected void	expectRendering(CaptureSearchResult capture, Resource headersResource, Resource payloadResource, CaptureSearchResults results) Setup expectation that capture is rendered.
protected void	expectUrlIndexQuery() setup expected call to ResourceIndex.query(WaybackRequest), returning empty UrlSearchResults.
void	setCaptureQueryRequest(String requestUrl, String replayTimestamp) create new WaybackRequest set up as capture query request for URL requestUrl, at time .
void	setReplayRequest(String requestUrl, String replayTimestamp) create new WaybackRequest set up as replay request for requestUrl at replayTimestamp. created object is set to #wbRequest.
protected void	setUp()
protected CaptureSearchResults	setupCaptures(int closestIndex, Resource... resources) setup mocks with resources.
static CaptureSearchResults	setupCaptures(ResourceIndex resourceIndex, ResourceStore resourceStore, int closestIndex, Resource... resources) given a sequence of WarcResources, build CaptureSearchResults, filled with CaptureSearchResult instances, which have auto-generated unique filename and offset of 0.
protected void	setupRequestStub(String contextPath, String uri, String contextPathPrefix) setup HttpServletRequest stubs
void	setUrlQueryRequest(String requestUrl, String replayTimestamp) create new WaybackRequest set up as URL query request for URL requestUrl at time replayTimestamp. created object is set to wbRequest.
void	testBounceToReplayPrefix() if bounceToReplayPrefix is true, replay request is redirected to other access point.
void	testDispatchLocal() static AccessPoint - configured with accessPointPath=${wayback.staticPrefix} serveStatic=true bounceToReplayPrefix=true bounceToQueryPrefix=true when RequestParser.parse(HttpServletRequest, AccessPoint) returns null, request is forwarded to dispatchLocal() for rendering static resources.
void	testHandleReplay_noMultipleErrors() Test of internal behavior.
void	testHandleRequest_CaptureSearchResults()
void	testHandleRequest_MissingRevisitPayload() handleReplay() is supposed to throw ResourceNotAvailableException when it cannot find a replay-able capture for a request.
void	testHandleRequest_queryCollapseTimeSpecified()
void	testHandleRequest_queryCollapseTimeUnspecified()
void	testHandleRequest_Replay_1() test basic behavior 1.
void	testHandleRequest_Replay_2() basic replay test part 2. there's a capture whose capture date matches the request.
void	testHandleRequest_Replay_Embedded() if closest is not HTTP-success AND replaying embedded context (CSS, JavaScript, images, etc.), use next closest with successful response, or for lower priority, a redirect, instead. unless such capture is of the same timestamp as the replay request, redirect to the capture found.
void	testHandleRequest_Replay_OldARCRevisit() old-style ARC revisit (no mimetype, filename is '-')
void	testHandleRequest_Replay_OldWARCRevisit() old-style WARC revisit (no HTTP status line and header, Content-Length in WARC header is zero). it shall replay HTTP status line, headers and content from previous matching capture.
void	testHandleRequest_Replay_Revisit() test of revisit. closest capture is a revisit.
void	testHandleRequest_UrlSearchResults()
void	testHandlerRequest_queryCollapseTimeForReplayQuery()
void	testMemento_dispatchLocal() test for local static resource when enableMemento=true. expectations: do-not-negotiate Link header is set.
void	testMemento_replay_exactCapture() test of Memento-furnished response to URL-M (Memento).
void	testMemento_replay_nearbyCapture() Test of Memento-furnished response to replay request for non-archived timestamp.
void	testMementoTimegate() Test of Memento-furnished response to Timegate (URI-G).
void	testMementoTimemap() test of Memento Timemap request.
protected static boolean	validTimestamp(String ts) checks if ts has expected format (YYYYmmddHHMMSS)

Methods inherited from class junit.framework.TestCase

countTestCases, createResult, getName, run, run, runBare, runTest, setName, tearDown, toString

Methods inherited from class junit.framework.Assert

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WEB_PREFIX

public static final String WEB_PREFIX

See Also:

Constant Field Values

STATIC_PREFIX

public static final String STATIC_PREFIX

See Also:

Constant Field Values

Constructor Detail

AccessPointTest

public AccessPointTest()

Method Detail

setupRequestStub

protected void setupRequestStub(String contextPath,
                    String uri,
                    String contextPathPrefix)

setup HttpServletRequest stubs

Parameters:

contextPath - servlet context path. typically "/"

uri - servlet URI. typically "/"

contextPathPrefix -

setUp

protected void setUp()
              throws Exception

Overrides:

setUp in class junit.framework.TestCase

Throws:

Exception

createTestHtmlResource

public static Resource createTestHtmlResource(String uri,
                              String timestamp,
                              byte[] payloadBytes)
                                       throws IOException

Throws:

IOException

createTestHtmlResource

public static Resource createTestHtmlResource(String uri,
                              String timestamp,
                              byte[] payloadBytes,
                              boolean compressed)
                                       throws IOException

Throws:

IOException

createTestHtmlResource

public static Resource createTestHtmlResource(String timestamp,
                              byte[] payloadBytes)
                                       throws IOException

Throws:

IOException

createTestRevisitResource

public static Resource createTestRevisitResource(String timestamp,
                                 int len,
                                 boolean withHeader)
                                          throws IOException

Create a test revisit record referring unknown capture of content-length len. This is meant for pathological case. Use createTestRevisitResource(String, int, boolean) for regular case.

Parameters:

timestamp - 14-digit timestamp of capture

len - original content-length

withHeader - false for omitting HTTP header (simulates old revisit record).

Returns:

new Resource object.

Throws:

IOException - for unexpected I/O failure while buiding payload

createTestRevisitResource

public static Resource createTestRevisitResource(String timestamp,
                                 Resource revisited,
                                 boolean withHeader)
                                          throws IOException

Create a test revisit record referring Resource revisited.

Parameters:

timestamp - CDX-style 14digit timestamp

revisited - Capture being revisited (must be a WarcResource or ClassCastException will be the result)

withHeader - true unless you want to emulate old implementation where revisit record had no HTTP headers.

Returns:

new Resource object

Throws:

IOException - for unexpected I/O error building payload

validTimestamp

protected static boolean validTimestamp(String ts)

checks if ts has expected format (YYYYmmddHHMMSS)

Parameters:

ts - timestamp string to check

Returns:

true if ok, false otherwise

setupCaptures

protected CaptureSearchResults setupCaptures(int closestIndex,
                                 Resource... resources)
                                      throws Exception

setup mocks with resources.

• Call setupCaptures(ResourceIndex, ResourceStore, int, Resource...)
• Set up replay so as to return closest from getClosest.
• Set up resourceIndex so as to return results from query(wbRequest)

Note: wbRequest must be set up before calling this method, or ResourceIndex will not return expected search result set.

Parameters:

closestIndex - zero-based index into resources

resources - resources

Returns:

CaptureSearchResults populated with CaptureSearchResult objects.

Throws:

Exception

setupCaptures

public static CaptureSearchResults setupCaptures(ResourceIndex resourceIndex,
                                 ResourceStore resourceStore,
                                 int closestIndex,
                                 Resource... resources)
                                          throws Exception

given a sequence of WarcResources,

• build CaptureSearchResults, filled with CaptureSearchResult instances, which have auto-generated unique filename and offset of 0. this is necessary for equality (see AccessPointTest.CaptureSearchResultMatcher).
• setup ResourceStore mock to return Resource for each CaptureSearchResult.
• if closestIndex >= 0, set corresponding CaptureSearchResult's closest flag.

It's left as caller's responsibility to setup ResourceIndex.query(WaybackRequest) mock to return CaptureSearchResults returned by this method.

Parameters:

resourceIndex - ResourceIndex mock

resourceStore - ResourceStore mock, can be null

closestIndex - 0-based index of resource to be marked as closest

resources - sequence of WarcResources

Returns:

CaptureSearchResults populated with CaptureSearchResult objects.

Throws:

Exception

setReplayRequest

public void setReplayRequest(String requestUrl,
                    String replayTimestamp)

create new WaybackRequest set up as replay request for requestUrl at replayTimestamp. created object is set to #wbRequest.

Parameters:

wbRequest -

requestUrl -

replayTimestamp -

expectRendering

protected void expectRendering(CaptureSearchResult capture,
                   Resource headersResource,
                   Resource payloadResource,
                   CaptureSearchResults results)
                        throws javax.servlet.ServletException,
                               IOException,
                               WaybackException

Setup expectation that capture is rendered.

Parameters:

capture - CaptureSearchResult to be rendered

headersResource - Resource from which HTTP headers are read (revisit)

payloadResource - Resource from which HTTP payload is read (revisited)

results - capture search results from which capture is picked

Throws:

WaybackException

IOException

javax.servlet.ServletException

expectRedirect

protected void expectRedirect(String expectedRedirectURI)

Setup expectation that handleReplay redirects to expectedRedirectURI.

Parameters:

expectedRedirectURI -

expectUrlIndexQuery

protected void expectUrlIndexQuery()
                            throws Exception

setup expected call to ResourceIndex.query(WaybackRequest), returning empty UrlSearchResults.

This is sufficient for most cases, as AccessPoint is not concerned with UrlSearchResult, but simply passes it to query renderer.

Note: set up wbRequest before calling this method.

Throws:

Exception - declared, but will never be thrown

testHandleRequest_Replay_1

public void testHandleRequest_Replay_1()
                                throws Exception

test basic behavior 1.

• no authorization
• no exclusion factory

and,

• there's no capture on date matching the request.
• closest capture is not a revisit
this shall result in redirect (302) response to the URL with closest capture date in date component. alternative path: testBounceToReplayPrefix()

Throws:

Exception

testHandleRequest_Replay_2

public void testHandleRequest_Replay_2()
                                throws Exception

basic replay test part 2. there's a capture whose capture date matches the request.

Throws:

Exception

eqCaptureSearchResult

public static CaptureSearchResult eqCaptureSearchResult(CaptureSearchResult expected)

eqCaptureSearchRequest

public static WaybackRequest eqCaptureSearchRequest(String url,
                                    String replayTimestamp)

testHandleRequest_Replay_Revisit

public void testHandleRequest_Replay_Revisit()
                                      throws Exception

test of revisit. closest capture is a revisit.

Throws:

Exception

testHandleReplay_noMultipleErrors

public void testHandleReplay_noMultipleErrors()
                                       throws Exception

Test of internal behavior. If loading recording from an archive failed, AccessPoint shall not attempt to load the same archive again within the request for performance reasons.

Throws:

Exception

createSelfRedirectResource

public static Resource createSelfRedirectResource(String url,
                                  String timestamp)
                                           throws IOException

Throws:

IOException

testHandleRequest_MissingRevisitPayload

public void testHandleRequest_MissingRevisitPayload()
                                             throws Exception

handleReplay() is supposed to throw ResourceNotAvailableException when it cannot find a replay-able capture for a request. This is a test for one of such "capture not found" case: revisited record cannot found in the capture search results, and only other non-revisit resource available is a self-redirect. This is rather a corner case. handlReplay() shall throw ResourceNotAvailableException.

Throws:

Exception

testHandleRequest_Replay_OldWARCRevisit

public void testHandleRequest_Replay_OldWARCRevisit()
                                             throws Exception

old-style WARC revisit (no HTTP status line and header, Content-Length in WARC header is zero). it shall replay HTTP status line, headers and content from previous matching capture.

Throws:

Exception

testHandleRequest_Replay_OldARCRevisit

public void testHandleRequest_Replay_OldARCRevisit()
                                            throws Exception

old-style ARC revisit (no mimetype, filename is '-')

Throws:

Exception

createTest502Resource

public static final Resource createTest502Resource()
                                            throws IOException

Throws:

IOException

testHandleRequest_Replay_Embedded

public void testHandleRequest_Replay_Embedded()
                                       throws Exception

if closest is not HTTP-success AND replaying embedded context (CSS, JavaScript, images, etc.), use next closest with successful response, or for lower priority, a redirect, instead. unless such capture is of the same timestamp as the replay request, redirect to the capture found.

Throws:

Exception

setCaptureQueryRequest

public final void setCaptureQueryRequest(String requestUrl,
                          String replayTimestamp)

create new WaybackRequest set up as capture query request for URL requestUrl, at time .

Parameters:

requestUrl -

replayTimestamp -

testHandleRequest_CaptureSearchResults

public void testHandleRequest_CaptureSearchResults()
                                            throws Exception

Throws:

Exception

setUrlQueryRequest

public void setUrlQueryRequest(String requestUrl,
                      String replayTimestamp)

create new WaybackRequest set up as URL query request for URL requestUrl at time replayTimestamp. created object is set to wbRequest.

Parameters:

requestUrl -

replayTimestamp -

testHandleRequest_UrlSearchResults

public void testHandleRequest_UrlSearchResults()
                                        throws Exception

Throws:

Exception

testHandleRequest_queryCollapseTimeUnspecified

public void testHandleRequest_queryCollapseTimeUnspecified()
                                                    throws Exception

Throws:

Exception

testHandleRequest_queryCollapseTimeSpecified

public void testHandleRequest_queryCollapseTimeSpecified()
                                                  throws Exception

Throws:

Exception

testHandlerRequest_queryCollapseTimeForReplayQuery

public void testHandlerRequest_queryCollapseTimeForReplayQuery()
                                                        throws Exception

Throws:

Exception

testBounceToReplayPrefix

public void testBounceToReplayPrefix()
                              throws Exception

if bounceToReplayPrefix is true, replay request is redirected to other access point.

Throws:

Exception

testDispatchLocal

public void testDispatchLocal()
                       throws Exception

static AccessPoint - configured with

• accessPointPath=${wayback.staticPrefix}
• serveStatic=true
• bounceToReplayPrefix=true
• bounceToQueryPrefix=true

when RequestParser.parse(HttpServletRequest, AccessPoint) returns null, request is forwarded to dispatchLocal() for rendering static resources.

Throws:

Exception

testMemento_replay_exactCapture

public void testMemento_replay_exactCapture()
                                     throws Exception

test of Memento-furnished response to URL-M (Memento). Memento Specification states that URL-M response

• MUST NOT have "Vary: accept-datetime"
• MUST have "Memento-Datetime"
• MUST have "Link" header with at least a URI-R as "original" relation.

Throws:

Exception

testMemento_replay_nearbyCapture

public void testMemento_replay_nearbyCapture()
                                      throws Exception

Test of Memento-furnished response to replay request for non-archived timestamp. This is not strictly a URL-M (as far as I understand). Wayback returns intermediate resource to URI-M. Memento Specification states the response

• MUST NOT have "Vary: accept-datetime" header (this is the key difference from redirect from URI-G; see below)
• MUST NOT have "Memento-Datetime" header
• MUST have "Link" header, which MUST have at least "original" relation link. "timegate", "timemap" and "memento" relation type links MAY be provided.

Throws:

Exception

testMementoTimegate

public void testMementoTimegate()
                         throws Exception

Test of Memento-furnished response to Timegate (URI-G). Memento Specification states the response

• MUST have "Vary: accept-datetime" header
• MUST NOT have "Memento-Datetime" header
• MUST have "Link" header, which MUST have at least "original" relation link. "timegate", "timemap" and "memento" relation type links MAY be provided.

Throws:

Exception

testMementoTimemap

public void testMementoTimemap()
                        throws Exception

test of Memento Timemap request.

Actual rendering is done by a separate bean implementing MementoHandler. So what we test here is that AccessPoint is correctly routing Timemap request to MementoHandler.

Throws:

Exception

testMemento_dispatchLocal

public void testMemento_dispatchLocal()
                               throws Exception

test for local static resource when enableMemento=true. expectations:

• do-not-negotiate Link header is set.

Throws:

Exception