forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CI] Parallelize quick checks (elastic#190401)
## Summary Use typescript's async processes to start quick checks in parallel 👍 Check out these for runs: - happy case: https://buildkite.com/elastic/kibana-pull-request/builds/227443#01914ca3-1f0d-4178-b539-263fbc588e98 - some broken checks: https://buildkite.com/elastic/kibana-pull-request/builds/228957#01917607-f7bd-4e08-8c70-7fdc3f9c12d1 Benefits: - with this (+more CPU) we can speed up the quick-check step's runtime, from ~15m to ~7m. - the added benefit is that all checks run so that we won't bail on the 1st one Disadvantage: - uglier error output, since we collect the logs asynchronously, and print it only upon failure - ~no output printed for happy checks (can be changed)~ Extra: - additionally, `yarn quick-checks` will now allow devs to run these checks locally (adjustments made so that the checks won't fail in local dev) - added the option to declare a 'context' for tooling loggers, so we can identify which script logs Solves 2/3 of elastic/kibana-operations#124 (+speedup)
- Loading branch information
Showing
9 changed files
with
253 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| .buildkite/scripts/steps/checks/precommit_hook.sh | ||
| .buildkite/scripts/steps/checks/ts_projects.sh | ||
| .buildkite/scripts/steps/checks/packages.sh | ||
| .buildkite/scripts/steps/checks/bazel_packages.sh | ||
| .buildkite/scripts/steps/checks/verify_notice.sh | ||
| .buildkite/scripts/steps/checks/plugin_list_docs.sh | ||
| .buildkite/scripts/steps/checks/event_log.sh | ||
| .buildkite/scripts/steps/checks/telemetry.sh | ||
| .buildkite/scripts/steps/checks/jest_configs.sh | ||
| .buildkite/scripts/steps/checks/bundle_limits.sh | ||
| .buildkite/scripts/steps/checks/i18n.sh | ||
| .buildkite/scripts/steps/checks/file_casing.sh | ||
| .buildkite/scripts/steps/checks/licenses.sh | ||
| .buildkite/scripts/steps/checks/test_projects.sh | ||
| .buildkite/scripts/steps/checks/test_hardening.sh | ||
| .buildkite/scripts/steps/checks/ftr_configs.sh | ||
| .buildkite/scripts/steps/checks/yarn_deduplicate.sh | ||
| .buildkite/scripts/steps/checks/prettier_topology.sh | ||
| .buildkite/scripts/steps/checks/renovate.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| require('../src/setup_node_env'); | ||
| require('../src/dev/run_quick_checks'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import { exec } from 'child_process'; | ||
| import { availableParallelism } from 'os'; | ||
| import { join, isAbsolute } from 'path'; | ||
| import { readdirSync, readFileSync } from 'fs'; | ||
|
|
||
| import { run, RunOptions } from '@kbn/dev-cli-runner'; | ||
| import { REPO_ROOT } from '@kbn/repo-info'; | ||
| import { ToolingLog } from '@kbn/tooling-log'; | ||
|
|
||
| const MAX_PARALLELISM = availableParallelism(); | ||
| const buildkiteQuickchecksFolder = join('.buildkite', 'scripts', 'steps', 'checks'); | ||
| const quickChecksList = join(buildkiteQuickchecksFolder, 'quick_checks.txt'); | ||
| const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms)); | ||
|
|
||
| interface CheckResult { | ||
| success: boolean; | ||
| script: string; | ||
| output: string; | ||
| durationMs: number; | ||
| } | ||
|
|
||
| const scriptOptions: RunOptions = { | ||
| description: ` | ||
| Runs sanity-testing quick-checks in parallel. | ||
| - arguments (--file, --dir, --checks) are exclusive - only one can be used at a time. | ||
| `, | ||
| flags: { | ||
| string: ['dir', 'checks', 'file'], | ||
| help: ` | ||
| --file Run all checks from a given file. (default='${quickChecksList}') | ||
| --dir Run all checks in a given directory. | ||
| --checks Runs all scripts given in this parameter. (comma or newline delimited) | ||
| `, | ||
| }, | ||
| log: { | ||
| context: 'quick-checks', | ||
| defaultLevel: process.env.CI === 'true' ? 'debug' : 'info', | ||
| }, | ||
| }; | ||
|
|
||
| let logger: ToolingLog; | ||
| void run(async ({ log, flagsReader }) => { | ||
| logger = log; | ||
|
|
||
| const scriptsToRun = collectScriptsToRun({ | ||
| targetFile: flagsReader.string('file'), | ||
| targetDir: flagsReader.string('dir'), | ||
| checks: flagsReader.string('checks'), | ||
| }); | ||
|
|
||
| logger.write( | ||
| `--- Running ${scriptsToRun.length} checks, with parallelism ${MAX_PARALLELISM}...`, | ||
| scriptsToRun | ||
| ); | ||
| const startTime = Date.now(); | ||
| const results = await runAllChecks(scriptsToRun); | ||
|
|
||
| logger.write('--- All checks finished.'); | ||
| printResults(startTime, results); | ||
|
|
||
| const failedChecks = results.filter((check) => !check.success); | ||
| if (failedChecks.length > 0) { | ||
| logger.write(`--- ${failedChecks.length} quick check(s) failed. ❌`); | ||
| logger.write(`See above for details.`); | ||
| process.exitCode = 1; | ||
| } else { | ||
| logger.write('--- All checks passed. ✅'); | ||
| return results; | ||
| } | ||
| }, scriptOptions); | ||
|
|
||
| function collectScriptsToRun(inputOptions: { | ||
| targetFile: string | undefined; | ||
| targetDir: string | undefined; | ||
| checks: string | undefined; | ||
| }) { | ||
| const { targetFile, targetDir, checks } = inputOptions; | ||
| if ([targetFile, targetDir, checks].filter(Boolean).length > 1) { | ||
| throw new Error('Only one of --file, --dir, or --checks can be used at a time.'); | ||
| } | ||
|
|
||
| if (targetDir) { | ||
| const targetDirAbsolute = isAbsolute(targetDir) ? targetDir : join(REPO_ROOT, targetDir); | ||
| return readdirSync(targetDirAbsolute).map((file) => join(targetDir, file)); | ||
| } else if (checks) { | ||
| return checks | ||
| .trim() | ||
| .split(/[,\n]/) | ||
| .map((script) => script.trim()); | ||
| } else { | ||
| const targetFileWithDefault = targetFile || quickChecksList; | ||
| const targetFileAbsolute = isAbsolute(targetFileWithDefault) | ||
| ? targetFileWithDefault | ||
| : join(REPO_ROOT, targetFileWithDefault); | ||
|
|
||
| return readFileSync(targetFileAbsolute, 'utf-8') | ||
| .trim() | ||
| .split('\n') | ||
| .map((line) => line.trim()); | ||
| } | ||
| } | ||
|
|
||
| async function runAllChecks(scriptsToRun: string[]) { | ||
| const checksRunning: Array<Promise<any>> = []; | ||
| const checksFinished: CheckResult[] = []; | ||
|
|
||
| while (scriptsToRun.length > 0 || checksRunning.length > 0) { | ||
| while (scriptsToRun.length > 0 && checksRunning.length < MAX_PARALLELISM) { | ||
| const script = scriptsToRun.shift(); | ||
| if (!script) { | ||
| continue; | ||
| } | ||
|
|
||
| const check = runCheckAsync(script); | ||
| checksRunning.push(check); | ||
| check.then((result) => { | ||
| checksRunning.splice(checksRunning.indexOf(check), 1); | ||
| checksFinished.push(result); | ||
| }); | ||
| } | ||
|
|
||
| await sleep(1000); | ||
| } | ||
|
|
||
| return checksFinished; | ||
| } | ||
|
|
||
| async function runCheckAsync(script: string): Promise<CheckResult> { | ||
| logger.info(`Starting check: ${script}`); | ||
| const startTime = Date.now(); | ||
|
|
||
| return new Promise((resolve) => { | ||
| const scriptProcess = exec(script); | ||
| let output = ''; | ||
| const appendToOutput = (data: string | Buffer) => (output += data); | ||
|
|
||
| scriptProcess.stdout?.on('data', appendToOutput); | ||
| scriptProcess.stderr?.on('data', appendToOutput); | ||
|
|
||
| scriptProcess.on('exit', (code) => { | ||
| const result: CheckResult = { | ||
| success: code === 0, | ||
| script, | ||
| output, | ||
| durationMs: Date.now() - startTime, | ||
| }; | ||
| if (code === 0) { | ||
| logger.info(`Passed check: ${script} in ${humanizeTime(result.durationMs)}`); | ||
| } else { | ||
| logger.warning(`Failed check: ${script} in ${humanizeTime(result.durationMs)}`); | ||
| } | ||
|
|
||
| resolve(result); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| function printResults(startTimestamp: number, results: CheckResult[]) { | ||
| const totalDuration = results.reduce((acc, result) => acc + result.durationMs, 0); | ||
| const total = humanizeTime(totalDuration); | ||
| const effective = humanizeTime(Date.now() - startTimestamp); | ||
| logger.info(`- Total time: ${total}, effective: ${effective}`); | ||
|
|
||
| results.forEach((result) => { | ||
| logger.write( | ||
| `--- ${result.success ? '✅' : '❌'} ${result.script}: ${humanizeTime(result.durationMs)}` | ||
| ); | ||
| if (result.success) { | ||
| logger.debug(result.output); | ||
| } else { | ||
| logger.warning(result.output); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| function humanizeTime(ms: number) { | ||
| if (ms < 1000) { | ||
| return `${ms}ms`; | ||
| } | ||
|
|
||
| const minutes = Math.floor(ms / 1000 / 60); | ||
| const seconds = Math.floor((ms - minutes * 60 * 1000) / 1000); | ||
| if (minutes === 0) { | ||
| return `${seconds}s`; | ||
| } else { | ||
| return `${minutes}m ${seconds}s`; | ||
| } | ||
| } |