Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run visual regression tests in CI during push or PR #3

Merged
merged 1 commit into from
Apr 25, 2022
Merged

Run visual regression tests in CI during push or PR #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/push.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@ jobs:
run: npm ci
- name: Run tests
run: npm test
- name: Run visual regression
shell: 'script -q -e -c "bash {0}"'
run: |
script -e -c "./pixel.js reference && ./pixel.js test"
71 changes: 36 additions & 35 deletions pixel.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,10 @@
#!/usr/bin/env node
const spawn = require( 'child_process' ).spawn;
const util = require( 'util' );
const exec = util.promisify( require( 'child_process' ).exec );
const LATEST_RELEASE_BRANCH = 'latest-release';
const MAIN_BRANCH = 'master';

/**
* @param {string} command
* @param {string[]} args
* @return {Promise<number>}
*/
function createSpawn( command, args ) {
return new Promise( ( resolve, reject ) => {
const childProcess = spawn(
command,
args,
{ stdio: 'inherit' }
);

childProcess.on( 'close', ( code ) => {
if ( code === 0 ) {
resolve( code );
return;
}

reject( code );
} );
} );
}
const BatchSpawn = require( './src/batch-spawn' );
const batchSpawn = new BatchSpawn( 1 );

/**
* @return {Promise<string>}
Expand All @@ -37,6 +14,21 @@ async function getLatestReleaseBranch() {
return `origin/${stdout.split( 'refs/heads/' )[ 1 ].trim()}`;
}

/**
* @param {'test'|'reference'} type
* @return {Promise<undefined>}
*/
async function openReportIfNecessary( type ) {
try {
if ( type === 'reference' ) {
return;
}
await batchSpawn.spawn( 'open', [ 'report/index.html' ] );
} catch ( e ) {
console.log( 'Could not open report, but it is located at report/index.html' );
}
}

/**
* @param {'test'|'reference'} type
* @param {any} opts
Expand All @@ -52,26 +44,35 @@ async function processCommand( type, opts ) {
}

// Start docker containers.
await createSpawn( 'docker-compose', [ 'up', '-d' ] );
await batchSpawn.spawn( 'docker-compose', [ 'up', '-d' ] );
// Execute main.js.
await createSpawn(
await batchSpawn.spawn(
'docker-compose',
[ 'exec', 'mediawiki', '/src/main.js', JSON.stringify( opts ) ]
);
// Execute Visual regression
await createSpawn(
// Execute Visual regression tests.
await batchSpawn.spawn(
'docker-compose',
[ 'run', '--rm', 'visual-regression', type, '--config', 'config.js' ]
).finally( async () => {
if ( type === 'test' ) {
await createSpawn( 'open', [ 'report/index.html' ] );
).then( async () => {
await openReportIfNecessary( type );
}, async ( /** @type {Error} */ err ) => {
if ( err.message.includes( '130' ) ) {
// If user ends subprocess with a sigint, exit early.
return;
}

if ( err.message.includes( 'Exit with error code 1' ) ) {
return openReportIfNecessary( type );
}
} );

throw err;
} );
} catch ( err ) {
console.log( `Exited with code ${err}` );
console.error( err );
// eslint-disable-next-line no-process-exit
process.exit( 1 );
}

}

function setupCli() {
Expand Down