Package-level declarations

Types

Link copied to clipboard
data class AccountResponse(val googleAuto: GoogleAutoResponse)

Identifies an account and how to log into it.

Link copied to clipboard
data class AndroidDeviceListResponse(val androidDevices: List<AndroidDeviceResponse>)

A list of Android device configurations in which the test is to be executed.

Link copied to clipboard
data class AndroidDeviceResponse(val androidModelId: String, val androidVersionId: String, val locale: String, val orientation: String)

A single Android device.

Link copied to clipboard
data class AndroidInstrumentationTestResponse(val appApk: FileReferenceResponse, val appBundle: AppBundleResponse, val appPackageId: String, val orchestratorOption: String, val shardingOption: ShardingOptionResponse, val testApk: FileReferenceResponse, val testPackageId: String, val testRunnerClass: String, val testTargets: List<String>)

A test of an Android application that can control an Android component independently of its normal lifecycle. Android instrumentation tests run an application APK and test APK inside the same process on a virtual or physical AndroidDevice. They also specify a test runner class, such as com.google.GoogleTestRunner, which can vary on the specific instrumentation framework chosen. See for more information on types of Android tests.

Link copied to clipboard
data class AndroidMatrixResponse(val androidModelIds: List<String>, val androidVersionIds: List<String>, val locales: List<String>, val orientations: List<String>)

A set of Android device configuration permutations is defined by the the cross-product of the given axes. Internally, the given AndroidMatrix will be expanded into a set of AndroidDevices. Only supported permutations will be instantiated. Invalid permutations (e.g., incompatible models/versions) are ignored.

Link copied to clipboard
data class AndroidRoboTestResponse(val appApk: FileReferenceResponse, val appBundle: AppBundleResponse, val appInitialActivity: String, val appPackageId: String, val maxDepth: Int, val maxSteps: Int, val roboDirectives: List<RoboDirectiveResponse>, val roboMode: String, val roboScript: FileReferenceResponse, val startingIntents: List<RoboStartingIntentResponse>)

A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes.

Link copied to clipboard
data class AndroidTestLoopResponse(val appApk: FileReferenceResponse, val appBundle: AppBundleResponse, val appPackageId: String, val scenarioLabels: List<String>, val scenarios: List<Int>)

A test of an Android Application with a Test Loop. The intent \ will be implicitly added, since Games is the only user of this api, for the time being.

Link copied to clipboard
data class ApkResponse(val location: FileReferenceResponse, val packageName: String)

An Android package file to install.

Link copied to clipboard
data class AppBundleResponse(val bundleLocation: FileReferenceResponse)

An Android App Bundle file format, containing a BundleConfig.pb file, a base module directory, zero or more dynamic feature module directories. See https://developer.android.com/guide/app-bundle/build for guidance on building App Bundles.

Link copied to clipboard
data class ClientInfoDetailResponse(val key: String, val value: String)

Key-value pair of detailed information about the client which invoked the test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}.

Link copied to clipboard
data class ClientInfoResponse(val clientInfoDetails: List<ClientInfoDetailResponse>, val name: String)

Information about the client which invoked the test.

Link copied to clipboard
data class DeviceFileResponse(val obbFile: ObbFileResponse, val regularFile: RegularFileResponse)

A single device file description.

Link copied to clipboard
data class EnvironmentMatrixResponse(val androidDeviceList: AndroidDeviceListResponse, val androidMatrix: AndroidMatrixResponse, val iosDeviceList: IosDeviceListResponse)

The matrix of environments in which the test is to be executed.

Link copied to clipboard
data class EnvironmentResponse(val androidDevice: AndroidDeviceResponse, val iosDevice: IosDeviceResponse)

The environment in which the test is run.

Link copied to clipboard
data class EnvironmentVariableResponse(val key: String, val value: String)

A key-value pair passed as an environment variable to the test.

Link copied to clipboard
data class FileReferenceResponse(val gcsPath: String)

A reference to a file, used for user inputs.

Link copied to clipboard
data class GetTestMatrixResult(val clientInfo: ClientInfoResponse, val environmentMatrix: EnvironmentMatrixResponse, val failFast: Boolean, val flakyTestAttempts: Int, val invalidMatrixDetails: String, val outcomeSummary: String, val project: String, val resultStorage: ResultStorageResponse, val state: String, val testExecutions: List<TestExecutionResponse>, val testMatrixId: String, val testSpecification: TestSpecificationResponse, val timestamp: String)
Link copied to clipboard

Enables automatic Google account login. If set, the service automatically generates a Google test account and adds it to the device, before executing the test. Note that test accounts might be reused. Many applications show their full set of functionalities when an account is present on the device. Logging into the device with these generated accounts allows testing more functionalities.

Link copied to clipboard
data class GoogleCloudStorageResponse(val gcsPath: String)

A storage location within Google cloud storage (GCS).

Link copied to clipboard
data class IosDeviceFileResponse(val bundleId: String, val content: FileReferenceResponse, val devicePath: String)

A file or directory to install on the device before the test starts.

Link copied to clipboard
data class IosDeviceListResponse(val iosDevices: List<IosDeviceResponse>)

A list of iOS device configurations in which the test is to be executed.

Link copied to clipboard
data class IosDeviceResponse(val iosModelId: String, val iosVersionId: String, val locale: String, val orientation: String)

A single iOS device.

Link copied to clipboard
data class IosTestLoopResponse(val appBundleId: String, val appIpa: FileReferenceResponse, val scenarios: List<Int>)

