accessibility-checker 3.1.49 → 3.1.51

package/lib/{log/ACMetricsLogger.d.ts → common/report/ACReporterMetrics.d.ts}

@@ -13,12 +13,14 @@
     See the License for the specific language governing permissions and
     limitations under the License.
  *****************************************************************************/
+import { IConfigInternal } from "../config/IConfig";
+import { CompressedReport, IRuleset } from "../engine/IReport";
+import { GenSummReturn, IReporter, IReporterStored } from "./ReporterManager";
 /*******************************************************************************
  * NAME: ACMetricsLogger.js
  * DESCRIPTION: Common Metrics logger object which can be shared between tools
  *              to upload metrics of the tool to the metrics server.
  *******************************************************************************/
-import { ILogger } from "../api/IChecker";
 /**
  * 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.
@@ -31,16 +33,16 @@ import { ILogger } from "../api/IChecker";
  *
  * @memberOf this
  */
-export declare class ACMetricsLogger {
+export declare class ACReporterMetrics implements IReporter {
+    name(): string;
     policies: string;
     metricsURLV2: string;
-    log: ILogger;
     toolName: string;
     scanTimesV1: any[];
     scanTimesV2: {
         [profile: string]: number[];
     };
-    constructor(toolName: string, logger: ILogger, policies: string[]);
+    constructor(toolName: string, policies: string[]);
     /**
      * 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.
@@ -57,7 +59,10 @@ export declare class ACMetricsLogger {
      *
      * @memberOf this
      */
-    profileV2(scanTime: number, profile: string): void;
+    generateReport(config: IConfigInternal, rulesets: IRuleset[], storedReport: IReporterStored): {
+        reportPath: string;
+        report: string;
+    } | void;
     /**
      * This function is responsible for uploading scan results to the metrics server:
      * https://aat.w3ibm.mybluemix.net
@@ -68,5 +73,5 @@ export declare class ACMetricsLogger {
      *
      * @memberOf this
      */
-    sendLogsV2(done: any, rulePack: any): Promise<void>;
+    generateSummary(config: IConfigInternal, rulesets: IRuleset[], endReport: number, summaryData: CompressedReport[]): Promise<GenSummReturn>;
 }

package/lib/{log/ACMetricsLogger.js → common/report/ACReporterMetrics.js}

@@ -51,8 +51,13 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ACMetricsLogger = void 0;
-var axios_1 = require("axios");
+exports.ACReporterMetrics = void 0;
+var Fetch_1 = require("../api-ext/Fetch");
+/*******************************************************************************
+ * NAME: ACMetricsLogger.js
+ * DESCRIPTION: Common Metrics logger object which can be shared between tools
+ *              to upload metrics of the tool to the metrics server.
+ *******************************************************************************/
 /**
  * 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.
@@ -65,17 +70,18 @@ var axios_1 = require("axios");
  *
  * @memberOf this
  */
-var ACMetricsLogger = /** @class */ (function () {
-    function ACMetricsLogger(toolName, logger, policies) {
+var ACReporterMetrics = /** @class */ (function () {
+    function ACReporterMetrics(toolName, 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;
     }
+    ACReporterMetrics.prototype.name = function () {
+        return "metrics";
+    };
     /**
      * 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.
@@ -92,14 +98,14 @@ var ACMetricsLogger = /** @class */ (function () {
      *
      * @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");
+    ACReporterMetrics.prototype.generateReport = function (config, rulesets, storedReport) {
+        if (!config.label || !config.label.includes("IBMa-Node-TeSt")) {
+            // URI encode the profile text provided
+            var profile = encodeURIComponent(storedReport.scanProfile);
+            // 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(storedReport.engineReport.summary.scanTime);
+        }
     };
     ;
     /**
@@ -112,72 +118,81 @@ var ACMetricsLogger = /** @class */ (function () {
      *
      * @memberOf this
      */
-    ACMetricsLogger.prototype.sendLogsV2 = function (done, rulePack) {
+    ACReporterMetrics.prototype.generateSummary = function (config, rulesets, endReport, summaryData) {
         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) {
+            var numProfiles_1, accountId, _a, _b, _c, _i, profile, _loop_1, this_1, e_1;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        _d.trys.push([0, 6, , 7]);
+                        numProfiles_1 = 0;
+                        accountId = "";
+                        _a = this.scanTimesV2;
+                        _b = [];
+                        for (_c in _a)
+                            _b.push(_c);
+                        _i = 0;
+                        _d.label = 1;
+                    case 1:
+                        if (!(_i < _b.length)) return [3 /*break*/, 5];
+                        _c = _b[_i];
+                        if (!(_c in _a)) return [3 /*break*/, 4];
+                        profile = _c;
                         _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 () {
-                            }).catch(function (_err) {
-                            }).finally(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();
+                            var subScanTimes, qs;
+                            return __generator(this, function (_e) {
+                                switch (_e.label) {
+                                    case 0:
+                                        subScanTimes = this_1.scanTimesV2[profile].splice(0, 150);
+                                        // Increment the num Profile
+                                        ++numProfiles_1;
+                                        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);
+                                        // 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 */
+                                        return [4 /*yield*/, (0, Fetch_1.fetch_get)(this_1.metricsURLV2 + "/api/pub/meter/v2" + qs).then(function () {
+                                            }).catch(function (_err) {
+                                            }).finally(function () {
+                                                // Decrement the numProfiles to identify that scan has finished
+                                                --numProfiles_1;
+                                            })];
+                                    case 1:
+                                        // 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 */
+                                        _e.sent();
+                                        return [2 /*return*/];
                                 }
                             });
                         };
                         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();
+                        _d.label = 2;
+                    case 2:
+                        if (!(this.scanTimesV2[profile].length > 0)) return [3 /*break*/, 4];
+                        return [5 /*yield**/, _loop_1()];
+                    case 3:
+                        _d.sent();
+                        return [3 /*break*/, 2];
+                    case 4:
+                        _i++;
+                        return [3 /*break*/, 1];
+                    case 5: return [3 /*break*/, 7];
+                    case 6:
+                        e_1 = _d.sent();
+                        return [3 /*break*/, 7];
+                    case 7: return [2 /*return*/];
                 }
-                return [2 /*return*/];
             });
         });
     };
     ;
-    return ACMetricsLogger;
+    return ACReporterMetrics;
 }());
-exports.ACMetricsLogger = ACMetricsLogger;
+exports.ACReporterMetrics = ACReporterMetrics;
 ;
-//# sourceMappingURL=ACMetricsLogger.js.map
+//# sourceMappingURL=ACReporterMetrics.js.map

package/lib/common/report/ACReporterMetrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ACReporterMetrics.js","sourceRoot":"","sources":["../../../../src-ts/lib/common/report/ACReporterMetrics.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;+EAc+E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE/E,0CAA6C;AAK7C;;;;iFAIiF;AAEjF;;;;;;;;;;;GAWG;AACH;IAYI,2BAAY,QAAgB,EAAE,QAAkB;QAPhD,iBAAY,GAAW,4BAA4B,CAAC;QAEpD,gBAAW,GAAG,EAAE,CAAC;QACjB,gBAAW,GAEP,EAAE,CAAC;QAGH,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEnC,sCAAsC;QACtC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAhBM,gCAAI,GAAX;QACI,OAAO,SAAS,CAAC;IACrB,CAAC;IAgBD;;;;;;;;;;;;;;;OAeG;IACI,0CAAc,GAArB,UAAsB,MAAuB,EAAE,QAAoB,EAAE,YAA6B;QAC9F,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE;YAC3D,uCAAuC;YACvC,IAAI,OAAO,GAAG,kBAAkB,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YAE3D,2FAA2F;YAC3F,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAC5D,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SAC9E;IACL,CAAC;IAAA,CAAC;IAEF;;;;;;;;;OASG;IACU,2CAAe,GAA5B,UAA6B,MAAuB,EAAE,QAAoB,EAAE,SAAiB,EAAE,WAA+B;;;;;;;wBAGlH,gBAAc,CAAC,CAAC;wBAChB,SAAS,GAAG,EAAE,CAAC;6BAGC,IAAI,CAAC,WAAW;;;;;;;;;;;;;;;;wCAKxB,YAAY,GAAG,OAAK,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;wCAE5D,4BAA4B;wCAC5B,EAAE,aAAW,CAAC;wCAGV,EAAE,GAAG,KAAK,GAAG,OAAK,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,OAAK,QAAQ,GAAG,MAAM,CAAC;wCAE1G,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC;4CAC5B,EAAE,IAAI,CAAC,CAAC;4CACR,EAAE,IAAI,GAAG,CAAC;wCACd,CAAC,CAAC,CAAC;wCACH,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;wCAEjC,0CAA0C;wCAC1C,yGAAyG;wCACzG,0BAA0B;wCAC1B,qBAAM,IAAA,iBAAS,EAAC,OAAK,YAAY,GAAG,mBAAmB,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC;4CACnE,CAAC,CAAC,CAAC,KAAK,CAAC,UAAC,IAAI;4CACd,CAAC,CAAC,CAAC,OAAO,CAAC;gDACP,+DAA+D;gDAC/D,EAAE,aAAW,CAAC;4CAClB,CAAC,CAAC,EAAA;;wCARF,0CAA0C;wCAC1C,yGAAyG;wCACzG,0BAA0B;wCAC1B,SAKE,CAAA;;;;;;;;6BAxBC,CAAA,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;;;;;;;;;;;;;;;;KA6BtD;IAAA,CAAC;IACN,wBAAC;AAAD,CAAC,AAhGD,IAgGC;AAhGY,8CAAiB;AAgG7B,CAAC"}

package/lib/common/report/ACReporterXLSX.d.ts

@@ -0,0 +1,37 @@
+/******************************************************************************
+     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.
+  *****************************************************************************/
+import { IConfigInternal } from "../config/IConfig";
+import { CompressedReport, IRuleset } from "../engine/IReport";
+import { GenSummReturn, IReporter } from "./ReporterManager";
+export declare class ACReporterXLSX implements IReporter {
+    name(): string;
+    generateReport(_reportData: any): {
+        reportPath: string;
+        report: string;
+    } | void;
+    generateSummary(config: IConfigInternal, rulesets: IRuleset[], endReport: number, summaryData: CompressedReport[]): Promise<GenSummReturn>;
+    private static createOverviewSheet;
+    private static createScanSummarySheet;
+    private static buildIssueSummaryLevel;
+    private static buildIssueSummaryTKLevel;
+    private static createIssueSummarySheet;
+    private static createIssuesSheet;
+    private static createDefinitionsSheet;
+    private static countDuplicatesInArray;
+    private static get_element;
+    private static format_date;
+    private static stringHash;
+}