@suffolklitlab/alkiln 4.0.0-pre-api.8 → 4.1.0

package/CHANGELOG.md

@@ -38,12 +38,15 @@ Format:
 ### Security
 - 
 -->
-<!--2022-02-11 -->
+<!-- ## [Unreleased] -->
+## [4.1.0] - 2022-04-01
+### Added
+- Step to set vars to secret variables. That is, using environment variables while hiding the names of those variables in the report, errors, and console logs.
 
-## [Unreleased]
+## [4.0.0] - 2022-03-30
 ### Added
-- Add action.yml that runs most of what users' workflows run now, along with notes for a new user workflow that will take less maintainance. See #420. We need to add documentation on how to write a workflow file as it currently is if they want to take back control. Setup interview has not yet been updated with this workflow.
-- Add package.json creation/overwriting to action.yml. Simplify package.json.
+- BREAKING: Add package.json creation/overwriting to action.yml. Simplify package.json.
+- BREAKING: Add action.yml that runs most of what users' workflows run now, along with notes for a new user workflow that will take less maintainance. See #420. We need to add documentation on how to write a workflow file as it currently is if they want to take back control. Setup interview has not yet been updated with this workflow.
 - Step: `the text in the JSON variable "variable_with_text_value" should be`. Compare JSON variable with a text value to given text. See #470. Does not accept nested values, e.g. "child.name.first". Downloads all the JSON vars to a .json file in the "downloads" artifacts.
 - Step to log the page's JSON variables and values in the report. Future goal: save to file. See #454.
 - Step to log into the developer's docassemble server account using GitHub SECRETs. See #499.
@@ -51,15 +54,17 @@ Format:
 - Add control of alkiln npm version to the action.yml
 
 ### Changed
