@suffolklitlab/alkiln 5.0.2-feat-github-server-14 → 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

@@ -23,12 +23,6 @@ inputs:
     description: "Max amount of time to give the server to reload if it needs to"
     required: false
     # no default to let the custom Scenario timeouts create the reload timeout
-  # INSTALL_LOCATION? Will that get confused with the location passed into the command line?
-  # Maybe `INSTALL_LOCATION` could be "playground", "server", or a custom path and we could handle all those.
-  INSTALL_METHOD:
-    description: "Default is 'playground'. Other option: 'server'. How to install the package onto the server."
-    required: false
-    default: "playground"
 
 runs:
   using: "composite"
@@ -53,43 +47,29 @@ runs:
         echo -e "\nALKiln version is $ALKILN_VERSION\nRepo is $REPO_URL\nBranch ref is $BRANCH_PATH\nMAX_SECONDS_FOR_SETUP is $MAX_SECONDS_FOR_SETUP\nSERVER_RELOAD_TIMEOUT_SECONDS is $SERVER_RELOAD_TIMEOUT_SECONDS\n"
       shell: bash
 
-    # Install
+    # Install node
     - name: "ALKiln: Install node packages"
       uses: actions/setup-node@v3
       with:
         node-version: "18"
     - name: Install ALKiln directly from npm
       run: |
-        npm install -g @suffolklitlab/alkiln@$ALKILN_VERSION
+        npm install -g @suffolklitlab/alkiln
       shell: bash
 
-    # Install on playground
+    # Run tests
     - name: "ALKiln: Create a Project and pull the package from GitHub"
-      if: ${{ inputs.INSTALL_METHOD == 'playground' }}
       run: alkiln-setup
       shell: bash
-    - run: echo -e "\n\n====\nALKiln could not create a project on your server's testing account or pull your package into it. Check the messages above this line.\n\n"
-      if: ${{ inputs.INSTALL_METHOD == 'playground' && failure() }}
-      shell: bash
-
-    # Install on server
-    - name: "ALKiln: Install the GitHub package onto the server"
-      if: ${{ inputs.INSTALL_METHOD == 'server' }}
-      run: alkiln-server-install
-      shell: bash
-    - run: echo -e "\n\n====\nALKiln could not install the package on the temporary GitHub docassemble server. Check the steps above this line.\n\n"
-      if: ${{ inputs.INSTALL_METHOD == 'server' && failure() }}
-      shell: bash
-
-    # run tests
     - name: "ALKiln: Run tests"
       if: ${{ success() }}
       run: alkiln-run ${{ github.event.inputs.tags && format('{0}', github.event.inputs.tags) }}
       shell: bash
-    
-    # on playground, delete project
-    - name: "ALKiln: Try to delete the project from the playground of the docassemble test account."
-      if: ${{ inputs.INSTALL_METHOD == 'playground' }}
+    - run: echo -e "\n\n====ALKiln could not create a project on your server's testing account or pull your package into it. Check the messages above this line.\n\n"
+      if: ${{ failure() }}
+      shell: bash
+    - name: "ALKiln: Delete project from docassemble test account"
+      if: ${{ always() }}
       run: alkiln-takedown
       shell: bash
     
@@ -102,7 +82,7 @@ runs:
         path: ./alkiln-*
 
 # ##################################
-# # A developer's workflow should look similar to the below.
+# # A developer's workflow should look similar to the below
 # # In place of `uses: suffolkLITLab/ALKiln@v5`, they
 # # might use another version.
 #

package/lib/docassemble/docassemble_api_REST.js

@@ -79,21 +79,13 @@ da.pull = async function ( timeout ) {
 };  // Ends da.pull()
 
 
-da.has_playground_task_finished = async function ( task_id, timeout ) {
-  return await da.has_task_finished( "/api/restart_status", task_id, timeout);
-}
-
-da.has_package_task_finished = async function ( task_id, timeout ) {
-  return await da.has_task_finished( "/api/package_update_status", task_id, timeout);
-}
-
 // node -e 'require("./lib/docassemble/docassemble_api_REST.js").has_task_finished()'
