@suffolklitlab/alkiln 3.0.9 → 4.0.0-pre-api.4

package/.github/workflows/test_tests.yml

@@ -18,16 +18,19 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [17.x]
 
     env:
-      BASE_URL: https://apps-dev.suffolklitlab.org
+      BASE_URL: ${{ secrets.SERVER_URL }}
       PLAYGROUND_EMAIL: ${{ secrets.PLAYGROUND_EMAIL }}
       PLAYGROUND_PASSWORD: ${{ secrets.PLAYGROUND_PASSWORD }}
       PLAYGROUND_ID: ${{ secrets.PLAYGROUND_ID }}
+      DOCASSEMBLE_DEVELOPER_API_KEY: ${{ secrets.DOCASSEMBLE_DEVELOPER_API_KEY }}
       BRANCH_PATH: main
       EXTRA_LANGUAGES: ${{ secrets.EXTRA_LANGUAGES }}
       REPO_URL: https://github.com/plocket/docassemble-ALAutomatedTestingTests
+      USER1_EMAIL: ${{ secrets.USER1_EMAIL }}
+      USER1_PASSWORD: ${{ secrets.USER1_PASSWORD }}
 
     name: Run Puppeteer tests
     steps:
@@ -72,6 +75,12 @@ jobs:
         with:
           name: report
           path: ./**/*_report_*
+      - name: log artifact
+        uses: actions/upload-artifact@v2
+        if: ${{ always() }}
+        with:
+          name: log file
+          path: ./log.txt
       - name: Cleanup
         if: ${{ always() }}
         run: npm run takedown

package/CHANGELOG.md

@@ -38,30 +38,29 @@ Format:
 ### Security
 - 
 -->
-<!-- ## [Unreleased] -->
-## [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.
+<!--2022-02-11 -->
 
-## [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
+## [Unreleased]
 ### 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.
+- 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.
+- Create log.txt for report items and uploaded as github artifact so there's always some kind of output.
+- 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)
+- 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. 
+- Allow a developer to wait as a first Step. See #387.
 
 <!-- ## [3.0.1-peer-deps.1] - 2021-12-07 -->
 ### Removed
@@ -69,6 +68,9 @@ Format:
 
 ### Fixed
 - 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.
 
 ## [3.0.4] - 2021-12-11
 ### Fixed

package/action.yml

@@ -14,45 +14,32 @@ inputs:
   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
   EXTRA_LANGUAGES:
     description: 'Other languages you want to test. This should be in your GitHub SECRETS or the SECRETS of your org.'
     required: false
     default: ''
+  # This is necessary to test pre-releases at the very least. It does seem
+  # strange considering we're controlling everything through the action, but
+  # that actually doesn't touch the npm version that's pulled in.
+  ALKILN_VERSION:
+    description: 'Version of ALKiln to get from npm.'
+    required: false
+    default: '^4.0.0'
 
 runs:
   using: "composite"
   steps:
-    # 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
-      run: |
-        cat << EOF > "package.json"
-        {
-          "scripts": {
-            "test": "npm run langs_setup && npm run cucumber -- $@",
-            "cucumber_base": "./node_modules/.bin/cucumber-js --require ./node_modules/docassemble-cucumber/lib/index.js",
-            "cucumber": "run_cucumber(){ npm run cucumber_base -- \"$@\" docassemble/*/data/sources/*.feature; }; run_cucumber",
-            "langs": "npm run langs_setup && ./node_modules/.bin/cucumber-js --require ./node_modules/docassemble-cucumber/lib/index.js docassemble/*/data/sources/*_lang*.feature",
-            "langs_setup": "node_modules/.bin/da-langs 'docassemble/*/data/sources/*.feature'",
-            "setup": "node_modules/.bin/da-setup",
-            "takedown": "node_modules/.bin/da-takedown"
-          },
-          "dependencies": {
-            "cucumber": "^6.0.5",
-            "docassemble-cucumber": "^3.0.0",
-            "colors": "1.4.0"
-          }
-        }
-      shell: bash
-
     # Install node
     - name: "ALKiln: Install node packages"
       uses: actions/setup-node@v1
       with:
