DataSourceContractTest

@UnstableApi
public abstract class DataSourceContractTest

A collection of contract tests for DataSource implementations.

Subclasses should only include the logic necessary to construct the DataSource (overriding either createDataSource or createDataSources) and allow it to successfully read data (overriding getTestResources. They shouldn't include any new @Test methods - implementation-specific tests should be in a separate class.

Most implementations should pass all these tests. If necessary, subclasses can disable tests by overriding the @Test method with a no-op implementation. It's recommended (but not required) to also annotate this @Ignore so that JUnit correctly reports the test as skipped/ignored instead of passing.

Summary

Nested types

A TransferListener that only keeps track of the transferred bytes.

Information about a resource that can be used to test the DataSource instance.

Builder for TestResource instances.

Public fields
final AdditionalFailureInfo

Public constructors

Public methods
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void

FLAG_ALLOW_GZIP should either be ignored by DataSource implementations, or correctly handled (i.e. the data is decompressed before being returned from read).
void
void
void

Protected methods
DataSource

Creates and returns an instance of the DataSource.
List<DataSource>

Creates and returns a list of instances of the DataSource.
List<DataSourceContractTest.TestResource>

Returns a non-empty list of TestResource that don't resolve.
Uri

Returns a Uri that doesn't resolve.
abstract ImmutableList<DataSourceContractTest.TestResource>

Returns TestResource instances.
@Nullable DataSource

Returns the DataSource that will be included in the TransferListener callbacks for the DataSource most recently created by createDataSource.
boolean

Returns whether the DataSource will continue reading indefinitely for unbounded DataSpecs.

Public fields

additionalFailureInfo

@Rule
public final AdditionalFailureInfo additionalFailureInfo

Public constructors

DataSourceContractTest

public DataSourceContractTest()

Public methods

dataSpecWithEndPositionOutOfRange_readsToEnd

@Test
public void dataSpecWithEndPositionOutOfRange_readsToEnd()
Throws
java.lang.Exception

dataSpecWithLength_readExpectedRange

@Test
public void dataSpecWithLength_readExpectedRange()
Throws
java.lang.Exception

dataSpecWithLength_readUntilEndInTwoParts

@Test
public void dataSpecWithLength_readUntilEndInTwoParts()
Throws
java.lang.Exception

dataSpecWithPositionAndLength_readExpectedRange

@Test
public void dataSpecWithPositionAndLength_readExpectedRange()
Throws
java.lang.Exception

dataSpecWithPositionAtEndAndLength_readsZeroBytes

@Test
public void dataSpecWithPositionAtEndAndLength_readsZeroBytes()
Throws
java.lang.Exception

dataSpecWithPositionAtEnd_readsZeroBytes

@Test
public void dataSpecWithPositionAtEnd_readsZeroBytes()
Throws
java.lang.Exception

dataSpecWithPositionOutOfRange_throwsPositionOutOfRangeException

@Test
public void dataSpecWithPositionOutOfRange_throwsPositionOutOfRangeException()
Throws
java.lang.Exception

dataSpecWithPosition_readUntilEnd

@Test
public void dataSpecWithPosition_readUntilEnd()
Throws
java.lang.Exception

getResponseHeaders_caseInsensitive

@Test
public void getResponseHeaders_caseInsensitive()
Throws
java.lang.Exception

getResponseHeaders_isEmptyWhileNotOpen

@Test
public void getResponseHeaders_isEmptyWhileNotOpen()
Throws
java.lang.Exception

getResponseHeaders_noNullKeysOrValues

@Test
public void getResponseHeaders_noNullKeysOrValues()
Throws
java.lang.Exception

getResponseHeaders_resourceNotFound_isEmptyWhileNotOpen

@Test
public void getResponseHeaders_resourceNotFound_isEmptyWhileNotOpen()
Throws
java.lang.Exception

getResponseHeaders_returnsExpectedValues

@Test
public void getResponseHeaders_returnsExpectedValues()
Throws
java.lang.Exception

getUri_resourceNotFound_returnsNullIfNotOpened

@Test
public void getUri_resourceNotFound_returnsNullIfNotOpened()
Throws
java.lang.Exception

getUri_returnsExpectedValueOnlyWhileOpen

@Test
public void getUri_returnsExpectedValueOnlyWhileOpen()
Throws
java.lang.Exception

resourceNotFound

@Test
public void resourceNotFound()
Throws
java.lang.Exception

resourceNotFound_transferListenerCallbacks

@Test
public void resourceNotFound_transferListenerCallbacks()
Throws
java.lang.Exception

transferListenerCallbacks

@Test
public void transferListenerCallbacks()
Throws
java.lang.Exception

unboundedDataSpecWithGzipFlag_readUntilEnd

@Test
public void unboundedDataSpecWithGzipFlag_readUntilEnd()

FLAG_ALLOW_GZIP should either be ignored by DataSource implementations, or correctly handled (i.e. the data is decompressed before being returned from read).

Throws
java.lang.Exception

unboundedDataSpec_readExpectedBytesWithOffset

@Test
public void unboundedDataSpec_readExpectedBytesWithOffset()
Throws
java.lang.Exception

unboundedDataSpec_readUntilEnd

@Test
public void unboundedDataSpec_readUntilEnd()
Throws
java.lang.Exception

uriSchemeIsCaseInsensitive

@Test
public void uriSchemeIsCaseInsensitive()
Throws
java.lang.Exception

Protected methods

createDataSource

@ForOverride
protected DataSource createDataSource()

Creates and returns an instance of the DataSource.

Only one of createDataSource and createDataSources should be implemented.

Throws
java.lang.Exception

createDataSources

@ForOverride
protected List<DataSource> createDataSources()

Creates and returns a list of instances of the DataSource.

Only one of createDataSource and createDataSources should be implemented.

Throws
java.lang.Exception

getNotFoundResources

@ForOverride
protected List<DataSourceContractTest.TestResource> getNotFoundResources()

Returns a non-empty list of TestResource that don't resolve.

This is used to test how a DataSource handles nonexistent data. Multiple entries and the rest of the TestResource fields can be helpful for situations where the data can be "not found" for different reasons. For example in HTTP, 'server not found' generally results in a failed HTTP connection while 'file not found' generally results in a successful connection with a 404 HTTP error code and some response headers, and the handling code for these two cases may be different (and therefore worth testing separately).

Only one of getNotFoundUri and getNotFoundResources should be implemented.

getNotFoundUri

@ForOverride
protected Uri getNotFoundUri()

Returns a Uri that doesn't resolve.

This is used to test how a DataSource handles nonexistent data.

Only one of getNotFoundUri and getNotFoundResources should be implemented.

getTestResources

@ForOverride
protected abstract ImmutableList<DataSourceContractTest.TestResource> getTestResources()

Returns TestResource instances.

Each resource will be used to exercise the DataSource instance, allowing different behaviours to be tested. Every getExpectedBytes must be at least 5 bytes.

If multiple resources are returned, it's recommended to disambiguate them using setName.

Throws
java.lang.Exception

getTransferListenerDataSource

@ForOverride
protected @Nullable DataSource getTransferListenerDataSource()

Returns the DataSource that will be included in the TransferListener callbacks for the DataSource most recently created by createDataSource. If it's the same DataSource then null can be returned.

unboundedReadsAreIndefinite

@ForOverride
protected boolean unboundedReadsAreIndefinite()

Returns whether the DataSource will continue reading indefinitely for unbounded DataSpecs.