Skip to content

Cypress cli npm install package #173

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

Merged
merged 18 commits into from
Nov 9, 2021
Merged

Cypress cli npm install package #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
ec471d3
added support for npm package caching
sparsh0204 Sep 18, 2021
81ed443
Merge branch 'master' into cypress_npm_install_cli
sparsh0204 Sep 18, 2021
7eb40da
added CYPRESS_INSTALL_BINARY to control cypress package install
sparsh0204 Sep 22, 2021
ded08c9
Merge branch 'master' into cypress_npm_install_cli
sparsh0204 Oct 4, 2021
4c300ef
add npmrc
sparsh0204 Oct 5, 2021
b4c9e81
add npmrc to md5 check
sparsh0204 Oct 5, 2021
cbb9fb3
remove debug logs
sparsh0204 Oct 5, 2021
3de6e80
log error to UsageReport
sparsh0204 Oct 6, 2021
60e403b
skip test md5 calculation
sparsh0204 Oct 6, 2021
a2afcca
use npm 6.14.15 and error handling
sparsh0204 Oct 6, 2021
e05069c
change flag name
sparsh0204 Oct 7, 2021
9463861
npm install cache and messaging
sparsh0204 Oct 7, 2021
8006beb
disable cache flag and cleanup
sparsh0204 Oct 12, 2021
2d180d5
improve messaging
sparsh0204 Oct 13, 2021
3b8d2fa
Merge branch 'master' into cypress_npm_install_cli
sparsh0204 Oct 26, 2021
c50065e
test coverage for npm install
sparsh0204 Oct 28, 2021
9909314
Merge branch 'master' into cypress_npm_install_cli
sparsh0204 Nov 9, 2021
6897980
merge issue
sparsh0204 Nov 9, 2021
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
213 changes: 122 additions & 91 deletions bin/commands/runs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const archiver = require("../helpers/archiver"),
fileHelpers = require("../helpers/fileHelpers"),
syncRunner = require("../helpers/syncRunner"),
checkUploaded = require("../helpers/checkUploaded"),
packageInstaller = require("../helpers/packageInstaller"),
reportGenerator = require('../helpers/reporterHTML').reportGenerator,
{initTimeComponents, instrumentEventTime, markBlockStart, markBlockEnd, getTimeComponents} = require('../helpers/timeComponents'),
downloadBuildArtifacts = require('../helpers/buildArtifacts').downloadBuildArtifacts,
Expand Down Expand Up @@ -103,121 +104,151 @@ module.exports = function run(args) {
return checkUploaded.checkUploadedMd5(bsConfig, args, {markBlockStart, markBlockEnd}).then(function (md5data) {
markBlockEnd('checkAlreadyUploaded');

// Archive the spec files
markBlockStart('zip');
markBlockStart('zip.archive');
return archiver.archive(bsConfig.run_settings, config.fileName, args.exclude, md5data).then(function (data) {
markBlockEnd('zip.archive');

// Uploaded zip file
markBlockStart('zip.zipUpload');
return zipUploader.zipUpload(bsConfig, config.fileName, md5data).then(async function (zip) {
markBlockEnd('zip.zipUpload');
markBlockEnd('zip');
// Create build

//setup Local Testing
markBlockStart('localSetup');
let bs_local = await utils.setupLocalTesting(bsConfig, args);
markBlockEnd('localSetup');
markBlockStart('createBuild');
return build.createBuild(bsConfig, zip).then(function (data) {
markBlockEnd('createBuild');
markBlockEnd('total');
utils.setProcessHooks(data.build_id, bsConfig, bs_local, args);
let message = `${data.message}! ${Constants.userMessages.BUILD_CREATED} with build id: ${data.build_id}`;
let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${data.dashboard_url}`;
utils.exportResults(data.build_id, `${config.dashboardUrl}${data.build_id}`);
if ((utils.isUndefined(bsConfig.run_settings.parallels) && utils.isUndefined(args.parallels)) || (!utils.isUndefined(bsConfig.run_settings.parallels) && bsConfig.run_settings.parallels == Constants.cliMessages.RUN.DEFAULT_PARALLEL_MESSAGE)) {
logger.warn(Constants.userMessages.NO_PARALLELS);
}
if (bsConfig.run_settings.cypress_version && bsConfig.run_settings.cypress_version !== data.cypress_version) {
if (bsConfig.run_settings.cypress_version.toString().match(Constants.LATEST_VERSION_SYNTAX_REGEX)) {
let versionMessage = utils.latestSyntaxToActualVersionMessage(bsConfig.run_settings.cypress_version, data.cypress_version, data.framework_upgrade_message);
logger.info(versionMessage);
} else {
let versionMessage = utils.versionChangedMessage(bsConfig.run_settings.cypress_version, data.cypress_version, data.framework_upgrade_message);
logger.warn(versionMessage);
markBlockStart('packageInstaller');
return packageInstaller.packageWrapper(bsConfig, config.packageDirName, config.packageFileName, md5data, {markBlockStart, markBlockEnd}).then(function (packageData) {
markBlockEnd('packageInstaller');

// Archive the spec files
markBlockStart('zip');
markBlockStart('zip.archive');
return archiver.archive(bsConfig.run_settings, config.fileName, args.exclude, md5data).then(function (data) {
markBlockEnd('zip.archive');

// Uploaded zip file
markBlockStart('zip.zipUpload');
return zipUploader.zipUpload(bsConfig, md5data, packageData).then(async function (zip) {
markBlockEnd('zip.zipUpload');
markBlockEnd('zip');

// Create build
//setup Local Testing
markBlockStart('localSetup');
let bs_local = await utils.setupLocalTesting(bsConfig, args);
markBlockEnd('localSetup');
markBlockStart('createBuild');
return build.createBuild(bsConfig, zip).then(function (data) {
markBlockEnd('createBuild');
markBlockEnd('total');
utils.setProcessHooks(data.build_id, bsConfig, bs_local, args);
let message = `${data.message}! ${Constants.userMessages.BUILD_CREATED} with build id: ${data.build_id}`;
let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${data.dashboard_url}`;
utils.exportResults(data.build_id, `${config.dashboardUrl}${data.build_id}`);
if ((utils.isUndefined(bsConfig.run_settings.parallels) && utils.isUndefined(args.parallels)) || (!utils.isUndefined(bsConfig.run_settings.parallels) && bsConfig.run_settings.parallels == Constants.cliMessages.RUN.DEFAULT_PARALLEL_MESSAGE)) {
logger.warn(Constants.userMessages.NO_PARALLELS);
}
}

if (!args.disableNpmWarning && bsConfig.run_settings.npm_dependencies && Object.keys(bsConfig.run_settings.npm_dependencies).length <= 0) {
logger.warn(Constants.userMessages.NO_NPM_DEPENDENCIES);
logger.warn(Constants.userMessages.NO_NPM_DEPENDENCIES_READ_MORE);
}
if (bsConfig.run_settings.cypress_version && bsConfig.run_settings.cypress_version !== data.cypress_version) {
if (bsConfig.run_settings.cypress_version.toString().match(Constants.LATEST_VERSION_SYNTAX_REGEX)) {
let versionMessage = utils.latestSyntaxToActualVersionMessage(bsConfig.run_settings.cypress_version, data.cypress_version, data.framework_upgrade_message);
logger.info(versionMessage);
} else {
let versionMessage = utils.versionChangedMessage(bsConfig.run_settings.cypress_version, data.cypress_version, data.framework_upgrade_message);
logger.warn(versionMessage);
}
}

if (args.sync) {
syncRunner.pollBuildStatus(bsConfig, data).then(async (exitCode) => {
if (!args.disableNpmWarning && bsConfig.run_settings.npm_dependencies && Object.keys(bsConfig.run_settings.npm_dependencies).length <= 0) {
logger.warn(Constants.userMessages.NO_NPM_DEPENDENCIES);
logger.warn(Constants.userMessages.NO_NPM_DEPENDENCIES_READ_MORE);
}

// stop the Local instance
await utils.stopLocalBinary(bsConfig, bs_local, args);

// waiting for 5 secs for upload to complete (as a safety measure)
await new Promise(resolve => setTimeout(resolve, 5000));
if (args.sync) {
syncRunner.pollBuildStatus(bsConfig, data).then(async (exitCode) => {

// download build artifacts
if (utils.nonEmptyArray(bsConfig.run_settings.downloads)) {
await downloadBuildArtifacts(bsConfig, data.build_id, args);
}
// stop the Local instance
await utils.stopLocalBinary(bsConfig, bs_local, args);

// waiting for 5 secs for upload to complete (as a safety measure)
await new Promise(resolve => setTimeout(resolve, 5000));

// download build artifacts
if (utils.nonEmptyArray(bsConfig.run_settings.downloads)) {
await downloadBuildArtifacts(bsConfig, data.build_id, args);
}

// Generate custom report!
reportGenerator(bsConfig, data.build_id, args, function(){
utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null);
utils.handleSyncExit(exitCode, data.dashboard_url);
// Generate custom report!
reportGenerator(bsConfig, data.build_id, args, function(){
utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null);
utils.handleSyncExit(exitCode, data.dashboard_url);
});
});
});
} else if (utils.nonEmptyArray(bsConfig.run_settings.downloads)) {
logger.info(Constants.userMessages.ASYNC_DOWNLOADS.replace('<build-id>', data.build_id));
}
} else if (utils.nonEmptyArray(bsConfig.run_settings.downloads)) {
logger.info(Constants.userMessages.ASYNC_DOWNLOADS.replace('<build-id>', data.build_id));
}

logger.info(message);
logger.info(dashboardLink);
if(!args.sync) logger.info(Constants.userMessages.EXIT_SYNC_CLI_MESSAGE.replace("<build-id>", data.build_id));
let dataToSend = {
time_components: getTimeComponents(),
unique_id: utils.generateUniqueHash(),
build_id: data.build_id,
};
if (bsConfig && bsConfig.connection_settings) {
if (bsConfig.connection_settings.local_mode) {
dataToSend.local_mode = bsConfig.connection_settings.local_mode;
logger.info(message);
logger.info(dashboardLink);
if(!args.sync) logger.info(Constants.userMessages.EXIT_SYNC_CLI_MESSAGE.replace("<build-id>",data.build_id));
let dataToSend = {
time_components: getTimeComponents(),
unique_id: utils.generateUniqueHash(),
package_error: utils.checkError(packageData),
checkmd5_error: utils.checkError(md5data),
build_id: data.build_id,
};
if (bsConfig && bsConfig.connection_settings) {
if (bsConfig.connection_settings.local_mode) {
dataToSend.local_mode = bsConfig.connection_settings.local_mode;
}
if (bsConfig.connection_settings.usedAutoLocal) {
dataToSend.used_auto_local = bsConfig.connection_settings.usedAutoLocal;
}
}
if (bsConfig.connection_settings.usedAutoLocal) {
dataToSend.used_auto_local = bsConfig.connection_settings.usedAutoLocal;
utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null, dataToSend);
return;
}).catch(async function (err) {
// Build creation failed
logger.error(err);
// stop the Local instance
await utils.stopLocalBinary(bsConfig, bs_local, args);

utils.sendUsageReport(bsConfig, args, err, Constants.messageTypes.ERROR, 'build_failed');
process.exitCode = Constants.ERROR_EXIT_CODE;
});
}).catch(function (err) {
// Zip Upload failed | Local Start failed
logger.error(err);
if(err === Constants.userMessages.LOCAL_START_FAILED){
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.LOCAL_START_FAILED}`, Constants.messageTypes.ERROR, 'local_start_failed');
} else {
logger.error(Constants.userMessages.ZIP_UPLOAD_FAILED);
fileHelpers.deleteZip();
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.ZIP_UPLOAD_FAILED}`, Constants.messageTypes.ERROR, 'zip_upload_failed');
try {
fileHelpers.deletePackageArchieve();
} catch (err) {
utils.sendUsageReport(bsConfig, args, Constants.userMessages.NPM_DELETE_FAILED, Constants.messageTypes.ERROR, 'npm_deletion_failed');
}
}
utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null, dataToSend);
return;
}).catch(async function (err) {
// Build creation failed
logger.error(err);
// stop the Local instance
await utils.stopLocalBinary(bsConfig, bs_local, args);

utils.sendUsageReport(bsConfig, args, err, Constants.messageTypes.ERROR, 'build_failed');
process.exitCode = Constants.ERROR_EXIT_CODE;
});
}).catch(function (err) {
// Zip Upload failed | Local Start failed
// Zipping failed
logger.error(err);
if(err === Constants.userMessages.LOCAL_START_FAILED){
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.LOCAL_START_FAILED}`, Constants.messageTypes.ERROR, 'local_start_failed');
} else {
logger.error(Constants.userMessages.ZIP_UPLOAD_FAILED);
logger.error(Constants.userMessages.FAILED_TO_ZIP);
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.FAILED_TO_ZIP}`, Constants.messageTypes.ERROR, 'zip_creation_failed');
try {
fileHelpers.deleteZip();
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.ZIP_UPLOAD_FAILED}`, Constants.messageTypes.ERROR, 'zip_upload_failed');
} catch (err) {
utils.sendUsageReport(bsConfig, args, Constants.userMessages.ZIP_DELETE_FAILED, Constants.messageTypes.ERROR, 'zip_deletion_failed');
}
try {
fileHelpers.deletePackageArchieve();
} catch (err) {
utils.sendUsageReport(bsConfig, args, Constants.userMessages.NPM_DELETE_FAILED, Constants.messageTypes.ERROR, 'npm_deletion_failed');
}
process.exitCode = Constants.ERROR_EXIT_CODE;
});
}).catch(function (err) {
// Zipping failed
// package installer failed
logger.error(err);
logger.error(Constants.userMessages.FAILED_TO_ZIP);
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.FAILED_TO_ZIP}`, Constants.messageTypes.ERROR, 'zip_creation_failed');
logger.error(Constants.userMessages.FAILED_CREATE_NPM_ARCHIVE);
utils.sendUsageReport(bsConfig, args, Constants.userMessages.FAILED_CREATE_NPM_ARCHIVE, Constants.messageTypes.ERROR, 'npm_package_archive_failed');
try {
fileHelpers.deleteZip();
fileHelpers.deletePackageArchieve();
} catch (err) {
utils.sendUsageReport(bsConfig, args, Constants.userMessages.ZIP_DELETE_FAILED, Constants.messageTypes.ERROR, 'zip_deletion_failed');
utils.sendUsageReport(bsConfig, args, Constants.userMessages.NPM_DELETE_FAILED, Constants.messageTypes.ERROR, 'npm_deletion_failed');
}
process.exitCode = Constants.ERROR_EXIT_CODE;
});
Expand Down
6 changes: 6 additions & 0 deletions bin/helpers/capabilityHelper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ const caps = (bsConfig, zip) => {
reject("Test suite is empty");
}

// Npm package
if (zip.npm_package_url && zip.npm_package_url.split("://")[1].length !== 0) {
obj.npm_package_suite = zip.npm_package_url.split("://")[1];
}
obj.cache_dependencies = bsConfig.run_settings.cache_dependencies;

// Inferred settings
if(bsConfig.connection_settings){
if (bsConfig.connection_settings.local_mode_inferred) {
Expand Down
Loading