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