@suffolklitlab/alkiln 5.13.4 → 5.15.0

package/tests/unit_tests/log.test.js

@@ -169,6 +169,10 @@ describe(`An instance of log`, function () {
   })
 
   describe(`given totally custom metadata`, function () {
+    let error;
+    before(function() {
+      error = new Error(`custom_SUCCESS_error`);
+    });
     it(`.success overwrites the right values`, async function() {
       let options = {
         before: `custom_SUCCESS_before~`,
@@ -176,17 +180,22 @@ describe(`An instance of log`, function () {
         icon: `custom_SUCCESS_icon`,
         code: `custom_SUCCESS_code`,
         context: `custom_SUCCESS_context`,
+        // Discuss: too complex to test right now? Test separately? Test
+        //     unexpected file contents?
+        error,
         do_throw: true,
       };
       let returned = log.success( options, `custom_SUCCESS_log` );
       // Note the intentional lack of space with `before`
       expect( returned ).to.include(`custom_SUCCESS_before~🌈 custom_SUCCESS_code custom_SUCCESS_context SUCCESS`);
       expect( returned ).to.include(`custom_SUCCESS_log`);
+      expect( returned ).to.include( error.stack );
       expect( returned ).to.not.include(`Skip`);
     });
     it(`.success stores the right text in the debug file`, async function() {
       expect_debug_file_to_include(`custom_SUCCESS_before~🌈 custom_SUCCESS_code custom_SUCCESS_context SUCCESS`);
       expect_debug_file_to_include(`custom_SUCCESS_log`);
+      expect_debug_file_to_include( error.stack );
       expect_debug_file_to_not_include(`Skip`);
     });
   })
@@ -313,10 +322,10 @@ describe(`An instance of log`, function () {
       } catch ( error ) {
         error_to_test = error;
       }
-      // Note: No metadata is included in the error so that we don't have
-      // to re-throw every error that comes in and they can keep their nice
-      // stack traces.
-      // Note: Also excludes logs from error message
+      // Note: No metadata is included in the error so that we don't have to
+      // re-throw every error that comes in (in order to add the metadata) and
+      // they can keep their nice stack traces. Note: Also excludes logs from
+      // error message
       expect( error_to_test.message ).to.include(`CUSTOM_THROW_ERROR_STRING`);
       expect( error_to_test.stack ).to.include(`at Log.throw`);
       expect( error_to_test.stack ).to.not.include(`Skip`);
@@ -435,47 +444,14 @@ describe(`An instance of log`, function () {
   })
 
   describe(`with a value for \`error\` and no throw with .debug()`, function () {
-    it(`returns a value that excludes the error and the error stack`, async function() {
+    it(`returns a value that includes the error and the error stack, but does not throw`, async function() {
       let options = { error: `custom_DEBUG_non_thrown_error`, };
       let returned = log.debug( options );
-      expect( returned ).to.not.include(`custom_DEBUG_non_thrown_error`);
+      expect( returned ).to.include(`custom_DEBUG_non_thrown_error`);
       expect( returned ).to.not.include(`at Log.throw`);
     });
-    it(`excludes the error in the debug file`, async function() {
-      expect_debug_file_to_not_include(`custom_DEBUG_non_thrown_error`);
-    });
-    it(`stores the warning code in the debug file`, async function() {
-      expect_debug_file_to_include(`ALK0223`);
-    });
-    it(`stores the text 'Skip' in the debug file`, async function() {
-      expect_debug_file_to_include(`Skip`);
-    });
-    it(`excludes the error in the unexpected output file`, async function() {
-      expect_unexpected_output_file_to_not_include(`custom_DEBUG_non_thrown_error`);
-    });
-    it(`stores the warning code in the unexpected output file`, async function() {
-      expect_unexpected_output_file_to_include(`ALK0223`);
-    });
-    it(`stores the text 'Skip' in the unexpected output file`, async function() {
-      expect_unexpected_output_file_to_include(`Skip`);
-    });
-  })
-
-  describe(`given an error without a do_throw`, function () {
-    it(`.debug saves a warning and ignores the error`, async function() {
-      let options = {
-        error: `Illegal error`,
-        do_throw: false,
-      };
-      let returned = log.debug( options, `DEBUG log with illegal error` );
-      expect( returned ).to.include(`DEBUG log with illegal error`);
-      expect( returned ).to.not.include(`Illegal error`);
-      // To not include `Illegal error`
-    });
-    it(`.debug stores and excludes the right text in the debug file`, async function() {
-      expect_debug_file_to_include(`ALK0223`);
-      expect_debug_file_to_include(`DEBUG log with illegal error`);
-      expect_debug_file_to_not_include(`Illegal error`);
+    it(`includes the error in the debug file`, async function() {
+      expect_debug_file_to_include(`custom_DEBUG_non_thrown_error`);
     });
   })
 

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 );
-  }
-}