@suffolklitlab/alkiln 5.8.1-feat2columns5 → 5.9.0-feat-url1

package/.github/workflows/github_server.yml

@@ -3,7 +3,7 @@ name: GitHub server installation
 on:
   push:
   # Default "opened", "reopened", "synchronize". "edited" fires when the PR title gets edited, etc.
-  pull_request_target:
+  pull_request:
   workflow_dispatch:
     inputs:
       tags:
@@ -42,13 +42,14 @@ jobs:
 
       - name: ALKiln - Start the isolated temporary docassemble server on GitHub
         id: github_server
-        #### Developer note: you'll need to replace `.` with the path to
-        #### the repo and branch. For example:
+        #### Developer note: you'll need to replace `.` with the path to ALKiln’s
+        #### repo and branch. For example, for version 5, put
         #### suffolkLITLab/ALKiln/action_for_github_server@v5
+        #### Come back and update this version later if you want the latest
         uses: ./action_for_github_server
         with:
           CONFIG_CONTENTS: "${{ secrets.CONFIG_CONTENTS }}"
-          #### Developer note: Set this to True to show docker logs and
+          #### Developer note: Set this to true to show docker logs and
           #### allow ALKiln to create the docker logs output artifact.
           SHOW_DOCKER_OUTPUT: "${{ github.event.inputs.show_docker_output }}"
       - run: echo "ALKiln finished starting the isolated GitHub docassemble server"
@@ -77,9 +78,10 @@ jobs:
 
       - name: "Run ALKiln tests"
         if: ${{ success() }}
-        #### Developer note: you'll need to replace `.` with the path to
-        #### the repo and branch and leave off the trailing `/`
-        #### For example suffolkLITLab/ALKiln@v5
+        #### Developer note: you'll need to replace `.` with the path to ALKiln’s
+        #### repo and branch and leave off the trailing `/`
+        #### For example, for version 5 put suffolkLITLab/ALKiln@v5
+        #### Come back and update this version later if you want the latest
         uses: ./
         with:
           SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
@@ -87,6 +89,7 @@ jobs:
           INSTALL_METHOD: "server"
           #### Developer note: Useful for temporarily shortening ALKiln tests
           #### to debug the docker install step
+          #### Use a "tag expression" to specify which tagged tests to run (https://cucumber.io/docs/cucumber/api/#tag-expressions)
           # ALKILN_TAG_EXPRESSION: @a_tag_expression
-          ALKILN_VERSION: 2columns
+          ALKILN_VERSION: url
 

package/.github/workflows/playground.yml

@@ -3,7 +3,7 @@ name: Playground installation
 on:
   push:
   # Default: opened, reopened, synchronize. "edited" is not what we want.
-  pull_request_target:
+  pull_request:
   workflow_dispatch:
     inputs:
       tags:
@@ -55,4 +55,4 @@ jobs:
           #### to debug the docker install step
           # ALKILN_TAG_EXPRESSION: @a_tag_expression
           #### Developer note: you probalby don't need this
-          ALKILN_VERSION: 2columns
+          ALKILN_VERSION: url

package/CHANGELOG.md

@@ -45,9 +45,22 @@ Format:
 
 <!-- ## [Unreleased] -->
 
+## [5.9.0] - 2024-02-11
+
 ### Added
 
