@suffolklitlab/alkiln 5.14.0 → 5.15.0

package/lib/docassemble/server_install.js

@@ -56,8 +56,6 @@ const server_install = async () => {
 session_vars.validateEnvironment();
 
 // 2. Prepare logs
-// Local devs: This will be separate from your test paths
-// unless you pass a `path` argument into the cucumber run command
 const argv = require(`minimist`)(process.argv.slice(2));
 const log = new Log({ path: argv.path, context, });
 

package/lib/docassemble/setup.js

@@ -54,7 +54,7 @@ const setup = async () => {
       + `dainstall this package on your server. See above for more details.`;
     log.throw({ code: `ALK0047`, context,
       before: `☝️ ☝️ ☝️  Error data ☝️ ☝️ ☝️\n`,
-      error: `Error while installing project` },
+      error: new Error(`Error while installing project on your docassemble server during GitHub+You™ tests`) },
       install_err_msg
     );
   }
@@ -68,8 +68,6 @@ const setup = async () => {
 session_vars.validateEnvironment();
 
 // 2. Prepare logs
-// Local devs: This will be separate from your test paths
-// unless you pass a `path` argument into the cucumber run command
 const argv = require(`minimist`)(process.argv.slice(2));
 const log = new Log({ path: argv.path, context, });
 

package/lib/docassemble/takedown.js

@@ -40,8 +40,8 @@ const takedown = async () => {
 session_vars.validateEnvironment();
 
 // 2. Prepare logs
-// Local devs: This will be separate from your test artifacts paths
-// unless you pass a `path` argument into the `cucumber` run command
+// Local devs: This will be separate from your test artifacts paths unless you
+//    pass a `path` argument into the `cucumber` run command
 const argv = require(`minimist`)( process.argv.slice(2) );
 const log = new Log({ path: argv.path, context, });
 

package/lib/globals.js

@@ -0,0 +1,10 @@
+let globals = {
+  // File name prefix ALKiln can use to identify random answer generator files
+  generators_prefix: `alkiln_random`,
+  generated_files_folder_name: `_alkiln_generated`,
+}
+
+module.exports = globals;
+
+// Discuss: Would this be clearer as a config file instead? If not, change name
+// to `constants`?

package/lib/run_cucumber.js

@@ -1,21 +1,37 @@
 #!/usr/bin/env node
 
 const fs = require('fs');
+const fast_glob = require(`fast-glob`);
 const path = require(`path`);
 const cucumber_api = require('@cucumber/cucumber/api');
 
+const globals = require(`./globals`);
 const Log = require('./utils/Log');
 const session_vars = require('./utils/session_vars');
+const set_sources_paths = require(`./utils/set_sources_paths`);
 
 const SUMMARY_FILENAME = `cucumber-report.txt`;
 
 
-function build_config( command_args ) {
+function build_config() {
+  /** Use the command line arguments to build the cucumberjs config object.
+   * 
+   * @param {string?} - Arguments passed to the command line.
+   * 
+   * @returns {object} - cucumberjs config object
+   * */
   // 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 = [];
-  for ( let source of sources_paths ) {
-    feature_paths.push( `${ source }/*.feature` );
+
+  // Get all the paths for the right feature files (for cucumber to use)
+  for ( let sources_path of sources_paths ) {
+    let glob = fast_glob.sync(
+      `${ sources_path }/**/*.feature`,
+      // Ignore "generator" feature files that we used to generate actual tests
+      { ignore: [`${ sources_path }/${ globals.generators_prefix }*.feature`] }
+    );
+    feature_paths.push( ...glob );
   }
 
   const config = {
@@ -26,9 +42,10 @@ function build_config( command_args ) {
     retry: 1,
   }
 
+  const cli_args = require(`minimist`)( process.argv.slice(2) );
   // Normalize tag expressions, if there are any
   // Joining and splitting handles both tags surrounded with `""` or those without `""`
-  let tags = command_args[`_`].join(` `).split(` `);
+  let tags = cli_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 ) {
@@ -56,46 +73,12 @@ function build_config( command_args ) {
 
 async function main() {
   /** Create the cucumber config, run the tests, create and
-  *   manipluate the output. */
+  *   manipulate the output. */
 
   const environment = { cwd: process.cwd() };
   log.info({ code: `ALK0049`, context: `pre_run environment` },
     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.
-  // If using `npm run cucumber` (as opposed to the bin commands),
-  // use `--` before `--sources=./foo`
-  const argv = 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
-      ],
-    }
-  });
-  
-  // Make sure `sources` is always a list
-  let sources_list = argv.sources;
-  if ( typeof argv.sources === `string` ) {
-    sources_list = [ argv.sources ];
-  }
-
-  let one_dir_exists = session_vars.set_sources_paths( sources_list );
-  if ( !one_dir_exists ) {
-    // If we don't throw, it'll be more confusing when no tests run
-    log.throw({ code: `ALK0050`, context: `pre_run`,
-      error: new ReferenceError(
-        `ALKiln can't find your "sources" folder(s). See above for details.`
-      ),
-    });
-  }
   
   const { runConfiguration } = await cucumber_api.loadConfiguration({
     provided: build_config( argv ),
@@ -122,9 +105,9 @@ async function main() {
 
   /** Write to files.
    *
-   * Note: Don't add to the purely report-focused files. Those are files where
-   *    authors can focus on the info we give them, which they often miss in
-   *    the GitHub action.
+   * Note: Avoid adding to the purely report-focused files. Those are files
+   *    where authors can focus on the info we give them, which they often miss
+   *    in the GitHub action.
    */
 
   if ( success ) {
@@ -134,7 +117,7 @@ async function main() {
   } else {
     // Don't want to throw error here, so don't pass error object
     log.warn({ code: `ALK0055`, context: `post_run`, },
-      `The tests ran into something unexpected. Look above for more details.`
+      `The tests ran into something unexpected. See warnings and errors above.`
     );
   }
   // Custom exit code. May overlap with other systems.
@@ -142,14 +125,12 @@ async function main() {
   const exitCode = success ? 0 : 50;
   process.exitCode = exitCode;
 
-  // This is hardcoded information from `provide_config` above.
-  // This code isn't used for anything other than detecting and removing color codes.
   let summary_file_name = SUMMARY_FILENAME;
   fs.readFile(summary_file_name, 'utf8', (read_error, text) => {
     if ( read_error ) {
       // Something else will probably show an error that's more relevant
       log.warn({ code: `ALK0056`, context: `post_run error`, },
-        `Failed to read cucumber report`, read_error
+        `Failed to read the report of the 3rd party library, cucumberjs. There may be more information above or below.`, read_error
       );
       return;
     }
@@ -184,7 +165,13 @@ async function main() {
         try {
           fs.readFileSync(`${ log.path }/${ log.unexpected_filename }`);  // Does it have contents?
           fs.appendFileSync(`${ log.path }/${ log.unexpected_filename }`, `\n\n\n\n\n` );
-        } catch ( ignore_err ) { /* Missing unexpected file is ok */ }
+        } catch ( ignore_err ) {
+          /* Missing "unexpected results" file is ok */
+        }
+
+        // TODO: Is this meant to write to the debug file or is this debug info
+        // really supposed to be in the "unexpected results" file? Or are these
+        // comments old?
 
         // Add the heading for debug content
         fs.appendFileSync( `${ log.path }/${ log.unexpected_filename }`,
@@ -198,8 +185,8 @@ async function main() {
 
     } catch ( writing_cucumber_error ) {
       let code = `ALK0182`;
-      let context = `post_run error`
-      let msg = `Something probably went wrong earlier. Look above for more details. Skipped writing to ${ log.path }/${ log.debug_log_filename }.`;
+      let context = `post_run`
+      let msg = `Something probably went wrong earlier. See warnings and errors above. Skipped writing to ${ log.path }/${ log.debug_log_filename }.`;
       try {
         log.warn({ code, context, }, msg, writing_cucumber_error );
       } catch ( all_writing_error ) {
@@ -223,10 +210,10 @@ session_vars.validateEnvironment();
 // If using `npm run cucumber` (as opposed to the bin commands),
 // use `--` before `--sources=./foo`
 const argv = require(`minimist`)( process.argv.slice(2) );
-// The artifacts folder might be getting created for the first
-// time right here. The tests themselves should avoid creating
-// their own file.
 const log = new Log({ path: argv.path, context: `run` });
 
-// 3. run
+// 3. Prep the sources paths to find .feature files
+let sources_paths = set_sources_paths({ log });
+
+// 4. run
 main();

package/lib/scope.js

@@ -2129,6 +2129,38 @@ module.exports = {
     // await scope.page.mouse.move(1, 1);  // Too big? Wait a while before drawing?
     await scope.page.mouse.up();
   },
+  
+  get_page_id: async function ( scope ) {
+    /** Return the current page's docassemble `question` block ID or `null`
+     *
+     * Note: The ID is already sanitized by docassemble.
+     *
+     * @param {object} scope - Tests state object
+     * @param {object} scope.page - puppeteerjs page object
+     *
+     * @returns {null | string}
+     * */
+    let question_id_match = await scope.page.$eval(`body`, function (elem) {
+      return elem.className.match(/question-([^ ]+)/);
+    });
+    if ( question_id_match !== null ) {
+      return question_id_match[ 1 ];
+    }
+    return null;
+  },
+
+  to_docassemble_sanitized_id: function ( risky_id ) {
+    /** Return a version of `risky_id` that's sanitized the same way docassemble
+     *    sanitizes its IDs to turn them into HTML class names in python:
+     *      re.sub(r'[^A-Za-z0-9]+', '-', interview_status.question.id.lower())
+     *    (reference needed)
+     *
+     * @param {string} risky_id - The un-sanitized id
+     *
+     * @returns {string} - Sanitized id
+     * */
+    return risky_id.toLowerCase().replace(/[^A-Za-z0-9]+/g, '-');
+  },
 
   examinePageID: async function ( scope, question_id = '' ) {
     /* Looks for a sanitized version of the question id as it's written