@suffolklitlab/alkiln 4.0.0-pre-api.8 → 4.0.0-pre-api.9

package/lib/utils/session_vars.js

@@ -16,69 +16,22 @@ require('dotenv').config();
 *    much easier to test.
 */
 
-const session_vars = {
-  PLAYGROUND_ID: process.env.PLAYGROUND_ID,  // Need to get rid of this in favor of API
-};
+const session_vars = {};
 
 module.exports = session_vars;
 
-/**
- * Ensure all required environment variables exist. Add each missing variable
- *    to an error that will be thrown at the end.
- * 
- * @throws ReferenceError with a message for all missing variables. 
- */
- session_vars.validateEnvironment = function() {
-
-  // We are checking for BASE_URL, but we are referring it as SERVER_URL as that
-  // is the name used in GitHub secrets, which is what most devs will be using.
-
-  let errorMessage = '';
-
-  // Since this code will most often be run in GitHub, I'm going to build a single error message that outlines all missing variables.  Otherwise, a developer
-  // will have to run their pipeline an incredible number of times to discover all the missing variables.
-  if (!process.env.DOCASSEMBLE_DEVELOPER_API_KEY)
-  {
-    errorMessage += `\nThe DOCASSEMBLE_DEVELOPER_API_KEY GitHub secret must be defined. The DOCASSEMBLE_DEVELOPER_API_KEY is a docassemble API key you created for your server's testing account. It should have developer permissions.`
-  }
-  if (!process.env.PLAYGROUND_ID)
-  {
-    errorMessage += '\nThe PLAYGROUND_ID GitHub secret must be defined.  The PLAYGROUND_ID is the ID of the Docassemble suite to run.'
-  }
-  if (!process.env.SERVER_URL && !process.env.BASE_URL)
-  {
-    errorMessage += `\nThe SERVER_URL GitHub secret must be defined. The SERVER_URL is the URL of the Docassemble Server where the tests should be run.`;
-  }
-  if (!process.env.REPO_URL)
-  {
-    errorMessage += `\nThe REPO_URL GitHub secret must be defined. The REPO_URL is the URL to the Git repo whose Actions are being run.`;
-  }
-  if (!process.env.BRANCH_PATH && !process.env.BRANCH_NAME)
-  {
-    errorMessage += `\nThe BRANCH_NAME environment variable must be defined. The BRANCH_NAME is the name of the repository branch that should be pulled into the docassemble project.`;
-  }
-
-  errorMessage = errorMessage.trim();
-
-  if (errorMessage !== '') {
-    throw new ReferenceError(errorMessage);
-  }
-};
-  
-session_vars.validateEnvironment();
+session_vars.get_debug = function () { return process.env.DEBUG || null; };
+session_vars.get_dev_api_key = function () { return process.env.DOCASSEMBLE_DEVELOPER_API_KEY || null; };
+session_vars.get_repo_url = function () { return process.env.REPO_URL || null; };
 
-session_vars.get_dev_api_key = function () { return process.env.DOCASSEMBLE_DEVELOPER_API_KEY; };
 session_vars.get_da_server_url = function () {
-  let url = process.env.SERVER_URL || process.env.BASE_URL;
-  return url.replace(/\/$/g, '');  // Remove any trailing slash for safety
+  try {
+    let url = process.env.SERVER_URL || process.env.BASE_URL;
+    return url.replace(/\/$/g, '');  // Remove any trailing slash for safety
+  } catch ( error ) {
+    return null;
+  }
 };
