@suffolklitlab/alkiln 5.1.0-sources-5 → 5.1.0-sources-6

package/CHANGELOG.md

@@ -41,7 +41,9 @@ Format:
 ### Internal
 - 
 -->
-<!-- ## [Unreleased] -->
+## [Unreleased]
+### Added
+- Can now take the location of the "sources" folder or folders as an argument in the command line. The formats are `npm run cucumber @tags -- --sources=./foo` and `alkiln-run @tags --sources=./foo`.
 
 ## [5.1.0] - 2023-08-12
 ### Added

package/lib/run_cucumber.js

@@ -6,18 +6,28 @@ const session_vars = require('./utils/session_vars');
 
 const cucumber_api = require('@cucumber/cucumber/api');
 
-function build_config(argv) {
-  // The default provided config
-  const provided_config = {
+function build_config( command_args ) {
+  // 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` );
+  }
+
+  const config = {
     publishQuiet: true,
     require: `./lib/index.js`,
     format: [`progress`, `summary:cucumber-report.txt`],
-    paths: [`${ argv.sources }/*.feature`],
+    paths: feature_paths,
     retry: 1,
   }
 
-  let tags = argv[`_`];
-  console.log(`tags: ${JSON.stringify(tags)}, ${tags.length}`);
+  // Normalize tag expressions, if there are any
+  let tags = command_args[`_`];
+  // Avoid breaking old versions of ALKilnInThePlayground
+  if ( tags.length === 0 && session_vars.get_origin() === `playground` ) {
+    tags = session_vars.get_tags();
+  }
   if (tags.length > 0) {
     let joined_tags = '';
     // Cucumber expects tags in boolean expressions, like (@a0 or @a1) and @random.
@@ -34,14 +44,10 @@ function build_config(argv) {
       joined_tags = tags.join(` `);
     }
 
-    provided_config.tags = joined_tags;
-  } //else {
-  //   provided_config.tags = ''
-  // }  // end if there are tags
-
-  console.log(`provided_config.tags: ${provided_config.tags}`);
+    config.tags = joined_tags;
+  }
 
-  return provided_config;
+  return config;
 };  // Ends build_config()
 
 
@@ -51,29 +57,31 @@ function build_config(argv) {
   const environment = { cwd: process.cwd() };
   console.log("alkiln-run: environment: %o", environment);
 
-  console.log(`command: ${ process.argv }`);
-
   // process.argv is a list of strings of commands and args.
+  // If using `npm run cucumber`, use `--` before `--sources=./foo`
   let argv = require(`minimist`)( process.argv.slice(2), {
     default: {
       // Testing from GitHub. TODO: Do we want to allow multiple sources paths?
-      sources: `./docassemble/*/data/sources`,
+      sources: [ `./docassemble/*/data/sources` ],
       // From playground: `/usr/share/docassemble/files/playgroundsources/<user_id>/<project>/*.feature`
       // From playground with S3: `/tmp/playgroundsources/<user_id>/<project>/*.feature`
     }
   });
+  
+  // Make sure `sources` is always a list
+  let sources_list = argv.sources;
+  if ( typeof argv.sources === `string` ) {
+    sources_list = [ argv.sources ];
+  }
 
-  let dir_exists = session_vars.set_sources_path( argv.sources );
-  if ( !dir_exists ) {
+  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
-    throw new ReferenceError( `No folder exists at "${ argv.sources }", where ALKiln looks for your \`.feature\` files.`)
+    throw new ReferenceError( `ALKiln ERROR: ALKiln can't find your "sources" folder(s). See above for details.`);
   }
-
-  const provided_config = build_config( argv );
-  console.log(`provided_config: ${provided_config}`);
-
+  
   const { runConfiguration } = await cucumber_api.loadConfiguration({
-    provided: provided_config
+    provided: build_config( argv ),
   }, environment);
 
   console.log("alkiln-run: runConfiguration: %o", runConfiguration);

package/lib/scope.js

@@ -1794,16 +1794,23 @@ module.exports = {
       return false;  // The row wasn't used
     }
 
-    let dir = session_vars.get_sources_path();
+    let sources_dirs = session_vars.get_sources_paths();
     // Get the full paths of all the existing files
     let paths = [];
     let missing_files = [];  // For any user warnings
     for ( let name of uploads_names ) {
+
       let trimmed_name = name.trim();
-      let matching_paths = fg.sync(
-        [ `${ dir }/${ trimmed_name }` ],
-        { suppressErrors: true }
-      );
+      let matching_paths = [];
+      // Look for the file in all "sources" folders
+      for ( let one_dir of sources_dirs ) {
+        let new_paths = fg.sync(
+          [ `${ one_dir }/${ trimmed_name }` ],
+          { suppressErrors: true }
+        );
+        matching_paths.push( ...new_paths );
+      }
+
       if ( matching_paths.length === 0 ) {
         missing_files.push( trimmed_name );
       } else {
@@ -1814,7 +1821,7 @@ module.exports = {
     if ( missing_files.length > 0 ) {
       await scope.addToReport( scope, {
         type: `warning`,
-        value: `ALKiln could not find "${ missing_files.join('", "') }" in "${ dir }".`
+        value: `ALKiln could not find "${ missing_files.join('", "') }" in the folder(s) at "${ sources_dirs.join('", "') }".`
       });
     }
 
@@ -2046,7 +2053,7 @@ module.exports = {
       }
       if ( num_unused_rows > 0 ) {
         let { id } = await scope.examinePageID( scope, 'none to match' );
-        let msg = `Missing variable or variables on page "${id}"`;
+        let msg = `Error on page "${id}". See screenshot and see text above for more details.`;
         await scope.addToReport(scope, { type: `error`, value: msg });
         expect( num_unused_rows, msg ).to.equal( 0 );
       }

package/lib/utils/session_vars.js

@@ -38,6 +38,14 @@ session_vars.get_origin = function () {
 };
 session_vars.get_user_project_name = function () { return process.env._PROJECT_NAME || null; };
 session_vars.get_user_id = function () { return process.env._USER_ID || null; };
+// Avoid breaking old versions of ALKilnInThePlayground
+session_vars.get_tags = function () {
+  if ( process.env._TAGS ) {
+    return process.env._TAGS.split(` `);
+  } else {
+    return [];
+  }
+};
 
 // More complex logic
 session_vars.get_server_reload_timeout = function () {
@@ -204,37 +212,59 @@ session_vars.get_artifacts_path_name = function () {
   }
 };  // Ends get_artifacts_path_name()
 
-session_vars.set_sources_path = function ( path ) {
-  /** Returns whether the given path exists or not. If it does, store
-  *   the path to the sources folder. Can be used for getting, e.g
-  *   .feature files, files to upload, etc. May be annoying repetition
-  *   for some local testing.
+session_vars.set_sources_paths = function ( paths ) {
+  /** Returns whether at least one of the given path exists. Store
+  *   a list of the existing paths. Warn of any missing paths. Can be
+  *   used for getting, e.g .feature files, files to upload, etc.
   * 
-  * Our code should ensure this gets run before cucumber gets triggered.
+  * Our code should ensure this gets run before cucumber tests get triggered.
   * 
-  * @returns bool */
+  * @param paths { [str] } List of paths to the 'sources' folder.
+  * 
+  * @returns bool
+  */
 
-  let sources = fg.sync(
-    [ path ],
-    { onlyFiles: false, suppressErrors: true }
-  );
+  // Check every path, tracking which exist and which are missing
+  let existing_paths = [];
+  let missing_paths = [];
+  for ( let path of paths ) {
+    let dirs = fg.sync(
+      [ path ],
+      { onlyFiles: false, suppressErrors: true }
+    );
+
+    if ( dirs.length > 0 ) {
+      existing_paths.push( ...dirs );
+    } else {
+      missing_paths.push( path );
+    }
+  }
 
-  if ( sources.length > 0 ) {
-    session_vars._sources_path = path;
-    return true;
-  } else {
-    session_vars._sources_path = null;
+  // Warn about missing paths
+  if ( missing_paths.length > 0 ) {
+    console.warn(
+      `ALKiln WARNING: ALKiln can't find folders at "${ paths.join(", ") }".`
+    );
+  }
+
+  // If no paths were valid
+  if ( existing_paths.length <= 0 ) {
+    session_vars._sources_paths = null;
     return false;
   }
+
+  // Otherwise, store valid paths
+  session_vars._sources_paths = existing_paths;
+  return true;
 };
 
-session_vars.get_sources_path = function () {
+session_vars.get_sources_paths = function () {
   /** Get the "sources" folder path. Should never be undefined during
   *   a run of the test. run_cucumber.js should make sure it has
   *   a default value.
   * 
   * @returns str || null */
-  return session_vars._sources_path;
+  return session_vars._sources_paths;
 };
 
 session_vars.validateEnvironment = function() {

package/package.json

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