Add dry and local options for run-tests.js (#67058)
Add support for `--dry` to the Next.js repo test runner, makes sure that you can see all commands that are going to run before actually running them. Adds support for `--local` to strip some of the environment variables that are entirely CI related. <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # -->
This commit is contained in:
Tim Neutkens
GitHub
parent
3a17d4d2cd
commit
d1f68acf7a
1 changed files with 42 additions and 26 deletions
68
run-tests.js
68
run-tests.js
|
|
@ -29,6 +29,8 @@ let argv = require('yargs/yargs')(process.argv.slice(2))
|
|||
.alias('g', 'group')
|
||||
.number('c')
|
||||
.boolean('related')
|
||||
.boolean('dry')
|
||||
.boolean('local')
|
||||
.alias('r', 'related')
|
||||
.alias('c', 'concurrency').argv
|
||||
|
||||
|
|
@ -205,9 +207,11 @@ async function main() {
|
|||
type: argv.type ?? false,
|
||||
related: argv.related ?? false,
|
||||
retries: argv.retries ?? DEFAULT_NUM_RETRIES,
|
||||
dry: argv.dry ?? false,
|
||||
local: argv.local ?? false,
|
||||
}
|
||||
let numRetries = options.retries
|
||||
const hideOutput = !options.debug
|
||||
const hideOutput = !options.debug && !options.dry
|
||||
|
||||
let filterTestsBy
|
||||
|
||||
|
|
@ -402,6 +406,7 @@ ${ENDGROUP}`)
|
|||
})
|
||||
|
||||
if (
|
||||
!options.dry &&
|
||||
process.platform !== 'win32' &&
|
||||
process.env.NEXT_TEST_MODE !== 'deploy' &&
|
||||
((options.type && options.type !== 'unit') || hasIsolatedTests)
|
||||
|
|
@ -471,37 +476,43 @@ ${ENDGROUP}`)
|
|||
]),
|
||||
]
|
||||
const env = {
|
||||
IS_RETRY: isRetry ? 'true' : undefined,
|
||||
RECORD_REPLAY: shouldRecordTestWithReplay,
|
||||
// run tests in headless mode by default
|
||||
HEADLESS: 'true',
|
||||
TRACE_PLAYWRIGHT:
|
||||
process.env.NEXT_TEST_MODE === 'deploy' ? undefined : 'true',
|
||||
NEXT_TELEMETRY_DISABLED: '1',
|
||||
// unset CI env so CI behavior is only explicitly
|
||||
// tested when enabled
|
||||
CI: '',
|
||||
CIRCLECI: '',
|
||||
GITHUB_ACTIONS: '',
|
||||
CONTINUOUS_INTEGRATION: '',
|
||||
RUN_ID: '',
|
||||
BUILD_NUMBER: '',
|
||||
// Format the output of junit report to include the test name
|
||||
// For the debugging purpose to compare actual run list to the generated reports
|
||||
// [NOTE]: This won't affect if junit reporter is not enabled
|
||||
// @ts-expect-error .replaceAll() does exist. Follow-up why TS is not recognizing it
|
||||
JEST_JUNIT_OUTPUT_NAME: test.file.replaceAll('/', '_'),
|
||||
// Specify suite name for the test to avoid unexpected merging across different env / grouped tests
|
||||
// This is not individual suites name (corresponding 'describe'), top level suite name which have redundant names by default
|
||||
// [NOTE]: This won't affect if junit reporter is not enabled
|
||||
JEST_SUITE_NAME: [
|
||||
`${process.env.NEXT_TEST_MODE ?? 'default'}`,
|
||||
options.group,
|
||||
options.type,
|
||||
test.file,
|
||||
]
|
||||
.filter(Boolean)
|
||||
.join(':'),
|
||||
|
||||
...(options.local
|
||||
? {}
|
||||
: {
|
||||
IS_RETRY: isRetry ? 'true' : undefined,
|
||||
RECORD_REPLAY: shouldRecordTestWithReplay,
|
||||
|
||||
TRACE_PLAYWRIGHT:
|
||||
process.env.NEXT_TEST_MODE === 'deploy' ? undefined : 'true',
|
||||
CIRCLECI: '',
|
||||
GITHUB_ACTIONS: '',
|
||||
CONTINUOUS_INTEGRATION: '',
|
||||
RUN_ID: '',
|
||||
BUILD_NUMBER: '',
|
||||
// Format the output of junit report to include the test name
|
||||
// For the debugging purpose to compare actual run list to the generated reports
|
||||
// [NOTE]: This won't affect if junit reporter is not enabled
|
||||
// @ts-expect-error .replaceAll() does exist. Follow-up why TS is not recognizing it
|
||||
JEST_JUNIT_OUTPUT_NAME: test.file.replaceAll('/', '_'),
|
||||
// Specify suite name for the test to avoid unexpected merging across different env / grouped tests
|
||||
// This is not individual suites name (corresponding 'describe'), top level suite name which have redundant names by default
|
||||
// [NOTE]: This won't affect if junit reporter is not enabled
|
||||
JEST_SUITE_NAME: [
|
||||
`${process.env.NEXT_TEST_MODE ?? 'default'}`,
|
||||
options.group,
|
||||
options.type,
|
||||
test.file,
|
||||
]
|
||||
.filter(Boolean)
|
||||
.join(':'),
|
||||
}),
|
||||
...(isFinalRun
|
||||
? {
|
||||
// Events can be finicky in CI. This switches to a more
|
||||
|
|
@ -529,6 +540,11 @@ ${ENDGROUP}`)
|
|||
].join(' ') + '\n'
|
||||
)
|
||||
|
||||
// Don't execute tests when in dry run mode
|
||||
if (options.dry) {
|
||||
return resolve(new Date().getTime() - start)
|
||||
}
|
||||
|
||||
const child = spawn(jestPath, args, {
|
||||
stdio: ['ignore', 'pipe', 'pipe'],
|
||||
env: {
|
||||
|
|
|
|||
Loading…
Reference in a new issue