testaro 30.0.8 → 32.0.1

package/watch.js

@@ -1,3 +1,25 @@
+/*
+  © 2022–2023 CVS Health and/or one of its affiliates. All rights reserved.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+*/
+
 /*
   watch.js
   Module for watching for a job and running it when found.
@@ -142,7 +164,9 @@ const checkNetJob = async (servers, serverIndex, isForever, interval, noJobCount
   const client = server.startsWith('https://') ? httpsClient : httpClient;
   const fullURL = `${server}?agent=${agent}`;
   const logStart = `Requested job from server ${server} and got `;
-  client.request(fullURL, response => {
+  // Tolerate unrecognized certificate authorities if the environment specifies.
+  const ruOpt = process.env.REJECT_UNAUTHORIZED === 'false' ? {rejectUnauthorized: false} : {};
+  client.request(fullURL, ruOpt, response => {
     const chunks = [];
     response
     // If the response to the job request threw an error:
@@ -187,7 +211,7 @@ const checkNetJob = async (servers, serverIndex, isForever, interval, noJobCount
               // Perform the job, adding result data to it.
               const testee = sources.target.which;
               console.log(
-                `${logStart}job ${id} (${nowString()})\n>> It will test ${testee}\n>> It will send report to ${sendReportTo}`
+                `${logStart}job ${id} (${nowString()})\n>> It will test ${testee}\n>> It will send report to ${sendReportTo}\n`
               );
               await doJob(contentObj);
               let reportJSON = JSON.stringify(contentObj, null, 2);
@@ -202,7 +226,7 @@ const checkNetJob = async (servers, serverIndex, isForever, interval, noJobCount
                 // If the response to the report threw an error:
                 .on('error', async error => {
                   // Report this.
-                  console.log(`${reportLogStart}error message ${error.message}`);
+                  console.log(`${reportLogStart}error message ${error.message}\n`);
                   // Check the next server.
                   await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
                 })
@@ -218,7 +242,7 @@ const checkNetJob = async (servers, serverIndex, isForever, interval, noJobCount
                     const {message} = ackObj;
                     if (message) {
                       // Report it.
-                      console.log(`${reportLogStart}${message}`);
+                      console.log(`${reportLogStart}${message}\n`);
                       // Free the memory used by the report.
                       reportJSON = '';
                       contentObj = {};
@@ -229,7 +253,7 @@ const checkNetJob = async (servers, serverIndex, isForever, interval, noJobCount
                     else {
                       // Report it.
                       console.log(
-                        `ERROR: ${reportLogStart}status ${repResponse.statusCode} and error message ${JSON.stringify(ackObj, null, 2)}`
+                        `ERROR: ${reportLogStart}status ${repResponse.statusCode} and error message ${JSON.stringify(ackObj, null, 2)}\n`
                       );
                       // Check the next server, disregarding the failed job.
                       await checkNetJob(
@@ -241,7 +265,7 @@ const checkNetJob = async (servers, serverIndex, isForever, interval, noJobCount
                   catch(error) {
                     // Report it.
                     console.log(
-                      `ERROR: ${reportLogStart}status ${repResponse.statusCode}, error message ${error.message}, and response ${content.slice(0, 1000)}`
+                      `ERROR: ${reportLogStart}status ${repResponse.statusCode}, error message ${error.message}, and response ${content.slice(0, 1000)}\n`
                     );
                     // Check the next server, disregarding the failed job.
                     await checkNetJob(
@@ -253,7 +277,7 @@ const checkNetJob = async (servers, serverIndex, isForever, interval, noJobCount
               // If the report submission throws an error:
               .on('error', async error => {
                 // Report this.
-                console.log(`ERROR: ${reportLogStart}error message ${error.message}`);
+                console.log(`ERROR: ${reportLogStart}error message ${error.message}\n`);
                 // Check the next server, disregarding the failed job.
                 await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
               })
@@ -336,6 +360,7 @@ exports.dirWatch = async (isForever, interval = 300) => {
 };
 // Checks for a network job, performs it, and submits a report, once or repeatedly.
 exports.netWatch = async (isForever, interval = 300) => {
+  console.log('Starting netWatch');
   // If the servers to be checked are valid:
   const servers = jobURLs
   .split('+')

package/call-old.js

@@ -1,86 +0,0 @@
-/*
-  call.js
-  Invokes Testaro modules with arguments.
-  This is the universal module for use of Testaro from a command line.
-  Arguments:
-    0. function to execute.
-    1+. arguments to pass to the function.
-  Usage examples:
-    node call run ts25
-    node call watch true true 30
-*/
-
-// ########## IMPORTS
-
-// Module to keep secrets.
-require('dotenv').config();
-// Module to process files.
-const fs = require('fs/promises');
-// Function to process a testing request.
-const {doJob} = require('./run');
-// Function to watch for jobs.
-const {watch} = require('./watch');
-
-// ########## CONSTANTS
-
-const fn = process.argv[2];
-const fnArgs = process.argv.slice(3);
-const jobDir = process.env.JOBDIR;
-const todoDir = `${jobDir}/todo`;
-const reportDir = process.env.REPORTDIR;
-const rawDir = `${reportDir}/raw`;
-
-// ########## FUNCTIONS
-
-// Fulfills a testing request.
-const callRun = async jobIDStart => {
-  // Find the job.
-  const jobDirFileNames = await fs.readdir(todoDir);
-  const jobFileName = jobDirFileNames.find(fileName => fileName.startsWith(jobIDStart));
-  // If it exists:
-  if (jobFileName) {
-    // Get it.
-    const jobJSON = await fs.readFile(`${todoDir}/${jobFileName}`, 'utf8');
-    const report = JSON.parse(jobJSON);
-    // Run it.
-    await doJob(report);
-    // Archive it.
-    await fs.rename(`${todoDir}/${jobFileName}`, `${jobDir}/done/${jobFileName}`);
-    // Save the report.
-    await fs.writeFile(`${rawDir}/${jobFileName}`, JSON.stringify(report, null, 2));
-    console.log(`Job completed and report ${report.id}.json saved in ${rawDir}`);
-  }
-  // Otherwise, i.e. if the job does not exist.
-  else {
-    // Report the error.
-    console.log(`ERROR: No to-do job ID starts with ${jobIDStart}`);
-  }
-};
-// Starts a watch.
-const callWatch = async (isDirWatch, interval) => {
-  const whenType = interval > -1 ? 'repeating' : 'one-time';
-  const whereType = isDirWatch === 'true' ? 'directory' : 'network';
-  console.log(`Starting ${whenType} ${whereType} watch`);
-  await watch(isDirWatch === 'true', Number.parseInt(interval, 10));
-};
-
-// ########## OPERATION
-
-// Execute the requested function.
-if (fn === 'run' && fnArgs.length === 1) {
-  callRun(fnArgs)
-  .then(() => {
-    console.log('Execution completed\n');
-    process.exit(0);
-  });
-}
-else if (fn === 'watch' && fnArgs.length === 2) {
-  callWatch(... fnArgs)
-  .then(() => {
-    console.log('Execution completed\n');
-    process.exit(0);
-  });
-}
-else {
-  console.log('ERROR: Invalid statement');
-}