-session_vars.get_debug = function () { return process.env.DEBUG; };
-session_vars.get_repo_url = function () { return process.env.REPO_URL; };
-// missing/moving functionality:
-// getBaseInterviewURL
-// Project name setting/getting
-// Playground id functionality needs to be transfered to api requests
-
 
 session_vars.get_branch_name = function () {
   /* Get the name of the repository's branch that is being tested */
@@ -102,29 +55,6 @@ session_vars.get_project_base_name = function () {
   return sanitized_name;
 };
 
-// // Notes: We were using `new_session=1` in the url args, but it wasn't
-// // always working. The idea was to save each session so we could look
-// // back on it if needed. Aside from the fact that you usually need to log in
-// // to make the sessions retrievable (though if you're using `interview_list()`
-// // you can get them anyway), it also has inconsistent behavior when
-// // `sessions are unique`` or `temporary session` or use `interview_list()`
-// // and/or respond immediately with a `command()`. Three ways to avoid this:
-// // 1. x Start a new browser instead of just a new page each time. Lengthens the tests.
-// // 1. √ Visit `/user/sign-out` (needed even if the user is not logged in)
-// // 1. x (seems to be causing a 'Unable to locate interview session' error
-// // instead) Use `reset=2` instead , which will not save the previous session at all. It
-// // Will not just restart any existing interview sessions, it will also
-// // clear out the browser session's memory of what other interviews the user has
-// // visited in the same browser session_vars.
-// session_vars.getBaseInterviewURL = function () {
-//   /* Return the part of the interview URL that comes before the filename.
-//   * Depends on the project name, which may have been changed. */
-//   let new_session = `/interview?new_session=1&i=docassemble.playground`;
-//   return `${ session_vars.BASE_URL }${ new_session }${ session_vars.PLAYGROUND_ID }${ session_vars.getProjectName() }%3A`;
-// };
-// // session_vars.BASE_INTERVIEW_URL = session_vars.getBaseInterviewURL();
-
-
 session_vars.get_languages = function () {
   /* Returns an array of strings, names of languages that should be tested. */
 
@@ -186,3 +116,47 @@ session_vars.delete_project_name = function () {
     return false;
   }
 };
+
+/**
+ * Ensure all required environment variables exist. Add each missing variable
+ *    to an error that will be thrown at the end.
+ * 
+ * @throws ReferenceError with a message for all missing variables. 
+ */
+ session_vars.validateEnvironment = function() {
+  /** Throw a useful error for the developer if any of the required env vars
+  *    are missing. For most devs, these will be GitHub secrets. */
+
+  // Note: We are checking for BASE_URL, but we are referring it as SERVER_URL as that
+  // is the name used in GitHub secrets, which is what most devs will be using.
+
+  let errorMessage = '';
+
+  // Since this code will most often be run in GitHub, I'm going to build a single error message that outlines all missing variables.  Otherwise, a developer
+  // will have to run their pipeline an incredible number of times to discover all the missing variables.
+  if ( !session_vars.get_dev_api_key() )
+  {
+    errorMessage += `\nThe DOCASSEMBLE_DEVELOPER_API_KEY GitHub secret must be defined. The DOCASSEMBLE_DEVELOPER_API_KEY is a docassemble API key you created for your server's testing account. It should have developer permissions.`
+  }
+  if ( !session_vars.get_da_server_url() )
+  {
+    errorMessage += `\nThe SERVER_URL GitHub secret must be defined. The SERVER_URL is the URL of the Docassemble Server where the tests should be run.`;
+  }
+  if ( !session_vars.get_repo_url() )
+  {
+    errorMessage += `\nThe REPO_URL GitHub secret must be defined. The REPO_URL is the URL to the Git repo whose Actions are being run.`;
+  }
+  // The branch name is always automatically defined in Github, it'll be missing only if you're running locally and missing an env var.
+  if ( !session_vars.get_branch_name() )
+  {
+    errorMessage += `\nThe BRANCH_NAME environment variable must be defined. The BRANCH_NAME is the name of the repository branch that should be pulled into the docassemble project.`;
+  }
+
+  errorMessage = errorMessage.trim();
+
+  if (errorMessage !== '') {
+    throw new ReferenceError(errorMessage);
+  }
+};
+  
+session_vars.validateEnvironment();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "4.0.0-pre-api.8",
+  "version": "4.0.0-pre-api.9",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
@@ -17,7 +17,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/SuffolkLITLab/alkiln.git"
+    "url": "git+https://github.com/SuffolkLITLab/ALKiln.git"
   },
   "keywords": [
     "docassemble",
@@ -30,7 +30,7 @@
   "author": "",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/SuffolkLITLab/alkiln/issues"
+    "url": "https://github.com/SuffolkLITLab/ALKiln/issues"
   },
   "homepage": "https://suffolklitlab.github.io/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing",
   "dependencies": {
@@ -48,7 +48,6 @@
   "bin": {
     "alkiln-setup": "./lib/docassemble/setup.js",
     "alkiln-takedown": "./lib/docassemble/takedown.js",
-    "alkiln-cucumber": "./lib/index.js",
     "alkiln-langs": "./lib/utils/langs.js"
   }
 }

