@suffolklitlab/alkiln 4.10.3-feat-debug-cache → 4.10.4-cli-playground-1

package/CHANGELOG.md

@@ -39,10 +39,26 @@ Format:
 - 
 -->
 ## [Unreleased]
-## Added
-- Contribution docs.
-- Story table can take screenshots after each visited page.
-- Projects created in da each have a unique name. We assume for now this will not build up test packages in the server.
+
+### Added
+- A new script: `alkiln-run`, which acts like `npm run cucumber`, but can
+  be run in any directory, not just in an npm package.
+- Ability to run ALKiln from an interview by a logged-in user
+
+### Changed
+- upgraded cucumber v8.6.0
+- using cucumber's JS API to run tests. For more details on how it works,
+    see [the cucumber-js docs](https://github.com/cucumber/cucumber-js/blob/main/docs/javascript_api.md).
+- the github action no longer runs `npm run XYZ`; it directly calls scripts,
+    e.g. `alkiln-setup`, `alkiln-run`, `alkiln-takedown`
+- don't print the ["publish this cucumber report" message](https://github.com/cucumber/cucumber-js/blob/main/docs/configuration.md#options)
+
+## [4.10.4] - 2023-02-15
+### Added
+- Contribution docs
+
+### Fixed
+- #511, couldn't take screenshots of signature pages https://github.com/SuffolkLITLab/ALKiln/issues/511
 
 ## [4.10.3] - 2023-01-11
 ### Removed
@@ -565,4 +581,4 @@ Format:
 - `example.feature` - an example test to get a project started
 - `github/workflows/run_form_tests.yml` - Automated github workflow to run tests when code is pushed and a manual trigger for testing without needing to push
 - `.gitignore` - ignores files that are generated by the tests and shouldn't be added to the repo
-- `package.json` - keep up-to-date version of this test repository and hold scripts that the automated tests run
+- `package.json` - keep up-to-date version of this test repository and hold scripts that the automated tests run

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
@@ -33,6 +24,16 @@ inputs:
     required: false
     default: '120'
 
+  ## Testing by hand on the server. Should only be created by interview code.
+  #_USER_ID:
+  #  description: 'AVOID SETTING THIS YOURSELF. The id of your docassemble playground account. This is created and used by ALKiln when testing manually on your server.'
+  #  required: false
+  #_PROJECT_NAME:
+  #  description: 'AVOID SETTING THIS YOURSELF. The name of the Playground Project to test manually on your server. ALKiln will ask you for this information.'
+  #  required: false
+  #_ORIGIN:
+  #  description: 'AVOID SETTING THIS YOURSELF. The origin that's triggering this round of tests.'
+
 runs:
   using: "composite"
   steps:
@@ -55,12 +56,12 @@ 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
+
+      #  echo "_USER_ID=${{ inputs._USER_ID }}" >> $GITHUB_ENV
+      #  echo "_PROJECT_NAME=${{ inputs._PROJECT_NAME }}" >> $GITHUB_ENV
       shell: bash
     - name: "ALKiln: confirm info"
       run: |
@@ -68,58 +69,31 @@ 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\nManually added languages are $EXTRA_LANGUAGES\n"
       shell: bash
 
-    # This doesn't use an already established package-lock.json and that
-    # comes with some types of test breaking risks. Same problem as before.
-    - name: Temporarily overwrite or create package.json
-      run: |
-        cat << EOF > "package.json"
-        {
-          "scripts": {
-            "test": "npm run langs_setup && npm run cucumber -- $@",
-            "cucumber_base": "./node_modules/.bin/cucumber-js --require ./node_modules/@suffolklitlab/alkiln/lib/index.js",
-            "cucumber": "run_cucumber(){ npm run cucumber_base -- \"$@\" docassemble/*/data/sources/*.feature --retry 1; }; run_cucumber",
-            "langs": "npm run langs_setup && ./node_modules/.bin/cucumber-js --require ./node_modules/.bin/alkiln-cucumber docassemble/*/data/sources/*_lang*.feature",
-            "langs_setup": "node_modules/.bin/alkiln-langs 'docassemble/*/data/sources/*.feature'",
-            "setup": "node_modules/.bin/alkiln-setup",
-            "takedown": "node_modules/.bin/alkiln-takedown"
-          },
-          "dependencies": {
-            "colors": "1.4.0",
-            "@cucumber/cucumber": "7.3.2",
-            "@suffolklitlab/alkiln": "$ALKILN_VERSION"
-          }
-        }
-        EOF
-        # Keep in sync with the cucumber.js in root
-        cat << EOF > "cucumber.js"
-        module.exports = {
-          default: "--require ./lib/index.js --format progress --format summary:cucumber-report.txt"
-        }
-        EOF
-      shell: bash
-
     # Install node
     - name: "ALKiln: Install node packages"
       uses: actions/setup-node@v1
       with:
         node-version: "17"
-    - run: npm install
+    # npm install -g "@suffolklitlab/alkiln@$ALKILN_VERSION"
+    - name: Install ALKiln directly from npm
+      run: |
+        npm install -g github:SuffolkLITLab/ALKiln#lighter_package_json
       shell: bash
 
     # Run tests
     - name: "ALKiln: Create a Project and pull the package from GitHub"
-      run: npm run setup
+      run: alkiln-setup
       shell: bash
     - name: "ALKiln: Run tests"
       if: ${{ success() }}
-      run: npm run test -- ${{ github.event.inputs.tags && format('"--tags" "{0}"', github.event.inputs.tags) }}
+      run: alkiln-run ${{ github.event.inputs.tags && format('"{0}"', github.event.inputs.tags) }}
       shell: bash
     - 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: npm run takedown
+      run: alkiln-takedown
       shell: bash
     
     # Upload artifacts that subscribers can download on the Actions summary page

package/cucumber.js

@@ -1,3 +1,3 @@
 module.exports = {
-  default: "--require ./lib/index.js --format progress --format summary:cucumber-report.txt"
+  default: "--publish-quiet  --require ./lib/index.js --format progress --format summary:cucumber-report.txt"
 }

package/lib/docassemble/docassemble_api_interface.js

@@ -204,16 +204,16 @@ da_i.loop_to_create_project = async function( creation_options ) {
   let wait_seconds = creation_options.wait_seconds || 5;
 
   let project_name = null;
-  let num_tries = 0;
+  let name_incrementor = 0;
 
   // Try to create a project. If the project name is already taken, increment and loop again.
-  while ( num_tries <= max_tries ) {
-    num_tries++;
+  while ( name_incrementor <= max_tries ) {
+    name_incrementor++;
     try {
 
-      // Try adding a new timestamp to the name. Must remove all non-valid characters
+      // Try next name that could be unique. Must remove all non-valid characters
       // TODO: This sanitization is already done in session_vars, so remove it from here
-      project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + `${Date.now()}`;
+      project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + name_incrementor;
       log.info({ pre: `Trying to create a docassemble Project with the name ${ project_name }` });
       let response = await _da_REST.create_project( project_name, timeout );
       log.info({ pre: `The docassemble server is ready. Created a Project named ${ project_name }` });
@@ -226,7 +226,7 @@ da_i.loop_to_create_project = async function( creation_options ) {
 
       if ( response && response.data ) {
         if ( response.data.includes( `Invalid project` ) ) {
-          if ( num_tries < max_tries ) {
+          if ( name_incrementor < max_tries ) {
             // A non-unique project name. Try the next project name.
             continue;
 
@@ -256,11 +256,11 @@ da_i.loop_to_create_project = async function( creation_options ) {
 
         // If it's a timeout error, server is busy. Try again after waiting.
         // Why are we using `max_tries` for timeout error as well?
-        if ( is_timeout_error( error ) && num_tries < max_tries ) {
+        if ( is_timeout_error( error ) && name_incrementor < max_tries ) {
           log.info({ pre: `The docassemble server was busy when we tried to `
-            + `create the Project. Attempt ${ num_tries } of `
+            + `create the Project. Attempt ${ name_incrementor } of `
             + `${ max_tries }. Will try again in ${ wait_seconds } seconds.` });
-          num_tries--;  // Try this name again next time
+          name_incrementor--;  // Try this name again next time
           await time.waitForTimeout( wait_seconds * 1000 );
           continue;
 
@@ -272,8 +272,6 @@ da_i.loop_to_create_project = async function( creation_options ) {
         }  // ends type of non-response error
       }  // ends type of response error
     }  // ends try
-
-    // TODO: Add a message that we're done trying to create a project, successful or not
   }  // ends while
 };  // Ends da_i.loop_to_create_project()
 

package/lib/run_cucumber.js

@@ -0,0 +1,92 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const log = require('./utils/log');
+const session_vars = require('./utils/session_vars');
+
+// import {loadConfiguration, loadSupport, runCucumber } from '@cucumber/cucumber/api';
+const cucumber_api = require('@cucumber/cucumber/api');
+
+(async function main() {
+  let argv = process.argv;
+
+  let just_args = argv.slice(2);
+
+  const environment = { cwd: process.cwd() };
+  const provided_config = {
+    "publishQuiet": true,
+    "require": "./lib/index.js", 
+    "format": ["progress", "summary:cucumber-report.txt"],
+    "paths": ["docassemble/*/data/sources/*.feature"],
+    "retry": 1,
+  }
+
+  // If they're running it from an interview on their server instead of from GitHub
+  if ( session_vars.get_origin() === `interview` ) {
+    provided_config.paths.append(`/usr/share/docassemble/files/playgroundsources/${session_vars.get_user_id()}/${session_vars.get_user_project_name()}/*.feature`);
+  }
+
+  let tag_vals = just_args;
+  if ( session_vars.get_origin() === `interview` ) {
+    // Should tags be given as a string or a list? String would give option to
+    // give a boolean expression. TODO: offer a dropdown with available tags.
+    tag_vals = session_vars.get_tags().split(` `);
+  }
+
+  if (tag_vals.length > 0) {
+    // 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 (tag_vals.every((val) => val.startsWith(`@`))) {
+      provided_config.tags = tag_vals.join(` or `);
+    }
+    // If we get a list of seemingly no tags, assume they meant to use tags
+    else if (tag_vals.every((val) => !val.startsWith(`@`))) {
+      provided_config.tags = tag_vals.map((val) => `@${ val }`).join(` or `);
+    }
+    // If it's a mix of tags and no tags, it's probably a boolean expression!
+    else {
+      provided_config.tags = tag_vals.join(` `);
+    }
+  }
+
+
+  const { runConfiguration } = await cucumber_api.loadConfiguration({
+    provided: provided_config
+  }, environment);
+  var path = require('path');
+  var codeDir = path.dirname(require.main.filename);
+  const support = await cucumber_api.loadSupport({ support: {
+    requireModules: [`${ codeDir }/index.js`],
+    requirePaths: [ `${ codeDir }/index.js`],
+    importPaths: [],
+  }, sources: {paths: []}}, environment);
+  
+  // TODO: Maybe only log these for debug?
+  console.log(`ALKiln run_cucumber.js configuration:`);
+  console.log(`%o`, runConfiguration);
+
+  const { success } = await cucumber_api.runCucumber({...runConfiguration, support});
+  console.log(`ALKiln run_cucumber.js succeeded:`);
+  console.log(`%o`, success);
+  const exitCode = success ? 0 : 1;
+  process.exitCode = exitCode;
+
+  // This is hardcoded information from `cucumber.js`. Now we on cucumber 8, we should
+  // change that the cucumber.json and actually parse the info from it.
+  // This code isn't used for anything other than detecting and removing color codes 
+  let summary_file_name = 'cucumber-report.txt';
+  fs.readFile(summary_file_name, 'utf8', (err, data) => {
+    if (err) {
+      console.error(err);
+      return;
+    }
+
+    // Replace terminal color codes, if present
+    // https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797#colors--graphics-mode
+    data = data.replace(/\x1b\[[0-9][0-9]?[0-9]?m/g, '');
+
+    // 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);
+  });
+})();

package/lib/scope.js

@@ -2002,13 +2002,6 @@ module.exports = {
           if ( row_used.source ) { row_used.source.times_used += 1 }
           row_used.times_used += 1;
 
-          let { id } = scope.examinePageID( scope );
-          await scope.page.screenshot({
-            path: `./${ scope.paths.scenario }/pic-${Date.now()}-${ id }.jpg`,
-            type: 'jpeg',
-            fullPage: true
-          });
-
           // TODO: special continue/navigation button function that handles url and all?
           
           // Have to catch errors right now or may get stuck in an infinite loop?
@@ -2022,7 +2015,6 @@ module.exports = {
           // Discuss moving this out of here. Having to pass in `id` just for
           // these messages smells bad. Con: Already a lot of code out there.
           error = await scope.waitUntilContinued( scope, { url: page_url, id });
-
           // if ( error.was_found ) {
           //   await scope.throwPageError( scope, { id: id });
           // }
@@ -2061,14 +2053,6 @@ module.exports = {
     if ( !did_navigate && ensure_navigation  ) {
       // All fields on this page should be taken care of
       let page_url = await scope.page.url();
-
-      let { id } = scope.examinePageID( scope );
-      await scope.page.screenshot({
-        path: `./${ scope.paths.scenario }/pic-${Date.now()}-${ id }.jpg`,
-        type: 'jpeg',
-        fullPage: true
-      });
-
       await scope.continue( scope );
       // Have to catch errors right now or may get stuck in an infinite loop?
       // TODO: Don't catch errors - maybe the developer expected/wanted an error
@@ -2295,6 +2279,23 @@ module.exports = {
     return scope;
   },  // Ends scope.throwPageError()
 
+  take_a_screenshot: async ( scope,{ path }) => {
+    /* Takes a jpeg screenshot. Avoids destroying signatures. */
+
+    let fullPage = true;
+    let signature_elem = await scope.page.$(scope.signature_selector);
+    if ( signature_elem !== null ) {
+      fullPage = false;
+    }
+
+    await scope.page.screenshot({
+      path: path,
+      type: 'jpeg',
+      fullPage: fullPage,
+    });
+
+  },  // Ends scope.take_a_screenshot()
+
 
   //#####################################
   //#####################################
@@ -2317,11 +2318,7 @@ module.exports = {
         name = `screenshot_on-${ id }-${ date }`;
       }
 
-      await scope.page.screenshot({
-        path: `./${ scope.paths.scenario }/${ name }.jpg`,
-        type: 'jpeg',
-        fullPage: true
-      });
+      await scope.take_a_screenshot( scope, { path: `./${ scope.paths.scenario }/${ name }.jpg` });
 
       await scope.afterStep( scope );
     },  // Ends scope.steps.screenshot()

package/lib/steps.js

@@ -92,7 +92,7 @@ BeforeAll(async () => {
   // Make the folder to store all the files for this run of the tests
   scope.paths.artifacts = files.make_artifacts_folder();
   // Save its name in a file. `session_vars` can get it back later.
-  // This is used by at least clean_reports.js.
+  // This is used by at least run_cucumber.js.
   session_vars.save_artifacts_path_name( scope.paths.artifacts );
 
   scope.paths.report = `${ scope.paths.artifacts }/report.txt`;
@@ -103,7 +103,7 @@ BeforeAll(async () => {
 Before(async (scenario) => {
   // Create browser, which can't be created in BeforeAll() where .driver doesn't exist for some reason
   if (!scope.browser) {
-    scope.browser = await scope.driver.launch({ headless: !session_vars.get_debug(), devtools: session_vars.get_debug() });
+    scope.browser = await scope.driver.launch({ args: ['--no-sandbox'], headless: !session_vars.get_debug(), devtools: session_vars.get_debug() });
   }
   // Clean up all previously existing pages
   for (const page of await scope.browser.pages()) { 
@@ -386,12 +386,6 @@ When(/^(?:the user gets)?(?:I get)? to ?(?:the)?(?: ?question)?(?: id)? "([^"]+)
     if( row1.report_str > row2.report_str ) { return 1; }
     return 0;
   });
-  
-  await scope.page.screenshot({
-    path: `./${ scope.paths.scenario }/pic-${Date.now()}-${ id }.jpg`,
-    type: 'jpeg',
-    fullPage: true
-  });
 
   // Add full used table to report so it can be copied if needed.
   // TODO: Should we/How do we get this in the final scenario report instead of here?
@@ -852,11 +846,8 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
           let buttons = await scope.steps.set_random_page_vars( scope );
 
           // Take a screenshot of the page before continuing or ending
-          await scope.page.screenshot({
-            path: `${ scope.paths.random_screenshots }/random-${ Date.now() }.jpg`,
-            type: `jpeg`,
-            fullPage: true
-          });
+          let path = `${ scope.paths.random_screenshots }/random-${ Date.now() }.jpg`;
+          await scope.take_a_screenshot( scope, { path: path });
 
           // Prep for the next loop to possibly stop. Signature page buttons
           // don't count as buttons in the way our field detects them
@@ -1125,27 +1116,23 @@ After(async function(scenario) {
       if ( !!scope.disable_error_screenshot ) {
         scope.addToReport(scope, {
           type: `row`,
-          value: `For security, ALKiln will not create a screenshot for this error. It's possible a secret is being used on this screen.`
+          value: `For security, ALKiln will avoid creating a screenshot for this error. It's possible a secret is being used on this screen.`
         });
       } else {
 
         // Save/download a picture of the screen that's showing during the unexpected status
         // Save one copy in the outer-most artifact folder
         let scenario_filename = await scope.getSafeScenarioFilename( scope, { prefix: `error_on` });
-        await scope.page.screenshot({
-          path: `${ scope.paths.artifacts }/${ scenario_filename }.jpg`,
-          type: `jpeg`,
-          fullPage: true
-        });
+        let path_outer = `${ scope.paths.artifacts }/${ scenario_filename }.jpg`;
+        await scope.take_a_screenshot( scope, { path: path_outer });
+
         // Save another copy in the artifact's Scenario folder
         let screenshot_name = `error_on`;
         let { id } = await scope.examinePageID( scope, 'none to match' );
         screenshot_name += `-${ id }`;
-        await scope.page.screenshot({
-          path: `${ scope.paths.scenario }/${ screenshot_name }.jpg`,
-          type: `jpeg`,
-          fullPage: true
-        });
+        let path_scenario = `${ scope.paths.scenario }/${ screenshot_name }.jpg`;
+        await scope.take_a_screenshot( scope, { path: path_scenario });
+
       }  // ends if scope.disable_error_screenshot
     }  // ends if scope.page exists
 

package/lib/utils/log.js

@@ -52,7 +52,8 @@ log.debug = function ({ type='', pre='', data='', post='' }) {
 };
 
 log.add_to_debug_log = function(value) {
-  fs.appendFileSync(log.debug_log_file, value);
+  let artifacts_path = session_vars.get_artifacts_path_name();
+  fs.appendFileSync(`${ artifacts_path }/${ log.debug_log_file}`, value);
 };
 
 log.debug_log_file = 'debug_log.txt'

package/lib/utils/session_vars.js

@@ -23,9 +23,19 @@ 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.is_dev_env = function () { return process.env.DEV || null; }
+
 session_vars.get_dev_api_key = function () { return process.env.DOCASSEMBLE_DEVELOPER_API_KEY || null; };
 session_vars.get_repo_url = function () { return process.env.REPO_URL || null; };
-session_vars.is_dev_env = function () { return process.env.DEV || null; }
+
+// Created by interview code when tests through an interview manually on the server
+session_vars.get_origin = function () {
+  /** Possible values: 'interview', 'github'. In future, maybe 'playground' or 'dashboard'. */
+  return process.env._ORIGIN || null;
+};
+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; };
+session_vars.get_tags = function () { return process.env._TAGS || null; };
 
 // More complex logic
 session_vars.get_server_reload_timeout = function () {
@@ -129,8 +139,12 @@ session_vars.save_project_name = function ( project_name ) {
   return file;
 };  // Ends save_project_name()
 
+// TODO next: Add use of env var in here in case not through GitHub cli_playground
 session_vars.get_project_name = function () {
-  /* Get the name of the current docassemble Project  */
+  /* Get the name of the current docassemble Project */
+  if ( session_vars.get_origin() === 'interview' ) {
+    return session_vars.get_user_project_name();
+  }
   let json = JSON.parse( fs.readFileSync( runtime_config_path ));
   let project_name = json[ project_name_key ] || null;
   if ( session_vars.get_debug() ) { console.log( `ALKiln debug: Project name from file is "${ project_name }".` ); }
@@ -174,7 +188,7 @@ session_vars.save_artifacts_path_name = function ( path_name ) {
     console.log( `ALKiln debug: Stored name of artifacts directory "${ path_name }" locally.` );
   }
   return file;
-};  // Ends get_project_name()
+};  // Ends save_artifacts_path_name()
 
 session_vars.get_artifacts_path_name = function () {
   /* Get the name of the current artifacts path. */
@@ -187,7 +201,7 @@ session_vars.get_artifacts_path_name = function () {
   } catch ( error ) {
     return null;
   }
-};  // Ends get_project_name()
+};  // Ends get_artifacts_path_name()
 
 /**
  * Ensure all required environment variables exist. Add each missing variable

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "4.10.3-feat-debug-cache",
+  "version": "4.10.4-cli-playground-1",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
     "test": "npm run unit && npm run langs_setup && npm run cucumber -- $@",
-    "cucumber_base": "run_cucumber(){ ./node_modules/.bin/cucumber-js \"$@\"; status=$?; ./lib/utils/clean_reports.js; return $status; }; run_cucumber",
-    "cucumber": "run_base(){ npm run cucumber_base -- \"$@\" docassemble/*/data/sources/*.feature --retry 1; }; run_base",
-    "cucumber_external": "run_cucumber(){ tmp_path=`pwd`; ( new_path=\"$1\"; shift; cd \"$new_path\"; npm run --prefix \"${tmp_path}\" cucumber_base -- \"$@\" \"$new_path\"/docassemble/*/data/sources/*.feature;) }; run_cucumber",
-    "langs": "npm run langs_setup && ./node_modules/.bin/cucumber-js --require ./lib/index.js docassemble/*/data/sources/*_lang*.feature",
+    "cucumber": "./lib/run_cucumber.js",
+    "langs": "npm run langs_setup && npm run cucumber",
     "langs_setup": "./lib/utils/langs.js 'docassemble/*/data/sources/*.feature'",
     "langs_local": "npm run langs_setup && npm run local",
     "local": "npm run setup && npm run cucumber; npm run takedown",
@@ -36,13 +34,13 @@
   "homepage": "https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/",
   "dependencies": {
     "@axe-core/puppeteer": "4.4.2",
-    "@cucumber/cucumber": "7.3.2",
+    "@cucumber/cucumber": "8.6.0",
     "@faker-js/faker": "^7.3.0",
     "axios": "0.24.0",
     "chai": "4.2.0",
     "cheerio": "1.0.0-rc.10",
-    "dotenv": "8.2.0",
     "deep-equal-in-any-order": "^2.0.0",
+    "dotenv": "8.2.0",
     "mocha": "9.2.0",
     "puppeteer": "13.1.3",
     "qs": "6.10.2",
@@ -52,6 +50,7 @@
   "bin": {
     "alkiln-setup": "./lib/docassemble/setup.js",
     "alkiln-takedown": "./lib/docassemble/takedown.js",
-    "alkiln-langs": "./lib/utils/langs.js"
+    "alkiln-langs": "./lib/utils/langs.js",
+    "alkiln-run": "./lib/run_cucumber.js"
   }
 }

package/lib/utils/clean_reports.js

@@ -1,29 +0,0 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const log = require('./log');
-const session_vars = require('./session_vars');
-
-// This is hardcoded information from `cucumber.js`. Once we move to cucumber 8, we should
-// change that the cucumber.json and actually parse the info from it.
-// The file won't be used for anything other than detecting and removing color codes 
-let summary_file_name = 'cucumber-report.txt';
-fs.readFile(summary_file_name, 'utf8', (err, data) => {
-  if (err) {
-    console.error(err);
-    return;
-  }
-
-  // Replace terminal color codes, if present
-  // https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797#colors--graphics-mode
-  data = data.replace(/\x1b\[[0-9][0-9]?[0-9]?m/g, '');
-
-  // Put it in the correct file in the correct folder
-  let artifacts_path = session_vars.get_artifacts_path_name();
-  fs.appendFile( `${ artifacts_path }/${ log.debug_log_file }`, data, err => {
-    if (err) {
-      console.error(err);
-      return;
-    }
-  });  // Ends appendFileSync
-});