PlatformTestStorage
@ExperimentalTestApi
interface PlatformTestStorage
FileTestStorage |
A class that reads/writes the runner data using the raw file system. |
TestStorage |
Provides convenient I/O operations for reading/writing testing relevant files, properties in a test. |
An interface represents on-device I/O operations in an Android test.
This is a low level API, typically used by higher level test frameworks. It is generally not recommended for direct use by most tests.
Use a concrete implementation class of this interface if you need to read/write files in your tests. For example, in an Android Instrumentation test, use
androidx.test.services.storage.TestStorage when the test services is installed on the device.
This API is experimental and is subject to change or removal in future releases.
Summary
Public functions |
|
|---|---|
Unit |
addOutputProperties(properties: (Mutable)Map<String!, Serializable!>!)Adds the given properties. |
String! |
getInputArg(argName: String!)Returns the value of a given argument name. |
(Mutable)Map<String!, String!>! |
Returns the name/value map of all test arguments or an empty map if no arguments are defined. |
(Mutable)Map<String!, Serializable!>! |
Returns a map of all the output test properties. |
InputStream! |
openInputFile(pathname: String!)Provides an InputStream to a test file dependency. |
InputStream! |
openInternalInputFile(pathname: String!)Provides an InputStream to an internal file used by the testing infrastructure. |
OutputStream! |
openInternalOutputFile(pathname: String!)Provides an OutputStream to an internal file used by the testing infrastructure. |
OutputStream! |
openOutputFile(pathname: String!)Provides an OutputStream to a test output file. |
OutputStream! |
openOutputFile(pathname: String!, append: Boolean)Provides an OutputStream to a test output file. |
Public functions
addOutputProperties
fun addOutputProperties(properties: (Mutable)Map<String!, Serializable!>!): Unit
Adds the given properties.
Adding a property with the same name would append new values and overwrite the old values if keys already exist.
getInputArg
fun getInputArg(argName: String!): String!
Returns the value of a given argument name.
| Parameters | |
|---|---|
argName: String! |
the argument name. Should not be null. |
getInputArgs
fun getInputArgs(): (Mutable)Map<String!, String!>!
Returns the name/value map of all test arguments or an empty map if no arguments are defined.
getOutputProperties
fun getOutputProperties(): (Mutable)Map<String!, Serializable!>!
Returns a map of all the output test properties. If no properties exist, an empty map will be returned.
openInputFile
fun openInputFile(pathname: String!): InputStream!
Provides an InputStream to a test file dependency.
| Parameters | |
|---|---|
pathname: String! |
path to the test file dependency. Should not be null. |
| Returns | |
|---|---|
InputStream! |
an InputStream to the given test file. |
| Throws | |
|---|---|
java.io.IOException |
openInternalInputFile
fun openInternalInputFile(pathname: String!): InputStream!
Provides an InputStream to an internal file used by the testing infrastructure.
| Parameters | |
|---|---|
pathname: String! |
path to the internal file. Should not be null. |
| Returns | |
|---|---|
InputStream! |
an InputStream to the given test file. |
| Throws | |
|---|---|
java.io.IOException |
openInternalOutputFile
fun openInternalOutputFile(pathname: String!): OutputStream!
Provides an OutputStream to an internal file used by the testing infrastructure.
| Parameters | |
|---|---|
pathname: String! |
path to the internal file. Should not be null. |
| Returns | |
|---|---|
OutputStream! |
an OutputStream to the given output file. |
| Throws | |
|---|---|
java.io.IOException |
openOutputFile
fun openOutputFile(pathname: String!): OutputStream!
Provides an OutputStream to a test output file.
| Parameters | |
|---|---|
pathname: String! |
path to the test output file. Should not be null. |
| Returns | |
|---|---|
OutputStream! |
an OutputStream to the given output file. |
| Throws | |
|---|---|
java.io.IOException |
openOutputFile
fun openOutputFile(pathname: String!, append: Boolean): OutputStream!
Provides an OutputStream to a test output file.
| Parameters | |
|---|---|
pathname: String! |
path to the test output file. Should not be null. |
append: Boolean |
if true, then the lines will be added to the end of the file rather than overwriting. |
| Returns | |
|---|---|
OutputStream! |
an OutputStream to the given output file. |
| Throws | |
|---|---|
java.io.IOException |