@suffolklitlab/alkiln 4.11.5 → 5.0.0-experimental1

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "4.11.5",
+  "version": "5.0.0-experimental1",
   "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 -- \"$@\" 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 docassemble/*/data/sources/*_lang*.feature",
+    "test": "npm run unit && npm run langs_setup && npm run cucumber",
+    "cucumber": "./lib/run_cucumber.js",
+    "langs": "npm run langs_setup && npm run cucumber",
     "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",
@@ -36,13 +34,13 @@
   "homepage": "https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/",
   "dependencies": {
     "@axe-core/puppeteer": "4.4.2",
-    "@cucumber/cucumber": "7.3.2",
+    "@cucumber/cucumber": "8.6.0",
     "@faker-js/faker": "^7.3.0",
     "axios": "0.24.0",
     "chai": "4.2.0",
     "cheerio": "1.0.0-rc.10",
-    "dotenv": "8.2.0",
     "deep-equal-in-any-order": "^2.0.0",
+    "dotenv": "8.2.0",
     "mocha": "9.2.0",
     "puppeteer": "13.1.3",
     "qs": "6.10.2",
@@ -52,6 +50,7 @@
   "bin": {
     "alkiln-setup": "./lib/docassemble/setup.js",
     "alkiln-takedown": "./lib/docassemble/takedown.js",
-    "alkiln-langs": "./lib/utils/langs.js"
+    "alkiln-langs": "./lib/utils/langs.js",
+    "alkiln-run": "./lib/run_cucumber.js"
   }
 }

package/tests/unit_tests/session_vars.test.js

@@ -4,42 +4,135 @@ const expect = chai.expect;
 const session_vars = require("../../lib/utils/session_vars.js");
 const validateEnvironment = session_vars.validateEnvironment;
 