package/procs/allText.js

@@ -1,76 +0,0 @@
-// Returns the text associated with an element.
-exports.allText = async (page, elementHandle) => await page.evaluate(element => {
-  // Identify the element, if specified, or else the focused element.
-  const el = element || document.activeElement;
-  // Initialize an array of its texts.
-  const texts = [];
-  // FUNCTION DEFINITION START
-  // Removes excess spacing from a string.
-  const debloat = text => text.trim().replace(/\s+/g, ' ');
-  // FUNCTION DEFINITION END
-  // Add any attribute label to the array.
-  const ariaLabel = el.getAttribute('aria-label');
-  if (ariaLabel) {
-    const trimmedLabel = debloat(ariaLabel);
-    if (trimmedLabel) {
-      texts.push(trimmedLabel);
-    }
-  }
-  // Add any explicit and implicit labels to the array.
-  const labelNodeList = el.labels;
-  if (labelNodeList && labelNodeList.length) {
-    const labels = Array.from(labelNodeList);
-    const labelTexts = labels
-    .map(label => label.textContent && debloat(label.textContent))
-    .filter(text => text);
-    if (labelTexts.length) {
-      texts.push(...labelTexts);
-    }
-  }
-  // Add any referenced labels to the array.
-  if (el.hasAttribute('aria-labelledby')) {
-    const labelerIDs = el.getAttribute('aria-labelledby').split(/\s+/);
-    labelerIDs.forEach(id => {
-      const labeler = document.getElementById(id);
-      if (labeler) {
-        const labelerText = debloat(labeler.textContent);
-        if (labelerText) {
-          texts.push(labelerText);
-        }
-      }
-    });
-  }
-  // Add any image text alternatives to the array.
-  const altTexts = Array
-  .from(element.querySelectorAll('img[alt]:not([alt=""])'))
-  .map(img => debloat(img.alt))
-  .join('; ');
-  if (altTexts.length) {
-    texts.push(altTexts);
-  }
-  // Add the first 100 characters of any text content of the element to the array.
-  const ownText = element.textContent;
-  if (ownText) {
-    const minText = debloat(ownText);
-    if (minText) {
-      texts.push(minText.slice(0, 100));
-    }
-  }
-  // Add any ID of the element to the array.
-  const id = element.id;
-  if (id) {
-    texts.push(`#${id}`);
-  }
-  // Identify a concatenation of the texts.
-  let textChain = texts.join('; ');
-  // If it is empty:
-  if (! textChain) {
-    // Substitute the HTML of the element.
-    textChain = `{${debloat(element.outerHTML)}}`;
-    if (textChain === '{}') {
-      textChain = '';
-    }
-  }
-  // Return a concatenation of the texts in the array.
-  return textChain;
-}, elementHandle);

