Skip to content

Commit e2a7ddd

Browse files
karanshah-browserstackkaranshah-browserstack
committed
Merge branch 'master' of github.com:browserstack/browserstack-cypress-cli into CYP_372_ENV_VAR
2 parents e133c53 + 22c892e commit e2a7ddd

File tree

9 files changed

+239
-27
lines changed

9 files changed

+239
-27
lines changed

‎bin/commands/runs.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ module.exports = function run(args) {
4444
let message = `${data.message}! ${Constants.userMessages.BUILD_CREATED} with build id: ${data.build_id}`;
4545
let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${config.dashboardUrl}${data.build_id}`;
4646
utils.exportResults(data.build_id, `${config.dashboardUrl}${data.build_id}`);
47+
if ((utils.isUndefined(bsConfig.run_settings.parallels) && utils.isUndefined(args.parallels)) || (!utils.isUndefined(bsConfig.run_settings.parallels) && bsConfig.run_settings.parallels == Constants.constants.DEFAULT_PARALLEL_MESSAGE)) {
48+
logger.warn(Constants.userMessages.NO_PARALLELS);
49+
}
50+
51+
if(!args.disableNpmWarning && bsConfig.run_settings.npm_dependencies && Object.keys(bsConfig.run_settings.npm_dependencies).length <= 0) logger.warn(Constants.userMessages.NO_NPM_DEPENDENCIES);
52+
4753
logger.info(message);
4854
logger.info(dashboardLink);
4955
utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null);

‎bin/helpers/archiver.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ const archiveSpecs = (runSettings, filePath) => {
3636

3737
archive.pipe(output);
3838

39-
let allowedFileTypes = [ 'js', 'json', 'txt', 'ts', 'feature', 'features' ];
39+
let allowedFileTypes = [ 'js', 'json', 'txt', 'ts', 'feature', 'features', 'pdf', 'jpg', 'jpeg', 'png', 'zip' ];
4040
allowedFileTypes.forEach(fileType => {
41-
archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: ['node_modules/**', 'package-lock.json', 'package.json', 'browserstack-package.json'] });
41+
archive.glob(`**/*.${fileType}`, { cwd: cypressFolderPath, matchBase: true, ignore: ['node_modules/**', 'package-lock.json', 'package.json', 'browserstack-package.json', 'tests.zip'] });
4242
});
4343

4444
let packageJSON = {};

‎bin/helpers/capabilityHelper.js

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@ const caps = (bsConfig, zip) => {
4747

4848
// Local Identifier
4949
obj.localIdentifier = null;
50-
if (obj.local === true && (bsConfig.connection_settings.localIdentifier || bsConfig.connection_settings.local_identifier))
51-
{
50+
if (obj.local === true && (bsConfig.connection_settings.localIdentifier || bsConfig.connection_settings.local_identifier)) {
5251
obj.localIdentifier = bsConfig.connection_settings.localIdentifier || bsConfig.connection_settings.local_identifier;
5352
logger.log(`Local Identifier is set to: ${obj.localIdentifier}`);
5453
}
@@ -70,6 +69,8 @@ const caps = (bsConfig, zip) => {
7069
obj.parallels = bsConfig.run_settings.parallels;
7170
}
7271

72+
if(obj.parallels === Constants.constants.DEFAULT_PARALLEL_MESSAGE) obj.parallels = undefined
73+
7374
if (obj.project) logger.log(`Project name is: ${obj.project}`);
7475

7576
if (obj.customBuildName) logger.log(`Build name is: ${obj.customBuildName}`);
@@ -86,16 +87,18 @@ const caps = (bsConfig, zip) => {
8687
}
8788

8889
const validate = (bsConfig, args) => {
89-
return new Promise(function(resolve, reject){
90+
return new Promise(function (resolve, reject) {
9091
if (!bsConfig) reject(Constants.validationMessages.EMPTY_BROWSERSTACK_JSON);
9192

9293
if (!bsConfig.auth) reject(Constants.validationMessages.INCORRECT_AUTH_PARAMS);
9394

95+
if( bsConfig.auth.username == "<Your BrowserStack username>" || bsConfig.auth.access_key == "<Your BrowserStack access key>" ) reject(Constants.validationMessages.INVALID_DEFAULT_AUTH_PARAMS);
96+
9497
if (!bsConfig.browsers || bsConfig.browsers.length === 0) reject(Constants.validationMessages.EMPTY_BROWSER_LIST);
9598

9699
if (!bsConfig.run_settings) reject(Constants.validationMessages.EMPTY_RUN_SETTINGS);
97100

98-
if (!bsConfig.run_settings.cypress_proj_dir) reject(Constants.validationMessages.EMPTY_SPEC_FILES);
101+
if (!bsConfig.run_settings.cypress_proj_dir) reject(Constants.validationMessages.EMPTY_CYPRESS_PROJ_DIR);
99102

100103
// validate parallels specified in browserstack.json if parallels are not specified via arguments
101104
if (!Utils.isUndefined(args) && Utils.isUndefined(args.parallels) && !Utils.isParallelValid(bsConfig.run_settings.parallels)) reject(Constants.validationMessages.INVALID_PARALLELS_CONFIGURATION);
@@ -105,10 +108,16 @@ const validate = (bsConfig, args) => {
105108

106109
if (!fs.existsSync(path.join(bsConfig.run_settings.cypress_proj_dir, 'cypress.json'))) reject(Constants.validationMessages.CYPRESS_JSON_NOT_FOUND + bsConfig.run_settings.cypress_proj_dir);
107110

108-
try{
109-
let cypressJson = fs.readFileSync(path.join(bsConfig.run_settings.cypress_proj_dir, 'cypress.json'))
110-
JSON.parse(cypressJson)
111-
}catch(error){
111+
try {
112+
let cypressJson = fs.readFileSync(path.join(bsConfig.run_settings.cypress_proj_dir, 'cypress.json'));
113+
cypressJson = JSON.parse(cypressJson);
114+
// Cypress Json Base Url & Local true check
115+
if (!Utils.isUndefined(cypressJson.baseUrl) && cypressJson.baseUrl.includes("localhost") && !Utils.getLocalFlag(bsConfig.connection_settings)) reject(Constants.validationMessages.LOCAL_NOT_SET);
116+
117+
// Detect if the user is not using the right directory structure, and throw an error
118+
if (!Utils.isUndefined(cypressJson.integrationFolder) && !Utils.isCypressProjDirValid(bsConfig.run_settings.cypress_proj_dir,cypressJson.integrationFolder)) reject(Constants.validationMessages.INCORRECT_DIRECTORY_STRUCTURE);
119+
120+
} catch (error) {
112121
reject(Constants.validationMessages.INVALID_CYPRESS_JSON)
113122
}
114123

‎bin/helpers/constants.js

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ const userMessages = {
1212
ZIP_DELETED: "Zip file deleted successfully.",
1313
API_DEPRECATED: "This version of API is deprecated, please use latest version of API.",
1414
FAILED_TO_ZIP: "Failed to zip files.",
15-
VISIT_DASHBOARD: "Visit the Automate dashboard for test reporting:"
15+
VISIT_DASHBOARD: "Visit the Automate dashboard for test reporting:",
16+
NO_PARALLELS: "Your tests will run sequentially. Read more about running your tests in parallel here: https://www.browserstack.com/docs/automate/cypress/run-tests-in-parallel",
17+
NO_NPM_DEPENDENCIES: "No npm dependencies specified. Read more here: https://www.browserstack.com/docs/automate/cypress/npm-packages. You can suppress this warning by using --disable-npm-warning flag."
1618
};
1719

1820
const validationMessages = {
@@ -21,14 +23,17 @@ const validationMessages = {
2123
EMPTY_TEST_SUITE: "Test suite is empty",
2224
EMPTY_BROWSERSTACK_JSON: "Empty browserstack.json",
2325
EMPTY_RUN_SETTINGS: "Empty run settings",
24-
EMPTY_SPEC_FILES: "No spec files specified in run_settings",
26+
EMPTY_CYPRESS_PROJ_DIR: "cypress_proj_dir is not set in run_settings. See https://www.browserstack.com/docs/automate/cypress/sample-tutorial to learn more.",
2527
VALIDATED: "browserstack.json file is validated",
2628
NOT_VALID: "browerstack.json is not valid",
2729
NOT_VALID_JSON: "browerstack.json is not a valid json",
2830
INVALID_EXTENSION: "Invalid files, please remove these files and try again.",
2931
INVALID_PARALLELS_CONFIGURATION: "Invalid value specified for parallels to use. Maximum parallels to use should be a number greater than 0.",
3032
CYPRESS_JSON_NOT_FOUND: "cypress.json file is not found at cypress_proj_dir path ",
31-
INVALID_CYPRESS_JSON: "cypress.json is not a valid json"
33+
INVALID_CYPRESS_JSON: "cypress.json is not a valid json",
34+
INVALID_DEFAULT_AUTH_PARAMS: "Your username and access key are required to run your tests on BrowserStack. Learn more at https://www.browserstack.com/docs/automate/cypress/authentication",
35+
LOCAL_NOT_SET: "To test <baseUrl value> on BrowserStack, you will have to set up Local testing. Read more here: https://www.browserstack.com/docs/automate/cypress/local-testing",
36+
INCORRECT_DIRECTORY_STRUCTURE: "No tests to run. Note that your Cypress tests should be in the same directory where the cypress.json exists."
3237
};
3338

3439
const cliMessages = {
@@ -60,7 +65,8 @@ const cliMessages = {
6065
COMMON: {
6166
DISABLE_USAGE_REPORTING: "Disable usage reporting",
6267
USERNAME: "Your BrowserStack username",
63-
ACCESS_KEY: "Your BrowserStack access key"
68+
ACCESS_KEY: "Your BrowserStack access key",
69+
NO_NPM_WARNING: "No NPM warning if npm_dependencies is empty"
6470
}
6571
}
6672

@@ -73,9 +79,14 @@ const messageTypes = {
7379
NULL: null
7480
}
7581

82+
const constants = {
83+
DEFAULT_PARALLEL_MESSAGE: "Here goes the number of parallels you want to run"
84+
}
85+
7686
module.exports = Object.freeze({
7787
userMessages,
7888
cliMessages,
7989
validationMessages,
8090
messageTypes,
91+
constants
8192
});

‎bin/helpers/utils.js

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ exports.validateBstackJson = (bsConfigPath) => {
1515
resolve(bsConfig);
1616
}
1717
catch (e) {
18-
reject(e);
18+
reject("Couldn't find the browserstack.json file at \""+ bsConfigPath +"\". Please use --config-file <path to browserstack.json>.");
1919
}
2020
});
2121
}
@@ -35,9 +35,24 @@ exports.getErrorCodeFromMsg = (errMsg) => {
3535
case Constants.validationMessages.EMPTY_RUN_SETTINGS:
3636
errorCode = "bstack_json_invalid_no_run_settings";
3737
break;
38-
case Constants.validationMessages.EMPTY_SPEC_FILES:
39-
errorCode = "bstack_json_invalid_values";
38+
case Constants.validationMessages.EMPTY_CYPRESS_PROJ_DIR:
39+
errorCode = "bstack_json_invalid_no_cypress_proj_dir";
4040
break;
41+
case Constants.validationMessages.INVALID_DEFAULT_AUTH_PARAMS:
42+
errorCode = "bstack_json_default_auth_keys";
43+
break;
44+
case Constants.validationMessages.INVALID_PARALLELS_CONFIGURATION:
45+
errorCode = "invalid_parallels_specified";
46+
break;
47+
case Constants.validationMessages.LOCAL_NOT_SET:
48+
errorCode = "cypress_json_base_url_no_local";
49+
break;
50+
case Constants.validationMessages.INCORRECT_DIRECTORY_STRUCTURE:
51+
errorCode = "invalid_directory_structure";
52+
break;
53+
}
54+
if(errMsg.includes("Please use --config-file <path to browserstack.json>.")){
55+
errorCode = "bstack_json_path_invalid";
4156
}
4257
return errorCode;
4358
}
@@ -101,7 +116,7 @@ exports.isUndefined = value => (value === undefined || value === null);
101116
exports.isFloat = value => (Number(value) && Number(value) % 1 !== 0);
102117

103118
exports.isParallelValid = (value) => {
104-
return this.isUndefined(value) || !(isNaN(value) || this.isFloat(value) || parseInt(value, 10) === 0 || parseInt(value, 10) < -1);
119+
return this.isUndefined(value) || !(isNaN(value) || this.isFloat(value) || parseInt(value, 10) === 0 || parseInt(value, 10) < -1 ) || value === Constants.constants.DEFAULT_PARALLEL_MESSAGE;
105120
}
106121

107122
exports.getUserAgent = () => {
@@ -136,3 +151,17 @@ exports.deleteResults = () => {
136151
fs.unlink("log/build_results.txt", function (err){
137152
});
138153
}
154+
155+
exports.isCypressProjDirValid = (cypressDir, cypressProjDir) => {
156+
// Getting absolute path
157+
cypressDir = path.resolve(cypressDir);
158+
cypressProjDir = path.resolve(cypressProjDir);
159+
if(cypressProjDir === cypressDir) return true;
160+
let parentTokens = cypressDir.split('/').filter(i => i.length);
161+
let childTokens = cypressProjDir.split('/').filter(i => i.length);
162+
return parentTokens.every((t, i) => childTokens[i] === t);
163+
}
164+
165+
exports.getLocalFlag = (connectionSettings) => {
166+
return !this.isUndefined(connectionSettings) && !this.isUndefined(connectionSettings.local) && connectionSettings.local
167+
}

‎bin/runner.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,11 @@ var argv = yargs
164164
describe: Constants.cliMessages.RUN.BUILD_NAME,
165165
type: "string",
166166
default: undefined
167+
},
168+
'disable-npm-warning': {
169+
default: false,
170+
description: Constants.cliMessages.COMMON.NO_NPM_WARNING,
171+
type: "boolean"
167172
}
168173
})
169174
.help('help')

‎test/unit/bin/commands/runs.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,7 @@ describe("runs", () => {
452452
deleteZipStub = sandbox.stub();
453453
exportResultsStub = sandbox.stub();
454454
deleteResultsStub = sandbox.stub();
455+
isUndefinedStub = sandbox.stub();
455456
});
456457

457458
afterEach(() => {
@@ -476,7 +477,8 @@ describe("runs", () => {
476477
setParallels: setParallelsStub,
477478
getConfigPath: getConfigPathStub,
478479
exportResults: exportResultsStub,
479-
deleteResults: deleteResultsStub
480+
deleteResults: deleteResultsStub,
481+
isUndefined: isUndefinedStub
480482
},
481483
"../helpers/capabilityHelper": {
482484
validate: capabilityValidatorStub,

0 commit comments

Comments
 (0)