testilo 20.0.2 → 21.0.0

package/procs/score/tsp36.js

@@ -1,278 +0,0 @@
-/*
-  tsp36
-  Testilo score proc 36
-
-  Computes target score data and adds them to a ts36 report.
-*/
-
-// IMPORTS
-
-const {issues} = require('./tic36');
-
-// CONSTANTS
-
-// ID of this proc.
-const scoreProcID = 'tsp36';
-// Configuration disclosures.
-const severityWeights = [1, 2, 3, 4];
-const toolWeight = 0.1;
-const logWeights = {
-  logCount: 0.1,
-  logSize: 0.002,
-  errorLogCount: 0.2,
-  errorLogSize: 0.004,
-  prohibitedCount: 3,
-  visitRejectionCount: 2
-};
-// How much each second of excess latency adds to the score.
-const latencyWeight = 1;
-// Normal latency (1.5 second per visit).
-const normalLatency = 9;
-// How much each prevention adds to the score.
-const preventionWeight = 300;
-// Initialize a table of tool rules.
-const issueIndex = {};
-// Initialize an array of variably named tool rules.
-const issueMatcher = [];
-// For each issue:
-Object.keys(issues).forEach(issueName => {
-  // For each tool with rules belonging to that issue:
-  Object.keys(issues[issueName].tools).forEach(toolName => {
-    // For each of those rules:
-    Object.keys(issues[issueName].tools[toolName]).forEach(ruleID => {
-      // Add it to the table of tool rules.
-      if (! issueIndex[toolName]) {
-        issueIndex[toolName] = {};
-      }
-      issueIndex[toolName][ruleID] = issueName;
-      // If it is variably named:
-      if (issues[issueName].tools[toolName][ruleID].variable) {
-        // Add it to the array of variably named tool rules.
-        issueMatcher.push(ruleID);
-      }
-    })
-  });
-});
-
-// FUNCTIONS
-
-// Scores a report.
-exports.scorer = report => {
-  // If there are any acts in the report:
-  const {acts} = report;
-  if (Array.isArray(acts) && acts.length) {
-    // If any of them are test acts:
-    const testActs = acts.filter(act => act.type === 'test');
-    if (testActs.length) {
-      // Initialize the score data.
-      const score = {
-        scoreProcID,
-        summary: {
-          total: 0,
-          issue: 0,
-          solo: 0,
-          tool: 0,
-          prevention: 0,
-          log: 0,
-          latency: 0
-        },
-        details: {
-          severity: {
-            total: [0, 0, 0, 0],
-            byTool: {}
-          },
-          prevention: {},
-          issue: {},
-          solo: {}
-        }
-      };
-      const {summary, details} = score;
-      // For each test act:
-      testActs.forEach(act => {
-        // If the page prevented the tool from operating:
-        const {which, standardResult} = act;
-        if (! standardResult || standardResult.prevented) {
-          // Add this to the score.
-          details.prevention[which] = preventionWeight;
-        }
-        // Otherwise, if a successful standard result exists:
-        else if (
-          standardResult
-          && standardResult.totals
-          && standardResult.totals.length === 4
-          && standardResult.instances
-        ) {
-          // Add the severity totals of the tool to the score.
-          const {totals} = standardResult;
-          details.severity.byTool[which] = totals;
-          // For each instance of the tool:
-          standardResult.instances.forEach(instance => {
-            // Get the rule ID.
-            const {ruleID, ordinalSeverity, count} = instance;
-            // If it is not in the table of tool rules:
-            let canonicalRuleID = ruleID;
-            if (! issueIndex[which][ruleID]) {
-              // Convert it to the variably named tool rule that it matches, if any.
-              canonicalRuleID = issueMatcher.find(pattern => {
-                const patternRE = new RegExp(pattern);
-                return patternRE.test(instance.ruleID);
-              });
-            }
-            // If the rule ID belongs to an issue:
-            if (canonicalRuleID) {
-              // Get the issue.
-              const issueName = issueIndex[which][canonicalRuleID];
-              // Add the instance to the issue details of the score data.
-              if (! details.issue[issueName]) {
-                details.issue[issueName] = {
-                  score: 0,
-                  maxCount: 0,
-                  weight: issues[issueName].weight,
-                  tools: {}
-                };
-              }
-              if (! details.issue[issueName].tools[which]) {
-                details.issue[issueName].tools[which] = {};
-              }
-              if (! details.issue[issueName].tools[which][canonicalRuleID]) {
-                const ruleData = issues[issueName].tools[which][canonicalRuleID];
-                details.issue[issueName].tools[which][canonicalRuleID] = {
-                  quality: ruleData.quality,
-                  what: ruleData.what,
-                  complaints: {
-                    countTotal: 0,
-                    texts: []
-                  }
-                };
-              }
-              details
-              .issue[issueName]
-              .tools[which][canonicalRuleID]
-              .complaints
-              .countTotal += instance.count || 1;
-              if (
-                ! details
-                .issue[issueName]
-                .tools[which][canonicalRuleID]
-                .complaints
-                .texts
-                .includes(instance.what)
-              ) {
-                details
-                .issue[issueName]
-                .tools[which][canonicalRuleID]
-                .complaints
-                .texts
-                .push(instance.what);
-              }
-            }
-            // Otherwise, i.e. if the rule ID belongs to no issue:
-            else {
-              // Add the instance to the solo details of the score data.
-              if (! details.solo[which]) {
-                details.solo[which] = {};
-              }
-              if (! details.solo[which][ruleID]) {
-                details.solo[which][ruleID] = 0;
-              }
-              details.solo[which][ruleID] += (count || 1) * (ordinalSeverity + 1);
-              // Report this.
-              console.log(`ERROR: ${instance.ruleID} of ${which} not found in issues`);
-            }
-          });
-        }
-        // Otherwise, i.e. if a failed standard result exists:
-        else {
-          // Add an inferred prevention to the score.
-          details.prevention[which] = preventionWeight;
-        }
-      });
-      // For each issue with any complaints:
-      Object.keys(details.issue).forEach(issueName => {
-        const issueData = details.issue[issueName];
-        // For each tool with any complaints for the issue:
-        Object.keys(issueData.tools).forEach(toolID => {
-          // Get the sum of the weighted counts of its issue rules.
-          let weightedCount = 0;
-          Object.values(issueData.tools[toolID]).forEach(ruleData => {
-            weightedCount += ruleData.quality * ruleData.complaints.countTotal;
-          });
-          // If the sum exceeds the existing maximum weighted count for the issue:
-          if (weightedCount > issueData.maxCount) {
-            // Change the maximum count for the issue to the sum.
-            issueData.maxCount = weightedCount;
-          }
-        });
-        // Get the score for the issue.
-        issueData.score = Math.round(issueData.weight * issueData.maxCount);
-      });
-      // Add the severity detail totals to the score.
-      details.severity.total = Object.keys(details.severity.byTool).reduce((severityTotals, toolID) => {
-        details.severity.byTool[toolID].forEach((severityScore, index) => {
-          severityTotals[index] += severityScore;
-        });
-        return severityTotals;
-      }, details.severity.total);
-      // Add the summary issue total to the score.
-      summary.issue = Object
-      .values(details.issue)
-      .reduce((total, current) => total + current.score, 0);
-      // Add the summary solo total to the score.
-      Object.keys(details.solo).forEach(tool => {
-        summary.solo += Object
-        .values(details.solo[tool])
-        .reduce((total, current) => total + current);
-      });
-      // Add the summary tool total to the score.
-      summary.tool = toolWeight * details.severity.total.reduce(
-        (total, current, index) => total + severityWeights[index] * current, 0
-      );
-      // Add the summary prevention total to the score.
-      summary.prevention = Object.values(details.prevention).reduce(
-        (total, current) => total + current, 0
-      );
-      // Add the summary log score to the score.
-      const {jobData} = report;
-      if (jobData) {
-        summary.log = Math.max(0, Math.round(
-          logWeights.logCount * jobData.logCount
-          + logWeights.logSize * jobData.logSize +
-          + logWeights.errorLogCount * jobData.errorLogCount
-          + logWeights.errorLogSize * jobData.errorLogSize
-          + logWeights.prohibitedCount * jobData.prohibitedCount +
-          + logWeights.visitRejectionCount * jobData.visitRejectionCount
-        ));
-        // Add the summary latency score to the score.
-        summary.latency = Math.round(
-          latencyWeight * (Math.max(0, jobData.visitLatency - normalLatency))
-        );
-      }
-      // Round the unrounded scores.
-      Object.keys(summary).forEach(summaryTypeName => {
-        summary[summaryTypeName] = Math.round(summary[summaryTypeName]);
-      });
-      details.severity.total.forEach((severityTotal, index) => {
-        details.severity.total[index] = Math.round(severityTotal);
-      });
-      // Add the summary total score to the score.
-      summary.total = summary.issue
-      + summary.solo
-      + summary.tool
-      + summary.prevention
-      + summary.log
-      + summary.latency;
-      // Add the score to the report.
-      report.score = score;
-    }
-    // Otherwise, i.e. if none of them is a test act:
-    else {
-      // Report this.
-      console.log('ERROR: No test acts');
-    }
-  }
-  // Otherwise, i.e. if there are no acts in the report:
-  else {
-    // Report this.
-    console.log('ERROR: No acts');
-  }
-};

