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

package/.github/workflows/github_server.yml

@@ -45,15 +45,15 @@ jobs:
     #### keyword or values at all. See
     #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing#env-vars
     env:
-      SECRET_VAR1: secret-var1-value
-      SECRET_VAR2: secret-var2-value
-      SECRET_FOR_MISSING_FIELD: secret for missing field
-      INVALID_API_KEY: invalidAPIkey
-      EMPTY_STRING: ""
       NORMAL_USER_EMAIL: alkiln@example.com
       NORMAL_USER_PASSWORD: User123^
       WRONG_EMAIL: wrong_email@example.com
       WRONG_PASSWORD: wrong_password
+      INVALID_API_KEY: invalidAPIkey
+      EMPTY_STRING: ""
+      SECRET_VAR1: secret-var1-value
+      SECRET_VAR2: secret-var2-value
+      SECRET_FOR_MISSING_FIELD: secret for missing field
       
     steps:
       # Place the root directory in this branch to access
@@ -159,8 +159,10 @@ 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 }}"
-          ALKILN_VERSION: download
+          #ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
+          # Temp debugging GitHub multi-folder problem
+          ALKILN_TAG_EXPRESSION: "@rp1"
+          ALKILN_VERSION: random
 
       #### Developer note: Example of making an issue when tests fail
       #### that includes the text of the failure output file
@@ -169,7 +171,7 @@ jobs:
         if: ${{ failure() }}
         env:
           GH_TOKEN: ${{ github.token }}
-          PATH_TO_REPORT_FILE: "${{ steps.alkiln.outputs.PATH_TO_REPORT_FILE }}"
+          PATH_TO_REPORT_LOG_FILE: "${{ steps.alkiln.outputs.PATH_TO_REPORT_LOG_FILE }}"
           PATH_TO_UNEXPECTED_RESULTS_FILE: "${{ steps.alkiln.outputs.PATH_TO_UNEXPECTED_RESULTS_FILE }}"
           PATH_TO_DEBUG_LOG_FILE: "${{ steps.alkiln.outputs.PATH_TO_DEBUG_LOG_FILE }}"
         run: |

package/.github/workflows/playground.yml

@@ -76,9 +76,12 @@ jobs:
           DOCASSEMBLE_DEVELOPER_API_KEY: "${{ env.DOCASSEMBLE_DEVELOPER_API_KEY }}"
           #### Developer note: See https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
           #### You can probably leave this out
+          MAX_RANDOM_TESTS_PER_SCENARIO: 10
           # 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 }}"
+          #ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
+          # Temp debugging GitHub multi-folder problem
+          ALKILN_TAG_EXPRESSION: "@rp1"
           #### Developer note: You can probably leave this out
-          ALKILN_VERSION: download
+          ALKILN_VERSION: random

package/.github/workflows/unit_tests.yml

@@ -27,7 +27,7 @@ jobs:
       - run: npm run unit
       # Artifacts
       - name: upload unit tests artifacts folder
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         # This will upload even if a previous step has failed
         if: ${{ always() }}
         with:

package/CHANGELOG.md

@@ -43,11 +43,36 @@ Format:
 - 
 -->
 