package/tests/features/establishing_steps.feature

@@ -4,13 +4,13 @@ Feature: Establishing steps
 Steps that establish things about the state of the test
 # In tag names, 'e' is for 'establishing'
 
-@slow @e1
+@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
+@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"

package/tests/features/observation_steps.feature

@@ -96,7 +96,7 @@ Scenario: Test "Then I don’t continue" with an apostrophe
   Then I don’t continue
   And I will be told an answer is invalid
 
-@fast @o9
+@fast @o9 @table
 Scenario: I can match JSON page var to str
   Given I start the interview at "all_tests.yml"
   And I get to "showifs" with this data:

package/tests/features/reports.feature

@@ -138,7 +138,7 @@ Scenario: Fail with missing link with url
   And I start the interview at "all_tests"
   Then I should see the link to "http://missing-url.com"
 
-@slow @rf13 @error
+@slow @rf13 @error @table
 Scenario: Fail with link with given text does not lead to correct url
   Given the final Scenario status should be "failed"
   Given the Scenario report should include:
@@ -166,7 +166,7 @@ Scenario: Fail with link with given text does not lead to correct url
   And I should see the link to "http://ecosia.org/"
   Then the "Link to external page" link leads to "http://wrong-url.com"
 
-@slow @rf14 @error
+@slow @rf14 @error @table
 Scenario: Fail with link unexpectedly opens in same window
   Given the final Scenario status should be "failed"
   Given the Scenario report should include:
@@ -194,7 +194,7 @@ Scenario: Fail with link unexpectedly opens in same window
   And I should see the link to "http://ecosia.org/"
   Then the "Link to external page" link opens in the same window
 
-@fast @rf15 @error
+@fast @rf15 @error @table
 Scenario: Fail with link unexpectedly opens in a new window
   Given the final Scenario status should be "failed"
   Given the Scenario report should include:
@@ -223,7 +223,7 @@ Scenario: Fail with link unexpectedly opens in a new window
   Then the "Link: reload the page" link opens in a new window
 
 ## Don't currently have a broken link to test and this Step is not officially supported
-#@fast @rf16 @error
+#@fast @rf16 @error @table
 #Scenario: Fail with link leads to a broken page
 #  Given the final Scenario status should be "failed"
 #  Given the Scenario report should include:
@@ -321,7 +321,7 @@ Scenario: Fail with system error after Step using wrong file name as trigger
 #  """
 #  And I start the interview at "wrong_yaml_filename"
 
-@fast @rf22
+@fast @rf22 @table
 Scenario: I can't match JSON page var to str
   Given the final Scenario status should be "failed"
   Given the Scenario report should include:
@@ -448,70 +448,27 @@ Scenario: Report still shows page id when I tap to continue without setting any
   # Next page (showifs ID SHOULD BE SHOWN IN REPORT)
   Then the question id should be "buttons yesnomaybe"
 
