@suffolklitlab/alkiln 5.4.0 → 5.4.1-feat-github-server-15

package/lib/scope.js

@@ -46,6 +46,9 @@ let printable_var_value = function(row) {
   /* `row` might be a row, a source row, or an original row. */
   let original = get_original_row(row);
   if ( is_secret_var(original) ) {
+    if ( session_vars.get_dangerous_debug() ) {
+      return `alkiln_dangerous ${ row.value }`;
+    }
     return original.flags.secret_name;
   }
   return row.value;
@@ -1681,75 +1684,52 @@ module.exports = {
   },  // Ends scope.today_to_date()
 
   findFiles: async function( scope, {to_find_names}) {
+    /** Returns a list of paths to the sources folder associated
+    *    with the given list of file names.
+    * 
+    * @param to_find_names { [str] } List of file names
+    * 
+    * @returns { [str] } sources folder paths
+    */
     // First make sure the list of files was defined. Don't remove spaces yet -
     // allow a typo where someone forgot to include a space after a comma.
+    // TODO: wish we had the var name here that folks are trying to set
     if ( to_find_names.length === 0 ) {
-      reports.addToReport( scope, {
-        type: `error`,
-        value: `Your list of files to find is empty.`
-      });
-      return [];
-    }
-
-    let dirs = [];
-    if ( session_vars.get_origin() === `playground` ) {
-      let files_playground = fg.sync(
-        [ `/usr/share/docassemble/files/playgroundsources/${session_vars.get_user_id()}/${session_vars.get_user_project_name()}` ],
-        { onlyFiles: false, suppressErrors: true }
-      );
-      let files_s3 = fg.sync(
-        [ `/tmp/playgroundsources/${session_vars.get_user_id()}/${session_vars.get_user_project_name()}` ],
-        { onlyFiles: false, suppressErrors: true }
-      );
-
-      dirs = files_playground.concat( files_s3 );
-    } else {
-      dirs = fg.sync(
-        [ `**/docassemble/**/data/sources` ],
-        { onlyFiles: false, suppressErrors: true }
-      );
-    }
-
-    if ( session_vars.get_debug() ) {
-      console.log( `All discovered dirs to find files from:`, dirs );
-    }
-
-    // Make sure sources directory exists and has files in it
-    if ( dirs.length === 0 ) {
       reports.addToReport( scope, {
         type: `warning`,
-        value: `The test files need to be in the "sources" directory, `
-          + `but ALKiln couldn't find the directory or it was empty.`
+        value: `Your Step is missing the names of which file(s) to use.`
       });
       return [];
     }
 
-    // Get the full paths of all the files
+    let sources_dirs = session_vars.get_sources_paths();
+    // Get the full paths of all the existing files
     let paths = [];
     let missing_files = [];  // For any user warnings
-    for ( let name of to_find_names) {
-     
+    for ( let name of to_find_names ) {
+
       let trimmed_name = name.trim();
       let matching_paths = [];
-
-      for ( let one_dir of dirs ) {
-        // accumulate all matching paths
-        let new_paths = fg.sync([ `${ one_dir }/${ trimmed_name }` ]);
+      // Look for the file in all "sources" folders
+      for ( let one_dir of sources_dirs ) {
+        let new_paths = fg.sync(
+          [ `${ one_dir }/${ trimmed_name }` ],
+          { suppressErrors: true }
+        );
         matching_paths.push( ...new_paths );
-      }  // ends for each dir
+      }
 
       if ( matching_paths.length === 0 ) {
         missing_files.push( trimmed_name );
       } else {
         paths.push( ...matching_paths );
       }
-
     }  // ends for each file
 
     if ( missing_files.length > 0 ) {
       reports.addToReport( scope, {
         type: `warning`,
-        value: `ALKiln could not find "${ missing_files.join('", "') }" in any of these folders: "${ dirs.join('", "') }".`
+        value: `ALKiln could not find "${ missing_files.join('", "') }" in the folder(s) at "${ sources_dirs.join('", "') }".`
       });
     }
 
@@ -1758,7 +1738,7 @@ module.exports = {
       return [];
     }
     return paths;
-  },
+  },  // Ends scope.findFiles()
 
   uploadFiles: async function ( scope, { handle, answer }) {
     /* Try to upload one or more files to a file-type input field.
@@ -1999,7 +1979,7 @@ module.exports = {
       }
       if ( num_unused_rows > 0 ) {
         let { id } = await scope.examinePageID( scope, 'none to match' );
-        let msg = `Missing variable or variables on page "${id}"`;
+        let msg = `Error on page "${id}". See screenshot and see text above for more details.`;
         reports.addToReport(scope, { type: `error`, value: msg });
         expect( num_unused_rows, msg ).to.equal( 0 );
       }
@@ -2460,6 +2440,10 @@ module.exports = {
       /** Sets a non-story table variable to a "secret" value (i.e. an env var) */
       // Prevent pictures of a screen with a secret.
       scope.disable_error_screenshot = true;
+      if ( session_vars.get_dangerous_debug() ) {
+        scope.disable_error_screenshot = false;
+      }
+
       let var_data = await scope.normalizeTable( scope, {
               var_data: [{
                 var: var_name,
@@ -2629,7 +2613,10 @@ module.exports = {
       */
       // Don't take a picture of a failed login in case one of the inputs is correct
       scope.disable_error_screenshot = true;
-
+      if ( session_vars.get_dangerous_debug() ) {
+        scope.disable_error_screenshot = false;
+      }
+      
       // If there is no browser open, start a new one
       if (!scope.browser) {
         scope.browser = await scope.driver.launch({ headless: !session_vars.DEBUG });
@@ -2662,6 +2649,10 @@ module.exports = {
       let email = process.env[ email_secret_name ];
       let password = process.env[ password_secret_name ];
 
+      if ( session_vars.get_dangerous_debug() ) {
+        log.debug({ type: `unsafe`, data: `login: ${ email }, ${ password }` });
+      }
+
       // Give as many useful messages to the user as possible if the env vars
       // aren't defined. Eventually, just provide a link to the docs because
       // this is complex

package/lib/utils/log.js

@@ -42,7 +42,7 @@ log.error = function ({ type='', pre='', data='', post='' }) {
 
 log.debug = function ({ type='', pre='', data='', post='' }) {
   /* If debugging is turned on, log a message that includes `ALKiln` and `debug` */
-  if ( session_vars.get_debug() ) {
+  if ( session_vars.get_debug() || session_vars.get_dangerous_debug() ) {
     let start = create_msg_start([ type, 'debug' ], pre );
     // Log them each on a separate line
     console.log( `ALKiln ${ type } debug: ${ pre }` );

package/lib/utils/session_vars.js

@@ -1,4 +1,5 @@
 const fs = require('fs');
+const fg = require('fast-glob');
 const path = require('path'); 
 require('dotenv').config();
 
@@ -23,6 +24,11 @@ module.exports = session_vars;
 // These default to null
 // TODO: How to isolate debug elsewhere so this file can use the logger?
 session_vars.get_debug = function () { return process.env.DEBUG || null; };
+session_vars.get_dangerous_debug = function () {
+  /** Note this will cause failure of tests that reassure the user about
+  *   security precautions we took, like not taking a screenshot. */
+  return process.env._ALKILN_DANGEROUS_DEBUG || null;
+};
 session_vars.is_dev_env = function () { return process.env.DEV || null; }
 
 session_vars.get_dev_api_key = function () { return process.env.DOCASSEMBLE_DEVELOPER_API_KEY || null; };
@@ -37,13 +43,6 @@ session_vars.get_origin = function () {
 };
 session_vars.get_user_project_name = function () { return process.env._PROJECT_NAME || null; };
 session_vars.get_user_id = function () { return process.env._USER_ID || null; };
-session_vars.get_tags = function () {
-  if ( process.env._TAGS ) {
-    return process.env._TAGS.split(` `);
-  } else {
-    return [];
-  }
-};
 
 // More complex logic
 session_vars.get_server_reload_timeout = function () {
@@ -210,6 +209,124 @@ session_vars.get_artifacts_path_name = function () {
   }
 };  // Ends get_artifacts_path_name()
 
+
+const install_type_key = `da_install_type`;
+session_vars.save_install_type = function (install_type) {
+  /* Save a key with the name of the current artifacts folder in case it doesn't exist. */
+
+  // Ensure artifacts path file exists
+  if ( !fs.existsSync( runtime_config_path ) ) {
+    // If the file doesn't exist, make one because next we need to read it
+    fs.writeFileSync( runtime_config_path, JSON.stringify( {}, null, 2 ) );
+  }
+
+  // Get the json, changing it, and re-write the file from scratch
+  let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
+  json[ install_type_key ] = install_type;
+  let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
+
+  return file;
+};  // Ends save_install_type()
+
+session_vars.get_install_type = function () {
+  /* Get the name of the current artifacts path. */
+  try {
+    let json = JSON.parse( fs.readFileSync( runtime_config_path ));
+    let install_type = json[ install_type_key ];
+
+    return install_type;
+  } catch ( error ) {
+    return null;
+  }
+};  // Ends get_install_type()
+
+
+const repo_folder_key = `da_repo_folder_name`;
+session_vars.save_repo_folder_name = function (repo_folder_name) {
+  /** Save a key with the name of the main package folder in the repository. */
+
+  // Ensure runtime config file exists
+  if ( !fs.existsSync( runtime_config_path ) ) {
+    // If the file doesn't exist, make one because next we need to read it
+    fs.writeFileSync( runtime_config_path, JSON.stringify( {}, null, 2 ) );
+  }
+
+  // Get the json, changing it, and re-write the file from scratch
+  let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
+  json[ da_repo_folder_name ] = repo_folder_name;
+  let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
+
+  return file;
+};  // Ends session_vars.save_repo_folder_name()
+
+session_vars.get_repo_folder_name = function () {
+  /** Get the name of the main folder in the repository. */
+  try {
+    let json = JSON.parse( fs.readFileSync( runtime_config_path ));
+    let name = json[ da_repo_folder_name ];
+
+    return name;
+  } catch ( error ) {
+    return null;
+  }
+};  // Ends session_vars.get_repo_folder_name()
+
+
+session_vars.set_sources_paths = function ( paths ) {
+  /** Returns whether at least one of the given path exists. Store
+  *   a list of the existing paths. Warn of any missing paths. Can be
+  *   used for getting, e.g .feature files, files to upload, etc.
+  * 
+  * Our code should ensure this gets run before cucumber tests get triggered.
+  * 
+  * @param paths { [str] } List of paths to the 'sources' folder.
+  * 
+  * @returns bool
+  */
+
+  // Check every path, tracking which exist and which are missing
+  let existing_paths = [];
+  let missing_paths = [];
+  for ( let path of paths ) {
+    let dirs = fg.sync(
+      [ path ],
+      { onlyFiles: false, suppressErrors: true }
+    );
+
+    if ( dirs.length > 0 ) {
+      existing_paths.push( ...dirs );
+    } else {
+      missing_paths.push( path );
+    }
+  }
+
+  // Warn about missing paths
+  if ( missing_paths.length > 0 ) {
+    console.warn(
+      `ALKiln WARNING: ALKiln can't find folders at "${ paths.join(", ") }".`
+    );
+  }
+
+  // If no paths were valid
+  if ( existing_paths.length <= 0 ) {
+    session_vars._sources_paths = null;
+    return false;
+  }
+
+  // Otherwise, store valid paths
+  session_vars._sources_paths = existing_paths;
+  return true;
+};
+
+session_vars.get_sources_paths = function () {
+  /** Get the "sources" folder path. Should never be undefined during
+  *   a run of the test. run_cucumber.js should make sure it has
+  *   a default value.
+  * 
+  * @returns str || null */
+  return session_vars._sources_paths;
+};
+
 session_vars.validateEnvironment = function() {
   /** Throw a useful error for the developer if any of the env vars
   *    required by absolutely all tests are missing. Gather all
@@ -274,3 +391,36 @@ session_vars.validateEnvironment = function() {
 };
 
 session_vars.validateEnvironment();
+
+
+const save_runtime_config_var = function (key, value) {
+  /** Save a key and its value in the runtime config file. */
+
+  // Ensure runtime config file exists
+  if ( !fs.existsSync( runtime_config_path ) ) {
+    // If the file doesn't exist, make one because next we need to read it
+    fs.writeFileSync( runtime_config_path, JSON.stringify( {}, null, 2 ) );
+  }
+
+  // Get the json, changing it, and re-write the file from scratch
+  let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
+  json[ key ] = value;
+  let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
+
+  if ( session_vars.get_debug() ) {
+    console.log( `ALKiln debug: Stored "${key}" locally as "${value}".` );
+  }
+  return file;
+};  // Ends save_runtime_config_var()
+
+const get_runtime_config_var = function (key) {
+  /** Get the value of the given key from the runtime config file. */
+  try {
+    let json = JSON.parse( fs.readFileSync( runtime_config_path ));
+    let value = json[ key ];
+
+    return value;
+  } catch ( error ) {
+    return null;
+  }
+};  // Ends get_runtime_config_var()