@suffolklitlab/alkiln 4.11.2 → 4.11.4

package/.github/workflows/test_tests.yml

@@ -44,8 +44,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 != '' }}

package/CHANGELOG.md

@@ -40,6 +40,17 @@ Format:
 -->
 <!-- ## [Unreleased] -->
 
+## [4.11.4] - 2023-04-19
+### Fixed
+- 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
+
+## [4.11.3] - 2023-04-06
+### Changed
+- Project name prefix now includes ALKiln in it for clarity
+
+### Fixed
+- Projects created in da each have a unique name. https://github.com/SuffolkLITLab/ALKiln/issues/663
+
 ## [4.11.2] - 2023-03-22
 ### Security
 - Pass docassemble API keys through HTTP headers instead of as parameters.

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/docassemble/docassemble_api_interface.js

@@ -204,16 +204,17 @@ da_i.loop_to_create_project = async function( creation_options ) {
   let wait_seconds = creation_options.wait_seconds || 5;
 
   let project_name = null;
-  let name_incrementor = 0;
+  // Unlikely, but 2 devs could run locally and create the same Project name
+  let num_tries = 0;
 
   // Try to create a project. If the project name is already taken, increment and loop again.
-  while ( name_incrementor <= max_tries ) {
-    name_incrementor++;
+  while ( num_tries <= max_tries ) {
+    num_tries++;
     try {
 
       // Try next name that could be unique. Must remove all non-valid characters
       // TODO: This sanitization is already done in session_vars, so remove it from here
-      project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + name_incrementor;
+      project_name = session_vars.get_project_base_name().replace(/[^A-Za-z0-9]/g, '') + `${Date.now()}`;
       log.info({ pre: `Trying to create a docassemble Project with the name ${ project_name }` });
       let response = await _da_REST.create_project( project_name, timeout );
       log.info({ pre: `The docassemble server is ready. Created a Project named ${ project_name }` });
@@ -226,7 +227,7 @@ da_i.loop_to_create_project = async function( creation_options ) {
 
       if ( response && response.data ) {
         if ( response.data.includes( `Invalid project` ) ) {
-          if ( name_incrementor < max_tries ) {
+          if ( num_tries < max_tries ) {
             // A non-unique project name. Try the next project name.
             continue;
 
@@ -254,11 +255,11 @@ da_i.loop_to_create_project = async function( creation_options ) {
 
         // If it's a timeout error, server is busy. Try again after waiting.
         // Why are we using `max_tries` for timeout error as well?
-        if ( is_timeout_error( error ) && name_incrementor < max_tries ) {
+        if ( is_timeout_error( error ) && num_tries < max_tries ) {
           log.info({ pre: `The docassemble server was busy when we tried to `
-            + `create the Project. Attempt ${ name_incrementor } of `
+            + `create the Project. Attempt ${ num_tries } of `
             + `${ max_tries }. Will try again in ${ wait_seconds } seconds.` });
-          name_incrementor--;  // Try this name again next time
+          num_tries--;  // Don't count this try
           await time.waitForTimeout( wait_seconds * 1000 );
           continue;
 

package/lib/docassemble/setup.js

@@ -25,6 +25,7 @@ const setup = async () => {
   // avoids showing confusing node errors to users that they shouldn't have to fix
   try {
     project_name = await da_i.loop_to_create_project();
+    log.info({type: `setup`, pre: `Created a Project named ${ project_name }`});
   } catch (error) {
     log.error({type: `setup`, pre: `an unexpected error occurred while trying to create a docassemble project in the user's account`, data: JSON.stringify(error, null, 4)})
     // we don't re-throw the exception, so make sure to exit with 1 to let Github Actions know the script failed

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
 
@@ -1890,7 +1896,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 });
@@ -2225,7 +2234,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;
 
@@ -2265,13 +2274,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;
     }
@@ -2307,18 +2316,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

@@ -122,7 +122,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
@@ -443,7 +443,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(
@@ -578,7 +578,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;
 
@@ -783,8 +783,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, {
@@ -806,7 +806,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
@@ -846,7 +846,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
@@ -1116,7 +1117,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 {
 
@@ -1129,7 +1130,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()
 

package/lib/utils/session_vars.js

@@ -75,7 +75,7 @@ session_vars.get_package_name = function () {
 };
 
 session_vars.get_project_base_name = function () {
-  let name = `testing${ session_vars.get_package_name() }${ session_vars.get_branch_name() }`;
+  let name = `ALKilnTest${ session_vars.get_package_name() }${ session_vars.get_branch_name() }`;
   let sanitized_name = name.replace( /[^A-Za-z0-9]/g, '' );
   return sanitized_name;
 };

package/package.json

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

package/tests/unit_tests/getSafeScenarioBaseFilename.fixtures.js

@@ -7,4 +7,7 @@ names.non_english_chars = `是汉字`;
 names.colon_input = `invalid:colon`;
 names.colon_output = `invalid_colon`;
 
+names.long_input = `Longest scenario description should be 70 characters or less 0123456789`;
+names.long_output = `Longest scenario description should be 70 characters or less 012345678`;
+
 module.exports = names;

package/tests/unit_tests/getSafeScenarioBaseFilename.test.js

@@ -39,6 +39,12 @@ describe(`When I use scope.getSafeScenarioBaseFilename()`, function() {
     expect( result ).to.equal( names.colon_output );
   });
 
+  it(`shortens a name over 70 chars`, async function() {
+    let scenario = mock_scenario( names.long_input );
+    let result = await getSafeScenarioBaseFilename( scope, { scenario });
+    expect( result ).to.equal( names.long_output );
+  });
+
   // language
   it(`adds a language correctly to a description`, async function() {
     scope.language = names.non_english_chars;

package/tests/unit_tests/getSafeScenarioFilename.test.js

@@ -5,13 +5,12 @@
  const names = require('./names.fixtures.js');
  const scope = require('../../lib/scope.js');
  const getSafeScenarioFilename = scope.getSafeScenarioFilename;
- 
- 
+
 let test_filename = function ( expected_prefix, result ) {
   /* Test a name to see if it's valid output with a language defined. */
-  let expected_name_regex_str = `^${ expected_prefix }-${ names.base_filename }-\.{32}$`;
+  let expected_name_regex_str = `^${ expected_prefix }-${ names.description }-\.{13}$`;
   if ( expected_prefix == `` ) {
-   expected_name_regex_str = `^${ names.base_filename }-\.{32}$`;
+   expected_name_regex_str = `^${ names.description }-\.{13}$`;
   }
   let regex = new RegExp( expected_name_regex_str );
  
@@ -29,7 +28,7 @@ let test_filename = function ( expected_prefix, result ) {
  describe(`When I use scope.getSafeScenarioFilename()`, function() {
  
    beforeEach(function() {
-    scope.base_filename = names.base_filename;
+    scope.base_filename = names.description;
    });
  
    it(`preserves chinese characters`, async function() {
@@ -81,6 +80,31 @@ let test_filename = function ( expected_prefix, result ) {
      let result = await getSafeScenarioFilename( scope, { prefix: names.numerical_input });
     test_filename( names.numerical_output, result );
    });
+
+  it(`handles a missing prefix`, async function() {
+    let result = await getSafeScenarioFilename( scope );
+    test_filename( ``, result );
+  });
+
+  it(`shortens ids over 20 chars long`, async function() {
+    // Necessary to set id correctly
+    scope.page = true;
+    let old_examine = scope.examinePageID;
+    scope.examinePageID = function () { return {id: names.long_id_input}; }
+    let result = await getSafeScenarioFilename( scope );
+    scope.examinePageID = old_examine;
+
+    let regext_str = `^${ names.long_id_output }-${ scope.base_filename }-\.*$`;
+    let regex = new RegExp( regext_str );
+
+    // Log more info if it failed
+    let found_match = regex.test( result );
+    if ( !found_match ) {
+      console.log( 'regex:', regex.source );
+      console.log( 'result:', result );
+    }
+    expect( found_match ).to.be.true;
+  });
  
  });
  

package/tests/unit_tests/names.fixtures.js

@@ -1,6 +1,6 @@
 let names = {};
 
-names.base_filename = `a_safe_id`;
+names.description = `a_safe_scenario_description`;
 
 names.chinese_input = `是汉字`;
 names.chinese_output = `是汉字`;
@@ -32,4 +32,7 @@ names.two_consecutive_invalid_output = `two_consecutive__invalid`;
 names.numerical_input = `scenario_w1th_number00`;
 names.numerical_output = `scenario_w1th_number00`;
 
+names.long_id_input = `over_20_chars_123456789`;
+names.long_id_output = `over_20_chars_123456`;
+
 module.exports = names;