@suffolklitlab/alkiln 5.13.4 → 5.14.0

package/lib/utils/reports.js

@@ -250,21 +250,23 @@ reports.getPrintableScenario = function( scenario ) {
   return report;
 };  // Ends reports.getPrintableScenario()
 
-let getLineText = function ({ type=`no type`, code=`ALK00rl`, value=`` }) {
+let getLineText = function ({ from_log, type=`no type`, code=`ALK00rl`, value=`` }) {
   let start = ``;
   if ( type.includes(`page_id`) ) { start += `screen id: `; }
   else if ( type.includes(`outcome`) ) { start += `\n`; }  // extra new line
-  else if ( type.includes(`warning`) ) { start += `🔎 ${ code } WARNING: `; }
-  else if ( type.includes(`error`) ) { start += `\n🤕 ${ code } ERROR: `; }  // extra new line
+  else if ( type.includes(`warning`) && !from_log ) { start += `🔎 ${ code } WARNING: `; }
+  else if ( type.includes(`error`) && !from_log ) { start += `\n🤕 ${ code } ERROR: `; }  // extra new line
   return `${ start }${ value }`;
 };  // Ends getLine()
 
-let getDebugLine = function ({ type=``, code=`ALK00rd`, value=`` }) {
-  /** In debug log lines, include all the information possible. */
+let getDebugLine = function ({ from_log, type=``, code=`ALK00rd`, value=`` }) {
+  /** In lines for the debug file, include all the information possible. */
 
   // `plain` is usually used for visual clarity and shouldn't have
   // codes and such associated with it. Return right away.
   if ( type.includes(`plain`) ) { return value; }
+  // Discuss: How to prevent saving in the debug log twice
+  if ( from_log ) { return value; }
 
   let start = ``;
 
@@ -291,7 +293,7 @@ let getDebugLine = function ({ type=``, code=`ALK00rd`, value=`` }) {
   if ( type.includes(`warning`) ) { description_parts.push( `WARNING` ); }
   if ( type.includes(`error`) ) { description_parts.push( `ERROR` ); }
   // Default
-  if ( description_parts.length <= 0 ) { description_parts.push( `UNKNOWN` ); }
+  if ( description_parts.length <= 0 ) { description_parts.push( `UNKNOWN LOG TYPE` ); }
 
   start = [ start, ...description_parts ].join(` `);
 

package/package.json

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

package/tests/unit_tests/example_of_chai_test_lifecycle.js

@@ -0,0 +1,78 @@
+const chai = require(`chai`);
+
+describe('chaijs before hooks', function () {
+  console.log(1);
+  before(() => console.log('--top-level before()'));
+  console.log(2);
+  beforeEach(() => console.log('--top-level beforeEach()'));
+  console.log(3);
+  describe('nesting 1', function () {
+    console.log(4);
+    before(() => console.log('--1. nested before()'));
+    console.log(5);
+    beforeEach(() => console.log('--1. nested beforeEach()'));
+    console.log(6);
+    it('is 1st nested spec', () => { console.log(7); return true; });
+    console.log(8);
+    it('is 2nd nested spec', () => { console.log(9); return true; });
+    console.log(10);
+  });
+  console.log(11);
+  describe('nesting 2', function () {
+    console.log(12);
+    before(() => console.log('--2. nested before()'));
+    console.log(13);
+    beforeEach(() => console.log('--2. nested beforeEach()'));
+    console.log(14);
+    it('is 1st nested spec', () => { console.log(15); return true; });
+    console.log(16);
+    it('is 2nd nested spec', () => { console.log(17); return true; });
+    console.log(18);
+  });
+  console.log(19);
+});
+
+/** Result:
+1
+2
+3
+4
+5
+6
+8
+10
+11
+12
+13
+14
+16
+18
+19
+
+
+  chaijs before hooks
+--top-level before()
+    nesting 1
+--1. nested before()
+--top-level beforeEach()
+--1. nested beforeEach()
+7
+      ✓ is 1st nested spec
+--top-level beforeEach()
+--1. nested beforeEach()
+9
+      ✓ is 2nd nested spec
+    nesting 2
+--2. nested before()
+--top-level beforeEach()
+--2. nested beforeEach()
+15
+      ✓ is 1st nested spec
+--top-level beforeEach()
+--2. nested beforeEach()
+17
+      ✓ is 2nd nested spec
+
+
+  4 passing (6ms)
+ * */

package/docs/seprate_file_generation_GitHub_action.md

@@ -1,11 +0,0 @@
-Pros for separate action:
-
-- Reflects nature of process - generating files is inherently separate.
-- Potentially cleaner separation conceptually for us.
-
-Cons:
-
-- Main beef: Developing and maintaining GitHub actions is hard
-- Authors have more in their workflow file
-- Need to update existing workflows
-- Need to update ALKilnSetup interview

package/lib/parse.js

@@ -1,36 +0,0 @@
-#!/usr/bin/env node
-
-let log = `log`;
-let args = get_command_line_args();
-let sources_paths = get_sources_paths( args );
-let feature_files_paths = get_feature_files( sources_paths );
-
-let all_errors = [];
-// Just see if any error when Gherkin parses them
-for ( let file_path of feature_files_paths ) {
-  try {
-    Gherkin.parse( file_path );
-  } catch ( error ) {
-    all_errors.push( error );
-  }
-}
-// let generated_files_paths = constrained_random_answer_tests.generate();
-// // Just see if any error when Gherkin parses them
-// for ( let generated_path of generated_files_paths ) {
-//   try {
-//     Gherkin.parse( generated_path );
-//   } catch ( error ) {
-//     all_errors.push( error );
-//   }
-// }
-
-let generator_errors = constrained_random_answer_tests.generate();
-all_errors = [ ...all_errors, ...generator_errors ];
-
-if ( all_errors.length > 0 ) {
-  // Use the Log class in here
-  for ( let one_error of all_errors ) {
-    console.log( `An error:`, one_error );
-  }
-  throw new Error( `ALKiln ran into an error when parsing the test files. See above for more details` );
-}

package/lib/utils/get_sources_paths.js

@@ -1,162 +0,0 @@
-/**
-fast_glob (fast glob)
-
-files
-session_vars
-*/
-
-
-// let log = null;
-
-// function set_log ( artifacts_path ) {
-//   log = Log( artifacts_path );
-// }
-
-// TODO: Remove after merging Log class PR
-let artifacts_path = files.make_artifacts_folder();
-session_vars.save_artifacts_path_name( artifacts_path );
-
-
-function proccess_command_line_args({ log }) {
-
-  // Discuss: Wouldn't have to use log if we moved this up.
-  const environment = { cwd: process.cwd() };
-  log.info({ type: `run`, code: `ALK0049`, pre: `environment`, data: environment });
-
-  // We'll use the user info to construct the possible paths to /sources
-  let id = session_vars.get_user_id();
-  // `project` is the name in the server docassemble "Project" page
-  let project = session_vars.get_user_project_name();
-
-  // process.argv is a list of strings of commands and args.
-  // Internal note: If using `npm run cucumber`, use `--` before
-  //    `--sources=./foo`
-  let command_line_args = require(`minimist`)( process.argv.slice(2), {
-    default: {
-      sources: [
-        `./docassemble/*/data/sources`,  // In GitHub folder
-        `/usr/share/docassemble/files/playgroundsources/${id}/${project}/*.feature`, // From playground without S3
-        `/tmp/playgroundsources/${id}/${project}/*.feature` // From playground with S3
-      ],
-    }
-  });
-
-  let processed = {};
-  processed.sources = get_sources_paths({ command_line_args });
-  let tags = get_tags({ command_line_args });
-
-  return command_line_args;
-}
-
-
-function get_sources_paths({ command_line_args }) {
-
-  // Make sure `sources` is always a list
-  let sources_list = command_line_args.sources;
-  if ( typeof command_line_args.sources === `string` ) {
-    sources_list = [ command_line_args.sources ];
-  }
-
-  // Check every path, tracking which exist and which are missing
-  let existing_paths = [];
-  let missing_paths = [];
-  for ( let path of paths ) {
-    let dirs = fast_glob.sync(
-      [ path ],
-      { onlyFiles: false, suppressErrors: true }
-    );
-
-    if ( dirs.length > 0 ) {
-      existing_paths.push( ...dirs );
-    } else {
-      missing_paths.push( path );
-    }
-  }
-
-  // If no paths were valid
-  if ( existing_paths.length <= 0 ) {
-    // session_vars.set_sources_paths( null );
-
-    // Discuss: Wouldn't have to use log if we moved this up.
-    // If we don't throw, it'll be more confusing when no tests run
-    let msg = `ALKiln can't find your "sources" folder(s). See above for details.`;
-    let code = `ALK0050`
-    log.error({ type: `run`, code: code, pre: msg });
-    // pass error up instead?
-    throw new ReferenceError(`🤕 ${ code } run ERROR: ${ msg }`);
-  }
-
-  // TODO: move this out a level
-  console.info(
-    `lightbulb ALK0042 INFO: Did find "sources" file(s) at "${ existing_paths.join('", "') }".`
-  )
-
-  // session_vars.set_sources_paths( existing_paths );
-  return existing_paths;
-}
-
-
-function get_tags({ command_line_args }) {
-  // Normalize tag expressions, if there are any Joining and splitting handles
-  //    both tags surrounded with `""` or those without `""`
-  let tags = command_line_args[`_`].join(` `).split(` `);
-  // If there was no tag expression, `tags` is ['']. Remove that item.
-  tags = tags.filter(function(entry) { return entry !== ""; })
-  if ( tags.length > 0 ) {
-    let joined_tags = '';
-    // Cucumber expects tags in boolean expressions, like (@a0 or @a1) and
-    //    @random. If we get a list of only tags, then "or" them all together
-    if (tags.every((val) => val.startsWith(`@`))) {
-      joined_tags = tags.join(` or `);
-    }
-    // If we get a list of seemingly no tags, assume they meant to use tags
-    else if (tags.every((val) => !val.startsWith(`@`))) {
-      joined_tags = tags.map((val) => `@` + val).join(` or `);
-    }
-    // If it's a mix of tags and no tags, it's probably a boolean expression!
-    else {
-      joined_tags = tags.join(` `);
-    }
-
-    // config.tags = joined_tags;
-    return joined_tags;
-  }
-
-  return null;
-}
-
-
-/**
- * get sources paths
- * generate feature files
- * try to parse everything
- * pass on the feature files?
- * 
- * When running run_cucumber, pass whether files have yet been parsed
- * Alternatively, have 2 setup steps? The second one parses before run_cucumber
- * That seems maybe better...? Have to pass on the feature files somehow, though
- * 
- * setup_server_stuff
- * get_feature_files
- * run_cucumber(with files list somehow... runtime_config?)
- * */
-
-function get_feature_paths() {
-  // Turn all the paths to the sources folders into paths to the feature files
-  let sources_paths = session_vars.get_sources_paths();
-  let feature_paths = [];
-
-  // Get all the paths for the right feature files (for cucumber to use)
-  for ( let sources_path of sources_paths ) {
-    const generators_prefix = `alkiln_random`;
-    constrained_random_tests.create({ generators_prefix, sources_path });
-    // Ignore feature files that we parsed ourselves
-    let glob = fast_glob.sync(
-      `${ sources_path }/**/*.feature`,
-      { ignore: [`${ sources_path }/${ generators_prefix }*.feature`] }
-    );
-    feature_paths.push( ...glob );
-  }
-}
-
-

package/lib/utils/parse.js

@@ -1 +0,0 @@
-parse.js

package/lib/utils/proccess_command_line_args.js

@@ -1,267 +0,0 @@
-/**
- * before everything else
- *  error if there are generator errors
- * 
- * problem:
- * 
- * because of the 3 (4) env of ALKiln, have to be able to generate and error in
- *    2 places: run_cucumber, at the start of the GitHub action
- * 
- * If there's an error, no problem (nothing will run twice)
- * 
- * Otherwise (success, warnings, etc.), generation/parsing will be run 2x. Do we
- *    care?
- * 
- * Note that generation cleans out its folder before generating.
- * 
- * Warnings are the problem if we log them at the top (not if we log them along
- *    with the other test errors/warnings).
- * 
- * Error:
- *    Action: Errors, nothing else is run
- *    Local/Playground: Errors, nothing else is run
- *    TODO: Need to generate error files?
- * 
- * Success:
- *    Action: Generate twice
- *    Local/Playground: Generate once
- * 
- * Warnings (same warnings):
- *    Action: Generate, warn?, generate, warn?, warn at end of test run
- *      Do we need a "dry run" env var?
- *    Local/Playground: Generate, warn, warn at end of test run
- * 
- * Maybe run_cucumber needs an idea of whether it's running as the first
- *    operation or as a follow-up
- * `is_followup` (general state of affairs)
- * `don't_generate` (a command of a specific action to take)
- * previous_steps = [`pre_parse`, `server_setup`/`github_playground_setup`]
- * 
- * Maybe do this completely separately and call it in different places in
- *    different processes.
- * 
- * 
- * action needs:
- *  pre-setup needs:
- *   `generate` which needs:
- *     (really??) trigger_any_parsing_errors which needs:
- *       feature files list/glob which needs:
- *        sources paths which needs
- *          command line args
- *        and
- *          prints environment PROBLEM TO REPEAT
- *          potentially errors
- *     and
- *      potentially errors
- * 
- * run_cucumber needs
- *  pre-setup
- *  (maybe) generate which needs:
- *  (maybe) trigger_any_parsing_errors etc.
- *  (maybe) trigger_any_parsing_errors which needs:
- *    feature files, etc.
- *    
- *  feature files list/glob which needs:
- *    sources paths which needs
- *      command line args
- *    and
- *      prints environment PROBLEM TO REPEAT
- *      potentially errors (not a problem. won't run if the other errors)
- *  tags needs
- *    command line args
- * 
- * ## Problem 1 - printing environment in 2 places
- * Fix: Move print environment into run_cucumber
- * 
- * ====
- * 
- * ## Problem 2 - parsing in both places.
- * Parsing errors will prevent duplicate parsing.
- * What about when there are no errors?
- * Fix: I guess we can check for parsing errors again without harm, though it'll
- *    take an extra second. Errors will only be parsed once because they'll
- *    prevent execution.
- * 
- * ## Problem 3 - generating in both places
- * Fix: flag? Or maybe re-generating isn't a problem if it doesn't take too long
- * 
- * ## Problem 4
- * Parse before generating or after generating?
- * - Can generating create files that have parsing errors without already
- *   having parsing errors? If so, parse before.
- * - Generating can create its own errors, though. So generate before?
- * - Also, errors for generated tests may be confusing because author may think,
- *    "I didn't write those tests."
- * Maybe:
- * 1. test all files before generating
- * 2. generate (and pass back errors or just throw?)
- * 3. test generated files and throw just generator process errors and parsing
- *    errors
- * 
- * All:
- * 0. Get command line args
- * 1. Get sources
- * 2. Get feature files
- * 3. Parse all current (can throw) (accumulated errors?)
- * 4. Generate (with possible errors) (can throw accumulated errors)
- * 5. Parse generated (can throw)
- * Should those throw all together? Probably not. They can affect each other.
- * 
- * run_cucumber also independently needs:
- * 1. sources
- * 2. feature files
- * */
-
-/**
- * get sources paths
- * generate feature files
- * try to parse everything
- * pass on the feature files?
- * 
- * When running run_cucumber, pass whether files have yet been parsed
- * Alternatively, have 2 setup steps? The second one parses before run_cucumber
- * That seems maybe better...? Have to pass on the feature files somehow, though
- * 
- * setup_server_stuff
- * get_feature_files
- * run_cucumber(with files list somehow... runtime_config?)
- * */
-
-/**
-fast_glob (fast glob)
-
-files
-session_vars
-*/
-
-// let log = null;
-
-// function set_log ( artifacts_path ) {
-//   log = Log( artifacts_path );
-// }
-
-// TODO: Remove after merging Log class PR
-let artifacts_path = files.make_artifacts_folder();
-session_vars.save_artifacts_path_name( artifacts_path );
-
-function get_command_line_args({ log }) {
-
-  // We'll use the user info to construct the possible paths to /sources
-  let id = session_vars.get_user_id();
-  // `project` is the name in the author's server's docassemble "Project" page
-  let project = session_vars.get_user_project_name();
-
-  // process.argv is a list of strings of commands and args.
-  // Internal note: If using `npm run cucumber`, use `--` before
-  //    `--sources=./foo`
-  let command_line_args = require(`minimist`)( process.argv.slice(2), {
-    default: {
-      sources: [
-        `./docassemble/*/data/sources`,  // In GitHub folder
-        `/usr/share/docassemble/files/playgroundsources/${id}/${project}/*.feature`, // From playground without S3
-        `/tmp/playgroundsources/${id}/${project}/*.feature` // From playground with S3
-      ],
-    }
-  });
-
-  // let processed = {};
-  // processed.sources = get_sources_paths({ command_line_args });
-  // let tags = get_tags({ command_line_args });
-
-  return command_line_args;
-}
-
-
-function get_sources_paths({ command_line_args }) {
-
-  // Make sure `sources` is always a list
-  let sources_list = command_line_args.sources;
-  if ( typeof command_line_args.sources === `string` ) {
-    sources_list = [ command_line_args.sources ];
-  }
-
-  // Check every path, tracking which exist and which are missing
-  let existing_paths = [];
-  let missing_paths = [];
-  for ( let path of paths ) {
-    let dirs = fast_glob.sync(
-      [ path ],
-      { onlyFiles: false, suppressErrors: true }
-    );
-
-    if ( dirs.length > 0 ) {
-      existing_paths.push( ...dirs );
-    } else {
-      missing_paths.push( path );
-    }
-  }
-
-  // If no paths were valid
-  if ( existing_paths.length <= 0 ) {
-    // session_vars.set_sources_paths( null );
-
-    // Discuss: Wouldn't have to use log if we moved this up.
-    // If we don't throw, it'll be more confusing when no tests run
-    let msg = `ALKiln can't find your "sources" folder(s). See above for details.`;
-    let code = `ALK0050`
-    log.error({ type: `run`, code: code, pre: msg });
-    // pass error up instead?
-    throw new ReferenceError(`🤕 ${ code } run ERROR: ${ msg }`);
-  }
-
-  // TODO: move this out a level
-  console.info(
-    `lightbulb ALK0042 INFO: Did find "sources" file(s) at "${ existing_paths.join('", "') }".`
-  )
-
-  // session_vars.set_sources_paths( existing_paths );
-  return existing_paths;
-}
-
-
-function get_tags({ command_line_args }) {
-  // Normalize tag expressions, if there are any Joining and splitting handles
-  //    both tags surrounded with `""` or those without `""`
-  let tags = command_line_args[`_`].join(` `).split(` `);
-  // If there was no tag expression, `tags` is ['']. Remove that item.
-  tags = tags.filter(function(entry) { return entry !== ""; })
-  if ( tags.length > 0 ) {
-    let joined_tags = '';
-    // Cucumber expects tags in boolean expressions, like (@a0 or @a1) and
-    //    @random. If we get a list of only tags, then "or" them all together
-    if (tags.every((val) => val.startsWith(`@`))) {
-      joined_tags = tags.join(` or `);
-    }
-    // If we get a list of seemingly no tags, assume they meant to use tags
-    else if (tags.every((val) => !val.startsWith(`@`))) {
-      joined_tags = tags.map((val) => `@` + val).join(` or `);
-    }
-    // If it's a mix of tags and no tags, it's probably a boolean expression!
-    else {
-      joined_tags = tags.join(` `);
-    }
-
-    // config.tags = joined_tags;
-    return joined_tags;
-  }
-
-  return null;
-}
-
-function get_feature_paths() {
-  // Turn all the paths to the sources folders into paths to the feature files
-  let sources_paths = session_vars.get_sources_paths();
-  let feature_paths = [];
-
-  // Get all the paths for the right feature files (for cucumber to use)
-  for ( let sources_path of sources_paths ) {
-    const generators_prefix = `alkiln_random`;
-    constrained_random_tests.create({ generators_prefix, sources_path });
-    // Ignore feature files that we parsed ourselves
-    let glob = fast_glob.sync(
-      `${ sources_path }/**/*.feature`,
-      { ignore: [`${ sources_path }/${ generators_prefix }*.feature`] }
-    );
-    feature_paths.push( ...glob );
-  }
-}