--- title: "POST /v1/projects/{projectId}/testMatrices" method: POST path: "/v1/projects/{projectId}/testMatrices" tags: ["projects"] --- # POST /v1/projects/{projectId}/testMatrices `POST /v1/projects/{projectId}/testMatrices` Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. A test matrix is limited to use at most 2000 devices in parallel. The returned matrix will not yet contain the executions that will be created for this matrix. Execution creation happens later on and will require a call to GetTestMatrix. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed or if the matrix tries to use too many simultaneous devices. ## Path parameters - `projectId` string, required ## Query parameters - `requestId` string ## Request body - TestMatrix — TestMatrix captures all details about a test. It contains the environment configuration, test specification, test executions and overall state and outcome. - `testExecutions` TestExecution[] — Output only. The list of test executions that the service creates for this matrix. - `environment` Environment — The environment in which the test is run. - `androidDevice` AndroidDevice — A single Android device. - `androidModelId` string — Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. - `androidVersionId` string — Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. - `locale` string — Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. - `orientation` string — Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. - `iosDevice` IosDevice — A single iOS device. - `iosModelId` string — Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. - `locale` string — Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. - `orientation` string — Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. - `iosVersionId` string — Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. - `toolResultsStep` ToolResultsStep — Represents a tool results step resource. This has the results of a TestExecution. - `projectId` string — Output only. The cloud project that owns the tool results step. - `historyId` string — Output only. A tool results history ID. - `executionId` string — Output only. A tool results execution ID. - `stepId` string — Output only. A tool results step ID. - `testDetails` TestDetails — Additional details about the progress of the running test. - `progressMessages` string[] — Output only. Human-readable, detailed descriptions of the test's progress. For example: "Provisioning a device", "Starting Test". During the course of execution new data may be appended to the end of progress_messages. - `errorMessage` string — Output only. If the TestState is ERROR, then this string will contain human-readable details about the error. - `testSpecification` TestSpecification — A description of how to run the test. - `iosXcTest` IosXcTest — 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. - `appBundleId` string — Output only. The bundle id for the application under test. - `testsZip` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `testSpecialEntitlements` boolean — The option to test special app entitlements. Setting this would re-sign the app having special entitlements with an explicit application-identifier. Currently supports testing aps-environment entitlement. - `xctestrun` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `xcodeVersion` string — The Xcode version that should be used for the test. Use the TestEnvironmentDiscoveryService to get supported options. Defaults to the latest Xcode version Firebase Test Lab supports. - `disablePerformanceMetrics` boolean — Disables performance metrics recording. May reduce test latency. - `androidRoboTest` AndroidRoboTest — A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes. - `appInitialActivity` string — The initial activity that should be used to start the app. - `roboMode` 'ROBO_MODE_UNSPECIFIED' | 'ROBO_VERSION_1' | 'ROBO_VERSION_2' — The mode in which Robo should run. Most clients should allow the server to populate this field automatically. - `maxDepth` integer — The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50. - `roboDirectives` RoboDirective[] — A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided. - `inputText` string — The text that Robo is directed to set. If left empty, the directive will be treated as a CLICK on the element matching the resource_name. - `resourceName` string — Required. The android resource name of the target UI element. For example, in Java: R.string.foo in xml: @string/foo Only the "foo" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html - `actionType` 'ACTION_TYPE_UNSPECIFIED' | 'SINGLE_CLICK' | 'ENTER_TEXT' | 'IGNORE' — Required. The type of action that Robo should perform on the specified element. - `appBundle` AppBundle — 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. - `bundleLocation` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `apks` ApkSplits — A single dynamic feature apk. - `bundleSplits` FileReference[] — A list of .apk files generated by bundletool to install to the device under test as a single android app with adb install-multiple. If specified, requires one or more bundle_splits. The first split specified represents the base APK, while subsequent splits represent feature apks. - … - `roboScript` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `appPackageId` string — The java package for the application under test. The default value is determined by examining the application's manifest. - `maxSteps` integer — The max number of steps Robo can execute. Default is no limit. - `appApk` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `startingIntents` RoboStartingIntent[] — The intents used to launch the app for the crawl. If none are provided, then the main launcher activity is launched. If some are provided, then only those provided are launched (the main launcher activity must be provided explicitly). - `startActivity` StartActivityIntent — A starting intent specified by an action, uri, and categories. - `action` string — Action name. Required for START_ACTIVITY. - `uri` string — URI for the action. - `categories` string[] — Intent categories to set on the intent. - `timeout` string, google-duration — Timeout in seconds for each intent. - `launcherActivity` LauncherActivityIntent — Specifies an intent that starts the main launcher activity. - `noActivity` NoActivityIntent — Skips the starting activity - `androidTestLoop` AndroidTestLoop — 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. - `appApk` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `appBundle` AppBundle — 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. - `bundleLocation` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `apks` ApkSplits — A single dynamic feature apk. - `bundleSplits` FileReference[] — A list of .apk files generated by bundletool to install to the device under test as a single android app with adb install-multiple. If specified, requires one or more bundle_splits. The first split specified represents the base APK, while subsequent splits represent feature apks. - … - `scenarios` integer[] — The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. - `scenarioLabels` string[] — The list of scenario labels that should be run during the test. The scenario labels should map to labels defined in the application's manifest. For example, player_experience and com.google.test.loops.player_experience add all of the loops labeled in the manifest with the com.google.test.loops.player_experience name to the execution. Scenarios can also be specified in the scenarios field. - `appPackageId` string — The java package for the application under test. The default is determined by examining the application's manifest. - `iosTestLoop` IosTestLoop — 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. - `appBundleId` string — Output only. The bundle id for the application under test. - `appIpa` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `scenarios` integer[] — The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. - `iosTestSetup` IosTestSetup — A description of how to set up an iOS device prior to running the test. - `pushFiles` IosDeviceFile[] — List of files to push to the device before starting the test. - `bundleId` string — The bundle id of the app where this file lives. iOS apps sandbox their own filesystem, so app files must specify which app installed on the device. - `content` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `devicePath` string — Location of the file on the device, inside the app's sandboxed filesystem - `networkProfile` string — The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. - `additionalIpas` FileReference[] — iOS apps to install in addition to those being directly tested. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `pullDirectories` IosDeviceFile[] — List of directories on the device to upload to Cloud Storage at the end of the test. Directories should either be in a shared directory (such as /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (such as /Documents) by specifying the bundle ID. - `bundleId` string — The bundle id of the app where this file lives. iOS apps sandbox their own filesystem, so app files must specify which app installed on the device. - `content` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `devicePath` string — Location of the file on the device, inside the app's sandboxed filesystem - `iosRoboTest` IosRoboTest — A test that explores an iOS application on an iOS device. - `roboScript` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `appIpa` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `appBundleId` string — The bundle ID for the app-under-test. This is determined by examining the application's "Info.plist" file. - `testSetup` TestSetup — A description of how to set up the Android device prior to running the test. - `filesToPush` DeviceFile[] — List of files to push to the device before starting the test. - `regularFile` RegularFile — A file or directory to install on the device before the test starts. - `content` FileReference — A reference to a file, used for user inputs. - … - `devicePath` string — Required. Where to put the content on the device. Must be an absolute, allowlisted path. If the file exists, it will be replaced. The following device-side directories and any of their subdirectories are allowlisted: ${EXTERNAL_STORAGE}, /sdcard ${ANDROID_DATA}/local/tmp, or /data/local/tmp Specifying a path outside of these directory trees is invalid. The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device and copy the file there. It is strongly advised to use the Environment API in app and test code to access files on the device in a portable way. - `obbFile` ObbFile — An opaque binary blob file to install on the device before the test starts. - `obb` FileReference — A reference to a file, used for user inputs. - … - `obbFileName` string — Required. OBB file name which must conform to the format as specified by Android e.g. [main|patch].0300110.com.example.android.obb which will be installed into \/Android/obb/\/ on the device. - `account` Account — Identifies an account and how to log into it. - `googleAuto` GoogleAuto — 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. - `systrace` SystraceSetup - `durationSeconds` integer — Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. - `additionalApks` Apk[] — APKs to install in addition to those being directly tested. These will be installed after the app under test. Limited to a combined total of 100 initial setup and additional files. - `location` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `packageName` string — The java package for the APK to be installed. Value is determined by examining the application's manifest. - `environmentVariables` EnvironmentVariable[] — Environment variables to set for the test (only applicable for instrumentation tests). - `key` string — Key for the environment variable. - `value` string — Value for the environment variable. - `initialSetupApks` Apk[] — Optional. Initial setup APKs to install before the app under test is installed. Limited to a combined total of 100 initial setup and additional files. - `location` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `packageName` string — The java package for the APK to be installed. Value is determined by examining the application's manifest. - `directoriesToPull` string[] — List of directories on the device to upload to GCS at the end of the test; they must be absolute paths under /sdcard, /storage or /data/local/tmp. Path names are restricted to characters a-z A-Z 0-9 _ - . + and / Note: The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device. - `dontAutograntPermissions` boolean — Whether to prevent all runtime permissions to be granted at app install - `networkProfile` string — The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. - `androidInstrumentationTest` AndroidInstrumentationTest — 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. - `testPackageId` string — The java package for the test to be executed. The default value is determined by examining the application's manifest. - `testRunnerClass` string — The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. - `orchestratorOption` 'ORCHESTRATOR_OPTION_UNSPECIFIED' | 'USE_ORCHESTRATOR' | 'DO_NOT_USE_ORCHESTRATOR' — The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with AndroidJUnitRunner version 1.1 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See for more information about Android Test Orchestrator. If not set, the test will be run without the orchestrator. - `shardingOption` ShardingOption — Options for enabling sharding. - `uniformSharding` UniformSharding — 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. - `numShards` integer — Required. The total number of shards to create. This must always be a positive number that is no greater than the total number of test cases. When you select one or more physical devices, the number of shards must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. - `manualSharding` ManualSharding — 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. - `testTargetsForShard` TestTargetsForShard[] — Required. Group of packages, classes, and/or test methods to be run for each manually-created shard. You must specify at least one shard if this field is present. When you select one or more physical devices, the number of repeated test_targets_for_shard must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. - … - `smartSharding` SmartSharding — Shards test based on previous test case timing records. - `targetedShardDuration` string, google-duration — The amount of time tests within a shard should take. Default: 300 seconds (5 minutes). The minimum allowed: 120 seconds (2 minutes). The shard count is dynamically set based on time, up to the maximum shard limit (described below). To guarantee at least one test case for each shard, the number of shards will not exceed the number of test cases. Shard duration will be exceeded if: - The maximum shard limit is reached and there is more calculated test time remaining to allocate into shards. - Any individual test is estimated to be longer than the targeted shard duration. Shard duration is not guaranteed because smart sharding uses test case history and default durations which may not be accurate. The rules for finding the test case timing records are: - If the service has processed a test case in the last 30 days, the record of the latest successful test case will be used. - For new test cases, the average duration of other known test cases will be used. - If there are no previous test case timing records available, the default test case duration is 15 seconds. Because the actual shard duration can exceed the targeted shard duration, we recommend that you set the targeted value at least 5 minutes less than the maximum allowed test timeout (45 minutes for physical devices and 60 minutes for virtual), or that you use the custom test timeout value that you set. This approach avoids cancelling the shard before all tests can finish. Note that there is a limit for maximum number of shards. When you select one or more physical devices, the number of shards must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. To guarantee at least one test case for per shard, the number of shards will not exceed the number of test cases. Each shard created counts toward daily test quota. - `appBundle` AppBundle — 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. - `bundleLocation` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `apks` ApkSplits — A single dynamic feature apk. - `bundleSplits` FileReference[] — A list of .apk files generated by bundletool to install to the device under test as a single android app with adb install-multiple. If specified, requires one or more bundle_splits. The first split specified represents the base APK, while subsequent splits represent feature apks. - … - `testTargets` string[] — Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run. - `appPackageId` string — The java package for the application under test. The default value is determined by examining the application's manifest. - `testApk` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `appApk` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `testTimeout` string, google-duration — Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. - `disableVideoRecording` boolean — Disables video recording. May reduce test latency. - `shard` Shard — Output only. Details about the shard. - `estimatedShardDuration` string, google-duration — Output only. The estimated shard duration based on previous test case timing records, if available. - `numShards` integer — Output only. The total number of shards. - `testTargetsForShard` TestTargetsForShard — Test targets for a shard. - `testTargets` string[] — Group of packages, classes, and/or test methods to be run for each shard. The targets need to be specified in AndroidJUnitRunner argument format. For example, "package com.my.packages" "class com.my.package.MyClass". The number of test_targets must be greater than 0. - `shardIndex` integer — Output only. The index of the shard among all the shards. - `timestamp` string, google-datetime — Output only. The time this test execution was initially created. - `id` string — Output only. Unique id set by the service. - `state` 'TEST_STATE_UNSPECIFIED' | 'VALIDATING' | 'PENDING' | 'RUNNING' | 'FINISHED' | 'ERROR' | 'UNSUPPORTED_ENVIRONMENT' | 'INCOMPATIBLE_ENVIRONMENT' | 'INCOMPATIBLE_ARCHITECTURE' | 'CANCELLED' | 'INVALID' — Output only. Indicates the current progress of the test execution (e.g., FINISHED). - `matrixId` string — Output only. Id of the containing TestMatrix. - `projectId` string — Output only. The cloud project that owns the test execution. - `failFast` boolean — If true, only a single attempt at most will be made to run each execution/shard in the matrix. Flaky test attempts are not affected. Normally, 2 or more attempts are made if a potential infrastructure issue is detected. This feature is for latency sensitive workloads. The incidence of execution failures may be significantly greater for fail-fast matrices and support is more limited because of that expectation. - `testMatrixId` string — Output only. Unique id set by the service. - `testSpecification` TestSpecification — A description of how to run the test. - `iosXcTest` IosXcTest — 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. - `appBundleId` string — Output only. The bundle id for the application under test. - `testsZip` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `testSpecialEntitlements` boolean — The option to test special app entitlements. Setting this would re-sign the app having special entitlements with an explicit application-identifier. Currently supports testing aps-environment entitlement. - `xctestrun` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `xcodeVersion` string — The Xcode version that should be used for the test. Use the TestEnvironmentDiscoveryService to get supported options. Defaults to the latest Xcode version Firebase Test Lab supports. - `disablePerformanceMetrics` boolean — Disables performance metrics recording. May reduce test latency. - `androidRoboTest` AndroidRoboTest — A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes. - `appInitialActivity` string — The initial activity that should be used to start the app. - `roboMode` 'ROBO_MODE_UNSPECIFIED' | 'ROBO_VERSION_1' | 'ROBO_VERSION_2' — The mode in which Robo should run. Most clients should allow the server to populate this field automatically. - `maxDepth` integer — The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50. - `roboDirectives` RoboDirective[] — A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided. - `inputText` string — The text that Robo is directed to set. If left empty, the directive will be treated as a CLICK on the element matching the resource_name. - `resourceName` string — Required. The android resource name of the target UI element. For example, in Java: R.string.foo in xml: @string/foo Only the "foo" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html - `actionType` 'ACTION_TYPE_UNSPECIFIED' | 'SINGLE_CLICK' | 'ENTER_TEXT' | 'IGNORE' — Required. The type of action that Robo should perform on the specified element. - `appBundle` AppBundle — 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. - `bundleLocation` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `apks` ApkSplits — A single dynamic feature apk. - `bundleSplits` FileReference[] — A list of .apk files generated by bundletool to install to the device under test as a single android app with adb install-multiple. If specified, requires one or more bundle_splits. The first split specified represents the base APK, while subsequent splits represent feature apks. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `roboScript` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `appPackageId` string — The java package for the application under test. The default value is determined by examining the application's manifest. - `maxSteps` integer — The max number of steps Robo can execute. Default is no limit. - `appApk` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `startingIntents` RoboStartingIntent[] — The intents used to launch the app for the crawl. If none are provided, then the main launcher activity is launched. If some are provided, then only those provided are launched (the main launcher activity must be provided explicitly). - `startActivity` StartActivityIntent — A starting intent specified by an action, uri, and categories. - `action` string — Action name. Required for START_ACTIVITY. - `uri` string — URI for the action. - `categories` string[] — Intent categories to set on the intent. - `timeout` string, google-duration — Timeout in seconds for each intent. - `launcherActivity` LauncherActivityIntent — Specifies an intent that starts the main launcher activity. - `noActivity` NoActivityIntent — Skips the starting activity - `androidTestLoop` AndroidTestLoop — 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. - `appApk` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `appBundle` AppBundle — 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. - `bundleLocation` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `apks` ApkSplits — A single dynamic feature apk. - `bundleSplits` FileReference[] — A list of .apk files generated by bundletool to install to the device under test as a single android app with adb install-multiple. If specified, requires one or more bundle_splits. The first split specified represents the base APK, while subsequent splits represent feature apks. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `scenarios` integer[] — The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. - `scenarioLabels` string[] — The list of scenario labels that should be run during the test. The scenario labels should map to labels defined in the application's manifest. For example, player_experience and com.google.test.loops.player_experience add all of the loops labeled in the manifest with the com.google.test.loops.player_experience name to the execution. Scenarios can also be specified in the scenarios field. - `appPackageId` string — The java package for the application under test. The default is determined by examining the application's manifest. - `iosTestLoop` IosTestLoop — 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. - `appBundleId` string — Output only. The bundle id for the application under test. - `appIpa` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `scenarios` integer[] — The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. - `iosTestSetup` IosTestSetup — A description of how to set up an iOS device prior to running the test. - `pushFiles` IosDeviceFile[] — List of files to push to the device before starting the test. - `bundleId` string — The bundle id of the app where this file lives. iOS apps sandbox their own filesystem, so app files must specify which app installed on the device. - `content` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `devicePath` string — Location of the file on the device, inside the app's sandboxed filesystem - `networkProfile` string — The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. - `additionalIpas` FileReference[] — iOS apps to install in addition to those being directly tested. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `pullDirectories` IosDeviceFile[] — List of directories on the device to upload to Cloud Storage at the end of the test. Directories should either be in a shared directory (such as /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (such as /Documents) by specifying the bundle ID. - `bundleId` string — The bundle id of the app where this file lives. iOS apps sandbox their own filesystem, so app files must specify which app installed on the device. - `content` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `devicePath` string — Location of the file on the device, inside the app's sandboxed filesystem - `iosRoboTest` IosRoboTest — A test that explores an iOS application on an iOS device. - `roboScript` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `appIpa` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `appBundleId` string — The bundle ID for the app-under-test. This is determined by examining the application's "Info.plist" file. - `testSetup` TestSetup — A description of how to set up the Android device prior to running the test. - `filesToPush` DeviceFile[] — List of files to push to the device before starting the test. - `regularFile` RegularFile — A file or directory to install on the device before the test starts. - `content` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `devicePath` string — Required. Where to put the content on the device. Must be an absolute, allowlisted path. If the file exists, it will be replaced. The following device-side directories and any of their subdirectories are allowlisted: ${EXTERNAL_STORAGE}, /sdcard ${ANDROID_DATA}/local/tmp, or /data/local/tmp Specifying a path outside of these directory trees is invalid. The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device and copy the file there. It is strongly advised to use the Environment API in app and test code to access files on the device in a portable way. - `obbFile` ObbFile — An opaque binary blob file to install on the device before the test starts. - `obb` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `obbFileName` string — Required. OBB file name which must conform to the format as specified by Android e.g. [main|patch].0300110.com.example.android.obb which will be installed into \/Android/obb/\/ on the device. - `account` Account — Identifies an account and how to log into it. - `googleAuto` GoogleAuto — 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. - `systrace` SystraceSetup - `durationSeconds` integer — Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. - `additionalApks` Apk[] — APKs to install in addition to those being directly tested. These will be installed after the app under test. Limited to a combined total of 100 initial setup and additional files. - `location` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `packageName` string — The java package for the APK to be installed. Value is determined by examining the application's manifest. - `environmentVariables` EnvironmentVariable[] — Environment variables to set for the test (only applicable for instrumentation tests). - `key` string — Key for the environment variable. - `value` string — Value for the environment variable. - `initialSetupApks` Apk[] — Optional. Initial setup APKs to install before the app under test is installed. Limited to a combined total of 100 initial setup and additional files. - `location` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `packageName` string — The java package for the APK to be installed. Value is determined by examining the application's manifest. - `directoriesToPull` string[] — List of directories on the device to upload to GCS at the end of the test; they must be absolute paths under /sdcard, /storage or /data/local/tmp. Path names are restricted to characters a-z A-Z 0-9 _ - . + and / Note: The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device. - `dontAutograntPermissions` boolean — Whether to prevent all runtime permissions to be granted at app install - `networkProfile` string — The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. - `androidInstrumentationTest` AndroidInstrumentationTest — 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. - `testPackageId` string — The java package for the test to be executed. The default value is determined by examining the application's manifest. - `testRunnerClass` string — The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. - `orchestratorOption` 'ORCHESTRATOR_OPTION_UNSPECIFIED' | 'USE_ORCHESTRATOR' | 'DO_NOT_USE_ORCHESTRATOR' — The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with AndroidJUnitRunner version 1.1 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See for more information about Android Test Orchestrator. If not set, the test will be run without the orchestrator. - `shardingOption` ShardingOption — Options for enabling sharding. - `uniformSharding` UniformSharding — 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. - `numShards` integer — Required. The total number of shards to create. This must always be a positive number that is no greater than the total number of test cases. When you select one or more physical devices, the number of shards must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. - `manualSharding` ManualSharding — 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. - `testTargetsForShard` TestTargetsForShard[] — Required. Group of packages, classes, and/or test methods to be run for each manually-created shard. You must specify at least one shard if this field is present. When you select one or more physical devices, the number of repeated test_targets_for_shard must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. - `testTargets` string[] — Group of packages, classes, and/or test methods to be run for each shard. The targets need to be specified in AndroidJUnitRunner argument format. For example, "package com.my.packages" "class com.my.package.MyClass". The number of test_targets must be greater than 0. - `smartSharding` SmartSharding — Shards test based on previous test case timing records. - `targetedShardDuration` string, google-duration — The amount of time tests within a shard should take. Default: 300 seconds (5 minutes). The minimum allowed: 120 seconds (2 minutes). The shard count is dynamically set based on time, up to the maximum shard limit (described below). To guarantee at least one test case for each shard, the number of shards will not exceed the number of test cases. Shard duration will be exceeded if: - The maximum shard limit is reached and there is more calculated test time remaining to allocate into shards. - Any individual test is estimated to be longer than the targeted shard duration. Shard duration is not guaranteed because smart sharding uses test case history and default durations which may not be accurate. The rules for finding the test case timing records are: - If the service has processed a test case in the last 30 days, the record of the latest successful test case will be used. - For new test cases, the average duration of other known test cases will be used. - If there are no previous test case timing records available, the default test case duration is 15 seconds. Because the actual shard duration can exceed the targeted shard duration, we recommend that you set the targeted value at least 5 minutes less than the maximum allowed test timeout (45 minutes for physical devices and 60 minutes for virtual), or that you use the custom test timeout value that you set. This approach avoids cancelling the shard before all tests can finish. Note that there is a limit for maximum number of shards. When you select one or more physical devices, the number of shards must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. To guarantee at least one test case for per shard, the number of shards will not exceed the number of test cases. Each shard created counts toward daily test quota. - `appBundle` AppBundle — 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. - `bundleLocation` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `apks` ApkSplits — A single dynamic feature apk. - `bundleSplits` FileReference[] — A list of .apk files generated by bundletool to install to the device under test as a single android app with adb install-multiple. If specified, requires one or more bundle_splits. The first split specified represents the base APK, while subsequent splits represent feature apks. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `testTargets` string[] — Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run. - `appPackageId` string — The java package for the application under test. The default value is determined by examining the application's manifest. - `testApk` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `appApk` FileReference — A reference to a file, used for user inputs. - `gcsPath` string — A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding) - `testTimeout` string, google-duration — Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. - `disableVideoRecording` boolean — Disables video recording. May reduce test latency. - `outcomeSummary` 'OUTCOME_SUMMARY_UNSPECIFIED' | 'SUCCESS' | 'FAILURE' | 'INCONCLUSIVE' | 'SKIPPED' — Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. - `extendedInvalidMatrixDetails` MatrixErrorDetail[] — Output only. Details about why a matrix was deemed invalid. If multiple checks can be safely performed, they will be reported but no assumptions should be made about the length of this list. - `reason` string — Output only. The reason for the error. This is a constant value in UPPER_SNAKE_CASE that identifies the cause of the error. - `message` string — Output only. A human-readable message about how the error in the TestMatrix. Expands on the `reason` field with additional details and possible options to fix the issue. - `clientInfo` ClientInfo — Information about the client which invoked the test. - `name` string — Required. Client name, such as gcloud. - `clientInfoDetails` ClientInfoDetail[] — The list of detailed information about client. - `key` string — Required. The key of detailed client information. - `value` string — Required. The value of detailed client information. - `projectId` string — The cloud project that owns the test matrix. - `resultStorage` ResultStorage — Locations where the results of running the test are stored. - `toolResultsExecution` ToolResultsExecution — Represents a tool results execution resource. This has the results of a TestMatrix. - `projectId` string — Output only. The cloud project that owns the tool results execution. - `historyId` string — Output only. A tool results history ID. - `executionId` string — Output only. A tool results execution ID. - `resultsUrl` string — Output only. URL to the results in the Firebase Web Console. - `googleCloudStorage` GoogleCloudStorage — A storage location within Google cloud storage (GCS). - `gcsPath` string — Required. The path to a directory in GCS that will eventually contain the results for this test. The requesting user must have write access on the bucket in the supplied path. - `toolResultsHistory` ToolResultsHistory — Represents a tool results history resource. - `historyId` string — Required. A tool results history ID. - `projectId` string — Required. The cloud project that owns the tool results history. - `flakyTestAttempts` integer — The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns. - `state` 'TEST_STATE_UNSPECIFIED' | 'VALIDATING' | 'PENDING' | 'RUNNING' | 'FINISHED' | 'ERROR' | 'UNSUPPORTED_ENVIRONMENT' | 'INCOMPATIBLE_ENVIRONMENT' | 'INCOMPATIBLE_ARCHITECTURE' | 'CANCELLED' | 'INVALID' — Output only. Indicates the current progress of the test matrix. - `environmentMatrix` EnvironmentMatrix — The matrix of environments in which the test is to be executed. - `iosDeviceList` IosDeviceList — A list of iOS device configurations in which the test is to be executed. - `iosDevices` IosDevice[] — Required. A list of iOS devices. - `iosModelId` string — Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. - `locale` string — Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. - `orientation` string — Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. - `iosVersionId` string — Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. - `androidMatrix` AndroidMatrix — 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. - `androidVersionIds` string[] — Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. - `locales` string[] — Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options. - `androidModelIds` string[] — Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. - `orientations` string[] — Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options. - `androidDeviceList` AndroidDeviceList — A list of Android device configurations in which the test is to be executed. - `androidDevices` AndroidDevice[] — Required. A list of Android devices. - `androidModelId` string — Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. - `androidVersionId` string — Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. - `locale` string — Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. - `orientation` string — Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. - `timestamp` string, google-datetime — Output only. The time this test matrix was initially created. - `invalidMatrixDetails` 'INVALID_MATRIX_DETAILS_UNSPECIFIED' | 'DETAILS_UNAVAILABLE' | 'MALFORMED_APK' | 'MALFORMED_TEST_APK' | 'NO_MANIFEST' | 'NO_PACKAGE_NAME' | 'INVALID_PACKAGE_NAME' | 'TEST_SAME_AS_APP' | 'NO_INSTRUMENTATION' | 'NO_SIGNATURE' | 'INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE' | 'NO_TEST_RUNNER_CLASS' | 'NO_LAUNCHER_ACTIVITY' | 'FORBIDDEN_PERMISSIONS' | 'INVALID_ROBO_DIRECTIVES' | 'INVALID_RESOURCE_NAME' | 'INVALID_DIRECTIVE_ACTION' | 'TEST_LOOP_INTENT_FILTER_NOT_FOUND' | 'SCENARIO_LABEL_NOT_DECLARED' | 'SCENARIO_LABEL_MALFORMED' | 'SCENARIO_NOT_DECLARED' | 'DEVICE_ADMIN_RECEIVER' | 'MALFORMED_XC_TEST_ZIP' | 'BUILT_FOR_IOS_SIMULATOR' | 'NO_TESTS_IN_XC_TEST_ZIP' | 'USE_DESTINATION_ARTIFACTS' | 'TEST_NOT_APP_HOSTED' | 'PLIST_CANNOT_BE_PARSED' | 'TEST_ONLY_APK' | 'MALFORMED_IPA' | 'MISSING_URL_SCHEME' | 'MALFORMED_APP_BUNDLE' | 'NO_CODE_APK' | 'INVALID_INPUT_APK' | 'INVALID_APK_PREVIEW_SDK' | 'MATRIX_TOO_LARGE' | 'TEST_QUOTA_EXCEEDED' | 'SERVICE_NOT_ACTIVATED' | 'UNKNOWN_PERMISSION_ERROR' — Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. ## Response `200` Successful response --- [API](https://skmtc.dev/google/apis/testing.md) · [All operations](https://skmtc.dev/google/apis/testing/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/testing/revisions/bf330da53ac5/schema)