Skip to content

Commit 11a63ce

Browse files
suryartsuryart
authored
Merge pull request #14 from browserstack/CYP_123_instrumentation
Adding required instrumentation
2 parents 331011e + 315c575 commit 11a63ce

File tree

17 files changed

+720
-236
lines changed

17 files changed

+720
-236
lines changed

‎bin/commands/info.js‎

Lines changed: 81 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,94 @@
11
'use strict';
2-
var config = require('../helpers/config');
3-
var request = require('request')
4-
var logger = require("../helpers/logger");
5-
var Constant = require("../helpers/constants")
2+
const request = require('request');
3+
4+
const config = require("../helpers/config"),
5+
logger = require("../helpers/logger").winstonLogger,
6+
Constants = require("../helpers/constants"),
7+
util = require("../helpers/util");
68

79
module.exports = function info(args) {
810
return buildInfo(args)
911
}
1012

1113
function buildInfo(args) {
1214
let bsConfigPath = process.cwd() + args.cf;
13-
logger.log(`Reading config from ${args.cf}`);
14-
var bsConfig = require(bsConfigPath);
15-
16-
let buildId = args._[1]
17-
18-
let options = {
19-
url: config.buildUrl + buildId,
20-
method: 'GET',
21-
auth: {
22-
user: bsConfig.auth.username,
23-
password: bsConfig.auth.access_key
24-
}
25-
}
26-
27-
request(options, function (err, resp, body) {
28-
if (err) {
29-
logger.log(Constant.userMessages.BUILD_INFO_FAILED);
30-
} else {
31-
let build = null
32-
try {
33-
build = JSON.parse(body)
34-
} catch (error) {
35-
build = null
36-
}
37-
38-
if (resp.statusCode != 200) {
39-
if (build) {
40-
logger.error(`${Constant.userMessages.BUILD_INFO_FAILED} with error: \n${JSON.stringify(build, null, 2)}`);
41-
} else {
42-
logger.error(Constant.userMessages.BUILD_INFO_FAILED);
15+
16+
util.validateBstackJson(bsConfigPath).then(function (bsConfig) {
17+
util.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
18+
19+
let buildId = args._[1];
20+
21+
let options = {
22+
url: config.buildUrl + buildId,
23+
method: "GET",
24+
auth: {
25+
user: bsConfig.auth.username,
26+
password: bsConfig.auth.access_key,
27+
},
28+
headers: {
29+
"User-Agent": util.getUserAgent(),
30+
},
31+
};
32+
33+
request(options, function (err, resp, body) {
34+
let message = null;
35+
let messageType = null;
36+
let errorCode = null;
37+
38+
if (err) {
39+
message = Constants.userMessages.BUILD_INFO_FAILED;
40+
messageType = Constants.messageTypes.ERROR;
41+
errorCode = 'api_failed_build_info';
42+
43+
logger.info(message);
44+
} else {
45+
let build = null;
46+
try {
47+
build = JSON.parse(body);
48+
} catch (error) {
49+
build = null;
4350
}
44-
} else if(resp.statusCode == 299) {
45-
if(build) {
46-
logger.log(build.message);
51+
52+
if (resp.statusCode == 299) {
53+
messageType = Constants.messageTypes.INFO;
54+
errorCode = "api_deprecated";
55+
56+
if (build) {
57+
message = build.message;
58+
logger.info(message);
59+
} else {
60+
message = Constants.userMessages.API_DEPRECATED;
61+
logger.info(message);
62+
}
63+
} else if (resp.statusCode != 200) {
64+
messageType = Constants.messageTypes.ERROR;
65+
errorCode = "api_failed_build_info";
66+
67+
if (build) {
68+
message = `${
69+
Constants.userMessages.BUILD_INFO_FAILED
70+
} with error: \n${JSON.stringify(build, null, 2)}`;
71+
logger.error(message);
72+
if (build.message === "Unauthorized") errorCode = "api_auth_failed";
73+
} else {
74+
message = Constants.userMessages.BUILD_INFO_FAILED;
75+
logger.error(message);
76+
}
4777
} else {
48-
logger.log(Constants.userMessages.API_DEPRECATED);
78+
messageType = Constants.messageTypes.SUCCESS;
79+
message = `Build info for build id: \n ${JSON.stringify(
80+
build,
81+
null,
82+
2
83+
)}`;
84+
logger.info(message);
4985
}
50-
} else {
51-
logger.log(`Build info for build id: \n ${JSON.stringify(build, null, 2)}`)
5286
}
53-
}
54-
})
87+
util.sendUsageReport(bsConfig, args, message, messageType, errorCode);
88+
})
89+
}).catch(function (err) {
90+
logger.error(err);
91+
util.setUsageReportingFlag(null, args.disableUsageReporting);
92+
util.sendUsageReport(null, args, err.message, Constants.messageTypes.ERROR, util.getErrorCodeFromErr(err));
93+
})
5594
}

‎bin/commands/init.js‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
'use strict';
2-
var fileHelpers = require('../helpers/fileHelpers');
3-
const Constants = require('../helpers/constants');
4-
var logger = require("../helpers/logger");
2+
const fileHelpers = require("../helpers/fileHelpers"),
3+
Constants = require("../helpers/constants"),
4+
logger = require("../helpers/logger").winstonLogger,
5+
util = require("../helpers/util");
56

67
module.exports = function init(args) {
78
return createBrowserStackConfig(args)
@@ -21,12 +22,16 @@ function createBrowserStackConfig(args) {
2122
};
2223

2324
function allDone() {
24-
logger.log(Constants.userMessages.CONFIG_FILE_CREATED);
25+
let message = Constants.userMessages.CONFIG_FILE_CREATED
26+
logger.info(message);
27+
util.sendUsageReport(null, args, message, Constants.messageTypes.SUCCESS, null);
2528
}
2629

2730
return fileHelpers.fileExists(config.path, function(exists){
2831
if (exists) {
29-
logger.error(Constants.userMessages.CONFIG_FILE_EXISTS);
32+
let message = Constants.userMessages.CONFIG_FILE_EXISTS;
33+
logger.error(message);
34+
util.sendUsageReport(null, args, message, Constants.messageTypes.ERROR, 'bstack_json_already_exists');
3035
} else {
3136
fileHelpers.write(config, null, allDone);
3237
}

‎bin/commands/runs.js‎

Lines changed: 62 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
'use strict';
2-
var archiver = require("../helpers/archiver");
3-
var zipUploader = require("../helpers/zipUpload");
4-
var build = require("../helpers/build");
5-
var logger = require("../helpers/logger");
6-
var config = require('../helpers/config');
7-
var capabilityHelper = require("../helpers/capabilityHelper");
8-
var fs = require('fs');
9-
const Constants = require('../helpers/constants');
2+
const fs = require('fs');
3+
4+
const archiver = require("../helpers/archiver"),
5+
zipUploader = require("../helpers/zipUpload"),
6+
build = require("../helpers/build"),
7+
logger = require("../helpers/logger").winstonLogger,
8+
config = require("../helpers/config"),
9+
capabilityHelper = require("../helpers/capabilityHelper"),
10+
Constants = require("../helpers/constants"),
11+
util = require("../helpers/util");
1012

1113
module.exports = function run(args) {
1214
return runCypress(args);
@@ -15,48 +17,69 @@ module.exports = function run(args) {
1517
function deleteZip() {
1618
fs.unlink(config.fileName, function (err) {
1719
if(err) {
18-
logger.log(Constants.userMessages.ZIP_DELETE_FAILED);
20+
logger.info(Constants.userMessages.ZIP_DELETE_FAILED);
1921
} else {
20-
logger.log(Constants.userMessages.ZIP_DELETED);
21-
}
22+
logger.info(Constants.userMessages.ZIP_DELETED);
23+
}
2224
});
2325
}
2426

2527
function runCypress(args) {
2628
let bsConfigPath = process.cwd() + args.cf;
27-
logger.log(`Reading config from ${args.cf}`);
28-
var bsConfig = require(bsConfigPath);
29-
30-
// Validate browserstack.json
31-
capabilityHelper.validate(bsConfig).then(function (validated) {
32-
logger.log(validated);
33-
// Archive the spec files
34-
archiver.archive(bsConfig.run_settings, config.fileName).then(function (data) {
35-
// Uploaded zip file
36-
zipUploader.zipUpload(bsConfig, config.fileName).then(function (zip) {
37-
// Create build
38-
build.createBuild(bsConfig, zip).then(function (data) {
39-
return;
29+
30+
util.validateBstackJson(bsConfigPath).then(function (bsConfig) {
31+
util.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
32+
33+
// Validate browserstack.json values
34+
capabilityHelper.validate(bsConfig).then(function (validated) {
35+
logger.info(validated);
36+
37+
// Archive the spec files
38+
archiver.archive(bsConfig.run_settings, config.fileName).then(function (data) {
39+
40+
// Uploaded zip file
41+
zipUploader.zipUpload(bsConfig, config.fileName).then(function (zip) {
42+
43+
// Create build
44+
build.createBuild(bsConfig, zip).then(function (message) {
45+
logger.info(message);
46+
util.sendUsageReport(bsConfig, args, message, Constants.messageTypes.SUCCESS, null);
47+
return;
48+
}).catch(function (err) {
49+
// Build creation failed
50+
logger.error(err);
51+
util.sendUsageReport(bsConfig, args, err, Constants.messageTypes.ERROR, 'build_failed');
52+
});
4053
}).catch(function (err) {
41-
// Build creation failed
42-
logger.error(Constants.userMessages.BUILD_FAILED)
54+
// Zip Upload failed
55+
logger.error(err)
56+
logger.error(Constants.userMessages.ZIP_UPLOAD_FAILED)
57+
util.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.ZIP_UPLOAD_FAILED}`, Constants.messageTypes.ERROR, 'zip_upload_failed');
58+
}).finally(function () {
59+
deleteZip();
4360
});
4461
}).catch(function (err) {
45-
// Zip Upload failed
46-
logger.error(err)
47-
logger.error(Constants.userMessages.ZIP_UPLOAD_FAILED)
48-
}).finally(function () {
49-
deleteZip();
62+
// Zipping failed
63+
logger.error(err);
64+
logger.error(Constants.userMessages.FAILED_TO_ZIP);
65+
util.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.FAILED_TO_ZIP}`, Constants.messageTypes.ERROR, 'zip_creation_failed');
66+
try {
67+
deleteZip();
68+
} catch (err) {
69+
util.sendUsageReport(bsConfig, args, Constants.userMessages.ZIP_DELETE_FAILED, Constants.messageTypes.ERROR, 'zip_deletion_failed');
70+
}
5071
});
5172
}).catch(function (err) {
52-
// Zipping failed
53-
logger.error(err)
54-
logger.error(Constants.userMessages.FAILED_TO_ZIP)
55-
deleteZip();
73+
// browerstack.json is not valid
74+
logger.error(err);
75+
logger.error(Constants.validationMessages.NOT_VALID);
76+
77+
let error_code = util.getErrorCodeFromMsg(err);
78+
util.sendUsageReport(bsConfig, args, `${err}\n${Constants.validationMessages.NOT_VALID}`, Constants.messageTypes.ERROR, error_code);
5679
});
5780
}).catch(function (err) {
58-
// browerstack.json is not valid
59-
logger.error(err)
60-
logger.error(Constants.validationMessages.NOT_VALID)
61-
});
81+
logger.error(err);
82+
util.setUsageReportingFlag(null, args.disableUsageReporting);
83+
util.sendUsageReport(null, args, err.message, Constants.messageTypes.ERROR, util.getErrorCodeFromErr(err));
84+
})
6285
}

0 commit comments

Comments
 (0)