@suffolklitlab/alkiln 5.0.2 → 5.1.0-sources-1

package/CHANGELOG.md

@@ -37,9 +37,19 @@ Format:
 
 ### Security
 - 
+
+### Internal
+- 
 -->
 <!-- ## [Unreleased] -->
 
+## [5.1.0] - 2023-08-12
+### Added
+- Comboboxes - can now fill in comboboxes on the latest Docassemble.
+
+### Fixed
+- Filling out a hidden field right after a date field triggered the date's calendar popup, which I believe ate the input for the next visible field.
+
 ## [5.0.2] - 2023-07-20
 ### Fixed
 - Accept `SERVER_RELOAD_TIMEOUT_SECONDS` as an env var input in GitHub.
@@ -89,6 +99,10 @@ Format:
     server
 - Update dependencies. See [#727](https://github.com/SuffolkLITLab/ALKiln/pull/727).
 
+### Internal
+- added a test for multiline json values (only ones set by code not by user input)
+- added an internal section to the change log
+
 ## [4.11.1] - 2023-03-21
 ### Changed
 - Get error data from server errors

package/action.yml

@@ -5,15 +5,6 @@ inputs:
   SERVER_URL:
     description: 'The url of your docassemble server. This should be in your GitHub SECRETS or the SECRETS of your org.'
     required: true
-  PLAYGROUND_EMAIL:
-    description: 'The email of your docassemble testing account. This should be in your GitHub SECRETS or the SECRETS of your org.'
-    required: true
-  PLAYGROUND_PASSWORD:
-    description: 'The password of your docassemble testing account. This should be in your GitHub SECRETS or the SECRETS of your org.'
-    required: true
-  PLAYGROUND_ID:
-    description: 'The id of your docassemble testing account. This should be in your GitHub SECRETS or the SECRETS of your org.'
-    required: true
   DOCASSEMBLE_DEVELOPER_API_KEY:
     description: 'API key of the testing account with developer permissions on your docassemble server.'
     required: true
@@ -45,9 +36,6 @@ runs:
         echo "REPO_URL=${{ github.server_url }}/${{ github.repository }}" >> $GITHUB_ENV
         echo "BRANCH_PATH=${{ github.ref }}" >> $GITHUB_ENV
         echo "BASE_URL=${{ inputs.SERVER_URL }}" >> $GITHUB_ENV
-        echo "PLAYGROUND_EMAIL=${{ inputs.PLAYGROUND_EMAIL }}" >> $GITHUB_ENV
-        echo "PLAYGROUND_PASSWORD=${{ inputs.PLAYGROUND_PASSWORD }}" >> $GITHUB_ENV
-        echo "PLAYGROUND_ID=${{ inputs.PLAYGROUND_ID }}" >> $GITHUB_ENV
         echo "DOCASSEMBLE_DEVELOPER_API_KEY=${{ inputs.DOCASSEMBLE_DEVELOPER_API_KEY }}" >> $GITHUB_ENV
         echo "ALKILN_VERSION=${{ inputs.ALKILN_VERSION }}" >> $GITHUB_ENV
         echo "MAX_SECONDS_FOR_SETUP=${{ inputs.MAX_SECONDS_FOR_SETUP }}" >> $GITHUB_ENV

package/lib/run_cucumber.js

@@ -6,64 +6,87 @@ const session_vars = require('./utils/session_vars');
 
 const cucumber_api = require('@cucumber/cucumber/api');
 
-(async function main() {
-  let argv = process.argv;
-
-  const environment = { cwd: process.cwd() };
-  console.log("alkiln-run: environment: %o", environment);
+function build_config(argv) {
+  // The default provided config
   const provided_config = {
-    "publishQuiet": true,
-    "require": "./lib/index.js",
-    "format": ["progress", "summary:cucumber-report.txt"],
-    "paths": ["docassemble/*/data/sources/*.feature"],
-    "retry": 1,
+    publishQuiet: true,
+    require: `./lib/index.js`,
+    format: [`progress`, `summary:cucumber-report.txt`],
+    paths: [`${ argv.sources }/*.feature`],
+    retry: 1,
   }
 
-
-  // If they're running it from an interview on their server instead of from GitHub
-  if ( session_vars.get_origin() === `playground` ) {
-    provided_config.paths.push(`/usr/share/docassemble/files/playgroundsources/${session_vars.get_user_id()}/${session_vars.get_user_project_name()}/*.feature`);
-    // For S3
-    provided_config.paths.push(`/tmp/playgroundsources/${session_vars.get_user_id()}/${session_vars.get_user_project_name()}/*.feature`);
-  }
-
-  let tags = argv.slice(2);
-  if ( session_vars.get_origin() === `playground` ) {
-    tags = session_vars.get_tags();
-  }
+  let tags = argv[`_`];
+  // if ( 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.
     // 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 (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 ');
+    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(' ');
+      joined_tags = tags.join(` `);
     }
 
     provided_config.tags = joined_tags;
   }  // end if there are tags
 
+  return provided_config;
+};  // Ends build_config()
+
+
+(async function main() {
+  /** Create the cucumber config, run the tests, create and
+  *   manipluate the output. */
+  const environment = { cwd: process.cwd() };
+  console.log("alkiln-run: environment: %o", environment);
+
+  // process.argv is a list of strings of commands and args.
+  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`,
+      // From playground: `/usr/share/docassemble/files/playgroundsources/<user_id>/<project>/*.feature`
+      // From playground with S3: `/tmp/playgroundsources/<user_id>/<project>/*.feature`
+
+      // // Installed in a user Playground
+      // url: `<server>/interview?new_session=1&i=docassemble.playground<user_id><project>%3A`,
+      // // server install: `<server>/interview?new_session=1&i=docassemble.<package>%3Adata/questions/`
+    }
+  });
+
+  let dir_exists = session_vars.set_sources_path( argv.sources );
+  if ( !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.`)
+  }
+
+  const provided_config = build_config( argv );
+
   const { runConfiguration } = await cucumber_api.loadConfiguration({
     provided: provided_config
   }, environment);
+
   console.log("alkiln-run: runConfiguration: %o", runConfiguration);
+
   var path = require('path');
   var codeDir = path.dirname(require.main.filename);
+  console.log("alkiln-run: working directory: %o", codeDir);
   const support = await cucumber_api.loadSupport({ support: {
-    requireModules: [`${ codeDir }/index.js`],
-    requirePaths: [ `${ codeDir }/index.js`],
+    requireModules: [ `${ codeDir }/index.js` ],
+    requirePaths: [ `${ codeDir }/index.js` ],
     importPaths: [],
   }, sources: {paths: []}}, environment);
 
-  console.log("alkiln-run: working directory: %o", codeDir);
   console.log(`\n\n`);
 
   const { success } = await cucumber_api.runCucumber({...runConfiguration, support});
@@ -86,6 +109,6 @@ const cucumber_api = require('@cucumber/cucumber/api');
 
     // Put it in the correct file in the correct folder
     let artifacts_path = session_vars.get_artifacts_path_name();
-    fs.appendFileSync( `${ artifacts_path}/${ log.debug_log_file }`, data);
+    fs.appendFileSync( `${ artifacts_path }/${ log.debug_log_file }`, data);
   });
 })();

package/lib/scope.js

@@ -998,6 +998,11 @@ module.exports = {
         }
       }
 
+      if ( !encoded_name ) {
+        // Some fields, like comboboxes, have a weird var name setup
+        encoded_name = $node.attr( `id` );
+      }
+
       // ====================
       // Table rows
       // ====================
@@ -1472,6 +1477,11 @@ module.exports = {
    */
     let row_used = null;
 
+    // Skip hidden fields right away. When a date field was above a combobox,
+    // interacting with the hidden field caused the date field to open its
+    // calendar which blocked input to the combobox
+    if ( field.type === `hidden` ) { return row_used; }
+
     let matching_input_rows = await scope.getMatchingRows( scope, { var_data, field });
 
     // Nothing to set if there are no matching table rows
@@ -1486,6 +1496,8 @@ module.exports = {
 
     let handle = await scope.get_handle_from_field( scope, { field: field });
 
+    // After each previous input, figure out if this input is (now/still) disabled
+    // TODO: Consider testing for disabled this before we get the matching row
     let disabled = await handle.evaluate(( elem )=> {
       // da's header covers the top of the section containing the fields which means
       // sometimes it blocks nodes from clicks. Scroll item to the bottom instead.
@@ -1775,73 +1787,34 @@ module.exports = {
     // allow a typo where someone forgot to include a space after a comma.
     let uploads_names = answer.split(`,`);
     if ( uploads_names.length === 0 ) {
-      await scope.addToReport( scope, {
-        type: `error`,
-        value: `Your list of files to upload is empty.`
-      });
-      return false;  // The row wasn't used
-    }
-
-    let dirs = [];
-    if ( session_vars.get_origin() === `playground` ) {
-      let files_playground = fg.sync(
-        [ `/usr/share/docassemble/files/playgroundsources/${session_vars.get_user_id()}/${session_vars.get_user_project_name()}` ],
-        { onlyFiles: false, suppressErrors: true }
-      );
-      let files_s3 = fg.sync(
-        [ `/tmp/playgroundsources/${session_vars.get_user_id()}/${session_vars.get_user_project_name()}` ],
-        { onlyFiles: false, suppressErrors: true }
-      );
-
-      dirs = files_playground.concat( files_s3 );
-    } else {
-      dirs = fg.sync(
-        [ `**/docassemble/**/data/sources` ],
-        { onlyFiles: false, suppressErrors: true }
-      );
-    }
-
-    if ( session_vars.get_debug() ) {
-      console.log( `All discovered dirs to upload from:`, dirs );
-    }
-
-    // Make sure sources directory exists and has files in it
-    if ( dirs.length === 0 ) {
       await scope.addToReport( scope, {
         type: `warning`,
-        value: `The test files need to be in the "sources" directory, `
-          + `but ALKiln couldn't find the directory or it was empty.`
+        value: `Your list of files to upload is empty.`
       });
       return false;  // The row wasn't used
     }
 
-    // Get the full paths of all the files
-    let dir = null;
+    let dir = session_vars.get_sources_path();
+    // 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 = [];
-
-      for ( let one_dir of dirs ) {
-        // accumulate all matching paths
-        let new_paths = fg.sync([ `${ one_dir }/${ trimmed_name }` ]);
-        matching_paths.push( ...new_paths );
-      }  // ends for each dir
-
+      let matching_paths = fg.sync(
+        [ `${ dir }/${ trimmed_name }` ],
+        { suppressErrors: true }
+      );
       if ( matching_paths.length === 0 ) {
         missing_files.push( trimmed_name );
       } else {
         paths.push( ...matching_paths );
       }
-
     }  // ends for each file
 
     if ( missing_files.length > 0 ) {
       await scope.addToReport( scope, {
         type: `warning`,
-        value: `ALKiln could not find "${ missing_files.join('", "') }" in any of these folders: "${ dirs.join('", "') }".`
+        value: `ALKiln could not find "${ missing_files.join('", "') }" in "${ dir }".`
       });
     }
 
@@ -1888,8 +1861,6 @@ module.exports = {
     await handle.evaluate( el => { el.value = '' });
     await handle.focus();
     await handle.type( answer );
-    setTimeout(async () => {
-    }, 500)
   },
 
   draw_signature: async function ( scope, name ) {

package/lib/utils/session_vars.js

@@ -1,4 +1,5 @@
 const fs = require('fs');
+const fg = require('fast-glob');
 const path = require('path'); 
 require('dotenv').config();
 
@@ -44,6 +45,7 @@ session_vars.get_tags = function () {
     return [];
   }
 };
+session_vars.get_sources = function () { return process.env._ALKILN_SOURCES || null; };
 
 // More complex logic
 session_vars.get_server_reload_timeout = function () {
@@ -210,6 +212,39 @@ 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.
+  * 
+  * Our code should ensure this gets run before cucumber gets triggered.
+  * 
+  * @returns bool */
+
+  let sources = fg.sync(
+    [ path ],
+    { onlyFiles: false, suppressErrors: true }
+  );
+
+  if ( sources.length > 0 ) {
+    session_vars._sources_path = path;
+    return true;
+  } else {
+    session_vars._sources_path = null;
+    return false;
+  }
+};
+
+session_vars.get_sources_path = 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;
+};
+
 session_vars.validateEnvironment = function() {
   /** Throw a useful error for the developer if any of the env vars
   *    required by absolutely all tests are missing. Gather all

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.0.0-pre-11",
+  "version": "5.1.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@suffolklitlab/alkiln",
-      "version": "5.0.0-pre-11",
+      "version": "5.1.0",
       "license": "MIT",
       "dependencies": {
         "@axe-core/puppeteer": "4.7.3",
@@ -19,6 +19,7 @@
         "dotenv": "8.2.0",
         "fast-glob": "3.2.12",
         "minimatch": "3.0.5",
+        "minimist": "1.2.8",
         "mocha": "9.2.2",
         "puppeteer": "20.8.2",
         "qs": "6.10.3",
@@ -1940,6 +1941,14 @@
         "node": "*"
       }
     },
+    "node_modules/minimist": {
+      "version": "1.2.8",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+      "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
+      "funding": {
+        "url": "https://github.com/sponsors/ljharb"
+      }
+    },
     "node_modules/mitt": {
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/mitt/-/mitt-3.0.0.tgz",
@@ -4516,6 +4525,11 @@
         "brace-expansion": "^1.1.7"
       }
     },
+    "minimist": {
+      "version": "1.2.8",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+      "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA=="
+    },
     "mitt": {
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/mitt/-/mitt-3.0.0.tgz",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.0.2",
+  "version": "5.1.0-sources-1",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
@@ -40,6 +40,7 @@
     "dotenv": "8.2.0",
     "fast-glob": "3.2.12",
     "minimatch": "3.0.5",
+    "minimist": "1.2.8",
     "mocha": "9.2.2",
     "puppeteer": "20.8.2",
     "qs": "6.10.3",