-- Update to v13 of puppeteer
-- Update to v7 of cucumber
-- Update action.yml node to v17
-- Use alkiln v4 package.json we create during the test run in `action.yml` (as discussed in #489)
+- BREAKING: NPM package is now suffolklitlab scoped package. Refer to @suffolklitlab/alkiln from now on.
+- BREAKING: Update to v13 of puppeteer
+- BREAKING: Update to v7 of cucumber
+- BREAKING: Update action.yml node to v17
+- BREAKING: Use alkiln v4 package.json we create during the test run in `action.yml` (as discussed in #489)
+- BREAKING: Use API key to access da server, create projects, pull code, delete projects, and check for server restart.
+- BREAKING: Throw an error for uploading nonexistent file, changed to error instead of warning in reports.
+- Update test setup interview to v4 of ALKiln.
 - Remove and ignore package-lock.json so that our tests will behave more like our users' tests
-- Use API key to access da server, create projects, pull code, delete projects, and check for server restart.
 - Add warning in steps.js for name input with too many parts. Add test in reports.
-- fix typo in the report
-- Throw an error for uploading nonexistent file, changed to error instead of warning in reports. 
+- fix typo in the report 
 - Allow a developer to wait as a first Step. See #387.
 
 <!-- ## [3.0.1-peer-deps.1] - 2021-12-07 -->
@@ -67,10 +72,63 @@ Format:
 - Peer dependencies and dev dependencies. Now `cucumber` is just a dependency. See https://github.com/SuffolkLITLab/ALKiln/issues/396 for discussion. Setup interview has not been updated to remove dependencies.
 
 ### Fixed
+- Proxy var story table row matches for any page containing the given variable name when there's only one row for the relevant variable. #464.
 - Fixed interview name not allowing url parameters. #449
 - Freeze colors npm package to before bug in both package.json and action.yml
 - Fix invalid project name allowed.
 - fix typo in the report.
+- session_vars branch path regex not removing start of branch path
+
+## [3.2.1] - 2022-02-09
+### Fixed
+- Typo in report that was messing up copy/paste of test table
+
+## [3.2.0] - 2022-02-09
+### Added
+- Add Step to log into server account using GitHub SECRETs (environment variables). See #499.
+
+## [3.1.11] - 2022-02-02
+### Changed
+- Handle an Assembly Line name Step value that has too many names, including a warning for the developer. Include the first three names and the last name to try to catch suffixes.
+
+## [3.0.11] - 2022-01-25
+### Added
+- Step: `the text in the JSON variable "variable_with_text_value" should be`. Compare JSON variable with a text value to given text. See #470. Does not accept nested values, e.g. "child.name.first". Downloads all the JSON vars to a .json file in the "downloads" artifacts.
+
+## [3.0.10] - 2022-01-24
+### Added
+- Step to log the page's JSON variables and values in the report. Future goal: save to file. See #454.
+
+## [3.0.9] - 2022-01-10
+### Security
+- Install the security fix in the action's package.json as well. Because dependents have to require cucumber itself, if they're not using our action (if they have their own package.json), they're going to have to implement this fix in their repo too. That's why our fix isn't working. We'll start the process of helping developers update. We also need to deprecate all previous versions of ALKiln. See #489.
+
+## [3.0.8] - 2022-01-10
+### Security
+- Fully publish the security fix in v3.0.7
+
+## [3.0.7] - 2022-01-10
+### Security
+- Pinned colors library to 1.4.0. See https://www.bleepingcomputer.com/news/security/dev-corrupts-npm-libs-colors-and-faker-breaking-thousands-of-apps/. We don't use faker, so we don't need to handle that.
+
+## [3.0.6] - 2022-01-07
+### Changed
+- See #371
+- Scenario heading tags are now on a second line
+- Artifact filenames use dashes more and are created separately from Scenario headings
+- Scenario ids are separated from filenames and Scenario headings
+
+## [3.0.5] - 2022-01-06
+### Added
+- Add action.yml that runs most of what users' workflows run now, along with notes for a new user workflow that will take less maintainance. See #420. We need to add documentation on how to write a workflow file as it currently is if they want to take back control. Setup interview has not yet been updated with this workflow.
+- Add package.json creation/overwriting to action.yml. Simplify package.json.
+
+<!-- ## [3.0.1-peer-deps.1] - 2021-12-07 -->
+### Removed
+- Peer dependencies and dev dependencies. Now `cucumber` is just a dependency. See https://github.com/SuffolkLITLab/ALKiln/issues/396 for discussion. Setup interview has not been updated to remove dependencies.
+
+### Fixed
+- Fixed interview name not allowing url parameters. #449
 
 ## [3.0.4] - 2021-12-11
 ### Fixed

package/README.md

@@ -1,5 +1,13 @@
-# docassemble-cucumber
-Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.
+# ALKiln
+Integrated automated end-to-end testing with docassemble, puppeteer, cucumber, and chai.
+
+Works well with https://github.com/suffolklitlab/docassemble-AssemblyLine but isn't
+dependent on it.
+
+Formerly named "docassemble-cucumber"
+
+## Documentation
+Read about how to use this framework at https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/.
 
 ## Integration tests
 To setup for the integration tests, create the project on the server:

package/action.yml

@@ -32,6 +32,7 @@ inputs:
 runs:
   using: "composite"
   steps:
+    
     # Set environment variables
     - name: "ALKiln: Set environment variables"
       # If extra languages were set manually, override the repository
@@ -54,9 +55,13 @@ runs:
         echo "DOCASSEMBLE_DEVELOPER_API_KEY=${{ inputs.DOCASSEMBLE_DEVELOPER_API_KEY }}" >> $GITHUB_ENV
         echo "ALKILN_VERSION=${{ inputs.ALKILN_VERSION }}" >> $GITHUB_ENV
       shell: bash
+    - name: "ALKiln: confirm info"
+      run: echo -e "\nRepo is $REPO_URL\nBranch ref is $BRANCH_PATH\nManually added languages are $EXTRA_LANGUAGES\nAll other data is secret\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: Overwrite or create package.json
+    - name: Temporarily overwrite or create package.json
       run: |
         cat << EOF > "package.json"
         {
@@ -76,11 +81,8 @@ runs:
           }
         }
       shell: bash
-    - name: "ALKiln: confirm info"
-      run: echo -e "\nRepo is $REPO_URL\nBranch ref is $BRANCH_PATH\nManually added languages are $EXTRA_LANGUAGES\nAll other data is secret\n"
-      shell: bash
 
-    # Install node after package.json is created
+    # Install node
     - name: "ALKiln: Install node packages"
       uses: actions/setup-node@v1
       with:

package/lib/docassemble/docassemble_api_interface.js

@@ -124,7 +124,8 @@ da_i.get_dev_id = async function ( dev_id_options ) {
 
   // Default timeouts
   let { timeout } = dev_id_options ||  { timeout: 75 * 1000 };
-  return await _da_REST.get_dev_id( timeout );
+  let response = await _da_REST.get_dev_id( timeout );
+  return response.data.id;
 };  // Ends da_i.get_dev_id();
 
 
@@ -242,7 +243,7 @@ da_i.loop_to_create_project = async function( creation_options ) {
           throw error;
 
         }  // ends type of non-response error
-      }  // ends type of reponse error
+      }  // ends type of response error
     }  // ends try
   }  // ends while
 };  // Ends da_i.loop_to_create_project()

package/lib/docassemble/get_base_interview_url.js

@@ -0,0 +1,19 @@
+let session_vars = require(`../utils/session_vars`);
+let docassemble_api_interface = require('./docassemble_api_interface');
+
+let get_base_interview_url = async function () {
+  /** Return the part of the interview URL that comes before the filename.
+  *    Depends on the project name, which may get changed.
+  *    This also needs to ensure that variable values from previous tests aren't used.
+  *    That's not completely possible, but our tests try to do this in several ways.
+  *    This function uses `new_session=1` to try to ensure old session vars aren't used.
+  *    When finishing a test, we go to the sign out page (which is supposed to help even
+  *    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();
+  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/index.js

@@ -1,4 +1,2 @@
-#!/usr/bin/env node
-
 require('./world');
 require('./steps.js');