Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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="toolresults_v1beta3.html">Cloud Tool Results API</a> . <a href="toolresults_v1beta3.executions.html">executions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(projectId, historyId, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates an Execution.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(projectId, historyId, executionId, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Gets an Execution.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list">list(projectId, historyId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Lists Executions for a given History.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#patch">patch(projectId, historyId, executionId, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Updates an existing Execution with the supplied partial entity.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| 94 | <code class="details" id="create">create(projectId, historyId, body=None, requestId=None, x__xgafv=None)</code> |
| 95 | <pre>Creates an Execution. |
| 96 | |
| 97 | The returned Execution will have the id set. |
| 98 | |
| 99 | May return any of the following canonical error codes: |
| 100 | |
| 101 | - PERMISSION_DENIED - if the user is not authorized to write to project |
| 102 | - INVALID_ARGUMENT - if the request is malformed |
| 103 | - NOT_FOUND - if the containing History does not exist |
| 104 | |
| 105 | Args: |
| 106 | projectId: string, A Project id. |
| 107 | |
| 108 | Required. (required) |
| 109 | historyId: string, A History id. |
| 110 | |
| 111 | Required. (required) |
| 112 | body: object, The request body. |
| 113 | The object takes the form of: |
| 114 | |
| 115 | { # An Execution represents a collection of Steps. For instance, it could |
| 116 | # represent: |
| 117 | # - a mobile test executed across a range of device configurations |
| 118 | # - a jenkins job with a build step followed by a test step |
| 119 | # |
| 120 | # The maximum size of an execution message is 1 MiB. |
| 121 | # |
| 122 | # An Execution can be updated until its state is set to COMPLETE at which |
| 123 | # point it becomes immutable. |
| 124 | "completionTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution status transitioned to COMPLETE. |
| 125 | # |
| 126 | # This value will be set automatically when state transitions to |
| 127 | # COMPLETE. |
| 128 | # |
| 129 | # - In response: set if the execution state is COMPLETE. |
| 130 | # - In create/update request: never set |
| 131 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 132 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 133 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 134 | # Gregorian calendar backwards to year one. |
| 135 | # |
| 136 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 137 | # second table is needed for interpretation, using a [24-hour linear |
| 138 | # smear](https://developers.google.com/time/smear). |
| 139 | # |
| 140 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 141 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 142 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 143 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 144 | # second values with fractions must still have non-negative nanos values |
| 145 | # that count forward in time. Must be from 0 to 999,999,999 |
| 146 | # inclusive. |
| 147 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 148 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 149 | # 9999-12-31T23:59:59Z inclusive. |
| 150 | }, |
| 151 | "executionId": "A String", # A unique identifier within a History for this Execution. |
| 152 | # |
| 153 | # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. |
| 154 | # |
| 155 | # - In response always set |
| 156 | # - In create/update request: never set |
| 157 | "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE |
| 158 | # |
| 159 | # - In response: present if set by create/update request |
| 160 | # - In create/update request: optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 161 | "successDetail": { # Details for an outcome with a SUCCESS outcome summary. # More information about a SUCCESS outcome. |
| 162 | # |
| 163 | # Returns INVALID_ARGUMENT if this field is set |
| 164 | # but the summary is not SUCCESS. |
| 165 | # |
| 166 | # Optional |
| 167 | # LINT.IfChange |
| 168 | "otherNativeCrash": True or False, # If a native process other than the app crashed. |
| 169 | }, |
| 170 | "skippedDetail": { # Details for an outcome with a SKIPPED outcome summary. # More information about a SKIPPED outcome. |
| 171 | # |
| 172 | # Returns INVALID_ARGUMENT if this field is set |
| 173 | # but the summary is not SKIPPED. |
| 174 | # |
| 175 | # Optional |
| 176 | "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level. |
| 177 | "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model. |
| 178 | "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86. |
| 179 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 180 | "summary": "A String", # The simplest way to interpret a result. |
| 181 | # |
| 182 | # Required |
| 183 | "failureDetail": { # Details for an outcome with a FAILURE outcome summary. # More information about a FAILURE outcome. |
| 184 | # |
| 185 | # Returns INVALID_ARGUMENT if this field is set |
| 186 | # but the summary is not FAILURE. |
| 187 | # |
| 188 | # Optional |
| 189 | "crashed": True or False, # If the failure was severe because the system (app) under test crashed. |
| 190 | "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not |
| 191 | # start. |
| 192 | "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. |
| 193 | # This might be caused by trying to run a test on an unsupported platform. |
| 194 | "timedOut": True or False, # If the test overran some time limit, and that is why it failed. |
| 195 | "otherNativeCrash": True or False, # If a native process (including any other than the app) crashed. |
| 196 | }, |
| 197 | "inconclusiveDetail": { # Details for an outcome with an INCONCLUSIVE outcome summary. # More information about an INCONCLUSIVE outcome. |
| 198 | # |
| 199 | # Returns INVALID_ARGUMENT if this field is set |
| 200 | # but the summary is not INCONCLUSIVE. |
| 201 | # |
| 202 | # Optional |
| 203 | "hasErrorLogs": True or False, # If results are being provided to the user in certain cases of |
| 204 | # infrastructure failures |
| 205 | "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test |
| 206 | # depends on a component other than the system under test which failed. |
| 207 | # |
| 208 | # For example, a mobile test requires provisioning a device where the test |
| 209 | # executes, and that provisioning can fail. |
| 210 | "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be |
| 211 | # determined. |
| 212 | # For example, the user pressed ctrl-c which sent a kill signal to the test |
| 213 | # runner while the test was running. |
| 214 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 215 | }, |
| 216 | "specification": { # The details about how to run the execution. # Lightweight information about execution request. |
| 217 | # |
| 218 | # - In response: present if set by create |
| 219 | # - In create: optional |
| 220 | # - In update: optional |
| 221 | "iosTest": { # A iOS mobile test specification # An iOS mobile test execution specification. |
| 222 | "iosAppInfo": { # iOS app information # Information about the application under test. |
| 223 | "name": "A String", # The name of the app. |
| 224 | # Required |
| 225 | }, |
| 226 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 227 | # automatically cancelled. |
| 228 | # A Duration represents a signed, fixed-length span of time represented |
| 229 | # as a count of seconds and fractions of seconds at nanosecond |
| 230 | # resolution. It is independent of any calendar and concepts like "day" |
| 231 | # or "month". It is related to Timestamp in that the difference between |
| 232 | # two Timestamp values is a Duration and it can be added or subtracted |
| 233 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 234 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 235 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 236 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 238 | # of time. Durations less than one second are represented with a 0 |
| 239 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 240 | # of one second or more, a non-zero value for the `nanos` field must be |
| 241 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 242 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 243 | }, |
| 244 | "iosRoboTest": { # A Robo test for an iOS application. # An iOS Robo test. |
| 245 | }, |
| 246 | "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest. |
| 247 | "xcodeVersion": "A String", # Xcode version that the test was run with. |
| 248 | "bundleId": "A String", # Bundle ID of the app. |
| 249 | }, |
| 250 | "iosTestLoop": { # A game loop test of an iOS application. # An iOS test loop. |
| 251 | "bundleId": "A String", # Bundle ID of the app. |
| 252 | }, |
| 253 | }, |
| 254 | "androidTest": { # An Android mobile test specification. # An Android mobile test execution specification. |
| 255 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 256 | # automatically cancelled. |
| 257 | # A Duration represents a signed, fixed-length span of time represented |
| 258 | # as a count of seconds and fractions of seconds at nanosecond |
| 259 | # resolution. It is independent of any calendar and concepts like "day" |
| 260 | # or "month". It is related to Timestamp in that the difference between |
| 261 | # two Timestamp values is a Duration and it can be added or subtracted |
| 262 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 263 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 264 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 265 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 266 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 267 | # of time. Durations less than one second are represented with a 0 |
| 268 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 269 | # of one second or more, a non-zero value for the `nanos` field must be |
| 270 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 271 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 272 | }, |
| 273 | "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test. |
| 274 | # or physical Android device, finding culprits and crashes as it goes. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 275 | "bootstrapPackageId": "A String", # The java package for the bootstrap. |
| 276 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 277 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 278 | # Optional |
| 279 | "bootstrapRunnerClass": "A String", # The runner class for the bootstrap. |
| 280 | # Optional |
| 281 | "maxSteps": 42, # The max number of steps/actions Robo can execute. |
| 282 | # Default is no limit (0). |
| 283 | # Optional |
| 284 | "maxDepth": 42, # The max depth of the traversal stack Robo can explore. |
| 285 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 286 | }, |
| 287 | "androidTestLoop": { # Test Loops are tests that can be launched by the app itself, determining # An Android test loop. |
| 288 | # when to run by listening for an intent. |
| 289 | }, |
| 290 | "androidAppInfo": { # Android app information. # Information about the application under test. |
| 291 | "name": "A String", # The name of the app. |
| 292 | # Optional |
| 293 | "packageName": "A String", # The package name of the app. |
| 294 | # Required. |
| 295 | "versionName": "A String", # The version name of the app. |
| 296 | # Optional. |
| 297 | "versionCode": "A String", # The internal version code of the app. |
| 298 | # Optional. |
| 299 | }, |
| 300 | "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test. |
| 301 | # independently of its normal lifecycle. |
| 302 | # |
| 303 | # See <http://developer.android.com/tools/testing/testing_android.html> for |
| 304 | # more information on types of Android tests. |
| 305 | "testPackageId": "A String", # The java package for the test to be executed. |
| 306 | # Required |
| 307 | "testTargets": [ # Each target must be fully qualified with the package name or class name, |
| 308 | # in one of these formats: |
| 309 | # - "package package_name" |
| 310 | # - "class package_name.class_name" |
| 311 | # - "class package_name.class_name#method_name" |
| 312 | # |
| 313 | # If empty, all targets in the module will be run. |
| 314 | "A String", |
| 315 | ], |
| 316 | "useOrchestrator": True or False, # The flag indicates whether Android Test Orchestrator will be used to run |
| 317 | # test or not. |
| 318 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. |
| 319 | # Required |
| 320 | }, |
| 321 | }, |
| 322 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 323 | "dimensionDefinitions": [ # The dimensions along which different steps in this execution may vary. |
| 324 | # This must remain fixed over the life of the execution. |
| 325 | # |
| 326 | # Returns INVALID_ARGUMENT if this field is set in an update request. |
| 327 | # |
| 328 | # Returns INVALID_ARGUMENT if the same name occurs in more than one |
| 329 | # dimension_definition. |
| 330 | # |
| 331 | # Returns INVALID_ARGUMENT if the size of the list is over 100. |
| 332 | # |
| 333 | # - In response: present if set by create |
| 334 | # - In create request: optional |
| 335 | # - In update request: never set |
| 336 | { # One dimension of the matrix of different runs of a step. |
| 337 | }, |
| 338 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 339 | "creationTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution was created. |
| 340 | # |
| 341 | # This value will be set automatically when CreateExecution is called. |
| 342 | # |
| 343 | # - In response: always set |
| 344 | # - In create/update request: never set |
| 345 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 346 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 347 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 348 | # Gregorian calendar backwards to year one. |
| 349 | # |
| 350 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 351 | # second table is needed for interpretation, using a [24-hour linear |
| 352 | # smear](https://developers.google.com/time/smear). |
| 353 | # |
| 354 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 355 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 356 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 357 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 358 | # second values with fractions must still have non-negative nanos values |
| 359 | # that count forward in time. Must be from 0 to 999,999,999 |
| 360 | # inclusive. |
| 361 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 362 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 363 | # 9999-12-31T23:59:59Z inclusive. |
| 364 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 365 | "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the TestExecutionService uses. |
| 366 | # |
| 367 | # - In response: present if set by create |
| 368 | # - In create: optional |
| 369 | # - In update: never set |
| 370 | "state": "A String", # The initial state is IN_PROGRESS. |
| 371 | # |
| 372 | # The only legal state transitions is from IN_PROGRESS to COMPLETE. |
| 373 | # |
| 374 | # A PRECONDITION_FAILED will be returned if an invalid transition is |
| 375 | # requested. |
| 376 | # |
| 377 | # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be |
| 378 | # returned if the state is set to COMPLETE multiple times. |
| 379 | # |
| 380 | # If the state is set to COMPLETE, all the in-progress steps within the |
| 381 | # execution will be set as COMPLETE. If the outcome of the step is not set, |
| 382 | # the outcome will be set to INCONCLUSIVE. |
| 383 | # |
| 384 | # - In response always set |
| 385 | # - In create/update request: optional |
| 386 | } |
| 387 | |
| 388 | requestId: string, A unique request ID for server to detect duplicated requests. |
| 389 | For example, a UUID. |
| 390 | |
| 391 | Optional, but strongly recommended. |
| 392 | x__xgafv: string, V1 error format. |
| 393 | Allowed values |
| 394 | 1 - v1 error format |
| 395 | 2 - v2 error format |
| 396 | |
| 397 | Returns: |
| 398 | An object of the form: |
| 399 | |
| 400 | { # An Execution represents a collection of Steps. For instance, it could |
| 401 | # represent: |
| 402 | # - a mobile test executed across a range of device configurations |
| 403 | # - a jenkins job with a build step followed by a test step |
| 404 | # |
| 405 | # The maximum size of an execution message is 1 MiB. |
| 406 | # |
| 407 | # An Execution can be updated until its state is set to COMPLETE at which |
| 408 | # point it becomes immutable. |
| 409 | "completionTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution status transitioned to COMPLETE. |
| 410 | # |
| 411 | # This value will be set automatically when state transitions to |
| 412 | # COMPLETE. |
| 413 | # |
| 414 | # - In response: set if the execution state is COMPLETE. |
| 415 | # - In create/update request: never set |
| 416 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 417 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 418 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 419 | # Gregorian calendar backwards to year one. |
| 420 | # |
| 421 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 422 | # second table is needed for interpretation, using a [24-hour linear |
| 423 | # smear](https://developers.google.com/time/smear). |
| 424 | # |
| 425 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 426 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 427 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 428 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 429 | # second values with fractions must still have non-negative nanos values |
| 430 | # that count forward in time. Must be from 0 to 999,999,999 |
| 431 | # inclusive. |
| 432 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 433 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 434 | # 9999-12-31T23:59:59Z inclusive. |
| 435 | }, |
| 436 | "executionId": "A String", # A unique identifier within a History for this Execution. |
| 437 | # |
| 438 | # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. |
| 439 | # |
| 440 | # - In response always set |
| 441 | # - In create/update request: never set |
| 442 | "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE |
| 443 | # |
| 444 | # - In response: present if set by create/update request |
| 445 | # - In create/update request: optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 446 | "successDetail": { # Details for an outcome with a SUCCESS outcome summary. # More information about a SUCCESS outcome. |
| 447 | # |
| 448 | # Returns INVALID_ARGUMENT if this field is set |
| 449 | # but the summary is not SUCCESS. |
| 450 | # |
| 451 | # Optional |
| 452 | # LINT.IfChange |
| 453 | "otherNativeCrash": True or False, # If a native process other than the app crashed. |
| 454 | }, |
| 455 | "skippedDetail": { # Details for an outcome with a SKIPPED outcome summary. # More information about a SKIPPED outcome. |
| 456 | # |
| 457 | # Returns INVALID_ARGUMENT if this field is set |
| 458 | # but the summary is not SKIPPED. |
| 459 | # |
| 460 | # Optional |
| 461 | "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level. |
| 462 | "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model. |
| 463 | "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86. |
| 464 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 465 | "summary": "A String", # The simplest way to interpret a result. |
| 466 | # |
| 467 | # Required |
| 468 | "failureDetail": { # Details for an outcome with a FAILURE outcome summary. # More information about a FAILURE outcome. |
| 469 | # |
| 470 | # Returns INVALID_ARGUMENT if this field is set |
| 471 | # but the summary is not FAILURE. |
| 472 | # |
| 473 | # Optional |
| 474 | "crashed": True or False, # If the failure was severe because the system (app) under test crashed. |
| 475 | "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not |
| 476 | # start. |
| 477 | "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. |
| 478 | # This might be caused by trying to run a test on an unsupported platform. |
| 479 | "timedOut": True or False, # If the test overran some time limit, and that is why it failed. |
| 480 | "otherNativeCrash": True or False, # If a native process (including any other than the app) crashed. |
| 481 | }, |
| 482 | "inconclusiveDetail": { # Details for an outcome with an INCONCLUSIVE outcome summary. # More information about an INCONCLUSIVE outcome. |
| 483 | # |
| 484 | # Returns INVALID_ARGUMENT if this field is set |
| 485 | # but the summary is not INCONCLUSIVE. |
| 486 | # |
| 487 | # Optional |
| 488 | "hasErrorLogs": True or False, # If results are being provided to the user in certain cases of |
| 489 | # infrastructure failures |
| 490 | "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test |
| 491 | # depends on a component other than the system under test which failed. |
| 492 | # |
| 493 | # For example, a mobile test requires provisioning a device where the test |
| 494 | # executes, and that provisioning can fail. |
| 495 | "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be |
| 496 | # determined. |
| 497 | # For example, the user pressed ctrl-c which sent a kill signal to the test |
| 498 | # runner while the test was running. |
| 499 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 500 | }, |
| 501 | "specification": { # The details about how to run the execution. # Lightweight information about execution request. |
| 502 | # |
| 503 | # - In response: present if set by create |
| 504 | # - In create: optional |
| 505 | # - In update: optional |
| 506 | "iosTest": { # A iOS mobile test specification # An iOS mobile test execution specification. |
| 507 | "iosAppInfo": { # iOS app information # Information about the application under test. |
| 508 | "name": "A String", # The name of the app. |
| 509 | # Required |
| 510 | }, |
| 511 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 512 | # automatically cancelled. |
| 513 | # A Duration represents a signed, fixed-length span of time represented |
| 514 | # as a count of seconds and fractions of seconds at nanosecond |
| 515 | # resolution. It is independent of any calendar and concepts like "day" |
| 516 | # or "month". It is related to Timestamp in that the difference between |
| 517 | # two Timestamp values is a Duration and it can be added or subtracted |
| 518 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 519 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 520 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 521 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 522 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 523 | # of time. Durations less than one second are represented with a 0 |
| 524 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 525 | # of one second or more, a non-zero value for the `nanos` field must be |
| 526 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 527 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 528 | }, |
| 529 | "iosRoboTest": { # A Robo test for an iOS application. # An iOS Robo test. |
| 530 | }, |
| 531 | "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest. |
| 532 | "xcodeVersion": "A String", # Xcode version that the test was run with. |
| 533 | "bundleId": "A String", # Bundle ID of the app. |
| 534 | }, |
| 535 | "iosTestLoop": { # A game loop test of an iOS application. # An iOS test loop. |
| 536 | "bundleId": "A String", # Bundle ID of the app. |
| 537 | }, |
| 538 | }, |
| 539 | "androidTest": { # An Android mobile test specification. # An Android mobile test execution specification. |
| 540 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 541 | # automatically cancelled. |
| 542 | # A Duration represents a signed, fixed-length span of time represented |
| 543 | # as a count of seconds and fractions of seconds at nanosecond |
| 544 | # resolution. It is independent of any calendar and concepts like "day" |
| 545 | # or "month". It is related to Timestamp in that the difference between |
| 546 | # two Timestamp values is a Duration and it can be added or subtracted |
| 547 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 548 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 549 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 550 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 551 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 552 | # of time. Durations less than one second are represented with a 0 |
| 553 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 554 | # of one second or more, a non-zero value for the `nanos` field must be |
| 555 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 556 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 557 | }, |
| 558 | "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test. |
| 559 | # or physical Android device, finding culprits and crashes as it goes. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 560 | "bootstrapPackageId": "A String", # The java package for the bootstrap. |
| 561 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 562 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 563 | # Optional |
| 564 | "bootstrapRunnerClass": "A String", # The runner class for the bootstrap. |
| 565 | # Optional |
| 566 | "maxSteps": 42, # The max number of steps/actions Robo can execute. |
| 567 | # Default is no limit (0). |
| 568 | # Optional |
| 569 | "maxDepth": 42, # The max depth of the traversal stack Robo can explore. |
| 570 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 571 | }, |
| 572 | "androidTestLoop": { # Test Loops are tests that can be launched by the app itself, determining # An Android test loop. |
| 573 | # when to run by listening for an intent. |
| 574 | }, |
| 575 | "androidAppInfo": { # Android app information. # Information about the application under test. |
| 576 | "name": "A String", # The name of the app. |
| 577 | # Optional |
| 578 | "packageName": "A String", # The package name of the app. |
| 579 | # Required. |
| 580 | "versionName": "A String", # The version name of the app. |
| 581 | # Optional. |
| 582 | "versionCode": "A String", # The internal version code of the app. |
| 583 | # Optional. |
| 584 | }, |
| 585 | "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test. |
| 586 | # independently of its normal lifecycle. |
| 587 | # |
| 588 | # See <http://developer.android.com/tools/testing/testing_android.html> for |
| 589 | # more information on types of Android tests. |
| 590 | "testPackageId": "A String", # The java package for the test to be executed. |
| 591 | # Required |
| 592 | "testTargets": [ # Each target must be fully qualified with the package name or class name, |
| 593 | # in one of these formats: |
| 594 | # - "package package_name" |
| 595 | # - "class package_name.class_name" |
| 596 | # - "class package_name.class_name#method_name" |
| 597 | # |
| 598 | # If empty, all targets in the module will be run. |
| 599 | "A String", |
| 600 | ], |
| 601 | "useOrchestrator": True or False, # The flag indicates whether Android Test Orchestrator will be used to run |
| 602 | # test or not. |
| 603 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. |
| 604 | # Required |
| 605 | }, |
| 606 | }, |
| 607 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 608 | "dimensionDefinitions": [ # The dimensions along which different steps in this execution may vary. |
| 609 | # This must remain fixed over the life of the execution. |
| 610 | # |
| 611 | # Returns INVALID_ARGUMENT if this field is set in an update request. |
| 612 | # |
| 613 | # Returns INVALID_ARGUMENT if the same name occurs in more than one |
| 614 | # dimension_definition. |
| 615 | # |
| 616 | # Returns INVALID_ARGUMENT if the size of the list is over 100. |
| 617 | # |
| 618 | # - In response: present if set by create |
| 619 | # - In create request: optional |
| 620 | # - In update request: never set |
| 621 | { # One dimension of the matrix of different runs of a step. |
| 622 | }, |
| 623 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 624 | "creationTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution was created. |
| 625 | # |
| 626 | # This value will be set automatically when CreateExecution is called. |
| 627 | # |
| 628 | # - In response: always set |
| 629 | # - In create/update request: never set |
| 630 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 631 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 632 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 633 | # Gregorian calendar backwards to year one. |
| 634 | # |
| 635 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 636 | # second table is needed for interpretation, using a [24-hour linear |
| 637 | # smear](https://developers.google.com/time/smear). |
| 638 | # |
| 639 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 640 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 641 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 642 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 643 | # second values with fractions must still have non-negative nanos values |
| 644 | # that count forward in time. Must be from 0 to 999,999,999 |
| 645 | # inclusive. |
| 646 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 647 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 648 | # 9999-12-31T23:59:59Z inclusive. |
| 649 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 650 | "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the TestExecutionService uses. |
| 651 | # |
| 652 | # - In response: present if set by create |
| 653 | # - In create: optional |
| 654 | # - In update: never set |
| 655 | "state": "A String", # The initial state is IN_PROGRESS. |
| 656 | # |
| 657 | # The only legal state transitions is from IN_PROGRESS to COMPLETE. |
| 658 | # |
| 659 | # A PRECONDITION_FAILED will be returned if an invalid transition is |
| 660 | # requested. |
| 661 | # |
| 662 | # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be |
| 663 | # returned if the state is set to COMPLETE multiple times. |
| 664 | # |
| 665 | # If the state is set to COMPLETE, all the in-progress steps within the |
| 666 | # execution will be set as COMPLETE. If the outcome of the step is not set, |
| 667 | # the outcome will be set to INCONCLUSIVE. |
| 668 | # |
| 669 | # - In response always set |
| 670 | # - In create/update request: optional |
| 671 | }</pre> |
| 672 | </div> |
| 673 | |
| 674 | <div class="method"> |
| 675 | <code class="details" id="get">get(projectId, historyId, executionId, x__xgafv=None)</code> |
| 676 | <pre>Gets an Execution. |
| 677 | |
| 678 | May return any of the following canonical error codes: |
| 679 | |
| 680 | - PERMISSION_DENIED - if the user is not authorized to write to project |
| 681 | - INVALID_ARGUMENT - if the request is malformed |
| 682 | - NOT_FOUND - if the Execution does not exist |
| 683 | |
| 684 | Args: |
| 685 | projectId: string, A Project id. |
| 686 | |
| 687 | Required. (required) |
| 688 | historyId: string, A History id. |
| 689 | |
| 690 | Required. (required) |
| 691 | executionId: string, An Execution id. |
| 692 | |
| 693 | Required. (required) |
| 694 | x__xgafv: string, V1 error format. |
| 695 | Allowed values |
| 696 | 1 - v1 error format |
| 697 | 2 - v2 error format |
| 698 | |
| 699 | Returns: |
| 700 | An object of the form: |
| 701 | |
| 702 | { # An Execution represents a collection of Steps. For instance, it could |
| 703 | # represent: |
| 704 | # - a mobile test executed across a range of device configurations |
| 705 | # - a jenkins job with a build step followed by a test step |
| 706 | # |
| 707 | # The maximum size of an execution message is 1 MiB. |
| 708 | # |
| 709 | # An Execution can be updated until its state is set to COMPLETE at which |
| 710 | # point it becomes immutable. |
| 711 | "completionTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution status transitioned to COMPLETE. |
| 712 | # |
| 713 | # This value will be set automatically when state transitions to |
| 714 | # COMPLETE. |
| 715 | # |
| 716 | # - In response: set if the execution state is COMPLETE. |
| 717 | # - In create/update request: never set |
| 718 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 719 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 720 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 721 | # Gregorian calendar backwards to year one. |
| 722 | # |
| 723 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 724 | # second table is needed for interpretation, using a [24-hour linear |
| 725 | # smear](https://developers.google.com/time/smear). |
| 726 | # |
| 727 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 728 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 729 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 730 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 731 | # second values with fractions must still have non-negative nanos values |
| 732 | # that count forward in time. Must be from 0 to 999,999,999 |
| 733 | # inclusive. |
| 734 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 735 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 736 | # 9999-12-31T23:59:59Z inclusive. |
| 737 | }, |
| 738 | "executionId": "A String", # A unique identifier within a History for this Execution. |
| 739 | # |
| 740 | # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. |
| 741 | # |
| 742 | # - In response always set |
| 743 | # - In create/update request: never set |
| 744 | "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE |
| 745 | # |
| 746 | # - In response: present if set by create/update request |
| 747 | # - In create/update request: optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 748 | "successDetail": { # Details for an outcome with a SUCCESS outcome summary. # More information about a SUCCESS outcome. |
| 749 | # |
| 750 | # Returns INVALID_ARGUMENT if this field is set |
| 751 | # but the summary is not SUCCESS. |
| 752 | # |
| 753 | # Optional |
| 754 | # LINT.IfChange |
| 755 | "otherNativeCrash": True or False, # If a native process other than the app crashed. |
| 756 | }, |
| 757 | "skippedDetail": { # Details for an outcome with a SKIPPED outcome summary. # More information about a SKIPPED outcome. |
| 758 | # |
| 759 | # Returns INVALID_ARGUMENT if this field is set |
| 760 | # but the summary is not SKIPPED. |
| 761 | # |
| 762 | # Optional |
| 763 | "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level. |
| 764 | "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model. |
| 765 | "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86. |
| 766 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 767 | "summary": "A String", # The simplest way to interpret a result. |
| 768 | # |
| 769 | # Required |
| 770 | "failureDetail": { # Details for an outcome with a FAILURE outcome summary. # More information about a FAILURE outcome. |
| 771 | # |
| 772 | # Returns INVALID_ARGUMENT if this field is set |
| 773 | # but the summary is not FAILURE. |
| 774 | # |
| 775 | # Optional |
| 776 | "crashed": True or False, # If the failure was severe because the system (app) under test crashed. |
| 777 | "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not |
| 778 | # start. |
| 779 | "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. |
| 780 | # This might be caused by trying to run a test on an unsupported platform. |
| 781 | "timedOut": True or False, # If the test overran some time limit, and that is why it failed. |
| 782 | "otherNativeCrash": True or False, # If a native process (including any other than the app) crashed. |
| 783 | }, |
| 784 | "inconclusiveDetail": { # Details for an outcome with an INCONCLUSIVE outcome summary. # More information about an INCONCLUSIVE outcome. |
| 785 | # |
| 786 | # Returns INVALID_ARGUMENT if this field is set |
| 787 | # but the summary is not INCONCLUSIVE. |
| 788 | # |
| 789 | # Optional |
| 790 | "hasErrorLogs": True or False, # If results are being provided to the user in certain cases of |
| 791 | # infrastructure failures |
| 792 | "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test |
| 793 | # depends on a component other than the system under test which failed. |
| 794 | # |
| 795 | # For example, a mobile test requires provisioning a device where the test |
| 796 | # executes, and that provisioning can fail. |
| 797 | "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be |
| 798 | # determined. |
| 799 | # For example, the user pressed ctrl-c which sent a kill signal to the test |
| 800 | # runner while the test was running. |
| 801 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 802 | }, |
| 803 | "specification": { # The details about how to run the execution. # Lightweight information about execution request. |
| 804 | # |
| 805 | # - In response: present if set by create |
| 806 | # - In create: optional |
| 807 | # - In update: optional |
| 808 | "iosTest": { # A iOS mobile test specification # An iOS mobile test execution specification. |
| 809 | "iosAppInfo": { # iOS app information # Information about the application under test. |
| 810 | "name": "A String", # The name of the app. |
| 811 | # Required |
| 812 | }, |
| 813 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 814 | # automatically cancelled. |
| 815 | # A Duration represents a signed, fixed-length span of time represented |
| 816 | # as a count of seconds and fractions of seconds at nanosecond |
| 817 | # resolution. It is independent of any calendar and concepts like "day" |
| 818 | # or "month". It is related to Timestamp in that the difference between |
| 819 | # two Timestamp values is a Duration and it can be added or subtracted |
| 820 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 821 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 822 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 823 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 824 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 825 | # of time. Durations less than one second are represented with a 0 |
| 826 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 827 | # of one second or more, a non-zero value for the `nanos` field must be |
| 828 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 829 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 830 | }, |
| 831 | "iosRoboTest": { # A Robo test for an iOS application. # An iOS Robo test. |
| 832 | }, |
| 833 | "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest. |
| 834 | "xcodeVersion": "A String", # Xcode version that the test was run with. |
| 835 | "bundleId": "A String", # Bundle ID of the app. |
| 836 | }, |
| 837 | "iosTestLoop": { # A game loop test of an iOS application. # An iOS test loop. |
| 838 | "bundleId": "A String", # Bundle ID of the app. |
| 839 | }, |
| 840 | }, |
| 841 | "androidTest": { # An Android mobile test specification. # An Android mobile test execution specification. |
| 842 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 843 | # automatically cancelled. |
| 844 | # A Duration represents a signed, fixed-length span of time represented |
| 845 | # as a count of seconds and fractions of seconds at nanosecond |
| 846 | # resolution. It is independent of any calendar and concepts like "day" |
| 847 | # or "month". It is related to Timestamp in that the difference between |
| 848 | # two Timestamp values is a Duration and it can be added or subtracted |
| 849 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 850 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 851 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 852 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 853 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 854 | # of time. Durations less than one second are represented with a 0 |
| 855 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 856 | # of one second or more, a non-zero value for the `nanos` field must be |
| 857 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 858 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 859 | }, |
| 860 | "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test. |
| 861 | # or physical Android device, finding culprits and crashes as it goes. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 862 | "bootstrapPackageId": "A String", # The java package for the bootstrap. |
| 863 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 864 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 865 | # Optional |
| 866 | "bootstrapRunnerClass": "A String", # The runner class for the bootstrap. |
| 867 | # Optional |
| 868 | "maxSteps": 42, # The max number of steps/actions Robo can execute. |
| 869 | # Default is no limit (0). |
| 870 | # Optional |
| 871 | "maxDepth": 42, # The max depth of the traversal stack Robo can explore. |
| 872 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 873 | }, |
| 874 | "androidTestLoop": { # Test Loops are tests that can be launched by the app itself, determining # An Android test loop. |
| 875 | # when to run by listening for an intent. |
| 876 | }, |
| 877 | "androidAppInfo": { # Android app information. # Information about the application under test. |
| 878 | "name": "A String", # The name of the app. |
| 879 | # Optional |
| 880 | "packageName": "A String", # The package name of the app. |
| 881 | # Required. |
| 882 | "versionName": "A String", # The version name of the app. |
| 883 | # Optional. |
| 884 | "versionCode": "A String", # The internal version code of the app. |
| 885 | # Optional. |
| 886 | }, |
| 887 | "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test. |
| 888 | # independently of its normal lifecycle. |
| 889 | # |
| 890 | # See <http://developer.android.com/tools/testing/testing_android.html> for |
| 891 | # more information on types of Android tests. |
| 892 | "testPackageId": "A String", # The java package for the test to be executed. |
| 893 | # Required |
| 894 | "testTargets": [ # Each target must be fully qualified with the package name or class name, |
| 895 | # in one of these formats: |
| 896 | # - "package package_name" |
| 897 | # - "class package_name.class_name" |
| 898 | # - "class package_name.class_name#method_name" |
| 899 | # |
| 900 | # If empty, all targets in the module will be run. |
| 901 | "A String", |
| 902 | ], |
| 903 | "useOrchestrator": True or False, # The flag indicates whether Android Test Orchestrator will be used to run |
| 904 | # test or not. |
| 905 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. |
| 906 | # Required |
| 907 | }, |
| 908 | }, |
| 909 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 910 | "dimensionDefinitions": [ # The dimensions along which different steps in this execution may vary. |
| 911 | # This must remain fixed over the life of the execution. |
| 912 | # |
| 913 | # Returns INVALID_ARGUMENT if this field is set in an update request. |
| 914 | # |
| 915 | # Returns INVALID_ARGUMENT if the same name occurs in more than one |
| 916 | # dimension_definition. |
| 917 | # |
| 918 | # Returns INVALID_ARGUMENT if the size of the list is over 100. |
| 919 | # |
| 920 | # - In response: present if set by create |
| 921 | # - In create request: optional |
| 922 | # - In update request: never set |
| 923 | { # One dimension of the matrix of different runs of a step. |
| 924 | }, |
| 925 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 926 | "creationTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution was created. |
| 927 | # |
| 928 | # This value will be set automatically when CreateExecution is called. |
| 929 | # |
| 930 | # - In response: always set |
| 931 | # - In create/update request: never set |
| 932 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 933 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 934 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 935 | # Gregorian calendar backwards to year one. |
| 936 | # |
| 937 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 938 | # second table is needed for interpretation, using a [24-hour linear |
| 939 | # smear](https://developers.google.com/time/smear). |
| 940 | # |
| 941 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 942 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 943 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 944 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 945 | # second values with fractions must still have non-negative nanos values |
| 946 | # that count forward in time. Must be from 0 to 999,999,999 |
| 947 | # inclusive. |
| 948 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 949 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 950 | # 9999-12-31T23:59:59Z inclusive. |
| 951 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 952 | "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the TestExecutionService uses. |
| 953 | # |
| 954 | # - In response: present if set by create |
| 955 | # - In create: optional |
| 956 | # - In update: never set |
| 957 | "state": "A String", # The initial state is IN_PROGRESS. |
| 958 | # |
| 959 | # The only legal state transitions is from IN_PROGRESS to COMPLETE. |
| 960 | # |
| 961 | # A PRECONDITION_FAILED will be returned if an invalid transition is |
| 962 | # requested. |
| 963 | # |
| 964 | # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be |
| 965 | # returned if the state is set to COMPLETE multiple times. |
| 966 | # |
| 967 | # If the state is set to COMPLETE, all the in-progress steps within the |
| 968 | # execution will be set as COMPLETE. If the outcome of the step is not set, |
| 969 | # the outcome will be set to INCONCLUSIVE. |
| 970 | # |
| 971 | # - In response always set |
| 972 | # - In create/update request: optional |
| 973 | }</pre> |
| 974 | </div> |
| 975 | |
| 976 | <div class="method"> |
| 977 | <code class="details" id="list">list(projectId, historyId, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 978 | <pre>Lists Executions for a given History. |
| 979 | |
| 980 | The executions are sorted by creation_time in descending order. The |
| 981 | execution_id key will be used to order the executions with the same |
| 982 | creation_time. |
| 983 | |
| 984 | May return any of the following canonical error codes: |
| 985 | |
| 986 | - PERMISSION_DENIED - if the user is not authorized to read project |
| 987 | - INVALID_ARGUMENT - if the request is malformed |
| 988 | - NOT_FOUND - if the containing History does not exist |
| 989 | |
| 990 | Args: |
| 991 | projectId: string, A Project id. |
| 992 | |
| 993 | Required. (required) |
| 994 | historyId: string, A History id. |
| 995 | |
| 996 | Required. (required) |
| 997 | pageToken: string, A continuation token to resume the query at the next item. |
| 998 | |
| 999 | Optional. |
| 1000 | pageSize: integer, The maximum number of Executions to fetch. |
| 1001 | |
| 1002 | Default value: 25. The server will use this default if the field is not set |
| 1003 | or has a value of 0. |
| 1004 | |
| 1005 | Optional. |
| 1006 | x__xgafv: string, V1 error format. |
| 1007 | Allowed values |
| 1008 | 1 - v1 error format |
| 1009 | 2 - v2 error format |
| 1010 | |
| 1011 | Returns: |
| 1012 | An object of the form: |
| 1013 | |
| 1014 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1015 | "executions": [ # Executions. |
| 1016 | # |
| 1017 | # Always set. |
| 1018 | { # An Execution represents a collection of Steps. For instance, it could |
| 1019 | # represent: |
| 1020 | # - a mobile test executed across a range of device configurations |
| 1021 | # - a jenkins job with a build step followed by a test step |
| 1022 | # |
| 1023 | # The maximum size of an execution message is 1 MiB. |
| 1024 | # |
| 1025 | # An Execution can be updated until its state is set to COMPLETE at which |
| 1026 | # point it becomes immutable. |
| 1027 | "completionTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution status transitioned to COMPLETE. |
| 1028 | # |
| 1029 | # This value will be set automatically when state transitions to |
| 1030 | # COMPLETE. |
| 1031 | # |
| 1032 | # - In response: set if the execution state is COMPLETE. |
| 1033 | # - In create/update request: never set |
| 1034 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 1035 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 1036 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 1037 | # Gregorian calendar backwards to year one. |
| 1038 | # |
| 1039 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 1040 | # second table is needed for interpretation, using a [24-hour linear |
| 1041 | # smear](https://developers.google.com/time/smear). |
| 1042 | # |
| 1043 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 1044 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 1045 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 1046 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 1047 | # second values with fractions must still have non-negative nanos values |
| 1048 | # that count forward in time. Must be from 0 to 999,999,999 |
| 1049 | # inclusive. |
| 1050 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 1051 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 1052 | # 9999-12-31T23:59:59Z inclusive. |
| 1053 | }, |
| 1054 | "executionId": "A String", # A unique identifier within a History for this Execution. |
| 1055 | # |
| 1056 | # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. |
| 1057 | # |
| 1058 | # - In response always set |
| 1059 | # - In create/update request: never set |
| 1060 | "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE |
| 1061 | # |
| 1062 | # - In response: present if set by create/update request |
| 1063 | # - In create/update request: optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1064 | "successDetail": { # Details for an outcome with a SUCCESS outcome summary. # More information about a SUCCESS outcome. |
| 1065 | # |
| 1066 | # Returns INVALID_ARGUMENT if this field is set |
| 1067 | # but the summary is not SUCCESS. |
| 1068 | # |
| 1069 | # Optional |
| 1070 | # LINT.IfChange |
| 1071 | "otherNativeCrash": True or False, # If a native process other than the app crashed. |
| 1072 | }, |
| 1073 | "skippedDetail": { # Details for an outcome with a SKIPPED outcome summary. # More information about a SKIPPED outcome. |
| 1074 | # |
| 1075 | # Returns INVALID_ARGUMENT if this field is set |
| 1076 | # but the summary is not SKIPPED. |
| 1077 | # |
| 1078 | # Optional |
| 1079 | "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level. |
| 1080 | "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model. |
| 1081 | "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86. |
| 1082 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1083 | "summary": "A String", # The simplest way to interpret a result. |
| 1084 | # |
| 1085 | # Required |
| 1086 | "failureDetail": { # Details for an outcome with a FAILURE outcome summary. # More information about a FAILURE outcome. |
| 1087 | # |
| 1088 | # Returns INVALID_ARGUMENT if this field is set |
| 1089 | # but the summary is not FAILURE. |
| 1090 | # |
| 1091 | # Optional |
| 1092 | "crashed": True or False, # If the failure was severe because the system (app) under test crashed. |
| 1093 | "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not |
| 1094 | # start. |
| 1095 | "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. |
| 1096 | # This might be caused by trying to run a test on an unsupported platform. |
| 1097 | "timedOut": True or False, # If the test overran some time limit, and that is why it failed. |
| 1098 | "otherNativeCrash": True or False, # If a native process (including any other than the app) crashed. |
| 1099 | }, |
| 1100 | "inconclusiveDetail": { # Details for an outcome with an INCONCLUSIVE outcome summary. # More information about an INCONCLUSIVE outcome. |
| 1101 | # |
| 1102 | # Returns INVALID_ARGUMENT if this field is set |
| 1103 | # but the summary is not INCONCLUSIVE. |
| 1104 | # |
| 1105 | # Optional |
| 1106 | "hasErrorLogs": True or False, # If results are being provided to the user in certain cases of |
| 1107 | # infrastructure failures |
| 1108 | "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test |
| 1109 | # depends on a component other than the system under test which failed. |
| 1110 | # |
| 1111 | # For example, a mobile test requires provisioning a device where the test |
| 1112 | # executes, and that provisioning can fail. |
| 1113 | "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be |
| 1114 | # determined. |
| 1115 | # For example, the user pressed ctrl-c which sent a kill signal to the test |
| 1116 | # runner while the test was running. |
| 1117 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1118 | }, |
| 1119 | "specification": { # The details about how to run the execution. # Lightweight information about execution request. |
| 1120 | # |
| 1121 | # - In response: present if set by create |
| 1122 | # - In create: optional |
| 1123 | # - In update: optional |
| 1124 | "iosTest": { # A iOS mobile test specification # An iOS mobile test execution specification. |
| 1125 | "iosAppInfo": { # iOS app information # Information about the application under test. |
| 1126 | "name": "A String", # The name of the app. |
| 1127 | # Required |
| 1128 | }, |
| 1129 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 1130 | # automatically cancelled. |
| 1131 | # A Duration represents a signed, fixed-length span of time represented |
| 1132 | # as a count of seconds and fractions of seconds at nanosecond |
| 1133 | # resolution. It is independent of any calendar and concepts like "day" |
| 1134 | # or "month". It is related to Timestamp in that the difference between |
| 1135 | # two Timestamp values is a Duration and it can be added or subtracted |
| 1136 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1137 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 1138 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 1139 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1140 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 1141 | # of time. Durations less than one second are represented with a 0 |
| 1142 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 1143 | # of one second or more, a non-zero value for the `nanos` field must be |
| 1144 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 1145 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1146 | }, |
| 1147 | "iosRoboTest": { # A Robo test for an iOS application. # An iOS Robo test. |
| 1148 | }, |
| 1149 | "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest. |
| 1150 | "xcodeVersion": "A String", # Xcode version that the test was run with. |
| 1151 | "bundleId": "A String", # Bundle ID of the app. |
| 1152 | }, |
| 1153 | "iosTestLoop": { # A game loop test of an iOS application. # An iOS test loop. |
| 1154 | "bundleId": "A String", # Bundle ID of the app. |
| 1155 | }, |
| 1156 | }, |
| 1157 | "androidTest": { # An Android mobile test specification. # An Android mobile test execution specification. |
| 1158 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 1159 | # automatically cancelled. |
| 1160 | # A Duration represents a signed, fixed-length span of time represented |
| 1161 | # as a count of seconds and fractions of seconds at nanosecond |
| 1162 | # resolution. It is independent of any calendar and concepts like "day" |
| 1163 | # or "month". It is related to Timestamp in that the difference between |
| 1164 | # two Timestamp values is a Duration and it can be added or subtracted |
| 1165 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1166 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 1167 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 1168 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1169 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 1170 | # of time. Durations less than one second are represented with a 0 |
| 1171 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 1172 | # of one second or more, a non-zero value for the `nanos` field must be |
| 1173 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 1174 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1175 | }, |
| 1176 | "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test. |
| 1177 | # or physical Android device, finding culprits and crashes as it goes. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1178 | "bootstrapPackageId": "A String", # The java package for the bootstrap. |
| 1179 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1180 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 1181 | # Optional |
| 1182 | "bootstrapRunnerClass": "A String", # The runner class for the bootstrap. |
| 1183 | # Optional |
| 1184 | "maxSteps": 42, # The max number of steps/actions Robo can execute. |
| 1185 | # Default is no limit (0). |
| 1186 | # Optional |
| 1187 | "maxDepth": 42, # The max depth of the traversal stack Robo can explore. |
| 1188 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1189 | }, |
| 1190 | "androidTestLoop": { # Test Loops are tests that can be launched by the app itself, determining # An Android test loop. |
| 1191 | # when to run by listening for an intent. |
| 1192 | }, |
| 1193 | "androidAppInfo": { # Android app information. # Information about the application under test. |
| 1194 | "name": "A String", # The name of the app. |
| 1195 | # Optional |
| 1196 | "packageName": "A String", # The package name of the app. |
| 1197 | # Required. |
| 1198 | "versionName": "A String", # The version name of the app. |
| 1199 | # Optional. |
| 1200 | "versionCode": "A String", # The internal version code of the app. |
| 1201 | # Optional. |
| 1202 | }, |
| 1203 | "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test. |
| 1204 | # independently of its normal lifecycle. |
| 1205 | # |
| 1206 | # See <http://developer.android.com/tools/testing/testing_android.html> for |
| 1207 | # more information on types of Android tests. |
| 1208 | "testPackageId": "A String", # The java package for the test to be executed. |
| 1209 | # Required |
| 1210 | "testTargets": [ # Each target must be fully qualified with the package name or class name, |
| 1211 | # in one of these formats: |
| 1212 | # - "package package_name" |
| 1213 | # - "class package_name.class_name" |
| 1214 | # - "class package_name.class_name#method_name" |
| 1215 | # |
| 1216 | # If empty, all targets in the module will be run. |
| 1217 | "A String", |
| 1218 | ], |
| 1219 | "useOrchestrator": True or False, # The flag indicates whether Android Test Orchestrator will be used to run |
| 1220 | # test or not. |
| 1221 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. |
| 1222 | # Required |
| 1223 | }, |
| 1224 | }, |
| 1225 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1226 | "dimensionDefinitions": [ # The dimensions along which different steps in this execution may vary. |
| 1227 | # This must remain fixed over the life of the execution. |
| 1228 | # |
| 1229 | # Returns INVALID_ARGUMENT if this field is set in an update request. |
| 1230 | # |
| 1231 | # Returns INVALID_ARGUMENT if the same name occurs in more than one |
| 1232 | # dimension_definition. |
| 1233 | # |
| 1234 | # Returns INVALID_ARGUMENT if the size of the list is over 100. |
| 1235 | # |
| 1236 | # - In response: present if set by create |
| 1237 | # - In create request: optional |
| 1238 | # - In update request: never set |
| 1239 | { # One dimension of the matrix of different runs of a step. |
| 1240 | }, |
| 1241 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1242 | "creationTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution was created. |
| 1243 | # |
| 1244 | # This value will be set automatically when CreateExecution is called. |
| 1245 | # |
| 1246 | # - In response: always set |
| 1247 | # - In create/update request: never set |
| 1248 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 1249 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 1250 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 1251 | # Gregorian calendar backwards to year one. |
| 1252 | # |
| 1253 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 1254 | # second table is needed for interpretation, using a [24-hour linear |
| 1255 | # smear](https://developers.google.com/time/smear). |
| 1256 | # |
| 1257 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 1258 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 1259 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 1260 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 1261 | # second values with fractions must still have non-negative nanos values |
| 1262 | # that count forward in time. Must be from 0 to 999,999,999 |
| 1263 | # inclusive. |
| 1264 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 1265 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 1266 | # 9999-12-31T23:59:59Z inclusive. |
| 1267 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1268 | "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the TestExecutionService uses. |
| 1269 | # |
| 1270 | # - In response: present if set by create |
| 1271 | # - In create: optional |
| 1272 | # - In update: never set |
| 1273 | "state": "A String", # The initial state is IN_PROGRESS. |
| 1274 | # |
| 1275 | # The only legal state transitions is from IN_PROGRESS to COMPLETE. |
| 1276 | # |
| 1277 | # A PRECONDITION_FAILED will be returned if an invalid transition is |
| 1278 | # requested. |
| 1279 | # |
| 1280 | # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be |
| 1281 | # returned if the state is set to COMPLETE multiple times. |
| 1282 | # |
| 1283 | # If the state is set to COMPLETE, all the in-progress steps within the |
| 1284 | # execution will be set as COMPLETE. If the outcome of the step is not set, |
| 1285 | # the outcome will be set to INCONCLUSIVE. |
| 1286 | # |
| 1287 | # - In response always set |
| 1288 | # - In create/update request: optional |
| 1289 | }, |
| 1290 | ], |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1291 | "nextPageToken": "A String", # A continuation token to resume the query at the next item. |
| 1292 | # |
| 1293 | # Will only be set if there are more Executions to fetch. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1294 | }</pre> |
| 1295 | </div> |
| 1296 | |
| 1297 | <div class="method"> |
| 1298 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1299 | <pre>Retrieves the next page of results. |
| 1300 | |
| 1301 | Args: |
| 1302 | previous_request: The request for the previous page. (required) |
| 1303 | previous_response: The response from the request for the previous page. (required) |
| 1304 | |
| 1305 | Returns: |
| 1306 | A request object that you can call 'execute()' on to request the next |
| 1307 | page. Returns None if there are no more items in the collection. |
| 1308 | </pre> |
| 1309 | </div> |
| 1310 | |
| 1311 | <div class="method"> |
| 1312 | <code class="details" id="patch">patch(projectId, historyId, executionId, body=None, requestId=None, x__xgafv=None)</code> |
| 1313 | <pre>Updates an existing Execution with the supplied partial entity. |
| 1314 | |
| 1315 | May return any of the following canonical error codes: |
| 1316 | |
| 1317 | - PERMISSION_DENIED - if the user is not authorized to write to project |
| 1318 | - INVALID_ARGUMENT - if the request is malformed |
| 1319 | - FAILED_PRECONDITION - if the requested state transition is illegal |
| 1320 | - NOT_FOUND - if the containing History does not exist |
| 1321 | |
| 1322 | Args: |
| 1323 | projectId: string, A Project id. |
| 1324 | Required. (required) |
| 1325 | historyId: string, Required. (required) |
| 1326 | executionId: string, Required. (required) |
| 1327 | body: object, The request body. |
| 1328 | The object takes the form of: |
| 1329 | |
| 1330 | { # An Execution represents a collection of Steps. For instance, it could |
| 1331 | # represent: |
| 1332 | # - a mobile test executed across a range of device configurations |
| 1333 | # - a jenkins job with a build step followed by a test step |
| 1334 | # |
| 1335 | # The maximum size of an execution message is 1 MiB. |
| 1336 | # |
| 1337 | # An Execution can be updated until its state is set to COMPLETE at which |
| 1338 | # point it becomes immutable. |
| 1339 | "completionTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution status transitioned to COMPLETE. |
| 1340 | # |
| 1341 | # This value will be set automatically when state transitions to |
| 1342 | # COMPLETE. |
| 1343 | # |
| 1344 | # - In response: set if the execution state is COMPLETE. |
| 1345 | # - In create/update request: never set |
| 1346 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 1347 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 1348 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 1349 | # Gregorian calendar backwards to year one. |
| 1350 | # |
| 1351 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 1352 | # second table is needed for interpretation, using a [24-hour linear |
| 1353 | # smear](https://developers.google.com/time/smear). |
| 1354 | # |
| 1355 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 1356 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 1357 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 1358 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 1359 | # second values with fractions must still have non-negative nanos values |
| 1360 | # that count forward in time. Must be from 0 to 999,999,999 |
| 1361 | # inclusive. |
| 1362 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 1363 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 1364 | # 9999-12-31T23:59:59Z inclusive. |
| 1365 | }, |
| 1366 | "executionId": "A String", # A unique identifier within a History for this Execution. |
| 1367 | # |
| 1368 | # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. |
| 1369 | # |
| 1370 | # - In response always set |
| 1371 | # - In create/update request: never set |
| 1372 | "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE |
| 1373 | # |
| 1374 | # - In response: present if set by create/update request |
| 1375 | # - In create/update request: optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1376 | "successDetail": { # Details for an outcome with a SUCCESS outcome summary. # More information about a SUCCESS outcome. |
| 1377 | # |
| 1378 | # Returns INVALID_ARGUMENT if this field is set |
| 1379 | # but the summary is not SUCCESS. |
| 1380 | # |
| 1381 | # Optional |
| 1382 | # LINT.IfChange |
| 1383 | "otherNativeCrash": True or False, # If a native process other than the app crashed. |
| 1384 | }, |
| 1385 | "skippedDetail": { # Details for an outcome with a SKIPPED outcome summary. # More information about a SKIPPED outcome. |
| 1386 | # |
| 1387 | # Returns INVALID_ARGUMENT if this field is set |
| 1388 | # but the summary is not SKIPPED. |
| 1389 | # |
| 1390 | # Optional |
| 1391 | "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level. |
| 1392 | "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model. |
| 1393 | "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86. |
| 1394 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1395 | "summary": "A String", # The simplest way to interpret a result. |
| 1396 | # |
| 1397 | # Required |
| 1398 | "failureDetail": { # Details for an outcome with a FAILURE outcome summary. # More information about a FAILURE outcome. |
| 1399 | # |
| 1400 | # Returns INVALID_ARGUMENT if this field is set |
| 1401 | # but the summary is not FAILURE. |
| 1402 | # |
| 1403 | # Optional |
| 1404 | "crashed": True or False, # If the failure was severe because the system (app) under test crashed. |
| 1405 | "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not |
| 1406 | # start. |
| 1407 | "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. |
| 1408 | # This might be caused by trying to run a test on an unsupported platform. |
| 1409 | "timedOut": True or False, # If the test overran some time limit, and that is why it failed. |
| 1410 | "otherNativeCrash": True or False, # If a native process (including any other than the app) crashed. |
| 1411 | }, |
| 1412 | "inconclusiveDetail": { # Details for an outcome with an INCONCLUSIVE outcome summary. # More information about an INCONCLUSIVE outcome. |
| 1413 | # |
| 1414 | # Returns INVALID_ARGUMENT if this field is set |
| 1415 | # but the summary is not INCONCLUSIVE. |
| 1416 | # |
| 1417 | # Optional |
| 1418 | "hasErrorLogs": True or False, # If results are being provided to the user in certain cases of |
| 1419 | # infrastructure failures |
| 1420 | "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test |
| 1421 | # depends on a component other than the system under test which failed. |
| 1422 | # |
| 1423 | # For example, a mobile test requires provisioning a device where the test |
| 1424 | # executes, and that provisioning can fail. |
| 1425 | "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be |
| 1426 | # determined. |
| 1427 | # For example, the user pressed ctrl-c which sent a kill signal to the test |
| 1428 | # runner while the test was running. |
| 1429 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1430 | }, |
| 1431 | "specification": { # The details about how to run the execution. # Lightweight information about execution request. |
| 1432 | # |
| 1433 | # - In response: present if set by create |
| 1434 | # - In create: optional |
| 1435 | # - In update: optional |
| 1436 | "iosTest": { # A iOS mobile test specification # An iOS mobile test execution specification. |
| 1437 | "iosAppInfo": { # iOS app information # Information about the application under test. |
| 1438 | "name": "A String", # The name of the app. |
| 1439 | # Required |
| 1440 | }, |
| 1441 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 1442 | # automatically cancelled. |
| 1443 | # A Duration represents a signed, fixed-length span of time represented |
| 1444 | # as a count of seconds and fractions of seconds at nanosecond |
| 1445 | # resolution. It is independent of any calendar and concepts like "day" |
| 1446 | # or "month". It is related to Timestamp in that the difference between |
| 1447 | # two Timestamp values is a Duration and it can be added or subtracted |
| 1448 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1449 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 1450 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 1451 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1452 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 1453 | # of time. Durations less than one second are represented with a 0 |
| 1454 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 1455 | # of one second or more, a non-zero value for the `nanos` field must be |
| 1456 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 1457 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1458 | }, |
| 1459 | "iosRoboTest": { # A Robo test for an iOS application. # An iOS Robo test. |
| 1460 | }, |
| 1461 | "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest. |
| 1462 | "xcodeVersion": "A String", # Xcode version that the test was run with. |
| 1463 | "bundleId": "A String", # Bundle ID of the app. |
| 1464 | }, |
| 1465 | "iosTestLoop": { # A game loop test of an iOS application. # An iOS test loop. |
| 1466 | "bundleId": "A String", # Bundle ID of the app. |
| 1467 | }, |
| 1468 | }, |
| 1469 | "androidTest": { # An Android mobile test specification. # An Android mobile test execution specification. |
| 1470 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 1471 | # automatically cancelled. |
| 1472 | # A Duration represents a signed, fixed-length span of time represented |
| 1473 | # as a count of seconds and fractions of seconds at nanosecond |
| 1474 | # resolution. It is independent of any calendar and concepts like "day" |
| 1475 | # or "month". It is related to Timestamp in that the difference between |
| 1476 | # two Timestamp values is a Duration and it can be added or subtracted |
| 1477 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1478 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 1479 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 1480 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1481 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 1482 | # of time. Durations less than one second are represented with a 0 |
| 1483 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 1484 | # of one second or more, a non-zero value for the `nanos` field must be |
| 1485 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 1486 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1487 | }, |
| 1488 | "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test. |
| 1489 | # or physical Android device, finding culprits and crashes as it goes. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1490 | "bootstrapPackageId": "A String", # The java package for the bootstrap. |
| 1491 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1492 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 1493 | # Optional |
| 1494 | "bootstrapRunnerClass": "A String", # The runner class for the bootstrap. |
| 1495 | # Optional |
| 1496 | "maxSteps": 42, # The max number of steps/actions Robo can execute. |
| 1497 | # Default is no limit (0). |
| 1498 | # Optional |
| 1499 | "maxDepth": 42, # The max depth of the traversal stack Robo can explore. |
| 1500 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1501 | }, |
| 1502 | "androidTestLoop": { # Test Loops are tests that can be launched by the app itself, determining # An Android test loop. |
| 1503 | # when to run by listening for an intent. |
| 1504 | }, |
| 1505 | "androidAppInfo": { # Android app information. # Information about the application under test. |
| 1506 | "name": "A String", # The name of the app. |
| 1507 | # Optional |
| 1508 | "packageName": "A String", # The package name of the app. |
| 1509 | # Required. |
| 1510 | "versionName": "A String", # The version name of the app. |
| 1511 | # Optional. |
| 1512 | "versionCode": "A String", # The internal version code of the app. |
| 1513 | # Optional. |
| 1514 | }, |
| 1515 | "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test. |
| 1516 | # independently of its normal lifecycle. |
| 1517 | # |
| 1518 | # See <http://developer.android.com/tools/testing/testing_android.html> for |
| 1519 | # more information on types of Android tests. |
| 1520 | "testPackageId": "A String", # The java package for the test to be executed. |
| 1521 | # Required |
| 1522 | "testTargets": [ # Each target must be fully qualified with the package name or class name, |
| 1523 | # in one of these formats: |
| 1524 | # - "package package_name" |
| 1525 | # - "class package_name.class_name" |
| 1526 | # - "class package_name.class_name#method_name" |
| 1527 | # |
| 1528 | # If empty, all targets in the module will be run. |
| 1529 | "A String", |
| 1530 | ], |
| 1531 | "useOrchestrator": True or False, # The flag indicates whether Android Test Orchestrator will be used to run |
| 1532 | # test or not. |
| 1533 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. |
| 1534 | # Required |
| 1535 | }, |
| 1536 | }, |
| 1537 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1538 | "dimensionDefinitions": [ # The dimensions along which different steps in this execution may vary. |
| 1539 | # This must remain fixed over the life of the execution. |
| 1540 | # |
| 1541 | # Returns INVALID_ARGUMENT if this field is set in an update request. |
| 1542 | # |
| 1543 | # Returns INVALID_ARGUMENT if the same name occurs in more than one |
| 1544 | # dimension_definition. |
| 1545 | # |
| 1546 | # Returns INVALID_ARGUMENT if the size of the list is over 100. |
| 1547 | # |
| 1548 | # - In response: present if set by create |
| 1549 | # - In create request: optional |
| 1550 | # - In update request: never set |
| 1551 | { # One dimension of the matrix of different runs of a step. |
| 1552 | }, |
| 1553 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1554 | "creationTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution was created. |
| 1555 | # |
| 1556 | # This value will be set automatically when CreateExecution is called. |
| 1557 | # |
| 1558 | # - In response: always set |
| 1559 | # - In create/update request: never set |
| 1560 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 1561 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 1562 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 1563 | # Gregorian calendar backwards to year one. |
| 1564 | # |
| 1565 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 1566 | # second table is needed for interpretation, using a [24-hour linear |
| 1567 | # smear](https://developers.google.com/time/smear). |
| 1568 | # |
| 1569 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 1570 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 1571 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 1572 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 1573 | # second values with fractions must still have non-negative nanos values |
| 1574 | # that count forward in time. Must be from 0 to 999,999,999 |
| 1575 | # inclusive. |
| 1576 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 1577 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 1578 | # 9999-12-31T23:59:59Z inclusive. |
| 1579 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1580 | "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the TestExecutionService uses. |
| 1581 | # |
| 1582 | # - In response: present if set by create |
| 1583 | # - In create: optional |
| 1584 | # - In update: never set |
| 1585 | "state": "A String", # The initial state is IN_PROGRESS. |
| 1586 | # |
| 1587 | # The only legal state transitions is from IN_PROGRESS to COMPLETE. |
| 1588 | # |
| 1589 | # A PRECONDITION_FAILED will be returned if an invalid transition is |
| 1590 | # requested. |
| 1591 | # |
| 1592 | # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be |
| 1593 | # returned if the state is set to COMPLETE multiple times. |
| 1594 | # |
| 1595 | # If the state is set to COMPLETE, all the in-progress steps within the |
| 1596 | # execution will be set as COMPLETE. If the outcome of the step is not set, |
| 1597 | # the outcome will be set to INCONCLUSIVE. |
| 1598 | # |
| 1599 | # - In response always set |
| 1600 | # - In create/update request: optional |
| 1601 | } |
| 1602 | |
| 1603 | requestId: string, A unique request ID for server to detect duplicated requests. |
| 1604 | For example, a UUID. |
| 1605 | |
| 1606 | Optional, but strongly recommended. |
| 1607 | x__xgafv: string, V1 error format. |
| 1608 | Allowed values |
| 1609 | 1 - v1 error format |
| 1610 | 2 - v2 error format |
| 1611 | |
| 1612 | Returns: |
| 1613 | An object of the form: |
| 1614 | |
| 1615 | { # An Execution represents a collection of Steps. For instance, it could |
| 1616 | # represent: |
| 1617 | # - a mobile test executed across a range of device configurations |
| 1618 | # - a jenkins job with a build step followed by a test step |
| 1619 | # |
| 1620 | # The maximum size of an execution message is 1 MiB. |
| 1621 | # |
| 1622 | # An Execution can be updated until its state is set to COMPLETE at which |
| 1623 | # point it becomes immutable. |
| 1624 | "completionTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution status transitioned to COMPLETE. |
| 1625 | # |
| 1626 | # This value will be set automatically when state transitions to |
| 1627 | # COMPLETE. |
| 1628 | # |
| 1629 | # - In response: set if the execution state is COMPLETE. |
| 1630 | # - In create/update request: never set |
| 1631 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 1632 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 1633 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 1634 | # Gregorian calendar backwards to year one. |
| 1635 | # |
| 1636 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 1637 | # second table is needed for interpretation, using a [24-hour linear |
| 1638 | # smear](https://developers.google.com/time/smear). |
| 1639 | # |
| 1640 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 1641 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 1642 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 1643 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 1644 | # second values with fractions must still have non-negative nanos values |
| 1645 | # that count forward in time. Must be from 0 to 999,999,999 |
| 1646 | # inclusive. |
| 1647 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 1648 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 1649 | # 9999-12-31T23:59:59Z inclusive. |
| 1650 | }, |
| 1651 | "executionId": "A String", # A unique identifier within a History for this Execution. |
| 1652 | # |
| 1653 | # Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. |
| 1654 | # |
| 1655 | # - In response always set |
| 1656 | # - In create/update request: never set |
| 1657 | "outcome": { # Interprets a result so that humans and machines can act on it. # Classify the result, for example into SUCCESS or FAILURE |
| 1658 | # |
| 1659 | # - In response: present if set by create/update request |
| 1660 | # - In create/update request: optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1661 | "successDetail": { # Details for an outcome with a SUCCESS outcome summary. # More information about a SUCCESS outcome. |
| 1662 | # |
| 1663 | # Returns INVALID_ARGUMENT if this field is set |
| 1664 | # but the summary is not SUCCESS. |
| 1665 | # |
| 1666 | # Optional |
| 1667 | # LINT.IfChange |
| 1668 | "otherNativeCrash": True or False, # If a native process other than the app crashed. |
| 1669 | }, |
| 1670 | "skippedDetail": { # Details for an outcome with a SKIPPED outcome summary. # More information about a SKIPPED outcome. |
| 1671 | # |
| 1672 | # Returns INVALID_ARGUMENT if this field is set |
| 1673 | # but the summary is not SKIPPED. |
| 1674 | # |
| 1675 | # Optional |
| 1676 | "incompatibleAppVersion": True or False, # If the App doesn't support the specific API level. |
| 1677 | "incompatibleDevice": True or False, # If the requested OS version doesn't run on the specific device model. |
| 1678 | "incompatibleArchitecture": True or False, # If the App doesn't run on the specific architecture, for example, x86. |
| 1679 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1680 | "summary": "A String", # The simplest way to interpret a result. |
| 1681 | # |
| 1682 | # Required |
| 1683 | "failureDetail": { # Details for an outcome with a FAILURE outcome summary. # More information about a FAILURE outcome. |
| 1684 | # |
| 1685 | # Returns INVALID_ARGUMENT if this field is set |
| 1686 | # but the summary is not FAILURE. |
| 1687 | # |
| 1688 | # Optional |
| 1689 | "crashed": True or False, # If the failure was severe because the system (app) under test crashed. |
| 1690 | "unableToCrawl": True or False, # If the robo was unable to crawl the app; perhaps because the app did not |
| 1691 | # start. |
| 1692 | "notInstalled": True or False, # If an app is not installed and thus no test can be run with the app. |
| 1693 | # This might be caused by trying to run a test on an unsupported platform. |
| 1694 | "timedOut": True or False, # If the test overran some time limit, and that is why it failed. |
| 1695 | "otherNativeCrash": True or False, # If a native process (including any other than the app) crashed. |
| 1696 | }, |
| 1697 | "inconclusiveDetail": { # Details for an outcome with an INCONCLUSIVE outcome summary. # More information about an INCONCLUSIVE outcome. |
| 1698 | # |
| 1699 | # Returns INVALID_ARGUMENT if this field is set |
| 1700 | # but the summary is not INCONCLUSIVE. |
| 1701 | # |
| 1702 | # Optional |
| 1703 | "hasErrorLogs": True or False, # If results are being provided to the user in certain cases of |
| 1704 | # infrastructure failures |
| 1705 | "infrastructureFailure": True or False, # If the test runner could not determine success or failure because the test |
| 1706 | # depends on a component other than the system under test which failed. |
| 1707 | # |
| 1708 | # For example, a mobile test requires provisioning a device where the test |
| 1709 | # executes, and that provisioning can fail. |
| 1710 | "abortedByUser": True or False, # If the end user aborted the test execution before a pass or fail could be |
| 1711 | # determined. |
| 1712 | # For example, the user pressed ctrl-c which sent a kill signal to the test |
| 1713 | # runner while the test was running. |
| 1714 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1715 | }, |
| 1716 | "specification": { # The details about how to run the execution. # Lightweight information about execution request. |
| 1717 | # |
| 1718 | # - In response: present if set by create |
| 1719 | # - In create: optional |
| 1720 | # - In update: optional |
| 1721 | "iosTest": { # A iOS mobile test specification # An iOS mobile test execution specification. |
| 1722 | "iosAppInfo": { # iOS app information # Information about the application under test. |
| 1723 | "name": "A String", # The name of the app. |
| 1724 | # Required |
| 1725 | }, |
| 1726 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 1727 | # automatically cancelled. |
| 1728 | # A Duration represents a signed, fixed-length span of time represented |
| 1729 | # as a count of seconds and fractions of seconds at nanosecond |
| 1730 | # resolution. It is independent of any calendar and concepts like "day" |
| 1731 | # or "month". It is related to Timestamp in that the difference between |
| 1732 | # two Timestamp values is a Duration and it can be added or subtracted |
| 1733 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1734 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 1735 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 1736 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1737 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 1738 | # of time. Durations less than one second are represented with a 0 |
| 1739 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 1740 | # of one second or more, a non-zero value for the `nanos` field must be |
| 1741 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 1742 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1743 | }, |
| 1744 | "iosRoboTest": { # A Robo test for an iOS application. # An iOS Robo test. |
| 1745 | }, |
| 1746 | "iosXcTest": { # A test of an iOS application that uses the XCTest framework. # An iOS XCTest. |
| 1747 | "xcodeVersion": "A String", # Xcode version that the test was run with. |
| 1748 | "bundleId": "A String", # Bundle ID of the app. |
| 1749 | }, |
| 1750 | "iosTestLoop": { # A game loop test of an iOS application. # An iOS test loop. |
| 1751 | "bundleId": "A String", # Bundle ID of the app. |
| 1752 | }, |
| 1753 | }, |
| 1754 | "androidTest": { # An Android mobile test specification. # An Android mobile test execution specification. |
| 1755 | "testTimeout": { # # Max time a test is allowed to run before it is |
| 1756 | # automatically cancelled. |
| 1757 | # A Duration represents a signed, fixed-length span of time represented |
| 1758 | # as a count of seconds and fractions of seconds at nanosecond |
| 1759 | # resolution. It is independent of any calendar and concepts like "day" |
| 1760 | # or "month". It is related to Timestamp in that the difference between |
| 1761 | # two Timestamp values is a Duration and it can be added or subtracted |
| 1762 | # from a Timestamp. Range is approximately +-10,000 years. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1763 | "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 |
| 1764 | # to +315,576,000,000 inclusive. Note: these bounds are computed from: |
| 1765 | # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1766 | "nanos": 42, # Signed fractions of a second at nanosecond resolution of the span |
| 1767 | # of time. Durations less than one second are represented with a 0 |
| 1768 | # `seconds` field and a positive or negative `nanos` field. For durations |
| 1769 | # of one second or more, a non-zero value for the `nanos` field must be |
| 1770 | # of the same sign as the `seconds` field. Must be from -999,999,999 |
| 1771 | # to +999,999,999 inclusive. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1772 | }, |
| 1773 | "androidRoboTest": { # A test of an android application that explores the application on a virtual # An Android robo test. |
| 1774 | # or physical Android device, finding culprits and crashes as it goes. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1775 | "bootstrapPackageId": "A String", # The java package for the bootstrap. |
| 1776 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1777 | "appInitialActivity": "A String", # The initial activity that should be used to start the app. |
| 1778 | # Optional |
| 1779 | "bootstrapRunnerClass": "A String", # The runner class for the bootstrap. |
| 1780 | # Optional |
| 1781 | "maxSteps": 42, # The max number of steps/actions Robo can execute. |
| 1782 | # Default is no limit (0). |
| 1783 | # Optional |
| 1784 | "maxDepth": 42, # The max depth of the traversal stack Robo can explore. |
| 1785 | # Optional |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1786 | }, |
| 1787 | "androidTestLoop": { # Test Loops are tests that can be launched by the app itself, determining # An Android test loop. |
| 1788 | # when to run by listening for an intent. |
| 1789 | }, |
| 1790 | "androidAppInfo": { # Android app information. # Information about the application under test. |
| 1791 | "name": "A String", # The name of the app. |
| 1792 | # Optional |
| 1793 | "packageName": "A String", # The package name of the app. |
| 1794 | # Required. |
| 1795 | "versionName": "A String", # The version name of the app. |
| 1796 | # Optional. |
| 1797 | "versionCode": "A String", # The internal version code of the app. |
| 1798 | # Optional. |
| 1799 | }, |
| 1800 | "androidInstrumentationTest": { # A test of an Android application that can control an Android component # An Android instrumentation test. |
| 1801 | # independently of its normal lifecycle. |
| 1802 | # |
| 1803 | # See <http://developer.android.com/tools/testing/testing_android.html> for |
| 1804 | # more information on types of Android tests. |
| 1805 | "testPackageId": "A String", # The java package for the test to be executed. |
| 1806 | # Required |
| 1807 | "testTargets": [ # Each target must be fully qualified with the package name or class name, |
| 1808 | # in one of these formats: |
| 1809 | # - "package package_name" |
| 1810 | # - "class package_name.class_name" |
| 1811 | # - "class package_name.class_name#method_name" |
| 1812 | # |
| 1813 | # If empty, all targets in the module will be run. |
| 1814 | "A String", |
| 1815 | ], |
| 1816 | "useOrchestrator": True or False, # The flag indicates whether Android Test Orchestrator will be used to run |
| 1817 | # test or not. |
| 1818 | "testRunnerClass": "A String", # The InstrumentationTestRunner class. |
| 1819 | # Required |
| 1820 | }, |
| 1821 | }, |
| 1822 | }, |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1823 | "dimensionDefinitions": [ # The dimensions along which different steps in this execution may vary. |
| 1824 | # This must remain fixed over the life of the execution. |
| 1825 | # |
| 1826 | # Returns INVALID_ARGUMENT if this field is set in an update request. |
| 1827 | # |
| 1828 | # Returns INVALID_ARGUMENT if the same name occurs in more than one |
| 1829 | # dimension_definition. |
| 1830 | # |
| 1831 | # Returns INVALID_ARGUMENT if the size of the list is over 100. |
| 1832 | # |
| 1833 | # - In response: present if set by create |
| 1834 | # - In create request: optional |
| 1835 | # - In update request: never set |
| 1836 | { # One dimension of the matrix of different runs of a step. |
| 1837 | }, |
| 1838 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1839 | "creationTime": { # A Timestamp represents a point in time independent of any time zone or local # The time when the Execution was created. |
| 1840 | # |
| 1841 | # This value will be set automatically when CreateExecution is called. |
| 1842 | # |
| 1843 | # - In response: always set |
| 1844 | # - In create/update request: never set |
| 1845 | # calendar, encoded as a count of seconds and fractions of seconds at |
| 1846 | # nanosecond resolution. The count is relative to an epoch at UTC midnight on |
| 1847 | # January 1, 1970, in the proleptic Gregorian calendar which extends the |
| 1848 | # Gregorian calendar backwards to year one. |
| 1849 | # |
| 1850 | # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap |
| 1851 | # second table is needed for interpretation, using a [24-hour linear |
| 1852 | # smear](https://developers.google.com/time/smear). |
| 1853 | # |
| 1854 | # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By |
| 1855 | # restricting to that range, we ensure that we can convert to and from [RFC |
| 1856 | # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. |
| 1857 | "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative |
| 1858 | # second values with fractions must still have non-negative nanos values |
| 1859 | # that count forward in time. Must be from 0 to 999,999,999 |
| 1860 | # inclusive. |
| 1861 | "seconds": "A String", # Represents seconds of UTC time since Unix epoch |
| 1862 | # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to |
| 1863 | # 9999-12-31T23:59:59Z inclusive. |
| 1864 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1865 | "testExecutionMatrixId": "A String", # TestExecution Matrix ID that the TestExecutionService uses. |
| 1866 | # |
| 1867 | # - In response: present if set by create |
| 1868 | # - In create: optional |
| 1869 | # - In update: never set |
| 1870 | "state": "A String", # The initial state is IN_PROGRESS. |
| 1871 | # |
| 1872 | # The only legal state transitions is from IN_PROGRESS to COMPLETE. |
| 1873 | # |
| 1874 | # A PRECONDITION_FAILED will be returned if an invalid transition is |
| 1875 | # requested. |
| 1876 | # |
| 1877 | # The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be |
| 1878 | # returned if the state is set to COMPLETE multiple times. |
| 1879 | # |
| 1880 | # If the state is set to COMPLETE, all the in-progress steps within the |
| 1881 | # execution will be set as COMPLETE. If the outcome of the step is not set, |
| 1882 | # the outcome will be set to INCONCLUSIVE. |
| 1883 | # |
| 1884 | # - In response always set |
| 1885 | # - In create/update request: optional |
| 1886 | }</pre> |
| 1887 | </div> |
| 1888 | |
| 1889 | </body></html> |