@suffolklitlab/alkiln 4.1.0 → 4.1.1

package/.github/workflows/test_tests.yml

@@ -31,6 +31,9 @@ jobs:
       REPO_URL: https://github.com/plocket/docassemble-ALAutomatedTestingTests
       USER1_EMAIL: ${{ secrets.USER1_EMAIL }}
       USER1_PASSWORD: ${{ secrets.USER1_PASSWORD }}
+      SECRET_VAR1: secret-var1-value
+      SECRET_VAR2: secret-var2-value
+      SECRET_FOR_MISSING_FIELD: secret for missing field
 
     name: Run Puppeteer tests
     steps:

package/CHANGELOG.md

@@ -39,7 +39,7 @@ Format:
 - 
 -->
 <!-- ## [Unreleased] -->
-## [4.1.0] - 2022-04-01
+## [4.1.1] - 2022-04-01
 ### Added
 - Step to set vars to secret variables. That is, using environment variables while hiding the names of those variables in the report, errors, and console logs.
 

package/lib/scope.js

@@ -22,6 +22,30 @@ let escape_regex = function( to_escape ) {
   return to_escape.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
 };
 
+let get_original_row = function (row) {
+  /* `row` might be a row, a source row, or an original row. */
+
+  // Until we flatten row data a litte, we need to find the `orignal` row, which has the flags
+  let source_row = row.source || row;
+  let original = source_row.original || source_row;
+  return original;
+}
+
+let printable_var_value = function(row) {
+  /* `row` might be a row, a source row, or an original row. */
+  let original = get_original_row(row);
+  if ( is_secret_var(original) ) {
+    return original.flags.secret_name;
+  }
+  return row.value;
+};
+
+let is_secret_var = function(row) {
+  /* `row` might be a row, a source row, or an original row. */
+  let original = get_original_row(row);
+  return original.flags !== undefined && original.flags.secret_name !== undefined;
+}
+
 let proxies_regex = /(\bx\.)|(\bx\[)|(\[[ijklmn]\])/g;
 
 module.exports = {
@@ -467,19 +491,29 @@ module.exports = {
 
   normalizeTable: async function ( scope, { var_data, from_story_table=true }) {
     /* Return data derived from cucumber variable-setting data.
-    * Table must have headers. Arrays are not supported. */
+     * Table must have headers. Arrays are not supported. */
 
     // Support tables with no 'trigger' column
     let supported_table = [];
     for ( let row of var_data ) {
       // See tests > unit_tests > tables.fixtures.js > tables.old_to_current_formatting
+      let actual_var_value = row.value;
+      if (is_secret_var(row)) {
+        actual_var_value = process.env[row.flags.secret_name];
+        if ( actual_var_value === undefined ) {
+          let not_in_env_msg = `The GitHub SECRET "${ row.flags.secret_name }" doesn't exist. Check for a typo and check your workflow file.`;
+          await scope.addToReport( scope, { type: `error`, value: not_in_env_msg })
+          throw ReferenceError(`Could not find "${row.flags.secret_name }": ${not_in_env_msg}.`)
+        }
+      }
+
       let result = {
         original: row,
         // Give fake data if needed to prevent some kind of hidden input field from being found
         // See bug at https://github.com/plocket/docassemble-cucumber/issues/79
         // May be able to remove this once converted to `getAllFields`
         var: row.var || 'al_no_var_name',
-        value: row.value,
+        value: actual_var_value,
         trigger: row.trigger || '',
         times_used: 0,
       }
@@ -487,7 +521,9 @@ module.exports = {
       supported_table.push( result );
     }
 
-    if ( session_vars.get_debug() ) { console.log( 'scope.normalizedTable():\n', JSON.stringify( supported_table )); }
+    if ( session_vars.get_debug() ) { 
+      console.log( 'scope.normalizedTable():\n', JSON.stringify( supported_table )); 
+    }
 
     return supported_table;
   },  // Ends scope.normalizeTable()
@@ -1506,9 +1542,10 @@ module.exports = {
         if ( row.times_used === 0 ) {
           num_unused_rows += 1;
           let source_row = row;
+          // TODO: Make the row object flatter so we don't need to dig in this way
           if ( row.source ) { source_row = row.source; }
           let original_row = source_row.original;
-          let msg = `Did not find a field on this page for the variable \`${ original_row.var }\` that could be set to \`${ original_row.value }\``;
+          let msg = `Did not find a field on this page for the variable "${ original_row.var }" that could be set to "${ original_row.value }"`;
           await scope.addToReport(scope, { type: `warning`, value: msg });
         }
       }
@@ -1610,20 +1647,24 @@ module.exports = {
     * This may in future be used to normalize all values that need `True`/`False`
     * normalization.
     */
-    let value = row.value;
+    let value = row.value.toLowerCase();
+    let val_to_print = printable_var_value(row); 
     let int_val = parseInt( value );
     
     // Step stuff. Take into account a lot of possible values
     if ( value.match( /(false|no|unchecked|uncheck|deselected|deselect)/i )) {
+      // Should this also contain a warning if this is trying to set `target_number`?
       return `False`;
 
     } else if ( value.match( /(true|yes|checked|check|selected|select)/i )) {
       if ( from_story_table ) {
-        // Just in case, but this should never happen.
         if ( row.var.match( /\.there_is_another$/ ) ) {
+          // `.there_is_another` should never get in here, but just in case
           await scope.addToReport( scope, { type: `warning`, value: `The attribute \`.there_is_another\` is invalid in story table tests. Replace it with \`.target_number\` in your \`var\` column. Set the \`value\` to the number of items in that list. This test will now set this row's \`value\` to \`False\`. See https://suffolklitlab.github.io/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing#there_is_another-loop. The row data is\n${ JSON.stringify( row.original )}` });
         } else {
-          await scope.addToReport( scope, { type: `warning`, value: `${ value } is not a valid value for ${ row.var } here. This test will default to \`False\` to avoid problems.` });
+          // If `target_number` is set to True instead of a number
+          // Since secret vars can't be passed in a table, this should never be a secret var
+          await scope.addToReport( scope, { type: `warning`, value: `${ val_to_print } value is not a valid value for ${ row.var } here. This test will default to \`False\` to avoid problems.` });
         }
         return `False`;
       } else { return `True`; }
@@ -1638,7 +1679,8 @@ module.exports = {
         return `False`;
 
     } else if ( isNaN( parseInt( value )) ) { // Loop will end
-      await scope.addToReport( scope, { type: `warning`, value: `${ value } is not a valid value for ${ row.var } here. This test will default to \`False\` to avoid problems.` });
+      // I can't figure out how to trigger this warning either
+      await scope.addToReport( scope, { type: `warning`, value: `${ val_to_print } value is not a valid value for ${ row.var } here. This test will default to \`False\` to avoid problems.` });
       return `False`;
 
     } else {  // It's a number. Loop will continue.
@@ -1792,6 +1834,21 @@ module.exports = {
       await scope.setFields( scope, { var_data, ensure_navigation: false, ensure_all_vars_used: true });
     },  // Ends set_regular_var()
 
+    set_secret_var: async ( scope, var_name, set_to_env_name ) => {
+      /** Sets a non-story table variable to a "secret" value (i.e. an env var) */
+      let var_data = await scope.normalizeTable( scope, {
+              var_data: [{
+                var: var_name,
+                value: set_to_env_name,
+                trigger: scope.trigger_not_needed_flag,
+                flags: {secret_name: set_to_env_name}
+              }],
+      });
+      // Don't continue if the variable doesn't cause navigation itself. Also,
+      // if this variable cannot be set on this page, trigger an error
+      await scope.setFields( scope, { var_data, ensure_navigation: false, ensure_all_vars_used: true });
+    },
+
     tap_term: async ( scope, phrase ) => {
       /** Tap a link that doesn't navigate. Depends on the language of the text. */
       const [link] = await scope.page.$x(`//a[contains(text(), "${phrase}")]`);

package/lib/steps.js

@@ -14,13 +14,11 @@ const wrapPromiseWithTimeout = require('./cucumber_8_shim');
 const fs = require('fs');
 const path = require('path');
 const { expect } = require('chai');
-const puppeteer = require('puppeteer');
 const { v4: uuidv4 } = require('uuid');
 
 // Ours
 const scope = require('./scope');
 const session_vars = require('./utils/session_vars');
-
 /* Of Note:
 - We're using `*=` because sometimes da text has funny characters in it that are hard to anticipate
 */
@@ -735,6 +733,15 @@ When(/I set the var(?:iable)? "([^"]+)" to "([^"]+)"/, { timeout: -1 }, async (
   );
 });
 
+When(/I set the var(?:iable)? "([^"]+)" to ?(?:the)? ?(?:GitHub)? secret "([^"]+)"/i, { timeout: -1 }, async ( var_name, set_to_env_name ) => {
+  /* Set a non-story table variable to a secrete value. Same as the above, but reads the value from `process.env` */
+  return wrapPromiseWithTimeout(
+    scope.steps.set_secret_var( scope, var_name, set_to_env_name ),
+    scope.timeout
+  );
+});
+
+
 Then(/I upload "([^"]+)" to "([^"]+)"/, { timeout: -1 }, async ( filenames, var_name ) => {
   /* Uploads file (docx, jpg, etc) in same folder to input var. Can actually use
   * 'I set the var "" to ""', but this is more explicit if it's desired. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {

package/tests/features/interactive_steps.feature

@@ -83,3 +83,21 @@ Scenario: I set text-type values
   And I tap to continue
   # Next page
   Then the question id should be "the end"
+
+@fast @i2 @secret
+Scenario: handles settings from Github secrets
+  Given the final Scenario status should be "failed"
+  And the Scenario report should include:
+  """
+  The GitHub SECRET "SECRET_NOT_THERE" doesn't exist
+  """
+  Given I start the interview at "test_secret_vars"
+  When I set the var "first_text_entry" to the secret "SECRET_VAR1"
+  And I tap to continue
+  Then I see the phrase "secret-var1-value"
+  When I tap to continue
+  And I set the var "second_text_entry" to the github secret "SECRET_VAR2"
+  And I tap to continue
+  Then I see the phrase "secret-var2-value"
+  When I tap to continue
+  And I set the variable "third_text_entry" to secret "SECRET_NOT_THERE"

package/tests/features/reports.feature

@@ -386,6 +386,17 @@ Scenario: Fail with could not find files
   Given I start the interview at "all_tests"
   And I upload "nonexistant1.pdf, nonexistant2.pdf" to "upload_files_visible"
 
+@fast @rf26 @secret @error
+Scenario: Fail to find var while keeping value secret
+  Given the final Scenario status should be "failed"
+  Given the Scenario report should include:
+  """
+  Did not find a field on this page for the variable "missing_var" that could be set to "SECRET_FOR_MISSING_FIELD"
+  """
+  And I start the interview at "test_secret_vars"
+  And I set the var "missing_var" to the secret "SECRET_FOR_MISSING_FIELD"
+
+
 # scope.js
 # I upload "___" to "___"
 # No need to test wrong var name
@@ -409,6 +420,7 @@ Scenario: Warn when there are too many names
   And I set the name of "users[0]" to "Uli Udo User Sampson Jr"
   And I tap to continue
 
+
 # ===============================
 # Reports for "passed" Scenarios
 # ===============================