package/procs/score/tsp37.js

@@ -1,292 +0,0 @@
-/*
-  tsp37
-  Testilo score proc 37
-
-  Computes target score data and adds them to a ts37 report.
-*/
-
-// IMPORTS
-
-const {issues} = require('./tic37');
-
-// CONSTANTS
-
-// ID of this proc.
-const scoreProcID = 'tsp37';
-// Configuration disclosures.
-const severityWeights = [1, 2, 3, 4];
-const toolWeight = 0.1;
-const logWeights = {
-  logCount: 0.1,
-  logSize: 0.002,
-  errorLogCount: 0.2,
-  errorLogSize: 0.004,
-  prohibitedCount: 3,
-  visitRejectionCount: 2
-};
-// How much each second of excess latency adds to the score.
-const latencyWeight = 1;
-// Normal latency (1.5 second per visit).
-const normalLatency = 9;
-// How much each prevention adds to the score.
-const preventionWeight = 300;
-// Initialize a table of tool rules.
-const issueIndex = {};
-// Initialize an array of variably named tool rules.
-const issueMatcher = [];
-// For each issue:
-Object.keys(issues).forEach(issueName => {
-  // For each tool with rules belonging to that issue:
-  Object.keys(issues[issueName].tools).forEach(toolName => {
-    // For each of those rules:
-    Object.keys(issues[issueName].tools[toolName]).forEach(ruleID => {
-      // Add it to the table of tool rules.
-      if (! issueIndex[toolName]) {
-        issueIndex[toolName] = {};
-      }
-      issueIndex[toolName][ruleID] = issueName;
-      // If it is variably named:
-      if (issues[issueName].tools[toolName][ruleID].variable) {
-        // Add it to the array of variably named tool rules.
-        issueMatcher.push(ruleID);
-      }
-    })
-  });
-});
-
-// FUNCTIONS
-
-// Scores a report.
-exports.scorer = report => {
-  // If there are any acts in the report:
-  const {acts} = report;
-  if (Array.isArray(acts) && acts.length) {
-    // If any of them are test acts:
-    const testActs = acts.filter(act => act.type === 'test');
-    if (testActs.length) {
-      // Initialize the score data.
-      const score = {
-        scoreProcID,
-        weights: {
-          severities: severityWeights,
-          tool: toolWeight,
-          log: logWeights,
-          latency: latencyWeight,
-          prevention: preventionWeight
-        },
-        normalLatency,
-        summary: {
-          total: 0,
-          issue: 0,
-          solo: 0,
-          tool: 0,
-          prevention: 0,
-          log: 0,
-          latency: 0
-        },
-        details: {
-          severity: {
-            total: [0, 0, 0, 0],
-            byTool: {}
-          },
-          prevention: {},
-          issue: {},
-          solo: {},
-          tool: {}
-        }
-      };
-      const {summary, details} = score;
-      // For each test act:
-      testActs.forEach(act => {
-        // If the page prevented the tool from operating:
-        const {which, standardResult} = act;
-        if (! standardResult || standardResult.prevented) {
-          // Add this to the score.
-          details.prevention[which] = preventionWeight;
-        }
-        // Otherwise, if a valid standard result exists:
-        else if (
-          standardResult
-          && standardResult.totals
-          && standardResult.totals.length === 4
-          && standardResult.instances
-        ) {
-          // Add the severity totals of the tool to the score.
-          const {totals} = standardResult;
-          details.severity.byTool[which] = totals;
-          // Add the severity-weighted tool totals to the score.
-          details.tool[which] = totals.reduce(
-            (sum, current, index) => sum + severityWeights[index] * current, 0
-          );
-          // For each instance of the tool:
-          standardResult.instances.forEach(instance => {
-            // Get the rule ID.
-            const {ruleID, ordinalSeverity, count} = instance;
-            // If it is not in the table of tool rules:
-            let canonicalRuleID = ruleID;
-            if (! issueIndex[which][ruleID]) {
-              // Convert it to the variably named tool rule that it matches, if any.
-              canonicalRuleID = issueMatcher.find(pattern => {
-                const patternRE = new RegExp(pattern);
-                return patternRE.test(instance.ruleID);
-              });
-            }
-            // If the rule ID belongs to an issue:
-            if (canonicalRuleID) {
-              // Get the issue.
-              const issueName = issueIndex[which][canonicalRuleID];
-              // Add the instance to the issue details of the score data.
-              if (! details.issue[issueName]) {
-                details.issue[issueName] = {
-                  summary: issues[issueName].summary,
-                  score: 0,
-                  maxCount: 0,
-                  weight: issues[issueName].weight,
-                  tools: {}
-                };
-              }
-              if (! details.issue[issueName].tools[which]) {
-                details.issue[issueName].tools[which] = {};
-              }
-              if (! details.issue[issueName].tools[which][canonicalRuleID]) {
-                const ruleData = issues[issueName].tools[which][canonicalRuleID];
-                details.issue[issueName].tools[which][canonicalRuleID] = {
-                  quality: ruleData.quality,
-                  what: ruleData.what,
-                  complaints: {
-                    countTotal: 0,
-                    texts: []
-                  }
-                };
-              }
-              details
-              .issue[issueName]
-              .tools[which][canonicalRuleID]
-              .complaints
-              .countTotal += instance.count || 1;
-              if (
-                ! details
-                .issue[issueName]
-                .tools[which][canonicalRuleID]
-                .complaints
-                .texts
-                .includes(instance.what)
-              ) {
-                details
-                .issue[issueName]
-                .tools[which][canonicalRuleID]
-                .complaints
-                .texts
-                .push(instance.what);
-              }
-            }
-            // Otherwise, i.e. if the rule ID belongs to no issue:
-            else {
-              // Add the instance to the solo details of the score data.
-              if (! details.solo[which]) {
-                details.solo[which] = {};
-              }
-              if (! details.solo[which][ruleID]) {
-                details.solo[which][ruleID] = 0;
-              }
-              details.solo[which][ruleID] += (count || 1) * (ordinalSeverity + 1);
-              // Report this.
-              console.log(`ERROR: ${instance.ruleID} of ${which} not found in issues`);
-            }
-          });
-        }
-        // Otherwise, i.e. if a failed standard result exists:
-        else {
-          // Add an inferred prevention to the score.
-          details.prevention[which] = preventionWeight;
-        }
-      });
-      // For each issue with any complaints:
-      Object.keys(details.issue).forEach(issueName => {
-        const issueData = details.issue[issueName];
-        // For each tool with any complaints for the issue:
-        Object.keys(issueData.tools).forEach(toolID => {
-          // Get the sum of the weighted counts of its issue rules.
-          let weightedCount = 0;
-          Object.values(issueData.tools[toolID]).forEach(ruleData => {
-            weightedCount += ruleData.quality * ruleData.complaints.countTotal;
-          });
-          // If the sum exceeds the existing maximum weighted count for the issue:
-          if (weightedCount > issueData.maxCount) {
-            // Change the maximum count for the issue to the sum.
-            issueData.maxCount = weightedCount;
-          }
-        });
-        // Get the score for the issue.
-        issueData.score = Math.round(issueData.weight * issueData.maxCount);
-      });
-      // Add the severity detail totals to the score.
-      details.severity.total = Object.keys(details.severity.byTool).reduce((severityTotals, toolID) => {
-        details.severity.byTool[toolID].forEach((severityScore, index) => {
-          severityTotals[index] += severityScore;
-        });
-        return severityTotals;
-      }, details.severity.total);
-      // Add the summary issue total to the score.
-      summary.issue = Object
-      .values(details.issue)
-      .reduce((total, current) => total + current.score, 0);
-      // Add the summary solo total to the score.
-      Object.keys(details.solo).forEach(tool => {
-        summary.solo += Object
-        .values(details.solo[tool])
-        .reduce((total, current) => total + current);
-      });
-      // Add the summary tool total to the score.
-      summary.tool = toolWeight * details.severity.total.reduce(
-        (total, current, index) => total + severityWeights[index] * current, 0
-      );
-      // Add the summary prevention total to the score.
-      summary.prevention = Object.values(details.prevention).reduce(
-        (total, current) => total + current, 0
-      );
-      // Add the summary log score to the score.
-      const {jobData} = report;
-      if (jobData) {
-        summary.log = Math.max(0, Math.round(
-          logWeights.logCount * jobData.logCount
-          + logWeights.logSize * jobData.logSize +
-          + logWeights.errorLogCount * jobData.errorLogCount
-          + logWeights.errorLogSize * jobData.errorLogSize
-          + logWeights.prohibitedCount * jobData.prohibitedCount +
-          + logWeights.visitRejectionCount * jobData.visitRejectionCount
-        ));
-        // Add the summary latency score to the score.
-        summary.latency = Math.round(
-          latencyWeight * (Math.max(0, jobData.visitLatency - normalLatency))
-        );
-      }
-      // Round the unrounded scores.
-      Object.keys(summary).forEach(summaryTypeName => {
-        summary[summaryTypeName] = Math.round(summary[summaryTypeName]);
-      });
-      details.severity.total.forEach((severityTotal, index) => {
-        details.severity.total[index] = Math.round(severityTotal);
-      });
-      // Add the summary total score to the score.
-      summary.total = summary.issue
-      + summary.solo
-      + summary.tool
-      + summary.prevention
-      + summary.log
-      + summary.latency;
-      // Add the score to the report.
-      report.score = score;
-    }
-    // Otherwise, i.e. if none of them is a test act:
-    else {
-      // Report this.
-      console.log('ERROR: No test acts');
-    }
-  }
-  // Otherwise, i.e. if there are no acts in the report:
-  else {
-    // Report this.
-    console.log('ERROR: No acts');
-  }
-};