@suffolklitlab/alkiln 4.6.1 → 4.7.1

package/.github/workflows/test_tests.yml

@@ -39,6 +39,11 @@ jobs:
 
     name: Run Puppeteer tests
     steps:
+      - 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_tests_output-$(date +'%Y-%m-%d at %Hhrs %Mmins %Ssecs' -u) UTC" >> $GITHUB_ENV
+          echo "UNIT_TESTS_ARTIFACT_NAME=_alkiln_tests_misc-$(date +'%Y-%m-%d at %Hhrs %Mmins %Ssecs' -u) UTC" >> $GITHUB_ENV
       - name: Set languages
         run: echo "EXTRA_LANGUAGES=${{ github.event.inputs.extra_languages }}" >> $GITHUB_ENV
         if: ${{ github.event.inputs.extra_languages != '' }}
@@ -53,46 +58,21 @@ jobs:
       - run: npm install
       - run: npm run setup
       - run: npm run test -- ${{ github.event.inputs.tags && format('"--tags" "{0}"', github.event.inputs.tags) }}
-      - name: upload error artifacts
+      # Artifacts
+      - name: upload unit tests artifacts folder
         uses: actions/upload-artifact@v2
-        if: ${{ failure() }}
-        with:
-          name: errors
-          path: ./**/error*.jpg
-      - name: upload screenshot steps
-        uses: actions/upload-artifact@v2
-        # They will upload even if a previosu step has failed
-        if: ${{ always() }}
-        with:
-          name: screenshots
-          path: ./**/screenshot*.jpg
-      - name: upload downloads
-        uses: actions/upload-artifact@v2
-        # They will upload even if a previous step has failed
-        if: ${{ always() }}
-        with:
-          name: downloads
-          path: ./**/downloads_*
-      - name: upload report
-        uses: actions/upload-artifact@v2
-        # They will upload even if a previous step has failed
-        if: ${{ always() }}
-        with:
-          name: report
-          path: ./**/*_report_*
-      - name: upload a11y reports
-        uses: actions/upload-artifact@v2
-        # They will upload even if a previous step has failed
+        # This will upload even if a previous step has failed
         if: ${{ always() }}
         with:
-          name: a11y report
-          path: ./**/aXe_failure_*
-      - name: upload debug_log artifact
+          name: ${{ env.UNIT_TESTS_ARTIFACT_NAME }}
+          path: ./_alkiln_tests_misc-*
+      - name: upload integration tests artifacts folder
         uses: actions/upload-artifact@v2
         if: ${{ always() }}
         with:
-          name: debug_log file
-          path: ./debug_log.txt
+          name: ${{ env.ARTIFACT_NAME }}
+          path: ./alkiln_tests_output-*
+      # Delete Playground Project and project name file
       - name: Cleanup
         if: ${{ always() }}
         run: npm run takedown

package/CHANGELOG.md

@@ -40,6 +40,32 @@ Format:
 -->
 <!-- ## [Unreleased] -->
 
+## [4.7.1] - 2022-08-07
+### Changed
+- Ensure unique folder names for random input screenshots in case developer uses multiple random steps in one Scenario.
+- Ensure random input detects unexpected interview errors.
+
+### Fixed
+- Fix failure when signature page is the first screen.
+- Internal tests failing even when failure status is as expected.
+- Double printing in report of scenario failure, one of them even when Scenario was possibly non-failure, like skipped.
+
+## [4.7.0] - 2022-07-27
+### Added
+- Generate random input to fill out a simple form automatically. Does not yet ensure that random screenshot folder names are unique, or that error screens are detected as errors. 4.7.1 implements those.
+
+### Changed
+- Add page id to the "Missing Variable or variables on page" error report
+- Allows Story Tables to not include a header row, as long as they have 2 or 3 columns.
+  This isn't the suggested way at the moment, since including headers is more readable,
+  but can prevent confusing and unnecessary errors.
+
+## [4.6.2] - 2022-06-28
+### Changed
+- Put cucumber tests' artifacts in one folder. See https://github.com/SuffolkLITLab/ALKiln/issues/552.
+- Add separate artifacts dir for our own internal tests, like unit tests
+- Abstract names of some of those artifact directories
+
 ## [4.6.1] - 2022-06-28
 ### Fixed
 - Single dropdown fields on pages are now recognized as fields properly

