accessibility-checker
Version:
An automated testing tools for accessibility testing using Puppeteer, Selenium, or Zombie
181 lines (178 loc) • 9.55 kB
JavaScript
;
/******************************************************************************
Copyright:: 2020- IBM, Inc
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*****************************************************************************/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ACMetricsLogger = void 0;
var axios_1 = require("axios");
/**
* This function is responsible for constructing the accessibility-checker Metrics object which contains all the function
* that are needed to upload scan metrics to the metric server.
*
* @param {String} toolName - The name of the tool sending the metrics.
* @param {String} logger - Logger object which can be used to log debug information.
* @param {String} policies - Array of policies which will be sent to the metrics server.
*
* @return - N/A
*
* @memberOf this
*/
var ACMetricsLogger = /** @class */ (function () {
function ACMetricsLogger(toolName, logger, policies) {
this.metricsURLV2 = "https://able.ibm.com/tools";
this.scanTimesV1 = [];
this.scanTimesV2 = {};
this.policies = policies.join(",");
// accessibility-checker Metrics Logger
this.log = logger;
// Init all the local object variables
this.toolName = toolName;
}
/**
* This function is responsible for profiling the testcases and adding the scan time to the global
* array which will be sent to the metrics server to log the number of scans that were performed.
* This function profiles scanTimes for the V2 metric server:
* https://aat.w3ibm.mybluemix.net
*
* In the case that user provides any url that is https://aat* it will upload based on accountId
*
* @param {String} scanTime - Provide the time it took for the testcase to run
* @param {String} profile - The type of profile the scan time is for:
* i.e. browser information, features, etc...
*
* @return N/A - Global scanTimesV2 object is updated with the time
*
* @memberOf this
*/
ACMetricsLogger.prototype.profileV2 = function (scanTime, profile) {
this.log.debug("START 'profileV2' function");
// URI encode the profile text provided
profile = encodeURIComponent(profile);
// Add the time it took for the testcase to run to the global array, indexed by the profile
this.scanTimesV2[profile] = this.scanTimesV2[profile] || [];
this.scanTimesV2[profile].push(scanTime);
this.log.debug("END 'profileV2' function");
};
;
/**
* This function is responsible for uploading scan results to the metrics server:
* https://aat.w3ibm.mybluemix.net
*
* @param {Function} done - The browser on which the testcases were run on
*
* @return N/A - performs the upload of the metrics to the server
*
* @memberOf this
*/
ACMetricsLogger.prototype.sendLogsV2 = function (done, rulePack) {
return __awaiter(this, void 0, void 0, function () {
var loggerInScope, numProfiles_1, accountId, profile, _loop_1, this_1;
return __generator(this, function (_a) {
this.log.debug("START 'sendLogsV2' function");
loggerInScope = this.log;
try {
numProfiles_1 = 0;
accountId = "";
// Loop over all the profiles with in the scanTime Object
for (profile in this.scanTimesV2) {
_loop_1 = function () {
// Build a truncatedScanTime Array to upload to the metrics server chunck by chunck
var subScanTimes = this_1.scanTimesV2[profile].splice(0, 150);
// Increment the num Profile
++numProfiles_1;
// Start building the Query string to be sent to the metrics server
var qs = "?t=" + this_1.toolName + "&tag=" + profile + "&a=" + accountId + "&pol=" + this_1.policies + "&st=";
subScanTimes.forEach(function (t) {
qs += t;
qs += ",";
});
qs = qs.substr(0, qs.length - 1);
this_1.log.debug("Uploading: " + this_1.metricsURLV2 + "/api/pub/meter/v2" + qs);
// Dispatch the call to the metrics server
// Istanbul is not able to capture the coverate of functions call in a callback therefore we need to skip
/* istanbul ignore next */
axios_1.default.get(this_1.metricsURLV2 + "/api/pub/meter/v2" + qs).then(function () {
// Decrement the numProfiles to identify that scan has finished
--numProfiles_1;
// Once all metrics for all profiles have been uploaded we end this function call
if (numProfiles_1 === 0) {
loggerInScope.debug("END 'sendLogsV2' function");
done && done();
}
});
};
this_1 = this;
// Loop over all the V2 Scan Times until it reaches 0
while (this.scanTimesV2[profile].length > 0) {
_loop_1();
}
}
// Once all metrics for all profiles have been uploaded we end this function call
if (numProfiles_1 === 0) {
this.log.debug("END 'sendLogsV2' function");
done && done();
}
}
catch (e) {
/* istanbul ignore next */
this.log.debug("Error uploading metrics logs: " + e);
/* istanbul ignore next */
this.log.debug("END 'sendLogsV2' function");
/* istanbul ignore next */
done && done();
}
return [2 /*return*/];
});
});
};
;
return ACMetricsLogger;
}());
exports.ACMetricsLogger = ACMetricsLogger;
;
//# sourceMappingURL=ACMetricsLogger.js.map