@suffolklitlab/alkiln 5.0.0-pre-3 → 5.0.0-pre-5

package/.github/workflows/test_tests.yml

@@ -45,8 +45,8 @@ jobs:
       - name: Set name of artifact folder with date and UTC time
         # https://www.shell-tips.com/linux/how-to-format-date-and-time-in-linux-macos-and-bash/#how-to-format-a-date-in-bash
         run: |
-          echo "ARTIFACT_NAME=alkiln-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u) UTC" >> $GITHUB_ENV
-          echo "UNIT_TESTS_ARTIFACT_NAME=_alkiln-misc-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u) UTC" >> $GITHUB_ENV
+          echo "ARTIFACT_NAME=alkiln-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u)UTC" >> $GITHUB_ENV
+          echo "UNIT_TESTS_ARTIFACT_NAME=_alkiln-misc-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u)UTC" >> $GITHUB_ENV
       - name: Set languages
         run: echo "EXTRA_LANGUAGES=${{ github.event.inputs.extra_languages }}" >> $GITHUB_ENV
         if: ${{ github.event.inputs.extra_languages != '' }}
@@ -60,7 +60,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: npm install
       - run: npm run setup
-      - run: npm run test -- ${{ github.event.inputs.tags && format('"--tags" "{0}"', github.event.inputs.tags) }}
+      - run: npm run test ${{ github.event.inputs.tags && format('{0}', github.event.inputs.tags) }}
       # Artifacts
       - name: upload unit tests artifacts folder
         uses: actions/upload-artifact@v3

package/CHANGELOG.md

@@ -45,6 +45,7 @@ Format:
   be run in any directory, not just in an npm package.
 - Additional environment variables and their validation to allow for tests that run on a developer's server/Playground instead of through GitHub. Also, other functionality for that purpose. [Issue #661](https://github.com/SuffolkLITLab/ALKiln/issues/661)
 - Tests for new session_vars behavior and improve previous tests.
+- Adds `npm-shrinkwrap.json`, so installs from npm will have fixed version dependencies
 
 ### Changed
 - upgraded cucumber v8.6.0
@@ -58,6 +59,7 @@ Format:
 
 ### Fixed
 - Projects created in da each have a unique name. https://github.com/SuffolkLITLab/ALKiln/issues/663
+- Shorten path names to try to accommodate limitations of windows systems while still keeping enough useful information to help devs identify the test outputs. https://github.com/SuffolkLITLab/ALKiln/issues/618
 
 ### Security
 - Pass docassemble API keys through HTTP headers instead of as parameters.

package/CONTRIBUTING.md

@@ -112,6 +112,12 @@ Our tests require the user/developer to have a docassemble server on which they
 
 When the developer commits code to GitHub, their account triggers our code, passing along variables that our code needs, like their GitHub secret of the API key for their docassemble server developer account.
 
+## Updating dependencies
+
+Sometimes you will have to add dependencies to ALKiln. You can do so by adding the dependency in the `package.json` "dependencies" section, specifying an exact version. Then, run `npm install` to update `npm-shrinkwrap.json` to have the new dependency.
+
+If you have to update an existing dependency, you can change the version in `package.json`, and run `npm install` to update `npm-shrankwrap.json`.
+
 ## Very general architecture of files and folders
 
 An honest look at our current project architecture—some of our files and folders, what they do, and how they interact.

package/action.yml

@@ -43,7 +43,7 @@ runs:
       # Human-readable date/time:
       # https://www.shell-tips.com/linux/how-to-format-date-and-time-in-linux-macos-and-bash/#how-to-format-a-date-in-bash
       run: |
-        echo "ARTIFACT_NAME=alkiln-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u) UTC" >> $GITHUB_ENV
+        echo "ARTIFACT_NAME=alkiln-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u)UTC" >> $GITHUB_ENV
         if ${{ github.event.inputs.extra_languages != '' }}
         then
           echo "Manually set languages: ${{ github.event.inputs.extra_languages }}"

package/lib/run_cucumber.js