-@slow @rp2
+@slow @rp2 @table
 Scenario: Report lists unused table rows
   Given the final Scenario status should be "passed"
   Given the Scenario report should include:
     """
-
-    ---------------
-    Scenario: Report lists unused table rows
-    Tags: @reports @slow @rp2
-    ---------------
-    screen id: upload-files
-    screen id: group-of-complex-fields
-          | single_quote_dict['single_quote_key']['sq_two'] | true |  |
-          | double_quote_dict[\"double_quote_key\"]['dq_two'] | true |  |
-
-      Rows that got set:
-        And I get to the question id "direct standard fields" with this data:
-          | var | value | trigger |
-          | double_quote_dict[\"double_quote_key\"]['dq_two'] | true |  |
-          | single_quote_dict['single_quote_key']['sq_two'] | true |  |
       Unused rows:
           | extra_2 | extra 2 |  |
           | extra_out_of_alphabetical_order | extra 1 |  |
-
-    screen id: direct-standard-fields
-          | checkboxes_other['checkbox_other_opt_1'] | true |  |
-          | radio_yesno | False | false |
-          | radio_other | radio_other_opt_3 |  |
-          | text_input | Regular text input field value |  |
-          | textarea | Multiline text\narea value |  |
-          | dropdown_test | dropdown_opt_2 |  |
-
-      Rows that got set:
-        And I get to the question id "showifs" with this data:
-          | var | value | trigger |
-          | checkboxes_other['checkbox_other_opt_1'] | true |  |
-          | dropdown_test | dropdown_opt_2 |  |
-          | radio_other | radio_other_opt_3 |  |
-          | radio_yesno | False | false |
-          | text_input | Regular text input field value |  |
-          | textarea | Multiline text\narea value |  |
+    """
+  Given the Scenario report should include:
+    """
       Unused rows:
           | extra_3 | extra 3 |  |
           | extra_4 | extra 4 |  |
           | extra_5 | extra 5 |  |
-
-    screen id: showifs
-    screen id: buttons-yesnomaybe
-          | buttons_yesnomaybe | True |  |
-    screen id: buttons-other
-          | buttons_other | button_2 |  |
-    screen id: button-continue
-          | button_continue | True |  |
-
-      Rows that got set:
-        And I get to the question id "screen features" with this data:
-          | var | value | trigger |
-          | button_continue | True |  |
-          | buttons_other | button_2 |  |
-          | buttons_yesnomaybe | True |  |
+    """
+  Given the Scenario report should include:
+    """
       Unused rows:
           | extra_6 | extra 6 |  |
           | extra_7 | extra 7 |  |
-
     """
   And I start the interview at "all_tests"
   And I get to "direct standard fields" with this data:

package/tests/features/story_table_formats.feature

@@ -1,4 +1,4 @@
-@story_tables_formats
+@story_tables_formats @table
 Feature: Supported story table formats
 
 NOTE:

package/tests/features/story_tables.feature

@@ -1,4 +1,4 @@
-@story_tables
+@story_tables @table
 Feature: Story tables
 
 NOTE:

package/tests/unit_tests/getMatchingRows.test.js

@@ -7,6 +7,8 @@ const fields = require('./fields.fixtures.js');
 const matches = require('./matches.fixtures.js');
 const scope = require('../../lib/scope.js');
 const getMatchingRows = scope.getMatchingRows;
+// Match state var instantiated in steps.js. TODO: Add tests for such rows.
+scope.row_needs_trigger_flag = `ALKiln: no trigger variable needed`;
 
 // TODO: Add tests for reports
 
@@ -188,6 +190,32 @@ describe(`For mulitple rows with the same proxies`, async function() {
   }
 });
 
