Blame - docs/dyn/toolresults_v1beta3.testCases.html - platform/external/python/google-api-python-client

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

<h1><a href="toolresults_v1beta3.html">Cloud Tool Results API</a> . <a href="toolresults_v1beta3.testCases.html">testCases</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#get">get(projectId, historyId, executionId, stepId, testCaseId, x__xgafv=None)</a></code></p>

79

<p class="firstline">Gets details of a Test Case for a Step.</p>

80

81

<code><a href="#list">list(projectId, historyId, executionId, stepId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Lists Test Cases attached to a Step.</p>

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

<h3>Method Details</h3>

87

88

<code class="details" id="get">get(projectId, historyId, executionId, stepId, testCaseId, x__xgafv=None)</code>

89

<pre>Gets details of a Test Case for a Step.

90

Experimental test cases API. Still in active development.

91

92

May return any of the following canonical error codes:

93

94

- PERMISSION_DENIED - if the user is not authorized to write to project

95

- INVALID_ARGUMENT - if the request is malformed

96

- NOT_FOUND - if the containing Test Case does not exist

97

98

Args:

99

projectId: string, A Project id.

100

101

Required. (required)

102

historyId: string, A History id.

103

104

Required. (required)

105

executionId: string, A Execution id

106

107

Required. (required)

108

stepId: string, A Step id.

109

Note: This step must include a TestExecutionStep.

110

111

Required. (required)

112

testCaseId: string, A Test Case id.

113

114

Required. (required)

115

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

122

123

{

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

124

"endTime": { # A Timestamp represents a point in time independent of any time zone or local # The end time of the test case.

125

# calendar, encoded as a count of seconds and fractions of seconds at

126

# nanosecond resolution. The count is relative to an epoch at UTC midnight on

127

# January 1, 1970, in the proleptic Gregorian calendar which extends the

128

# Gregorian calendar backwards to year one.

129

#

130

# All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap

131

# second table is needed for interpretation, using a [24-hour linear

132

# smear](https://developers.google.com/time/smear).

133

#

134

# The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By

135

# restricting to that range, we ensure that we can convert to and from [RFC

136

# 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

137

"nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative

138

# second values with fractions must still have non-negative nanos values

139

# that count forward in time. Must be from 0 to 999,999,999

140

# inclusive.

141

"seconds": "A String", # Represents seconds of UTC time since Unix epoch

142

# 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to

143

# 9999-12-31T23:59:59Z inclusive.

144

},

145

"skippedMessage": "A String", # Why the test case was skipped.

146

#

147

# Present only for skipped test case

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

148

"testCaseReference": { # A reference to a test case. # Test case reference, e.g. name, class name and test suite name.

#

# Required.

#

# Test case references are canonically ordered lexicographically by these three

153

# factors:

154

# * First, by test_suite_name.

155

# * Second, by class_name.

156

# * Third, by name.

157

"testSuiteName": "A String", # The name of the test suite to which this test case belongs.

158

"className": "A String", # The name of the class.

159

"name": "A String", # The name of the test case.

160

#

161

# Required.

162

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

163

"toolOutputs": [ # References to opaque files of any format output by the tool execution.

164

#

165

# @OutputOnly

166

{ # A reference to a ToolExecution output file.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

167

"testCase": { # A reference to a test case. # The test case to which this output file belongs.

168

#

169

# - In response: present if set by create/update request

170

# - In create/update request: optional

171

#

172

# Test case references are canonically ordered lexicographically by these three

173

# factors:

174

# * First, by test_suite_name.

175

# * Second, by class_name.

176

# * Third, by name.

177

"testSuiteName": "A String", # The name of the test suite to which this test case belongs.

178

"className": "A String", # The name of the class.

179

"name": "A String", # The name of the test case.

180

#

181

# Required.

182

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

183

"creationTime": { # A Timestamp represents a point in time independent of any time zone or local # The creation time of the file.

184

#

185

# - In response: present if set by create/update request

186

# - In create/update request: optional

187

# calendar, encoded as a count of seconds and fractions of seconds at

188

# nanosecond resolution. The count is relative to an epoch at UTC midnight on

189

# January 1, 1970, in the proleptic Gregorian calendar which extends the

190

# Gregorian calendar backwards to year one.

191

#

192

# All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap

193

# second table is needed for interpretation, using a [24-hour linear

194

# smear](https://developers.google.com/time/smear).

195

#

196

# The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By

197

# restricting to that range, we ensure that we can convert to and from [RFC

198

# 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

199

"nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative

200

# second values with fractions must still have non-negative nanos values

201

# that count forward in time. Must be from 0 to 999,999,999

202

# inclusive.

203

"seconds": "A String", # Represents seconds of UTC time since Unix epoch

204

# 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to

205

# 9999-12-31T23:59:59Z inclusive.

206

},

207

"output": { # A reference to a file. # A FileReference to an output file.

208

#

209

# - In response: always set

210

# - In create/update request: always set

211

"fileUri": "A String", # The URI of a file stored in Google Cloud Storage.

212

#

213

# For example: http://storage.googleapis.com/mybucket/path/to/test.xml

214

# or in gsutil format: gs://mybucket/path/to/test.xml

215

# with version-specific info,

216

# gs://mybucket/path/to/test.xml#1360383693690000

217

#

218

# An INVALID_ARGUMENT error will be returned if the URI format is not

219

# supported.

220

#

221

# - In response: always set

222

# - In create/update request: always set

223

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

224

},

225

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

226

"startTime": { # A Timestamp represents a point in time independent of any time zone or local # The start time of the test case.

227

# calendar, encoded as a count of seconds and fractions of seconds at

228

# nanosecond resolution. The count is relative to an epoch at UTC midnight on

229

# January 1, 1970, in the proleptic Gregorian calendar which extends the

230

# Gregorian calendar backwards to year one.

231

#

232

# All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap

233

# second table is needed for interpretation, using a [24-hour linear

234

# smear](https://developers.google.com/time/smear).

235

#

236

# The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By

237

# restricting to that range, we ensure that we can convert to and from [RFC

238

# 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

239

"nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative

240

# second values with fractions must still have non-negative nanos values

241

# that count forward in time. Must be from 0 to 999,999,999

242

# inclusive.

243

"seconds": "A String", # Represents seconds of UTC time since Unix epoch

244

# 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to

245

# 9999-12-31T23:59:59Z inclusive.

246

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

247

"status": "A String", # The status of the test case.

248

#

249

# Required.

250

"elapsedTime": { # # The elapsed run time of the test case.

251

#

252

# Required.

253

# A Duration represents a signed, fixed-length span of time represented

254

# as a count of seconds and fractions of seconds at nanosecond

255

# resolution. It is independent of any calendar and concepts like "day"

256

# or "month". It is related to Timestamp in that the difference between

257

# two Timestamp values is a Duration and it can be added or subtracted

258

# from a Timestamp. Range is approximately +-10,000 years.

259

"seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000

260

# to +315,576,000,000 inclusive. Note: these bounds are computed from:

261

# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

262

"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span

263

# of time. Durations less than one second are represented with a 0

264

# `seconds` field and a positive or negative `nanos` field. For durations

265

# of one second or more, a non-zero value for the `nanos` field must be

266

# of the same sign as the `seconds` field. Must be from -999,999,999

267

# to +999,999,999 inclusive.

268

},

269

"testCaseId": "A String", # A unique identifier within a Step for this Test Case.

270

"stackTraces": [ # The stack trace details if the test case failed or encountered an error.

271

#

272

# The maximum size of the stack traces is 100KiB, beyond which the stack

273

# track will be truncated.

274

#

275

# Zero if the test case passed.

276

{ # A stacktrace.

277

"exception": "A String", # The stack trace message.

#

# Required

},

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list">list(projectId, historyId, executionId, stepId, pageToken=None, pageSize=None, x__xgafv=None)</code>

287

<pre>Lists Test Cases attached to a Step.

288

Experimental test cases API. Still in active development.

289

290

May return any of the following canonical error codes:

291

292

- PERMISSION_DENIED - if the user is not authorized to write to project

293

- INVALID_ARGUMENT - if the request is malformed

294

- NOT_FOUND - if the containing Step does not exist

295

296

Args:

297

projectId: string, A Project id.

298

299

Required. (required)

300

historyId: string, A History id.

301

302

Required. (required)

303

executionId: string, A Execution id

304

305

Required. (required)

306

stepId: string, A Step id.

307

Note: This step must include a TestExecutionStep.

308

309

Required. (required)

310

pageToken: string, A continuation token to resume the query at the next item.

311

312

Optional.

313

pageSize: integer, The maximum number of TestCases to fetch.

314

315

Default value: 100. The server will use this default if the field is not

316

set or has a value of 0.

317

318

Optional.

319

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

326

327

{ # Response message for StepService.ListTestCases.

328

"nextPageToken": "A String",

329

"testCases": [ # List of test cases.

330

{

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

331

"endTime": { # A Timestamp represents a point in time independent of any time zone or local # The end time of the test case.

332

# calendar, encoded as a count of seconds and fractions of seconds at

333

# nanosecond resolution. The count is relative to an epoch at UTC midnight on

334

# January 1, 1970, in the proleptic Gregorian calendar which extends the

335

# Gregorian calendar backwards to year one.

336

#

337

# All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap

338

# second table is needed for interpretation, using a [24-hour linear

339

# smear](https://developers.google.com/time/smear).

340

#

341

# The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By

342

# restricting to that range, we ensure that we can convert to and from [RFC

343

# 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

344

"nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative

345

# second values with fractions must still have non-negative nanos values

346

# that count forward in time. Must be from 0 to 999,999,999

347

# inclusive.

348

"seconds": "A String", # Represents seconds of UTC time since Unix epoch

349

# 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to

350

# 9999-12-31T23:59:59Z inclusive.

351

},

352

"skippedMessage": "A String", # Why the test case was skipped.

353

#

354

# Present only for skipped test case

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

355

"testCaseReference": { # A reference to a test case. # Test case reference, e.g. name, class name and test suite name.

#

# Required.

#

# Test case references are canonically ordered lexicographically by these three

360

# factors:

361

# * First, by test_suite_name.

362

# * Second, by class_name.

363

# * Third, by name.

364

"testSuiteName": "A String", # The name of the test suite to which this test case belongs.

365

"className": "A String", # The name of the class.

366

"name": "A String", # The name of the test case.

367

#

368

# Required.

369

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

370

"toolOutputs": [ # References to opaque files of any format output by the tool execution.

371

#

372

# @OutputOnly

373

{ # A reference to a ToolExecution output file.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

374

"testCase": { # A reference to a test case. # The test case to which this output file belongs.

375

#

376

# - In response: present if set by create/update request

377

# - In create/update request: optional

378

#

379

# Test case references are canonically ordered lexicographically by these three

380

# factors:

381

# * First, by test_suite_name.

382

# * Second, by class_name.

383

# * Third, by name.

384

"testSuiteName": "A String", # The name of the test suite to which this test case belongs.

385

"className": "A String", # The name of the class.

386

"name": "A String", # The name of the test case.

387

#

388

# Required.

389

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

390

"creationTime": { # A Timestamp represents a point in time independent of any time zone or local # The creation time of the file.

391

#

392

# - In response: present if set by create/update request

393

# - In create/update request: optional

394

# calendar, encoded as a count of seconds and fractions of seconds at

395

# nanosecond resolution. The count is relative to an epoch at UTC midnight on

396

# January 1, 1970, in the proleptic Gregorian calendar which extends the

397

# Gregorian calendar backwards to year one.

398

#

399

# All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap

400

# second table is needed for interpretation, using a [24-hour linear

401

# smear](https://developers.google.com/time/smear).

402

#

403

# The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By

404

# restricting to that range, we ensure that we can convert to and from [RFC

405

# 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

406

"nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative

407

# second values with fractions must still have non-negative nanos values

408

# that count forward in time. Must be from 0 to 999,999,999

409

# inclusive.

410

"seconds": "A String", # Represents seconds of UTC time since Unix epoch

411

# 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to

412

# 9999-12-31T23:59:59Z inclusive.

413

},

414

"output": { # A reference to a file. # A FileReference to an output file.

415

#

416

# - In response: always set

417

# - In create/update request: always set

418

"fileUri": "A String", # The URI of a file stored in Google Cloud Storage.

419

#

420

# For example: http://storage.googleapis.com/mybucket/path/to/test.xml

421

# or in gsutil format: gs://mybucket/path/to/test.xml

422

# with version-specific info,

423

# gs://mybucket/path/to/test.xml#1360383693690000

424

#

425

# An INVALID_ARGUMENT error will be returned if the URI format is not

426

# supported.

427

#

428

# - In response: always set

429

# - In create/update request: always set

430

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

431

},

432

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

433

"startTime": { # A Timestamp represents a point in time independent of any time zone or local # The start time of the test case.

434

# calendar, encoded as a count of seconds and fractions of seconds at

435

# nanosecond resolution. The count is relative to an epoch at UTC midnight on

436

# January 1, 1970, in the proleptic Gregorian calendar which extends the

437

# Gregorian calendar backwards to year one.

438

#

439

# All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap

440

# second table is needed for interpretation, using a [24-hour linear

441

# smear](https://developers.google.com/time/smear).

442

#

443

# The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By

444

# restricting to that range, we ensure that we can convert to and from [RFC

445

# 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

446

"nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative

447

# second values with fractions must still have non-negative nanos values

448

# that count forward in time. Must be from 0 to 999,999,999

449

# inclusive.

450

"seconds": "A String", # Represents seconds of UTC time since Unix epoch

451

# 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to

452

# 9999-12-31T23:59:59Z inclusive.

453

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

454

"status": "A String", # The status of the test case.

455

#

456

# Required.

457

"elapsedTime": { # # The elapsed run time of the test case.

458

#

459

# Required.

460

# A Duration represents a signed, fixed-length span of time represented

461

# as a count of seconds and fractions of seconds at nanosecond

462

# resolution. It is independent of any calendar and concepts like "day"

463

# or "month". It is related to Timestamp in that the difference between

464

# two Timestamp values is a Duration and it can be added or subtracted

465

# from a Timestamp. Range is approximately +-10,000 years.

466

"seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000

467

# to +315,576,000,000 inclusive. Note: these bounds are computed from:

468

# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

469

"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span

470

# of time. Durations less than one second are represented with a 0

471

# `seconds` field and a positive or negative `nanos` field. For durations

472

# of one second or more, a non-zero value for the `nanos` field must be

473

# of the same sign as the `seconds` field. Must be from -999,999,999

474

# to +999,999,999 inclusive.

475

},

476

"testCaseId": "A String", # A unique identifier within a Step for this Test Case.

477

"stackTraces": [ # The stack trace details if the test case failed or encountered an error.

478

#

479

# The maximum size of the stack traces is 100KiB, beyond which the stack

480

# track will be truncated.

481

#

482

# Zero if the test case passed.

483

{ # A stacktrace.

484

"exception": "A String", # The stack trace message.

#

# Required

},

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

496

<pre>Retrieves the next page of results.

497

498

Args:

499

previous_request: The request for the previous page. (required)

500

previous_response: The response from the request for the previous page. (required)

501

502

Returns:

503

A request object that you can call 'execute()' on to request the next

504

page. Returns None if there are no more items in the collection.

</pre>

</div>

</body></html>