@@ -61,6 +61,7 @@ const cucumber_api = require('@cucumber/cucumber/api');
   }, sources: {paths: []}}, environment);
 
   console.log("alkiln-run: working directory: %o", codeDir);
+  console.log(`\n\n`);
 
   const { success } = await cucumber_api.runCucumber({...runConfiguration, support});
   console.log("alkiln-run: success: %b", success);

package/lib/scope.js

@@ -121,8 +121,7 @@ module.exports = {
     * create it. */
     if ( !scope.report ) { scope.report = new Map(); }
     if ( !scope.scenario_id ) {
-      let date = files.readable_date();
-      scope.scenario_id = `_report_${ date }`;
+      scope.scenario_id = `_report_${ Date.now() }`;
     }
     if ( !scope.report.get( scope.scenario_id )) {
       scope.report.set( scope.scenario_id, {} )
@@ -243,9 +242,9 @@ module.exports = {
     let filename = name_parts.join(`-`);
     let safe_name = safe_filename( filename, { replacement: `_` });
     // Allow room for extensions, date, etc.
-    let safer_name = safe_name.substring(0, (255 - 45));
+    let short_name = `${ safe_name }`.substring(0, 70);
 
-    return safer_name;
+    return short_name;
   },  // Ends scope.getSafeScenarioBaseFilename()
 
   // TODO: Does this need a name change? getSafeScenarioBasedFilename?
@@ -254,6 +253,14 @@ module.exports = {
     *    a prefix the caller wants, and the base filename. We hope it can
     *    contain non-english characters too. We do not offer a suffix option
     *    because it may be cut off if the filename is too long.
+    * 
+    * @Examples
+    * Return value possible formats
+    * prefix-id-scenario_description-timestamp
+    * id-scenario_description-timestamp
+    * scenario_description-timestamp
+    * 
+    * @returns str
     */
     let name = options.prefix || '';
 
@@ -264,23 +271,22 @@ module.exports = {
 
     if ( scope.page ) {
       let { id } = await scope.examinePageID( scope, 'none to match' );
-      name += `${ id }-`;
+      let short_id = `${ id }`.substring(0, 20);
+      name += `${ short_id }-`;
     }
 
     name += scope.base_filename;
-    name += `-${ files.readable_date() }`;
+    name += `-${ Date.now() }`;
 
     let safe_name = safe_filename( name, { replacement: `_` });
-    // Allow room for extensions, etc.
-    let safer_name = safe_name.substring(0, (255 - 10));
-    return safer_name;
+    return safe_name;
   },  // Ends scope.getSafeScenarioFilename()
 
   getJSONFilename: async function( scope ) {
     // Get a unique path for a json file
     let { id } = await scope.examinePageID( scope, 'none to match' );
-    let date = files.readable_date();
-    let json_path = path.join( scope.paths.scenario, `json_for-${ id }-${ date }.json` );
+    let short_id = `${ id }`.substring(0, 20);
+    let json_path = path.join( scope.paths.scenario, `json_for-${ short_id }-${ Date.now() }.json` );
     return json_path;
   },
 
@@ -840,7 +846,7 @@ module.exports = {
 
       // Error types we haven't accounted for
       } else {
-        result.error = "Docassemble ran into an error on the page, but ALKiln does not know what the error is. If a screenshot was taken, check the screenshot";
+        result.error = "Docassemble ran into an error on the page, but ALKiln does not know what the error is. Check the picture of this page. If a secret variable was used, there will be no picture.";
       }  // ends if error_elem !== null
     }  // ends if error_id_elem
 
@@ -1900,7 +1906,10 @@ module.exports = {
   examinePageID: async function ( scope, question_id = '' ) {
     /* Looks for a sanitized version of the question id as it's written
     *     in the .yml. docassemble's way in python:
-    *     re.sub(r'[^A-Za-z0-9]+', '-', interview_status.question.id.lower()) */
+    *     re.sub(r'[^A-Za-z0-9]+', '-', interview_status.question.id.lower())
+    * 
+    * @returns { question_has_id: bool, id: str, id_matches: bool }
+    */
     let id_as_class = question_id.toLowerCase().replace(/[^A-Za-z0-9]+/g, '-');
     // `.className` is the node's list of classes as a string, separated by spaces
     let classes_str = await scope.page.$eval(`body`, function (elem) { return elem.className });
@@ -2235,7 +2244,7 @@ module.exports = {
       error = await scope.checkForError( scope );
     }
 
-    let timeout_err_message = `The test tried to continue to the next page, but it took longer than ${ (scope.timeout/1000)/60 } min. Check the screenshot.`
+    let timeout_err_message = `The test tried to continue to the next page, but it took longer than ${ (scope.timeout/1000)/60 } min. Check the picture of this page. If a secret variable was used, there will be no picture.`
     if ( timedOut ) { await scope.addToReport(scope, { type: `error`, value: timeout_err_message }); }
     expect( timedOut, timeout_err_message ).to.be.false;
 
@@ -2275,13 +2284,13 @@ module.exports = {
   throwPageError: async function ( scope, { error_handlers = {}, id = '' }) {
     /* Throw a cucumber error with the error that appeared on the page. */
     if ( error_handlers.system_error !== undefined ) {
-      let sys_err_message = `The test tried to continue to the next page after ${ id }, but there was a system error. Check the screenshot.`
+      let sys_err_message = `The test tried to continue to the next page after ${ id }, but there was a system error. Check the picture of this page.`
       await scope.addToReport(scope, { type: `error`, value: sys_err_message });
       expect( was_system_error, sys_err_message ).to.be.false;
 
     } else {
       // If it wasn't a system error, it was a user error
-      let user_err_message = `The test tried to continue to the next page after ${ id }, but the user got an error. Check the screenshot.`
+      let user_err_message = `The test tried to continue to the next page after ${ id }, but the user got an error. Check the picture of this page.`
       await scope.addToReport(scope, { type: `error`, value: user_err_message });
       expect( true, user_err_message ).to.be.false;
     }
@@ -2317,18 +2326,19 @@ module.exports = {
     screenshot: async ( scope, name ) => {
       /* Download and save a screenshot. `name` does not have to be
       * unique as the filename will be made unique. */
-      name = name || '';
 
-      let date = files.readable_date();
+      let timestamp = Date.now();
       let { id } = await scope.examinePageID( scope, 'none to match' );
+      let short_id = `${ id }`.substring(0, 20);
       // Include the custom name if it has one
-      if ( name.length > 0 ) {
-        name = `screenshot-${ name }-on-${ id }-${ date }`;
+      if ( name && name.length > 0 ) {
+        let short_name = `${ name }`.substring(0, 70);
+        pic_name = `pic-${ short_name }-on-${ short_id }-${ timestamp }`;
       } else {
-        name = `screenshot_on-${ id }-${ date }`;
+        pic_name = `pic_on-${ short_id }-${ timestamp }`;
       }
 
-      await scope.take_a_screenshot( scope, { path: `./${ scope.paths.scenario }/${ name }.jpg` });
+      await scope.take_a_screenshot( scope, { path: `./${ scope.paths.scenario }/${ pic_name }.jpg` });
 
       await scope.afterStep( scope );
     },  // Ends scope.steps.screenshot()

package/lib/steps.js

@@ -129,7 +129,7 @@ Before(async (scenario) => {
   // Make folder for this Scenario in the all-tests artifacts folder
   scope.base_filename = await scope.getSafeScenarioBaseFilename(scope, {scenario});
   // Add a date for uniqueness in case dev has accidentally copied a Scenario description
-  let date = files.readable_date();
+  let date = Date.now();
   scope.paths.scenario = `${ scope.paths.artifacts }/${ scope.base_filename }-${ date }`;
   fs.mkdirSync( scope.paths.scenario );
   // Store path name for this Scenario's individualized report
@@ -450,7 +450,7 @@ When(/I wait ?(?:for)? (\d*\.?\d+) seconds?/, { timeout: -1 }, async ( seconds )
   );
 });
 
-Then(/I take a screenshot ?(?:named "([^"]+)")?/, { timeout: -1 }, async ( name ) => {
+Then(/I take a (?:screenshot|pic) ?(?:named "([^"]+)")?/, { timeout: -1 }, async ( name ) => {
   /* Download and save a screenshot. `name` does not have to be
   * unique as the filename will be made unique. */
   return wrapPromiseWithTimeout(
@@ -585,7 +585,7 @@ Then('I will be told an answer is invalid', async () => {  // √
   expect( was_found, no_error_msg ).to.be.true;
 
   let was_user_error = error_handlers.complex_user_error !== undefined || error_handlers.simple_user_error !== undefined;
-  let not_user_error_msg = `The error was a system error, not an error message to the user. Check the error screenshot.`;
+  let not_user_error_msg = `The error was a system error, not an invalid user answer. Check for the picture of the page's error if the step did not use any secret variables.`;
   if ( !was_user_error ) { await scope.addToReport(scope, { type: `error`, value: not_user_error_msg }); }
   expect( was_user_error, not_user_error_msg ).to.be.true;
 
@@ -790,8 +790,8 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
   */
   // Give each screenshots folder a time-stamped name in case the dev gets clever
   // and use the same Scenario to run multiple randomized tests.
-  let timestamp = files.readable_date();
-  let random_input_path = `${ scope.paths.scenario }/random_answers_screenshots-${ timestamp }`
+  let timestamp = Date.now();
+  let random_input_path = `${ scope.paths.scenario }/random${ timestamp }`
   scope.paths.random_screenshots = random_input_path;
   fs.mkdirSync( scope.paths.random_screenshots );
   await scope.addToReport( scope, {
@@ -813,7 +813,7 @@ When(/I answer randomly for at most ([0-9]+) (?:page(?:s)?|screen(?:s)?)/, { tim
 
     let no_content_err = `The interview seemed to run into an error page`
       + ` after the page with the question id "${ id }".`
-      + ` See the screenshot in "${ random_input_path }".`;
+      + ` See the picture of the page in "${ random_input_path }".`;
 
     let has_thrown = false;
     // Ensure no infinite loop, but each page has a full timeout to run
@@ -853,7 +853,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
-          let path = `${ scope.paths.random_screenshots }/random-${ Date.now() }.jpg`;
+          let short_id = `${ id }`.substring(0, 20);
+          let path = `${ scope.paths.random_screenshots }/random-${ short_id }${ Date.now() }.jpg`;
           await scope.take_a_screenshot( scope, { path: path });
 
           // Prep for the next loop to possibly stop. Signature page buttons
@@ -1131,7 +1132,7 @@ After(async function(scenario) {
       if ( !!scope.disable_error_screenshot ) {
         scope.addToReport(scope, {
           type: `row`,
-          value: `For security, ALKiln will avoid creating a screenshot for this error. It's possible a secret is being used on this screen.`
+          value: `For security, ALKiln will avoid creating a picture of the page for this error. It's possible a secret is being used on this screen.`
         });
       } else {
 
@@ -1144,7 +1145,8 @@ After(async function(scenario) {
         // 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 }`;
+        let short_id = `${ id }`.substring(0, 20);
+        screenshot_name += `-${ short_id }`;
         let path_scenario = `${ scope.paths.scenario }/${ screenshot_name }.jpg`;
         await scope.take_a_screenshot( scope, { path: path_scenario });
 

package/lib/utils/files.js

@@ -16,9 +16,8 @@ files.readable_date = function() {
   let hours = ("0" + date.getUTCHours()).slice(-2);
   let mins = ("0" + date.getUTCMinutes()).slice(-2);
   let secs = ("0" + date.getUTCSeconds()).slice(-2);
-  let msecs = ("00" + date.getUTCMilliseconds()).slice(-3);
 
-  let fancy_str = `${ year }-${ month }-${ day } at ${ hours }h${ mins }m${ secs }s${ msecs }ms UTC`;
+  let fancy_str = `${ year }-${ month }-${ day } at ${ hours }h${ mins }m${ secs }sUTC`;
   return fancy_str;
 };  // Ends files.readable_date()