+// Not going to totally support these any more.
+delete process.env.BRANCH_PATH;
+delete process.env.BASE_URL;
+
 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() {
+         * All required variables should be defined in .env. Different
+         * env vars for different test runner locations/origins.
+         */
+        it("successfully completes when all required local env vars exist", function() {
+            process.env._ORIGIN = `local`;
+            process.env.SERVER_URL = `https://example.com`;
+            process.env.DOCASSEMBLE_DEVELOPER_API_KEY = `1`;
+            process.env.REPO_URL = `https://github.com/org/docassemble-repo`;
+            process.env.BRANCH_NAME = `a_branch`;
+
+            delete process.env._PROJECT_NAME;
+            delete process.env._USER_ID;
+
             session_vars.validateEnvironment();
         });
+        it("successfully completes when all required GitHub env vars exist", function() {
+            process.env._ORIGIN = `github`;
+            process.env.SERVER_URL = `https://example.com`;
+            process.env.DOCASSEMBLE_DEVELOPER_API_KEY = `1`;
+            process.env.REPO_URL = `https://github.com/org/docassemble-repo`;
+            process.env.BRANCH_NAME = `a_branch`;
+
+            delete process.env._PROJECT_NAME;
+            delete process.env._USER_ID;
+
+            session_vars.validateEnvironment();
+        });
+        it("successfully completes when all required Playground env vars exist", function() {
+            process.env._ORIGIN = `playground`;
+            process.env.SERVER_URL = `https://example.com`;
+            process.env._PROJECT_NAME = `TheProject`;
+            process.env._USER_ID = `1`;
 
-        /**
-         * 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;
+            delete process.env.REPO_URL;
+            delete process.env.BRANCH_NAME;
 
-            expect(session_vars.validateEnvironment).to.throw(ReferenceError, /DOCASSEMBLE_DEVELOPER_API_KEY/);            
+            session_vars.validateEnvironment();
         });
 
         /**
-         * Delete all environment variables before validating the variables.
+         * Throwing errors
          */
-        it("names all missing variables in the error, not just one", function() {
-            delete process.env.DOCASSEMBLE_DEVELOPER_API_KEY;
-            delete process.env.BASE_URL;
+        it("names all missing always-required variables in the error", function() {
+            process.env._ORIGIN = 'playground';
+            // Ensure it doesn't fail because of Playground required vars
+            process.env._PROJECT_NAME = `TheProject`;
+            process.env._USER_ID = `1`;
+
             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/
+                /SERVER_URL/
+            );
+        });
+
+        it("identifies when _ORIGIN has an invalid value", function() {
+            process.env._ORIGIN = 'invalid';
+            delete process.env.SERVER_URL;
+
+            // This test just tests that the variable names show up in a fixed order.
+            expect(session_vars.validateEnvironment).to.throw(
+                ReferenceError,
+                /_ORIGIN/
+            );
+        });
+
+        it("names all missing local variables in the error, not just one", function() {
+            // Ensure it doesn't fail because of always-required vars
+            process.env.SERVER_URL = `https://example.com`;
+            // Ensure it doesn't fail because of Playground required vars
+            process.env._PROJECT_NAME = `TheProject`;
+            process.env._USER_ID = `1`;
+
+            process.env._ORIGIN = `local`;
+            delete process.env.DOCASSEMBLE_DEVELOPER_API_KEY;
+            delete process.env.REPO_URL;
+            delete process.env.BRANCH_NAME;
+
+            // Matches message contents in any order
+            expect(session_vars.validateEnvironment).to.throw(
+                ReferenceError,
+                /(?=[\S\s]*REPO_URL)(?=[\S\s]*BRANCH_NAME)(?=[\S\s]*DOCASSEMBLE_DEVELOPER_API_KEY)/
+            );
+        });
+
+        it("names all missing GitHub variables in the error, not just one", function() {
+            // Ensure it doesn't fail because of always-required vars
+            process.env.SERVER_URL = `https://example.com`;
+            // Ensure it doesn't fail because of Playground required vars
+            process.env._PROJECT_NAME = `TheProject`;
+            process.env._USER_ID = `1`;
+
+            process.env._ORIGIN = `github`;
+            delete process.env.DOCASSEMBLE_DEVELOPER_API_KEY;
+            delete process.env.REPO_URL;
+            delete process.env.BRANCH_NAME;
+
+            expect(session_vars.validateEnvironment).to.throw(
+                ReferenceError,
+                /(?=[\S\s]*REPO_URL)(?=[\S\s]*BRANCH_NAME)(?=[\S\s]*DOCASSEMBLE_DEVELOPER_API_KEY)/
+            );
+        });
+
+        it("names all missing Playground variables in the error, not just one", function() {
+            // Ensure it doesn't fail because of always-required vars
+            process.env.SERVER_URL = `https://example.com`;
+            // Ensure it doesn't fail because of GitHub required vars
+            process.env.DOCASSEMBLE_DEVELOPER_API_KEY = `1`;
+            process.env.REPO_URL = `https://github.com/org/docassemble-repo`;
+            process.env.BRANCH_NAME = `a_branch`;
+
+            process.env._ORIGIN = `playground`;
+            delete process.env._PROJECT_NAME;
+            delete process.env._USER_ID;
+
+            expect(session_vars.validateEnvironment).to.throw(
+                ReferenceError,
+                /(?=[\S\s]*_PROJECT_NAME)(?=[\S\s]*_USER_ID)/
             );
         });
     });

package/cucumber.js

@@ -1,3 +0,0 @@
-module.exports = {
-  default: "--require ./lib/index.js --format progress --format summary:cucumber-report.txt"
-}

package/lib/utils/clean_reports.js

@@ -1,29 +0,0 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const log = require('./log');
-const session_vars = require('./session_vars');
-
-// This is hardcoded information from `cucumber.js`. Once we move to cucumber 8, we should
-// change that the cucumber.json and actually parse the info from it.
-// The file won't be used for anything other than detecting and removing color codes 
-let summary_file_name = 'cucumber-report.txt';
-fs.readFile(summary_file_name, 'utf8', (err, data) => {
-  if (err) {
-    console.error(err);
-    return;
-  }
-
-  // Replace terminal color codes, if present
-  // https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797#colors--graphics-mode
-  data = data.replace(/\x1b\[[0-9][0-9]?[0-9]?m/g, '');
-
-  // Put it in the correct file in the correct folder
-  let artifacts_path = session_vars.get_artifacts_path_name();
-  fs.appendFile( `${ artifacts_path }/${ log.debug_log_file }`, data, err => {
-    if (err) {
-      console.error(err);
-      return;
-    }
-  });  // Ends appendFileSync
-});