@suffolklitlab/alkiln 5.13.3-feat-random-2 → 5.13.3-feat-random-3

package/.github/workflows/github_server.yml

@@ -159,9 +159,7 @@ jobs:
           INSTALL_METHOD: "server"
           #### Developer note: You can probably leave the rest out
           #### To learn more, see https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
-          #ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
-          # Temp debugging GitHub multi-folder problem
-          ALKILN_TAG_EXPRESSION: "@rp1"
+          ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
           ALKILN_VERSION: random
 
       #### Developer note: Example of making an issue when tests fail

package/.github/workflows/playground.yml

@@ -80,8 +80,6 @@ jobs:
           # Internal: docassemble changes sometimes break @a11y tests. That is
           # a da problem, not ours. We will trigger these tests manually when we
           # want to check up on this.
-          #ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
-          # Temp debugging GitHub multi-folder problem
-          ALKILN_TAG_EXPRESSION: "@rp1"
+          ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
           #### Developer note: You can probably leave this out
           ALKILN_VERSION: random

package/CHANGELOG.md

@@ -43,7 +43,34 @@ Format:
 - 
 -->
 
-<!-- ## [Unreleased] -->
+## [Unreleased]
+
+### Added
+
+- Add the `constrained random answers` Step. You must put the Step in a "constrained random test generator" Scenario which goes in a "constrained random test generator" file - a `.feature` file that starts with "alkiln_random". The file **MUST have ONLY 1 Scenario per generator file** at the moment. The Step is pretty strict. If there are irregularities, it will probably fail, but it will fail quickly. It is flexible about number of tests, though, and will default to 1. Closes [#962](https://github.com/SuffolkLITLab/ALKiln/issues/962).
+- Add `MAX_RANDOM_TESTS_PER_SCENARIO` optional environment variable for the above `constrained random answers` Step. Default value is `40` until we hear otherwise.
+- Regular tests that have incorrect syntax will fail more quickly now - very near the start. So will invalid "constrained random test generator" files. This will be a little slower for GitHub Sandbox tests right now, but still faster than it has been in the past. Closes [#972](https://github.com/SuffolkLITLab/ALKiln/issues/972).
+
+### Changed
+
+- Improve report indentation and tweak styling.
+- Clarify some logs, including addressing bite-sized issues like [#981](https://github.com/SuffolkLITLab/ALKiln/issues/981).
+- The report now shows the name of every Step that gets run in a test.
+
+### Internal
+
+- Added: `lib/globals.js` file to hold some shared constant values across the framework. It should NOT manage state. We may want to change the name to `constants.js` or `global_contants.js`. Let's see how it serves us.
+- Added: executable scripts for more setup steps - managing the artifacts path (at the start of a run) and validating and generating files.
+- Changed: `Log` now prioritizes what folder it stores files in in this order:
+    1. Use the argument to use an existing folder and save that to runtime_config.json at root.
+    2. Use the argument to make a new folder with that name and save that to runtime_config.json at root.
+    3. Use the alread-existing folder name value in runtime_config.json at root
+    4. Create a new folder and save that to runtime_config.json at root
+- Changed: Add `.error()` to `Log` for visual clarity when storing an error to throw later. We need to discuss this behavior and its return value. To make that work Logs can now get the `error` prop without throwing an error.
+- Changed: the Story Table step now accepts multiple ids and stops at whatever id it reaches first. I highly recommend that only ALKiln generated tests use this feature. We may avoid documenting it unless authors ask for it.
+- Changed: `.gitignore` and `.npmignore` more things
+- Fixed: log codes checker obob.
+- Fixed: updated `actions/upload-artifact@v3` to `actions/upload-artifact@v4`
 
 ## [5.13.4] - 2025-01-11
 

package/lib/run_cucumber.js

@@ -79,12 +79,6 @@ async function main() {
   log.info({ code: `ALK0049`, context: `pre_run environment` },
     environment
   );
-
-  // TODO: These are not used as far as I can tell. Delete them
-  // // We'll use the user info to construct the possible paths to /sources
-  // let id = session_vars.get_user_id();
-  // // `project` is the name in the server docassemble "Project" page
-  // let project = session_vars.get_user_project_name();
   
   const { runConfiguration } = await cucumber_api.loadConfiguration({
     provided: build_config( argv ),

package/lib/steps.js

@@ -99,28 +99,12 @@ BeforeAll(async function() {
   // Store path names for files and docs created for the tests
   scope.paths = {};
 
-  // // Make the folder to store all the files for this run of the tests
-  // scope.paths.artifacts = files.make_artifacts_folder();
-  // // Save its name in a file. `session_vars` can get it back later.
-  // // The value we are saving is used by at least run_cucumber.js.
-
   // A little indirect, but the artifacts path should always have already been
   // created by now, either by `run_cucumber.js` or the relevant test
-
-  // // TODO: Is this causing the GitHub tests artifacts trouble? Because
-  // // `.get_artifacts_path_name()` is messing up somehow? That shouldn't be a
-  // // problem. That's the same method `Log` uses. Why does runtime_config not
-  // // have a value here?
-  // scope.paths.artifacts = session_vars.get_artifacts_path_name();
-  // log = new Log({ path: scope.paths.artifacts, context: `steps` });
-
-  console.log(`\n\n`, `scope.paths.artifacts:`, scope.paths.artifacts, `\n\n`);
-  // New attempt avoids passing in a path. For the record, this shouldn't help.
   log = new Log({ context: `steps` });
   scope.set_log({ log_obj: log });
 
   scope.paths.artifacts = session_vars.get_artifacts_path_name();
-
   scope.paths.debug_log = `${ scope.paths.artifacts }/${ log.debug_log_filename }`;
   scope.paths.report_log = `${ scope.paths.artifacts }/${ log.report_log_filename }`;
   scope.paths.report = `${ scope.paths.artifacts }/${ log.report_filename }`;
@@ -196,7 +180,7 @@ BeforeStep(async function ( step ) {
   //    start of a Step after it's been completed, as cucumber already does. Add
   //    a 'step' type and additional success/failure information, though that
   //    may be challenging.
-  reports.addToReport(scope, { type: `row info`, value: step.pickleStep.text });
+  reports.addToReport(scope, { type: `row`, value: step.pickleStep.text });
   reports.indent();
 });
 

package/lib/utils/Log.js

@@ -147,8 +147,6 @@ class Log {
      * const log = new Log({ path: "_alkiln-123", context: "setup" });
      * */
 
-    console.trace(`\n\nCreating from Log`);
-
     // These records help internal tests check for correct behavior
     this.internal_log_records = [];
 
@@ -164,7 +162,6 @@ class Log {
     if ( context ) { context = context + ` log`; }
     else { context = `log`; }
     let files_msg = `ALKiln will save test results files at "${ this.path }"`;
-    console.log(`🐛🐛🐛🐛🐛 ALKTemp debugging Log path. Calculated path:`, this.path);
     if ( is_new_folder ) {
       this.info({ code: `ALK0214`, context, }, files_msg );
     }  else {
@@ -220,30 +217,23 @@ class Log {
      * */
     try {
 
-      console.log(`🐛🐛🐛🐛🐛 ALKTemp debugging Log path. Given dir:`, dir);
-
       // GitHub actions pass in a dir, but other processes, like
       //    ALKilnInThePlayground, don't have a path
       if ( !dir ) {
-        console.log(`🐛🐛🐛🐛🐛 ALKTemp debugging Log path. No dir given`);
         if ( session_vars.get_artifacts_path_name() ) {
-          console.log(`🐛🐛🐛🐛🐛 ALKTemp debugging Log path. Artifacts path already has a name`);
           dir = session_vars.get_artifacts_path_name();
         } else {
-          console.log(`🐛🐛🐛🐛🐛 ALKTemp debugging Log path. Making brand new artifacts path`);
           dir = files.make_artifacts_folder();
         }
       }
 
       if ( !fs.existsSync( dir )) {
-        console.log(`🐛🐛🐛🐛🐛 ALKTemp debugging Log path. Artifacts path dir doesn't yet exist`);
         files.make_artifacts_folder( dir );
       }
 
       return { dir, errors: [] };
 
     } catch ( error_making_dir ) {
-      // Logs should fail silently. With no dir, though, we can't save the error
       return { dir, errors: [ error_making_dir ]};
     }
     

package/lib/utils/session_vars.js

@@ -280,7 +280,6 @@ session_vars.get_runtime_config_var = function ( key ) {
   try {
     let json = JSON.parse( fs.readFileSync( runtime_config_path ));
     let value = json[ key ];
-    console.log(`🐛🐛🐛🐛🐛 ALK00temp config key/value pair:`, key, value);
     if ( session_vars.get_debug() ) {
       console.debug( `🐛 ALK0041 DEBUG: Runtime config var "${ key }" is "${ value }".` );
     }

package/package.json

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

package/_alkiln_meta/shift_logs.js

@@ -1,75 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-function shift_logs(folderPath, startNum, endNum) {
-    // Validate inputs
-    if (!folderPath || typeof folderPath !== 'string') {
-        throw new Error('Invalid folder path provided');
-    }
-    if (!startNum || !endNum || isNaN(startNum) || isNaN(endNum)) {
-        throw new Error('Invalid number range provided');
-    }
-
-    // Process directory recursively
-    function processDirectory(dirPath) {
-        // Read all files in the folder
-        const files = fs.readdirSync(dirPath);
-        
-        files.forEach(file => {
-            const some_path = path.join(dirPath, file);
-            const stats = fs.statSync(some_path);
-
-            if (stats.isDirectory()) {
-                // Recursively process subdirectories
-                processDirectory(some_path);
-            } else if (stats.isFile()) {
-                // Only process supported file paths
-                if ( some_path.startsWith(`.`) || some_path.startsWith(`alkiln`) || some_path.startsWith(`_`)) {
-                    console.log(`not editing`, some_path);
-                    return;
-                }
-                if (some_path.match(/(node_modules)|(_alkiln)|(package)|(shrinkwrap)|(runtime)|(alkiln\-)$/)) {
-                    console.log(`not editing`, some_path);
-                    return;
-                }
-
-                let content = fs.readFileSync(some_path, 'utf8');
-                
-                // Create regex pattern for ALK followed by digits
-                const pattern = /\bALK0(\d+)\b/g;
-                
-                // Process matches and adjust numbers
-                content = content.replace(pattern, (match, numStr) => {
-                    console.log(`match in ${ some_path }:`, JSON.stringify(match) );
-                    
-                    const num = parseInt(numStr);
-                    // Only modify numbers within our target range
-                    if (num >= startNum && num <= endNum) {
-                        console.log(`Changing match: previous content:`);
-                        console.log( content );
-                        return `ALK0${num + 1}`;
-                    }
-                    return match;
-                });
-
-                // Write back the modified content
-                fs.writeFileSync(some_path, content);
-                console.log(`Processed file: ${file}`);
-            }
-        });
-    }
-
-    processDirectory(folderPath)
-}
-
-// Example usage
-try {
-    shift_logs(`.`, 236, 276);  //'./your_folder', 123, 456);
-    console.log('Sequence fixing completed');
-} catch (error) {
-    console.error('Error:', error.message);
-}
-
-
-function check_types({ folderPath, startNum, endNum }) {
-}