github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[kbn-failed-test-reporter-cli] truncate report message to fix github api call failure (#155141)

Browse source 
## Summary

We recently had a
[failure](https://buildkite.com/elastic/kibana-on-merge/builds/29020#018792bc-498a-46d1-9343-fb791823d92e)
while calling Github API to open new issue:

```
2023-04-18 07:56:26 CEST	ERROR Error: [post https://api.github.com/repos/elastic/kibana/issues] 422 Unprocessable Entity Error: {"message":"Validation Failed","errors":[{"resource":"Issue","code":"custom","field":"body","message":"body is too long"},{"resource":"Issue","code":"custom","field":"body","message":"body is too long (maximum is 65536 characters)"}],"documentation_url":"https://docs.github.com/rest/reference/issues#create-an-issue"}
2023-04-18 07:56:26 CEST	          at GithubApi.request (github_api.ts:177:17)
2023-04-18 07:56:26 CEST	          at processTicksAndRejections (node:internal/process/task_queues:96:5)
2023-04-18 07:56:26 CEST	          at GithubApi.createIssue (github_api.ts:106:18)
2023-04-18 07:56:26 CEST	          at createFailureIssue (report_failure.ts:39:10)
2023-04-18 07:56:26 CEST	          at description (failed_tests_reporter_cli.ts:153:28)
2023-04-18 07:56:26 CEST	          at run.ts:70:7
2023-04-18 07:56:26 CEST	          at withProcRunner (with_proc_runner.ts:29:5)
2023-04-18 07:56:26 CEST	          at run (run.ts:69:5)
```

It seems like some test might have a very long failure message that
reaches Github body length limit and causes a failure.

Since mocha truncates failure message to 8192 chars, I thought it might
be a good option for Github issues as well (Having too long message is
not very useful anyway)
This commit is contained in:
Dzmitry Lemechko 2023-04-19 16:39:35 +02:00 • committed by GitHub
parent ddf9ab6c13
commit 271d9aa68c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

14
packages/kbn-failed-test-reporter-cli/failed_tests_reporter/report_failure.ts
View file

@ -19,12 +19,24 @@ export async function createFailureIssue(
) {
const title = `Failing test: ${failure.classname} - ${failure.name}`;
// Github API body length maximum is 65536 characters
// Let's keep consistency with Mocha output that is truncated to 8192 characters
const failureMaxCharacters = 8192;
const failureBody =
failure.failure.length <= failureMaxCharacters
? failure.failure
: [
failure.failure.substring(0, failureMaxCharacters),
`[report_failure] output truncated to ${failureMaxCharacters} characters`,
].join('\n');
const body = updateIssueMetadata(
[
'A test failed on a tracked branch',
'',
'```',
failure.failure,
failureBody,
'```',
'',
`First failure: [CI Build - ${branch}](${buildUrl})`,