package/procs/allVis.js

@@ -1,17 +0,0 @@
-// Makes all elements in a page visible.
-exports.allVis = async page => {
-  await page.$$eval('body *', elements => {
-    elements.forEach(element => {
-      const styleDec = window.getComputedStyle(element);
-      if (styleDec.display === 'none') {
-        element.style.display = 'initial';
-      }
-      if (['hidden', 'collapse'].includes(styleDec.visibility)) {
-        element.style.visibility = 'inherit';
-      }
-    });
-  })
-  .catch(error => {
-    console.log(`ERROR making all elements visible (${error.message})`);
-  });
-};

package/procs/getTextNodes.js

@@ -1,39 +0,0 @@
-/*
-  getTextNodes
-  Gets the text nodes of a page and their parent elements as a JSHandle.
-*/
-exports.getTextNodes = async page => {
-  // Identify the text nodes.
-  const data = await page.evaluateHandle(() => {
-    // Initialize the result.
-    const data = [];
-    // Collapse any adjacent text nodes.
-    document.body.normalize();
-    // Remove the irrelevant text content.
-    const extraElements = Array.from(document.body.querySelectorAll('style, script, svg'));
-    extraElements.forEach(element => {
-      element.textContent = '';
-    });
-    // FUNCTION DEFINITION START
-    // Returns a space-minimized copy of a string.
-    const compact = string => string.replace(/\s+/g, ' ').trim();
-    // FUNCTION DEFINITION END
-    // Create a collection of the text nodes.
-    const walker = document.createTreeWalker(document.body, NodeFilter.SHOW_TEXT);
-    let more = true;
-    while(more) {
-      if (walker.nextNode()) {
-        const nodeText = walker.currentNode.nodeValue;
-        const compactNodeText = compact(nodeText);
-        if (compactNodeText) {
-          data.push([nodeText, walker.currentNode.parentElement]);
-        }
-      }
-      else {
-        more = false;
-      }
-    }
-    return data;
-  });
-  return data;
-};

package/procs/linksByType.js

@@ -1,54 +0,0 @@
-// Returns an object classifying the links in a page by layout.
-exports.linksByType = async page => await page.evaluateHandle(() => {
-  // FUNCTION DEFINITIONS START
-  // Removes spacing characters from a text.
-  const despace = text => text.replace(/\s/g, '');
-  // Returns whether a list is a list entirely of links.
-  const isLinkList = list => {
-    const listItems = Array.from(list.children);
-    if (listItems.length > 1) {
-      return listItems.length > 1 && listItems.every(item => {
-        if (item.tagName === 'LI') {
-          const {children} = item;
-          if (children.length === 1) {
-            const link = children[0];
-            if (link.tagName === 'A') {
-              const itemText = despace(item.textContent);
-              const linkText = despace(link.textContent);
-              return itemText.length === linkText.length;
-            }
-            else {
-              return false;
-            }
-          }
-          else {
-            return false;
-          }
-        }
-        else {
-          return false;
-        }
-      });
-    }
-    else {
-      return false;
-    }
-  };
-  // FUNCTION DEFINITIONS END
-  // Identify the list links in the page.
-  const lists = Array.from(document.body.querySelectorAll('ul, ol'));
-  const listLinks = [];
-  lists.forEach(list => {
-    if (isLinkList(list)) {
-      listLinks.push(... Array.from(list.querySelectorAll('a')));
-    }
-  });
-  // Identify the inline links in the page.
-  const allLinks = Array.from(document.body.querySelectorAll('a'));
-  const inlineLinks = allLinks.filter(link => ! listLinks.includes(link));
-  // Return the data.
-  return {
-    adjacent: inlineLinks,
-    list: listLinks
-  };
-});