+// Missing table row for loop
+describe(`For a second proxy loop page,`, async function() {
+  for ( let test_i = 0; test_i < fields.proxies_multi.length; test_i++ ) {
+    let field = fields.proxies_multi[ test_i ];
+    let curr_matches = matches.proxies_missing_loop[ test_i ];
+    let name = getSafeName( field );
+    it( `does not find any matches when table row for second loop page is missing`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.proxies_missing_loop });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+// Missing trigger matches second loop
+describe(`For a second proxy loop page,`, async function() {
+  for ( let test_i = 0; test_i < fields.proxies_multi.length; test_i++ ) {
+    let field = fields.proxies_multi[ test_i ];
+    let curr_matches = matches.proxies_missing_trigger[ test_i ];
+    let name = getSafeName( field );
+    it( `matches with a missing trigger row with the correct variable name`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.proxies_missing_trigger });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
 
 // ============================
 // Signature

package/tests/unit_tests/matches.fixtures.js

@@ -15,7 +15,7 @@ matches.standard = [
   [],
   [ { var: 'radio_other', value: 'radio_other_opt_2' } ],
   [],
-  [ { var: 'text_input', value: 'Some one-line text' }, { var: 'text_input', value: 'Some conflicting text' } ],
+  [ { var: 'text_input', value: 'Some one-line text', "original": { var: 'text_input', value: 'Some one-line text' } }, { var: 'text_input', value: 'Some conflicting text', "original": { var: 'text_input', value: 'Some conflicting text' } } ],
   [ { var: 'textarea', value: 'Some\nmulti-line\ntext' } ],
   [ { 'var': 'date_input','value':'today-1' } ],
   [ { var: 'dropdown_test', value: 'dropdown_opt_2' } ],
@@ -111,6 +111,18 @@ matches.proxies_multi = [
   []
 ];
 
+// Missing table row for second loop
+matches.proxies_missing_loop = [
+  [],
+  []
+];
+
+// Missing trigger matches second loop
+matches.proxies_missing_trigger = [
+  [{ "trigger": "", "var": "x[i].name.first", "value": "Firstname", "original": { "trigger": "", "var": "x[i].name.first", "value": "Firstname" }}],
+  []
+];
+
 
 // ============================
 // Signature

package/tests/unit_tests/session_vars.test.js

@@ -0,0 +1,46 @@
+const chai = require('chai');
+const expect = chai.expect;
+
+const session_vars = require("../../lib/utils/session_vars.js");
+const validateEnvironment = session_vars.validateEnvironment;
+
+describe('When the `session_vars` object uses', function () {
+    describe('validateEnvironment, it', function() {
+
+        /**
+         * All required variables should be defined in .env. For reference, those variables are the following:
+         * 
+         * DOCASSEMBLE_DEVELOPER_API_KEY
+         * BASE_URL
+         * REPO_URL
+         */ 
+        it("successfully completes when all required env vars exist", function() {
+            session_vars.validateEnvironment();
+        });
+
+        /**
+         * This test has an ordering dependency with the test below.  I'm not certain if I am getting lucky or if I need to explicitly declare the order.
+         */
+        it("throws a reference error when any var is missing", function() {
+            delete process.env.DOCASSEMBLE_DEVELOPER_API_KEY;
+
+            expect(session_vars.validateEnvironment).to.throw(ReferenceError, /DOCASSEMBLE_DEVELOPER_API_KEY/);            
+        });
+
+        /**
+         * Delete all environment variables before validating the variables.
+         */
+        it("names all missing variables in the error, not just one", function() {
+            delete process.env.DOCASSEMBLE_DEVELOPER_API_KEY;
+            delete process.env.BASE_URL;
+            delete process.env.SERVER_URL;
+            delete process.env.REPO_URL;
+
+            // This test just tests that the variable names show up in a fixed order.
+            expect(session_vars.validateEnvironment).to.throw(
+                ReferenceError,
+                /DOCASSEMBLE_DEVELOPER_API_KEY.*\n.*SERVER_URL.*\n.*REPO_URL/
+            );
+        });
+    });
+});

package/tests/unit_tests/tables.fixtures.js

@@ -21,8 +21,8 @@ tables.standard = [
   { "var": "date_input","value":"today-1" },
   { "var": "radio_yesno", "value": "False" },
   { "var": "radio_other", "value": "radio_other_opt_2" },
-  { "var": "text_input", "value": "Some one-line text" },
-  { "var": "text_input","value":"Some conflicting text" },
+  { "var": "text_input", "value": "Some one-line text", "original": { "var": "text_input", "value": "Some one-line text" } },
+  { "var": "text_input","value":"Some conflicting text", "original": { "var": "text_input","value":"Some conflicting text" } },
   { "var": "textarea", "value": "Some\nmulti-line\ntext" },
   { "var": "dropdown_test", "value": "dropdown_opt_2" },  // May want to change `checked`
 ];
@@ -373,6 +373,16 @@ tables.proxies_multi = [
   { "trigger": "proxy_list[2].name.first", "var": "x[i].name.first", "value": "Firstname", },
 ];
 
+// Missing table row for second loop
+tables.proxies_missing_loop = [
+  { "trigger": "proxy_list[0].name.first", "var": "x[i].name.first", "value": "Firstname", "original": { "trigger": "proxy_list[0].name.first", "var": "x[i].name.first", "value": "Firstname" } },
+];
+
+// Missing trigger matches second loop
+tables.proxies_missing_trigger = [
+  { "trigger": "", "var": "x[i].name.first", "value": "Firstname", "original": { "trigger": "", "var": "x[i].name.first", "value": "Firstname" }},
+];
+
 
 // ============================
 // Signature