woocommerce/packages/js/e2e-environment/utils/get-plugin-zip.js

173 lines
5.1 KiB
JavaScript
Raw Normal View History

2021-07-15 20:39:32 +00:00
const path = require( 'path' );
const fs = require( 'fs' );
2021-07-15 20:39:32 +00:00
const mkdirp = require( 'mkdirp' );
const request = require( 'request' );
const StreamZip = require( 'node-stream-zip' );
2021-12-15 21:06:19 +00:00
const { resolveLocalE2ePath } = require( './test-config' );
2021-07-15 20:39:32 +00:00
/**
* Upload a plugin zip from a remote location, such as a GitHub URL or other hosted location.
*
* @param {string} fileUrl The URL where the zip file is located.
2021-12-08 22:56:42 +00:00
* @param {string} authorizationToken Authorization token used to authenticate with the GitHub API if required.
* @return {string} The path where the zip file is located.
2021-07-15 20:39:32 +00:00
*/
2021-12-08 22:56:42 +00:00
const getRemotePluginZip = async ( fileUrl, authorizationToken = '' ) => {
const savePath = resolveLocalE2ePath( 'plugins' );
2021-07-15 20:39:32 +00:00
mkdirp.sync( savePath );
// Pull the version from the end of the URL
const fileName = fileUrl.split( '/' ).pop();
2021-07-15 20:39:32 +00:00
let filePath = path.join( savePath, fileName );
// First, download the zip file
2021-12-08 22:56:42 +00:00
await downloadZip( fileUrl, filePath, authorizationToken );
2021-07-15 20:39:32 +00:00
// Check for a nested zip and update the filepath
2021-07-21 16:22:50 +00:00
filePath = await checkNestedZip( filePath, savePath );
2021-07-15 20:39:32 +00:00
return filePath;
};
/**
* Get the latest release zip for a plugin from a GiHub repository.
*
2021-12-08 22:56:42 +00:00
* @param {string} repository The repository owner and name. For example: `woocommerce/woocommerce`.
* @param {string} authorizationToken Authorization token used to authenticate with the GitHub API if required.
* @param {boolean} getPrerelease Flag on whether to get a prelease or not.
* @param {number} perPage Limit of entries returned from the latest releases list, defaults to 3.
* @return {Promise<string>}} Returns the URL for the release zip file.
*/
const getLatestReleaseZipUrl = async (
repository,
2021-12-08 22:56:42 +00:00
authorizationToken = '',
getPrerelease = false,
perPage = 3
) => {
let requesturl;
if ( getPrerelease ) {
2021-12-08 22:56:42 +00:00
requesturl = `https://api.github.com/repos/${ repository }/releases?per_page=${ perPage }`;
} else {
2021-12-08 22:56:42 +00:00
requesturl = `https://api.github.com/repos/${ repository }/releases/latest`;
}
const options = {
url: requesturl,
method: 'GET',
json: true,
headers: { 'user-agent': 'node.js' },
};
2021-12-08 22:56:42 +00:00
// If provided with a token, use it for authorization
if ( authorizationToken ) {
options.headers.Authorization = `token ${ authorizationToken }`;
}
// Wrap in a promise to make the request async
return new Promise( function ( resolve, reject ) {
request.get( options, function ( err, resp, body ) {
if ( err ) {
reject( err );
} else if ( getPrerelease ) {
// Loop until we find the first pre-release, then return it.
body.forEach( ( release ) => {
if ( release.prerelease ) {
resolve( release.assets[ 0 ].browser_download_url );
}
} );
} else if ( authorizationToken ) {
// If it's a private repo, we need to download the archive this way
const tagName = body.tag_name;
resolve(
`https://github.com/${ repository }/archive/${ tagName }.zip`
);
} else {
resolve( body.assets[ 0 ].browser_download_url );
}
} );
} );
};
2021-07-15 20:39:32 +00:00
/**
* Check the zip file for any nested zips. If one is found, extract it.
*
* @param {string} zipFilePath The location of the zip file.
* @param {string} savePath The location where to save a nested zip if found.
* @return {string} The path where the zip file is located.
2021-07-15 20:39:32 +00:00
*/
2021-07-21 16:22:50 +00:00
const checkNestedZip = async ( zipFilePath, savePath ) => {
2021-07-15 20:39:32 +00:00
const zip = new StreamZip.async( { file: zipFilePath } );
const entries = await zip.entries();
for ( const entry of Object.values( entries ) ) {
2021-12-14 18:11:53 +00:00
if ( entry.name.match( /\.zip/ ) ) {
2021-07-15 20:39:32 +00:00
await zip.extract( null, savePath );
await zip.close();
return path.join( savePath, entry.name );
}
}
return zipFilePath;
};
2021-07-15 20:39:32 +00:00
/**
* Download the zip file from a remote location.
*
* @param {string} fileUrl The URL where the zip file is located.
* @param {string} downloadPath The location where to download the zip to.
2021-12-14 17:56:44 +00:00
* @param {string} authorizationToken Authorization token used to authenticate with the GitHub API if required.
* @return {Promise<void>}
2021-07-15 20:39:32 +00:00
*/
2021-12-08 22:56:42 +00:00
const downloadZip = async ( fileUrl, downloadPath, authorizationToken ) => {
2021-07-15 20:39:32 +00:00
const options = {
url: fileUrl,
method: 'GET',
encoding: null,
2021-12-08 22:56:42 +00:00
headers: { 'user-agent': 'node.js' },
2021-07-15 20:39:32 +00:00
};
2021-12-08 22:56:42 +00:00
// If provided with a token, use it for authorization
if ( authorizationToken ) {
options.headers.Authorization = `token ${ authorizationToken }`;
}
2021-07-15 20:39:32 +00:00
// Wrap in a promise to make the request async
return new Promise( function ( resolve, reject ) {
request
.get( options, function ( err, resp, body ) {
if ( err ) {
reject( err );
} else {
resolve( body );
}
} )
.pipe( fs.createWriteStream( downloadPath ) );
} );
2021-07-15 20:39:32 +00:00
};
2021-12-08 22:56:42 +00:00
/**
* Delete the downloaded plugin files.
*/
const deleteDownloadedPluginFiles = async () => {
2021-12-15 21:06:19 +00:00
const pluginSavePath = resolveLocalE2ePath( 'plugins' );
2021-12-08 22:56:42 +00:00
fs.readdir( pluginSavePath, ( err, files ) => {
if ( err ) throw err;
for ( const file of files ) {
2021-12-14 17:56:44 +00:00
fs.unlink( path.join( pluginSavePath, file ), ( error ) => {
if ( error ) throw error;
2021-12-08 22:56:42 +00:00
} );
}
} );
2021-12-14 17:56:44 +00:00
};
2021-12-08 22:56:42 +00:00
2021-07-15 20:39:32 +00:00
module.exports = {
getRemotePluginZip,
getLatestReleaseZipUrl,
2021-07-21 16:22:50 +00:00
checkNestedZip,
downloadZip,
2021-12-08 22:56:42 +00:00
deleteDownloadedPluginFiles,
2021-07-15 20:39:32 +00:00
};