| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="testing_v1.html">Cloud Testing API</a> . <a href="testing_v1.projects.html">projects</a> . <a href="testing_v1.projects.testMatrices.html">testMatrices</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#cancel">cancel(projectId, testMatrixId, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 79 | <p class="firstline">Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asynchronously. If the matrix is already final, this operation will have no effect. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#close">close()</a></code></p> |
| 82 | <p class="firstline">Close httplib2 connections.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 84 | <code><a href="#create">create(projectId, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 85 | <p class="firstline">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. 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.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(projectId, testMatrixId, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 88 | <p class="firstline">Checks the status of a test matrix. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="cancel">cancel(projectId, testMatrixId, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 92 | <pre>Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asynchronously. If the matrix is already final, this operation will have no effect. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 93 | |
| 94 | Args: |
| 95 | projectId: string, Cloud project that owns the test. (required) |
| 96 | testMatrixId: string, Test matrix that will be canceled. (required) |
| 97 | x__xgafv: string, V1 error format. |
| 98 | Allowed values |
| 99 | 1 - v1 error format |
| 100 | 2 - v2 error format |
| 101 | |
| 102 | Returns: |
| 103 | An object of the form: |
| 104 | |
| 105 | { # Response containing the current state of the specified test matrix. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 106 | "testState": "A String", # The current rolled-up state of the test matrix. If this state is already final, then the cancelation request will have no effect. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 107 | }</pre> |
| 108 | </div> |
| 109 | |
| 110 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 111 | <code class="details" id="close">close()</code> |
| 112 | <pre>Close httplib2 connections.</pre> |
| 113 | </div> |
| 114 | |
| 115 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 116 | <code class="details" id="create">create(projectId, body=None, requestId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 117 | <pre>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. 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 118 | |
| 119 | Args: |
| 120 | projectId: string, The GCE project under which this job will run. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 121 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | The object takes the form of: |
| 123 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 124 | { # TestMatrix captures all details about a test. It contains the environment configuration, test specification, test executions and overall state and outcome. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 125 | "testMatrixId": "A String", # Output only. Unique id set by the service. |
| 126 | "timestamp": "A String", # Output only. The time this test matrix was initially created. |
| 127 | "invalidMatrixDetails": "A String", # Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. |
| 128 | "state": "A String", # Output only. Indicates the current progress of the test matrix. |
| 129 | "testSpecification": { # A description of how to run the test. # Required. How to run the test. |
| 130 | "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. # An iOS XCTest, via an .xctestrun file. |
| 131 | "testSpecialEntitlements": True or False, # 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. |
| 132 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 133 | "xcodeVersion": "A 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. |
| 134 | "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip. |
| 135 | "gcsPath": "A 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) |
| 136 | }, |
| 137 | "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified. |
| 138 | "gcsPath": "A 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) |
| 139 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 140 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 141 | "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS. |
| 142 | "additionalIpas": [ # iOS apps to install in addition to those being directly tested. |
| 143 | { # A reference to a file, used for user inputs. |
| 144 | "gcsPath": "A 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) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 145 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 146 | ], |
| 147 | "pullDirectories": [ # 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 (e.g. /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (e.g. /Documents) by specifying the bundle id. |
| 148 | { # A file or directory to install on the device before the test starts. |
| 149 | "bundleId": "A 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. |
| 150 | "content": { # A reference to a file, used for user inputs. # The source file |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 151 | "gcsPath": "A 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) |
| 152 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 153 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 154 | }, |
| 155 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 156 | "pushFiles": [ # List of files to push to the device before starting the test. |
| 157 | { # A file or directory to install on the device before the test starts. |
| 158 | "bundleId": "A 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. |
| 159 | "content": { # A reference to a file, used for user inputs. # The source file |
| 160 | "gcsPath": "A 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) |
| 161 | }, |
| 162 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| 163 | }, |
| 164 | ], |
| 165 | "networkProfile": "A 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 166 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 167 | "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. Next tag: 30 # An Android robo test. |
| 168 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| 169 | "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue for the crawl. |
| 170 | "gcsPath": "A 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) |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 171 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 172 | "roboDirectives": [ # 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. |
| 173 | { # 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. |
| 174 | "inputText": "A 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. |
| 175 | "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. |
| 176 | "resourceName": "A 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 |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 177 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 178 | ], |
| 179 | "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. |
| 180 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 181 | "maxDepth": 42, # 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. |
| 182 | "startingIntents": [ # 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). |
| 183 | { # Message for specifying the start activities to crawl. |
| 184 | "timeout": "A String", # Timeout in seconds for each intent. |
| 185 | "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details. |
| 186 | "uri": "A String", # URI for the action. |
| 187 | "action": "A String", # Action name. Required for START_ACTIVITY. |
| 188 | "categories": [ # Intent categories to set on the intent. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 189 | "A String", |
| 190 | ], |
| 191 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 192 | "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 193 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 194 | }, |
| 195 | ], |
| 196 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 197 | "gcsPath": "A 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) |
| 198 | }, |
| 199 | "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. # A multi-apk app bundle for the application under test. |
| 200 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 201 | "gcsPath": "A 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) |
| 202 | }, |
| 203 | }, |
| 204 | }, |
| 205 | "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency. |
| 206 | "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. # An Android Application with a Test Loop. |
| 207 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 208 | "gcsPath": "A 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) |
| 209 | }, |
| 210 | "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. # A multi-apk app bundle for the application under test. |
| 211 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 212 | "gcsPath": "A 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) |
| 213 | }, |
| 214 | }, |
| 215 | "appPackageId": "A String", # The java package for the application under test. The default is determined by examining the application's manifest. |
| 216 | "scenarioLabels": [ # 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. |
| 217 | "A String", |
| 218 | ], |
| 219 | "scenarios": [ # The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. |
| 220 | 42, |
| 221 | ], |
| 222 | }, |
| 223 | "testTimeout": "A String", # Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. |
| 224 | "disableVideoRecording": True or False, # Disables video recording. May reduce test latency. |
| 225 | "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. # An iOS application with a test loop. |
| 226 | "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test. |
| 227 | "gcsPath": "A 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) |
| 228 | }, |
| 229 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 230 | "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. |
| 231 | 42, |
| 232 | ], |
| 233 | }, |
| 234 | "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. # An Android instrumentation test. |
| 235 | "orchestratorOption": "A String", # 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.0 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. |
| 236 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. |
| 237 | "testPackageId": "A String", # The java package for the test to be executed. The default value is determined by examining the application's manifest. |
| 238 | "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed. |
| 239 | "gcsPath": "A 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) |
| 240 | }, |
| 241 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| 242 | "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel. |
| 243 | "uniformSharding": { # Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to "-e numShard" "-e shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid. # Uniformly shards test cases given a total number of shards. |
| 244 | "numShards": 42, # Required. Total number of shards. When any physical devices are selected, the number must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 245 | }, |
| 246 | "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. # Shards test cases into the specified groups of packages, classes, and/or methods. |
| 247 | "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 248 | { # Test targets for a shard. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 249 | "testTargets": [ # 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 shard_test_targets must be greater than 0. |
| 250 | "A String", |
| 251 | ], |
| 252 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 253 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 254 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 255 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 256 | "testTargets": [ # 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. |
| 257 | "A String", |
| 258 | ], |
| 259 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 260 | "gcsPath": "A 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) |
| 261 | }, |
| 262 | "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. # A multi-apk app bundle for the application under test. |
| 263 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 264 | "gcsPath": "A 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) |
| 265 | }, |
| 266 | }, |
| 267 | }, |
| 268 | "testSetup": { # A description of how to set up the Android device prior to running the test. # Test setup requirements for Android e.g. files to install, bootstrap scripts. |
| 269 | "systrace": { # Systrace configuration for the run. If set a systrace will be taken, starting on test start and lasting for the configured duration. The systrace file thus obtained is put in the results bucket together with the other artifacts from the run. |
| 270 | "durationSeconds": 42, # Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. |
| 271 | }, |
| 272 | "account": { # Identifies an account and how to log into it. # The device will be logged in on this account for the duration of the test. |
| 273 | "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. # An automatic google login account. |
| 274 | }, |
| 275 | }, |
| 276 | "dontAutograntPermissions": True or False, # Whether to prevent all runtime permissions to be granted at app install |
| 277 | "directoriesToPull": [ # 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. |
| 278 | "A String", |
| 279 | ], |
| 280 | "additionalApks": [ # APKs to install in addition to those being directly tested. Currently capped at 100. |
| 281 | { # An Android package file to install. |
| 282 | "packageName": "A String", # The java package for the APK to be installed. Value is determined by examining the application's manifest. |
| 283 | "location": { # A reference to a file, used for user inputs. # The path to an APK to be installed on the device before the test begins. |
| 284 | "gcsPath": "A 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) |
| 285 | }, |
| 286 | }, |
| 287 | ], |
| 288 | "filesToPush": [ # List of files to push to the device before starting the test. |
| 289 | { # A single device file description. |
| 290 | "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file. |
| 291 | "obbFileName": "A 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. |
| 292 | "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device. |
| 293 | "gcsPath": "A 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) |
| 294 | }, |
| 295 | }, |
| 296 | "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file. |
| 297 | "devicePath": "A 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, or /storage ${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. |
| 298 | "content": { # A reference to a file, used for user inputs. # Required. The source file. |
| 299 | "gcsPath": "A 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) |
| 300 | }, |
| 301 | }, |
| 302 | }, |
| 303 | ], |
| 304 | "networkProfile": "A 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. |
| 305 | "environmentVariables": [ # Environment variables to set for the test (only applicable for instrumentation tests). |
| 306 | { # A key-value pair passed as an environment variable to the test. |
| 307 | "value": "A String", # Value for the environment variable. |
| 308 | "key": "A String", # Key for the environment variable. |
| 309 | }, |
| 310 | ], |
| 311 | }, |
| 312 | }, |
| 313 | "outcomeSummary": "A String", # Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. |
| 314 | "failFast": True or False, # 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. |
| 315 | "testExecutions": [ # Output only. The list of test executions that the service creates for this matrix. |
| 316 | { # A single test executed in a single environment. |
| 317 | "projectId": "A String", # Output only. The cloud project that owns the test execution. |
| 318 | "id": "A String", # Output only. Unique id set by the service. |
| 319 | "environment": { # The environment in which the test is run. # Output only. How the host machine(s) are configured. |
| 320 | "iosDevice": { # A single iOS device. # An iOS device which must be used with an iOS test. |
| 321 | "iosModelId": "A String", # Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 322 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 323 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 324 | "iosVersionId": "A String", # Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 325 | }, |
| 326 | "androidDevice": { # A single Android device. # An Android device which must be used with an Android test. |
| 327 | "androidVersionId": "A String", # Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 328 | "androidModelId": "A String", # Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 329 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 330 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 331 | }, |
| 332 | }, |
| 333 | "testDetails": { # Additional details about the progress of the running test. # Output only. Additional details about the running test. |
| 334 | "errorMessage": "A String", # Output only. If the TestState is ERROR, then this string will contain human-readable details about the error. |
| 335 | "progressMessages": [ # 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. |
| 336 | "A String", |
| 337 | ], |
| 338 | }, |
| 339 | "timestamp": "A String", # Output only. The time this test execution was initially created. |
| 340 | "state": "A String", # Output only. Indicates the current progress of the test execution (e.g., FINISHED). |
| 341 | "shard": { # Output only. Details about the shard. # Output only. Details about the shard. |
| 342 | "testTargetsForShard": { # Test targets for a shard. # Output only. Test targets for each shard. |
| 343 | "testTargets": [ # 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 shard_test_targets must be greater than 0. |
| 344 | "A String", |
| 345 | ], |
| 346 | }, |
| 347 | "numShards": 42, # Output only. The total number of shards. |
| 348 | "shardIndex": 42, # Output only. The index of the shard among all the shards. |
| 349 | }, |
| 350 | "matrixId": "A String", # Output only. Id of the containing TestMatrix. |
| 351 | "testSpecification": { # A description of how to run the test. # Output only. How to run the test. |
| 352 | "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. # An iOS XCTest, via an .xctestrun file. |
| 353 | "testSpecialEntitlements": True or False, # 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. |
| 354 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 355 | "xcodeVersion": "A 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. |
| 356 | "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip. |
| 357 | "gcsPath": "A 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) |
| 358 | }, |
| 359 | "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified. |
| 360 | "gcsPath": "A 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) |
| 361 | }, |
| 362 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 363 | "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 364 | "additionalIpas": [ # iOS apps to install in addition to those being directly tested. |
| 365 | { # A reference to a file, used for user inputs. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 366 | "gcsPath": "A 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) |
| 367 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 368 | ], |
| 369 | "pullDirectories": [ # 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 (e.g. /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (e.g. /Documents) by specifying the bundle id. |
| 370 | { # A file or directory to install on the device before the test starts. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 371 | "bundleId": "A 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. |
| 372 | "content": { # A reference to a file, used for user inputs. # The source file |
| 373 | "gcsPath": "A 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) |
| 374 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 375 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 376 | }, |
| 377 | ], |
| 378 | "pushFiles": [ # List of files to push to the device before starting the test. |
| 379 | { # A file or directory to install on the device before the test starts. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 380 | "bundleId": "A 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. |
| 381 | "content": { # A reference to a file, used for user inputs. # The source file |
| 382 | "gcsPath": "A 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) |
| 383 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 384 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 385 | }, |
| 386 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 387 | "networkProfile": "A 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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 388 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 389 | "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. Next tag: 30 # An Android robo test. |
| 390 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 391 | "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue for the crawl. |
| 392 | "gcsPath": "A 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) |
| 393 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 394 | "roboDirectives": [ # 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. |
| 395 | { # 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 396 | "inputText": "A 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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 397 | "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 398 | "resourceName": "A 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 |
| 399 | }, |
| 400 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 401 | "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. |
| 402 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 403 | "maxDepth": 42, # 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. |
| 404 | "startingIntents": [ # 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). |
| 405 | { # Message for specifying the start activities to crawl. |
| 406 | "timeout": "A String", # Timeout in seconds for each intent. |
| 407 | "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details. |
| 408 | "uri": "A String", # URI for the action. |
| 409 | "action": "A String", # Action name. Required for START_ACTIVITY. |
| 410 | "categories": [ # Intent categories to set on the intent. |
| 411 | "A String", |
| 412 | ], |
| 413 | }, |
| 414 | "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity. |
| 415 | }, |
| 416 | }, |
| 417 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 418 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 419 | "gcsPath": "A 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) |
| 420 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 421 | "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. # A multi-apk app bundle for the application under test. |
| 422 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 423 | "gcsPath": "A 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) |
| 424 | }, |
| 425 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 426 | }, |
| 427 | "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency. |
| 428 | "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. # An Android Application with a Test Loop. |
| 429 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 430 | "gcsPath": "A 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) |
| 431 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 432 | "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. # A multi-apk app bundle for the application under test. |
| 433 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 434 | "gcsPath": "A 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) |
| 435 | }, |
| 436 | }, |
| 437 | "appPackageId": "A String", # The java package for the application under test. The default is determined by examining the application's manifest. |
| 438 | "scenarioLabels": [ # 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. |
| 439 | "A String", |
| 440 | ], |
| 441 | "scenarios": [ # The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. |
| 442 | 42, |
| 443 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 444 | }, |
| 445 | "testTimeout": "A String", # Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. |
| 446 | "disableVideoRecording": True or False, # Disables video recording. May reduce test latency. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 447 | "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. # An iOS application with a test loop. |
| 448 | "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 449 | "gcsPath": "A 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) |
| 450 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 451 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 452 | "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. |
| 453 | 42, |
| 454 | ], |
| 455 | }, |
| 456 | "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. # An Android instrumentation test. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 457 | "orchestratorOption": "A String", # 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.0 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. |
| 458 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 459 | "testPackageId": "A String", # The java package for the test to be executed. The default value is determined by examining the application's manifest. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 460 | "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed. |
| 461 | "gcsPath": "A 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) |
| 462 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 463 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 464 | "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel. |
| 465 | "uniformSharding": { # Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to "-e numShard" "-e shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid. # Uniformly shards test cases given a total number of shards. |
| 466 | "numShards": 42, # Required. Total number of shards. When any physical devices are selected, the number must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 467 | }, |
| 468 | "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. # Shards test cases into the specified groups of packages, classes, and/or methods. |
| 469 | "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 470 | { # Test targets for a shard. |
| 471 | "testTargets": [ # 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 shard_test_targets must be greater than 0. |
| 472 | "A String", |
| 473 | ], |
| 474 | }, |
| 475 | ], |
| 476 | }, |
| 477 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 478 | "testTargets": [ # 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. |
| 479 | "A String", |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 480 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 481 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 482 | "gcsPath": "A 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) |
| 483 | }, |
| 484 | "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. # A multi-apk app bundle for the application under test. |
| 485 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 486 | "gcsPath": "A 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) |
| 487 | }, |
| 488 | }, |
| 489 | }, |
| 490 | "testSetup": { # A description of how to set up the Android device prior to running the test. # Test setup requirements for Android e.g. files to install, bootstrap scripts. |
| 491 | "systrace": { # Systrace configuration for the run. If set a systrace will be taken, starting on test start and lasting for the configured duration. The systrace file thus obtained is put in the results bucket together with the other artifacts from the run. |
| 492 | "durationSeconds": 42, # Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. |
| 493 | }, |
| 494 | "account": { # Identifies an account and how to log into it. # The device will be logged in on this account for the duration of the test. |
| 495 | "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. # An automatic google login account. |
| 496 | }, |
| 497 | }, |
| 498 | "dontAutograntPermissions": True or False, # Whether to prevent all runtime permissions to be granted at app install |
| 499 | "directoriesToPull": [ # 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. |
| 500 | "A String", |
| 501 | ], |
| 502 | "additionalApks": [ # APKs to install in addition to those being directly tested. Currently capped at 100. |
| 503 | { # An Android package file to install. |
| 504 | "packageName": "A String", # The java package for the APK to be installed. Value is determined by examining the application's manifest. |
| 505 | "location": { # A reference to a file, used for user inputs. # The path to an APK to be installed on the device before the test begins. |
| 506 | "gcsPath": "A 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) |
| 507 | }, |
| 508 | }, |
| 509 | ], |
| 510 | "filesToPush": [ # List of files to push to the device before starting the test. |
| 511 | { # A single device file description. |
| 512 | "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file. |
| 513 | "obbFileName": "A 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. |
| 514 | "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device. |
| 515 | "gcsPath": "A 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) |
| 516 | }, |
| 517 | }, |
| 518 | "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file. |
| 519 | "devicePath": "A 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, or /storage ${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. |
| 520 | "content": { # A reference to a file, used for user inputs. # Required. The source file. |
| 521 | "gcsPath": "A 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) |
| 522 | }, |
| 523 | }, |
| 524 | }, |
| 525 | ], |
| 526 | "networkProfile": "A 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. |
| 527 | "environmentVariables": [ # Environment variables to set for the test (only applicable for instrumentation tests). |
| 528 | { # A key-value pair passed as an environment variable to the test. |
| 529 | "value": "A String", # Value for the environment variable. |
| 530 | "key": "A String", # Key for the environment variable. |
| 531 | }, |
| 532 | ], |
| 533 | }, |
| 534 | }, |
| 535 | "toolResultsStep": { # Represents a tool results step resource. This has the results of a TestExecution. # Output only. Where the results for this execution are written. |
| 536 | "executionId": "A String", # Output only. A tool results execution ID. |
| 537 | "historyId": "A String", # Output only. A tool results history ID. |
| 538 | "stepId": "A String", # Output only. A tool results step ID. |
| 539 | "projectId": "A String", # Output only. The cloud project that owns the tool results step. |
| 540 | }, |
| 541 | }, |
| 542 | ], |
| 543 | "projectId": "A String", # The cloud project that owns the test matrix. |
| 544 | "resultStorage": { # Locations where the results of running the test are stored. # Required. Where the results for the matrix are written. |
| 545 | "toolResultsExecution": { # Represents a tool results execution resource. This has the results of a TestMatrix. # Output only. The tool results execution that results are written to. |
| 546 | "historyId": "A String", # Output only. A tool results history ID. |
| 547 | "executionId": "A String", # Output only. A tool results execution ID. |
| 548 | "projectId": "A String", # Output only. The cloud project that owns the tool results execution. |
| 549 | }, |
| 550 | "googleCloudStorage": { # A storage location within Google cloud storage (GCS). # Required. |
| 551 | "gcsPath": "A 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. |
| 552 | }, |
| 553 | "resultsUrl": "A String", # Output only. URL to the results in the Firebase Web Console. |
| 554 | "toolResultsHistory": { # Represents a tool results history resource. # The tool results history that contains the tool results execution that results are written to. If not provided, the service will choose an appropriate value. |
| 555 | "projectId": "A String", # Required. The cloud project that owns the tool results history. |
| 556 | "historyId": "A String", # Required. A tool results history ID. |
| 557 | }, |
| 558 | }, |
| 559 | "environmentMatrix": { # The matrix of environments in which the test is to be executed. # Required. The devices the tests are being executed on. |
| 560 | "androidDeviceList": { # A list of Android device configurations in which the test is to be executed. # A list of Android devices; the test will be run only on the specified devices. |
| 561 | "androidDevices": [ # Required. A list of Android devices. |
| 562 | { # A single Android device. |
| 563 | "androidVersionId": "A String", # Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 564 | "androidModelId": "A String", # Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 565 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 566 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 567 | }, |
| 568 | ], |
| 569 | }, |
| 570 | "iosDeviceList": { # A list of iOS device configurations in which the test is to be executed. # A list of iOS devices. |
| 571 | "iosDevices": [ # Required. A list of iOS devices. |
| 572 | { # A single iOS device. |
| 573 | "iosModelId": "A String", # Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 574 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 575 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 576 | "iosVersionId": "A String", # Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 577 | }, |
| 578 | ], |
| 579 | }, |
| 580 | "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. # A matrix of Android devices. |
| 581 | "locales": [ # Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 582 | "A String", |
| 583 | ], |
| 584 | "orientations": [ # Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options. |
| 585 | "A String", |
| 586 | ], |
| 587 | "androidModelIds": [ # Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 588 | "A String", |
| 589 | ], |
| 590 | "androidVersionIds": [ # Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 591 | "A String", |
| 592 | ], |
| 593 | }, |
| 594 | }, |
| 595 | "flakyTestAttempts": 42, # 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. |
| 596 | "clientInfo": { # Information about the client which invoked the test. # Information about the client which invoked the test. |
| 597 | "name": "A String", # Required. Client name, such as gcloud. |
| 598 | "clientInfoDetails": [ # The list of detailed information about client. |
| 599 | { # Key-value pair of detailed information about the client which invoked the test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}. |
| 600 | "key": "A String", # Required. The key of detailed client information. |
| 601 | "value": "A String", # Required. The value of detailed client information. |
| 602 | }, |
| 603 | ], |
| 604 | }, |
| 605 | } |
| 606 | |
| 607 | requestId: string, A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended. |
| 608 | x__xgafv: string, V1 error format. |
| 609 | Allowed values |
| 610 | 1 - v1 error format |
| 611 | 2 - v2 error format |
| 612 | |
| 613 | Returns: |
| 614 | An object of the form: |
| 615 | |
| 616 | { # TestMatrix captures all details about a test. It contains the environment configuration, test specification, test executions and overall state and outcome. |
| 617 | "testMatrixId": "A String", # Output only. Unique id set by the service. |
| 618 | "timestamp": "A String", # Output only. The time this test matrix was initially created. |
| 619 | "invalidMatrixDetails": "A String", # Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. |
| 620 | "state": "A String", # Output only. Indicates the current progress of the test matrix. |
| 621 | "testSpecification": { # A description of how to run the test. # Required. How to run the test. |
| 622 | "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. # An iOS XCTest, via an .xctestrun file. |
| 623 | "testSpecialEntitlements": True or False, # 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. |
| 624 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 625 | "xcodeVersion": "A 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. |
| 626 | "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip. |
| 627 | "gcsPath": "A 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) |
| 628 | }, |
| 629 | "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified. |
| 630 | "gcsPath": "A 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) |
| 631 | }, |
| 632 | }, |
| 633 | "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS. |
| 634 | "additionalIpas": [ # iOS apps to install in addition to those being directly tested. |
| 635 | { # A reference to a file, used for user inputs. |
| 636 | "gcsPath": "A 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) |
| 637 | }, |
| 638 | ], |
| 639 | "pullDirectories": [ # 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 (e.g. /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (e.g. /Documents) by specifying the bundle id. |
| 640 | { # A file or directory to install on the device before the test starts. |
| 641 | "bundleId": "A 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. |
| 642 | "content": { # A reference to a file, used for user inputs. # The source file |
| 643 | "gcsPath": "A 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) |
| 644 | }, |
| 645 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| 646 | }, |
| 647 | ], |
| 648 | "pushFiles": [ # List of files to push to the device before starting the test. |
| 649 | { # A file or directory to install on the device before the test starts. |
| 650 | "bundleId": "A 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. |
| 651 | "content": { # A reference to a file, used for user inputs. # The source file |
| 652 | "gcsPath": "A 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) |
| 653 | }, |
| 654 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| 655 | }, |
| 656 | ], |
| 657 | "networkProfile": "A 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. |
| 658 | }, |
| 659 | "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. Next tag: 30 # An Android robo test. |
| 660 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| 661 | "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue for the crawl. |
| 662 | "gcsPath": "A 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) |
| 663 | }, |
| 664 | "roboDirectives": [ # 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. |
| 665 | { # 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. |
| 666 | "inputText": "A 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. |
| 667 | "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. |
| 668 | "resourceName": "A 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 |
| 669 | }, |
| 670 | ], |
| 671 | "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. |
| 672 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 673 | "maxDepth": 42, # 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. |
| 674 | "startingIntents": [ # 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). |
| 675 | { # Message for specifying the start activities to crawl. |
| 676 | "timeout": "A String", # Timeout in seconds for each intent. |
| 677 | "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details. |
| 678 | "uri": "A String", # URI for the action. |
| 679 | "action": "A String", # Action name. Required for START_ACTIVITY. |
| 680 | "categories": [ # Intent categories to set on the intent. |
| 681 | "A String", |
| 682 | ], |
| 683 | }, |
| 684 | "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity. |
| 685 | }, |
| 686 | }, |
| 687 | ], |
| 688 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 689 | "gcsPath": "A 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) |
| 690 | }, |
| 691 | "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. # A multi-apk app bundle for the application under test. |
| 692 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 693 | "gcsPath": "A 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) |
| 694 | }, |
| 695 | }, |
| 696 | }, |
| 697 | "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency. |
| 698 | "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. # An Android Application with a Test Loop. |
| 699 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 700 | "gcsPath": "A 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) |
| 701 | }, |
| 702 | "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. # A multi-apk app bundle for the application under test. |
| 703 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 704 | "gcsPath": "A 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) |
| 705 | }, |
| 706 | }, |
| 707 | "appPackageId": "A String", # The java package for the application under test. The default is determined by examining the application's manifest. |
| 708 | "scenarioLabels": [ # 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. |
| 709 | "A String", |
| 710 | ], |
| 711 | "scenarios": [ # The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. |
| 712 | 42, |
| 713 | ], |
| 714 | }, |
| 715 | "testTimeout": "A String", # Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. |
| 716 | "disableVideoRecording": True or False, # Disables video recording. May reduce test latency. |
| 717 | "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. # An iOS application with a test loop. |
| 718 | "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test. |
| 719 | "gcsPath": "A 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) |
| 720 | }, |
| 721 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 722 | "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. |
| 723 | 42, |
| 724 | ], |
| 725 | }, |
| 726 | "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. # An Android instrumentation test. |
| 727 | "orchestratorOption": "A String", # 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.0 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. |
| 728 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. |
| 729 | "testPackageId": "A String", # The java package for the test to be executed. The default value is determined by examining the application's manifest. |
| 730 | "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed. |
| 731 | "gcsPath": "A 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) |
| 732 | }, |
| 733 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| 734 | "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel. |
| 735 | "uniformSharding": { # Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to "-e numShard" "-e shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid. # Uniformly shards test cases given a total number of shards. |
| 736 | "numShards": 42, # Required. Total number of shards. When any physical devices are selected, the number must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 737 | }, |
| 738 | "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. # Shards test cases into the specified groups of packages, classes, and/or methods. |
| 739 | "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 740 | { # Test targets for a shard. |
| 741 | "testTargets": [ # 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 shard_test_targets must be greater than 0. |
| 742 | "A String", |
| 743 | ], |
| 744 | }, |
| 745 | ], |
| 746 | }, |
| 747 | }, |
| 748 | "testTargets": [ # 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. |
| 749 | "A String", |
| 750 | ], |
| 751 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 752 | "gcsPath": "A 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) |
| 753 | }, |
| 754 | "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. # A multi-apk app bundle for the application under test. |
| 755 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 756 | "gcsPath": "A 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) |
| 757 | }, |
| 758 | }, |
| 759 | }, |
| 760 | "testSetup": { # A description of how to set up the Android device prior to running the test. # Test setup requirements for Android e.g. files to install, bootstrap scripts. |
| 761 | "systrace": { # Systrace configuration for the run. If set a systrace will be taken, starting on test start and lasting for the configured duration. The systrace file thus obtained is put in the results bucket together with the other artifacts from the run. |
| 762 | "durationSeconds": 42, # Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. |
| 763 | }, |
| 764 | "account": { # Identifies an account and how to log into it. # The device will be logged in on this account for the duration of the test. |
| 765 | "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. # An automatic google login account. |
| 766 | }, |
| 767 | }, |
| 768 | "dontAutograntPermissions": True or False, # Whether to prevent all runtime permissions to be granted at app install |
| 769 | "directoriesToPull": [ # 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. |
| 770 | "A String", |
| 771 | ], |
| 772 | "additionalApks": [ # APKs to install in addition to those being directly tested. Currently capped at 100. |
| 773 | { # An Android package file to install. |
| 774 | "packageName": "A String", # The java package for the APK to be installed. Value is determined by examining the application's manifest. |
| 775 | "location": { # A reference to a file, used for user inputs. # The path to an APK to be installed on the device before the test begins. |
| 776 | "gcsPath": "A 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) |
| 777 | }, |
| 778 | }, |
| 779 | ], |
| 780 | "filesToPush": [ # List of files to push to the device before starting the test. |
| 781 | { # A single device file description. |
| 782 | "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file. |
| 783 | "obbFileName": "A 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. |
| 784 | "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device. |
| 785 | "gcsPath": "A 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) |
| 786 | }, |
| 787 | }, |
| 788 | "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file. |
| 789 | "devicePath": "A 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, or /storage ${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. |
| 790 | "content": { # A reference to a file, used for user inputs. # Required. The source file. |
| 791 | "gcsPath": "A 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) |
| 792 | }, |
| 793 | }, |
| 794 | }, |
| 795 | ], |
| 796 | "networkProfile": "A 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. |
| 797 | "environmentVariables": [ # Environment variables to set for the test (only applicable for instrumentation tests). |
| 798 | { # A key-value pair passed as an environment variable to the test. |
| 799 | "value": "A String", # Value for the environment variable. |
| 800 | "key": "A String", # Key for the environment variable. |
| 801 | }, |
| 802 | ], |
| 803 | }, |
| 804 | }, |
| 805 | "outcomeSummary": "A String", # Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. |
| 806 | "failFast": True or False, # 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. |
| 807 | "testExecutions": [ # Output only. The list of test executions that the service creates for this matrix. |
| 808 | { # A single test executed in a single environment. |
| 809 | "projectId": "A String", # Output only. The cloud project that owns the test execution. |
| 810 | "id": "A String", # Output only. Unique id set by the service. |
| 811 | "environment": { # The environment in which the test is run. # Output only. How the host machine(s) are configured. |
| 812 | "iosDevice": { # A single iOS device. # An iOS device which must be used with an iOS test. |
| 813 | "iosModelId": "A String", # Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 814 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 815 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 816 | "iosVersionId": "A String", # Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 817 | }, |
| 818 | "androidDevice": { # A single Android device. # An Android device which must be used with an Android test. |
| 819 | "androidVersionId": "A String", # Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 820 | "androidModelId": "A String", # Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 821 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 822 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 823 | }, |
| 824 | }, |
| 825 | "testDetails": { # Additional details about the progress of the running test. # Output only. Additional details about the running test. |
| 826 | "errorMessage": "A String", # Output only. If the TestState is ERROR, then this string will contain human-readable details about the error. |
| 827 | "progressMessages": [ # 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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 828 | "A String", |
| 829 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 830 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 831 | "timestamp": "A String", # Output only. The time this test execution was initially created. |
| 832 | "state": "A String", # Output only. Indicates the current progress of the test execution (e.g., FINISHED). |
| 833 | "shard": { # Output only. Details about the shard. # Output only. Details about the shard. |
| 834 | "testTargetsForShard": { # Test targets for a shard. # Output only. Test targets for each shard. |
| 835 | "testTargets": [ # 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 shard_test_targets must be greater than 0. |
| 836 | "A String", |
| 837 | ], |
| 838 | }, |
| 839 | "numShards": 42, # Output only. The total number of shards. |
| 840 | "shardIndex": 42, # Output only. The index of the shard among all the shards. |
| 841 | }, |
| 842 | "matrixId": "A String", # Output only. Id of the containing TestMatrix. |
| 843 | "testSpecification": { # A description of how to run the test. # Output only. How to run the test. |
| 844 | "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. # An iOS XCTest, via an .xctestrun file. |
| 845 | "testSpecialEntitlements": True or False, # 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. |
| 846 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 847 | "xcodeVersion": "A 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. |
| 848 | "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip. |
| 849 | "gcsPath": "A 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) |
| 850 | }, |
| 851 | "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified. |
| 852 | "gcsPath": "A 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) |
| 853 | }, |
| 854 | }, |
| 855 | "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS. |
| 856 | "additionalIpas": [ # iOS apps to install in addition to those being directly tested. |
| 857 | { # A reference to a file, used for user inputs. |
| 858 | "gcsPath": "A 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) |
| 859 | }, |
| 860 | ], |
| 861 | "pullDirectories": [ # 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 (e.g. /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (e.g. /Documents) by specifying the bundle id. |
| 862 | { # A file or directory to install on the device before the test starts. |
| 863 | "bundleId": "A 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. |
| 864 | "content": { # A reference to a file, used for user inputs. # The source file |
| 865 | "gcsPath": "A 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) |
| 866 | }, |
| 867 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| 868 | }, |
| 869 | ], |
| 870 | "pushFiles": [ # List of files to push to the device before starting the test. |
| 871 | { # A file or directory to install on the device before the test starts. |
| 872 | "bundleId": "A 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. |
| 873 | "content": { # A reference to a file, used for user inputs. # The source file |
| 874 | "gcsPath": "A 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) |
| 875 | }, |
| 876 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| 877 | }, |
| 878 | ], |
| 879 | "networkProfile": "A 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. |
| 880 | }, |
| 881 | "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. Next tag: 30 # An Android robo test. |
| 882 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| 883 | "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue for the crawl. |
| 884 | "gcsPath": "A 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) |
| 885 | }, |
| 886 | "roboDirectives": [ # 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. |
| 887 | { # 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. |
| 888 | "inputText": "A 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. |
| 889 | "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. |
| 890 | "resourceName": "A 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 |
| 891 | }, |
| 892 | ], |
| 893 | "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. |
| 894 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 895 | "maxDepth": 42, # 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. |
| 896 | "startingIntents": [ # 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). |
| 897 | { # Message for specifying the start activities to crawl. |
| 898 | "timeout": "A String", # Timeout in seconds for each intent. |
| 899 | "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details. |
| 900 | "uri": "A String", # URI for the action. |
| 901 | "action": "A String", # Action name. Required for START_ACTIVITY. |
| 902 | "categories": [ # Intent categories to set on the intent. |
| 903 | "A String", |
| 904 | ], |
| 905 | }, |
| 906 | "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity. |
| 907 | }, |
| 908 | }, |
| 909 | ], |
| 910 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 911 | "gcsPath": "A 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) |
| 912 | }, |
| 913 | "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. # A multi-apk app bundle for the application under test. |
| 914 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 915 | "gcsPath": "A 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) |
| 916 | }, |
| 917 | }, |
| 918 | }, |
| 919 | "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency. |
| 920 | "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. # An Android Application with a Test Loop. |
| 921 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 922 | "gcsPath": "A 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) |
| 923 | }, |
| 924 | "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. # A multi-apk app bundle for the application under test. |
| 925 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 926 | "gcsPath": "A 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) |
| 927 | }, |
| 928 | }, |
| 929 | "appPackageId": "A String", # The java package for the application under test. The default is determined by examining the application's manifest. |
| 930 | "scenarioLabels": [ # 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. |
| 931 | "A String", |
| 932 | ], |
| 933 | "scenarios": [ # The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. |
| 934 | 42, |
| 935 | ], |
| 936 | }, |
| 937 | "testTimeout": "A String", # Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. |
| 938 | "disableVideoRecording": True or False, # Disables video recording. May reduce test latency. |
| 939 | "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. # An iOS application with a test loop. |
| 940 | "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test. |
| 941 | "gcsPath": "A 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) |
| 942 | }, |
| 943 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 944 | "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. |
| 945 | 42, |
| 946 | ], |
| 947 | }, |
| 948 | "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. # An Android instrumentation test. |
| 949 | "orchestratorOption": "A String", # 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.0 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. |
| 950 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. |
| 951 | "testPackageId": "A String", # The java package for the test to be executed. The default value is determined by examining the application's manifest. |
| 952 | "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed. |
| 953 | "gcsPath": "A 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) |
| 954 | }, |
| 955 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| 956 | "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel. |
| 957 | "uniformSharding": { # Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to "-e numShard" "-e shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid. # Uniformly shards test cases given a total number of shards. |
| 958 | "numShards": 42, # Required. Total number of shards. When any physical devices are selected, the number must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 959 | }, |
| 960 | "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. # Shards test cases into the specified groups of packages, classes, and/or methods. |
| 961 | "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 962 | { # Test targets for a shard. |
| 963 | "testTargets": [ # 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 shard_test_targets must be greater than 0. |
| 964 | "A String", |
| 965 | ], |
| 966 | }, |
| 967 | ], |
| 968 | }, |
| 969 | }, |
| 970 | "testTargets": [ # 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. |
| 971 | "A String", |
| 972 | ], |
| 973 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 974 | "gcsPath": "A 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) |
| 975 | }, |
| 976 | "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. # A multi-apk app bundle for the application under test. |
| 977 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 978 | "gcsPath": "A 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) |
| 979 | }, |
| 980 | }, |
| 981 | }, |
| 982 | "testSetup": { # A description of how to set up the Android device prior to running the test. # Test setup requirements for Android e.g. files to install, bootstrap scripts. |
| 983 | "systrace": { # Systrace configuration for the run. If set a systrace will be taken, starting on test start and lasting for the configured duration. The systrace file thus obtained is put in the results bucket together with the other artifacts from the run. |
| 984 | "durationSeconds": 42, # Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. |
| 985 | }, |
| 986 | "account": { # Identifies an account and how to log into it. # The device will be logged in on this account for the duration of the test. |
| 987 | "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. # An automatic google login account. |
| 988 | }, |
| 989 | }, |
| 990 | "dontAutograntPermissions": True or False, # Whether to prevent all runtime permissions to be granted at app install |
| 991 | "directoriesToPull": [ # 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. |
| 992 | "A String", |
| 993 | ], |
| 994 | "additionalApks": [ # APKs to install in addition to those being directly tested. Currently capped at 100. |
| 995 | { # An Android package file to install. |
| 996 | "packageName": "A String", # The java package for the APK to be installed. Value is determined by examining the application's manifest. |
| 997 | "location": { # A reference to a file, used for user inputs. # The path to an APK to be installed on the device before the test begins. |
| 998 | "gcsPath": "A 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) |
| 999 | }, |
| 1000 | }, |
| 1001 | ], |
| 1002 | "filesToPush": [ # List of files to push to the device before starting the test. |
| 1003 | { # A single device file description. |
| 1004 | "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file. |
| 1005 | "obbFileName": "A 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. |
| 1006 | "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device. |
| 1007 | "gcsPath": "A 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) |
| 1008 | }, |
| 1009 | }, |
| 1010 | "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file. |
| 1011 | "devicePath": "A 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, or /storage ${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. |
| 1012 | "content": { # A reference to a file, used for user inputs. # Required. The source file. |
| 1013 | "gcsPath": "A 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) |
| 1014 | }, |
| 1015 | }, |
| 1016 | }, |
| 1017 | ], |
| 1018 | "networkProfile": "A 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. |
| 1019 | "environmentVariables": [ # Environment variables to set for the test (only applicable for instrumentation tests). |
| 1020 | { # A key-value pair passed as an environment variable to the test. |
| 1021 | "value": "A String", # Value for the environment variable. |
| 1022 | "key": "A String", # Key for the environment variable. |
| 1023 | }, |
| 1024 | ], |
| 1025 | }, |
| 1026 | }, |
| 1027 | "toolResultsStep": { # Represents a tool results step resource. This has the results of a TestExecution. # Output only. Where the results for this execution are written. |
| 1028 | "executionId": "A String", # Output only. A tool results execution ID. |
| 1029 | "historyId": "A String", # Output only. A tool results history ID. |
| 1030 | "stepId": "A String", # Output only. A tool results step ID. |
| 1031 | "projectId": "A String", # Output only. The cloud project that owns the tool results step. |
| 1032 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1033 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1034 | ], |
| 1035 | "projectId": "A String", # The cloud project that owns the test matrix. |
| 1036 | "resultStorage": { # Locations where the results of running the test are stored. # Required. Where the results for the matrix are written. |
| 1037 | "toolResultsExecution": { # Represents a tool results execution resource. This has the results of a TestMatrix. # Output only. The tool results execution that results are written to. |
| 1038 | "historyId": "A String", # Output only. A tool results history ID. |
| 1039 | "executionId": "A String", # Output only. A tool results execution ID. |
| 1040 | "projectId": "A String", # Output only. The cloud project that owns the tool results execution. |
| 1041 | }, |
| 1042 | "googleCloudStorage": { # A storage location within Google cloud storage (GCS). # Required. |
| 1043 | "gcsPath": "A 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. |
| 1044 | }, |
| 1045 | "resultsUrl": "A String", # Output only. URL to the results in the Firebase Web Console. |
| 1046 | "toolResultsHistory": { # Represents a tool results history resource. # The tool results history that contains the tool results execution that results are written to. If not provided, the service will choose an appropriate value. |
| 1047 | "projectId": "A String", # Required. The cloud project that owns the tool results history. |
| 1048 | "historyId": "A String", # Required. A tool results history ID. |
| 1049 | }, |
| 1050 | }, |
| 1051 | "environmentMatrix": { # The matrix of environments in which the test is to be executed. # Required. The devices the tests are being executed on. |
| 1052 | "androidDeviceList": { # A list of Android device configurations in which the test is to be executed. # A list of Android devices; the test will be run only on the specified devices. |
| 1053 | "androidDevices": [ # Required. A list of Android devices. |
| 1054 | { # A single Android device. |
| 1055 | "androidVersionId": "A String", # Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1056 | "androidModelId": "A String", # Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1057 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1058 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1059 | }, |
| 1060 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1061 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1062 | "iosDeviceList": { # A list of iOS device configurations in which the test is to be executed. # A list of iOS devices. |
| 1063 | "iosDevices": [ # Required. A list of iOS devices. |
| 1064 | { # A single iOS device. |
| 1065 | "iosModelId": "A String", # Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1066 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1067 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1068 | "iosVersionId": "A String", # Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1069 | }, |
| 1070 | ], |
| 1071 | }, |
| 1072 | "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. # A matrix of Android devices. |
| 1073 | "locales": [ # Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1074 | "A String", |
| 1075 | ], |
| 1076 | "orientations": [ # Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1077 | "A String", |
| 1078 | ], |
| 1079 | "androidModelIds": [ # Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1080 | "A String", |
| 1081 | ], |
| 1082 | "androidVersionIds": [ # Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1083 | "A String", |
| 1084 | ], |
| 1085 | }, |
| 1086 | }, |
| 1087 | "flakyTestAttempts": 42, # 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. |
| 1088 | "clientInfo": { # Information about the client which invoked the test. # Information about the client which invoked the test. |
| 1089 | "name": "A String", # Required. Client name, such as gcloud. |
| 1090 | "clientInfoDetails": [ # The list of detailed information about client. |
| 1091 | { # Key-value pair of detailed information about the client which invoked the test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}. |
| 1092 | "key": "A String", # Required. The key of detailed client information. |
| 1093 | "value": "A String", # Required. The value of detailed client information. |
| 1094 | }, |
| 1095 | ], |
| 1096 | }, |
| 1097 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1098 | </div> |
| 1099 | |
| 1100 | <div class="method"> |
| 1101 | <code class="details" id="get">get(projectId, testMatrixId, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1102 | <pre>Checks the status of a test matrix. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1103 | |
| 1104 | Args: |
| 1105 | projectId: string, Cloud project that owns the test matrix. (required) |
| 1106 | testMatrixId: string, Unique test matrix id which was assigned by the service. (required) |
| 1107 | x__xgafv: string, V1 error format. |
| 1108 | Allowed values |
| 1109 | 1 - v1 error format |
| 1110 | 2 - v2 error format |
| 1111 | |
| 1112 | Returns: |
| 1113 | An object of the form: |
| 1114 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1115 | { # TestMatrix captures all details about a test. It contains the environment configuration, test specification, test executions and overall state and outcome. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1116 | "testMatrixId": "A String", # Output only. Unique id set by the service. |
| 1117 | "timestamp": "A String", # Output only. The time this test matrix was initially created. |
| 1118 | "invalidMatrixDetails": "A String", # Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. |
| 1119 | "state": "A String", # Output only. Indicates the current progress of the test matrix. |
| 1120 | "testSpecification": { # A description of how to run the test. # Required. How to run the test. |
| 1121 | "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. # An iOS XCTest, via an .xctestrun file. |
| 1122 | "testSpecialEntitlements": True or False, # 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. |
| 1123 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 1124 | "xcodeVersion": "A 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. |
| 1125 | "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip. |
| 1126 | "gcsPath": "A 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) |
| 1127 | }, |
| 1128 | "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified. |
| 1129 | "gcsPath": "A 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) |
| 1130 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1131 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1132 | "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS. |
| 1133 | "additionalIpas": [ # iOS apps to install in addition to those being directly tested. |
| 1134 | { # A reference to a file, used for user inputs. |
| 1135 | "gcsPath": "A 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) |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1136 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1137 | ], |
| 1138 | "pullDirectories": [ # 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 (e.g. /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (e.g. /Documents) by specifying the bundle id. |
| 1139 | { # A file or directory to install on the device before the test starts. |
| 1140 | "bundleId": "A 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. |
| 1141 | "content": { # A reference to a file, used for user inputs. # The source file |
| 1142 | "gcsPath": "A 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) |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1143 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1144 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| 1145 | }, |
| 1146 | ], |
| 1147 | "pushFiles": [ # List of files to push to the device before starting the test. |
| 1148 | { # A file or directory to install on the device before the test starts. |
| 1149 | "bundleId": "A 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. |
| 1150 | "content": { # A reference to a file, used for user inputs. # The source file |
| 1151 | "gcsPath": "A 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) |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1152 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1153 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| 1154 | }, |
| 1155 | ], |
| 1156 | "networkProfile": "A 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. |
| 1157 | }, |
| 1158 | "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. Next tag: 30 # An Android robo test. |
| 1159 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| 1160 | "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue for the crawl. |
| 1161 | "gcsPath": "A 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) |
| 1162 | }, |
| 1163 | "roboDirectives": [ # 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. |
| 1164 | { # 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. |
| 1165 | "inputText": "A 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. |
| 1166 | "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. |
| 1167 | "resourceName": "A 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 |
| 1168 | }, |
| 1169 | ], |
| 1170 | "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. |
| 1171 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 1172 | "maxDepth": 42, # 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. |
| 1173 | "startingIntents": [ # 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). |
| 1174 | { # Message for specifying the start activities to crawl. |
| 1175 | "timeout": "A String", # Timeout in seconds for each intent. |
| 1176 | "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details. |
| 1177 | "uri": "A String", # URI for the action. |
| 1178 | "action": "A String", # Action name. Required for START_ACTIVITY. |
| 1179 | "categories": [ # Intent categories to set on the intent. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1180 | "A String", |
| 1181 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1182 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1183 | "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1184 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1185 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1186 | ], |
| 1187 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 1188 | "gcsPath": "A 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) |
| 1189 | }, |
| 1190 | "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. # A multi-apk app bundle for the application under test. |
| 1191 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 1192 | "gcsPath": "A 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) |
| 1193 | }, |
| 1194 | }, |
| 1195 | }, |
| 1196 | "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency. |
| 1197 | "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. # An Android Application with a Test Loop. |
| 1198 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 1199 | "gcsPath": "A 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) |
| 1200 | }, |
| 1201 | "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. # A multi-apk app bundle for the application under test. |
| 1202 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 1203 | "gcsPath": "A 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) |
| 1204 | }, |
| 1205 | }, |
| 1206 | "appPackageId": "A String", # The java package for the application under test. The default is determined by examining the application's manifest. |
| 1207 | "scenarioLabels": [ # 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. |
| 1208 | "A String", |
| 1209 | ], |
| 1210 | "scenarios": [ # The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. |
| 1211 | 42, |
| 1212 | ], |
| 1213 | }, |
| 1214 | "testTimeout": "A String", # Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. |
| 1215 | "disableVideoRecording": True or False, # Disables video recording. May reduce test latency. |
| 1216 | "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. # An iOS application with a test loop. |
| 1217 | "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test. |
| 1218 | "gcsPath": "A 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) |
| 1219 | }, |
| 1220 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 1221 | "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. |
| 1222 | 42, |
| 1223 | ], |
| 1224 | }, |
| 1225 | "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. # An Android instrumentation test. |
| 1226 | "orchestratorOption": "A String", # 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.0 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. |
| 1227 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. |
| 1228 | "testPackageId": "A String", # The java package for the test to be executed. The default value is determined by examining the application's manifest. |
| 1229 | "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed. |
| 1230 | "gcsPath": "A 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) |
| 1231 | }, |
| 1232 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| 1233 | "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel. |
| 1234 | "uniformSharding": { # Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to "-e numShard" "-e shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid. # Uniformly shards test cases given a total number of shards. |
| 1235 | "numShards": 42, # Required. Total number of shards. When any physical devices are selected, the number must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 1236 | }, |
| 1237 | "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. # Shards test cases into the specified groups of packages, classes, and/or methods. |
| 1238 | "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 1239 | { # Test targets for a shard. |
| 1240 | "testTargets": [ # 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 shard_test_targets must be greater than 0. |
| 1241 | "A String", |
| 1242 | ], |
| 1243 | }, |
| 1244 | ], |
| 1245 | }, |
| 1246 | }, |
| 1247 | "testTargets": [ # 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. |
| 1248 | "A String", |
| 1249 | ], |
| 1250 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 1251 | "gcsPath": "A 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) |
| 1252 | }, |
| 1253 | "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. # A multi-apk app bundle for the application under test. |
| 1254 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 1255 | "gcsPath": "A 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) |
| 1256 | }, |
| 1257 | }, |
| 1258 | }, |
| 1259 | "testSetup": { # A description of how to set up the Android device prior to running the test. # Test setup requirements for Android e.g. files to install, bootstrap scripts. |
| 1260 | "systrace": { # Systrace configuration for the run. If set a systrace will be taken, starting on test start and lasting for the configured duration. The systrace file thus obtained is put in the results bucket together with the other artifacts from the run. |
| 1261 | "durationSeconds": 42, # Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. |
| 1262 | }, |
| 1263 | "account": { # Identifies an account and how to log into it. # The device will be logged in on this account for the duration of the test. |
| 1264 | "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. # An automatic google login account. |
| 1265 | }, |
| 1266 | }, |
| 1267 | "dontAutograntPermissions": True or False, # Whether to prevent all runtime permissions to be granted at app install |
| 1268 | "directoriesToPull": [ # 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. |
| 1269 | "A String", |
| 1270 | ], |
| 1271 | "additionalApks": [ # APKs to install in addition to those being directly tested. Currently capped at 100. |
| 1272 | { # An Android package file to install. |
| 1273 | "packageName": "A String", # The java package for the APK to be installed. Value is determined by examining the application's manifest. |
| 1274 | "location": { # A reference to a file, used for user inputs. # The path to an APK to be installed on the device before the test begins. |
| 1275 | "gcsPath": "A 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) |
| 1276 | }, |
| 1277 | }, |
| 1278 | ], |
| 1279 | "filesToPush": [ # List of files to push to the device before starting the test. |
| 1280 | { # A single device file description. |
| 1281 | "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file. |
| 1282 | "obbFileName": "A 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. |
| 1283 | "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device. |
| 1284 | "gcsPath": "A 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) |
| 1285 | }, |
| 1286 | }, |
| 1287 | "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file. |
| 1288 | "devicePath": "A 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, or /storage ${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. |
| 1289 | "content": { # A reference to a file, used for user inputs. # Required. The source file. |
| 1290 | "gcsPath": "A 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) |
| 1291 | }, |
| 1292 | }, |
| 1293 | }, |
| 1294 | ], |
| 1295 | "networkProfile": "A 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. |
| 1296 | "environmentVariables": [ # Environment variables to set for the test (only applicable for instrumentation tests). |
| 1297 | { # A key-value pair passed as an environment variable to the test. |
| 1298 | "value": "A String", # Value for the environment variable. |
| 1299 | "key": "A String", # Key for the environment variable. |
| 1300 | }, |
| 1301 | ], |
| 1302 | }, |
| 1303 | }, |
| 1304 | "outcomeSummary": "A String", # Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. |
| 1305 | "failFast": True or False, # 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. |
| 1306 | "testExecutions": [ # Output only. The list of test executions that the service creates for this matrix. |
| 1307 | { # A single test executed in a single environment. |
| 1308 | "projectId": "A String", # Output only. The cloud project that owns the test execution. |
| 1309 | "id": "A String", # Output only. Unique id set by the service. |
| 1310 | "environment": { # The environment in which the test is run. # Output only. How the host machine(s) are configured. |
| 1311 | "iosDevice": { # A single iOS device. # An iOS device which must be used with an iOS test. |
| 1312 | "iosModelId": "A String", # Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1313 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1314 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1315 | "iosVersionId": "A String", # Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1316 | }, |
| 1317 | "androidDevice": { # A single Android device. # An Android device which must be used with an Android test. |
| 1318 | "androidVersionId": "A String", # Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1319 | "androidModelId": "A String", # Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1320 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1321 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1322 | }, |
| 1323 | }, |
| 1324 | "testDetails": { # Additional details about the progress of the running test. # Output only. Additional details about the running test. |
| 1325 | "errorMessage": "A String", # Output only. If the TestState is ERROR, then this string will contain human-readable details about the error. |
| 1326 | "progressMessages": [ # 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. |
| 1327 | "A String", |
| 1328 | ], |
| 1329 | }, |
| 1330 | "timestamp": "A String", # Output only. The time this test execution was initially created. |
| 1331 | "state": "A String", # Output only. Indicates the current progress of the test execution (e.g., FINISHED). |
| 1332 | "shard": { # Output only. Details about the shard. # Output only. Details about the shard. |
| 1333 | "testTargetsForShard": { # Test targets for a shard. # Output only. Test targets for each shard. |
| 1334 | "testTargets": [ # 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 shard_test_targets must be greater than 0. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1335 | "A String", |
| 1336 | ], |
| 1337 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1338 | "numShards": 42, # Output only. The total number of shards. |
| 1339 | "shardIndex": 42, # Output only. The index of the shard among all the shards. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1340 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1341 | "matrixId": "A String", # Output only. Id of the containing TestMatrix. |
| 1342 | "testSpecification": { # A description of how to run the test. # Output only. How to run the test. |
| 1343 | "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. # An iOS XCTest, via an .xctestrun file. |
| 1344 | "testSpecialEntitlements": True or False, # 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. |
| 1345 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 1346 | "xcodeVersion": "A 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. |
| 1347 | "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1348 | "gcsPath": "A 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) |
| 1349 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1350 | "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1351 | "gcsPath": "A 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) |
| 1352 | }, |
| 1353 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1354 | "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS. |
| 1355 | "additionalIpas": [ # iOS apps to install in addition to those being directly tested. |
| 1356 | { # A reference to a file, used for user inputs. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1357 | "gcsPath": "A 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) |
| 1358 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1359 | ], |
| 1360 | "pullDirectories": [ # 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 (e.g. /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (e.g. /Documents) by specifying the bundle id. |
| 1361 | { # A file or directory to install on the device before the test starts. |
| 1362 | "bundleId": "A 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. |
| 1363 | "content": { # A reference to a file, used for user inputs. # The source file |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1364 | "gcsPath": "A 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) |
| 1365 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1366 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1367 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1368 | ], |
| 1369 | "pushFiles": [ # List of files to push to the device before starting the test. |
| 1370 | { # A file or directory to install on the device before the test starts. |
| 1371 | "bundleId": "A 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. |
| 1372 | "content": { # A reference to a file, used for user inputs. # The source file |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1373 | "gcsPath": "A 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) |
| 1374 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1375 | "devicePath": "A String", # Location of the file on the device, inside the app's sandboxed filesystem |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1376 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1377 | ], |
| 1378 | "networkProfile": "A 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. |
| 1379 | }, |
| 1380 | "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. Next tag: 30 # An Android robo test. |
| 1381 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| 1382 | "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue for the crawl. |
| 1383 | "gcsPath": "A 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) |
| 1384 | }, |
| 1385 | "roboDirectives": [ # 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. |
| 1386 | { # 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. |
| 1387 | "inputText": "A 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. |
| 1388 | "actionType": "A String", # Required. The type of action that Robo should perform on the specified element. |
| 1389 | "resourceName": "A 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 |
| 1390 | }, |
| 1391 | ], |
| 1392 | "maxSteps": 42, # The max number of steps Robo can execute. Default is no limit. |
| 1393 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 1394 | "maxDepth": 42, # 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. |
| 1395 | "startingIntents": [ # 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). |
| 1396 | { # Message for specifying the start activities to crawl. |
| 1397 | "timeout": "A String", # Timeout in seconds for each intent. |
| 1398 | "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details. |
| 1399 | "uri": "A String", # URI for the action. |
| 1400 | "action": "A String", # Action name. Required for START_ACTIVITY. |
| 1401 | "categories": [ # Intent categories to set on the intent. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1402 | "A String", |
| 1403 | ], |
| 1404 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1405 | "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity. |
| 1406 | }, |
| 1407 | }, |
| 1408 | ], |
| 1409 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1410 | "gcsPath": "A 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) |
| 1411 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1412 | "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. # A multi-apk app bundle for the application under test. |
| 1413 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 1414 | "gcsPath": "A 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) |
| 1415 | }, |
| 1416 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1417 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1418 | "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency. |
| 1419 | "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. # An Android Application with a Test Loop. |
| 1420 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 1421 | "gcsPath": "A 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) |
| 1422 | }, |
| 1423 | "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. # A multi-apk app bundle for the application under test. |
| 1424 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 1425 | "gcsPath": "A 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) |
| 1426 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1427 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1428 | "appPackageId": "A String", # The java package for the application under test. The default is determined by examining the application's manifest. |
| 1429 | "scenarioLabels": [ # 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. |
| 1430 | "A String", |
| 1431 | ], |
| 1432 | "scenarios": [ # The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. |
| 1433 | 42, |
| 1434 | ], |
| 1435 | }, |
| 1436 | "testTimeout": "A String", # Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. |
| 1437 | "disableVideoRecording": True or False, # Disables video recording. May reduce test latency. |
| 1438 | "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. # An iOS application with a test loop. |
| 1439 | "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test. |
| 1440 | "gcsPath": "A 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) |
| 1441 | }, |
| 1442 | "appBundleId": "A String", # Output only. The bundle id for the application under test. |
| 1443 | "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. |
| 1444 | 42, |
| 1445 | ], |
| 1446 | }, |
| 1447 | "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. # An Android instrumentation test. |
| 1448 | "orchestratorOption": "A String", # 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.0 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. |
| 1449 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. |
| 1450 | "testPackageId": "A String", # The java package for the test to be executed. The default value is determined by examining the application's manifest. |
| 1451 | "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed. |
| 1452 | "gcsPath": "A 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) |
| 1453 | }, |
| 1454 | "appPackageId": "A String", # The java package for the application under test. The default value is determined by examining the application's manifest. |
| 1455 | "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel. |
| 1456 | "uniformSharding": { # Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to "-e numShard" "-e shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid. # Uniformly shards test cases given a total number of shards. |
| 1457 | "numShards": 42, # Required. Total number of shards. When any physical devices are selected, the number must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 1458 | }, |
| 1459 | "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. # Shards test cases into the specified groups of packages, classes, and/or methods. |
| 1460 | "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500. |
| 1461 | { # Test targets for a shard. |
| 1462 | "testTargets": [ # 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 shard_test_targets must be greater than 0. |
| 1463 | "A String", |
| 1464 | ], |
| 1465 | }, |
| 1466 | ], |
| 1467 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1468 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1469 | "testTargets": [ # 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. |
| 1470 | "A String", |
| 1471 | ], |
| 1472 | "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test. |
| 1473 | "gcsPath": "A 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) |
| 1474 | }, |
| 1475 | "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. # A multi-apk app bundle for the application under test. |
| 1476 | "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test. |
| 1477 | "gcsPath": "A 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) |
| 1478 | }, |
| 1479 | }, |
| 1480 | }, |
| 1481 | "testSetup": { # A description of how to set up the Android device prior to running the test. # Test setup requirements for Android e.g. files to install, bootstrap scripts. |
| 1482 | "systrace": { # Systrace configuration for the run. If set a systrace will be taken, starting on test start and lasting for the configured duration. The systrace file thus obtained is put in the results bucket together with the other artifacts from the run. |
| 1483 | "durationSeconds": 42, # Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. |
| 1484 | }, |
| 1485 | "account": { # Identifies an account and how to log into it. # The device will be logged in on this account for the duration of the test. |
| 1486 | "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. # An automatic google login account. |
| 1487 | }, |
| 1488 | }, |
| 1489 | "dontAutograntPermissions": True or False, # Whether to prevent all runtime permissions to be granted at app install |
| 1490 | "directoriesToPull": [ # 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. |
| 1491 | "A String", |
| 1492 | ], |
| 1493 | "additionalApks": [ # APKs to install in addition to those being directly tested. Currently capped at 100. |
| 1494 | { # An Android package file to install. |
| 1495 | "packageName": "A String", # The java package for the APK to be installed. Value is determined by examining the application's manifest. |
| 1496 | "location": { # A reference to a file, used for user inputs. # The path to an APK to be installed on the device before the test begins. |
| 1497 | "gcsPath": "A 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) |
| 1498 | }, |
| 1499 | }, |
| 1500 | ], |
| 1501 | "filesToPush": [ # List of files to push to the device before starting the test. |
| 1502 | { # A single device file description. |
| 1503 | "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file. |
| 1504 | "obbFileName": "A 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. |
| 1505 | "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device. |
| 1506 | "gcsPath": "A 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) |
| 1507 | }, |
| 1508 | }, |
| 1509 | "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file. |
| 1510 | "devicePath": "A 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, or /storage ${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. |
| 1511 | "content": { # A reference to a file, used for user inputs. # Required. The source file. |
| 1512 | "gcsPath": "A 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) |
| 1513 | }, |
| 1514 | }, |
| 1515 | }, |
| 1516 | ], |
| 1517 | "networkProfile": "A 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. |
| 1518 | "environmentVariables": [ # Environment variables to set for the test (only applicable for instrumentation tests). |
| 1519 | { # A key-value pair passed as an environment variable to the test. |
| 1520 | "value": "A String", # Value for the environment variable. |
| 1521 | "key": "A String", # Key for the environment variable. |
| 1522 | }, |
| 1523 | ], |
| 1524 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1525 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1526 | "toolResultsStep": { # Represents a tool results step resource. This has the results of a TestExecution. # Output only. Where the results for this execution are written. |
| 1527 | "executionId": "A String", # Output only. A tool results execution ID. |
| 1528 | "historyId": "A String", # Output only. A tool results history ID. |
| 1529 | "stepId": "A String", # Output only. A tool results step ID. |
| 1530 | "projectId": "A String", # Output only. The cloud project that owns the tool results step. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1531 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1532 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1533 | ], |
| 1534 | "projectId": "A String", # The cloud project that owns the test matrix. |
| 1535 | "resultStorage": { # Locations where the results of running the test are stored. # Required. Where the results for the matrix are written. |
| 1536 | "toolResultsExecution": { # Represents a tool results execution resource. This has the results of a TestMatrix. # Output only. The tool results execution that results are written to. |
| 1537 | "historyId": "A String", # Output only. A tool results history ID. |
| 1538 | "executionId": "A String", # Output only. A tool results execution ID. |
| 1539 | "projectId": "A String", # Output only. The cloud project that owns the tool results execution. |
| 1540 | }, |
| 1541 | "googleCloudStorage": { # A storage location within Google cloud storage (GCS). # Required. |
| 1542 | "gcsPath": "A 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. |
| 1543 | }, |
| 1544 | "resultsUrl": "A String", # Output only. URL to the results in the Firebase Web Console. |
| 1545 | "toolResultsHistory": { # Represents a tool results history resource. # The tool results history that contains the tool results execution that results are written to. If not provided, the service will choose an appropriate value. |
| 1546 | "projectId": "A String", # Required. The cloud project that owns the tool results history. |
| 1547 | "historyId": "A String", # Required. A tool results history ID. |
| 1548 | }, |
| 1549 | }, |
| 1550 | "environmentMatrix": { # The matrix of environments in which the test is to be executed. # Required. The devices the tests are being executed on. |
| 1551 | "androidDeviceList": { # A list of Android device configurations in which the test is to be executed. # A list of Android devices; the test will be run only on the specified devices. |
| 1552 | "androidDevices": [ # Required. A list of Android devices. |
| 1553 | { # A single Android device. |
| 1554 | "androidVersionId": "A String", # Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1555 | "androidModelId": "A String", # Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1556 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1557 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1558 | }, |
| 1559 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1560 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame^] | 1561 | "iosDeviceList": { # A list of iOS device configurations in which the test is to be executed. # A list of iOS devices. |
| 1562 | "iosDevices": [ # Required. A list of iOS devices. |
| 1563 | { # A single iOS device. |
| 1564 | "iosModelId": "A String", # Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1565 | "locale": "A String", # Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1566 | "orientation": "A String", # Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1567 | "iosVersionId": "A String", # Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1568 | }, |
| 1569 | ], |
| 1570 | }, |
| 1571 | "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. # A matrix of Android devices. |
| 1572 | "locales": [ # Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1573 | "A String", |
| 1574 | ], |
| 1575 | "orientations": [ # Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1576 | "A String", |
| 1577 | ], |
| 1578 | "androidModelIds": [ # Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1579 | "A String", |
| 1580 | ], |
| 1581 | "androidVersionIds": [ # Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. |
| 1582 | "A String", |
| 1583 | ], |
| 1584 | }, |
| 1585 | }, |
| 1586 | "flakyTestAttempts": 42, # 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. |
| 1587 | "clientInfo": { # Information about the client which invoked the test. # Information about the client which invoked the test. |
| 1588 | "name": "A String", # Required. Client name, such as gcloud. |
| 1589 | "clientInfoDetails": [ # The list of detailed information about client. |
| 1590 | { # Key-value pair of detailed information about the client which invoked the test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}. |
| 1591 | "key": "A String", # Required. The key of detailed client information. |
| 1592 | "value": "A String", # Required. The value of detailed client information. |
| 1593 | }, |
| 1594 | ], |
| 1595 | }, |
| 1596 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1597 | </div> |
| 1598 | |
| 1599 | </body></html> |