-- 2-column Story Tables that work without the trigger variable. Now column 1, "var", should only contain the actual variable name with no proxies (x, i, j, etc). For example, instead of `x[i].name.first` the var column should now contain `users[0].name.first`. Column 2 is the same as it was before - the answer for the field. See [#582](https://github.com/SuffolkLITLab/ALKiln/issues/582).
+- New feature: 2-column Story Tables that work without the trigger variable. Now column 1, "var", should only contain the actual variable name with no proxies (x, i, j, etc). For example, instead of `x[i].name.first` the var column should now contain `users[0].name.first`. Column 2 is the same as it was before - the answer for the field. See [#582](https://github.com/SuffolkLITLab/ALKiln/issues/582).
+- Added console logs enhancing the "progress dots". You don't usually see those till after the tests run. Now more of them should show up during the test run and the name of the Scenario being tested should appear there as well. Unfortunately, the first Scenario behaves differently. We're consulting with the creators of cucumber to understand why that's happening.
+
+### Changed
+- Reduced a couple error messages. See [#573](https://github.com/SuffolkLITLab/ALKiln/issues/573) and [#452](https://github.com/SuffolkLITLab/ALKiln/issues/452).
+
+### Internal
+- Internal tests: Fixed Scenarios that had failed but had correct reports were instead passing.
+- Internal tests: Allow more types of "expected status" for when we test dealing with "undefined", "skipped", etc.
+- Internal tests: Changed name suffix values in tests. Assembly Line changed its punctuation a while ago.
+- Added doc explaining what internal test results we expect to see as people new to the project are surprised by all our red Fs and yet passing tests.
+- Changed our workflow's `on: pull_request_target` to `on: pull_request`. When the former runs tests, `checkout` checks out the target branch's files. It was unhelpful to test the files of the old branch with the new version of ALKiln. The latter checks out the head branch's files. We should be good now.
 
 ## [5.8.1] - 2023-12-28
 

package/lib/cucumber_8_shim.js

@@ -1,3 +1,4 @@
+// TODO: Add the error message to the report. Would have to pass in `scope`.
 module.exports = async function wrapPromiseWithTimeout (
   promise,
   timeoutInMilliseconds,

package/lib/scope.js

@@ -626,7 +626,7 @@ module.exports = {
 
     reports.addToReport(scope,{
       type: `row`,
-      value: `Trying to load the interview at "${interview_url}"`
+      value: `Trying to load the interview at "${ interview_url }"`
     });
 
     if ( !scope.page ) { scope.page = await scope.browser.newPage(); }
@@ -641,8 +641,9 @@ module.exports = {
       // If the page didn't load because it took to long to load
       if ( error.name === `TimeoutError` ) {
 
-        let non_reload_report_msg = `Timeout error occurred when ALKiln tried to go to the interview url`;
+        let non_reload_report_msg = `Timeout error occurred when ALKiln tried to go to the interview at ${ interview_url }`;
         await scope.handle_page_timeout_error( scope, { non_reload_report_msg, error });
+        // TODO: Should this throw to avoid multiple error messages?
 
       // If the page didn't load because of any other reason
       } else {
@@ -650,7 +651,7 @@ module.exports = {
         // Throw any non-timeout error
         reports.addToReport( scope, {
           type: `error`,
-          value: `Error occurred when ALKiln tried to go to the interview url`
+          value: `Error occurred when ALKiln tried to go to the interview at ${ interview_url }`
         });
         throw( error );
       }  // ends if error is timeout error
@@ -658,10 +659,12 @@ module.exports = {
     }  // ends try/catch
 
     let load_result = await scope.getLoadData( scope );
-    // Errors, or reaching timeout, causes an exception and is shown to the developer at the end
+    // da page invalidation errors or timeout will show an error to the developer at the end
     if ( load_result.error ) {
-      reports.addToReport(scope, { type: `error`, value: `On final attempt to load interview, got "${ load_result.error }"` });
+      reports.addToReport(scope, { type: `error`, value: `On final attempt to load interview at "${ interview_url }", got "${ load_result.error }"` });
       expect( load_result.error ).to.equal( '' );
+    } else {
+      reports.addToReport(scope, { type: `info`, value: `Successfully found the interview at "${ interview_url }"` });
     }
 
     return scope.page;
@@ -693,6 +696,11 @@ module.exports = {
 
       // or if they cause some other kind of error
       } else {
+        reports.addToReport(scope, {
+          type: `error`,
+          value: `ALKiln got an error when it tried to load the interview page`,
+          data: error
+        });
         throw error;
       }  // ends if error.name.includes(`TimeoutError`)
     });  // ends Promise.race()

package/lib/steps.js

@@ -177,12 +177,14 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
   // Load the right interview page
   await scope.load( scope, file_name );
   
+  // TODO: Move this above loading? Put it in `Before()` instead?
   // The page timeout is set in here too in case someone set a custom timeout
   // before a page was loaded.
   // The function itself won't really timeout here, so we don't need to wrap it in
   // a custom timeout
   await scope.page.setDefaultTimeout( scope.timeout );  // overrides outer default timeout
 
+  // TODO: Move this to the `download` Step and only do it once per scenario
   // Allow developer to save download files
   let custom_download_behavior_timeout = new Promise(async ( resolve, reject ) => {
     let page_timeout = setTimeout(function() {reject( `Took too long to set download behavior.` ); }, scope.timeout);
@@ -236,6 +238,8 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
     }  // ends if this is the file the developer expected
   });  // ends page.on 'response'
 
+  // TODO: Wrap everything in this step in this timeout? Or is this Step's timeout different?
+  // Wait for navigation
   let custom_afterStep_timeout = new Promise(async ( resolve, reject ) => {
     let page_timeout = setTimeout(function() { reject(`\`afterStep()\` took too long.`); }, scope.timeout);
     // self-invoke an anonymous async function so we don't have to
@@ -251,6 +255,22 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
   await custom_afterStep_timeout;
 });
 
+Given(/I go to "([^"]+)"/i, {timeout: -1}, async ( url ) => {
+  /** Navigate to an arbitrary url. What you do after that depends on you. There's
+   *    a limited amount ALKiln can do on a non-docassemble page or a very customized
+   *    docassemble page.
+   *
+   * @params {string} A valid url */
+  let result = await wrapPromiseWithTimeout(
+    scope.page.goto( url, { waitUntil: 'domcontentloaded', timeout: scope.timeout }),
+    scope.timeout,
+    `It took to long to get to "${ url }"`
+  );
+
+  reports.addToReport(scope, { type: `info`, value: `Successfully went to "${ 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 ) => {
   /** 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.

package/lib/utils/session_vars.js

@@ -294,7 +294,7 @@ session_vars.set_sources_paths = function ( paths ) {
   }
 
   console.info(
-    `ALKiln info: Did find "sources" folder(s) at "${ existing_paths.join('", "') }".`
+    `ALKiln SUCCESS: Did find "sources" file(s) at "${ existing_paths.join('", "') }".`
   )
 
   // Otherwise, store valid paths

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.8.1-feat2columns5",
+  "version": "5.9.0-feat-url1",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {