org.archive.wayback.resourceindex.cdxserver

Class EmbeddedCDXServerIndexTest

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.archive.wayback.resourceindex.cdxserver.EmbeddedCDXServerIndexTest

All Implemented Interfaces:

junit.framework.Test

public class EmbeddedCDXServerIndexTest
extends junit.framework.TestCase

Test EmbeddedCDXServerIndex.

Author:

Kenji Nagahashi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbeddedCDXServerIndexTest.ExcludeAllFilterFactory
static class	EmbeddedCDXServerIndexTest.StubZipNumCluster
static class	EmbeddedCDXServerIndexTest.TestCDXServer fixture CDXServer (unnecessary if CDServer was an interface).

Constructor Summary

Constructors

Constructor and Description
EmbeddedCDXServerIndexTest()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	setCdxLines(String... lines) Set CDX lines TestCDXServer stub returns.
protected void	setUp()
void	testBuildStatusFilter() quick test of EmbeddedCDXServerIndex.buildStatusFilter(String)
void	testCollapseTime() test of timestamp-collapsing.
void	testHandleRequest() EmbeddedCDXServerIndex.handleRequest(HttpServletRequest, HttpServletResponse) is a entry point for CDXServer API.
void	testIgnoreRobotPaths() for those SURT prefixes in ignoreRobotsPaths, AuthToken.isIgnoreRobots() flag is set.
void	testIgnoreRobotsForEmbeds() robots.txt exclusion shall be disable for embeds.
void	testQuery() capture search. basic options.
void	testQueryWithCustomStatusFilter() test of EmbeddedCDXServerIndex.setBaseStatusRegexp(String)
void	testRenderMementoTimemap() EmbeddedCDXServerIndex.renderMementoTimemap(WaybackRequest, HttpServletRequest, HttpServletResponse) is a CDXServer API entry point for Memento format output.
void	testRevisitResolution() EmbeddedCDXServerIndex resolves revisits for replay requests.
void	testRevisitResolutionReverse() CDXToCaptureSearchResultsWriter resolves revisits for replay requests (reverse order input mode) (Test of CDXToCaptureSearchResultsWriter.)
void	testSoftBlock_fieldModificationRecognized() Supplementary test for soft-block feature.
void	testSoftBlock_revisitPayloadLookup() Test of soft-block feature (URL-agnostic revisit payload lookup).
void	testSoftBlock() Test of soft-block feature (regular replay).

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

Constructor Detail

EmbeddedCDXServerIndexTest

public EmbeddedCDXServerIndexTest()

Method Detail

setUp

protected void setUp()
              throws Exception

Overrides:

setUp in class junit.framework.TestCase

Throws:

Exception

setCdxLines

protected void setCdxLines(String... lines)

Set CDX lines TestCDXServer stub returns. Lines are parsed with CDXFieldConstants.CDX_ALL_NAMES. Note EmbeddedCDXServerIndex.query(org.archive.wayback.core.WaybackRequest) will throw ResourceNotInArchiveException if lines is empty.

Parameters:

lines - text CDX lines

testQuery

public void testQuery()
               throws Exception

capture search. basic options.

Throws:

Exception

testRevisitResolution

public void testRevisitResolution()
                           throws Exception

EmbeddedCDXServerIndex resolves revisits for replay requests. (This is actually a test of CDXToCaptureSearchResultsWriter.)

Throws:

Exception

testRevisitResolutionReverse

public void testRevisitResolutionReverse()
                                  throws Exception

CDXToCaptureSearchResultsWriter resolves revisits for replay requests (reverse order input mode) (Test of CDXToCaptureSearchResultsWriter.)

Since there's no way to put CDXToCaptureSearchResultsWriter's in reverse mode, this test calls CDXToCaptureSearchResultWriter directly.

In other words, its reverse mode is never used in practice.

Throws:

Exception

testSoftBlock

public void testSoftBlock()
                   throws Exception

Test of soft-block feature (regular replay). capture with "X" in robotflags field does not make its way into CaptureSearchResults, but still available as payload capture for revisits.

Throws:

Exception

testSoftBlock_fieldModificationRecognized

public void testSoftBlock_fieldModificationRecognized()
                                               throws Exception

Supplementary test for soft-block feature. Modification to robotflags made by exclusionFilter must be properly recognized. As baseline EmbeddedCDXServerIndex does not have setting up exclusionFilter, this test deals with CDXToCaptureSearchResultsWriter directly.

Throws:

Exception

testSoftBlock_revisitPayloadLookup

public void testSoftBlock_revisitPayloadLookup()
                                        throws Exception

Test of soft-block feature (URL-agnostic revisit payload lookup). In revisit payload lookup mode, capture with "X" is returned.

Throws:

Exception

testBuildStatusFilter

public void testBuildStatusFilter()

quick test of EmbeddedCDXServerIndex.buildStatusFilter(String)

testQueryWithCustomStatusFilter

public void testQueryWithCustomStatusFilter()
                                     throws Exception

test of EmbeddedCDXServerIndex.setBaseStatusRegexp(String)

Throws:

Exception

testIgnoreRobotPaths

public void testIgnoreRobotPaths()
                          throws Exception

for those SURT prefixes in ignoreRobotsPaths, AuthToken.isIgnoreRobots() flag is set.

Throws:

Exception

testCollapseTime

public void testCollapseTime()
                      throws Exception

test of timestamp-collapsing.

Actual processing happens in CDXServer. EmbeddedCDXServerIndex simply passes WaybackRequest.getCollapseTime() to CDXQuery.setCollapse(String[]). if collapseTime is unspecified in WaybackRequest (-1), default value timestampDedupLength will be used.

Throws:

Exception

testHandleRequest

public void testHandleRequest()
                       throws Exception

EmbeddedCDXServerIndex.handleRequest(HttpServletRequest, HttpServletResponse) is a entry point for CDXServer API. It should return all accessible cdx lines, without applying any additional filters not requested by API user.

Throws:

Exception

testRenderMementoTimemap

public void testRenderMementoTimemap()
                              throws Exception

EmbeddedCDXServerIndex.renderMementoTimemap(WaybackRequest, HttpServletRequest, HttpServletResponse) is a CDXServer API entry point for Memento format output.

Throws:

Exception

testIgnoreRobotsForEmbeds

public void testIgnoreRobotsForEmbeds()
                               throws Exception

robots.txt exclusion shall be disable for embeds.

TODO: This is actually testing classes in wayback-cdx-server module. Implemented here because it takes more work to do this in wayback-cdx-server module, and it makes little sense to do it before planned refactoring.

Ref: WWM-119. A bug in PrivTokenAuthChecker.

Throws:

Exception