-        node-version: "12"
+        node-version: "17"
     - run: npm install
       shell: bash
-      
+
     # Set environment variables
     - name: "ALKiln: Set environment variables"
       # If extra languages were set manually, override the repository
@@ -72,6 +59,30 @@ runs:
         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
+      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
+      run: |
+        cat << EOF > "package.json"
+        {
+          "scripts": {
+            "test": "npm run langs_setup && npm run cucumber -- $@",
+            "cucumber_base": "./node_modules/.bin/cucumber-js --require ./node_modules/.bin/alkiln-cucumber",
+            "cucumber": "run_cucumber(){ npm run cucumber_base -- \"$@\" docassemble/*/data/sources/*.feature; }; 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"
+          }
+        }
       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"
@@ -125,10 +136,8 @@ runs:
 # # A developer's workflow should look similar to the below
 # # In place of `uses: suffolkLITLab/ALKiln@releases/v4`, they
 # # might use another version.
-
-# name: Use the ALKiln testing framework
-# description: "Use the ALKiln testing framework to test interviews. See https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing."
-
+#
+# name: Use the ALKiln testing framework v4 to run tests
 # on:
 #   push:
 #   workflow_dispatch:
@@ -139,9 +148,9 @@ runs:
 #       tags:
 #         description: 'Optional. Use a "tag expression" specify which tagged tests to run. See https://cucumber.io/docs/cucumber/api/#tag-expressions for syntax.'
 #         default: ''
-
+#
 # jobs:
-
+#
 #   interview-testing:
 #     runs-on: ubuntu-latest
 #     name: Run interview tests
@@ -151,8 +160,9 @@ runs:
 #         uses: suffolkLITLab/ALKiln@releases/v4
 #         with:
 #           SERVER_URL: "${{ secrets.SERVER_URL }}"
+#           DOCASSEMBLE_DEVELOPER_API_KEY: "${{ secrets.DOCASSEMBLE_DEVELOPER_API_KEY }}"
 #           PLAYGROUND_EMAIL: "${{ secrets.PLAYGROUND_EMAIL }}"
 #           PLAYGROUND_PASSWORD: "${{ secrets.PLAYGROUND_PASSWORD }}"
 #           PLAYGROUND_ID: "${{ secrets.PLAYGROUND_ID }}"
 #           EXTRA_LANGUAGES: "${{ secrets.EXTRA_LANGUAGES }}"
-#       - run: echo "Finished running ALKiln tests"
+#       - run: echo "Finished running ALKiln tests"

package/lib/cucumber_8_shim.js

@@ -0,0 +1,25 @@
+module.exports = async function wrapPromiseWithTimeout (
+  promise,
+  timeoutInMilliseconds,
+  timeoutMessage
+) {
+  /** Race between a timeout and another function and clean up
+  *    async afterwards.
+  * 
+  * Taken from https://github.com/cucumber/cucumber-js/blob/main/src/time.ts#L42-L59
+  */
+  if ( timeoutMessage === '' ) {
+    timeoutMessage = `Action did not complete within ${ timeoutInMilliseconds } milliseconds`;
+  }
+
+  let timeoutId;
+  const timeoutPromise = new Promise((resolve, reject) => {
+    timeoutId = setTimeout(() => {
+      reject(new Error( timeoutMessage ))
+    }, timeoutInMilliseconds)
+  });
+
+  return await Promise.race([ promise, timeoutPromise ]).finally(() =>
+    clearTimeout(timeoutId)
+  );
+}

package/lib/docassemble/docassemble_api_REST.js

