@suffolklitlab/alkiln 5.8.1-feat2columns2 → 5.8.1-feat2columns4

package/.github/workflows/github_server.yml

@@ -88,5 +88,5 @@ jobs:
           #### Developer note: Useful for temporarily shortening ALKiln tests
           #### to debug the docker install step
           # ALKILN_TAG_EXPRESSION: @a_tag_expression
-          ALKILN_VERSION: 5.8.1-feat2columns2
+          ALKILN_VERSION: 5.8.1-feat2columns4
 

package/.github/workflows/playground.yml

@@ -55,4 +55,4 @@ jobs:
           #### to debug the docker install step
           # ALKILN_TAG_EXPRESSION: @a_tag_expression
           #### Developer note: you probalby don't need this
-          ALKILN_VERSION: 5.8.1-feat2columns2
+          ALKILN_VERSION: 5.8.1-feat2columns4

package/CHANGELOG.md

@@ -45,6 +45,10 @@ Format:
 
 <!-- ## [Unreleased] -->
 
+### Added
+
+- 2-column Story Tables that work without the trigger variable. Now column 1, "var", should only contain the actual variable name with no proxies (x, i, j, etc). For example, instead of `x[i].name.first` the var column should now contain `users[0].name.first`. Column 2 is the same as it was before - the answer for the field. See [#582](https://github.com/SuffolkLITLab/ALKiln/issues/582).
+
 ## [5.8.1] - 2023-12-28
 
 ### Fixed

package/docs/expected_inernal_results.md

@@ -0,0 +1,15 @@
+# What results are we expecting in our own tests?
+
+Our internal test results look a little strange. For example, they sometimes initially look like they're failing, but eventually pass. That's because we're testing that our tests respond appropriately to authors' failures as well as successees.
+
+These are the results that we expect:
+
+## Cucumber feature tests {#cucumber}
+
+- Many red `F`s in our cucumber "progress bar"
+- Final results to show all Scenarios passing
+- Cucumber seems to be unable to print the name of the first scenario
+
+## Unit tests {#unit}
+
+All these must pass

package/lib/scope.js

@@ -721,51 +721,6 @@ module.exports = {
     return result;
   },  // Ends scope.getLoadData()
 
-  // three_column_table_warning: async function ( scope, { var_data=null, raw_var_data=null }) {
-
-  // },
-
-  // normalize_table_base: async function ( scope, { var_data=null, raw_var_data=null }) {
-  //   /* Return data derived from cucumber variable-setting data, from either an object format
-  //    * (var_data) or an array format (raw_var_data). `var_data` only is used when calling
-  //    * normalizeTable internally.
-  //    *
-  //    * Takes care of the shared funcitonality that needs to happen to all tables.
-  //    */
-
-  //   if (!var_data && ! raw_var_data) {
-  //     let no_data_msg = `ALKiln Internal error: normalizeTable called w/o var_data or raw_var_data:` +
-  //         ` open an issue at https://github.com/SuffolkLITLab/ALKiln/issues/new if you see this!`;
-  //     reports.addToReport( scope, { type: `error`, value: no_data_msg });
-  //     throw Error(no_data_msg);
-  //   }
-
-  //   // Always use the raw var data if present; it has the full first row
-  //   if (raw_var_data) {
-  //     var_data = raw_var_data.hashes();
-  //     if (!('var' in var_data[0]) || !('value' in var_data[0])) {
-  //       let raw_array = raw_var_data.raw();
-  //       var_data = [];
-  //       for (let row_raw of raw_array) {
-  //         if (row_raw.length < 2) {
-  //           let bad_table_msg = `Your Story Table has less than 2 columns.`
-  //               + ` Take another look at Story Table documentation at`
-  //               + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#story-tables.`
-  //           reports.addToReport( scope, { type: `error`, value: bad_table_msg})
-  //           throw Error(bad_table_msg);
-  //         } else if (row_raw.length == 2) {
-  //           var_data.push({var: row_raw[0], value: row_raw[1]});
-  //         } else {
-  //           var_data.push({var: row_raw[0], value: row_raw[1], trigger: row_raw[2]});
-  //         }
-  //       }
-  //     }
-  //   }
-
-
-
-  // },
-
   normalizeTable: async function ( scope, { var_data=null, raw_var_data=null }) {
     /* Return data derived from cucumber variable-setting data, from either an object format
      * (var_data) or an array format (raw_var_data). `var_data` only is used when calling
@@ -1482,9 +1437,12 @@ module.exports = {
 
       let multiple_matches_msg = `Do you have a duplicate story table row? `
         + `Multiple story table rows match this field's variable name. `
-        + `The test will use the last row that matched. See `
-        + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger.`
-        + `\nThe matching rows:\n${ rows_as_story_table.join(`\n`) }`
+        + `The test will use the last row that matched.`
+
+      if ( trigger_might_be_needed ) {
+        multiple_matches_msg += ` See https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger.`
+      }
+      multiple_matches_msg += `\nThe matching rows:\n${ rows_as_story_table.join(`\n`) }`
         + `\nThis field's data:\n${ JSON.stringify( field )}`;
       reports.addToReport(scope, { type: `warning`, value: multiple_matches_msg });
     }
@@ -2148,24 +2106,21 @@ module.exports = {
 
     // If all table rows must be used and any table row was not, error
     if ( ensure_all_vars_used ) {
-      let num_unused_rows = 0;
       for ( let row of var_data ) {
         if ( row.times_used === 0 ) {
-          num_unused_rows += 1;
+          let values_used_status = 'The page is missing a value';
           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 }"`;
-          reports.addToReport(scope, { type: `warning`, value: msg });
+          let { id } = await scope.examinePageID( scope, 'none to match' );
+          let msg = `In a linear Step all the values you give MUST be filled in, but ALKiln was unable `
+            + `to find a field on the page "${id}" for the variable "${ original_row.var }" that `
+            + `could be set to "${ original_row.value }". See this Scenario's HTML file for details.`;
+          reports.addToReport(scope, { type: `error`, value: msg });
+          expect( values_used_status, msg ).to.equal( '' );
         }
       }
-      if ( num_unused_rows > 0 ) {
-        let { id } = await scope.examinePageID( scope, 'none to match' );
-        let msg = `Error on page "${id}". See screenshot and see text above for more details.`;
-        reports.addToReport(scope, { type: `error`, value: msg });
-        expect( num_unused_rows, msg ).to.equal( 0 );
-      }
     }
 
     // If didn't already press a continue button, press one now.

package/lib/steps.js

@@ -106,6 +106,12 @@ BeforeAll(async () => {
 });
 
 Before(async (scenario) => {
+
+  // Useful for those with a lot of tests
+  // Is unable to print the first Scenario name for some reason
+  console.log('');
+  process.stdout.write(`Scenario: ${ scenario.pickle.name }: `);
+
   // Create browser, which can't be created in BeforeAll() where .driver doesn't exist for some reason
   if (!scope.browser) {
     if (session_vars.get_origin() === 'playground') {
@@ -297,7 +303,9 @@ Given(/the max(?:imum)? sec(?:ond)?s for each step (?:in this scenario )?is (\d+
 // Story
 //#####################################
 //#####################################
-
+// TODO: Consider more permissive sentences:
+// with(?: this data| these answers)?:?
+// with(?:.*):?
 When(/^(?:the user gets)?(?:I get)? to ?(?:the)?(?: ?question)?(?: id)? "([^"]+)" with this data:?/, {timeout: -1}, async (target_id, raw_var_data) => {
   /* NO CUCUMBER TIMEOUT. Must handle timeout ourselves:
   * https://github.com/cucumber/cucumber-js/blob/master/docs/support_files/timeouts.md#disable-timeouts
@@ -1242,8 +1250,8 @@ Given(/the Scenario report should not include/i, async ( report_text ) => {
 
 });
 
-Given(/the final Scenario status should be "(passed|failed)"/i, async ( expected_status ) => {
-  /* WARNING: If a Step will fail, this Step must come first.
+Given(/the final Scenario status should be "([^"]+)"/i, async ( expected_status ) => {
+  /** WARNING: If a Step will fail, this Step must come first.
   * 
   * Prepare to test that the Scenario completes with the correct status. */
   scope.expected_status = expected_status.toUpperCase();
@@ -1325,39 +1333,46 @@ After(async function(scenario) {
 
   }  // ends if not passed
 
-  // Internal tests of this framework
-  if ( scope.expected_status ) {
-    let expected = scope.expected_status;
-    scope.expected_status = null;  // reset for next Scenario
-    expect( changeable_test_status ).to.equal( expected );
-    // If the status was as expected, pass this criteria
-    changeable_test_status = `PASSED`;
-  }
-  
+  // Add report text to Scenario folder after everything has been added to the report
+  let current_report_obj = scope.report.get( scope.scenario_id );
+  let scenario_report_obj = [ scope.scenario_id, current_report_obj ];  // Mimic how loop works with `Map`
+  let report = reports.getPrintableScenario( scenario_report_obj );
+  // Save the report as in the Scenario folder
+  fs.writeFileSync( scope.paths.scenario_report, report );
+
+  // ---------------- Check internal test results of this framework ----------------
+
   if ( scope.expected_in_report && scope.expected_in_report.length > 0) {
-    let expected = scope.expected_in_report;
+    let report_includes_all_expected_strings = await scope.reportIncludesAllExpected(
+      scope,
+      { expected: scope.expected_in_report }
+    );
+    if ( !report_includes_all_expected_strings ) { changeable_test_status = `FAILED`; }
     // Reset report values no matter what so they don't mess up future scenarios
     scope.expected_in_report = null;
-    let all_were_included = await scope.reportIncludesAllExpected( scope, { expected });
-
-    if ( all_were_included ) { changeable_test_status = `PASSED`; }
-    else { changeable_test_status = `FAILED`; }
   }
   
   if (scope.expected_not_in_report && scope.expected_not_in_report.length > 0) {
-    let not_expected = scope.expected_not_in_report;
+    let all_prohibited_strings_were_absent = await scope.reportDoesNotInclude(
+      scope,
+      { not_expected: scope.expected_not_in_report }
+    );
+    if ( !all_prohibited_strings_were_absent ) { changeable_test_status = `FAILED`;}
     // Reset report values no matter what so they don't mess up future scenarios
     scope.expected_not_in_report = null;
-    let all_were_not_there = await scope.reportDoesNotInclude( scope, { not_expected });
-
-    if ( all_were_not_there ) {
-      changeable_test_status = `PASSED`;
-    } else { 
-      changeable_test_status = `FAILED`;
-    }
+  }
 
+  // The default is 'passed', which won't need to get in here
+  if ( scope.expected_status ) {
+    // When internal tests should fail (to test our failure conditions), passing _is_ failing
+    expect( changeable_test_status ).to.equal( scope.expected_status );
+    // If the status was as expected, pass this Scenario
+    changeable_test_status = `PASSED`;
+    scope.expected_status = null;  // reset for next Scenario
   }
 
+  // ---------------- Ends check internal test results of this framework ----------------
+
   // If there is a page open, then sign out and close it
   if ( scope.page ) {
     // Catch a possible reload error.
@@ -1385,23 +1400,19 @@ After(async function(scenario) {
 
   }  // ends if scope.page
 
-  // Add report text to Scenario folder after everything has been added to the report
-  let current_report_obj = scope.report.get( scope.scenario_id );
-  let scenario_report_obj = [ scope.scenario_id, current_report_obj ];  // Mimic how loop works with `Map`
-  let report = reports.getPrintableScenario( scenario_report_obj );
-  // Save the report as in the Scenario folder
-  fs.writeFileSync( scope.paths.scenario_report, report );
-
   if ( changeable_test_status === `FAILED` ) {
     // If the result object status wasn't failure and we still want
     // the tests to fail, as with a11y tests, we can't mess with the
     // cucumber result.status object because it will cause unwanted
     // errors. We have to throw an error here instead.
     if ( scenario.result.status !== `FAILED` ) {
-      throw new Error(`The test failed. See the report for more information.`);
+      throw new Error(`The test failed. See the report above for more information.`);
     }
   } else {
-    // Other types of errors should be ok
+    // Some internal test failures should be ok
+    // TODO: Look into setDefinitionFunctionWrapper to catch errors
+    // of failing tests that should indeed be failing:
+    // https://github.com/cucumber/cucumber-js/blob/main/docs/support_files/api_reference.md#setdefinitionfunctionwrapperwrapper
     scenario.result.status = changeable_test_status;
   }
 });

package/package.json

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