Refactor performance tests artifacts handling #48684
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,9 @@ const { | |
| } = require( '../lib/utils' ); | ||
| const config = require( '../config' ); | ||
|
|
||
| const ARTIFACTS_PATH = | ||
| process.env.WP_ARTIFACTS_PATH || path.join( process.cwd(), 'artifacts' ); | ||
|
|
||
| /** | ||
| * @typedef WPPerformanceCommandOptions | ||
| * | ||
|
|
@@ -193,38 +196,22 @@ function curateResults( testSuite, results ) { | |
| * @return {Promise<WPPerformanceResults>} Performance results for the branch. | ||
| */ | ||
| async function runTestSuite( testSuite, performanceTestDirectory, runKey ) { | ||
| const resultsFilename = `${ runKey }.performance-results.json`; | ||
|
|
||
| await runShellScript( | ||
| `npm run test:performance -- ${ testSuite }`, | ||
| performanceTestDirectory, | ||
| { | ||
| ...process.env, | ||
| WP_ARTIFACTS_PATH: ARTIFACTS_PATH, | ||
| RESULTS_FILENAME: resultsFilename, | ||
| } | ||
| ); | ||
|
|
||
| return curateResults( | ||
| testSuite, | ||
| await readJSONFile( path.join( ARTIFACTS_PATH, resultsFilename ) ) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -339,15 +326,41 @@ async function runPerformanceTests( branches, options ) { | |
| buildPath | ||
| ); | ||
|
|
||
| // Create the config file for the current env. | ||
| fs.writeFileSync( | ||
| path.join( environmentDirectory, '.wp-env.json' ), | ||
| JSON.stringify( | ||
| { | ||
| core: 'WordPress/WordPress', | ||
| plugins: [ path.join( environmentDirectory, 'plugin' ) ], | ||
| themes: [ | ||
| path.join( | ||
| performanceTestDirectory, | ||
| 'test/emptytheme' | ||
| ), | ||
| 'https://downloads.wordpress.org/theme/twentytwentyone.1.7.zip', | ||
| 'https://downloads.wordpress.org/theme/twentytwentythree.1.0.zip', | ||
|
There was a problem hiding this comment. are these things we want to hard-code here in this seemingly independent function? I could easily imagine someone wanting to update the themes and then overlooking these lines… There was a problem hiding this comment. This is only carried over from the There was a problem hiding this comment.
if you meant "I would not consider this a blocker" then that sounds good. if not, then I'm confused 😄 There was a problem hiding this comment. Ah, good catch! Missed the important 'not' there 😅 |
||
| ], | ||
| env: { | ||
| tests: { | ||
| mappings: { | ||
| 'wp-content/mu-plugins': path.join( | ||
| performanceTestDirectory, | ||
| 'packages/e2e-tests/mu-plugins' | ||
| ), | ||
| 'wp-content/plugins/gutenberg-test-plugins': | ||
| path.join( | ||
| performanceTestDirectory, | ||
| 'packages/e2e-tests/plugins' | ||
| ), | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| null, | ||
| 2 | ||
| ), | ||
| 'utf8' | ||
| ); | ||
|
|
||
| if ( options.wpVersion ) { | ||
|
|
@@ -404,33 +417,39 @@ async function runPerformanceTests( branches, options ) { | |
|
|
||
| /** @type {Record<string,Record<string, WPPerformanceResults>>} */ | ||
| const results = {}; | ||
| const wpEnvPath = path.join( | ||
| performanceTestDirectory, | ||
| 'node_modules/.bin/wp-env' | ||
| ); | ||
|
|
||
| for ( const testSuite of testSuites ) { | ||
| results[ testSuite ] = {}; | ||
| /** @type {Array<Record<string, WPPerformanceResults>>} */ | ||
| const rawResults = []; | ||
| for ( let i = 0; i < TEST_ROUNDS; i++ ) { | ||
| const roundInfo = `round ${ i + 1 } of ${ TEST_ROUNDS }`; | ||
| log( ` >> Suite: ${ testSuite } (${ roundInfo })` ); | ||
| rawResults[ i ] = {}; | ||
| for ( const branch of branches ) { | ||
| const sanitizedBranch = sanitizeBranchName( branch ); | ||
| const runKey = `${ testSuite }_${ sanitizedBranch }_run-${ i }`; | ||
| // @ts-ignore | ||
| const environmentDirectory = branchDirectories[ branch ]; | ||
| log( ` >> Branch: ${ branch }` ); | ||
| log( ' >> Starting the environment.' ); | ||
| await runShellScript( | ||
| `${ wpEnvPath } start`, | ||
| environmentDirectory | ||
| ); | ||
| log( ' >> Running the test.' ); | ||
| rawResults[ i ][ branch ] = await runTestSuite( | ||
| testSuite, | ||
| performanceTestDirectory, | ||
| runKey | ||
| ); | ||
| log( ' >> Stopping the environment' ); | ||
| await runShellScript( | ||
| `${ wpEnvPath } stop`, | ||
| environmentDirectory | ||
| ); | ||
| } | ||
|
|
@@ -493,9 +512,9 @@ async function runPerformanceTests( branches, options ) { | |
| ); | ||
| console.table( invertedResult ); | ||
|
|
||
| const resultsFilename = testSuite + '.performance-results.json'; | ||
| fs.writeFileSync( | ||
| path.join( ARTIFACTS_PATH, resultsFilename ), | ||
| JSON.stringify( results[ testSuite ], null, 2 ) | ||
| ); | ||
| } | ||
|
|
||
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
similar question here about removing
performancefrom the name. when I download these files they lose some inherent linkage to the performance CI job that created them.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was the same before - we were copying the
.wp-env.performance.jsonand renaming it to.wp-env.json, so in this regard nothing has changed. I assumed the default.wp-env.jsonname is used for thewp-env startscript to pick it up without any extra arguments.