package/action.yml

@@ -36,12 +36,14 @@ inputs:
 runs:
   using: "composite"
   steps:
-    
     # Set environment variables
     - name: "ALKiln: Set environment variables"
       # If extra languages were set manually, override the repository
       # EXTRA_LANGUAGES secret with the manually set values
+      # 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_tests_output $(date +'%Y-%m-%d at %Hhrs %Mmins %Ssecs' -u) UTC" >> $GITHUB_ENV
         if ${{ github.event.inputs.extra_languages != '' }}
         then
           echo "Manually set languages: ${{ github.event.inputs.extra_languages }}"
@@ -121,39 +123,12 @@ runs:
       shell: bash
     
     # Upload artifacts that subscribers can download on the Actions summary page
-    - name: "ALKiln: Upload errors to action summary artifacts"
-      if: ${{ failure() }}
-      uses: actions/upload-artifact@v2
-      with:
-        name: errors
-        path: ./**/error*.jpg
-    - name: "ALKiln: Upload screenshots to action summary artifacts"
-      if: ${{ always() }}
-      uses: actions/upload-artifact@v2
-      #if-no-files-found: ignore
-      with:
-        name: screenshots
-        path: ./**/screenshot*.jpg
-    - name: "ALKiln: Upload downloaded files to action summary artifacts"
-      if: ${{ always() }}
-      uses: actions/upload-artifact@v2
-      #if-no-files-found: ignore
-      with:
-        name: downloads
-        path: ./**/downloads_*
-    - name: "ALKiln: Upload report to action summary artifacts"
-      if: ${{ always() }}
-      uses: actions/upload-artifact@v2
-      with:
-        name: report
-        path: ./**/*_report_*
-    - name: "ALKiln: Upload Accessibility failures, if any, to action summary artifacts"
+    - name: "ALKiln: Upload artifacts folder"
       if: ${{ always() }}
       uses: actions/upload-artifact@v2
-      # They will upload even if a previous step has failed
       with:
-        name: a11y report
-        path: ./**/aXe_failure*
+        name: ${{ env.ARTIFACT_NAME }}
+        path: ./alkiln_tests_output-*
 
 # ##################################
 # # A developer's workflow should look similar to the below
@@ -184,8 +159,4 @@ runs:
 #         with:
 #           SERVER_URL: "${{ secrets.SERVER_URL }}"
 #           DOCASSEMBLE_DEVELOPER_API_KEY: "${{ secrets.DOCASSEMBLE_DEVELOPER_API_KEY }}"
-#           PLAYGROUND_EMAIL: "${{ secrets.PLAYGROUND_EMAIL }}"
-#           PLAYGROUND_PASSWORD: "${{ secrets.PLAYGROUND_PASSWORD }}"
-#           PLAYGROUND_ID: "${{ secrets.PLAYGROUND_ID }}"
-#           EXTRA_LANGUAGES: "${{ secrets.EXTRA_LANGUAGES }}"
 #       - run: echo "Finished running ALKiln tests"

package/lib/docassemble/setup.js

@@ -3,6 +3,7 @@
 const da_i = require('./docassemble_api_interface');
 const log = require('../utils/log');
 const session_vars = require('../utils/session_vars' );
+const files = require('../utils/files' );
 
 
 const setup = async () => {
@@ -30,6 +31,11 @@ const setup = async () => {
     await da_i.wait_for_server_to_restart( task_id );
   }
 
+  // Make the folder to store all the files for this run of the tests
+  const artifacts_path_name = files.make_artifacts_folder();
+  // Save its name in a file. `session_vars` can get it back later.
+  session_vars.save_artifacts_path_name( artifacts_path_name );
+
   // Finish
   log.info({ type: `setup`, pre: `Success! Test setup has finished successfully.` });
 };  // Ends setup();