A test of an iOS application that implements one or more game loop scenarios. This test type accepts an archived application (.ipa file) and a list of integer scenarios that will be executed on the app sequentially.

Link copied to clipboard
data class IosTestSetupResponse(val additionalIpas: List<FileReferenceResponse>, val networkProfile: String, val pullDirectories: List<IosDeviceFileResponse>, val pushFiles: List<IosDeviceFileResponse>)

A description of how to set up an iOS device prior to running the test.

Link copied to clipboard
data class IosXcTestResponse(val appBundleId: String, val testSpecialEntitlements: Boolean, val testsZip: FileReferenceResponse, val xcodeVersion: String, val xctestrun: FileReferenceResponse)

A test of an iOS application that uses the XCTest framework. Xcode supports the option to "build for testing", which generates an .xctestrun file that contains a test specification (arguments, test methods, etc). This test type accepts a zip file containing the .xctestrun file and the corresponding contents of the Build/Products directory that contains all the binaries needed to run the tests.

Link copied to clipboard

Specifies an intent that starts the main launcher activity.

Link copied to clipboard
data class ManualShardingResponse(val testTargetsForShard: List<TestTargetsForShardResponse>)

Shards test cases into the specified groups of packages, classes, and/or methods. With manual sharding enabled, specifying test targets via environment_variables or in InstrumentationTest is invalid.

Link copied to clipboard
data class ObbFileResponse(val obb: FileReferenceResponse, val obbFileName: String)

An opaque binary blob file to install on the device before the test starts.

Link copied to clipboard
data class RegularFileResponse(val content: FileReferenceResponse, val devicePath: String)

A file or directory to install on the device before the test starts.

Link copied to clipboard
data class ResultStorageResponse(val googleCloudStorage: GoogleCloudStorageResponse, val resultsUrl: String, val toolResultsExecution: ToolResultsExecutionResponse, val toolResultsHistory: ToolResultsHistoryResponse)

Locations where the results of running the test are stored.

Link copied to clipboard
data class RoboDirectiveResponse(val actionType: String, val inputText: String, val resourceName: String)

Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click.

Link copied to clipboard
data class RoboStartingIntentResponse(val launcherActivity: LauncherActivityIntentResponse, val startActivity: StartActivityIntentResponse, val timeout: String)

Message for specifying the start activities to crawl.

Link copied to clipboard
data class ShardingOptionResponse(val manualSharding: ManualShardingResponse, val smartSharding: SmartShardingResponse, val uniformSharding: UniformShardingResponse)

Options for enabling sharding.

Link copied to clipboard
data class ShardResponse(val numShards: Int, val shardIndex: Int, val testTargetsForShard: TestTargetsForShardResponse)

Output only. Details about the shard.

Link copied to clipboard
data class SmartShardingResponse(val targetedShardDuration: String)

Shards test based on previous test case timing records.

Link copied to clipboard
data class StartActivityIntentResponse(val action: String, val categories: List<String>, val uri: String)

A starting intent specified by an action, uri, and categories.

Link copied to clipboard
data class SystraceSetupResponse(val durationSeconds: Int)
Link copied to clipboard
data class TestDetailsResponse(val errorMessage: String, val progressMessages: List<String>)

Additional details about the progress of the running test.

Link copied to clipboard
data class TestExecutionResponse(val environment: EnvironmentResponse, val matrixId: String, val project: String, val shard: ShardResponse, val state: String, val testDetails: TestDetailsResponse, val testSpecification: TestSpecificationResponse, val timestamp: String, val toolResultsStep: ToolResultsStepResponse)

A single test executed in a single environment.

Link copied to clipboard
data class TestSetupResponse(val account: AccountResponse, val additionalApks: List<ApkResponse>, val directoriesToPull: List<String>, val dontAutograntPermissions: Boolean, val environmentVariables: List<EnvironmentVariableResponse>, val filesToPush: List<DeviceFileResponse>, val networkProfile: String, val systrace: SystraceSetupResponse)

A description of how to set up the Android device prior to running the test.

Link copied to clipboard
data class TestSpecificationResponse(val androidInstrumentationTest: AndroidInstrumentationTestResponse, val androidRoboTest: AndroidRoboTestResponse, val androidTestLoop: AndroidTestLoopResponse, val disablePerformanceMetrics: Boolean, val disableVideoRecording: Boolean, val iosTestLoop: IosTestLoopResponse, val iosTestSetup: IosTestSetupResponse, val iosXcTest: IosXcTestResponse, val testSetup: TestSetupResponse, val testTimeout: String)

A description of how to run the test.

Link copied to clipboard
data class TestTargetsForShardResponse(val testTargets: List<String>)

Test targets for a shard.

Link copied to clipboard
data class ToolResultsExecutionResponse(val executionId: String, val historyId: String, val project: String)

Represents a tool results execution resource. This has the results of a TestMatrix.

Link copied to clipboard
data class ToolResultsHistoryResponse(val historyId: String, val project: String)

Represents a tool results history resource.

Link copied to clipboard
data class ToolResultsStepResponse(val executionId: String, val historyId: String, val project: String, val stepId: String)

Represents a tool results step resource. This has the results of a TestExecution.

Link copied to clipboard
data class UniformShardingResponse(val numShards: Int)

Uniformly shards test cases given a total number of shards. For instrumentation tests, it will be translated to "-e numShard" and "-e shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying either of these sharding arguments via environment_variables is invalid. Based on the sharding mechanism AndroidJUnitRunner uses, there is no guarantee that test cases will be distributed uniformly across all shards.