@suffolklitlab/alkiln 4.10.0 → 4.10.1

package/alkiln-2022-12-29 at 02h09m19s552ms UTC/tap element with an error-2022-12-29 at 02h12m18s853ms UTC/report.txt

@@ -0,0 +1,10 @@
+
+---------------
+Scenario: tap element with an error
+Tags: @interactive @i4 @tap-elements @tabs @error
+---------------
+Trying to load the interview
+
+ERROR: Couldn't find the tab with id "#Tests-not_there-tab" on the page, is there a typo?
+
+**-- Scenario Failed --**

package/alkiln-2022-12-29 at 02h09m19s552ms UTC/tap elements-2022-12-29 at 02h12m16s677ms UTC/report.txt

@@ -0,0 +1,6 @@
+
+---------------
+Scenario: tap elements
+Tags: @interactive @i3 @tap-elements @tabs
+---------------
+Trying to load the interview

package/docassemble/__init__.py

@@ -0,0 +1,5 @@
+try:
+    __import__('pkg_resources').declare_namespace(__name__)
+except ImportError:
+    __path__ = __import__('pkgutil').extend_path(__path__, __name__)
+

package/lib/scope.js

@@ -81,7 +81,7 @@ let toBase64 = function ( utf8_str, exclude_padding=true) {
 
 let proxies_regex = /(\bx\.)|(\bx\[)|(\[[ijklmn]\])/g;
 let da_base64_regex = /^[A-Za-z0-9+/]+$/;
-let misc_artifacts_dir = `_alkiln_test-misc_artifacts`;
+let misc_artifacts_dir = `_alkiln-misc_artifacts`;
 
 module.exports = {
   trigger_not_needed_flag: `ALKiln: no trigger variable needed`,
@@ -1805,35 +1805,53 @@ module.exports = {
     /* Try to upload one or more files to a file-type input field.
     *    Does not submit, so no danger of timeout with server reload.
     */
-    
-    // Tests could be in one of two places. Figure out which directory they're in
-    // Makes an absolute path from the directory in which `npm run` was used plus our internal folders
-    let dir_source = `${ process.cwd() }/docassemble/${ session_vars.get_repo_url().match(/docassemble-(.*)/)[1] }/data/sources`;
-    let dir_features = `${ process.cwd() }/tests/features`;
-    let dir = null;
-
-    // Make sure one of the valid directories exist. This only allows
-    // one directory to be used per Step or table row. We don't anticipate
-    // future people having a `tests/features` folder, let alone both.
+
+    // Tests should be one place: docassemble/*/data/sources, where * is the only folder in `docassemble`.
+    // Makes an absolute path from the folder in which `npm run` was used plus our internal folders
+    let docassemble_pkg_path = `${ process.cwd() }/docassemble`;
+    let subpackage_name = session_vars.get_package_name().substring(12);
+    let pkg_paths = [];
     try {
-      // Try the most common directory first
-      fs.accessSync( dir_source );
-      dir = dir_source;
-      // If they have both directories, let them know which directory will be used.
-      try {
-        fs.accessSync( dir_features );
-        await scope.addToReport( scope, { type: `warning`, value: `You have both a docassemble package 'sources' folder and a 'test/features' folder. These tests will use the package's 'sources' folder.` });
-      } catch ( error_features ) { `all's well, do nothing`; }
+      fs.accessSync(docassemble_pkg_path);
+      // https://stackoverflow.com/a/24594123/11416267
+      let dirs = fs.readdirSync(docassemble_pkg_path, {withFileTypes: true}).filter(dirent => dirent.isDirectory()).map(dirent => dirent.name);
+      if (dirs.length < 1) {
+        let msg = `You can store files to upload in 'docassemble/${ subpackage_name }/data/source'. These tests could not find a folder like that starting at ${ process.cwd() }.`;
+        await scope.addToReport( scope, { type: `warning`, value: msg});
+        throw Error(msg);  // Most people will want to know the sources folder path;
+      }
+      for (let dir of dirs) {
+        pkg_paths.push(`${docassemble_pkg_path}/${dir}`);
+      }
+    } catch ( error_da ) {
+      let msg = `You can store files to upload in 'docassemble/${ subpackage_name }/data/source'. ` +
+          `These tests could not find a folder like that. The current directory is ` +
+          ` ${ process.cwd() }; is that in the top level folder of your docassemble package? (${ session_vars.get_package_name() })?`;
+      await scope.addToReport( scope, { type: `warning`, value: msg});
+      throw error_da;  // Most people will want to know the sources folder path;
+    }
 
-    } catch ( error_source ) {
+    let chosen_dir = null;
+    let err_paths = [];
+    for (let pkg_path of pkg_paths) {
+      let dir = `${ pkg_path }/data/sources`;
       try {
-        fs.accessSync( dir_features );
-        dir = dir_features;
-      } catch ( error_features ) {
-        await scope.addToReport( scope, { type: `warning`, value: `There are two places where you can store files to upload: "${ dir_source }" and "${ dir_features }". These tests could not find either of those.` });
-        throw error_source;  // Most people will want to know the sources folder path;
+        fs.accessSync(dir);
+        chosen_dir = dir;
+        break;
+      } catch ( error_full ) {
+        err_paths.push(`'${dir}'`);
       }
     }
+    if (chosen_dir === null) {
+      let msg = `You can store files to upload in ${err_paths.join(", or ")}. These tests could not find any of those folders.`;
+      await scope.addToReport( scope, { type: `warning`, value: msg });
+      throw Error(msg);  // Most people will want to know the sources folder path;
+    }
+
+    if (pkg_paths.length > 1 && pkg_paths.length - err_paths.length > 1) {
+      await scope.addToReport( scope, { type: `warning`, value: `You have multiple folders in the 'docassemble' folder (${ pkg_paths }). These tests will use the first folder with a "data/sources" subfolder (${chosen_dir}).` });
+    }
 
     // Allow a typo where someone forgot to include a space after a comma
     let file_names = answer.split(`,`);
@@ -1845,15 +1863,14 @@ module.exports = {
       // If the developer correctly used a ", ", there will be a space at the
       // start of the string. Remove it. If they forgot the space, that's fine too.
       name = name.replace(/^\s/, '');
-      let file_path = path.join( dir, name );
+      let file_path = path.join( chosen_dir, name );
 
       try {
         fs.accessSync( file_path );
         paths.push( file_path );
-
       } catch ( err ) {
         // TODO: Should this throw an error?
-        await scope.addToReport( scope, { type: `warning`, value: `Could not find "${ name }" in "${ dir }"` });
+        await scope.addToReport( scope, { type: `warning`, value: `Could not find "${ name }" in "${ chosen_dir }"` });
       }
     }
 

package/lib/utils/files.js

@@ -31,7 +31,7 @@ files.make_artifacts_folder = function (folder_name) {
   if (folder_name) {
     folder_name = safe_filename( folder_name );
   } else {
-    folder_name = `alkiln_tests_output-${ files.readable_date() }`
+    folder_name = `alkiln-${ files.readable_date() }`
   }
 
   fs.mkdirSync( folder_name );

package/lib/utils/session_vars.js

@@ -67,13 +67,15 @@ session_vars.get_branch_name = function () {
   return branch_name;
 };
 
-session_vars.get_project_base_name = function () {
+session_vars.get_package_name = function () {
   /* Make an un-incremented project name based on the repo name and branch name. */
   let repo_url_without_trailing_slash = session_vars.get_repo_url().replace(/\/$/, '');
   let repo_name_parts = repo_url_without_trailing_slash.split('/');
-  let package_name = repo_name_parts[ repo_name_parts.length - 1 ];
+  return repo_name_parts[ repo_name_parts.length - 1 ];
+};
 
-  let name = `testing${ package_name }${ session_vars.get_branch_name() }`;
+session_vars.get_project_base_name = function () {
+  let name = `testing${ 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,15 +1,15 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "4.10.0",
+  "version": "4.10.1",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
     "test": "npm run unit && npm run langs_setup && npm run cucumber -- $@",
     "cucumber_base": "run_cucumber(){ ./node_modules/.bin/cucumber-js \"$@\"; status=$?; ./lib/utils/clean_reports.js; return $status; }; run_cucumber",
-    "cucumber": "run_base(){ npm run cucumber_base -- \"$@\" tests/features/*.feature --retry 1; }; run_base",
+    "cucumber": "run_base(){ npm run cucumber_base -- \"$@\" docassemble/*/data/sources/*.feature --retry 1; }; run_base",
     "cucumber_external": "run_cucumber(){ tmp_path=`pwd`; ( new_path=\"$1\"; shift; cd \"$new_path\"; npm run --prefix \"${tmp_path}\" cucumber_base -- \"$@\" \"$new_path\"/docassemble/*/data/sources/*.feature;) }; run_cucumber",
-    "langs": "npm run langs_setup && ./node_modules/.bin/cucumber-js --require ./lib/index.js tests/features/*_lang*.feature",
-    "langs_setup": "./lib/utils/langs.js 'tests/features/*.feature'",
+    "langs": "npm run langs_setup && ./node_modules/.bin/cucumber-js --require ./lib/index.js docassemble/*/data/sources/*_lang*.feature",
+    "langs_setup": "./lib/utils/langs.js 'docassemble/*/data/sources/*.feature'",
     "langs_local": "npm run langs_setup && npm run local",
     "local": "npm run setup && npm run cucumber; npm run takedown",
     "setup": "./lib/docassemble/setup.js",

package/setup.py

@@ -0,0 +1,60 @@
+import os
+import sys
+from setuptools import setup, find_packages
+from fnmatch import fnmatchcase
+from distutils.util import convert_path
+
+standard_exclude = ('*.pyc', '*~', '.*', '*.bak', '*.swp*')
+standard_exclude_directories = ('.*', 'CVS', '_darcs', './build', './dist', 'EGG-INFO', '*.egg-info')
+def find_package_data(where='.', package='', exclude=standard_exclude, exclude_directories=standard_exclude_directories):
+    out = {}
+    stack = [(convert_path(where), '', package)]
+    while stack:
+        where, prefix, package = stack.pop(0)
+        for name in os.listdir(where):
+            fn = os.path.join(where, name)
+            if os.path.isdir(fn):
+                bad_name = False
+                for pattern in exclude_directories:
+                    if (fnmatchcase(name, pattern)
+                        or fn.lower() == pattern.lower()):
+                        bad_name = True
+                        break
+                if bad_name:
+                    continue
+                if os.path.isfile(os.path.join(fn, '__init__.py')):
+                    if not package:
+                        new_package = name
+                    else:
+                        new_package = package + '.' + name
+                        stack.append((fn, '', new_package))
+                else:
+                    stack.append((fn, prefix + name + '/', package))
+            else:
+                bad_name = False
+                for pattern in exclude:
+                    if (fnmatchcase(name, pattern)
+                        or fn.lower() == pattern.lower()):
+                        bad_name = True
+                        break
+                if bad_name:
+                    continue
+                out.setdefault(package, []).append(prefix+name)
+    return out
+
+setup(name='docassemble.ALKilnTests',
+      version='1.0.0',
+      description=('A docassemble extension for testing the ALKiln integrated testing framework.'),
+      long_description='# ALKiln support package\r\n\r\nAssembly Line Kiln (ALKiln) is a framework for automatically testing **any** [docassemble](https://docassemble.org/) package using GitHub. ALKiln is being developed as part of the SuffolkLITLab Document Assembly Line project. See [documentation for kiln](https://suffolklitlab.github.io/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing).\r\n\r\nThis package supports ALKiln in different ways.\r\n\r\n## Tool to set up testing\r\n\r\n[Tap here to set up automated integrated testing for your docassemble interview](https://apps-dev.suffolklitlab.org/start/test-setup/).\r\n\r\nThis repo contains a step-by-step form that a developer can use to set up automated integrated testing for **any** docassemble package. It requires, among other things, a docassemble account and a temporary GitHub personal access token with correct permissions. It will add necessary GitHub secrets, make a new branch, push necessary files to that branch, and make a PR with that branch.\r\n\r\n',
+      long_description_content_type='text/markdown',
+      author='plocket',
+      author_email='example@example.com',
+      license='The MIT License (MIT)',
+      url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing',
+      packages=find_packages(),
+      namespace_packages=['docassemble'],
+      install_requires=['docassemble.ALToolbox>=0.5.1'],
+      zip_safe=False,
+      package_data=find_package_data(where='docassemble/ALKilnTests/', package='docassemble.ALKilnTests'),
+     )
+

package/tests/features/assembly_line.feature

@@ -1,43 +0,0 @@
-@assembly_line
-Feature: Assembly Line package-specific Steps
-
-# In tag names, 'al' is for 'assembly line'
-
-# Note: the first test for this suite is the first test in this file and we're having timeout issues, so we're trying to give the server longer to load.
-
-@fast @al1
-Scenario: I have two name parts
-  Given the max secs for each step is 120
-  Given I start the interview at "AL_tests"
-  And I set the name of "users[0]" to "Uli User"
-  And I tap to continue
-  And I set the address of "users[0]" to "120 Tremont Street, Unit 2, Boston, MA 02108"
-  And I tap to continue
-  And I set the name of "users[1]" to "Uli2 User2"
-  And I set the var "users[i].proxy_var" to "Mixed proxy var step test"
-  And I tap to continue
-  Then the question id should be "end"
-
-@fast @al2
-Scenario: I have three name parts
-  Given I start the interview at "AL_tests"
-  And I set the name of "users[0]" to "Uli Udo User"
-  And I tap to continue
-  And I set the address of "users[0]" to "120 Tremont Street, Unit 2, Boston, MA 02108"
-  And I tap to continue
-  And I set the name of "users[1]" to "Uli2 User2"
-  And I set the var "users[i].proxy_var" to "Mixed proxy var step test"
-  And I tap to continue
-  Then the question id should be "end"
-
-@fast @al3
-Scenario: I have four name parts
-  Given I start the interview at "AL_tests"
-  And I set the name of "users[0]" to "Uli Udo User Sr"
-  And I tap to continue
-  And I set the address of "users[0]" to "120 Tremont Street, Unit 2, Boston, MA 02108"
-  And I tap to continue
-  And I set the name of "users[1]" to "Uli2 User2"
-  And I set the var "users[i].proxy_var" to "Mixed proxy var step test"
-  And I tap to continue
-  Then the question id should be "end"

package/tests/features/establishing_steps.feature

@@ -1,62 +0,0 @@
-@establishing
-Feature: Establishing steps
-
-Steps that establish things about the state of the test
-# In tag names, 'e' is for 'establishing'
-
-@slow @e1 @wait
-Scenario: I am able to set a custom wait time that allows steps to run longer than the half minute default
-  Given I start the interview at "all_tests"
-  And the max seconds for each step in this scenario is 40
-  And I wait 35 seconds
-
-@slow @e2 @wait
-Scenario: I am able to set a custom wait time before an interview has been loaded
-  Given the max seconds for each step in this scenario is 40
-  And I start the interview at "all_tests"
-  And I wait 35 seconds
-
-@fast @e3 @urlargs
-Scenario: Interview name includes url args
-  Given I start the interview at "url_args.yml&from=theinternets&random=zoo"
-  Then I should see the phrase "zoo"
-
-@slow @e4 @wait_first
-Scenario: I can wait as a first step in a test
-  Given I wait 1 second
-  
-@slow @e5 @wait_first
-Scenario: Interview name includes url args with a wait
-  Given I wait 1 second
-  Then I start the interview at "url_args.yml&from=theinternets&random=zoo"
-  Then I should see the phrase "zoo"
-
-@fast @e6 @signin
-Scenario: I sign in
-  Given I sign in with the email "USER1_EMAIL" and the password "USER1_PASSWORD"
-  And I start the interview at "all_tests"
-
-@fast @e7 @arbitraryurl
-Scenario: I want to go to a full arbitrary url
-  Given the max seconds for each step in this scenario is 5
-  And the Scenario report should include:
-  """
-  Trying to load the interview
-  """
-  Given I start the interview at "https://apps-test.suffolklitlab.org/start/demo/questions"
-  Then I should see the phrase "What language do you speak?"
-
-# WARNING: This Scenario may fail if the file moves or changes too much
-@fast @failing @e8 @rfe8 @arbitraryurl
-Scenario: Fail with no interview at arbitrary url
-  Given the final Scenario status should be "failed"
-  And the Scenario report should include:
-  """
-  Trying to load the interview
-  """
-  And the Scenario report should include:
-  """
-  ALKiln could not find any interview question page
-  """
-  And the max seconds for each step in this scenario is 5
-  Then I start the interview at "https://apps-test.suffolklitlab.org/list"

package/tests/features/example_test.feature

@@ -1,11 +0,0 @@
-@example_feature_tag
-Feature: An example test
-
-The tests in this file should cover
-- [x] Provide a template people can use to make their own tests.
-- [ ] Direct people to more documentation.
-- [ ] Find the ultimate question to life, the universe, and everything.
-
-@example_scenario_tag
-Scenario: Server finishes reloading
-  Given I start the interview at "test"

package/tests/features/interactive_steps.feature

@@ -1,166 +0,0 @@
-@interactive
-Feature: Interactive steps
-
-# In tag names, 'i' is for 'interactive'
-
-@slow @i1
-Scenario: I set various values
-  Given I start the interview at "all_tests"
-  Then the question id should be "upload files"
-  When I set the var "upload_files_visible" to "some_png_1.png, some_png_2.png"
-  And I set the var "show_upload" to "True"
-  And I upload "some_png_2.png,some_png_1.png" to "upload_files_hidden"
-  And I tap to continue
-  # Next page
-  Then the question id should be "group of complex fields"
-  And I set the var "double_quote_dict['double_quote_key']['dq_two']" to "true"
-  And I set the var "single_quote_dict['single_quote_key']['sq_two']" to "true"
-  And I tap to continue
-  Then the question id should be "direct standard fields"
-  # Next page
-  When I set the var "checkboxes_yesno" to "True"
-  And I set the var "checkboxes_other['checkbox_other_opt_1']" to "true"
-  And I set the var "dropdown_test" to "dropdown_opt_2"
-  And I set the var "radio_yesno" to "False"
-  And I set the var "radio_other" to "radio_other_opt_3"
-  And I set the var "text_input" to "Regular text input field value"
-  And I set the var "textarea" to "Multiline text\narea value"
-  And I set the var "date_input" to "today - 1"
-  When I set the var "direct_standard_fields" to "True"
-  # Next page
-  Then the question id should be "showifs"
-  When I set the var "show_2" to "True"
-  And I set the var "show_3" to "True"
-  And I set the var "showif_checkbox_yesno" to "true"
-  And I set the var "showif_checkboxes_other['showif_checkboxes_nota_2']" to "true"
-  And I set the var "showif_checkboxes_other['showif_checkboxes_nota_3']" to "true"
-  And I set the var "showif_yesnoradio" to "True"
-  And I set the var "showif_radio_other" to "showif_radio_multi_2"
-  And I set the var "showif_text_input" to "Show if text input value"
-  And I set the var "showif_textarea" to "Show if\nmultiline text\narea value"
-  And I set the var "showif_dropdown" to "showif_dropdown_1"
-  When I tap to continue
-  # Next page
-  Then the question id should be "object checkboxes"
-  And I set the var "object_checkboxes_test['obj_chkbx_opt_1']" to "true" 
-  And I set the var "object_dropdown" to "obj_opt_2"
-  When I tap to continue
-  # Next page
-  Then the question id should be "buttons yesnomaybe"
-  When I set the var "buttons_yesnomaybe" to "None"
-  # Next page
-  Then the question id should be "buttons other"
-  When I set the var "buttons_other" to "button_3"
-  # Next page
-  Then the question id should be "button continue"
-  When I set the var "button_continue" to "True"
-  # Next page
-  Then the question id should be "screen features"
-  When I tap to continue
-  # Next page
-  Then the question id should be "proxy vars"
-  When I set the var "x[i].name.first" to "Proxyname1"
-  And I tap to continue
-  # Next page
-  Then the question id should be "is there another generic"
-  When I set the var "x.there_is_another" to "True"
-  # Next page
-  Then the question id should be "proxy vars"
-  When I set the var "x[i].name.first" to "Proxyname2"
-  And I tap to continue
-  # Next page
-  Then the question id should be "is there another generic"
-  When I set the var "x.there_is_another" to "False"
-  # Next page
-  Then the question id should be "first signature"
-  When I sign
-  And I tap to continue
-  # Next page
-  Then the question id should be "second signature"
-  When I sign
-  And I tap to continue
-  # Next page
-  Then the question id should be "simple doc"
-  When I download "simple-doc.pdf"
-  And I tap to continue
-  # Next page
-  Then the question id should be "button event action"
-  And I tap to continue
-  # Next page
-  Then the question id should be "single-dropdown-field"
-  And I set the var "single_dropdown_field" to "email"
-  And I tap to continue
-  # Next page
-  Then the question id should be "the end"
-
-@fast @i2 @secret
-Scenario: handles settings from Github secrets
-  Given the final Scenario status should be "failed"
-  And the Scenario report should include:
-  """
-  The GitHub SECRET "SECRET_NOT_THERE" doesn't exist
-  """
-  Given I start the interview at "test_secret_vars"
-  When I set the var "first_text_entry" to the secret "SECRET_VAR1"
-  And I tap to continue
-  Then I see the phrase "secret-var1-value"
-  When I tap to continue
-  And I set the var "second_text_entry" to the github secret "SECRET_VAR2"
-  And I tap to continue
-  Then I see the phrase "secret-var2-value"
-  When I tap to continue
-  And I set the variable "third_text_entry" to secret "SECRET_NOT_THERE"
-
-@i3 @tap-elements @tabs
-Scenario: tap elements
-  Given I start the interview at "test_taps"
-  And I tap the "Tests-first_template-tab" tab
-  Then I see the phrase "Mechanics"
-  And I tap the "Tests-second_template-tab" tab
-  Then I see the phrase "villify"
-  And I tap the "Tests-third_template-tab" tab
-  Then I see the phrase "museum"
-  And I tap the "#special_event" element and wait 1 second
-  Then I see the phrase "Portishead"
-
-@i4 @tap-elements @tabs @error
-Scenario: tap element with an error
-  Given the final Scenario status should be "failed"
-  And the Scenario report should include:
-  """
-  is there a typo?
-  """
-  Given I start the interview at "test_taps"
-  And I tap the "Tests-not_there-tab" tab
-
-@i5 @decoding-test @object-multiselect
-Scenario: Base64 encoded corner cases are decoded correctly
-  Given I start the interview at "test_decoding"
-  And I get to "end screen" with this data:
-    | var | value | trigger |
-    | object_multiselect_test['obj_opt_1'] | True | |
-    | object_multiselect_test['obj_opt_3'] | True | |
-    | multiselect_test['hi'] | True | |
-    | multiselect_test['dear'] | True | |
-    | object_radio_field | object_radio_choice_one | |
-    | object_checkboxes_test['obj_chkbx_opt_1'] | True | |
-    | object_dropdown | obj_opt_2 | |
-    | checkbox_dict['single_quote_key']['🁳🧴🯍🥫🅍🗎🹇🗷🌲🯵'] | True | |
-
-# This test should fail because it's target id is never found, but that also means
-# it has succeeded because it didn't try to keep looking for the id by pressing 'restart'
-# to continue.
-@fast @i6
-Scenario: Fails as it doesn't try to 'continue' with a restart button
-  Given the final Scenario status should be "failed"
-  And the Scenario report should include:
-  """
-  The test got stuck on "kickout-screen"
-  """
-  Given the max seconds for each step in this scenario is 10
-  Given I start the interview at "test_kickout"
-  And I get to "doesnt exist" with this data:
-    | var | value | trigger |
-    | user_choice | wrong | |
-  
-