-da.has_task_finished = async function ( api_endpoint, task_id, timeout ) {
+da.has_task_finished = async function ( task_id, timeout ) {
   /* Check task status based on `task_id`. */
   let options = {
     method: 'GET',
     headers: {'X-API-Key': session_vars.get_dev_api_key()},
-    url: `${ session_vars.get_da_server_url() }${ api_endpoint }`,
+    url: `${ session_vars.get_da_server_url() }/api/restart_status`,
     params: {
       task_id: task_id,
     },

package/lib/docassemble/docassemble_api_interface.js

@@ -329,8 +329,9 @@ da_i.pull = async function ( pull_options ) {
   }
 };  // Ends da_i.pull()
 
+
 // node -e 'require("./lib/docassemble/docassemble_api_interface.js").has_task_finished()'
-da_i.has_task_finished = async function ( api_endpoint, task_id, options ) {
+da_i.has_task_finished = async function ( task_id, options ) {
   /** Check task status if it exists. If not, return true as task did
   *    not require a server restart. See da_i.pull().
   *    See https://docassemble.org/docs/api.html#restart_status. */
@@ -341,7 +342,7 @@ da_i.has_task_finished = async function ( api_endpoint, task_id, options ) {
   try {
 
     // If server did need to restart, check if it's done.
-    let response = await _da_REST.has_task_finished( api_endpoint, task_id, timeout );
+    let response = await _da_REST.has_task_finished( task_id, timeout );
     log.debug({ pre: `Task status: ${ response.status }. Docassemble status text: ${ response.data.status }. Task id: ${ task_id }` });
     
     if ( response.data.status === 'completed' ) {
@@ -352,15 +353,16 @@ da_i.has_task_finished = async function ( api_endpoint, task_id, options ) {
       return false;
 
     } else if ( response.data.status === 'unknown' ) {
-      // Server is working, but status 'unknown'? Bad design, but this
-      // does get returned when install packages, so return true
+      // Server is working, but status 'unknown'? We shouldn't even
+      // get here according to the API docs, but it feels weird to have
+      // no default behavior. What to return? Throw?
       log.info({
         pre: `\`task_id\` "${ task_id }" has expired. If it's been `
           + `less than 1 hour since the task started, the task is `
           + `complete. See https://docassemble.org/docs/api.html#restart_status.`,
-        data: response.data,
+        data: response,
       });
-      return true;
+      return null;
     }  // ends status type
 
   } catch ( error ) {
@@ -376,15 +378,8 @@ da_i.has_task_finished = async function ( api_endpoint, task_id, options ) {
 
 };  // Ends da_i.has_task_finished()
 
-da_i.wait_for_playground_to_restart = async ( task_id, options ) => {
-  return await da_i.wait_for_server_to_restart( "/api/restart_status", task_id, options );
-};
-
-da_i.wait_for_package_to_restart = async ( task_id, options ) => {
-  return await da_i.wait_for_server_to_restart( "/api/package_update_status", task_id, options );
-};
 
-da_i.wait_for_server_to_restart = async ( api_endpoint, task_id, options ) => {
+da_i.wait_for_server_to_restart = async ( task_id, options ) => {
   /** Wait for the server to finish restarting in case a module needs to load.
   *     This is a polling function because things may be returned
   *     that aren't equivalent to the server being done with a task. */
@@ -415,7 +410,7 @@ da_i.wait_for_server_to_restart = async ( api_endpoint, task_id, options ) => {
   while ( !done_restarting && num_tries <= max_loops ) {
     num_tries++;
     // Wait only a short time for the task to finish, not the full default timeout
-    done_restarting = await da_i.has_task_finished( api_endpoint, task_id, { timeout: wait_for_response } );
+    done_restarting = await da_i.has_task_finished( task_id, { timeout: wait_for_response } );
     if ( !done_restarting ) {
       if ( num_tries < max_loops ) {
         // Show a slightly different message after a number of tries to reassure

package/lib/docassemble/get_base_interview_url.js

@@ -11,13 +11,9 @@ let get_base_interview_url = async function () {
   *    when the user is not logged in.) We can't use `reset=2` because it caused an
   *    'Unable to locate interview session' error. */
   let server_url = session_vars.get_da_server_url();
-  if (session_vars.get_install_type() === "server") {
-    return `${ server_url }/interview?new_session=1&i=docassemble.${session_vars.get_package_name().replace("-", ".")}%3Adata/questions/`;
-  } else {
-    let dev_id = await docassemble_api_interface.get_dev_id();
-    let project_name = session_vars.get_project_name();
-    return `${ server_url }/interview?new_session=1&i=docassemble.playground${ dev_id }${ project_name }%3A`;
-  }
+  let dev_id = await docassemble_api_interface.get_dev_id();
+  let project_name = session_vars.get_project_name();
+  return `${ server_url }/interview?new_session=1&i=docassemble.playground${ dev_id }${ project_name }%3A`;
 };
 
 module.exports = get_base_interview_url;

package/lib/docassemble/setup.js

@@ -39,7 +39,7 @@ const setup = async () => {
   let task_id = await da_i.pull();
   // Task id will be null if server did not need to restart
   if ( task_id ) {
-    await da_i.wait_for_playground_to_restart( task_id );
+    await da_i.wait_for_server_to_restart( task_id );
   }
 
   // Finish

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

@@ -44,9 +44,6 @@ let printable_var_value = function(row) {
   /* `row` might be a row, a source row, or an original row. */
   let original = get_original_row(row);
   if ( is_secret_var(original) ) {
-    if ( session_vars.get_dangerous_debug() ) {
-      return `alkiln_dangerous ${ row.value }`;
-    }
     return original.flags.secret_name;
   }
   return row.value;
@@ -1001,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
       // ====================
@@ -1475,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
@@ -1489,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.
@@ -1778,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 }".`
       });
     }
 
@@ -1891,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 ) {
@@ -2523,10 +2491,6 @@ module.exports = {
       /** Sets a non-story table variable to a "secret" value (i.e. an env var) */
       // Prevent pictures of a screen with a secret.
       scope.disable_error_screenshot = true;
-      if ( session_vars.get_dangerous_debug() ) {
-        scope.disable_error_screenshot = false;
-      }
-
       let var_data = await scope.normalizeTable( scope, {
               var_data: [{
                 var: var_name,
@@ -2670,10 +2634,7 @@ module.exports = {
       */
       // Don't take a picture of a failed login in case one of the inputs is correct
       scope.disable_error_screenshot = true;
-      if ( session_vars.get_dangerous_debug() ) {
-        scope.disable_error_screenshot = false;
-      }
-      
+
       // If there is no browser open, start a new one
       if (!scope.browser) {
         scope.browser = await scope.driver.launch({ headless: !session_vars.DEBUG });
@@ -2706,10 +2667,6 @@ module.exports = {
       let email = process.env[ email_secret_name ];
       let password = process.env[ password_secret_name ];
 
-      if ( session_vars.get_dangerous_debug() ) {
-        log.debug({ type: `unsafe`, data: `login: ${ email }, ${ password }` });
-      }
-
       // Give as many useful messages to the user as possible if the env vars
       // aren't defined. Eventually, just provide a link to the docs because
       // this is complex

package/lib/utils/log.js

@@ -42,7 +42,7 @@ log.error = function ({ type='', pre='', data='', post='' }) {
 
 log.debug = function ({ type='', pre='', data='', post='' }) {
   /* If debugging is turned on, log a message that includes `ALKiln` and `debug` */
-  if ( session_vars.get_debug() || session_vars.get_dangerous_debug() ) {
+  if ( session_vars.get_debug() ) {
     let start = create_msg_start([ type, 'debug' ], pre );
     // Log them each on a separate line
     console.log( `ALKiln ${ type } debug: ${ pre }` );

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();
 
@@ -23,7 +24,6 @@ module.exports = session_vars;
 // These default to null
 // TODO: How to isolate debug elsewhere so this file can use the logger?
 session_vars.get_debug = function () { return process.env.DEBUG || null; };
-session_vars.get_dangerous_debug = function () { return process.env._ALKILN_DANGEROUS_DEBUG || null; };
 session_vars.is_dev_env = function () { return process.env.DEV || null; }
 
 session_vars.get_dev_api_key = function () { return process.env.DOCASSEMBLE_DEVELOPER_API_KEY || null; };
@@ -45,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 () {
@@ -116,7 +117,6 @@ session_vars.get_languages = function () {
 
 const runtime_config_path = `runtime_config.json`;
 const project_name_key = `da_project_name`;
-const install_type_key = `da_install_type`;
 session_vars.save_project_name = function ( project_name ) {
   /* Saves the name of the project to a json obj so deletion can use it later.
   *    Built for local as well as remote testing. Assumes a kosher string.
@@ -199,36 +199,6 @@ session_vars.save_artifacts_path_name = function ( path_name ) {
   return file;
 };  // Ends save_artifacts_path_name()
 
-
-session_vars.save_install_type = function (install_type) {
-  /* Save a key with the name of the current artifacts folder in case it doesn't exist. */
-
-  // Ensure artifacts path file exists
-  if ( !fs.existsSync( runtime_config_path ) ) {
-    // If the file doesn't exist, make one because next we need to read it
-    fs.writeFileSync( runtime_config_path, JSON.stringify( {}, null, 2 ) );
-  }
-
-  // Get the json, changing it, and re-write the file from scratch
-  let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
-  json[ install_type_key ] = install_type;
-  let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
-
-  return file;
-};  // Ends save_artifacts_path_name()
-
-session_vars.get_install_type = function () {
-  /* Get the name of the current artifacts path. */
-  try {
-    let json = JSON.parse( fs.readFileSync( runtime_config_path ));
-    let install_type = json[ install_type_key ];
-
-    return install_type;
-  } catch ( error ) {
-    return null;
-  }
-};  // Ends get_artifacts_path_name()
-
 session_vars.get_artifacts_path_name = function () {
   /* Get the name of the current artifacts path. */
   try {
@@ -242,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-feat-github-server-14",
+  "version": "5.1.0-sources-1",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
@@ -9,7 +9,6 @@
     "local": "npm run setup && npm run cucumber; npm run takedown",
     "setup": "./lib/docassemble/setup.js",
     "takedown": "./lib/docassemble/takedown.js",
-    "server_install": "./lib/docassemble/server_install.js",
     "unit": "mocha tests/unit_tests/*.test.*"
   },
   "repository": {
@@ -41,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",
@@ -48,7 +48,6 @@
     "uuid": "8.3.2"
   },
   "bin": {
-    "alkiln-server-install": "./lib/docassemble/server_install.js",
     "alkiln-setup": "./lib/docassemble/setup.js",
     "alkiln-takedown": "./lib/docassemble/takedown.js",
     "alkiln-run": "./lib/run_cucumber.js"

package/setup.py

@@ -50,10 +50,10 @@ setup(name='docassemble.ALKilnTests',
       author='plocket',
       author_email='example@example.com',
       license='The MIT License (MIT)',
-      url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln',
+      url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing',
       packages=find_packages(),
       namespace_packages=['docassemble'],
-      install_requires=['docassemble.ALToolbox>=0.8.2', 'docassemble.AssemblyLine>=2.24.0'],
+      install_requires=['docassemble.ALToolbox>=0.5.1'],
       zip_safe=False,
       package_data=find_package_data(where='docassemble/ALKilnTests/', package='docassemble.ALKilnTests'),
      )

package/.github/workflows/github_server.yml

@@ -1,83 +0,0 @@
-name: GitHub server tests
-
-on:
-  push:
-  # why is workflow dispatch not showing up in github?
-  workflow_dispatch:
-    inputs:
-      tags:
-        required: False
-        description: 'Optional. Use a "tag expression" specify which tagged tests to run (https://cucumber.io/docs/cucumber/api/#tag-expressions)'
-        # # Only test 2 tests - one uses an env var, the other uses AL.
-        # # They test if env vars get set correctly and depencencies get
-        # # pulled in correctly.
-        # default: '@al1'
-      enable_tmate:
-        type: boolean
-        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
-        required: false
-        default: false
-      # TODO: alkiln_version:
-
-jobs:
-
-  github-server-tests:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [18.x]
-
-    env:
-      # How would a dev make another user/password if they wanted to?
-      SECRET_VAR1: secret-var1-value
-      SECRET_VAR2: secret-var2-value
-      SECRET_FOR_MISSING_FIELD: secret for missing field
-      #_ALKILN_DANGEROUS_DEBUG: true
-      
-    steps:
-      # Place the root directory in this branch
-      - uses: actions/checkout@v3
-
-      # Debugging. Maybe add a long sleep after whatever it is we want to check
-      # to give us time to explore.
-      - name: Setup tmate session
-        if: ${{ inputs.enable_tmate }}
-        uses: mxschmitt/action-tmate@v3
-        with:
-          detached: true
-
-      - name: Start the temporary GitHub server
-        id: github_server
-        uses: ./github_server
-        with:
-          CONFIG_CONTENTS: "${{ secrets.CONFIG_CONTENTS }}"
-      - run: echo "Finished starting the GitHub server"
-
-      # Debugging on failure
-      # Trying to catch that intermittent bug mentioned in ./github_server/action.yml
-      - name: Docker failure tmate session
-        if: ${{ failure() }}
-        uses: mxschmitt/action-tmate@v3
-
-      - name: Env vars from server output
-        run: |
-          echo "USER1_EMAIL=${{ steps.github_server.outputs.DA_ADMIN_EMAIL }}" >> $GITHUB_ENV
-          echo "USER1_PASSWORD=${{ steps.github_server.outputs.DA_ADMIN_PASSWORD }}" >> $GITHUB_ENV
-      #- name: Work with docker
-      #  run: |
-      #    # Authors can use this to do more with the docker container.
-      #    # There may be a better way. Would take research. A docker action?
-      #    container_name=$(docker ps --format '{{.Names}}' | head -n 1)
-      #    echo "container_name is $container_name"
-
-      - name: "Run ALKiln tests"
-        if: ${{ success() }}
-        uses: ./
-        with:
-          SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
-          DOCASSEMBLE_DEVELOPER_API_KEY: "${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}"
-          INSTALL_METHOD: "server"
-          # TODO: See what happens if this is an empty string
-          ALKILN_VERSION: "5.0.2-feat-github-server-14"
-      - run: echo "Finished running ALKiln tests"
-

package/github_server/action.yml

@@ -1,143 +0,0 @@
-name: "ALKiln/github_server: Isolated docassemble tests"
-description: "Download and start up a temporary docassemble server on GitHub's servers, in an isolated environment. Avoids docassemble reload errors and other external factors."
-
-# Bug? Race condition? Exit with 52 when waiting for container to finish starting
-# https://github.com/SuffolkLITLab/ALKiln/actions/runs/5912900256/job/16036751264#step:4:188
-# Had no completion messages, but it exited with an error anyway
-# Took 121 seconds
-# The rerun of the test completed that step just fine, though it took less time
-# Took 120 and was fine: https://github.com/SuffolkLITLab/ALKiln/actions/runs/5913167036/job/16037288791
-# 150 secs with exit code 56:
-# https://github.com/SuffolkLITLab/ALKiln/actions/runs/5914677262/job/16040233419#step:4:196
-# 120 sec with exit code 56:
-# https://github.com/SuffolkLITLab/ALKiln/actions/runs/5914963614/job/16040773624#step:4:206
-
-# If we want to control the version of the docassemble image, we'd have
-# to make our own image:
-# You can build your own image by doing git clone jhpyle/docassemble  and then
-# using git checkout to select a particular version, and then using docker build
-# to build an image. https://docassemble.org/docs/docker.html#downgrading
-# If we just want to use an older version of da (as long as it works with
-# the latest image):
-# If you have an existing container you can use dainstall from the command
-# line to install docassemble.webapp==1.4.68
-
-inputs:
-  CONFIG_CONTENTS:
-    description: "The contents of the config file of the docassemble server"
-    required: false
-  MAX_SECONDS_FOR_DOCKER:
-    description: "Maximum amount of seconds to give the docassemble docker container to serve the site."
-    required: false
-    default: 600  # 10 min
-
-outputs:
-  DOCASSEMBLE_DEVELOPER_API_KEY:
-    description: "Use this inside `with:` for the ALKiln step. Temporary admin api key. It will be destroyed after the tests are done."
-    value: ${{ steps.api_key_output_step.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}
-  SERVER_URL:
-    description: "Use this inside `with:` for the ALKiln step. URL of the temporary docassemble server."
-    value: "http://localhost"
-  DA_ADMIN_EMAIL:
-    value: ${{ steps.api_key_output_step.outputs.DA_ADMIN_EMAIL }}
-  DA_ADMIN_PASSWORD:
-    value: ${{ steps.api_key_output_step.outputs.DA_ADMIN_PASSWORD }}
-
-
-runs:
-  using: "composite"
-  steps:
-      - uses: actions/checkout@v3
-
-      - name: "ALKiln github_server: Set environment variables"
-        run: |
-          echo "DA_ADMIN_API_KEY=abcd1234abcd1234abcd5678abdc5678" >> $GITHUB_ENV
-          echo "MAX_SECONDS_FOR_DOCKER=${{ inputs.MAX_SECONDS_FOR_DOCKER }}" >> $GITHUB_ENV
-          echo "DA_ADMIN_EMAIL=admin@example.com" >> $GITHUB_ENV
-          # Login will fail if this is "password"
-          echo "DA_ADMIN_PASSWORD=@123abcdefg" >> $GITHUB_ENV
-        shell: bash
-      - id: api_key_output_step
-        run: |
-          echo "DOCASSEMBLE_DEVELOPER_API_KEY=$DA_ADMIN_API_KEY" >> "$GITHUB_OUTPUT"
-          echo "DA_ADMIN_EMAIL=$DA_ADMIN_EMAIL" >> "$GITHUB_OUTPUT"
-          echo "DA_ADMIN_PASSWORD=$DA_ADMIN_PASSWORD" >> "$GITHUB_OUTPUT"
-        shell: bash
-
-      - name: "ALKiln github_server: Download and start docker"
-        run: |
-          mkdir /tmp/config
-          echo "${{ inputs.CONFIG_CONTENTS }}" > /tmp/config/myconfig.yml
-          docker pull jhpyle/docassemble
-          docker run --env DA_ADMIN_EMAIL="${{ env.DA_ADMIN_EMAIL }}" --env DA_ADMIN_PASSWORD="${{ env.DA_ADMIN_PASSWORD }}" --env DA_ADMIN_API_KEY="${{ env.DA_ADMIN_API_KEY }}" --env DA_CONFIG=/tmp/config/myconfig.yml --volume /tmp/config:/tmp/config --cap-add SYS_PTRACE --memory="4gb" -d -p 80:80 jhpyle/docassemble
-        shell: bash
-      - name: "ALKiln github_server: Wait for server to start"
-        run: |
-          # ALKiln github_server: Wait for server to start
-
-          # Reset the SECONDS variable
-          SECONDS=0
-          # Wait 1 minute before pinging the server constantly
-          sleep 60
-
-          # Use a variable instead of checking $response so we can control to avoid race
-          # conditions from preventing the success log message.
-          ready="false"
-
-          while [[ $ready == "false" ]]; do
-            echo "Time ellapsed: $SECONDS seconds"
-
-            # Check if max seconds till loading has passed
-            if [[ $SECONDS -ge $MAX_SECONDS_FOR_DOCKER ]]; then
-              echo "ALKiln GitHub Server Error: Timed out waiting for docker container to serve the site. If you want to give your docker container more timem to install, set the MAX_SECONDS_FOR_DOCKER input for this action."
-              # Exit with failure, or allow this to keep going?
-              break
-            fi
-
-            # Set the variable to a new string value in each iteration
-            response=$(curl -o /dev/null -s -w "%{http_code}\n" http://localhost:80/health_check?ready=1)
-            echo "response is $response"
-
-            # Check if the string includes the desired text
-            if [[ $response == *"200"* ]]; then
-              echo "Success! The docker container is ready!"
-              ready="true"
-            else
-              echo "The docker container isn't ready yet. Will check again in 30 seconds."
-              sleep 30
-            fi
-
-          done
-        shell: bash
-
-      # Don't rely on the environment's version of python
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
-      - run: pip install docassemblecli
-        shell: bash
-      # Install the current directory into docassemble
-      - run: dainstall . --apiurl http://localhost --apikey $DA_ADMIN_API_KEY
-        shell: bash
-
-      # Upload artifacts that subscribers can download on the Actions summary page
-      - name: "ALKiln github_server: Docker logs"
-        if: ${{ always() }}
-        run: |
-          docker_logs=$(docker logs $(docker ps --filter "ancestor=jhpyle/docassemble" --format {{.ID}}))
-          # Should this name have a date/time attached? The logs themselves have timestamps
-          echo "$docker_logs" > /tmp/alkiln_docker_logs.txt
-        shell: bash
-    
-      # Should this date/time be created at the start of this action?
-      - name: "ALKiln github_server: Get folder name with date and time"
-        if: ${{ always() }}
-        run: |
-          echo "GITHUB_SERVER_ARTIFACT_NAME=alkiln-github-server-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u)UTC" >> $GITHUB_ENV
-        shell: bash
-      - name: "ALKiln github_server: Upload artifacts folder"
-        if: ${{ always() }}
-        uses: actions/upload-artifact@v3
-        with:
-          name: ${{ env.GITHUB_SERVER_ARTIFACT_NAME }}
-          path: /tmp/alkiln_docker_logs.txt

package/lib/docassemble/server_install.js

@@ -1,9 +0,0 @@
-#!/usr/bin/env node
-
-const session_vars = require('../utils/session_vars');
-
-const server_install = async () => {
-  session_vars.save_install_type("server");
-};  // Ends server_install();
-
-server_install();