@suffolklitlab/alkiln 5.13.3-feat-random → 5.13.3-feat-random-2

package/lib/utils/reports.js

@@ -26,14 +26,14 @@ reports.addReportHeading = function (scope, { scenario }) {
     tag_names.push( tag.name );
   }
 
-  let heading = `\n―――――――――――――――\n`
+  let heading = `\n━━━━━━━━━━━━━━━\n`
     + `Scenario: ${ scenario.pickle.name }`;
 
   if ( tag_names.length > 0 ) {
     heading += `\nTags: ${ tag_names.join(' ') }`;
   }
 
-  heading += `\n―――――――――――――――`;
+  heading += `\n━━━━━━━━━━━━━━━`;
 
   reports.addToReport( scope, {
     code: `ALK0176`,
@@ -279,7 +279,7 @@ let getLineText = function ({ type=`no type`, code=`ALK00rl`, value=``, indent=`
   return result;
 };  // Ends getLine()
 
-let getDebugLine = function ({ type=``, code=`ALK00rd`, value=``, indent=`` }) {
+let getDebugLine = function ({ type=``, code=`ALK0278`, value=``, indent=`` }) {
   /** In debug log lines, include all the information possible. */
 
   // `plain` is usually used for visual clarity and shouldn't have
@@ -299,12 +299,11 @@ let getDebugLine = function ({ type=``, code=`ALK00rd`, value=``, indent=`` }) {
 
   start += ` ${ code }`;
 
-  // TODO: This doesn't take care
+  let description_parts = [];
   let extra_types = type.replace(/debug|info|success|warning|error/i, ``).replace(/  +/g, ' ').trim();
-  if ( extra_types.length > 0 ) { start += ` ${ extra_types } `; }
+  if ( extra_types.length > 0 ) { description_parts = extra_types.split(` `); }
 
-  // Get all the relevant descriptive text
-  let description_parts = [];
+  // Get all the main descriptive text
   if ( type.includes(`debug`) ) { description_parts.push( `DEBUG` ); }
   if ( type.includes(`info`) ) { description_parts.push( `INFO` ); }
   if ( type.includes(`success`) ) { description_parts.push( `SUCCESS` ); }

package/lib/utils/session_vars.js

@@ -21,10 +21,14 @@ require('dotenv').config();
  * */
 
 /**
- * Discuss: consider returning most logs (info, error, warning) so that the
- *    calling functions can use a `Log` to log them properly instead of logging
- *    to the console. Alternatively, move everything in here that `Log` uses
- *    into its own file so that `session_vars` can have its own `Log` instance.
+ * Discuss: We don't like logging directly to the console in here. Consider
+ *    returning most logs (info, error, warning) so that the calling functions
+ *    can use a `Log` to log them properly instead of logging to the console.
+ *    Alternatively, move everything in here that `Log` uses into its own file
+ *    so that `session_vars` can have its own `Log` instance. For example, put
+ *    artifacts path name related functions in `Log`. That "get/set/delete"
+ *    behavior would be inconsistent with other similar functions. Other places
+ *    need to use artifacts path name too.
  * */
 
 const session_vars = {};
@@ -276,13 +280,14 @@ session_vars.get_runtime_config_var = function ( key ) {
   try {
     let json = JSON.parse( fs.readFileSync( runtime_config_path ));
     let value = json[ key ];
+    console.log(`🐛🐛🐛🐛🐛 ALK00temp config key/value pair:`, key, value);
     if ( session_vars.get_debug() ) {
       console.debug( `🐛 ALK0041 DEBUG: Runtime config var "${ key }" is "${ value }".` );
     }
     return value;
   } catch ( get_var_error ) {
 
-    console.debug(`🖊️ ALK0271 NOTE: Skipped getting runtime config var "${ key }".`, get_var_error.stack );
+    console.debug(`🖊️ ALK0273 NOTE: Skipped getting runtime config var "${ key }".`, get_var_error.stack );
     return null;
 
   }
@@ -306,7 +311,7 @@ session_vars.delete_runtime_config_var = function ({ key }) {
 
   } catch ( delete_var_error ) {
 
-    console.debug( `🖊️ ALK0272 NOTE: Skipped deleting runtime config var "${ key }".`, delete_var_error.stack );
+    console.debug( `🖊️ ALK0274 NOTE: Skipped deleting runtime config var "${ key }".`, delete_var_error.stack );
     return null
 
   }

package/package.json

@@ -1,23 +1,26 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.13.3-feat-random",
+  "version": "5.13.3-feat-random-2",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
-    "test": "npm run build && npm run unit && npm run codes && npm run cucumber",
-    "local": "npm run build && npm run setup && npm run cucumber; npm run takedown",
-    "pass": "npm run build && ./lib/run_cucumber.js 'not @error and not @temp_error'",
-    "fail": "npm run build && npm run cucumber '@error'",
-    "cucumber": "npm run build && ./lib/run_cucumber.js",
-    "setup": "./lib/docassemble/setup.js",
+    "test": "npm run unit && npm run codes && npm run cucumber",
+    "local": "npm run setup && npm run cucumber; npm run takedown",
+
     "takedown": "./lib/docassemble/takedown.js",
+    "setup": "./lib/docassemble/setup.js",
     "server_install": "./lib/docassemble/server_install.js",
-    "build": "npm run artifacts && npm run files",
-    "files": "npm run validate && npm run generate",
+
+    "pass": "npm run cucumber 'not @error and not @temp_error'",
+    "fail": "npm run cucumber '@error'",
+    "cucumber": "npm run build && ./lib/run_cucumber.js",
+
+    "build": "npm run artifacts && npm run validate && npm run generate",
     "validate": "./lib/setup/validate.js",
     "generate": "./lib/setup/generate.js",
-    "unit": "npm run artifacts && mocha --recursive 'tests/unit_tests/**/*.test.*'",
     "artifacts": "./lib/setup/artifacts.js",
+    
+    "unit": "npm run artifacts && mocha --recursive 'tests/unit_tests/**/*.test.*'",
     "codes": "tests/log_codes/check_codes.sh ."
   },
   "repository": {

package/tests/log_codes/check_codes.sh

@@ -138,7 +138,7 @@ while [ "$indx" -le "$highest_code" ]; do
     # if [[ "$loudness" != "0" ]]; then
       missing+=("$long_msg")
     # else
-      # missing+=("$short_msg")
+    #   missing+=("$short_msg")
     # fi
 
   # too_many
@@ -146,7 +146,7 @@ while [ "$indx" -le "$highest_code" ]; do
     # if [[ "$loudness" != "0" ]]; then
       too_many+=("$long_msg")
     # else
-      # too_many+=("$short_msg")
+    #   too_many+=("$short_msg")
     # fi
   fi
 
@@ -195,4 +195,4 @@ else
 fi
 
 
-exit $exit_code
+exit $exit_code

package/tests/log_codes/log_code_expected_instances.txt

@@ -5,8 +5,11 @@ Why we need duplicate codes sometimes: GitHub actions sometimes don't have ways
 The script that tests the log codes will ignore this file (or any file with this name), and any file with these names: check_codes.sh, debug_log.txt, cucumber-report.txt. It will also ignore files in folders with these names:, node_modules, ALKilnTests, alkiln-*, _alkiln*. That list might get updated, so for an up-to-date list, always check the file check_codes.sh where we use `--exclude=` and such.
 
 Reasons for deletion:
+0000 - unknown
 0053 - duplicate log
 0173 - redundant
+0181 - unknown
+0223 - changed Log behavior ("Only logs that throw should give a value to `error`.")
 
 ALK0000:0
 ALK0001:1
@@ -231,7 +234,7 @@ ALK0219:1
 ALK0220:1
 ALK0221:1
 ALK0222:1
-ALK0223:0 "Only logs that throw should give a value to \`error\`. Skipping the value."
+ALK0223:0
 ALK0224:1
 ALK0225:1
 ALK0226:1
@@ -267,3 +270,22 @@ ALK0255:1
 ALK0256:1
 ALK0257:1
 ALK0258:1
+ALK0259:1
+ALK0260:1
+ALK0261:1
+ALK0262:1
+ALK0263:1
+ALK0264:1
+ALK0265:1
+ALK0266:1
+ALK0267:1
+ALK0268:1
+ALK0269:1
+ALK0270:1
+ALK0271:1
+ALK0272:1
+ALK0273:1
+ALK0274:1
+ALK0275:1
+ALK0276:1
+ALK0277:1

package/tests/unit_tests/constrained_random_answers/invalid.fixtures.js

@@ -49,11 +49,11 @@ Scenario: I fail with missing keywords for a fore Step
     | user_choice | correct;; wrong |
 `;
 fixts.missing_fore_Step_keywords.expected = null;
-fixts.missing_fore_Step_keywords.error_codes = [ `ALK0241`, `ALK0261` ];
+fixts.missing_fore_Step_keywords.error_codes = [ `ALK0242`, `ALK0263` ];
 fixts.missing_fore_Step_keywords.log_codes = [
-  `ALK0236`,
-  `ALK0241`,
-  `ALK0261`,
+  `ALK0237`,
+  `ALK0242`,
+  `ALK0263`,
 ];
 
 
@@ -70,12 +70,12 @@ Scenario: I fail with missing keywords for a constraints Step
     | user_choice | correct;; wrong |
 `;
 fixts.missing_constraints_Step_keywords.expected = null;
-fixts.missing_constraints_Step_keywords.error_codes = [ `ALK0254`, `ALK0261` ];
+fixts.missing_constraints_Step_keywords.error_codes = [ `ALK0256`, `ALK0263` ];
 fixts.missing_constraints_Step_keywords.log_codes = [
-  `ALK0236`, `ALK0242`, `ALK0243`,
-  `ALK0244`, `ALK0247`, `ALK0248`,
-  `ALK0254`,
-  `ALK0261`,
+  `ALK0237`, `ALK0243`, `ALK0244`,
+  `ALK0245`, `ALK0248`, `ALK0249`,
+  `ALK0256`,
+  `ALK0263`,
 ];
 
 
@@ -92,12 +92,12 @@ Scenario: I fail with the first missing table
 `;
 // ======= ENDS ARG ======= //
 fixts.missing_table.expected = null;
-fixts.missing_table.error_codes = [ `ALK0250`, `ALK0261` ];
+fixts.missing_table.error_codes = [ `ALK0251`, `ALK0263` ];
 fixts.missing_table.log_codes = [
-  `ALK0236`, `ALK0242`, `ALK0243`,
-  `ALK0244`, `ALK0247`, `ALK0248`, `ALK0245`,
-  `ALK0250`,
-  `ALK0261`,
+  `ALK0237`, `ALK0243`, `ALK0244`,
+  `ALK0245`, `ALK0248`, `ALK0249`, `ALK0246`,
+  `ALK0251`,
+  `ALK0263`,
 ];
 
 
@@ -115,12 +115,12 @@ Scenario: I fail with missing quoted ids in constrained random answers
 `;
 // ======= ENDS ARG ======= //
 fixts.missing_ids.expected = null;
-fixts.missing_ids.error_codes = [ `ALK0249`, `ALK0261` ];
+fixts.missing_ids.error_codes = [ `ALK0250`, `ALK0263` ];
 fixts.missing_ids.log_codes = [
-  `ALK0236`, `ALK0242`, `ALK0243`,
-  `ALK0244`, `ALK0247`, `ALK0248`, `ALK0245`,
-  `ALK0249`,
-  `ALK0261`,
+  `ALK0237`, `ALK0243`, `ALK0244`,
+  `ALK0245`, `ALK0248`, `ALK0249`, `ALK0246`,
+  `ALK0250`,
+  `ALK0263`,
 ];
 
 
@@ -140,12 +140,12 @@ Scenario: Non-table row after table header
     | user_choice | correct;; wrong |
 `;
 fixts.only_row_is_header.expected = null;
-fixts.only_row_is_header.error_codes = [`ALK0251`, `ALK0261`];
+fixts.only_row_is_header.error_codes = [`ALK0252`, `ALK0263`];
 fixts.only_row_is_header.log_codes = [
-  `ALK0236`, `ALK0242`, `ALK0243`,
-  `ALK0244`, `ALK0247`, `ALK0248`, `ALK0245`,
-  `ALK0251`,
-  `ALK0261`,
+  `ALK0237`, `ALK0243`, `ALK0244`,
+  `ALK0245`, `ALK0248`, `ALK0249`, `ALK0246`,
+  `ALK0252`,
+  `ALK0263`,
 ];
 
 /**
@@ -153,3 +153,25 @@ fixts.only_row_is_header.log_codes = [
  * can't detect it)
  * */
 
+
+fixts.multiple_scenarios = {};
+fixts.multiple_scenarios.arg =
+`Feature: It is invalid to have multiple Scenarios in one generator file
+
+Scenario: The first of 2 Scenarios
+  Given ALKiln makes 1 constrained random answers tests
+  Given I start the interview at "test_kickout"
+  And ALKiln will get to "end" with:
+    | var | possible_values |
+    | user_choice | correct;; wrong |
+
+Scenario: The second of 2 Scenarios
+  Given ALKiln makes 1 constrained random answers tests
+  Given I start the interview at "test_kickout"
+  And ALKiln will get to "end" with:
+    | var | possible_values |
+    | user_choice | correct;; wrong |
+`;
+fixts.multiple_scenarios.expected = null;
+fixts.multiple_scenarios.error_codes = [`ALK0236`];
+fixts.multiple_scenarios.log_codes = [`ALK0236`];

package/tests/unit_tests/constrained_random_answers/invalid.test.js

@@ -39,7 +39,7 @@ function get_log_codes({ logger }) {
    * */
   let codes = [];
 
-  for ( let record of logger.internal_tests_records ) {
+  for ( let record of logger.internal_log_records ) {
     codes.push( record.opts.code );
   }
 
@@ -62,8 +62,8 @@ function mutate_globals_with({ testing_vals }) {
    * 
    * @returns {undefined}
    * */
-  // Resets logger
-  logger.internal_tests_records = [];
+  // Reset log codes
+  logger.clear_internal_log_records();
 
   // Fresh namespace
   let generator = new TestGenerator();
@@ -98,7 +98,7 @@ describe(`Constrained random answers parser,`, function () {
 
   });
 
-  describe(`when given a empty generator text`, function () {
+  describe(`when given an empty string`, function () {
 
     before(function () { mutate_globals_with({ testing_vals: fixtures.generator_missing_contents }); });
     
@@ -228,6 +228,24 @@ describe(`Constrained random answers parser,`, function () {
 
     });
 
+    describe(`that has multiple Scenarios,`, function () {
+
+      before(function () { mutate_globals_with({ testing_vals: fixtures.multiple_scenarios }); });
+
+      let outer = fixtures.multiple_scenarios;
+      
+      it(`returns \`null\` for contents value`, function () {
+        expect( new_contents ).to.equal( fixture.expected );
+      });
+      it(`has these exact error codes: ${ JSON.stringify( outer.error_codes )}`, function () {
+        expect( get_error_codes({ errors: errors }) ).to.have.all.members( fixture.error_codes );
+      });
+      it(`has these exact _log_ codes: ${ JSON.stringify( outer.log_codes )}`, function () {
+        expect( get_log_codes({ logger }) ).to.have.all.members( fixture.log_codes );
+      });
+
+    });
+
   });
 
 });