@suffolklitlab/alkiln 5.12.0 → 5.13.0

package/.github/workflows/github_server.yml

@@ -43,18 +43,22 @@ jobs:
     #### Developer note: You can probably leave out these specific
     #### environment variables. You may not even need the `env`
     #### keyword or values at all. See
-    #### https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing#env-vars
+    #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing#env-vars
     env:
       SECRET_VAR1: secret-var1-value
       SECRET_VAR2: secret-var2-value
       SECRET_FOR_MISSING_FIELD: secret for missing field
+      INVALID_API_KEY: invalidAPIkey
+      EMPTY_STRING: ""
+      USER_NO_PERMISSIONS_EMAIL: alkiln@example.com
+      USER_NO_PERMISSIONS_PASSWORD: User123^
       
     steps:
       # Place the root directory in this branch to access
       # relative paths to action files
       - uses: actions/checkout@v4
 
-      - name: ALKiln - Start the isolated temporary docassemble server on GitHub
+      - name: "ALKiln - Start the isolated temporary docassemble server on GitHub"
         id: github_server
         #### Developer note: you'll need to replace `uses: ./action_for_github_server`
         #### with the path to ALKiln’s repository name and branch name. For example,
@@ -71,13 +75,54 @@ jobs:
         shell: bash
 
       #### Developer note: You can probably leave this out
-      # # Optional debugging to explore things like docker issues
-      # - name: Docker debug tmate session
-      #   if: ${{ failure() && github.event.inputs.enable_tmate == 'true' }}
-      #   uses: mxschmitt/action-tmate@v3
+      - name: "Add a low-level user and their API key (in an env var)"
+        env:
+          SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
+          KEY: ${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}
+        run: |
+          # Create user and their API key
+
+          # Install json processor
+          sudo apt-get install jq
+
+          # https://docassemble.org/docs/api.html#user_new
+          user_data=$(curl -X POST \
+            ${{ env.SERVER_URL }}/api/user/new \
+            -H 'Content-Type: application/json' \
+            -d '{
+              "key": "${{ env.KEY }}",
+              "username": "${{ env.USER_NO_PERMISSIONS_EMAIL }}",
+              "password": "${{ env.USER_NO_PERMISSIONS_PASSWORD }}"
+            }')
+          echo "User data:"
+          echo "$user_data"
+
+          user_id=$(echo "$user_data" | jq '.user_id' -r)
+
+          # https://docassemble.org/docs/api.html#api_user_user_id_api_post
+          new_key_with_quotes=$(curl -X POST \
+            ${{ env.SERVER_URL }}/api/user/"$user_id"/api \
+            -H 'Content-Type: application/json' \
+            -d '{
+              "key": "${{ env.KEY }}",
+              "name": "alkiln_key",
+              "method": "none"
+            }')
+          echo "new key (watch out, this contains actual quotation marks): $new_key_with_quotes"
+          no_end_quote="${new_key_with_quotes%\"}"
+          unquoted="${no_end_quote#\"}"
+          echo "unquoted: $unquoted"
+
+          echo "USER_NO_PERMISSIONS_API_KEY=$unquoted" >> "$GITHUB_ENV"
+
+      #### Developer note: You can probably leave this out
+      ## Optional debugging to explore things like docker issues
+      #- name: Docker debug tmate session
+      #  #if: ${{ failure() && github.event.inputs.enable_tmate == 'true' }}
+      #  uses: mxschmitt/action-tmate@v3
 
       #### Developer note: You can probably leave this out
-      - name: Run ALKiln - Env vars for our own tests from server output
+      - name: "Create other env vars for our own tests 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
@@ -103,17 +148,17 @@ jobs:
           # Internal: docassemble changes sometimes break @a11y tests. That is
           # a da problem, not ours. We will trigger these tests manually when we
           # want to check up on this.
-          ALKILN_TAG_EXPRESSION: "${{ (github.event.inputs.tags && format('{0}', github.event.inputs.tags)) || '(not @a11y) and (not @error)' }}"
+          ALKILN_TAG_EXPRESSION: "${{ (github.event.inputs.tags && format('{0}', github.event.inputs.tags)) || '(not @error) and (not @temp_error)' }}"
         with:
           #### Developer note: Required inputs. See
-          #### https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing/#sandbox-inputs
+          #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sandbox-inputs
           SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
           DOCASSEMBLE_DEVELOPER_API_KEY: "${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}"
           INSTALL_METHOD: "server"
           #### Developer note: You can probably leave the rest out
-          #### To learn more, see https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing/#optional-inputs
+          #### To learn more, see https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
           ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
-          ALKILN_VERSION: output
+          ALKILN_VERSION: delete
 
       #### Developer note: Example of making an issue when tests fail
       #### that includes the text of the failure output file

package/.github/workflows/playground.yml

@@ -43,6 +43,11 @@ jobs:
       PLAYGROUND_ID: ${{ secrets.PLAYGROUND_ID }}
       USER1_EMAIL: ${{ secrets.USER1_EMAIL }}
       USER1_PASSWORD: ${{ secrets.USER1_PASSWORD }}
+      USER_NO_PERMISSIONS_EMAIL: ${{ secrets.USER_NO_PERMISSIONS_EMAIL }}
+      USER_NO_PERMISSIONS_PASSWORD: ${{ secrets.USER_NO_PERMISSIONS_PASSWORD }}
+      USER_NO_PERMISSIONS_API_KEY: ${{ secrets.USER_NO_PERMISSIONS_API_KEY }}
+      INVALID_API_KEY: invalidAPIkey
+      EMPTY_STRING: ""
       SECRET_VAR1: secret-var1-value
       SECRET_VAR2: secret-var2-value
       SECRET_FOR_MISSING_FIELD: secret for missing field
@@ -61,17 +66,17 @@ jobs:
       - uses: ./
         #### Developer note: You can probably leave this out
         env:
-          ALKILN_TAG_EXPRESSION: "${{ (github.event.inputs.tags && format('{0}', github.event.inputs.tags)) || '(not @a11y) and (not @error)' }}"
+          ALKILN_TAG_EXPRESSION: "${{ (github.event.inputs.tags && format('{0}', github.event.inputs.tags)) || '(not @error) and (not @temp_error)' }}"
         with:
           #### Developer note: Required ALKiln inputs. You can read more at
-          #### https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing/#githubNyou-inputs
+          #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#githubNyou-inputs
           SERVER_URL: "${{ env.SERVER_URL }}"
           DOCASSEMBLE_DEVELOPER_API_KEY: "${{ env.DOCASSEMBLE_DEVELOPER_API_KEY }}"
-          #### Developer note: See https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing/#optional-inputs
+          #### Developer note: See https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
           #### You can probably leave this out
           # Internal: docassemble changes sometimes break @a11y tests. That is
           # a da problem, not ours. We will trigger these tests manually when we
           # want to check up on this.
           ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
           #### Developer note: You can probably leave this out
-          ALKILN_VERSION: output
+          ALKILN_VERSION: delete

package/CHANGELOG.md

@@ -45,6 +45,28 @@ Format:
 
 <!-- ## [Unreleased] -->
 
