DataSourceContractTest

Artifact: androidx.media3:media3-test-utils

Kotlin |Java

@RequiresApi(value = 19)
@UnstableApi
public abstract class DataSourceContractTest

A collection of contract tests for DataSource implementations.

Subclasses should only include the logic necessary to construct the DataSource and allow it to successfully read data. 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
`public class DataSourceContractTest.FakeTransferListener implements TransferListener` A `TransferListener` that only keeps track of the transferred bytes.
`public final class DataSourceContractTest.TestResource` Information about a resource that can be used to test the `DataSource` instance.
`public final class DataSourceContractTest.TestResource.Builder` Builder for `TestResource` instances.

Public fields
`final AdditionalFailureInfo`	`@Rule additionalFailureInfo`

Public constructors
`DataSourceContractTest()`

Public methods
`void`	`@Test dataSpecWithEndPositionOutOfRange_readsToEnd()`
`void`	`@Test dataSpecWithLength_readExpectedRange()`
`void`	`@Test dataSpecWithPositionAndLength_readExpectedRange()`
`void`	`@Test dataSpecWithPositionAtEndAndLength_readsZeroBytes()`
`void`	`@Test dataSpecWithPositionAtEnd_readsZeroBytes()`
`void`	`@Test dataSpecWithPositionOutOfRange_throwsPositionOutOfRangeException()`
`void`	`@Test dataSpecWithPosition_readUntilEnd()`
`void`	`@Test getResponseHeaders_caseInsensitive()`
`void`	`@Test getResponseHeaders_isEmptyWhileNotOpen()`
`void`	`@Test getResponseHeaders_noNullKeysOrValues()`
`void`	`@Test getResponseHeaders_resourceNotFound_isEmptyWhileNotOpen()`
`void`	`@Test getUri_resourceNotFound_returnsNullIfNotOpened()`
`void`	`@Test getUri_returnsNonNullValueOnlyWhileOpen()`
`void`	`@Test resourceNotFound()`
`void`	`@Test resourceNotFound_transferListenerCallbacks()`
`void`	`@Test transferListenerCallbacks()`
`void`	`@Test 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`).
`void`	`@Test unboundedDataSpec_readUntilEnd()`
`void`	`@Test uriSchemeIsCaseInsensitive()`

Protected methods
`abstract DataSource`	`createDataSource()` Creates and returns an instance of the `DataSource`.
`abstract Uri`	`getNotFoundUri()` Returns a `Uri` that doesn't resolve.
`abstract ImmutableList<DataSourceContractTest.TestResource>`	`getTestResources()` Returns `TestResource` instances.
`@Nullable DataSource`	`getTransferListenerDataSource()` Returns the `DataSource` that will be included in the `TransferListener` callbacks for the `DataSource` most recently created by `createDataSource`.
`boolean`	`unboundedReadsAreIndefinite()` 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`

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`

getUri_resourceNotFound_returnsNullIfNotOpened

@Test
public void getUri_resourceNotFound_returnsNullIfNotOpened()

Throws
`java.lang.Exception`

getUri_returnsNonNullValueOnlyWhileOpen

@Test
public void getUri_returnsNonNullValueOnlyWhileOpen()

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_readUntilEnd

@Test
public void unboundedDataSpec_readUntilEnd()

Throws
`java.lang.Exception`

uriSchemeIsCaseInsensitive

@Test
public void uriSchemeIsCaseInsensitive()

Throws
`java.lang.Exception`

Protected methods

createDataSource

protected abstract DataSource createDataSource()

Creates and returns an instance of the DataSource.

Throws
`java.lang.Exception`

getNotFoundUri

protected abstract Uri getNotFoundUri()

Returns a Uri that doesn't resolve.

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

getTestResources

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.

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

Throws
`java.lang.Exception`

getTransferListenerDataSource

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

protected boolean unboundedReadsAreIndefinite()

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

DataSourceContractTest

Summary

Nested types

Public fields

Public constructors

Public methods

Protected methods

Public fields

additionalFailureInfo

Public constructors

DataSourceContractTest

Public methods

dataSpecWithEndPositionOutOfRange_readsToEnd

dataSpecWithLength_readExpectedRange

dataSpecWithPositionAndLength_readExpectedRange

dataSpecWithPositionAtEndAndLength_readsZeroBytes

dataSpecWithPositionAtEnd_readsZeroBytes

dataSpecWithPositionOutOfRange_throwsPositionOutOfRangeException

dataSpecWithPosition_readUntilEnd

getResponseHeaders_caseInsensitive

getResponseHeaders_isEmptyWhileNotOpen

getResponseHeaders_noNullKeysOrValues

getResponseHeaders_resourceNotFound_isEmptyWhileNotOpen

getUri_resourceNotFound_returnsNullIfNotOpened

getUri_returnsNonNullValueOnlyWhileOpen

resourceNotFound

resourceNotFound_transferListenerCallbacks

transferListenerCallbacks

unboundedDataSpecWithGzipFlag_readUntilEnd

unboundedDataSpec_readUntilEnd

uriSchemeIsCaseInsensitive

Protected methods

createDataSource

getNotFoundUri

getTestResources

getTransferListenerDataSource

unboundedReadsAreIndefinite