@@ -0,0 +1,130 @@
+const axios = require('axios');
+const qs = require('qs');
+
+const session_vars = require('../utils/session_vars' );
+
+/* Requests to make to the developer's docassemble server.
+*   As close to plain requests as we can get so we don't have
+*   to think about this file again.
+* Notes:
+*   - We are not using `.create()` because we want to get
+*   the environment variables fresh every time. */
+
+let da = {};
+module.exports = da;
+
+
+// node -e 'require("./lib/docassemble/docassemble_api_REST.js").get_dev_id()'
+da.get_dev_id = async function ( timeout ) {
+  /* Get docassemble developer id. */
+  let options = {
+    method: 'GET',
+    url: `${ session_vars.get_da_server_url() }/api/user`,
+    params: { key: session_vars.get_dev_api_key(), },
+    timeout: timeout,
+  };
+
+  return await axios.request( options );
+};  // Ends da.get_dev_id()
+
+
+// node -e 'require("./lib/docassemble/docassemble_api_REST.js").create_project( "create1" )'
+da.create_project = async function ( project_name, timeout ) {
+  /* Create a new project on the user's da server. */
+  let options = {
+    method: 'POST',
+    url: `${ session_vars.get_da_server_url() }/api/playground/project`,
+    data: qs.stringify({
+      key: session_vars.get_dev_api_key(),
+      project: project_name,
+    }),
+    timeout: timeout,
+  };
+
+  return await axios.request( options );
+
+};  // Ends da.create_project()
+
+
+// node -e 'require("./lib/docassemble/docassemble_api_REST.js").pull()'
+da.pull = async function ( timeout ) {
+  /* Pull github code into an existing Project. */
+  let options = {
+    method: 'POST',
+    url: `${ session_vars.get_da_server_url() }/api/playground_pull`,
+    data: qs.stringify({
+      key: session_vars.get_dev_api_key(),
+      project: session_vars.get_project_name(),
+      github_url: session_vars.get_repo_url(),
+      branch: session_vars.get_branch_name(),
+    }),
+    timeout: timeout,
+  };
+
+  return await axios.request( options );
+};  // Ends da.pull()
+
+
+// node -e 'require("./lib/docassemble/docassemble_api_REST.js").has_task_finished()'
+da.has_task_finished = async function ( task_id, timeout ) {
+  /* Check task status based on `task_id`. */
+  let options = {
+    method: 'GET',
+    url: `${ session_vars.get_da_server_url() }/api/restart_status`,
+    params: {
+      key: session_vars.get_dev_api_key(),
+      task_id: task_id,
+    },
+    timeout: timeout,
+  };
+
+  return await axios.request( options );
+};  // Ends da.has_task_finished()
+
+
+// node -e 'require("./lib/docassemble/docassemble_api_REST.js").delete_project( "create1" )'
+da.delete_project = async function ( timeout ) {
+  /* Delete a project on the user's da server. */
+  let options = {
+    method: 'DELETE',
+    url: `${ session_vars.get_da_server_url() }/api/playground/project`,
+    params: {
+      key: session_vars.get_dev_api_key(),
+      project: session_vars.get_project_name(),
+    },
+    timeout: timeout,
+  };
+
+  return await axios.request( options );
+};  // Ends da.delete_project()
+
+
+// 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
+  *    prefix. Useful for Projects created by an infinite loop. */
+  let name_incrementor = parseInt( starting_num );
+  ending_num = ending_num || starting_num;  // Default to just delete one
+  let final_num = parseInt( ending_num );
+  while ( name_incrementor <= final_num ) {
+    try {
+      let project_name = base_name + name_incrementor;
+      console.log( `Deleting Project ${ project_name }` );
+
+      let options = {
+        method: 'DELETE',
+        url: `${ session_vars.get_da_server_url() }/api/playground/project`,
+        params: {
+          key: session_vars.get_dev_api_key(),
+          project: project_name,
+        },
+        timeout: 30 * 1000,
+      };
+
+      await axios.request( options ); 
+    } catch ( error ) {
+      console.log( error )
+    }
+    name_incrementor++;
+  }
+}; // Ends da_i.__delete_projects_starting_with()