-## [Unreleased]
+<!-- ## [Unreleased] -->
+
+## [5.13.4] - 2025-01-11
+
+### Changed
+
+- Removed an extraneous log
+
+### Fixed
+
+- Final error showed an undefined var instead of a more useful error message
+
+### Internal
+
+- Refactored `log` into a class that works with ALKiln's 4 possible environments
+- Refactored `Log` class to handle throwing errors
+- Now store debug information in debug log instead of printing it live
+- Removed debug flag so debug logs always get stored
+- Added decision/design docs
+
+## [5.13.3] - 2025-01-05
+
+### Fixed
+
+- Updates to latest docassemble HTML. See [#960](https://github.com/SuffolkLITLab/ALKiln/issues/960). Changes all appearances of `fieldset` to keep the code consistent.
 
 ## [5.13.2] - 2024-11-23
 
 ### Fixed
+
 - Fixes download Step unable to use a partial filename match. The Step needed the whole name, including the extension. See [#725](https://github.com/SuffolkLITLab/ALKiln/issues/725).
 
 ## [5.13.1] - 2024-10-23
@@ -59,6 +84,8 @@ Format:
 ### Fixed
 
 - Detects failed sign in. Closes [#918](https://github.com/SuffolkLITLab/ALKiln/issues/918).
+- Fixes undefined `errors` var in `After()`
+- Closes [#924](https://github.com/SuffolkLITLab/ALKiln/issues/924), remove extra interview url print
 
 ### Internal
 
@@ -69,6 +96,10 @@ Format:
 - Adds decision docs
 - Updated CONTRIBUTING.md
 - Added example.env, closes [#374](https://github.com/SuffolkLITLab/ALKiln/issues/374)
+- Closes [#805](https://github.com/SuffolkLITLab/ALKiln/issues/805), create verbose-type log
+- Closes [#659](https://github.com/SuffolkLITLab/ALKiln/issues/659), abstract adding to debug_log
+- Closes [#925](https://github.com/SuffolkLITLab/ALKiln/issues/925), allow a `Log` to throw an error
+- Addresses [#461](https://github.com/SuffolkLITLab/ALKiln/issues/461), setup and takedown reports
 - Updates pdfjs-dist for node v20 and v22. See [#952](https://github.com/SuffolkLITLab/ALKiln/issues/952).
 
 ## [5.13.0] - 2024-07-11

package/_alkiln_meta/shift_logs.js

@@ -0,0 +1,75 @@
+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 }) {
+}

package/action.yml

@@ -33,6 +33,10 @@ inputs:
     description: "The version of docassemblecli to install."
     required: false
     default: "0.0.17"
+  MAX_RANDOM_TESTS_PER_SCENARIO:
+    description: "The maximum number of tests ALKiln will generate for every Scenario that can generate tests."
+    required: false
+    # Default will be internal to avoid duplication of data
 
 outputs:
   PATH_TO_ARTIFACTS:
@@ -41,6 +45,9 @@ outputs:
   PATH_TO_REPORT_FILE:
     description: 'An empty string ("") or the path to report.txt. Remember to check for the existence of the file before using it.'
     value: ${{ steps.alkiln_outputs.outputs.PATH_TO_REPORT_FILE }}
+  PATH_TO_REPORT_LOG_FILE:
+    description: 'An empty string ("") or the path to report_log.txt. Remember to check for the existence of the file before using it.'
+    value: ${{ steps.alkiln_outputs.outputs.PATH_TO_REPORT_LOG_FILE }}
   PATH_TO_UNEXPECTED_RESULTS_FILE:
     description: 'An empty string ("") or the path to unexpected_results.txt. Remember to check for the existence of the file before using it.'
     value: ${{ steps.alkiln_outputs.outputs.PATH_TO_UNEXPECTED_RESULTS_FILE }}
@@ -65,11 +72,23 @@ runs:
         MAX_SECONDS_FOR_SETUP: ${{ inputs.MAX_SECONDS_FOR_SETUP }}
         SERVER_RELOAD_TIMEOUT_SECONDS: ${{ inputs.SERVER_RELOAD_TIMEOUT_SECONDS }}
         DOCASSEMBLECLI_VERSION: ${{ inputs.DOCASSEMBLECLI_VERSION }}
+        MAX_RANDOM_TESTS_PER_SCENARIO: ${{ inputs.MAX_RANDOM_TESTS_PER_SCENARIO }}
       shell: bash
       run: |
-        # 💡 ALK0023 INFO: Set environment variables
+        log="💡 ALK0023 INFO: Set environment variables and create artifacts folder"
+
         # 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
-        echo "ARTIFACT_NAME=alkiln-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u)UTC" >> $GITHUB_ENV
+        timestamp="$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u)"
+        artifact_folder="alkiln-${timestamp}UTC"
+        debug_path="${artifact_folder}/debug_log.txt"
+        mkdir -p "$artifact_folder"
+        echo "$log" >> "$debug_path"
+
+        # Action-specific vars
+        echo "ARTIFACT_FOLDER=$artifact_folder" >> $GITHUB_ENV
+        echo "DEBUG_PATH=$debug_path" >> $GITHUB_ENV
+
+        # Required for all tests
         echo "REPO_URL=${{ github.server_url }}/${{ github.repository }}" >> $GITHUB_ENV
         echo "BRANCH_PATH=$BRANCH_PATH" >> $GITHUB_ENV
         # Workflow inputs
@@ -77,6 +96,7 @@ runs:
         echo "DOCASSEMBLE_DEVELOPER_API_KEY=$DOCASSEMBLE_DEVELOPER_API_KEY" >> $GITHUB_ENV
         echo "ALKILN_VERSION=$ALKILN_VERSION" >> $GITHUB_ENV
         echo "MAX_SECONDS_FOR_SETUP=$MAX_SECONDS_FOR_SETUP" >> $GITHUB_ENV
+        echo "MAX_RANDOM_TESTS_PER_SCENARIO=$MAX_RANDOM_TESTS_PER_SCENARIO" >> $GITHUB_ENV
         echo "SERVER_RELOAD_TIMEOUT_SECONDS=$SERVER_RELOAD_TIMEOUT_SECONDS" >> $GITHUB_ENV
         echo "DOCASSEMBLECLI_VERSION=$DOCASSEMBLECLI_VERSION" >> $GITHUB_ENV
         # Hard-coded internal ALKiln vars
@@ -84,22 +104,35 @@ runs:
     - name: "💡 ALK0024 INFO: Confirm environment variables"
       shell: bash
       run: |
-        # 💡 ALK0024 INFO: Confirm environment variables
-        echo -e "\nALKiln version is $ALKILN_VERSION\nRepo is $REPO_URL\nBranch ref is $BRANCH_PATH\nMAX_SECONDS_FOR_SETUP is $MAX_SECONDS_FOR_SETUP\nSERVER_RELOAD_TIMEOUT_SECONDS is $SERVER_RELOAD_TIMEOUT_SECONDS\n"
+        log="💡 ALK0024 INFO: Confirm environment variables"
+        echo -e "\n$log" >> "${{ env.DEBUG_PATH }}"
+        vars_log='\nALKiln version is ${{ env.ALKILN_VERSION }}\nRepo is "${{ env.REPO_URL }}"\nBranch ref is "${{ env.BRANCH_PATH }}"\nCustom MAX_SECONDS_FOR_SETUP is "${{ env.MAX_SECONDS_FOR_SETUP }}"\nCustom SERVER_RELOAD_TIMEOUT_SECONDS is "${{ env.SERVER_RELOAD_TIMEOUT_SECONDS }}"\nCustom MAX_RANDOM_TESTS_PER_SCENARIO is "${{ env.MAX_RANDOM_TESTS_PER_SCENARIO }}"\n'
+        echo -e "$vars_log" >> "${{ env.DEBUG_PATH }}" && echo -e "$vars_log"
 
-    # Install
-    - name: "💡 ALK0025 INFO: Install node packages"
+    # Install ALKiln during GitHub workflow
+    - name: "💡 ALK0025 INFO: Set up node"
       uses: actions/setup-node@v4
       with:
         node-version: "18"
     - name: "💡 ALK0026 INFO: Install ALKiln directly from npm"
       shell: bash
       run: |
-        # 💡 ALK0026 INFO: Install ALKiln directly from npm
+        log="💡 ALK0026 INFO: Install ALKiln directly from npm"
+        echo -e "\n$log" >> "${{ env.DEBUG_PATH }}"
         npm install -g "@suffolklitlab/alkiln@$ALKILN_VERSION"
 
-    # Install on playground
+    # Files prep
+    - shell: bash
+      env:
+        ARTIFACT_FOLDER: ${{ env.ARTIFACT_FOLDER }}
+      run: |
+        log="💡 ALK0275 INFO: Prepare repository test files"
+        echo -e "\n$log" >> "${{ env.DEBUG_PATH }}"
+        alkiln-artifacts --path="${{ env.ARTIFACT_FOLDER }}"
+        alkiln-validate
+        alkiln-generate
 
+    # Install package on playground
     # Don't rely on the environment's version of python
     - uses: actions/setup-python@v5
       if: ${{ inputs.INSTALL_METHOD == 'playground' }}
@@ -109,26 +142,32 @@ runs:
       if: ${{ inputs.INSTALL_METHOD == 'playground' }}
       shell: bash
       run: |
-        # 💡 ALK0027 INFO: Create a Project and install the package from GitHub
+        log="💡 ALK0027 INFO: Create a Project and install the package from GitHub"
+        echo -e "\n$log" >> "${{ env.DEBUG_PATH }}"
         pip install "docassemblecli==$DOCASSEMBLECLI_VERSION"
         alkiln-setup
-    - name: "😞 ALK0028 ERROR: Unable to create a Project"
+    - name: "🤕 ALK0028 ERROR: Unable to create a Project"
       if: ${{ inputs.INSTALL_METHOD == 'playground' && failure() }}
       shell: bash
       run: |
-        # 😞 ALK0028 ERROR: Unable to create a Project
-        echo -e "\n\n====\n😞 ALK0028 ERROR: Unable to create a Project on your server's testing account or pull your package into it. Check the messages above this line.\n\n"
+        # "🤕 ALK0028 ERROR: Unable to create a Project"
+        long_log="\n\n―――\n🤕 ALK0028 ERROR: Unable to create a Project on your server's testing account or pull your package into it. Check the messages above this line.\n\n"
+        echo -e "$long_log" >> "${{ env.DEBUG_PATH }}" && echo -e "$long_log"
 
-    # Server installations - find folders and save session vars
-    - name: "💡 ALK0029 INFO: Install the GitHub package onto the server"
+    # Server installation
+    - name: "💡 ALK0029 INFO: Try to install the GitHub package onto the GitHub sandbox server"
       if: ${{ inputs.INSTALL_METHOD == 'server' }}
       shell: bash
-      run: alkiln-server-install
-    - name: "😞 ALK0030 ERROR: Unable to install the package"
+      run: |
+        log="💡 ALK0029 INFO: Install the GitHub package onto the server"
+        echo -e "\n$log" >> "${{ env.DEBUG_PATH }}"
+        alkiln-server-install
+    - name: "🤕 ALK0030 ERROR: Unable to install the package on the GitHub sandbox server"
       if: ${{ inputs.INSTALL_METHOD == 'server' && failure() }}
       shell: bash
       run: |
-        echo -e "\n\n====\n😞 ALK0030 ERROR: Unable to install the package on the temporary GitHub docassemble server. Check the steps above this line.\n\n"
+        log="\n\n―――\n🤕 ALK0030 ERROR: Unable to install the package on the temporary GitHub docassemble server. Check the steps above this line.\n\n"
+        echo -e "$log" >> "${{ env.DEBUG_PATH }}" && echo -e "$log"
 
     # run tests
     - name: "💡 ALK0031 INFO: Run tests"
@@ -136,20 +175,26 @@ runs:
       env:
         ALKILN_TAG_EXPRESSION: ${{ inputs.ALKILN_TAG_EXPRESSION || github.event.inputs.tags && format('{0}', github.event.inputs.tags) }}
       shell: bash
-      run: alkiln-run "$ALKILN_TAG_EXPRESSION"
+      run: |
+        log="💡 ALK0031 INFO: Run tests"
+        echo -e "\n$log" >> "${{ env.DEBUG_PATH }}"
+        alkiln-run "$ALKILN_TAG_EXPRESSION"
     
     # on playground, delete project
     - name: "💡 ALK0032 INFO: Delete the Project from the Playground"
       if: ${{ always() && inputs.INSTALL_METHOD == 'playground' }}
-      run: alkiln-takedown
       shell: bash
+      run: |
+        log="💡 ALK0032 INFO: Delete the Project from the Playground"
+        echo -e "\n$log" >> "${{ env.DEBUG_PATH }}"
+        alkiln-takedown
     
     # Upload artifacts that subscribers can download on the Actions summary page
     - name: "💡 ALK0033 INFO: Upload artifacts folder"
       if: ${{ always() }}
       uses: actions/upload-artifact@v4
       with:
-        name: ${{ env.ARTIFACT_NAME }}
+        name: ${{ env.ARTIFACT_FOLDER }}
         path: ./alkiln-*
 
     # Download artifacts folder internally to create action output
@@ -157,45 +202,56 @@ runs:
       if: ${{ always() }}
       uses: actions/download-artifact@v4
       with:
-        name: ${{ env.ARTIFACT_NAME }}
+        name: ${{ env.ARTIFACT_FOLDER }}
 
     - name: "💡 ALK0184 INFO: Prepare ALKiln output file paths"
       if: ${{ always() }}
       id: alkiln_outputs
       shell: bash
       run: |
-        # 💡 ALK0184 INFO: Prepare ALKiln output file paths
+        log="💡 ALK0184 INFO: Prepare ALKiln output file paths"
+        echo -e "\n$log" >> "${{ env.DEBUG_PATH }}" && echo "$log"
 
         FOLDER=$(ls -d */ | grep -E '^alkiln-*' || true)
 
-        echo "Test results artifacts folder is $FOLDER"
+        log_folder="Test results artifacts folder is $FOLDER"
+        echo -e "\n$log_folder" >> "${{ env.DEBUG_PATH }}" && echo "$log_folder"
 
         if [[ "$FOLDER" = "" ]]; then
-          echo "Artifacts folder is missing. The path is an empty string: '$FOLDER'"
+          log_missing="Artifacts folder is missing. The path is an empty string: '$FOLDER'"
+          echo -e "\n$log_missing" >> "${{ env.DEBUG_PATH }}" && echo "$log_missing"
 
         else
           REPORT_PATH="${FOLDER}report.txt"
+          REPORT_LOG_PATH="${FOLDER}report_log.txt"
           UNEXPECTED_RESULTS_PATH="${FOLDER}unexpected_results.txt"
           DEBUG_LOG_PATH="${FOLDER}debug_log.txt"
 
           if [ -f "$REPORT_PATH" ]; then
-            echo "$REPORT_PATH exists"
+            echo -e "\n$REPORT_PATH exists" >> "${{ env.DEBUG_PATH }}" && echo "$REPORT_PATH exists"
           else
-            echo "$REPORT_PATH is missing"
+            echo -e "\n$REPORT_PATH is missing" >> "${{ env.DEBUG_PATH }}" && echo "$REPORT_PATH is missing"
             REPORT_PATH=""
           fi
 
+          if [ -f "$REPORT_LOG_PATH" ]; then
+            echo -e "\n$REPORT_LOG_PATH exists" >> "${{ env.DEBUG_PATH }}" && echo "$REPORT_LOG_PATH exists"
+          else
+            echo -e "\n$REPORT_LOG_PATH is missing" >> "${{ env.DEBUG_PATH }}" && echo "$REPORT_LOG_PATH is missing"
+            REPORT_LOG_PATH=""
+          fi
+
           if [ -f "$UNEXPECTED_RESULTS_PATH" ]; then
-            echo "$UNEXPECTED_RESULTS_PATH exists"
+            echo -e "\n$UNEXPECTED_RESULTS_PATH exists" >> "${{ env.DEBUG_PATH }}" && echo "$UNEXPECTED_RESULTS_PATH exists"
           else
-            echo "$UNEXPECTED_RESULTS_PATH is missing"
+            echo -e "\n$UNEXPECTED_RESULTS_PATH is missing" >> "${{ env.DEBUG_PATH }}" && echo "$UNEXPECTED_RESULTS_PATH is missing"
             UNEXPECTED_RESULTS_PATH=""
           fi
 
           if [ -f "$DEBUG_LOG_PATH" ]; then
-            echo "$DEBUG_LOG_PATH exists"
+            echo -e "\n$DEBUG_LOG_PATH exists" >> "${{ env.DEBUG_PATH }}" && echo "$DEBUG_LOG_PATH exists"
           else
-            echo "$DEBUG_LOG_PATH is missing"
+            echo -e "\n$DEBUG_LOG_PATH is missing" >> "${{ env.DEBUG_PATH }}" && echo "$DEBUG_LOG_PATH is missing"
             DEBUG_LOG_PATH=""
           fi
 
@@ -203,6 +259,7 @@ runs:
 
         echo "PATH_TO_ARTIFACTS=$FOLDER" >> "$GITHUB_OUTPUT"
         echo "PATH_TO_REPORT_FILE=$REPORT_PATH" >> "$GITHUB_OUTPUT"
+        echo "PATH_TO_REPORT_LOG_FILE=$REPORT_LOG_PATH" >> "$GITHUB_OUTPUT"
         echo "PATH_TO_UNEXPECTED_RESULTS_FILE=$UNEXPECTED_RESULTS_PATH" >> "$GITHUB_OUTPUT"
         echo "PATH_TO_DEBUG_LOG_FILE=$DEBUG_LOG_PATH" >> "$GITHUB_OUTPUT"
 
@@ -212,4 +269,5 @@ runs:
     - shell: bash
       if: ${{ always() }}
       run: |
-        echo "💡 ALK0034 INFO: ALkiln finished running tests"
+        log="💡 ALK0034 INFO: ALkiln finished running tests. See above for more details."
+        echo -e "\n$log" >> "${{ env.DEBUG_PATH }}" && echo "$log"