+## [5.13.0] - 2024-07-11
+
+## Added
+
+- Authors can now make sure that ALKiln deletes the interviews it creates for an ALKiln testing account. They can add a new (optional) value, an API key, to [the "sign in" Step](https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sign-in) and use the ["start interview" Step](https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#start-interview) to go to the interview. The API key must belong to the user who signs in. Example: `Given I sign in with the email "<username env var>", the password "<password env var>", and the API key "<user API key>`. Admins can create an API key for a regular user with https://docassemble.org/docs/api.html#api_user_user_id_api_post. We will add this to the documentation for the "sign in" Step.
+
+### Changed
+
+- Update links in logs to new Suffolk docs pages
+
+### Fixed
+
+- Now ALKiln deletes interviews upon interview completion for [signed in users](https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sign-in) as long as the user has an API key. Also, the author must have used the ["start interview" Step](https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#start-interview) to get to the interview. Admins can give an API key to a regular user with https://docassemble.org/docs/api.html#api_user_user_id_api_post. See [#831](https://github.com/SuffolkLITLab/ALKiln/issues/831).
+
+### Internal
+
+- Tests deleting interviews upon interview completion for signed in users.
+- Switches to mostly using a lowest-access-level user account for actually running interviews.
+- Switches to adding our own `users[0]` question because of changes in Assembly Line.
+- Adds @temp_error to neutralize tests that are getting undesired errors right now, but which we anticipate being fixed soon. We want to ignore them for a short while. For example, an upstream change temporarily breaking some tests.
+- Excludes docassemble/ALKiln files from log code checks.
+
 ## [5.12.0] - 2024-06-06
 
 ### Added

package/README.md

@@ -12,7 +12,7 @@ https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-rea
 
 ## Use ALKiln
 
-Read about how to use this framework in [Assembly Line's documentation](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/).
+Read about how to use [this framework in Assembly Line's documentation](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/intro).
 
 If you have questions or need to report a bug, [start a new issue](https://github.com/SuffolkLITLab/ALKiln/issues/new).
 

package/action.yml

@@ -1,5 +1,5 @@
 name: "ALKiln: Automated docassemble tests"
-description: "Automatically test any docassemble interview in a any branch on your GitHub repository whenever you commit or push. See https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing."
+description: "Automatically test any docassemble interview in a any branch on your GitHub repository whenever you commit or push. See https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/setup/#types."
 
 inputs:
   SERVER_URL:

package/docs/story_tables.md

@@ -4,7 +4,7 @@ The Story Table is a very flexible tool. It lets the author answer interview (fo
 
 When the robot arrives on each interview page, it finds all the fields on the page and loops through the whole Story Table trying to match rows with fields.
 
-Here's some [documentation on the use of Story Table rows](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#story-tables).
+Here's some [documentation on the use of Story Table rows](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing#story-table).
 
 ## Tracking use of rows
 

package/lib/docassemble/docassemble_api_REST.js

@@ -31,7 +31,28 @@ da.get_dev_id = async function ( timeout ) {
 };  // Ends da.get_dev_id()
 
 
-// node -e 'require("./lib/docassemble/docassemble_api_REST.js").delete_project( "create1" )'
+da.get_api_key_info = async function ( timeout, { api_key = null, server_url = null }) {
+  /** Get information about an API key owned by the user of the given API key. */
+  let options = {
+    method: 'GET',
+    headers: {'X-API-Key': api_key},
+    url: `${ server_url }/api/user/api`,
+    params: {
+      api_key: api_key,
+    },
+    timeout: timeout,
+  };
+
+  try {
+    return await axios.request( options );
+  } catch (error) {
+    let response = error.response || { data: null }
+    throw {...error.toJSON(), data: response.data};
+  }
+};  // Ends da.get_api_key_info()
+
+
+// node -e 'require("./lib/docassemble/docassemble_api_REST.js").delete_project()'
 da.delete_project = async function ( timeout ) {
   /* Delete a project on the user's da server. */
   let options = {
@@ -53,6 +74,51 @@ da.delete_project = async function ( timeout ) {
 };  // Ends da.delete_project()
 
 
+// node -e 'require("./lib/docassemble/docassemble_api_REST.js").delete_interview(...)'
+da.delete_interview = async function ( timeout, { session = null, api_key = null }) {
+  /* Delete an interview with the given session id. */
+  let options = {
+    method: 'DELETE',
+    headers: { 'X-API-Key': api_key },
+    // Can't use `api/session` that uses the API key to identify the user's
+    // interview sessions. The test may have signed in with an account
+    // that's different than the ALKiln dev account that sends this request.
+    url: `${ session_vars.get_da_server_url() }/api/user/interviews`,
+    params: { session },
+    timeout: timeout,
+  };
+
+  try {
+    return await axios.request( options );
+  } catch (error) {
+    let response = error.response || {data: null}
+    throw {...error.toJSON(), data: response.data};
+  }
+};  // Ends da.delete_interview()
+
+// node -e 'require("./lib/docassemble/docassemble_api_REST.js").get_interview(...)'
+da.get_interview = async function ( timeout, { session = null, api_key = null }) {
+  /* Get a specific interview. */
+  let options = {
+    method: 'GET',
+    headers: { 'X-API-Key': api_key },
+    // Can't use `/api/user/interviews` that uses the API key to identify the user's
+    // interview sessions. The test may have signed in with an account
+    // that's different than the ALKiln dev account that sends this request.
+    url: `${ session_vars.get_da_server_url() }/api/user/interviews`,
+    params: { session },
+    timeout: timeout,
+  };
+
+  try {
+    return await axios.request( options );
+  } catch ( error ) {
+    let response = error.response || { data: null }
+    throw { ...error.toJSON(), data: response.data };
+  }
+};  // Ends da.get_interview()
+
+
 // node -e 'require("./lib/docassemble/docassemble_api_REST.js").__delete_projects_starting_with( "testingdocassembleALAutomatedTestingTestsmain", 1, 1 )'
 da.__delete_projects_starting_with = async function ( base_name, starting_num=1, ending_num ) {
   /** FOR DEVELOPMENT ONLY. Deletes a set of Projects that start with a shared

package/lib/docassemble/docassemble_api_interface.js

@@ -15,6 +15,9 @@ const time = require('../utils/time');
 // to specific functions, which can run in a very small
 // window.
 
+// TODO: Move get_dev_id() and such into here instead of in
+// docassemble_REST - args should be the same vals as the request expects
+
 /** Notes:
 * - Checking for a busy server is vulnerable to race conditions, but
 *    there's nothing we can do about that.
@@ -174,13 +177,74 @@ da_i.get_dev_id = async function ( dev_id_options ) {
   return dev_id;
 };  // Ends da_i.get_dev_id();
 
+da_i.get_api_key_access_status = async function ({ timeout = null, api_key = null }) {
+  /** Check if the API key has minimal authorization on the server.
+  *    See https://docassemble.org/docs/api.html#api_user_api_get.
+  *
+  * @param options {obj} Options for getting authorization of the API key
+  * @param options.api_key {str | null} Required. The API key to test.
+  * @param options.timeout {int | null} Optional. Max MS
+  *    to allow for server request.
+  */
+
+  let auth_data = {
+    codes: [ 1 ],
+    has_auth: null,
+    messages: [`API key authorization is not yet determined.`],
+    error: null
+  }
+
+  // Skip this for tests run from ALKilnInThePlayground
+  if ( session_vars.get_origin() === 'playground' ) {
+    auth_data.codes.push( 2 );
+    auth_data.messages.push( `API keys are unnecessary for tests run in the Playground.` );
+  }
+
+  if ( typeof api_key !== `string` ) {
+    auth_data.codes.push( 3 );
+    auth_data.messages.push( `The given API key is not a string. Type: ${ typeof api_key }`);
+  }
+
+  if ( auth_data.codes.length === 1 ) {
+    // Default timeouts
+    timeout = timeout || DEFAULT_MAX_REQUEST_MS;
+    try {
+      let response = await _da_REST.get_api_key_info( timeout, {
+        api_key,
+        server_url: session_vars.get_da_server_url(),
+      });
+      auth_data.has_auth = true;
+      auth_data.codes = [ 6 ];
+      auth_data.messages = [ `This API key has at least basic authorization on this server.` ];
+
+    } catch ( error ) {
+      auth_data.error = error;
+      if ( error.status === 403 ) {
+        auth_data.has_auth = false;
+        auth_data.codes = [ 4 ];
+        auth_data.messages = [ `This API is unverified on this server. It is probably missing or has been deleted.` ];
+      } else {
+        // Note on 404, non-existent key: 404 == 403 - Since we're using the
+        // key itself to get its own info, if it doesn't exist, we'll get 403
+        auth_data.codes = [ 5 ];
+        auth_data.messages = [ `This API key threw a non-403 error.` ];
+      }  // ends error status
+    }  // ends try
+  }  // ends auth_data.codes only has the first code
+
+  log.debug({ type: `da api info`, code: `ALK0202`,
+    pre: `API key authentication info`, data: auth_data });
+
+  return auth_data;
+};  // Ends da_i.get_api_key_access_status()
+
 // node -e 'require("./lib/docassemble/docassemble_api_interface.js").delete_project( "create1" )'
 da_i.delete_project = async function ( delete_options ) {
   /** Delete a project on the user's da server. Do we need to watch
   *   for a timeout? */
 
   // Defaults
-  let { timeout } = delete_options ||  { timeout: DEFAULT_MAX_REQUEST_MS };
+  let { timeout } = delete_options || { timeout: DEFAULT_MAX_REQUEST_MS };
 
   let project_name = session_vars.get_project_name()
   log.info({ type: `da api`, code: `ALK0170`, pre: `Trying to delete Project ${ project_name }` });
@@ -196,3 +260,117 @@ da_i.delete_project = async function ( delete_options ) {
   }
 
 };  // Ends da_i.delete_project()
+
+// node -e 'require("./lib/docassemble/docassemble_api_interface.js").quietly_try_to_delete_interviews(...)'
+da_i.quietly_try_to_delete_interviews = async function ({ interviews = {}, api_keys = [], options = {} }) {
+  /** Try to delete the given interviews. Fail silently. Example failure: the test
+   *    did not log in any users and the testing account's role prevents
+   *    access to other user's interviews. Do we need to watch for a timeout? */
+
+  // Defaults
+  let { timeout } = options || { timeout: DEFAULT_MAX_REQUEST_MS };
+
+  let responses = [];
+  for ( let id in interviews ) {
+    let interview = interviews[ id ];
+    if ( interview && interview.uid ) {
+      let sub_responses = await da_i.quietly_delete_one_interview( timeout, {
+        interview,
+        api_keys
+      });
+      responses.push( sub_responses );
+    } else {
+      log.debug({ type: `da api info`, code: `ALK0191`, pre: `There is no interview to delete.` });
+    }
+  }
+  return responses;
+};  // Ends da_i.quietly_try_to_delete_interviews()
+
+// node -e 'require("./lib/docassemble/docassemble_api_interface.js").quietly_delete_one_interview(...)'
+da_i.quietly_delete_one_interview = async function ( timeout, { interview = {}, api_keys = [] }) {
+  /** Try to delete an interview using all available API keys. Fail silently.
+   *    Example failure: the test did not log in any users and the testing
+   *    account's role prevents access to other user's interviews. */
+
+  let responses = [];
+  for ( let api_key of api_keys ) {
+    try {
+      log.debug({ type: `da api info`, code: `ALK0188`,
+        pre: `Trying to delete the interview with the id ${ interview.uid } and an API key.`
+      });
+
+      // Actual work:
+      let response = await _da_REST.delete_interview( timeout, {
+        session: interview.uid,
+        api_key
+      });
+      responses.push( response );
+
+      log.debug({ type: `da api info`, code: `ALK0189`,
+        pre: `No error when trying to delete interview ${ interview.uid } at ${ interview.i }.`
+      });
+    } catch ( error ) {
+      error.interview = interview;
+      let msg = `Error when deleting the interview. See https://docassemble.org/docs/api.html#session_delete.`
+      log.debug({ type: `da api info`, code: `ALK0190`, pre: msg, data: error });
+    }
+  }  // ends for api keys
+  return responses;
+};  // Ends da_i.quietly_delete_one_interview()
+
+// node -e 'require("./lib/docassemble/docassemble_api_interface.js").get_interviews(...)'
+da_i.get_interviews = async function ({ interviews = {}, api_keys = [], options = {} }) {
+  /** Return an object of interviews that exist on the server
+   *    that match the given interviews. Keys are the session ids. */
+
+  let fetched_interviews = {};
+  if ( interviews ) {
+    for ( let id in interviews ) {
+      let interview = interviews[ id ];
+      let fetched = await da_i.get_interview({ interview, api_keys, options });
+      if ( fetched && fetched.session ) {
+        fetched_interviews[ fetched.session ] = fetched;
+      }
+    }
+  }  // ends if interviews
+
+  return fetched_interviews;
+};  // Ends da_i.get_interviews()
+
+// node -e 'require("./lib/docassemble/docassemble_api_interface.js").get_interview(...)'
+da_i.get_interview = async function ({ interview = {}, api_keys = [], options = {} }) {
+  /** Try to get an interview from the server that matches the given interview data. */
+
+  // Defaults
+  let { timeout } = options || { timeout: DEFAULT_MAX_REQUEST_MS };
+
+  if ( interview && interview.uid ) {
+    for ( let api_key of api_keys ) {
+      try {
+        log.debug({ type: `da api info`, code: `ALK0192`, pre: `Trying to get the interview with the id ${ interview.uid } and an API key.` });
+
+        // Actual work:
+        let response = await _da_REST.get_interview( timeout, {
+          session: interview.uid,
+          api_key
+        });
+
+        if ( response && response.data && response.data.items && response.data.items[0] && response.data.items[0].session ) {
+          log.debug({ type: `da api info`, code: `ALK0193`, pre: `Status ${ response.status }. Got ${ response.data.items[0].session }.`});
+          return response.data.items[0];
+        } else {
+          log.debug({ type: `da api info`, code: `ALK0194`, pre: `Status ${ response.status }. Cannot find ${ interview.uid }`});
+        }
+
+      } catch ( error ) {
+        error.interview = interview;
+        let msg = `${ error.status || `No error.status.` } ${ error.statusText || error.data || `No error.statusText.` } Ran into an error when getting the interview ${ interview.uid }. See https://docassemble.org/docs/api.html#interviews.`
+        log.debug({ type: `da api info`, code: `ALK0195`, pre: msg, data: error });
+      }
+    }  // ends for api_keys
+  } else {
+    log.debug({ type: `da api info`, code: `ALK0196`, pre: `There is no interview to get.` });
+  }
+
+  return null;
+};  // Ends da_i.get_interview()

package/lib/run_cucumber.js

@@ -8,6 +8,7 @@ const session_vars = require('./utils/session_vars');
 
 const SUMMARY_FILENAME = `cucumber-report.txt`;
 
+
 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();
@@ -124,7 +125,8 @@ function build_config( command_args ) {
   let summary_file_name = SUMMARY_FILENAME;
   fs.readFile(summary_file_name, 'utf8', (err, text) => {
     if (err) {
-      log.error({ type: `internal run`, code: `ALK0056`, pre: `Failed to read cucumber report`, data: err });
+      // Something else will probably show an error that's more relevant
+      log.info({ type: `run`, code: `ALK0056`, pre: `Failed to read cucumber report`, data: err });
       return;
     }
 
@@ -137,7 +139,7 @@ function build_config( command_args ) {
     try {
       fs.appendFileSync( `${ artifacts_path }/${ log.debug_log_file }`, `\n\n${text}`);
     } catch ( error ) {
-      log.info({ type: `internal run`, code: `ALK0182`, pre: `Something probably went wrong earlier. Look above for more details, but here's more info just in case: ALKiln was unable to write to ${ artifacts_path }/${ log.debug_log_file }.`, data: error });
+      log.info({ type: `run`, code: `ALK0182`, pre: `Something probably went wrong earlier. Look above for more details, but here is more information just in case: ALKiln was unable to write to ${ artifacts_path }/${ log.debug_log_file }.`, data: error });
     }
     try {
       // Add to a unexpected results file when tests themselves fail
@@ -145,7 +147,7 @@ function build_config( command_args ) {
         fs.appendFileSync( `${ artifacts_path }/${ log.unexpected_filename }`, `\n\n${ text }` );
       }
     } catch ( error ) {
-      log.info({ type: `internal run`, code: `ALK0181`, pre: `Something probably went wrong earlier. Look above for more details, but here's more info just in case: ALKiln was unable to write to ${ artifacts_path }/${ log.unexpected_filename }.`, data: error });
+      log.info({ type: `run`, code: `ALK0181`, pre: `Something probably went wrong earlier. Look above for more details, but here is more information just in case: ALKiln was unable to write to ${ artifacts_path }/${ log.unexpected_filename }.`, data: error });
     }
   });
 })();

package/lib/scope.js

@@ -16,7 +16,7 @@ const time = require('./utils/time');
 const log = require('./utils/log');
 const { waitForTimeout } = require('./utils/time');
 const files = require('./utils/files' );
-const server = require('./docassemble/docassemble_api_interface');
+const da_api = require('./docassemble/docassemble_api_interface');
 const wrapPromiseWithTimeout = require('./cucumber_8_shim');
 const reports = require(`./utils/reports`);
 
@@ -339,7 +339,7 @@ module.exports = {
       // This code assumes a reasonable response time would be n seconds if the
       // server is up and that a server reload/restart won't take less than n seconds.
       // Also, it's non-blocking, so it doesn't slow down tests
-      let is_up = await server.is_server_responding({ timeout: scope.server_check_interval_ms });
+      let is_up = await da_api.is_server_responding({ timeout: scope.server_check_interval_ms });
       // Add status to the beginning of the list to make truncating easier
       scope.server_statuses.unshift( is_up );
 
@@ -627,7 +627,7 @@ module.exports = {
       interview_url = `${ base_url }${ file_name }`;
     }
 
-    reports.addToReport(scope,{
+    reports.addToReport(scope, {
       code: `ALK0113`,
       type: `row info`,
       value: `Trying to load the interview at "${ interview_url }"`
@@ -638,7 +638,17 @@ module.exports = {
     // TODO: implement and use scope.handle_possible_timeout()
     try {
 
-      await scope.page.goto(interview_url, { waitUntil: 'domcontentloaded', timeout: scope.timeout })
+      await scope.page.goto(interview_url, { waitUntil: 'domcontentloaded', timeout: scope.timeout });
+      // Get interview session values, if possible, so we can delete the session later
+      let interview_vars = await scope.page.evaluate(async function() {
+        try {
+          // won't exist on non-da interview pages
+          return await get_interview_variables();
+        } catch (error) {
+          return null;
+        }
+      });
+      scope.set_interview_session_data( scope, { vars: interview_vars });
 
     } catch ( error ) {
 
@@ -682,6 +692,36 @@ module.exports = {
     return scope.page;
   },  // Ends scope.load()
 
+  set_interview_session_data: function ( scope, { vars = null }) {
+    /** Sets this interview's session data for this scenario if it doesn't
+     *    already exist.
+     *
+     * @returns final_vars { object | null }
+     * @returns final_vars.i { str } File path of interview
+     * @returns final_vars.uid { str } UID of interview
+     * */
+    if ( vars && vars.i ) {
+      let scenario = scope.scenarios.get( scope.scenario_id );
+      if ( !scenario.interviews ) { scenario.interviews = {}; }
+      if ( !scenario.interviews[ vars.uid ] ) {
+        scenario.interviews[ vars.uid ] = vars;
+        log.debug({
+          code: `ALK0185`, type: `info`,
+          pre: `Saved new interview data. File path: ${ vars.i }. Session id: ${ vars.uid }.`
+        });
+      } else {
+        log.debug({
+          code: `ALK0186`, type: `info`,
+          pre: `Interview data already existed. File path: ${ vars.i }. Session id: ${ vars.uid }.`
+        });
+      }
+      return vars;
+    } else {
+      log.debug({ code: `ALK0187`, type: `info`, pre: `Found no interview data.` });
+      return null;
+    }
+  },  // Ends scope.set_interview_session_data()
+
   getLoadData: async function ( scope ) {
     /* Return elements that could load on the page, like #daMainQuestion
     * and #da-retry. If there's a system error on the page, return its main text.
@@ -771,7 +811,7 @@ module.exports = {
             if ( row_raw.length > 3 ) { more_or_less = `less`; }
             let bad_table_msg = `Your Story Table should have ${ more_or_less } than`
               + ` ${ row_raw.length } columns. Take another look at Story Table documentation at`
-              + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#story-tables.`
+              + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing#story-table.`
             reports.addToReport( scope, { type: `error`, code: `ALK0120`, value: bad_table_msg})
             throw Error(bad_table_msg);
           }
@@ -798,7 +838,7 @@ module.exports = {
           let not_in_env_msg = `ALKiln could not find the GitHub secret "${ row.flags.secret_name }".`
             + ` Check for a typo and check your workflow file.`
             + ` Read more about using GitHub secrets in your workflow file at`
-            + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#github-secrets.`
+            + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/writing#secrets.`
           reports.addToReport( scope, { type: `error`, code: `ALK0121`, value: not_in_env_msg });
           throw ReferenceError(not_in_env_msg);
         }
@@ -1317,6 +1357,7 @@ module.exports = {
     * setting fields, and an object for a DOM field, returns list of the
     * rows that match the DOM field. That list of story table rows may be empty.
     *
+    * Using a `trigger` column is deprecated, but still used in many tests in the wild.
     * For notes on trigger var, see https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger
     * 
     * @param var_data {arr} - fields and the values they can be set to
@@ -1411,9 +1452,13 @@ module.exports = {
 
       // field/page trigger name is needed but is missing.
       if ( !page_trigger_name ) {
-        let page_trigger_warning = `A field on this page uses an index `
-          + `variable or a generic object, but the page is missing `
-          + `the ALKiln "trigger" variable's name. See `
+        let page_trigger_warning = `You are using a 3-column Story Table. If possible, you should `
+          + `think about switching to the newer, easier, 2-column Story Table. That will probably `
+          + `get rid of this warning. Read more at `
+          + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/trouble#deprecated-story-tables. `
+          + `If you still want to use this 3-column format, here is more info about the warning: `
+          + `A field on this page uses an index variable or a generic object in a 3-column `
+          + `Story Table, but the page is missing the ALKiln "trigger" variable's name. See `
           + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#a-missing-trigger-variable.`;
         reports.addToReport(scope, { type: `warning`, code: `ALK0127`, value: page_trigger_warning });
       }
@@ -1430,7 +1475,7 @@ module.exports = {
 
           // First, make the row data more readable to humans.
           let row_as_story_table = reports.convertToOriginalStoryTableRow( scope, { row_data: row_that_matches_this_field });
-          let row_trigger_warning = `This Story Table row needs a value in the "trigger" `
+          let row_trigger_warning = `This 3-column Story Table row needs a value in the "trigger" `
             + `column, but it is empty. The test might get unexpected results. See `
             + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger.`
             + `\nThe rows:\n${ row_as_story_table }`;
@@ -1467,7 +1512,7 @@ module.exports = {
 
         let all_trigger_names_conflict_msg = `${ rows_that_match_field_names.length } `
           + `Story Table row(s) matched a field name, but didn't match a trigger `
-          + `variable. The Story Table might be missng a row or a trigger variable. `
+          + `variable. This 3-column Story Table might be missing a row or a trigger variable. `
           + `The test will have to ignore this field. See `
           + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger.`
           + `\nThe row(s) data:\n${ conflicts_as_story_table_rows.join( `\n` )}`
@@ -2893,7 +2938,9 @@ module.exports = {
       await scope.afterStep(scope, {waitForShowIf: true});
     },  // Ends scope.steps.set_al_address()
 
-    sign_in: async function ( scope, { email_secret_name, password_secret_name }) {
+    sign_in: async function ( scope, {
+      email_secret_name, password_secret_name, api_key_secret_name
+    }) {
       /** Allow the developer to log a user into their server using GitHub
       * secrets to authenticate.
       */
@@ -2946,6 +2993,26 @@ module.exports = {
       if ( password === undefined ) {
         reports.addToReport( scope, { type: `error`, code: `ALK0162`, value: password_msg })
       }
+      // Save API key to clean up interviews later. Nice to have, not critical
+      if ( api_key_secret_name ) {
+        let api_key = process.env[ api_key_secret_name ];
+        let api_key_msg = `The API key in the variable "${ api_key_secret_name }" is missing. Check for a typo in your test, workflow file, GitHub secret, or server config.`
+        if ( api_key === undefined ) {
+          reports.addToReport( scope, { type: `warning`, code: `ALK0199`, value: api_key_msg });
+        } else if ( api_key === `` ) {
+          reports.addToReport( scope, { type: `warning`, code: `ALK0200`,
+            value: `ALKiln found the API key in the variable "${ api_key_secret_name }", but it was empty. It had no text in it. Edit the value of the GitHub secret or server config variable called "${ api_key_secret_name }".` });
+        } else {
+          let access_info = await da_api.get_api_key_access_status({ api_key });
+          if ( !access_info.has_auth ) {
+          reports.addToReport( scope, { type: `warning`, code: `ALK0201`,
+            value: `The server rejected the API key in the variable "${ api_key_secret_name }". Does it exist on this server? Was it deleted somehow? You can always make a new one.` });
+          }
+          // Even if it doesn't have access, give it a shot anyway.
+          // Maybe we got something wrong.
+          scope.scenarios.get( scope.scenario_id ).api_keys.push( api_key );
+        }
+      }
 
       expect( email, email_msg ).to.not.equal( undefined );
       expect( password, password_msg ).to.not.equal( undefined );

package/lib/steps.js

@@ -22,6 +22,7 @@ const log = require('./utils/log');
 const session_vars = require('./utils/session_vars');
 const files = require('./utils/files' );
 const reports = require(`./utils/reports`);
+const da_api = require('./docassemble/docassemble_api_interface');
 
 /* Of Note:
 - We're using `*=` for selectors because sometimes da text has funny characters in it that are hard to anticipate
@@ -83,6 +84,9 @@ let click_with = {
 
 BeforeAll(async () => {
   scope.showif_timeout = 600;
+  // TODO: Do these really need to be maps? As sets, they may make the output
+  // more predictable to the user, but they add complexity.
+  scope.scenarios = new Map();
   scope.report = new Map();
 
   // Start tracking whether server is up and running
@@ -93,7 +97,7 @@ BeforeAll(async () => {
 
   // TODO: figure out how to test file and folder creation stuff,
   // especially when setup is excluded from the flow.
-  
+
   // 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.
@@ -127,13 +131,16 @@ Before(async (scenario) => {
     }
   }
   // Clean up all previously existing pages
-  for (const page of await scope.browser.pages()) { 
+  for (const page of await scope.browser.pages()) {
     await page.close();
   }
   // Make a new page
   scope.page = await scope.browser.newPage()
 
   scope.scenario_id = uuidv4();
+  scope.scenarios.set( scope.scenario_id, {} );
+  scope.scenarios.get( scope.scenario_id ).interviews = {};
+  scope.scenarios.get( scope.scenario_id ).api_keys = [];
   scope.expected_status = null;
   scope.expected_in_report = null;
   scope.expected_not_in_report = null;
@@ -179,7 +186,7 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
 
   // Load the right interview page
   await scope.load( scope, file_name );
-  
+
   // The page timeout is set in here too in case someone set a custom timeout
   // just before a page was loaded for the Scenario. Move this to just after page creation?
   // The function itself won't really timeout here, so we don't need to wrap it in
@@ -274,21 +281,27 @@ Given(/I go to "([^"]+)"/i, {timeout: -1}, async ( url ) => {
   return result;
 });
 
-Given(/I (?:sign|log) ?(?:in)?(?:on)?(?:to the server)? with(?: the email)? "([^"]+)" and(?: the password)? "([^"]+)"(?: SECRETs)?/i, {timeout: -1}, async ( email, password ) => {
+Given(
+  /I (?:sign|log) ?(?:in)?(?:on)?(?:to the server)? with(?: the email)? "([^"]+)",?(?: and)?(?: the password)? "([^"]+)"(?: SECRETs)?(?:,?(?: and)?(?: the API key)? "([^"]+)")?/i,
+  { timeout: -1 },
+  async ( email, password, api_key ) => {
   /** Uses the names of environment variables (most often GitHub SECRETs) to
-  *     log into an account on the user's server. Must be SECRETs to stay secure.
+  *     log into an account on the user's server. Must be secure.
   * 
   * Variations:
-  * I sign into the server with the email "USER1_EMAIL" and the password "USER1_PASSWORD" SECRETs
-  * I sign on with the email "USER1_EMAIL" and the password "USER1_PASSWORD" SECRETs
-  * I log in with "USER1_EMAIL" and "USER1_PASSWORD"
+  * I sign into the server with the email "USER2_EMAIL" and the password "USER2_PASSWORD"
+  * I sign on with the email "USER2_EMAIL" and the password "USER2_PASSWORD"
+  * I log in with "USER2_EMAIL" and "USER2_PASSWORD"
+  * I sign in with the email "USER2_EMAIL", the password "USER2_PASSWORD", and the API key "USER2_API_KEY"
+  * I sign in with "USER2_EMAIL", "USER2_PASSWORD", "USER2_API_KEY"
   */
   // `page` timeout will deal with custom timeout
   // Couldn't test the timeout for tapping the button because there's not
   // enough of a pause between initial navigation and pressing button.
   await scope.steps.sign_in( scope, {
     email_secret_name: email,
-    password_secret_name: password
+    password_secret_name: password,
+    api_key_secret_name: api_key
   });
 });
 
@@ -313,7 +326,7 @@ Given(/the max(?:imum)? sec(?:ond)?s for each step (?:in this scenario )?is (\d+
   /* At any time, set a custom timeout for the scenario. */
   // TODO: Add 1 second to this to allow other steps to not fail, like "I wait n seconds"
   scope.timeout = parseInt( seconds ) * 1000;
-  
+
   // Cucumber timeouts are made custom for each step that needs it
 
   // If there is no page yet, we've ensured custom timeout will still be set
@@ -653,7 +666,7 @@ Then('I should see the link to {string}', async ( url ) => {  // √
   let msg = `Cannot find a link to "${ url }".`;
   if ( !link ) { reports.addToReport(scope, { type: `error`, code: `ALK0080`, value: msg }); }
   expect(link, msg ).to.exist;
-  
+
   await scope.afterStep(scope);
 });
 
@@ -662,7 +675,7 @@ Then(/the "([^"]+)" link leads to "([^"]+)"/, async (linkText, expected_url) =>
   let [link] = await scope.page.$x(`//a[contains(text(), "${linkText}")]`);
   // TODO: Possibly add a check here for the link text, though note this
   // Step is not currently supported.
-  
+
   let prop_obj = await link.getProperty('href');
   let actual_url = await prop_obj.jsonValue();
 
@@ -756,7 +769,7 @@ Then(/I expect the baseline PDF "([^"]+)" and the new PDF "([^"]+)" to be the sa
   * Variations:
   * Then I expect the baseline PDF "simple-doc-Baseline.pdf" and the new PDF "simple-doc.pdf" to be the same
   */
-  
+
   return await wrapPromiseWithTimeout(
     scope.steps.compare_pdfs(scope, {existing_pdf_path, new_pdf_path}),
     scope.timeout
@@ -880,7 +893,7 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
 
       // Set up timeout to stop infinite loops
       let page_timeout_id = setTimeout(async function() {
-        
+
         // Make sure to only throw once
         if ( has_thrown ) { return; }
         else { has_thrown = true; }
@@ -1178,6 +1191,71 @@ Given(/the final Scenario status should be "([^"]+)"/i, async ( expected_status
   scope.expected_status = expected_status.toUpperCase();
 });
 
+Then(/of two interviews, I delete one __internal__/i, async () => {
+  /** Test that an interview does get successfully deleted. This tests whether
+   *    the API code is working correctly.
+   */
+  // Make sure we have two interviews in `scope.scenario.interviews` (two session ids)
+  let interviews = scope.scenarios.get( scope.scenario_id ).interviews;
+  let interview_keys = Object.keys( interviews );
+  expect(
+    interview_keys.length,
+    `Of 2 interview sessions, ALKiln only saved ${ interview_keys.length }`
+  ).to.equal( 2 );
+
+  // Check that both interviews exist on the server. 1 √ 2 √
+  let api_keys = scope.scenarios.get( scope.scenario_id ).api_keys;
+  let visible_interviews = await da_api.get_interviews({ interviews, api_keys });
+  let visible_keys = Object.keys( visible_interviews );
+  expect(
+    visible_keys.length,
+    `2 interviews should be on the server. Instead: "${ visible_keys.join(', ') }"`
+  ).to.equal( 2 );
+
+  // Delete one. 1 x 2 √
+  let to_delete = interviews[ interview_keys[ 0 ]];
+  await da_api.quietly_try_to_delete_interviews({
+    interviews: { [interview_keys[ 0 ]]: to_delete },
+    api_keys
+  });
+
+  // Check that only one session exists on the server. This tests that
+  // 1. An interview has been deleted and
+  // 2. We are fetching interviews correctly because we are getting one
+  // back (e.g. not passing null into the api function)
+  // 1 x 2 √
+  let after_deletion = await da_api.get_interviews({ interviews, api_keys });
+  let keys_after_deletion = Object.keys( after_deletion );
+  expect(
+    keys_after_deletion.length,
+    `1 interviews should be on the server: ${ keys_after_deletion.join(', ') }`
+  ).to.equal( 1 )
+  // In After(), the other session should get deleted
+});
+
+Then(/I fail to delete (\d) detected interview(?:s)? and get no error __internal__/i, async ( num ) => {
+  /** Test that there is no error when ALKiln is unable to delete an interview. */
+  num = parseInt( num );
+  // Make sure we started an interview
+  let interviews = scope.scenarios.get( scope.scenario_id ).interviews;
+  expect(
+    Object.keys( interviews ).length,
+    `The test should have saved ${ num } interview session(s)`
+  ).to.equal( num );
+
+  // There should be no error about an unauthorized user
+  let api_keys = scope.scenarios.get( scope.scenario_id ).api_keys;
+  let visible_interviews = await da_api.get_interviews({ interviews, api_keys });
+  let visible_keys = Object.keys( visible_interviews );
+  expect(
+    visible_keys.length,
+    `User should detect 0 interviews on the server. Instead: "${ visible_keys.join(', ') }"`
+  ).to.equal( 0 );
+
+  // Deleting with an anonymous user should fail silently
+  await da_api.quietly_try_to_delete_interviews({ interviews, api_keys });
+});
+
 
 //#####################################
 //#####################################
@@ -1314,8 +1392,8 @@ After(async function(scenario) {
       // it as failed too.
       expected_status_was_met = false;
       // Keep it general. Users may see this message, e.g. for a11y tests.
-      let msg = `Test failed. Expected status: ${scope.expected_status}. `
-          + `ALKiln's assessed status: ${ changeable_test_status }. `
+      let msg = `Test ${ changeable_test_status }. `
+          + `Expected status: ${scope.expected_status}. `
           + `See the report for details.`;
       let code = `ALK0099`;
       log.debug({ type: `error`, code: code, pre: msg, })
@@ -1372,7 +1450,7 @@ After(async function(scenario) {
             code: code,
             message: non_reload_report_msg,
           }, error });
-        } catch {
+        } catch ( error ) {
           signout_error_msg = `🤕 ${ code } ERROR: ${ non_reload_report_msg }`;
         }
       } else {
@@ -1387,10 +1465,43 @@ After(async function(scenario) {
 
   }  // ends if scope.page
 
+  // Now that we're no longer on the interview page, one way or
+  // another, try to delete the interviews created during the test
+  // Authors running this manually get to choose what to do with
+  // the interviews they're creating unless we hear otherwise.
+  if ( session_vars.get_origin() !== `playground` ) {
+    try {
+      let interviews = scope.scenarios.get( scope.scenario_id ).interviews;
+      let api_keys = scope.scenarios.get( scope.scenario_id ).api_keys;
+      await da_api.quietly_try_to_delete_interviews({ interviews, api_keys });
+      let visible_interviews = await da_api.get_interviews({ interviews, api_keys });
+      let visible_keys = Object.keys( visible_interviews );
+      // Deleting interviews is nice, but not non-critical. Don't bother the
+      // user with it. Don't want to cover up a more meaningful failure (like
+      // going to the wrong file). If it becomes a problem we can track it down later.
+      if ( visible_keys.length > 0 ) {
+        // Can an API key ever see an interview that it can't delete?
+        log.info({ type: `internal warning`, code: `ALK0197`,
+          pre: `The API key can see ${ visible_keys.length } interviews that were not deleted: ${ visible_keys.join( ', ' ) }`
+        });
+      }
+    } catch ( error ) {
+      // Deleting interviews is nice, but not non-critical. Don't bother the
+      // user with it. Don't want to cover up a more meaningful failure (like
+      // going to the wrong file). Example of OK failure: the user owns the
+      // interview is different than the API key that's trying to delete the
+      // interview. If it becomes a problem we can track it down later.
+      // Consider add "internal" to docs: "If you see this, make an
+      // issue in ALKiln with your debug/verbose log"
+      log.info({ type: `internal warning`, code: `ALK0198`, pre: `Error while cleaning up interviews.`, data: error });
+    }
+  }
+
+  // Handle all the accumulated errors
   let errors = []
   if ( !expected_status_was_met ) { errors.push( expected_status_err_msg ); }
   if ( !signout_succeeded ) { errors.push( signout_error_msg ); }
-  if ( !expected_status_was_met || !signout_succeeded ) {
+  if ( errors.length > 0 ) {
     throw new Error( `${errors.join( errors, '\n')}` );
   }
 

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.12.0",
+  "version": "5.13.0",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
     "test": "npm run unit && npm run codes && npm run cucumber",
     "cucumber": "./lib/run_cucumber.js",
     "local": "npm run setup && npm run cucumber; npm run takedown",
-    "pass": "npm run cucumber 'not @error'",
+    "pass": "npm run cucumber 'not @error and not @temp_error'",
     "fail": "npm run cucumber '@error'",
     "setup": "./lib/docassemble/setup.js",
     "takedown": "./lib/docassemble/takedown.js",
@@ -32,7 +32,7 @@
   "bugs": {
     "url": "https://github.com/SuffolkLITLab/ALKiln/issues"
   },
-  "homepage": "https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/",
+  "homepage": "https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/intro",
   "dependencies": {
     "@axe-core/puppeteer": "4.7.3",
     "@cucumber/cucumber": "9.3.0",

package/setup.py

@@ -50,7 +50,7 @@ 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/alkiln/intro',
       packages=find_packages(),
       namespace_packages=['docassemble'],
       install_requires=['docassemble.ALToolbox>=0.8.2', 'docassemble.AssemblyLine>=2.24.0'],

package/tests/log_codes/check_codes.sh

@@ -16,7 +16,7 @@ fi
 # The grepped files will include the list of all the codes that have been
 # removed and are no longer used. Syntax used works with GitHub cli ([[:digit:]])
 # https://stackoverflow.com/a/6901221
-lines=$(grep -roh --exclude="tests/log_codes/check_codes.sh" --exclude="debug_log.txt" --exclude="cucumber-report.txt" --exclude-dir="node_modules" --exclude-dir='alkiln-*' --exclude-dir='_alkiln*' 'ALK[[:digit:]][[:digit:]][[:digit:]][[:digit:]]' "$directory")
+lines=$(grep -roh --exclude="tests/log_codes/check_codes.sh" --exclude="debug_log.txt" --exclude="cucumber-report.txt" --exclude-dir="ALKilnTests" --exclude-dir="node_modules" --exclude-dir='alkiln-*' --exclude-dir='_alkiln*' 'ALK[[:digit:]][[:digit:]][[:digit:]][[:digit:]]' "$directory")
 sorted=$(echo "$lines" | sort -n)