package/procs/nav.js

@@ -1,259 +0,0 @@
-// nav
-
-// ######## IMPORTS
-
-// Playwright package.
-const playwright = require('playwright');
-
-// ######## CONSTANTS
-
-// Strings in log messages indicating errors.
-const errorWords = [
-  'but not used',
-  'content security policy',
-  'deprecated',
-  'error',
-  'exception',
-  'expected',
-  'failed',
-  'invalid',
-  'missing',
-  'non-standard',
-  'not supported',
-  'refused',
-  'requires',
-  'sorry',
-  'suspicious',
-  'unrecognized',
-  'violates',
-  'warning'
-];
-
-// ######## VARIABLES
-
-let browser;
-
-// ######## FUNCTIONS
-
-// Returns a string with any final slash removed.
-const deSlash = string => string.endsWith('/') ? string.slice(0, -1) : string;
-// Gets the script nonce from a response.
-const getNonce = async response => {
-  let nonce = '';
-  // If the response includes a content security policy:
-  const headers = await response.allHeaders();
-  const cspWithQuotes = headers && headers['content-security-policy'];
-  if (cspWithQuotes) {
-    // If it requires scripts to have a nonce:
-    const csp = cspWithQuotes.replace(/'/g, '');
-    const directives = csp.split(/ *; */).map(directive => directive.split(/ +/));
-    const scriptDirective = directives.find(dir => dir[0] === 'script-src');
-    if (scriptDirective) {
-      const nonceSpec = scriptDirective.find(valPart => valPart.startsWith('nonce-'));
-      if (nonceSpec) {
-        // Return the nonce.
-        nonce = nonceSpec.replace(/^nonce-/, '');
-      }
-    }
-  }
-  // Return the nonce, if any.
-  return nonce;
-};
-// Visits a URL and returns the response of the server.
-const goTo = async (report, page, url, timeout, waitUntil) => {
-  // If the URL is a file path:
-  if (url.startsWith('file://')) {
-    // Make it absolute.
-    url = url.replace('file://', `file://${__dirname.replace(/procs$/, '')}`);
-  }
-  // Visit the URL.
-  const startTime = Date.now();
-  try {
-    const response = await page.goto(url, {
-      timeout,
-      waitUntil
-    });
-    report.jobData.visitLatency += Math.round((Date.now() - startTime) / 1000);
-    const httpStatus = response.status();
-    // If the response status was normal:
-    if ([200, 304].includes(httpStatus) || url.startsWith('file:')) {
-      // If the browser was redirected in violation of a strictness requirement:
-      const actualURL = page.url();
-      if (report.strict && deSlash(actualURL) !== deSlash(url)) {
-        // Return an error.
-        console.log(`ERROR: Visit to ${url} redirected to ${actualURL}`);
-        return {
-          exception: 'badRedirection'
-        };
-      }
-      // Otherwise, i.e. if no prohibited redirection occurred:
-      else {
-        // Press the Escape key to dismiss any modal dialog.
-        await page.keyboard.press('Escape');
-        // Return the result of the navigation.
-        return {
-          success: true,
-          response
-        };
-      }
-    }
-    // Otherwise, i.e. if the response status was abnormal:
-    else {
-      // Return an error.
-      console.log(`ERROR: Visit to ${url} got status ${httpStatus}`);
-      report.jobData.visitRejectionCount++;
-      return {
-        success: false,
-        error: 'badStatus'
-      };
-    }
-  }
-  catch(error) {
-    console.log(`ERROR visiting ${url} (${error.message.slice(0, 200)})`);
-    return {
-      success: false,
-      error: 'noVisit'
-    };
-  }
-};
-// Closes the current browser.
-const browserClose = async () => {
-  if (browser) {
-    let contexts = browser.contexts();
-    for (const context of contexts) {
-      await context.close();
-      contexts = browser.contexts();
-    }
-    await browser.close();
-    browser = null;
-  }
-};
-// Launches a browser, navigates to a URL, and returns browser data.
-const launch = async (report, typeName, url, debug, waits, isLowMotion = false) => {
-  // If the specified browser type exists:
-  const browserType = playwright[typeName];
-  if (browserType) {
-    // Close the current browser, if any.
-    await browserClose();
-    // Launch a browser of the specified type.
-    const browserOptions = {
-      logger: {
-        isEnabled: () => false,
-        log: (name, severity, message) => console.log(message.slice(0, 100))
-      }
-    };
-    if (debug) {
-      browserOptions.headless = false;
-    }
-    if (waits) {
-      browserOptions.slowMo = waits;
-    }
-    browser = await browserType.launch(browserOptions)
-    // If the launch failed:
-    .catch(async error => {
-      console.log(`ERROR launching browser (${error.message.slice(0, 200)})`);
-      // Return this.
-      return {
-        success: false,
-        error: 'Browser launch failed'
-      };
-    });
-    // Open a context (i.e. browser tab), with reduced motion if specified.
-    const options = {reduceMotion: isLowMotion ? 'reduce' : 'no-preference'};
-    const browserContext = await browser.newContext(options);
-    // When a page (i.e. browser tab) is added to the browser context (i.e. browser window):
-    browserContext.on('page', async page => {
-      // If it emits a message:
-      page.on('console', msg => {
-        const msgText = msg.text();
-        let indentedMsg = '';
-        // If debugging is on:
-        if (debug) {
-          // Log a summary of the message on the console.
-          const parts = [msgText.slice(0, 75)];
-          if (msgText.length > 75) {
-            parts.push(msgText.slice(75, 150));
-            if (msgText.length > 150) {
-              const tail = msgText.slice(150).slice(-150);
-              if (msgText.length > 300) {
-                parts.push('...');
-              }
-              parts.push(tail.slice(0, 75));
-              if (tail.length > 75) {
-                parts.push(tail.slice(75));
-              }
-            }
-          }
-          indentedMsg = parts.map(part => `    | ${part}`).join('\n');
-          console.log(`\n${indentedMsg}`);
-        }
-        // Add statistics on the message to the report.
-        const msgTextLC = msgText.toLowerCase();
-        const msgLength = msgText.length;
-        report.jobData.logCount++;
-        report.jobData.logSize += msgLength;
-        if (errorWords.some(word => msgTextLC.includes(word))) {
-          report.jobData.errorLogCount++;
-          report.jobData.errorLogSize += msgLength;
-        }
-        const msgLC = msgText.toLowerCase();
-        if (
-          msgText.includes('403') && (msgLC.includes('status')
-          || msgLC.includes('prohibited'))
-        ) {
-          report.jobData.prohibitedCount++;
-        }
-      });
-    });
-    // Open the first page of the context.
-    const page = await browserContext.newPage();
-    try {
-      // Wait until it is stable.
-      await page.waitForLoadState('domcontentloaded', {timeout: 5000});
-      // Navigate to the specified URL.
-      const navResult = await goTo(report, page, url, 15000, 'domcontentloaded');
-      // If the navigation succeeded:
-      if (navResult.success) {
-        // Update the name of the current browser type and store it in the page.
-        page.browserTypeName = typeName;
-        // Return the response of the target server, the browser context, and the page.
-        return {
-          success: true,
-          response: navResult.response,
-          browserContext,
-          page
-        };
-      }
-      // If the navigation failed:
-      if (navResult.error) {
-        // Return this.
-        return {
-          success: false,
-          error: 'Navigation failed'
-        };
-      }
-    }
-    // If it fails to become stable after load:
-    catch(error) {
-      // Return this.
-      console.log(`ERROR: Blank page load in new tab timed out (${error.message})`);
-      return {
-        success: false,
-        error: 'Blank page load in new tab timed out'
-      };
-    }
-  }
-  // Otherwise, i.e. if it does not exist:
-  else {
-    // Return this.
-    console.log(`ERROR: Browser of type ${typeName} could not be launched`);
-    return {
-      success: false,
-      error: `${typeName} browser launch failed`
-    };
-  }
-};
-exports.browserClose = browserClose;
-exports.getNonce = getNonce;
-exports.goTo = goTo;
-exports.launch = launch;