@suffolklitlab/alkiln 5.11.2 → 5.12.0-delete2

package/lib/utils/reports.js

@@ -7,6 +7,13 @@ const files = require(`./files` );
 
 module.exports = reports = {};
 
+reports.title = `Assembly Line Kiln Automated Testing Report - ${ (new Date()).toUTCString() }\n`;
+reports.failures = [ `\n\n≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡\n🤕 Failed scenarios\n≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡\n` ];
+reports.successes = [ `\n\n≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡\n🌈 Passed scenarios\n≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡\n` ];
+// reports.warnings = [ `\n\n≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡\n🔎 Scenarios to check\n≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡\n` ];
+// reports.undefineds = [ `\n\n≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡\n[langs icon] Scenarios with typos\n≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡\n` ];
+reports.others = [ `\n\n≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡\n🔎 Other scenarios that did not pass\n≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡\n` ];
+
 reports.addReportHeading = function (scope, { scenario }) {
   /** Return printable heading based on Scenario name and tags.
   *    Allow characters from other languages.
@@ -19,14 +26,14 @@ reports.addReportHeading = function (scope, { scenario }) {
     tag_names.push( tag.name );
   }
 
-  let heading = `\n---------------\n`
+  let heading = `\n―――――――――――――――\n`
     + `Scenario: ${ scenario.pickle.name }`;
 
   if ( tag_names.length > 0 ) {
     heading += `\nTags: ${ tag_names.join(' ') }`;
   }
 
-  heading += `\n---------------`;
+  heading += `\n―――――――――――――――`;
 
   reports.addToReport( scope, {
     code: `ALK0176`,
@@ -71,21 +78,30 @@ reports.addToReport = function( scope, { type, code, value }) {
   }
 
   // Report stuff
-  let scenario = makeSureReportPartsExist( scope );
+  let scenario = reports.makeSureScenarioExists( scope );
   scenario.lines.push({ type, code, value });
 
   return scenario;
 };  // Ends reports.addToReport()
 
-let makeSureReportPartsExist = function( scope ) {
+reports.create = function( scope ) {
+  reports.makeSureReportExists( scope );
+}
+
+reports.makeSureReportExists = function( scope ) {
   /** If a part of the report needs to exist right now, but doesn't exist,
   * create it. */
   if ( !scope.report ) { scope.report = new Map(); }
+  return this;
+};  // Ends reports.makeSureReportExists()
+
+reports.makeSureScenarioExists = function ( scope ) {
+  reports.makeSureReportExists( scope );
   if ( !scope.scenario_id ) {
     scope.scenario_id = `_report_${ Date.now() }`;
   }
   if ( !scope.report.get( scope.scenario_id )) {
-    scope.report.set( scope.scenario_id, {} )
+    scope.report.set( scope.scenario_id, {} );
     scope.report.get( scope.scenario_id ).status = `in progress`;
   }
 
@@ -93,11 +109,36 @@ let makeSureReportPartsExist = function( scope ) {
   if ( !scenario.lines ) { scenario.lines = []; }
 
   return scenario;
-};  // Ends makeSureReportPartsExist()
+};  // Ends reports.makeSureScenarioExists()
+
+reports.saveFinalScenarioData = function( scope, { status=`in progress` }) {
+  this.setReportScenarioStatus( scope, { status });
+  let scenario = scope.report.get( scope.scenario_id );
+  let report = this.getPrintableScenario( scenario );
+  if ( scenario.status === `FAILED` ) { this.failures.push( report ); }
+  else if ( scenario.status === `PASSED` ) { this.successes.push( report ); }
+  // else if ( scenario.status === `WARNING` ) { passed_reports += report; this.warnings.push( report ); }
+  // else if ( scenario.status === `UNDEFINED` ) { passed_reports += report; this.undefineds.push( report ); }
+  else { this.others.push( report ); }
+
+  // Save to failures.txt (worry about optimization later)
+  if ( this.failures.length > 1 || this.others.length > 1 ) {
+    fs.writeFileSync(
+      scope.paths.failures,
+      this.title + this.getPrintableUnexpected( scope )
+    );
+  }
+  // Save to reports.txt (worry about optimization later)
+  fs.writeFileSync( scope.paths.report, this.getPrintableReport( scope ) );
+
+  return scenario;
+};  // Ends reports.saveFinalScenarioData()
+
 
 reports.setReportScenarioStatus = function( scope, { status=`PASSED` }) {
   /** Add final status of scenario to scenario report object - passed, failed, etc. */
   scope.report.get( scope.scenario_id ).status = status;
+  return scope.report.get( scope.scenario_id );
 };  // Ends reports.setReportScenarioStatus()
 
 reports.convertToOriginalStoryTableRow = function( scope, { row_data }) {
@@ -124,34 +165,38 @@ let trimJSON = function( str=`` ) {
 };  // Ends trimJSON()
 
 reports.getPrintableReport = function( scope ) {
-  /** Return a string generated from test report data. */
-  let report = `Assembly Line Kiln Automated Testing Report - ${ (new Date()).toUTCString() }\n`;
-
-  // First list failed scenarios, then non-passed scenarios, then passed scenarios
-  let failed_reports = ``;
-  let passed_reports = ``;
-  let other_reports = ``;
-  for ( let scenario of scope.report ) {
-
-    let report = reports.getPrintableScenario( scenario );
-    let [ scenario_id, data ] = scenario;
-    if ( data.status === `FAILED` ) { failed_reports += report; }
-    else if ( data.status === `PASSED` ) { passed_reports += report; }
-    else { other_reports += report; }
-  };  // ends for every scenario
-
-  if ( failed_reports !== `` ) { report += `\n\n===============================\n===============================\n🤕 Failed scenarios:\n${ failed_reports }`; }
-  if ( other_reports !== `` ) { report += `\n\n===============================\n===============================\n🔎 Scenarios that did not pass:\n${ other_reports }`; }
-  if ( passed_reports !== `` ) { report += `\n\n===============================\n===============================\n🌈 Passed scenarios:\n${ passed_reports }`; }
+  /** Return a string generated from test report data.
+  *
+  * First list failed scenarios, then non-passed scenarios, then passed scenarios. */
+  let report = this.getTitle( scope );
+
+  if ( this.failures.length > 1 ) { report += this.failures.join( `` ); }
+  if ( this.successes.length > 1 ) { report += this.successes.join( `` ); }
+  // if ( this.warnings.length > 1 ) {}
+  // if ( this.undefineds.length > 1 ) {}
+  if ( this.others.length > 1 ) { report += this.others.join( `` ); }
 
   return report;
 };  // Ends reports.getPrintableReport()
 
+reports.getTitle = function( scope ) { return this.title; }
+
+reports.getPrintableUnexpected = function( scope ) {
+  // Note about `> 1`: The first line of the report section always exists
+  let output = ``;
+  if ( this.failures.length > 1 ) {
+    output += this.failures.join(``);
+  }
+  if ( this.others.length > 1 ) {
+    output += this.others.join(``);
+  }
+  return output;
+};  // Ends reports.getPrintableUnexpected()
+
 reports.getPrintableScenario = function( scenario ) {
   /** Return a string generated from scenario list of report items. */
-  let [ scenario_id, data ] = scenario;
   let report = ``;
-  for ( let line of data.lines ) {
+  for ( let line of scenario.lines ) {
     let { type, code, value } = line;
     report += `${ getLineText({ type, code, value }) }\n`;
   }

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.11.2",
+  "version": "5.12.0-delete2",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
     "test": "npm run unit && npm run codes && npm run cucumber",
     "cucumber": "./lib/run_cucumber.js",
     "local": "npm run setup && npm run cucumber; npm run takedown",
+    "pass": "npm run cucumber 'not @error and not @temp_error'",
+    "fail": "npm run cucumber '@error'",
     "setup": "./lib/docassemble/setup.js",
     "takedown": "./lib/docassemble/takedown.js",
     "server_install": "./lib/docassemble/server_install.js",
@@ -30,7 +32,7 @@
   "bugs": {
     "url": "https://github.com/SuffolkLITLab/ALKiln/issues"
   },
-  "homepage": "https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing/",
+  "homepage": "https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/intro",
   "dependencies": {
     "@axe-core/puppeteer": "4.7.3",
     "@cucumber/cucumber": "9.3.0",

package/setup.py

@@ -50,7 +50,7 @@ setup(name='docassemble.ALKilnTests',
       author='plocket',
       author_email='example@example.com',
       license='The MIT License (MIT)',
-      url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln',
+      url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/intro',
       packages=find_packages(),
       namespace_packages=['docassemble'],
       install_requires=['docassemble.ALToolbox>=0.8.2', 'docassemble.AssemblyLine>=2.24.0'],

package/tests/log_codes/check_codes.sh

@@ -106,7 +106,8 @@ ALK0026
 ALK0027
 ALK0028
 ALK0030
-ALK0049"
+ALK0049
+ALK0184"
 
 # Use a sorted list. `uniq` only detects consecutive duplicates
 duplicates=$(echo "$sorted" | uniq -d)