Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / testing_v1.projects.testMatrices.html
blob: c5281db9456506ee068f61fc7f5cf3de601a67b1 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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>
79<p class="firstline">Cancels unfinished test executions in a test matrix.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#create">create(projectId, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Creates and runs a matrix of tests according to the given specifications.</p>
83<p class="toc_element">
84 <code><a href="#get">get(projectId, testMatrixId, x__xgafv=None)</a></code></p>
85<p class="firstline">Checks the status of a test matrix.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="cancel">cancel(projectId, testMatrixId, x__xgafv=None)</code>
89 <pre>Cancels unfinished test executions in a test matrix.
90This call returns immediately and cancellation proceeds asychronously.
91If the matrix is already final, this operation will have no effect.
92
93May return any of the following canonical error codes:
94
95- PERMISSION_DENIED - if the user is not authorized to read project
96- INVALID_ARGUMENT - if the request is malformed
97- NOT_FOUND - if the Test Matrix does not exist
98
99Args:
100 projectId: string, Cloud project that owns the test. (required)
101 testMatrixId: string, Test matrix that will be canceled. (required)
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107Returns:
108 An object of the form:
109
110 { # Response containing the current state of the specified test matrix.
111 "testState": "A String", # The current rolled-up state of the test matrix.
112 # If this state is already final, then the cancelation request will
113 # have no effect.
114 }</pre>
115</div>
116
117<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 <code class="details" id="create">create(projectId, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 <pre>Creates and runs a matrix of tests according to the given specifications.
120Unsupported environments will be returned in the state UNSUPPORTED.
121Matrices are limited to at most 200 supported executions.
122
123May return any of the following canonical error codes:
124
125- PERMISSION_DENIED - if the user is not authorized to write to project
126- INVALID_ARGUMENT - if the request is malformed or if the matrix expands
127 to more than 200 supported executions
128
129Args:
130 projectId: string, The GCE project under which this job will run. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]131 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 The object takes the form of:
133
134{ # TestMatrix captures all details about a test. It contains the environment
135 # configuration, test specification, test executions and overall state and
136 # outcome.
137 "clientInfo": { # Information about the client which invoked the test. # Information about the client which invoked the test.
138 "clientInfoDetails": [ # The list of detailed information about client.
139 { # Key-value pair of detailed information about the client which invoked the
140 # test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}.
141 "key": "A String", # Required. The key of detailed client information.
142 "value": "A String", # Required. The value of detailed client information.
143 },
144 ],
145 "name": "A String", # Required. Client name, such as gcloud.
146 },
147 "projectId": "A String", # The cloud project that owns the test matrix.
148 "resultStorage": { # Locations where the results of running the test are stored. # Required. Where the results for the matrix are written.
149 "toolResultsHistory": { # Represents a tool results history resource. # The tool results history that contains the tool results execution that
150 # results are written to.
151 #
152 # If not provided, the service will choose an appropriate value.
153 "projectId": "A String", # Required. The cloud project that owns the tool results history.
154 "historyId": "A String", # Required. A tool results history ID.
155 },
156 "googleCloudStorage": { # A storage location within Google cloud storage (GCS). # Required.
157 "gcsPath": "A String", # Required. The path to a directory in GCS that will
158 # eventually contain the results for this test.
159 # The requesting user must have write access on the bucket in the supplied
160 # path.
161 },
162 "toolResultsExecution": { # Represents a tool results execution resource. # Output only. The tool results execution that results are written to.
163 #
164 # This has the results of a TestMatrix.
165 "projectId": "A String", # Output only. The cloud project that owns the tool results execution.
166 "executionId": "A String", # Output only. A tool results execution ID.
167 "historyId": "A String", # Output only. A tool results history ID.
168 },
169 "resultsUrl": "A String", # Output only. URL to the results in the Firebase Web Console.
170 },
171 "flakyTestAttempts": 42, # The number of times a TestExecution should be re-attempted if one or more
172 # of its test cases fail for any reason.
173 # The maximum number of reruns allowed is 10.
174 #
175 # Default is 0, which implies no reruns.
176 "state": "A String", # Output only. Indicates the current progress of the test matrix.
177 "testExecutions": [ # Output only. The list of test executions that the service creates for
178 # this matrix.
179 { # A single test executed in a single environment.
180 "timestamp": "A String", # Output only. The time this test execution was initially created.
181 "matrixId": "A String", # Output only. Id of the containing TestMatrix.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]182 "shard": { # Output only. Details about the shard. # Output only. Details about the shard.
183 "numShards": 42, # Output only. The total number of shards.
184 "testTargetsForShard": { # Test targets for a shard. # Output only. Test targets for each shard.
185 "testTargets": [ # Group of packages, classes, and/or test methods to be run for each shard.
186 # The targets need to be specified in AndroidJUnitRunner argument format. For
187 # example, “package com.my.packages” “class com.my.package.MyClass”.
188 #
189 # The number of shard_test_targets must be greater than 0.
190 "A String",
191 ],
192 },
193 "shardIndex": 42, # Output only. The index of the shard among all the shards.
194 },
195 "id": "A String", # Output only. Unique id set by the service.
196 "environment": { # The environment in which the test is run. # Output only. How the host machine(s) are configured.
197 "iosDevice": { # A single iOS device. # An iOS device which must be used with an iOS test.
198 "locale": "A String", # Required. The locale the test device used for testing.
199 # Use the TestEnvironmentDiscoveryService to get supported options.
200 "iosVersionId": "A String", # Required. The id of the iOS major software version to be used.
201 # Use the TestEnvironmentDiscoveryService to get supported options.
202 "orientation": "A String", # Required. How the device is oriented during the test.
203 # Use the TestEnvironmentDiscoveryService to get supported options.
204 "iosModelId": "A String", # Required. The id of the iOS device to be used.
205 # Use the TestEnvironmentDiscoveryService to get supported options.
206 },
207 "androidDevice": { # A single Android device. # An Android device which must be used with an Android test.
208 "locale": "A String", # Required. The locale the test device used for testing.
209 # Use the TestEnvironmentDiscoveryService to get supported options.
210 "androidVersionId": "A String", # Required. The id of the Android OS version to be used.
211 # Use the TestEnvironmentDiscoveryService to get supported options.
212 "androidModelId": "A String", # Required. The id of the Android device to be used.
213 # Use the TestEnvironmentDiscoveryService to get supported options.
214 "orientation": "A String", # Required. How the device is oriented during the test.
215 # Use the TestEnvironmentDiscoveryService to get supported options.
216 },
217 },
218 "state": "A String", # Output only. Indicates the current progress of the test execution
219 # (e.g., FINISHED).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 "testSpecification": { # A description of how to run the test. # Output only. How to run the test.
221 "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS.
222 "networkProfile": "A String", # The network traffic profile used for running the test.
223 # Available network profiles can be queried by using the
224 # NETWORK_CONFIGURATION environment type when calling
225 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
226 },
227 "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest, via an .xctestrun file.
228 # Xcode supports the option to "build for testing", which generates an
229 # .xctestrun file that contains a test specification (arguments, test methods,
230 # etc). This test type accepts a zip file containing the .xctestrun file and
231 # the corresponding contents of the Build/Products directory that contains all
232 # the binaries needed to run the tests.
233 "xcodeVersion": "A String", # The Xcode version that should be used for the test.
234 # Use the TestEnvironmentDiscoveryService to get supported options.
235 # Defaults to the latest Xcode version Firebase Test Lab supports.
236 "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the
237 # tests zip. Because the .xctestrun file contains environment variables along
238 # with test methods to run and/or ignore, this can be useful for sharding
239 # tests. Default is taken from the tests zip.
240 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
241 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
242 },
243 "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the
244 # DerivedData/Build/Products directory.
245 # The .xctestrun file in this zip is ignored if the xctestrun field is
246 # specified.
247 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
248 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
249 },
250 "appBundleId": "A String", # Output only. The bundle id for the application under test.
251 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]252 "iosTestLoop": { # A test of an iOS application that implements one or more game loop scenarios. # An iOS application with a test loop.
253 # This test type accepts an archived application (.ipa file) and a list of
254 # integer scenarios that will be executed on the app sequentially.
255 "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the
256 # single scenario 0 if unspecified.
257 42,
258 ],
259 "appBundleId": "A String", # Output only. The bundle id for the application under test.
260 "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test.
261 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
262 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
263 },
264 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 "testTimeout": "A String", # Max time a test execution is allowed to run before it is
266 # automatically cancelled.
267 # The default value is 5 min.
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
269 # scripts.
270 "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.
271 "googleAuto": { # Enables automatic Google account login. # An automatic google login account.
272 # If set, the service automatically generates a Google test account and adds
273 # it to the device, before executing the test. Note that test accounts might be
274 # reused.
275 # Many applications show their full set of functionalities when an account is
276 # present on the device. Logging into the device with these generated accounts
277 # allows testing more functionalities.
278 },
279 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]280 "systrace": { # Systrace configuration for the run.
281 # If set a systrace will be taken, starting on test start and lasting for the
282 # configured duration. The systrace file thus obtained is put in the results
283 # bucket together with the other artifacts from the run.
284 "durationSeconds": 42, # Systrace duration in seconds.
285 # Should be between 1 and 30 seconds. 0 disables systrace.
286 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]287 "networkProfile": "A String", # The network traffic profile used for running the test.
288 # Available network profiles can be queried by using the
289 # NETWORK_CONFIGURATION environment type when calling
290 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
291 "directoriesToPull": [ # List of directories on the device to upload to GCS at the end of the test;
292 # they must be absolute paths under /sdcard or /data/local/tmp.
293 # Path names are restricted to characters a-z A-Z 0-9 _ - . + and /
294 #
295 # Note: The paths /sdcard and /data will be made available and treated as
296 # implicit path substitutions. E.g. if /sdcard on a particular device does
297 # not map to external storage, the system will replace it with the external
298 # storage path prefix for that device.
299 "A String",
300 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]301 "environmentVariables": [ # Environment variables to set for the test (only applicable for
302 # instrumentation tests).
303 { # A key-value pair passed as an environment variable to the test.
304 "key": "A String", # Key for the environment variable.
305 "value": "A String", # Value for the environment variable.
306 },
307 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308 "filesToPush": [ # List of files to push to the device before starting the test.
309 { # A single device file description.
310 "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file.
311 "content": { # A reference to a file, used for user inputs. # Required. The source file.
312 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
313 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
314 },
315 "devicePath": "A String", # Required. Where to put the content on the device. Must be an absolute,
316 # whitelisted path. If the file exists, it will be replaced.
317 # The following device-side directories and any of their subdirectories are
318 # whitelisted:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]319 # &lt;p&gt;${EXTERNAL_STORAGE}, or /sdcard&lt;/p&gt;
320 # &lt;p&gt;${ANDROID_DATA}/local/tmp, or /data/local/tmp&lt;/p&gt;
321 # &lt;p&gt;Specifying a path outside of these directory trees is invalid.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]322 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]323 # &lt;p&gt; The paths /sdcard and /data will be made available and treated as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 # implicit path substitutions. E.g. if /sdcard on a particular device does
325 # not map to external storage, the system will replace it with the external
326 # storage path prefix for that device and copy the file there.
327 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]328 # &lt;p&gt; It is strongly advised to use the &lt;a href=
329 # "http://developer.android.com/reference/android/os/Environment.html"&gt;
330 # Environment API&lt;/a&gt; in app and test code to access files on the device in a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331 # portable way.
332 },
333 "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file.
334 "obbFileName": "A String", # Required. OBB file name which must conform to the format as specified by
335 # Android
336 # e.g. [main|patch].0300110.com.example.android.obb
337 # which will be installed into
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]338 # \&lt;shared-storage\&gt;/Android/obb/\&lt;package-name\&gt;/
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]339 # on the device.
340 "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device.
341 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
342 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
343 },
344 },
345 },
346 ],
347 "additionalApks": [ # APKs to install in addition to those being directly tested.
348 # Currently capped at 100.
349 { # An Android package file to install.
350 "packageName": "A String", # The java package for the APK to be installed.
351 # Value is determined by examining the application's manifest.
352 "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.
353 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
354 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
355 },
356 },
357 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]358 },
359 "disableVideoRecording": True or False, # Disables video recording. May reduce test latency.
360 "androidTestLoop": { # A test of an Android Application with a Test Loop. # An Android Application with a Test Loop.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]361 # The intent \&lt;intent-name\&gt; will be implicitly added, since Games is the only
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]362 # user of this api, for the time being.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]363 "scenarios": [ # The list of scenarios that should be run during the test.
364 # The default is all test loops, derived from the application's
365 # manifest.
366 42,
367 ],
368 "appPackageId": "A String", # The java package for the application under test.
369 # The default is determined by examining the application's manifest.
370 "scenarioLabels": [ # The list of scenario labels that should be run during the test.
371 # The scenario labels should map to labels defined in the application's
372 # manifest. For example, player_experience and
373 # com.google.test.loops.player_experience add all of the loops labeled in the
374 # manifest with the com.google.test.loops.player_experience name to the
375 # execution.
376 # Scenarios can also be specified in the scenarios field.
377 "A String",
378 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]379 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
380 # a base module directory, zero or more dynamic feature module directories.
381 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
382 # building App Bundles.
383 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
384 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
385 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
386 },
387 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]388 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
389 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
390 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
391 },
392 },
393 "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency.
394 "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test.
395 # or physical Android Device, finding culprits and crashes as it goes.
396 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
397 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]398 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399 # building App Bundles.
400 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
401 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
402 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
403 },
404 },
405 "roboDirectives": [ # A set of directives Robo should apply during the crawl.
406 # This allows users to customize the crawl. For example, the username and
407 # password for a test account can be provided.
408 { # Directs Robo to interact with a specific UI element if it is encountered
409 # during the crawl. Currently, Robo can perform text entry or element click.
410 "inputText": "A String", # The text that Robo is directed to set. If left empty, the directive will be
411 # treated as a CLICK on the element matching the resource_name.
412 "resourceName": "A String", # Required. The android resource name of the target UI element.
413 # For example,
414 # in Java: R.string.foo
415 # in xml: @string/foo
416 # Only the "foo" part is needed.
417 # Reference doc:
418 # https://developer.android.com/guide/topics/resources/accessing-resources.html
419 "actionType": "A String", # Required. The type of action that Robo should perform on the specified
420 # element.
421 },
422 ],
423 "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue
424 # for the crawl.
425 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
426 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
427 },
428 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
429 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
430 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
431 },
432 "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least
433 # 2 to make Robo explore the app beyond the first activity.
434 # Default is 50.
435 "startingIntents": [ # The intents used to launch the app for the crawl.
436 # If none are provided, then the main launcher activity is launched.
437 # If some are provided, then only those provided are launched (the main
438 # launcher activity must be provided explicitly).
439 { # Message for specifying the start activities to crawl.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]440 "timeout": "A String", # Timeout in seconds for each intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]441 "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details.
442 "action": "A String", # Action name.
443 # Required for START_ACTIVITY.
444 "uri": "A String", # URI for the action.
445 "categories": [ # Intent categories to set on the intent.
446 "A String",
447 ],
448 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449 "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity.
450 },
451 },
452 ],
453 "maxSteps": 42, # The max number of steps Robo can execute.
454 # Default is no limit.
455 "appPackageId": "A String", # The java package for the application under test.
456 # The default value is determined by examining the application's manifest.
457 "appInitialActivity": "A String", # The initial activity that should be used to start the app.
458 },
459 "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test.
460 # independently of its normal lifecycle.
461 # Android instrumentation tests run an application APK and test APK inside the
462 # same process on a virtual or physical AndroidDevice. They also specify
463 # a test runner class, such as com.google.GoogleTestRunner, which can vary
464 # on the specific instrumentation framework chosen.
465 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]466 # See &lt;http://developer.android.com/tools/testing/testing_android.html&gt; for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]467 # more information on types of Android tests.
468 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
469 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]470 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]471 # building App Bundles.
472 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
473 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
474 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
475 },
476 },
477 "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed.
478 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
479 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
480 },
481 "testRunnerClass": "A String", # The InstrumentationTestRunner class.
482 # The default value is determined by examining the application's manifest.
483 "testPackageId": "A String", # The java package for the test to be executed.
484 # The default value is determined by examining the application's manifest.
485 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
486 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
487 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
488 },
489 "appPackageId": "A String", # The java package for the application under test.
490 # The default value is determined by examining the application's manifest.
491 "orchestratorOption": "A String", # The option of whether running each test within its own invocation of
492 # instrumentation with Android Test Orchestrator or not.
493 # ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or
494 # higher! **
495 # Orchestrator offers the following benefits:
496 # - No shared state
497 # - Crashes are isolated
498 # - Logs are scoped per test
499 #
500 # See
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]501 # &lt;https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]502 # for more information about Android Test Orchestrator.
503 #
504 # If not set, the test will be run without the orchestrator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]505 "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel.
506 "manualSharding": { # Shards test cases into the specified groups of packages, classes, and/or # Shards test cases into the specified groups of packages, classes, and/or
507 # methods.
508 # methods.
509 #
510 # With manual sharding enabled, specifying test targets via
511 # environment_variables or in InstrumentationTest is invalid.
512 "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for
513 # each shard. The number of shard_test_targets must be &gt;= 1 and &lt;= 50.
514 { # Test targets for a shard.
515 "testTargets": [ # Group of packages, classes, and/or test methods to be run for each shard.
516 # The targets need to be specified in AndroidJUnitRunner argument format. For
517 # example, “package com.my.packages” “class com.my.package.MyClass”.
518 #
519 # The number of shard_test_targets must be greater than 0.
520 "A String",
521 ],
522 },
523 ],
524 },
525 "uniformSharding": { # Uniformly shards test cases given a total number of shards. # Uniformly shards test cases given a total number of shards.
526 #
527 # For Instrumentation test, it will be translated to “-e numShard” “-e
528 # shardIndex” AndroidJUnitRunner arguments. With uniform sharding enabled,
529 # specifying these sharding arguments via environment_variables is invalid.
530 "numShards": 42, # Required. Total number of shards. The number must be &gt;= 1 and &lt;= 50.
531 },
532 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]533 "testTargets": [ # Each target must be fully qualified with the package name or class name,
534 # in one of these formats:
535 # - "package package_name"
536 # - "class package_name.class_name"
537 # - "class package_name.class_name#method_name"
538 #
539 # If empty, all targets in the module will be run.
540 "A String",
541 ],
542 },
543 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]544 "projectId": "A String", # Output only. The cloud project that owns the test execution.
545 "toolResultsStep": { # Represents a tool results step resource. # Output only. Where the results for this execution are written.
546 #
547 # This has the results of a TestExecution.
548 "projectId": "A String", # Output only. The cloud project that owns the tool results step.
549 "executionId": "A String", # Output only. A tool results execution ID.
550 "stepId": "A String", # Output only. A tool results step ID.
551 "historyId": "A String", # Output only. A tool results history ID.
552 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]553 "testDetails": { # Additional details about the progress of the running test. # Output only. Additional details about the running test.
554 "progressMessages": [ # Output only. Human-readable, detailed descriptions of the test's progress.
555 # For example: "Provisioning a device", "Starting Test".
556 #
557 # During the course of execution new data may be appended
558 # to the end of progress_messages.
559 "A String",
560 ],
561 "errorMessage": "A String", # Output only. If the TestState is ERROR, then this string will contain
562 # human-readable details about the error.
563 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]564 },
565 ],
566 "testSpecification": { # A description of how to run the test. # Required. How to run the test.
567 "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS.
568 "networkProfile": "A String", # The network traffic profile used for running the test.
569 # Available network profiles can be queried by using the
570 # NETWORK_CONFIGURATION environment type when calling
571 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
572 },
573 "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest, via an .xctestrun file.
574 # Xcode supports the option to "build for testing", which generates an
575 # .xctestrun file that contains a test specification (arguments, test methods,
576 # etc). This test type accepts a zip file containing the .xctestrun file and
577 # the corresponding contents of the Build/Products directory that contains all
578 # the binaries needed to run the tests.
579 "xcodeVersion": "A String", # The Xcode version that should be used for the test.
580 # Use the TestEnvironmentDiscoveryService to get supported options.
581 # Defaults to the latest Xcode version Firebase Test Lab supports.
582 "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the
583 # tests zip. Because the .xctestrun file contains environment variables along
584 # with test methods to run and/or ignore, this can be useful for sharding
585 # tests. Default is taken from the tests zip.
586 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
587 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
588 },
589 "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the
590 # DerivedData/Build/Products directory.
591 # The .xctestrun file in this zip is ignored if the xctestrun field is
592 # specified.
593 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
594 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
595 },
596 "appBundleId": "A String", # Output only. The bundle id for the application under test.
597 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]598 "iosTestLoop": { # A test of an iOS application that implements one or more game loop scenarios. # An iOS application with a test loop.
599 # This test type accepts an archived application (.ipa file) and a list of
600 # integer scenarios that will be executed on the app sequentially.
601 "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the
602 # single scenario 0 if unspecified.
603 42,
604 ],
605 "appBundleId": "A String", # Output only. The bundle id for the application under test.
606 "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test.
607 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
608 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
609 },
610 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]611 "testTimeout": "A String", # Max time a test execution is allowed to run before it is
612 # automatically cancelled.
613 # The default value is 5 min.
614 "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
615 # scripts.
616 "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.
617 "googleAuto": { # Enables automatic Google account login. # An automatic google login account.
618 # If set, the service automatically generates a Google test account and adds
619 # it to the device, before executing the test. Note that test accounts might be
620 # reused.
621 # Many applications show their full set of functionalities when an account is
622 # present on the device. Logging into the device with these generated accounts
623 # allows testing more functionalities.
624 },
625 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]626 "systrace": { # Systrace configuration for the run.
627 # If set a systrace will be taken, starting on test start and lasting for the
628 # configured duration. The systrace file thus obtained is put in the results
629 # bucket together with the other artifacts from the run.
630 "durationSeconds": 42, # Systrace duration in seconds.
631 # Should be between 1 and 30 seconds. 0 disables systrace.
632 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]633 "networkProfile": "A String", # The network traffic profile used for running the test.
634 # Available network profiles can be queried by using the
635 # NETWORK_CONFIGURATION environment type when calling
636 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
637 "directoriesToPull": [ # List of directories on the device to upload to GCS at the end of the test;
638 # they must be absolute paths under /sdcard or /data/local/tmp.
639 # Path names are restricted to characters a-z A-Z 0-9 _ - . + and /
640 #
641 # Note: The paths /sdcard and /data will be made available and treated as
642 # implicit path substitutions. E.g. if /sdcard on a particular device does
643 # not map to external storage, the system will replace it with the external
644 # storage path prefix for that device.
645 "A String",
646 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]647 "environmentVariables": [ # Environment variables to set for the test (only applicable for
648 # instrumentation tests).
649 { # A key-value pair passed as an environment variable to the test.
650 "key": "A String", # Key for the environment variable.
651 "value": "A String", # Value for the environment variable.
652 },
653 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]654 "filesToPush": [ # List of files to push to the device before starting the test.
655 { # A single device file description.
656 "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file.
657 "content": { # A reference to a file, used for user inputs. # Required. The source file.
658 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
659 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
660 },
661 "devicePath": "A String", # Required. Where to put the content on the device. Must be an absolute,
662 # whitelisted path. If the file exists, it will be replaced.
663 # The following device-side directories and any of their subdirectories are
664 # whitelisted:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]665 # &lt;p&gt;${EXTERNAL_STORAGE}, or /sdcard&lt;/p&gt;
666 # &lt;p&gt;${ANDROID_DATA}/local/tmp, or /data/local/tmp&lt;/p&gt;
667 # &lt;p&gt;Specifying a path outside of these directory trees is invalid.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]668 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]669 # &lt;p&gt; The paths /sdcard and /data will be made available and treated as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]670 # implicit path substitutions. E.g. if /sdcard on a particular device does
671 # not map to external storage, the system will replace it with the external
672 # storage path prefix for that device and copy the file there.
673 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]674 # &lt;p&gt; It is strongly advised to use the &lt;a href=
675 # "http://developer.android.com/reference/android/os/Environment.html"&gt;
676 # Environment API&lt;/a&gt; in app and test code to access files on the device in a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]677 # portable way.
678 },
679 "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file.
680 "obbFileName": "A String", # Required. OBB file name which must conform to the format as specified by
681 # Android
682 # e.g. [main|patch].0300110.com.example.android.obb
683 # which will be installed into
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]684 # \&lt;shared-storage\&gt;/Android/obb/\&lt;package-name\&gt;/
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]685 # on the device.
686 "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device.
687 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
688 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
689 },
690 },
691 },
692 ],
693 "additionalApks": [ # APKs to install in addition to those being directly tested.
694 # Currently capped at 100.
695 { # An Android package file to install.
696 "packageName": "A String", # The java package for the APK to be installed.
697 # Value is determined by examining the application's manifest.
698 "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.
699 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
700 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
701 },
702 },
703 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]704 },
705 "disableVideoRecording": True or False, # Disables video recording. May reduce test latency.
706 "androidTestLoop": { # A test of an Android Application with a Test Loop. # An Android Application with a Test Loop.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]707 # The intent \&lt;intent-name\&gt; will be implicitly added, since Games is the only
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]708 # user of this api, for the time being.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]709 "scenarios": [ # The list of scenarios that should be run during the test.
710 # The default is all test loops, derived from the application's
711 # manifest.
712 42,
713 ],
714 "appPackageId": "A String", # The java package for the application under test.
715 # The default is determined by examining the application's manifest.
716 "scenarioLabels": [ # The list of scenario labels that should be run during the test.
717 # The scenario labels should map to labels defined in the application's
718 # manifest. For example, player_experience and
719 # com.google.test.loops.player_experience add all of the loops labeled in the
720 # manifest with the com.google.test.loops.player_experience name to the
721 # execution.
722 # Scenarios can also be specified in the scenarios field.
723 "A String",
724 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]725 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
726 # a base module directory, zero or more dynamic feature module directories.
727 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
728 # building App Bundles.
729 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
730 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
731 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
732 },
733 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]734 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
735 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
736 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
737 },
738 },
739 "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency.
740 "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test.
741 # or physical Android Device, finding culprits and crashes as it goes.
742 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
743 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]744 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]745 # building App Bundles.
746 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
747 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
748 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
749 },
750 },
751 "roboDirectives": [ # A set of directives Robo should apply during the crawl.
752 # This allows users to customize the crawl. For example, the username and
753 # password for a test account can be provided.
754 { # Directs Robo to interact with a specific UI element if it is encountered
755 # during the crawl. Currently, Robo can perform text entry or element click.
756 "inputText": "A String", # The text that Robo is directed to set. If left empty, the directive will be
757 # treated as a CLICK on the element matching the resource_name.
758 "resourceName": "A String", # Required. The android resource name of the target UI element.
759 # For example,
760 # in Java: R.string.foo
761 # in xml: @string/foo
762 # Only the "foo" part is needed.
763 # Reference doc:
764 # https://developer.android.com/guide/topics/resources/accessing-resources.html
765 "actionType": "A String", # Required. The type of action that Robo should perform on the specified
766 # element.
767 },
768 ],
769 "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue
770 # for the crawl.
771 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
772 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
773 },
774 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
775 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
776 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
777 },
778 "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least
779 # 2 to make Robo explore the app beyond the first activity.
780 # Default is 50.
781 "startingIntents": [ # The intents used to launch the app for the crawl.
782 # If none are provided, then the main launcher activity is launched.
783 # If some are provided, then only those provided are launched (the main
784 # launcher activity must be provided explicitly).
785 { # Message for specifying the start activities to crawl.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]786 "timeout": "A String", # Timeout in seconds for each intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]787 "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details.
788 "action": "A String", # Action name.
789 # Required for START_ACTIVITY.
790 "uri": "A String", # URI for the action.
791 "categories": [ # Intent categories to set on the intent.
792 "A String",
793 ],
794 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]795 "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity.
796 },
797 },
798 ],
799 "maxSteps": 42, # The max number of steps Robo can execute.
800 # Default is no limit.
801 "appPackageId": "A String", # The java package for the application under test.
802 # The default value is determined by examining the application's manifest.
803 "appInitialActivity": "A String", # The initial activity that should be used to start the app.
804 },
805 "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test.
806 # independently of its normal lifecycle.
807 # Android instrumentation tests run an application APK and test APK inside the
808 # same process on a virtual or physical AndroidDevice. They also specify
809 # a test runner class, such as com.google.GoogleTestRunner, which can vary
810 # on the specific instrumentation framework chosen.
811 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]812 # See &lt;http://developer.android.com/tools/testing/testing_android.html&gt; for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]813 # more information on types of Android tests.
814 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
815 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]816 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]817 # building App Bundles.
818 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
819 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
820 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
821 },
822 },
823 "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed.
824 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
825 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
826 },
827 "testRunnerClass": "A String", # The InstrumentationTestRunner class.
828 # The default value is determined by examining the application's manifest.
829 "testPackageId": "A String", # The java package for the test to be executed.
830 # The default value is determined by examining the application's manifest.
831 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
832 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
833 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
834 },
835 "appPackageId": "A String", # The java package for the application under test.
836 # The default value is determined by examining the application's manifest.
837 "orchestratorOption": "A String", # The option of whether running each test within its own invocation of
838 # instrumentation with Android Test Orchestrator or not.
839 # ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or
840 # higher! **
841 # Orchestrator offers the following benefits:
842 # - No shared state
843 # - Crashes are isolated
844 # - Logs are scoped per test
845 #
846 # See
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]847 # &lt;https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]848 # for more information about Android Test Orchestrator.
849 #
850 # If not set, the test will be run without the orchestrator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]851 "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel.
852 "manualSharding": { # Shards test cases into the specified groups of packages, classes, and/or # Shards test cases into the specified groups of packages, classes, and/or
853 # methods.
854 # methods.
855 #
856 # With manual sharding enabled, specifying test targets via
857 # environment_variables or in InstrumentationTest is invalid.
858 "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for
859 # each shard. The number of shard_test_targets must be &gt;= 1 and &lt;= 50.
860 { # Test targets for a shard.
861 "testTargets": [ # Group of packages, classes, and/or test methods to be run for each shard.
862 # The targets need to be specified in AndroidJUnitRunner argument format. For
863 # example, “package com.my.packages” “class com.my.package.MyClass”.
864 #
865 # The number of shard_test_targets must be greater than 0.
866 "A String",
867 ],
868 },
869 ],
870 },
871 "uniformSharding": { # Uniformly shards test cases given a total number of shards. # Uniformly shards test cases given a total number of shards.
872 #
873 # For Instrumentation test, it will be translated to “-e numShard” “-e
874 # shardIndex” AndroidJUnitRunner arguments. With uniform sharding enabled,
875 # specifying these sharding arguments via environment_variables is invalid.
876 "numShards": 42, # Required. Total number of shards. The number must be &gt;= 1 and &lt;= 50.
877 },
878 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]879 "testTargets": [ # Each target must be fully qualified with the package name or class name,
880 # in one of these formats:
881 # - "package package_name"
882 # - "class package_name.class_name"
883 # - "class package_name.class_name#method_name"
884 #
885 # If empty, all targets in the module will be run.
886 "A String",
887 ],
888 },
889 },
890 "testMatrixId": "A String", # Output only. Unique id set by the service.
891 "timestamp": "A String", # Output only. The time this test matrix was initially created.
892 "invalidMatrixDetails": "A String", # Output only. Describes why the matrix is considered invalid.
893 # Only useful for matrices in the INVALID state.
894 "environmentMatrix": { # The matrix of environments in which the test is to be executed. # Required. The devices the tests are being executed on.
895 "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
896 # devices.
897 "androidDevices": [ # Required. A list of Android devices.
898 { # A single Android device.
899 "locale": "A String", # Required. The locale the test device used for testing.
900 # Use the TestEnvironmentDiscoveryService to get supported options.
901 "androidVersionId": "A String", # Required. The id of the Android OS version to be used.
902 # Use the TestEnvironmentDiscoveryService to get supported options.
903 "androidModelId": "A String", # Required. The id of the Android device to be used.
904 # Use the TestEnvironmentDiscoveryService to get supported options.
905 "orientation": "A String", # Required. How the device is oriented during the test.
906 # Use the TestEnvironmentDiscoveryService to get supported options.
907 },
908 ],
909 },
910 "androidMatrix": { # A set of Android device configuration permutations is defined by the # A matrix of Android devices.
911 # the cross-product of the given axes. Internally, the given AndroidMatrix
912 # will be expanded into a set of AndroidDevices.
913 #
914 # Only supported permutations will be instantiated. Invalid permutations
915 # (e.g., incompatible models/versions) are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]916 "orientations": [ # Required. The set of orientations to test with.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]917 # Use the TestEnvironmentDiscoveryService to get supported options.
918 "A String",
919 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]920 "locales": [ # Required. The set of locales the test device will enable for testing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]921 # Use the TestEnvironmentDiscoveryService to get supported options.
922 "A String",
923 ],
924 "androidVersionIds": [ # Required. The ids of the set of Android OS version to be used.
925 # Use the TestEnvironmentDiscoveryService to get supported options.
926 "A String",
927 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]928 "androidModelIds": [ # Required. The ids of the set of Android device to be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]929 # Use the TestEnvironmentDiscoveryService to get supported options.
930 "A String",
931 ],
932 },
933 "iosDeviceList": { # A list of iOS device configurations in which the test is to be executed. # A list of iOS devices.
934 "iosDevices": [ # Required. A list of iOS devices.
935 { # A single iOS device.
936 "locale": "A String", # Required. The locale the test device used for testing.
937 # Use the TestEnvironmentDiscoveryService to get supported options.
938 "iosVersionId": "A String", # Required. The id of the iOS major software version to be used.
939 # Use the TestEnvironmentDiscoveryService to get supported options.
940 "orientation": "A String", # Required. How the device is oriented during the test.
941 # Use the TestEnvironmentDiscoveryService to get supported options.
942 "iosModelId": "A String", # Required. The id of the iOS device to be used.
943 # Use the TestEnvironmentDiscoveryService to get supported options.
944 },
945 ],
946 },
947 },
948 "outcomeSummary": "A String", # Output Only. The overall outcome of the test.
949 # Only set when the test matrix state is FINISHED.
950 }
951
952 requestId: string, A string id used to detect duplicated requests.
953Ids are automatically scoped to a project, so
954users should ensure the ID is unique per-project.
955A UUID is recommended.
956
957Optional, but strongly recommended.
958 x__xgafv: string, V1 error format.
959 Allowed values
960 1 - v1 error format
961 2 - v2 error format
962
963Returns:
964 An object of the form:
965
966 { # TestMatrix captures all details about a test. It contains the environment
967 # configuration, test specification, test executions and overall state and
968 # outcome.
969 "clientInfo": { # Information about the client which invoked the test. # Information about the client which invoked the test.
970 "clientInfoDetails": [ # The list of detailed information about client.
971 { # Key-value pair of detailed information about the client which invoked the
972 # test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}.
973 "key": "A String", # Required. The key of detailed client information.
974 "value": "A String", # Required. The value of detailed client information.
975 },
976 ],
977 "name": "A String", # Required. Client name, such as gcloud.
978 },
979 "projectId": "A String", # The cloud project that owns the test matrix.
980 "resultStorage": { # Locations where the results of running the test are stored. # Required. Where the results for the matrix are written.
981 "toolResultsHistory": { # Represents a tool results history resource. # The tool results history that contains the tool results execution that
982 # results are written to.
983 #
984 # If not provided, the service will choose an appropriate value.
985 "projectId": "A String", # Required. The cloud project that owns the tool results history.
986 "historyId": "A String", # Required. A tool results history ID.
987 },
988 "googleCloudStorage": { # A storage location within Google cloud storage (GCS). # Required.
989 "gcsPath": "A String", # Required. The path to a directory in GCS that will
990 # eventually contain the results for this test.
991 # The requesting user must have write access on the bucket in the supplied
992 # path.
993 },
994 "toolResultsExecution": { # Represents a tool results execution resource. # Output only. The tool results execution that results are written to.
995 #
996 # This has the results of a TestMatrix.
997 "projectId": "A String", # Output only. The cloud project that owns the tool results execution.
998 "executionId": "A String", # Output only. A tool results execution ID.
999 "historyId": "A String", # Output only. A tool results history ID.
1000 },
1001 "resultsUrl": "A String", # Output only. URL to the results in the Firebase Web Console.
1002 },
1003 "flakyTestAttempts": 42, # The number of times a TestExecution should be re-attempted if one or more
1004 # of its test cases fail for any reason.
1005 # The maximum number of reruns allowed is 10.
1006 #
1007 # Default is 0, which implies no reruns.
1008 "state": "A String", # Output only. Indicates the current progress of the test matrix.
1009 "testExecutions": [ # Output only. The list of test executions that the service creates for
1010 # this matrix.
1011 { # A single test executed in a single environment.
1012 "timestamp": "A String", # Output only. The time this test execution was initially created.
1013 "matrixId": "A String", # Output only. Id of the containing TestMatrix.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1014 "shard": { # Output only. Details about the shard. # Output only. Details about the shard.
1015 "numShards": 42, # Output only. The total number of shards.
1016 "testTargetsForShard": { # Test targets for a shard. # Output only. Test targets for each shard.
1017 "testTargets": [ # Group of packages, classes, and/or test methods to be run for each shard.
1018 # The targets need to be specified in AndroidJUnitRunner argument format. For
1019 # example, “package com.my.packages” “class com.my.package.MyClass”.
1020 #
1021 # The number of shard_test_targets must be greater than 0.
1022 "A String",
1023 ],
1024 },
1025 "shardIndex": 42, # Output only. The index of the shard among all the shards.
1026 },
1027 "id": "A String", # Output only. Unique id set by the service.
1028 "environment": { # The environment in which the test is run. # Output only. How the host machine(s) are configured.
1029 "iosDevice": { # A single iOS device. # An iOS device which must be used with an iOS test.
1030 "locale": "A String", # Required. The locale the test device used for testing.
1031 # Use the TestEnvironmentDiscoveryService to get supported options.
1032 "iosVersionId": "A String", # Required. The id of the iOS major software version to be used.
1033 # Use the TestEnvironmentDiscoveryService to get supported options.
1034 "orientation": "A String", # Required. How the device is oriented during the test.
1035 # Use the TestEnvironmentDiscoveryService to get supported options.
1036 "iosModelId": "A String", # Required. The id of the iOS device to be used.
1037 # Use the TestEnvironmentDiscoveryService to get supported options.
1038 },
1039 "androidDevice": { # A single Android device. # An Android device which must be used with an Android test.
1040 "locale": "A String", # Required. The locale the test device used for testing.
1041 # Use the TestEnvironmentDiscoveryService to get supported options.
1042 "androidVersionId": "A String", # Required. The id of the Android OS version to be used.
1043 # Use the TestEnvironmentDiscoveryService to get supported options.
1044 "androidModelId": "A String", # Required. The id of the Android device to be used.
1045 # Use the TestEnvironmentDiscoveryService to get supported options.
1046 "orientation": "A String", # Required. How the device is oriented during the test.
1047 # Use the TestEnvironmentDiscoveryService to get supported options.
1048 },
1049 },
1050 "state": "A String", # Output only. Indicates the current progress of the test execution
1051 # (e.g., FINISHED).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1052 "testSpecification": { # A description of how to run the test. # Output only. How to run the test.
1053 "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS.
1054 "networkProfile": "A String", # The network traffic profile used for running the test.
1055 # Available network profiles can be queried by using the
1056 # NETWORK_CONFIGURATION environment type when calling
1057 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
1058 },
1059 "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest, via an .xctestrun file.
1060 # Xcode supports the option to "build for testing", which generates an
1061 # .xctestrun file that contains a test specification (arguments, test methods,
1062 # etc). This test type accepts a zip file containing the .xctestrun file and
1063 # the corresponding contents of the Build/Products directory that contains all
1064 # the binaries needed to run the tests.
1065 "xcodeVersion": "A String", # The Xcode version that should be used for the test.
1066 # Use the TestEnvironmentDiscoveryService to get supported options.
1067 # Defaults to the latest Xcode version Firebase Test Lab supports.
1068 "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the
1069 # tests zip. Because the .xctestrun file contains environment variables along
1070 # with test methods to run and/or ignore, this can be useful for sharding
1071 # tests. Default is taken from the tests zip.
1072 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1073 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1074 },
1075 "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the
1076 # DerivedData/Build/Products directory.
1077 # The .xctestrun file in this zip is ignored if the xctestrun field is
1078 # specified.
1079 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1080 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1081 },
1082 "appBundleId": "A String", # Output only. The bundle id for the application under test.
1083 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1084 "iosTestLoop": { # A test of an iOS application that implements one or more game loop scenarios. # An iOS application with a test loop.
1085 # This test type accepts an archived application (.ipa file) and a list of
1086 # integer scenarios that will be executed on the app sequentially.
1087 "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the
1088 # single scenario 0 if unspecified.
1089 42,
1090 ],
1091 "appBundleId": "A String", # Output only. The bundle id for the application under test.
1092 "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test.
1093 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1094 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1095 },
1096 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1097 "testTimeout": "A String", # Max time a test execution is allowed to run before it is
1098 # automatically cancelled.
1099 # The default value is 5 min.
1100 "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
1101 # scripts.
1102 "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.
1103 "googleAuto": { # Enables automatic Google account login. # An automatic google login account.
1104 # If set, the service automatically generates a Google test account and adds
1105 # it to the device, before executing the test. Note that test accounts might be
1106 # reused.
1107 # Many applications show their full set of functionalities when an account is
1108 # present on the device. Logging into the device with these generated accounts
1109 # allows testing more functionalities.
1110 },
1111 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1112 "systrace": { # Systrace configuration for the run.
1113 # If set a systrace will be taken, starting on test start and lasting for the
1114 # configured duration. The systrace file thus obtained is put in the results
1115 # bucket together with the other artifacts from the run.
1116 "durationSeconds": 42, # Systrace duration in seconds.
1117 # Should be between 1 and 30 seconds. 0 disables systrace.
1118 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1119 "networkProfile": "A String", # The network traffic profile used for running the test.
1120 # Available network profiles can be queried by using the
1121 # NETWORK_CONFIGURATION environment type when calling
1122 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
1123 "directoriesToPull": [ # List of directories on the device to upload to GCS at the end of the test;
1124 # they must be absolute paths under /sdcard or /data/local/tmp.
1125 # Path names are restricted to characters a-z A-Z 0-9 _ - . + and /
1126 #
1127 # Note: The paths /sdcard and /data will be made available and treated as
1128 # implicit path substitutions. E.g. if /sdcard on a particular device does
1129 # not map to external storage, the system will replace it with the external
1130 # storage path prefix for that device.
1131 "A String",
1132 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1133 "environmentVariables": [ # Environment variables to set for the test (only applicable for
1134 # instrumentation tests).
1135 { # A key-value pair passed as an environment variable to the test.
1136 "key": "A String", # Key for the environment variable.
1137 "value": "A String", # Value for the environment variable.
1138 },
1139 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1140 "filesToPush": [ # List of files to push to the device before starting the test.
1141 { # A single device file description.
1142 "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file.
1143 "content": { # A reference to a file, used for user inputs. # Required. The source file.
1144 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1145 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1146 },
1147 "devicePath": "A String", # Required. Where to put the content on the device. Must be an absolute,
1148 # whitelisted path. If the file exists, it will be replaced.
1149 # The following device-side directories and any of their subdirectories are
1150 # whitelisted:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1151 # &lt;p&gt;${EXTERNAL_STORAGE}, or /sdcard&lt;/p&gt;
1152 # &lt;p&gt;${ANDROID_DATA}/local/tmp, or /data/local/tmp&lt;/p&gt;
1153 # &lt;p&gt;Specifying a path outside of these directory trees is invalid.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1154 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1155 # &lt;p&gt; The paths /sdcard and /data will be made available and treated as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1156 # implicit path substitutions. E.g. if /sdcard on a particular device does
1157 # not map to external storage, the system will replace it with the external
1158 # storage path prefix for that device and copy the file there.
1159 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1160 # &lt;p&gt; It is strongly advised to use the &lt;a href=
1161 # "http://developer.android.com/reference/android/os/Environment.html"&gt;
1162 # Environment API&lt;/a&gt; in app and test code to access files on the device in a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1163 # portable way.
1164 },
1165 "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file.
1166 "obbFileName": "A String", # Required. OBB file name which must conform to the format as specified by
1167 # Android
1168 # e.g. [main|patch].0300110.com.example.android.obb
1169 # which will be installed into
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1170 # \&lt;shared-storage\&gt;/Android/obb/\&lt;package-name\&gt;/
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1171 # on the device.
1172 "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device.
1173 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1174 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1175 },
1176 },
1177 },
1178 ],
1179 "additionalApks": [ # APKs to install in addition to those being directly tested.
1180 # Currently capped at 100.
1181 { # An Android package file to install.
1182 "packageName": "A String", # The java package for the APK to be installed.
1183 # Value is determined by examining the application's manifest.
1184 "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.
1185 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1186 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1187 },
1188 },
1189 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1190 },
1191 "disableVideoRecording": True or False, # Disables video recording. May reduce test latency.
1192 "androidTestLoop": { # A test of an Android Application with a Test Loop. # An Android Application with a Test Loop.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1193 # The intent \&lt;intent-name\&gt; will be implicitly added, since Games is the only
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1194 # user of this api, for the time being.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1195 "scenarios": [ # The list of scenarios that should be run during the test.
1196 # The default is all test loops, derived from the application's
1197 # manifest.
1198 42,
1199 ],
1200 "appPackageId": "A String", # The java package for the application under test.
1201 # The default is determined by examining the application's manifest.
1202 "scenarioLabels": [ # The list of scenario labels that should be run during the test.
1203 # The scenario labels should map to labels defined in the application's
1204 # manifest. For example, player_experience and
1205 # com.google.test.loops.player_experience add all of the loops labeled in the
1206 # manifest with the com.google.test.loops.player_experience name to the
1207 # execution.
1208 # Scenarios can also be specified in the scenarios field.
1209 "A String",
1210 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1211 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
1212 # a base module directory, zero or more dynamic feature module directories.
1213 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
1214 # building App Bundles.
1215 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
1216 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1217 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1218 },
1219 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1220 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
1221 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1222 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1223 },
1224 },
1225 "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency.
1226 "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test.
1227 # or physical Android Device, finding culprits and crashes as it goes.
1228 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
1229 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1230 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1231 # building App Bundles.
1232 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
1233 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1234 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1235 },
1236 },
1237 "roboDirectives": [ # A set of directives Robo should apply during the crawl.
1238 # This allows users to customize the crawl. For example, the username and
1239 # password for a test account can be provided.
1240 { # Directs Robo to interact with a specific UI element if it is encountered
1241 # during the crawl. Currently, Robo can perform text entry or element click.
1242 "inputText": "A String", # The text that Robo is directed to set. If left empty, the directive will be
1243 # treated as a CLICK on the element matching the resource_name.
1244 "resourceName": "A String", # Required. The android resource name of the target UI element.
1245 # For example,
1246 # in Java: R.string.foo
1247 # in xml: @string/foo
1248 # Only the "foo" part is needed.
1249 # Reference doc:
1250 # https://developer.android.com/guide/topics/resources/accessing-resources.html
1251 "actionType": "A String", # Required. The type of action that Robo should perform on the specified
1252 # element.
1253 },
1254 ],
1255 "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue
1256 # for the crawl.
1257 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1258 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1259 },
1260 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
1261 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1262 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1263 },
1264 "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least
1265 # 2 to make Robo explore the app beyond the first activity.
1266 # Default is 50.
1267 "startingIntents": [ # The intents used to launch the app for the crawl.
1268 # If none are provided, then the main launcher activity is launched.
1269 # If some are provided, then only those provided are launched (the main
1270 # launcher activity must be provided explicitly).
1271 { # Message for specifying the start activities to crawl.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1272 "timeout": "A String", # Timeout in seconds for each intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1273 "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details.
1274 "action": "A String", # Action name.
1275 # Required for START_ACTIVITY.
1276 "uri": "A String", # URI for the action.
1277 "categories": [ # Intent categories to set on the intent.
1278 "A String",
1279 ],
1280 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1281 "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity.
1282 },
1283 },
1284 ],
1285 "maxSteps": 42, # The max number of steps Robo can execute.
1286 # Default is no limit.
1287 "appPackageId": "A String", # The java package for the application under test.
1288 # The default value is determined by examining the application's manifest.
1289 "appInitialActivity": "A String", # The initial activity that should be used to start the app.
1290 },
1291 "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test.
1292 # independently of its normal lifecycle.
1293 # Android instrumentation tests run an application APK and test APK inside the
1294 # same process on a virtual or physical AndroidDevice. They also specify
1295 # a test runner class, such as com.google.GoogleTestRunner, which can vary
1296 # on the specific instrumentation framework chosen.
1297 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1298 # See &lt;http://developer.android.com/tools/testing/testing_android.html&gt; for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1299 # more information on types of Android tests.
1300 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
1301 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1302 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1303 # building App Bundles.
1304 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
1305 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1306 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1307 },
1308 },
1309 "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed.
1310 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1311 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1312 },
1313 "testRunnerClass": "A String", # The InstrumentationTestRunner class.
1314 # The default value is determined by examining the application's manifest.
1315 "testPackageId": "A String", # The java package for the test to be executed.
1316 # The default value is determined by examining the application's manifest.
1317 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
1318 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1319 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1320 },
1321 "appPackageId": "A String", # The java package for the application under test.
1322 # The default value is determined by examining the application's manifest.
1323 "orchestratorOption": "A String", # The option of whether running each test within its own invocation of
1324 # instrumentation with Android Test Orchestrator or not.
1325 # ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or
1326 # higher! **
1327 # Orchestrator offers the following benefits:
1328 # - No shared state
1329 # - Crashes are isolated
1330 # - Logs are scoped per test
1331 #
1332 # See
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1333 # &lt;https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1334 # for more information about Android Test Orchestrator.
1335 #
1336 # If not set, the test will be run without the orchestrator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1337 "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel.
1338 "manualSharding": { # Shards test cases into the specified groups of packages, classes, and/or # Shards test cases into the specified groups of packages, classes, and/or
1339 # methods.
1340 # methods.
1341 #
1342 # With manual sharding enabled, specifying test targets via
1343 # environment_variables or in InstrumentationTest is invalid.
1344 "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for
1345 # each shard. The number of shard_test_targets must be &gt;= 1 and &lt;= 50.
1346 { # Test targets for a shard.
1347 "testTargets": [ # Group of packages, classes, and/or test methods to be run for each shard.
1348 # The targets need to be specified in AndroidJUnitRunner argument format. For
1349 # example, “package com.my.packages” “class com.my.package.MyClass”.
1350 #
1351 # The number of shard_test_targets must be greater than 0.
1352 "A String",
1353 ],
1354 },
1355 ],
1356 },
1357 "uniformSharding": { # Uniformly shards test cases given a total number of shards. # Uniformly shards test cases given a total number of shards.
1358 #
1359 # For Instrumentation test, it will be translated to “-e numShard” “-e
1360 # shardIndex” AndroidJUnitRunner arguments. With uniform sharding enabled,
1361 # specifying these sharding arguments via environment_variables is invalid.
1362 "numShards": 42, # Required. Total number of shards. The number must be &gt;= 1 and &lt;= 50.
1363 },
1364 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1365 "testTargets": [ # Each target must be fully qualified with the package name or class name,
1366 # in one of these formats:
1367 # - "package package_name"
1368 # - "class package_name.class_name"
1369 # - "class package_name.class_name#method_name"
1370 #
1371 # If empty, all targets in the module will be run.
1372 "A String",
1373 ],
1374 },
1375 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1376 "projectId": "A String", # Output only. The cloud project that owns the test execution.
1377 "toolResultsStep": { # Represents a tool results step resource. # Output only. Where the results for this execution are written.
1378 #
1379 # This has the results of a TestExecution.
1380 "projectId": "A String", # Output only. The cloud project that owns the tool results step.
1381 "executionId": "A String", # Output only. A tool results execution ID.
1382 "stepId": "A String", # Output only. A tool results step ID.
1383 "historyId": "A String", # Output only. A tool results history ID.
1384 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1385 "testDetails": { # Additional details about the progress of the running test. # Output only. Additional details about the running test.
1386 "progressMessages": [ # Output only. Human-readable, detailed descriptions of the test's progress.
1387 # For example: "Provisioning a device", "Starting Test".
1388 #
1389 # During the course of execution new data may be appended
1390 # to the end of progress_messages.
1391 "A String",
1392 ],
1393 "errorMessage": "A String", # Output only. If the TestState is ERROR, then this string will contain
1394 # human-readable details about the error.
1395 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1396 },
1397 ],
1398 "testSpecification": { # A description of how to run the test. # Required. How to run the test.
1399 "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS.
1400 "networkProfile": "A String", # The network traffic profile used for running the test.
1401 # Available network profiles can be queried by using the
1402 # NETWORK_CONFIGURATION environment type when calling
1403 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
1404 },
1405 "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest, via an .xctestrun file.
1406 # Xcode supports the option to "build for testing", which generates an
1407 # .xctestrun file that contains a test specification (arguments, test methods,
1408 # etc). This test type accepts a zip file containing the .xctestrun file and
1409 # the corresponding contents of the Build/Products directory that contains all
1410 # the binaries needed to run the tests.
1411 "xcodeVersion": "A String", # The Xcode version that should be used for the test.
1412 # Use the TestEnvironmentDiscoveryService to get supported options.
1413 # Defaults to the latest Xcode version Firebase Test Lab supports.
1414 "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the
1415 # tests zip. Because the .xctestrun file contains environment variables along
1416 # with test methods to run and/or ignore, this can be useful for sharding
1417 # tests. Default is taken from the tests zip.
1418 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1419 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1420 },
1421 "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the
1422 # DerivedData/Build/Products directory.
1423 # The .xctestrun file in this zip is ignored if the xctestrun field is
1424 # specified.
1425 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1426 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1427 },
1428 "appBundleId": "A String", # Output only. The bundle id for the application under test.
1429 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1430 "iosTestLoop": { # A test of an iOS application that implements one or more game loop scenarios. # An iOS application with a test loop.
1431 # This test type accepts an archived application (.ipa file) and a list of
1432 # integer scenarios that will be executed on the app sequentially.
1433 "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the
1434 # single scenario 0 if unspecified.
1435 42,
1436 ],
1437 "appBundleId": "A String", # Output only. The bundle id for the application under test.
1438 "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test.
1439 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1440 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1441 },
1442 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1443 "testTimeout": "A String", # Max time a test execution is allowed to run before it is
1444 # automatically cancelled.
1445 # The default value is 5 min.
1446 "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
1447 # scripts.
1448 "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.
1449 "googleAuto": { # Enables automatic Google account login. # An automatic google login account.
1450 # If set, the service automatically generates a Google test account and adds
1451 # it to the device, before executing the test. Note that test accounts might be
1452 # reused.
1453 # Many applications show their full set of functionalities when an account is
1454 # present on the device. Logging into the device with these generated accounts
1455 # allows testing more functionalities.
1456 },
1457 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1458 "systrace": { # Systrace configuration for the run.
1459 # If set a systrace will be taken, starting on test start and lasting for the
1460 # configured duration. The systrace file thus obtained is put in the results
1461 # bucket together with the other artifacts from the run.
1462 "durationSeconds": 42, # Systrace duration in seconds.
1463 # Should be between 1 and 30 seconds. 0 disables systrace.
1464 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1465 "networkProfile": "A String", # The network traffic profile used for running the test.
1466 # Available network profiles can be queried by using the
1467 # NETWORK_CONFIGURATION environment type when calling
1468 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
1469 "directoriesToPull": [ # List of directories on the device to upload to GCS at the end of the test;
1470 # they must be absolute paths under /sdcard or /data/local/tmp.
1471 # Path names are restricted to characters a-z A-Z 0-9 _ - . + and /
1472 #
1473 # Note: The paths /sdcard and /data will be made available and treated as
1474 # implicit path substitutions. E.g. if /sdcard on a particular device does
1475 # not map to external storage, the system will replace it with the external
1476 # storage path prefix for that device.
1477 "A String",
1478 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1479 "environmentVariables": [ # Environment variables to set for the test (only applicable for
1480 # instrumentation tests).
1481 { # A key-value pair passed as an environment variable to the test.
1482 "key": "A String", # Key for the environment variable.
1483 "value": "A String", # Value for the environment variable.
1484 },
1485 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1486 "filesToPush": [ # List of files to push to the device before starting the test.
1487 { # A single device file description.
1488 "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file.
1489 "content": { # A reference to a file, used for user inputs. # Required. The source file.
1490 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1491 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1492 },
1493 "devicePath": "A String", # Required. Where to put the content on the device. Must be an absolute,
1494 # whitelisted path. If the file exists, it will be replaced.
1495 # The following device-side directories and any of their subdirectories are
1496 # whitelisted:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1497 # &lt;p&gt;${EXTERNAL_STORAGE}, or /sdcard&lt;/p&gt;
1498 # &lt;p&gt;${ANDROID_DATA}/local/tmp, or /data/local/tmp&lt;/p&gt;
1499 # &lt;p&gt;Specifying a path outside of these directory trees is invalid.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1500 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1501 # &lt;p&gt; The paths /sdcard and /data will be made available and treated as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1502 # implicit path substitutions. E.g. if /sdcard on a particular device does
1503 # not map to external storage, the system will replace it with the external
1504 # storage path prefix for that device and copy the file there.
1505 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1506 # &lt;p&gt; It is strongly advised to use the &lt;a href=
1507 # "http://developer.android.com/reference/android/os/Environment.html"&gt;
1508 # Environment API&lt;/a&gt; in app and test code to access files on the device in a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1509 # portable way.
1510 },
1511 "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file.
1512 "obbFileName": "A String", # Required. OBB file name which must conform to the format as specified by
1513 # Android
1514 # e.g. [main|patch].0300110.com.example.android.obb
1515 # which will be installed into
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1516 # \&lt;shared-storage\&gt;/Android/obb/\&lt;package-name\&gt;/
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1517 # on the device.
1518 "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device.
1519 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1520 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1521 },
1522 },
1523 },
1524 ],
1525 "additionalApks": [ # APKs to install in addition to those being directly tested.
1526 # Currently capped at 100.
1527 { # An Android package file to install.
1528 "packageName": "A String", # The java package for the APK to be installed.
1529 # Value is determined by examining the application's manifest.
1530 "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.
1531 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1532 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1533 },
1534 },
1535 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1536 },
1537 "disableVideoRecording": True or False, # Disables video recording. May reduce test latency.
1538 "androidTestLoop": { # A test of an Android Application with a Test Loop. # An Android Application with a Test Loop.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1539 # The intent \&lt;intent-name\&gt; will be implicitly added, since Games is the only
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1540 # user of this api, for the time being.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1541 "scenarios": [ # The list of scenarios that should be run during the test.
1542 # The default is all test loops, derived from the application's
1543 # manifest.
1544 42,
1545 ],
1546 "appPackageId": "A String", # The java package for the application under test.
1547 # The default is determined by examining the application's manifest.
1548 "scenarioLabels": [ # The list of scenario labels that should be run during the test.
1549 # The scenario labels should map to labels defined in the application's
1550 # manifest. For example, player_experience and
1551 # com.google.test.loops.player_experience add all of the loops labeled in the
1552 # manifest with the com.google.test.loops.player_experience name to the
1553 # execution.
1554 # Scenarios can also be specified in the scenarios field.
1555 "A String",
1556 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1557 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
1558 # a base module directory, zero or more dynamic feature module directories.
1559 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
1560 # building App Bundles.
1561 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
1562 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1563 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1564 },
1565 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1566 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
1567 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1568 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1569 },
1570 },
1571 "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency.
1572 "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test.
1573 # or physical Android Device, finding culprits and crashes as it goes.
1574 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
1575 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1576 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1577 # building App Bundles.
1578 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
1579 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1580 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1581 },
1582 },
1583 "roboDirectives": [ # A set of directives Robo should apply during the crawl.
1584 # This allows users to customize the crawl. For example, the username and
1585 # password for a test account can be provided.
1586 { # Directs Robo to interact with a specific UI element if it is encountered
1587 # during the crawl. Currently, Robo can perform text entry or element click.
1588 "inputText": "A String", # The text that Robo is directed to set. If left empty, the directive will be
1589 # treated as a CLICK on the element matching the resource_name.
1590 "resourceName": "A String", # Required. The android resource name of the target UI element.
1591 # For example,
1592 # in Java: R.string.foo
1593 # in xml: @string/foo
1594 # Only the "foo" part is needed.
1595 # Reference doc:
1596 # https://developer.android.com/guide/topics/resources/accessing-resources.html
1597 "actionType": "A String", # Required. The type of action that Robo should perform on the specified
1598 # element.
1599 },
1600 ],
1601 "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue
1602 # for the crawl.
1603 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1604 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1605 },
1606 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
1607 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1608 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1609 },
1610 "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least
1611 # 2 to make Robo explore the app beyond the first activity.
1612 # Default is 50.
1613 "startingIntents": [ # The intents used to launch the app for the crawl.
1614 # If none are provided, then the main launcher activity is launched.
1615 # If some are provided, then only those provided are launched (the main
1616 # launcher activity must be provided explicitly).
1617 { # Message for specifying the start activities to crawl.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1618 "timeout": "A String", # Timeout in seconds for each intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1619 "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details.
1620 "action": "A String", # Action name.
1621 # Required for START_ACTIVITY.
1622 "uri": "A String", # URI for the action.
1623 "categories": [ # Intent categories to set on the intent.
1624 "A String",
1625 ],
1626 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1627 "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity.
1628 },
1629 },
1630 ],
1631 "maxSteps": 42, # The max number of steps Robo can execute.
1632 # Default is no limit.
1633 "appPackageId": "A String", # The java package for the application under test.
1634 # The default value is determined by examining the application's manifest.
1635 "appInitialActivity": "A String", # The initial activity that should be used to start the app.
1636 },
1637 "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test.
1638 # independently of its normal lifecycle.
1639 # Android instrumentation tests run an application APK and test APK inside the
1640 # same process on a virtual or physical AndroidDevice. They also specify
1641 # a test runner class, such as com.google.GoogleTestRunner, which can vary
1642 # on the specific instrumentation framework chosen.
1643 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1644 # See &lt;http://developer.android.com/tools/testing/testing_android.html&gt; for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1645 # more information on types of Android tests.
1646 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
1647 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1648 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1649 # building App Bundles.
1650 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
1651 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1652 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1653 },
1654 },
1655 "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed.
1656 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1657 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1658 },
1659 "testRunnerClass": "A String", # The InstrumentationTestRunner class.
1660 # The default value is determined by examining the application's manifest.
1661 "testPackageId": "A String", # The java package for the test to be executed.
1662 # The default value is determined by examining the application's manifest.
1663 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
1664 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1665 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1666 },
1667 "appPackageId": "A String", # The java package for the application under test.
1668 # The default value is determined by examining the application's manifest.
1669 "orchestratorOption": "A String", # The option of whether running each test within its own invocation of
1670 # instrumentation with Android Test Orchestrator or not.
1671 # ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or
1672 # higher! **
1673 # Orchestrator offers the following benefits:
1674 # - No shared state
1675 # - Crashes are isolated
1676 # - Logs are scoped per test
1677 #
1678 # See
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1679 # &lt;https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1680 # for more information about Android Test Orchestrator.
1681 #
1682 # If not set, the test will be run without the orchestrator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1683 "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel.
1684 "manualSharding": { # Shards test cases into the specified groups of packages, classes, and/or # Shards test cases into the specified groups of packages, classes, and/or
1685 # methods.
1686 # methods.
1687 #
1688 # With manual sharding enabled, specifying test targets via
1689 # environment_variables or in InstrumentationTest is invalid.
1690 "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for
1691 # each shard. The number of shard_test_targets must be &gt;= 1 and &lt;= 50.
1692 { # Test targets for a shard.
1693 "testTargets": [ # Group of packages, classes, and/or test methods to be run for each shard.
1694 # The targets need to be specified in AndroidJUnitRunner argument format. For
1695 # example, “package com.my.packages” “class com.my.package.MyClass”.
1696 #
1697 # The number of shard_test_targets must be greater than 0.
1698 "A String",
1699 ],
1700 },
1701 ],
1702 },
1703 "uniformSharding": { # Uniformly shards test cases given a total number of shards. # Uniformly shards test cases given a total number of shards.
1704 #
1705 # For Instrumentation test, it will be translated to “-e numShard” “-e
1706 # shardIndex” AndroidJUnitRunner arguments. With uniform sharding enabled,
1707 # specifying these sharding arguments via environment_variables is invalid.
1708 "numShards": 42, # Required. Total number of shards. The number must be &gt;= 1 and &lt;= 50.
1709 },
1710 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1711 "testTargets": [ # Each target must be fully qualified with the package name or class name,
1712 # in one of these formats:
1713 # - "package package_name"
1714 # - "class package_name.class_name"
1715 # - "class package_name.class_name#method_name"
1716 #
1717 # If empty, all targets in the module will be run.
1718 "A String",
1719 ],
1720 },
1721 },
1722 "testMatrixId": "A String", # Output only. Unique id set by the service.
1723 "timestamp": "A String", # Output only. The time this test matrix was initially created.
1724 "invalidMatrixDetails": "A String", # Output only. Describes why the matrix is considered invalid.
1725 # Only useful for matrices in the INVALID state.
1726 "environmentMatrix": { # The matrix of environments in which the test is to be executed. # Required. The devices the tests are being executed on.
1727 "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
1728 # devices.
1729 "androidDevices": [ # Required. A list of Android devices.
1730 { # A single Android device.
1731 "locale": "A String", # Required. The locale the test device used for testing.
1732 # Use the TestEnvironmentDiscoveryService to get supported options.
1733 "androidVersionId": "A String", # Required. The id of the Android OS version to be used.
1734 # Use the TestEnvironmentDiscoveryService to get supported options.
1735 "androidModelId": "A String", # Required. The id of the Android device to be used.
1736 # Use the TestEnvironmentDiscoveryService to get supported options.
1737 "orientation": "A String", # Required. How the device is oriented during the test.
1738 # Use the TestEnvironmentDiscoveryService to get supported options.
1739 },
1740 ],
1741 },
1742 "androidMatrix": { # A set of Android device configuration permutations is defined by the # A matrix of Android devices.
1743 # the cross-product of the given axes. Internally, the given AndroidMatrix
1744 # will be expanded into a set of AndroidDevices.
1745 #
1746 # Only supported permutations will be instantiated. Invalid permutations
1747 # (e.g., incompatible models/versions) are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1748 "orientations": [ # Required. The set of orientations to test with.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1749 # Use the TestEnvironmentDiscoveryService to get supported options.
1750 "A String",
1751 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1752 "locales": [ # Required. The set of locales the test device will enable for testing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1753 # Use the TestEnvironmentDiscoveryService to get supported options.
1754 "A String",
1755 ],
1756 "androidVersionIds": [ # Required. The ids of the set of Android OS version to be used.
1757 # Use the TestEnvironmentDiscoveryService to get supported options.
1758 "A String",
1759 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1760 "androidModelIds": [ # Required. The ids of the set of Android device to be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1761 # Use the TestEnvironmentDiscoveryService to get supported options.
1762 "A String",
1763 ],
1764 },
1765 "iosDeviceList": { # A list of iOS device configurations in which the test is to be executed. # A list of iOS devices.
1766 "iosDevices": [ # Required. A list of iOS devices.
1767 { # A single iOS device.
1768 "locale": "A String", # Required. The locale the test device used for testing.
1769 # Use the TestEnvironmentDiscoveryService to get supported options.
1770 "iosVersionId": "A String", # Required. The id of the iOS major software version to be used.
1771 # Use the TestEnvironmentDiscoveryService to get supported options.
1772 "orientation": "A String", # Required. How the device is oriented during the test.
1773 # Use the TestEnvironmentDiscoveryService to get supported options.
1774 "iosModelId": "A String", # Required. The id of the iOS device to be used.
1775 # Use the TestEnvironmentDiscoveryService to get supported options.
1776 },
1777 ],
1778 },
1779 },
1780 "outcomeSummary": "A String", # Output Only. The overall outcome of the test.
1781 # Only set when the test matrix state is FINISHED.
1782 }</pre>
1783</div>
1784
1785<div class="method">
1786 <code class="details" id="get">get(projectId, testMatrixId, x__xgafv=None)</code>
1787 <pre>Checks the status of a test matrix.
1788
1789May return any of the following canonical error codes:
1790
1791- PERMISSION_DENIED - if the user is not authorized to read project
1792- INVALID_ARGUMENT - if the request is malformed
1793- NOT_FOUND - if the Test Matrix does not exist
1794
1795Args:
1796 projectId: string, Cloud project that owns the test matrix. (required)
1797 testMatrixId: string, Unique test matrix id which was assigned by the service. (required)
1798 x__xgafv: string, V1 error format.
1799 Allowed values
1800 1 - v1 error format
1801 2 - v2 error format
1802
1803Returns:
1804 An object of the form:
1805
1806 { # TestMatrix captures all details about a test. It contains the environment
1807 # configuration, test specification, test executions and overall state and
1808 # outcome.
1809 "clientInfo": { # Information about the client which invoked the test. # Information about the client which invoked the test.
1810 "clientInfoDetails": [ # The list of detailed information about client.
1811 { # Key-value pair of detailed information about the client which invoked the
1812 # test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}.
1813 "key": "A String", # Required. The key of detailed client information.
1814 "value": "A String", # Required. The value of detailed client information.
1815 },
1816 ],
1817 "name": "A String", # Required. Client name, such as gcloud.
1818 },
1819 "projectId": "A String", # The cloud project that owns the test matrix.
1820 "resultStorage": { # Locations where the results of running the test are stored. # Required. Where the results for the matrix are written.
1821 "toolResultsHistory": { # Represents a tool results history resource. # The tool results history that contains the tool results execution that
1822 # results are written to.
1823 #
1824 # If not provided, the service will choose an appropriate value.
1825 "projectId": "A String", # Required. The cloud project that owns the tool results history.
1826 "historyId": "A String", # Required. A tool results history ID.
1827 },
1828 "googleCloudStorage": { # A storage location within Google cloud storage (GCS). # Required.
1829 "gcsPath": "A String", # Required. The path to a directory in GCS that will
1830 # eventually contain the results for this test.
1831 # The requesting user must have write access on the bucket in the supplied
1832 # path.
1833 },
1834 "toolResultsExecution": { # Represents a tool results execution resource. # Output only. The tool results execution that results are written to.
1835 #
1836 # This has the results of a TestMatrix.
1837 "projectId": "A String", # Output only. The cloud project that owns the tool results execution.
1838 "executionId": "A String", # Output only. A tool results execution ID.
1839 "historyId": "A String", # Output only. A tool results history ID.
1840 },
1841 "resultsUrl": "A String", # Output only. URL to the results in the Firebase Web Console.
1842 },
1843 "flakyTestAttempts": 42, # The number of times a TestExecution should be re-attempted if one or more
1844 # of its test cases fail for any reason.
1845 # The maximum number of reruns allowed is 10.
1846 #
1847 # Default is 0, which implies no reruns.
1848 "state": "A String", # Output only. Indicates the current progress of the test matrix.
1849 "testExecutions": [ # Output only. The list of test executions that the service creates for
1850 # this matrix.
1851 { # A single test executed in a single environment.
1852 "timestamp": "A String", # Output only. The time this test execution was initially created.
1853 "matrixId": "A String", # Output only. Id of the containing TestMatrix.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1854 "shard": { # Output only. Details about the shard. # Output only. Details about the shard.
1855 "numShards": 42, # Output only. The total number of shards.
1856 "testTargetsForShard": { # Test targets for a shard. # Output only. Test targets for each shard.
1857 "testTargets": [ # Group of packages, classes, and/or test methods to be run for each shard.
1858 # The targets need to be specified in AndroidJUnitRunner argument format. For
1859 # example, “package com.my.packages” “class com.my.package.MyClass”.
1860 #
1861 # The number of shard_test_targets must be greater than 0.
1862 "A String",
1863 ],
1864 },
1865 "shardIndex": 42, # Output only. The index of the shard among all the shards.
1866 },
1867 "id": "A String", # Output only. Unique id set by the service.
1868 "environment": { # The environment in which the test is run. # Output only. How the host machine(s) are configured.
1869 "iosDevice": { # A single iOS device. # An iOS device which must be used with an iOS test.
1870 "locale": "A String", # Required. The locale the test device used for testing.
1871 # Use the TestEnvironmentDiscoveryService to get supported options.
1872 "iosVersionId": "A String", # Required. The id of the iOS major software version to be used.
1873 # Use the TestEnvironmentDiscoveryService to get supported options.
1874 "orientation": "A String", # Required. How the device is oriented during the test.
1875 # Use the TestEnvironmentDiscoveryService to get supported options.
1876 "iosModelId": "A String", # Required. The id of the iOS device to be used.
1877 # Use the TestEnvironmentDiscoveryService to get supported options.
1878 },
1879 "androidDevice": { # A single Android device. # An Android device which must be used with an Android test.
1880 "locale": "A String", # Required. The locale the test device used for testing.
1881 # Use the TestEnvironmentDiscoveryService to get supported options.
1882 "androidVersionId": "A String", # Required. The id of the Android OS version to be used.
1883 # Use the TestEnvironmentDiscoveryService to get supported options.
1884 "androidModelId": "A String", # Required. The id of the Android device to be used.
1885 # Use the TestEnvironmentDiscoveryService to get supported options.
1886 "orientation": "A String", # Required. How the device is oriented during the test.
1887 # Use the TestEnvironmentDiscoveryService to get supported options.
1888 },
1889 },
1890 "state": "A String", # Output only. Indicates the current progress of the test execution
1891 # (e.g., FINISHED).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1892 "testSpecification": { # A description of how to run the test. # Output only. How to run the test.
1893 "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS.
1894 "networkProfile": "A String", # The network traffic profile used for running the test.
1895 # Available network profiles can be queried by using the
1896 # NETWORK_CONFIGURATION environment type when calling
1897 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
1898 },
1899 "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest, via an .xctestrun file.
1900 # Xcode supports the option to "build for testing", which generates an
1901 # .xctestrun file that contains a test specification (arguments, test methods,
1902 # etc). This test type accepts a zip file containing the .xctestrun file and
1903 # the corresponding contents of the Build/Products directory that contains all
1904 # the binaries needed to run the tests.
1905 "xcodeVersion": "A String", # The Xcode version that should be used for the test.
1906 # Use the TestEnvironmentDiscoveryService to get supported options.
1907 # Defaults to the latest Xcode version Firebase Test Lab supports.
1908 "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the
1909 # tests zip. Because the .xctestrun file contains environment variables along
1910 # with test methods to run and/or ignore, this can be useful for sharding
1911 # tests. Default is taken from the tests zip.
1912 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1913 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1914 },
1915 "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the
1916 # DerivedData/Build/Products directory.
1917 # The .xctestrun file in this zip is ignored if the xctestrun field is
1918 # specified.
1919 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1920 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1921 },
1922 "appBundleId": "A String", # Output only. The bundle id for the application under test.
1923 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1924 "iosTestLoop": { # A test of an iOS application that implements one or more game loop scenarios. # An iOS application with a test loop.
1925 # This test type accepts an archived application (.ipa file) and a list of
1926 # integer scenarios that will be executed on the app sequentially.
1927 "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the
1928 # single scenario 0 if unspecified.
1929 42,
1930 ],
1931 "appBundleId": "A String", # Output only. The bundle id for the application under test.
1932 "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test.
1933 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1934 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1935 },
1936 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1937 "testTimeout": "A String", # Max time a test execution is allowed to run before it is
1938 # automatically cancelled.
1939 # The default value is 5 min.
1940 "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
1941 # scripts.
1942 "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.
1943 "googleAuto": { # Enables automatic Google account login. # An automatic google login account.
1944 # If set, the service automatically generates a Google test account and adds
1945 # it to the device, before executing the test. Note that test accounts might be
1946 # reused.
1947 # Many applications show their full set of functionalities when an account is
1948 # present on the device. Logging into the device with these generated accounts
1949 # allows testing more functionalities.
1950 },
1951 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1952 "systrace": { # Systrace configuration for the run.
1953 # If set a systrace will be taken, starting on test start and lasting for the
1954 # configured duration. The systrace file thus obtained is put in the results
1955 # bucket together with the other artifacts from the run.
1956 "durationSeconds": 42, # Systrace duration in seconds.
1957 # Should be between 1 and 30 seconds. 0 disables systrace.
1958 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1959 "networkProfile": "A String", # The network traffic profile used for running the test.
1960 # Available network profiles can be queried by using the
1961 # NETWORK_CONFIGURATION environment type when calling
1962 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
1963 "directoriesToPull": [ # List of directories on the device to upload to GCS at the end of the test;
1964 # they must be absolute paths under /sdcard or /data/local/tmp.
1965 # Path names are restricted to characters a-z A-Z 0-9 _ - . + and /
1966 #
1967 # Note: The paths /sdcard and /data will be made available and treated as
1968 # implicit path substitutions. E.g. if /sdcard on a particular device does
1969 # not map to external storage, the system will replace it with the external
1970 # storage path prefix for that device.
1971 "A String",
1972 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1973 "environmentVariables": [ # Environment variables to set for the test (only applicable for
1974 # instrumentation tests).
1975 { # A key-value pair passed as an environment variable to the test.
1976 "key": "A String", # Key for the environment variable.
1977 "value": "A String", # Value for the environment variable.
1978 },
1979 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1980 "filesToPush": [ # List of files to push to the device before starting the test.
1981 { # A single device file description.
1982 "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file.
1983 "content": { # A reference to a file, used for user inputs. # Required. The source file.
1984 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
1985 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
1986 },
1987 "devicePath": "A String", # Required. Where to put the content on the device. Must be an absolute,
1988 # whitelisted path. If the file exists, it will be replaced.
1989 # The following device-side directories and any of their subdirectories are
1990 # whitelisted:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1991 # &lt;p&gt;${EXTERNAL_STORAGE}, or /sdcard&lt;/p&gt;
1992 # &lt;p&gt;${ANDROID_DATA}/local/tmp, or /data/local/tmp&lt;/p&gt;
1993 # &lt;p&gt;Specifying a path outside of these directory trees is invalid.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1994 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1995 # &lt;p&gt; The paths /sdcard and /data will be made available and treated as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1996 # implicit path substitutions. E.g. if /sdcard on a particular device does
1997 # not map to external storage, the system will replace it with the external
1998 # storage path prefix for that device and copy the file there.
1999 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2000 # &lt;p&gt; It is strongly advised to use the &lt;a href=
2001 # "http://developer.android.com/reference/android/os/Environment.html"&gt;
2002 # Environment API&lt;/a&gt; in app and test code to access files on the device in a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2003 # portable way.
2004 },
2005 "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file.
2006 "obbFileName": "A String", # Required. OBB file name which must conform to the format as specified by
2007 # Android
2008 # e.g. [main|patch].0300110.com.example.android.obb
2009 # which will be installed into
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2010 # \&lt;shared-storage\&gt;/Android/obb/\&lt;package-name\&gt;/
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2011 # on the device.
2012 "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device.
2013 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2014 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2015 },
2016 },
2017 },
2018 ],
2019 "additionalApks": [ # APKs to install in addition to those being directly tested.
2020 # Currently capped at 100.
2021 { # An Android package file to install.
2022 "packageName": "A String", # The java package for the APK to be installed.
2023 # Value is determined by examining the application's manifest.
2024 "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.
2025 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2026 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2027 },
2028 },
2029 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2030 },
2031 "disableVideoRecording": True or False, # Disables video recording. May reduce test latency.
2032 "androidTestLoop": { # A test of an Android Application with a Test Loop. # An Android Application with a Test Loop.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2033 # The intent \&lt;intent-name\&gt; will be implicitly added, since Games is the only
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2034 # user of this api, for the time being.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2035 "scenarios": [ # The list of scenarios that should be run during the test.
2036 # The default is all test loops, derived from the application's
2037 # manifest.
2038 42,
2039 ],
2040 "appPackageId": "A String", # The java package for the application under test.
2041 # The default is determined by examining the application's manifest.
2042 "scenarioLabels": [ # The list of scenario labels that should be run during the test.
2043 # The scenario labels should map to labels defined in the application's
2044 # manifest. For example, player_experience and
2045 # com.google.test.loops.player_experience add all of the loops labeled in the
2046 # manifest with the com.google.test.loops.player_experience name to the
2047 # execution.
2048 # Scenarios can also be specified in the scenarios field.
2049 "A String",
2050 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2051 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
2052 # a base module directory, zero or more dynamic feature module directories.
2053 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
2054 # building App Bundles.
2055 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
2056 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2057 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2058 },
2059 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2060 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
2061 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2062 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2063 },
2064 },
2065 "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency.
2066 "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test.
2067 # or physical Android Device, finding culprits and crashes as it goes.
2068 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
2069 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2070 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2071 # building App Bundles.
2072 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
2073 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2074 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2075 },
2076 },
2077 "roboDirectives": [ # A set of directives Robo should apply during the crawl.
2078 # This allows users to customize the crawl. For example, the username and
2079 # password for a test account can be provided.
2080 { # Directs Robo to interact with a specific UI element if it is encountered
2081 # during the crawl. Currently, Robo can perform text entry or element click.
2082 "inputText": "A String", # The text that Robo is directed to set. If left empty, the directive will be
2083 # treated as a CLICK on the element matching the resource_name.
2084 "resourceName": "A String", # Required. The android resource name of the target UI element.
2085 # For example,
2086 # in Java: R.string.foo
2087 # in xml: @string/foo
2088 # Only the "foo" part is needed.
2089 # Reference doc:
2090 # https://developer.android.com/guide/topics/resources/accessing-resources.html
2091 "actionType": "A String", # Required. The type of action that Robo should perform on the specified
2092 # element.
2093 },
2094 ],
2095 "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue
2096 # for the crawl.
2097 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2098 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2099 },
2100 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
2101 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2102 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2103 },
2104 "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least
2105 # 2 to make Robo explore the app beyond the first activity.
2106 # Default is 50.
2107 "startingIntents": [ # The intents used to launch the app for the crawl.
2108 # If none are provided, then the main launcher activity is launched.
2109 # If some are provided, then only those provided are launched (the main
2110 # launcher activity must be provided explicitly).
2111 { # Message for specifying the start activities to crawl.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2112 "timeout": "A String", # Timeout in seconds for each intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2113 "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details.
2114 "action": "A String", # Action name.
2115 # Required for START_ACTIVITY.
2116 "uri": "A String", # URI for the action.
2117 "categories": [ # Intent categories to set on the intent.
2118 "A String",
2119 ],
2120 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2121 "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity.
2122 },
2123 },
2124 ],
2125 "maxSteps": 42, # The max number of steps Robo can execute.
2126 # Default is no limit.
2127 "appPackageId": "A String", # The java package for the application under test.
2128 # The default value is determined by examining the application's manifest.
2129 "appInitialActivity": "A String", # The initial activity that should be used to start the app.
2130 },
2131 "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test.
2132 # independently of its normal lifecycle.
2133 # Android instrumentation tests run an application APK and test APK inside the
2134 # same process on a virtual or physical AndroidDevice. They also specify
2135 # a test runner class, such as com.google.GoogleTestRunner, which can vary
2136 # on the specific instrumentation framework chosen.
2137 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2138 # See &lt;http://developer.android.com/tools/testing/testing_android.html&gt; for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2139 # more information on types of Android tests.
2140 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
2141 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2142 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2143 # building App Bundles.
2144 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
2145 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2146 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2147 },
2148 },
2149 "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed.
2150 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2151 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2152 },
2153 "testRunnerClass": "A String", # The InstrumentationTestRunner class.
2154 # The default value is determined by examining the application's manifest.
2155 "testPackageId": "A String", # The java package for the test to be executed.
2156 # The default value is determined by examining the application's manifest.
2157 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
2158 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2159 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2160 },
2161 "appPackageId": "A String", # The java package for the application under test.
2162 # The default value is determined by examining the application's manifest.
2163 "orchestratorOption": "A String", # The option of whether running each test within its own invocation of
2164 # instrumentation with Android Test Orchestrator or not.
2165 # ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or
2166 # higher! **
2167 # Orchestrator offers the following benefits:
2168 # - No shared state
2169 # - Crashes are isolated
2170 # - Logs are scoped per test
2171 #
2172 # See
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2173 # &lt;https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2174 # for more information about Android Test Orchestrator.
2175 #
2176 # If not set, the test will be run without the orchestrator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2177 "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel.
2178 "manualSharding": { # Shards test cases into the specified groups of packages, classes, and/or # Shards test cases into the specified groups of packages, classes, and/or
2179 # methods.
2180 # methods.
2181 #
2182 # With manual sharding enabled, specifying test targets via
2183 # environment_variables or in InstrumentationTest is invalid.
2184 "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for
2185 # each shard. The number of shard_test_targets must be &gt;= 1 and &lt;= 50.
2186 { # Test targets for a shard.
2187 "testTargets": [ # Group of packages, classes, and/or test methods to be run for each shard.
2188 # The targets need to be specified in AndroidJUnitRunner argument format. For
2189 # example, “package com.my.packages” “class com.my.package.MyClass”.
2190 #
2191 # The number of shard_test_targets must be greater than 0.
2192 "A String",
2193 ],
2194 },
2195 ],
2196 },
2197 "uniformSharding": { # Uniformly shards test cases given a total number of shards. # Uniformly shards test cases given a total number of shards.
2198 #
2199 # For Instrumentation test, it will be translated to “-e numShard” “-e
2200 # shardIndex” AndroidJUnitRunner arguments. With uniform sharding enabled,
2201 # specifying these sharding arguments via environment_variables is invalid.
2202 "numShards": 42, # Required. Total number of shards. The number must be &gt;= 1 and &lt;= 50.
2203 },
2204 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2205 "testTargets": [ # Each target must be fully qualified with the package name or class name,
2206 # in one of these formats:
2207 # - "package package_name"
2208 # - "class package_name.class_name"
2209 # - "class package_name.class_name#method_name"
2210 #
2211 # If empty, all targets in the module will be run.
2212 "A String",
2213 ],
2214 },
2215 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2216 "projectId": "A String", # Output only. The cloud project that owns the test execution.
2217 "toolResultsStep": { # Represents a tool results step resource. # Output only. Where the results for this execution are written.
2218 #
2219 # This has the results of a TestExecution.
2220 "projectId": "A String", # Output only. The cloud project that owns the tool results step.
2221 "executionId": "A String", # Output only. A tool results execution ID.
2222 "stepId": "A String", # Output only. A tool results step ID.
2223 "historyId": "A String", # Output only. A tool results history ID.
2224 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2225 "testDetails": { # Additional details about the progress of the running test. # Output only. Additional details about the running test.
2226 "progressMessages": [ # Output only. Human-readable, detailed descriptions of the test's progress.
2227 # For example: "Provisioning a device", "Starting Test".
2228 #
2229 # During the course of execution new data may be appended
2230 # to the end of progress_messages.
2231 "A String",
2232 ],
2233 "errorMessage": "A String", # Output only. If the TestState is ERROR, then this string will contain
2234 # human-readable details about the error.
2235 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2236 },
2237 ],
2238 "testSpecification": { # A description of how to run the test. # Required. How to run the test.
2239 "iosTestSetup": { # A description of how to set up an iOS device prior to running the test. # Test setup requirements for iOS.
2240 "networkProfile": "A String", # The network traffic profile used for running the test.
2241 # Available network profiles can be queried by using the
2242 # NETWORK_CONFIGURATION environment type when calling
2243 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
2244 },
2245 "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest, via an .xctestrun file.
2246 # Xcode supports the option to "build for testing", which generates an
2247 # .xctestrun file that contains a test specification (arguments, test methods,
2248 # etc). This test type accepts a zip file containing the .xctestrun file and
2249 # the corresponding contents of the Build/Products directory that contains all
2250 # the binaries needed to run the tests.
2251 "xcodeVersion": "A String", # The Xcode version that should be used for the test.
2252 # Use the TestEnvironmentDiscoveryService to get supported options.
2253 # Defaults to the latest Xcode version Firebase Test Lab supports.
2254 "xctestrun": { # A reference to a file, used for user inputs. # An .xctestrun file that will override the .xctestrun file in the
2255 # tests zip. Because the .xctestrun file contains environment variables along
2256 # with test methods to run and/or ignore, this can be useful for sharding
2257 # tests. Default is taken from the tests zip.
2258 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2259 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2260 },
2261 "testsZip": { # A reference to a file, used for user inputs. # Required. The .zip containing the .xctestrun file and the contents of the
2262 # DerivedData/Build/Products directory.
2263 # The .xctestrun file in this zip is ignored if the xctestrun field is
2264 # specified.
2265 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2266 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2267 },
2268 "appBundleId": "A String", # Output only. The bundle id for the application under test.
2269 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2270 "iosTestLoop": { # A test of an iOS application that implements one or more game loop scenarios. # An iOS application with a test loop.
2271 # This test type accepts an archived application (.ipa file) and a list of
2272 # integer scenarios that will be executed on the app sequentially.
2273 "scenarios": [ # The list of scenarios that should be run during the test. Defaults to the
2274 # single scenario 0 if unspecified.
2275 42,
2276 ],
2277 "appBundleId": "A String", # Output only. The bundle id for the application under test.
2278 "appIpa": { # A reference to a file, used for user inputs. # Required. The .ipa of the application to test.
2279 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2280 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2281 },
2282 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2283 "testTimeout": "A String", # Max time a test execution is allowed to run before it is
2284 # automatically cancelled.
2285 # The default value is 5 min.
2286 "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
2287 # scripts.
2288 "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.
2289 "googleAuto": { # Enables automatic Google account login. # An automatic google login account.
2290 # If set, the service automatically generates a Google test account and adds
2291 # it to the device, before executing the test. Note that test accounts might be
2292 # reused.
2293 # Many applications show their full set of functionalities when an account is
2294 # present on the device. Logging into the device with these generated accounts
2295 # allows testing more functionalities.
2296 },
2297 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2298 "systrace": { # Systrace configuration for the run.
2299 # If set a systrace will be taken, starting on test start and lasting for the
2300 # configured duration. The systrace file thus obtained is put in the results
2301 # bucket together with the other artifacts from the run.
2302 "durationSeconds": 42, # Systrace duration in seconds.
2303 # Should be between 1 and 30 seconds. 0 disables systrace.
2304 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2305 "networkProfile": "A String", # The network traffic profile used for running the test.
2306 # Available network profiles can be queried by using the
2307 # NETWORK_CONFIGURATION environment type when calling
2308 # TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
2309 "directoriesToPull": [ # List of directories on the device to upload to GCS at the end of the test;
2310 # they must be absolute paths under /sdcard or /data/local/tmp.
2311 # Path names are restricted to characters a-z A-Z 0-9 _ - . + and /
2312 #
2313 # Note: The paths /sdcard and /data will be made available and treated as
2314 # implicit path substitutions. E.g. if /sdcard on a particular device does
2315 # not map to external storage, the system will replace it with the external
2316 # storage path prefix for that device.
2317 "A String",
2318 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2319 "environmentVariables": [ # Environment variables to set for the test (only applicable for
2320 # instrumentation tests).
2321 { # A key-value pair passed as an environment variable to the test.
2322 "key": "A String", # Key for the environment variable.
2323 "value": "A String", # Value for the environment variable.
2324 },
2325 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2326 "filesToPush": [ # List of files to push to the device before starting the test.
2327 { # A single device file description.
2328 "regularFile": { # A file or directory to install on the device before the test starts. # A reference to a regular file.
2329 "content": { # A reference to a file, used for user inputs. # Required. The source file.
2330 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2331 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2332 },
2333 "devicePath": "A String", # Required. Where to put the content on the device. Must be an absolute,
2334 # whitelisted path. If the file exists, it will be replaced.
2335 # The following device-side directories and any of their subdirectories are
2336 # whitelisted:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2337 # &lt;p&gt;${EXTERNAL_STORAGE}, or /sdcard&lt;/p&gt;
2338 # &lt;p&gt;${ANDROID_DATA}/local/tmp, or /data/local/tmp&lt;/p&gt;
2339 # &lt;p&gt;Specifying a path outside of these directory trees is invalid.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2340 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2341 # &lt;p&gt; The paths /sdcard and /data will be made available and treated as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2342 # implicit path substitutions. E.g. if /sdcard on a particular device does
2343 # not map to external storage, the system will replace it with the external
2344 # storage path prefix for that device and copy the file there.
2345 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2346 # &lt;p&gt; It is strongly advised to use the &lt;a href=
2347 # "http://developer.android.com/reference/android/os/Environment.html"&gt;
2348 # Environment API&lt;/a&gt; in app and test code to access files on the device in a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2349 # portable way.
2350 },
2351 "obbFile": { # An opaque binary blob file to install on the device before the test starts. # A reference to an opaque binary blob file.
2352 "obbFileName": "A String", # Required. OBB file name which must conform to the format as specified by
2353 # Android
2354 # e.g. [main|patch].0300110.com.example.android.obb
2355 # which will be installed into
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2356 # \&lt;shared-storage\&gt;/Android/obb/\&lt;package-name\&gt;/
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2357 # on the device.
2358 "obb": { # A reference to a file, used for user inputs. # Required. Opaque Binary Blob (OBB) file(s) to install on the device.
2359 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2360 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2361 },
2362 },
2363 },
2364 ],
2365 "additionalApks": [ # APKs to install in addition to those being directly tested.
2366 # Currently capped at 100.
2367 { # An Android package file to install.
2368 "packageName": "A String", # The java package for the APK to be installed.
2369 # Value is determined by examining the application's manifest.
2370 "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.
2371 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2372 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2373 },
2374 },
2375 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2376 },
2377 "disableVideoRecording": True or False, # Disables video recording. May reduce test latency.
2378 "androidTestLoop": { # A test of an Android Application with a Test Loop. # An Android Application with a Test Loop.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2379 # The intent \&lt;intent-name\&gt; will be implicitly added, since Games is the only
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2380 # user of this api, for the time being.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2381 "scenarios": [ # The list of scenarios that should be run during the test.
2382 # The default is all test loops, derived from the application's
2383 # manifest.
2384 42,
2385 ],
2386 "appPackageId": "A String", # The java package for the application under test.
2387 # The default is determined by examining the application's manifest.
2388 "scenarioLabels": [ # The list of scenario labels that should be run during the test.
2389 # The scenario labels should map to labels defined in the application's
2390 # manifest. For example, player_experience and
2391 # com.google.test.loops.player_experience add all of the loops labeled in the
2392 # manifest with the com.google.test.loops.player_experience name to the
2393 # execution.
2394 # Scenarios can also be specified in the scenarios field.
2395 "A String",
2396 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2397 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
2398 # a base module directory, zero or more dynamic feature module directories.
2399 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
2400 # building App Bundles.
2401 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
2402 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2403 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2404 },
2405 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2406 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
2407 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2408 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2409 },
2410 },
2411 "disablePerformanceMetrics": True or False, # Disables performance metrics recording. May reduce test latency.
2412 "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test.
2413 # or physical Android Device, finding culprits and crashes as it goes.
2414 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
2415 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2416 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2417 # building App Bundles.
2418 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
2419 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2420 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2421 },
2422 },
2423 "roboDirectives": [ # A set of directives Robo should apply during the crawl.
2424 # This allows users to customize the crawl. For example, the username and
2425 # password for a test account can be provided.
2426 { # Directs Robo to interact with a specific UI element if it is encountered
2427 # during the crawl. Currently, Robo can perform text entry or element click.
2428 "inputText": "A String", # The text that Robo is directed to set. If left empty, the directive will be
2429 # treated as a CLICK on the element matching the resource_name.
2430 "resourceName": "A String", # Required. The android resource name of the target UI element.
2431 # For example,
2432 # in Java: R.string.foo
2433 # in xml: @string/foo
2434 # Only the "foo" part is needed.
2435 # Reference doc:
2436 # https://developer.android.com/guide/topics/resources/accessing-resources.html
2437 "actionType": "A String", # Required. The type of action that Robo should perform on the specified
2438 # element.
2439 },
2440 ],
2441 "roboScript": { # A reference to a file, used for user inputs. # A JSON file with a sequence of actions Robo should perform as a prologue
2442 # for the crawl.
2443 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2444 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2445 },
2446 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
2447 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2448 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2449 },
2450 "maxDepth": 42, # The max depth of the traversal stack Robo can explore. Needs to be at least
2451 # 2 to make Robo explore the app beyond the first activity.
2452 # Default is 50.
2453 "startingIntents": [ # The intents used to launch the app for the crawl.
2454 # If none are provided, then the main launcher activity is launched.
2455 # If some are provided, then only those provided are launched (the main
2456 # launcher activity must be provided explicitly).
2457 { # Message for specifying the start activities to crawl.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2458 "timeout": "A String", # Timeout in seconds for each intent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2459 "startActivity": { # A starting intent specified by an action, uri, and categories. # An intent that starts an activity with specific details.
2460 "action": "A String", # Action name.
2461 # Required for START_ACTIVITY.
2462 "uri": "A String", # URI for the action.
2463 "categories": [ # Intent categories to set on the intent.
2464 "A String",
2465 ],
2466 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2467 "launcherActivity": { # Specifies an intent that starts the main launcher activity. # An intent that starts the main launcher activity.
2468 },
2469 },
2470 ],
2471 "maxSteps": 42, # The max number of steps Robo can execute.
2472 # Default is no limit.
2473 "appPackageId": "A String", # The java package for the application under test.
2474 # The default value is determined by examining the application's manifest.
2475 "appInitialActivity": "A String", # The initial activity that should be used to start the app.
2476 },
2477 "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test.
2478 # independently of its normal lifecycle.
2479 # Android instrumentation tests run an application APK and test APK inside the
2480 # same process on a virtual or physical AndroidDevice. They also specify
2481 # a test runner class, such as com.google.GoogleTestRunner, which can vary
2482 # on the specific instrumentation framework chosen.
2483 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2484 # See &lt;http://developer.android.com/tools/testing/testing_android.html&gt; for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2485 # more information on types of Android tests.
2486 "appBundle": { # An Android App Bundle file format, containing a BundleConfig.pb file, # A multi-apk app bundle for the application under test.
2487 # a base module directory, zero or more dynamic feature module directories.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2488 # &lt;p&gt;See https://developer.android.com/guide/app-bundle/build for guidance on
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2489 # building App Bundles.
2490 "bundleLocation": { # A reference to a file, used for user inputs. # .aab file representing the app bundle under test.
2491 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2492 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2493 },
2494 },
2495 "testApk": { # A reference to a file, used for user inputs. # Required. The APK containing the test code to be executed.
2496 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2497 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2498 },
2499 "testRunnerClass": "A String", # The InstrumentationTestRunner class.
2500 # The default value is determined by examining the application's manifest.
2501 "testPackageId": "A String", # The java package for the test to be executed.
2502 # The default value is determined by examining the application's manifest.
2503 "appApk": { # A reference to a file, used for user inputs. # The APK for the application under test.
2504 "gcsPath": "A String", # A path to a file in Google Cloud Storage.
2505 # Example: gs://build-app-1414623860166/app-debug-unaligned.apk
2506 },
2507 "appPackageId": "A String", # The java package for the application under test.
2508 # The default value is determined by examining the application's manifest.
2509 "orchestratorOption": "A String", # The option of whether running each test within its own invocation of
2510 # instrumentation with Android Test Orchestrator or not.
2511 # ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or
2512 # higher! **
2513 # Orchestrator offers the following benefits:
2514 # - No shared state
2515 # - Crashes are isolated
2516 # - Logs are scoped per test
2517 #
2518 # See
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2519 # &lt;https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2520 # for more information about Android Test Orchestrator.
2521 #
2522 # If not set, the test will be run without the orchestrator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2523 "shardingOption": { # Options for enabling sharding. # The option to run tests in multiple shards in parallel.
2524 "manualSharding": { # Shards test cases into the specified groups of packages, classes, and/or # Shards test cases into the specified groups of packages, classes, and/or
2525 # methods.
2526 # methods.
2527 #
2528 # With manual sharding enabled, specifying test targets via
2529 # environment_variables or in InstrumentationTest is invalid.
2530 "testTargetsForShard": [ # Required. Group of packages, classes, and/or test methods to be run for
2531 # each shard. The number of shard_test_targets must be &gt;= 1 and &lt;= 50.
2532 { # Test targets for a shard.
2533 "testTargets": [ # Group of packages, classes, and/or test methods to be run for each shard.
2534 # The targets need to be specified in AndroidJUnitRunner argument format. For
2535 # example, “package com.my.packages” “class com.my.package.MyClass”.
2536 #
2537 # The number of shard_test_targets must be greater than 0.
2538 "A String",
2539 ],
2540 },
2541 ],
2542 },
2543 "uniformSharding": { # Uniformly shards test cases given a total number of shards. # Uniformly shards test cases given a total number of shards.
2544 #
2545 # For Instrumentation test, it will be translated to “-e numShard” “-e
2546 # shardIndex” AndroidJUnitRunner arguments. With uniform sharding enabled,
2547 # specifying these sharding arguments via environment_variables is invalid.
2548 "numShards": 42, # Required. Total number of shards. The number must be &gt;= 1 and &lt;= 50.
2549 },
2550 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2551 "testTargets": [ # Each target must be fully qualified with the package name or class name,
2552 # in one of these formats:
2553 # - "package package_name"
2554 # - "class package_name.class_name"
2555 # - "class package_name.class_name#method_name"
2556 #
2557 # If empty, all targets in the module will be run.
2558 "A String",
2559 ],
2560 },
2561 },
2562 "testMatrixId": "A String", # Output only. Unique id set by the service.
2563 "timestamp": "A String", # Output only. The time this test matrix was initially created.
2564 "invalidMatrixDetails": "A String", # Output only. Describes why the matrix is considered invalid.
2565 # Only useful for matrices in the INVALID state.
2566 "environmentMatrix": { # The matrix of environments in which the test is to be executed. # Required. The devices the tests are being executed on.
2567 "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
2568 # devices.
2569 "androidDevices": [ # Required. A list of Android devices.
2570 { # A single Android device.
2571 "locale": "A String", # Required. The locale the test device used for testing.
2572 # Use the TestEnvironmentDiscoveryService to get supported options.
2573 "androidVersionId": "A String", # Required. The id of the Android OS version to be used.
2574 # Use the TestEnvironmentDiscoveryService to get supported options.
2575 "androidModelId": "A String", # Required. The id of the Android device to be used.
2576 # Use the TestEnvironmentDiscoveryService to get supported options.
2577 "orientation": "A String", # Required. How the device is oriented during the test.
2578 # Use the TestEnvironmentDiscoveryService to get supported options.
2579 },
2580 ],
2581 },
2582 "androidMatrix": { # A set of Android device configuration permutations is defined by the # A matrix of Android devices.
2583 # the cross-product of the given axes. Internally, the given AndroidMatrix
2584 # will be expanded into a set of AndroidDevices.
2585 #
2586 # Only supported permutations will be instantiated. Invalid permutations
2587 # (e.g., incompatible models/versions) are ignored.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2588 "orientations": [ # Required. The set of orientations to test with.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2589 # Use the TestEnvironmentDiscoveryService to get supported options.
2590 "A String",
2591 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2592 "locales": [ # Required. The set of locales the test device will enable for testing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2593 # Use the TestEnvironmentDiscoveryService to get supported options.
2594 "A String",
2595 ],
2596 "androidVersionIds": [ # Required. The ids of the set of Android OS version to be used.
2597 # Use the TestEnvironmentDiscoveryService to get supported options.
2598 "A String",
2599 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2600 "androidModelIds": [ # Required. The ids of the set of Android device to be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2601 # Use the TestEnvironmentDiscoveryService to get supported options.
2602 "A String",
2603 ],
2604 },
2605 "iosDeviceList": { # A list of iOS device configurations in which the test is to be executed. # A list of iOS devices.
2606 "iosDevices": [ # Required. A list of iOS devices.
2607 { # A single iOS device.
2608 "locale": "A String", # Required. The locale the test device used for testing.
2609 # Use the TestEnvironmentDiscoveryService to get supported options.
2610 "iosVersionId": "A String", # Required. The id of the iOS major software version to be used.
2611 # Use the TestEnvironmentDiscoveryService to get supported options.
2612 "orientation": "A String", # Required. How the device is oriented during the test.
2613 # Use the TestEnvironmentDiscoveryService to get supported options.
2614 "iosModelId": "A String", # Required. The id of the iOS device to be used.
2615 # Use the TestEnvironmentDiscoveryService to get supported options.
2616 },
2617 ],
2618 },
2619 },
2620 "outcomeSummary": "A String", # Output Only. The overall outcome of the test.
2621 # Only set when the test matrix state is FINISHED.
2622 }</pre>
2623</div>
2624
2625</body></html>