@locustjs/test 1.6.1 → 1.6.2

package/README.md

@@ -14,6 +14,7 @@ const tests = [
   ['test 1', expect => expect(2 + 2).toBe(4)],
   ['test 2', expect => expect(undefined).toBeUndefined()],
   ['test 3', expect => expect(5).toBeGt(10)],  // this test fails
+  ...
 ];
 
 const runner = new TestRunner();
@@ -44,18 +45,25 @@ Sample output:
 
 8. <b>Test 8: not expected:</b> <span style="color:magenta">expect not used</span> (0 sec)
 
-9. <b>Test 9: error without expect:</b> <span style="color:magenta">expect not used</span> (0 sec)
+9. <b>Test 9: error without expect:</b> <span style="color:yellow">faulted</span> (0 sec)
 <div style="color:gray; margin-left: 50px">error 501: test 'Test 9: error without expect' failed.</div>
 <div style="color:yellow; margin-left: 50px">some err</div>
 
 10. Test 10: class: <span style="color:green">passed</span> (0 sec)
 
-<div><b>Number of tests: 8</b></div>
+<div><b>Number of tests: 10</b></div>
 <div><b>Total Time: 0.001</b> sec</div>
 <br/>
- <span style="color:green">7 test(s) passed</span>,  <span style="color:red">1 test(s) failed</span>,  <span style="color:magenta">2 test(s) are unknown</span>
+ <span style="color:green">7 test(s) passed</span>, <span style="color:red">1 test(s) failed</span>, <span style="color:yellow">1 test(s) faulted</span>, <span style="color:magenta">1 test(s) are unknown</span>
+
+## Test result types
 
-# expect
+- <span style="color:green">passed</span>: Test passed.
+- <span style="color:red">failed</span>: Test failed (at least one `expect` did not succeed).
+- <span style="color:yellow">faulted</span>: Test crashed (no `expect` was called).
+- <span style="color:magenta">unknown</span>: Test executed, however, no `expect` was seen.
+
+## expect
 Positive
 - `toBe(value)`
 - `toBeGt(value)`
@@ -132,6 +140,8 @@ Negative
 - `async notToThrowAsync(ex, shape = false, strict = false)`
 - `notToBeNaN()`
 
+## Qucik Testing
+
 `TestRunner` has a static method `start()` that simplifies running tests.
 
 ```javascript

package/index.cjs.js

@@ -1464,13 +1464,19 @@ var bgGray = "\x1b[100m";
 var TestRunner = /*#__PURE__*/function () {
   function TestRunner() {
     _classCallCheck(this, TestRunner);
-    this._passed = 0;
-    this._failed = 0;
-    this._unknown = 0;
-    this._results = [];
-    this._errors = [];
+    this._init();
   }
   return _createClass(TestRunner, [{
+    key: "_init",
+    value: function _init() {
+      this._passed = 0;
+      this._failed = 0;
+      this._faulted = 0;
+      this._unknown = 0;
+      this._results = [];
+      this._errors = [];
+    }
+  }, {
     key: "_runSingle",
     value: function () {
       var _runSingle2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(test, onProgress, i) {
@@ -1503,7 +1509,13 @@ var TestRunner = /*#__PURE__*/function () {
             case 3:
               tr = _context3.sent;
               this._results.push(tr);
-              if (!tr.expected) {
+              if ((0, _base.isObject)(tr.err)) {
+                if (!tr.expected) {
+                  this._faulted++;
+                } else {
+                  this._failed++;
+                }
+              } else if (!tr.expected) {
                 this._unknown++;
               } else if (tr.success) {
                 this._passed++;
@@ -1527,6 +1539,7 @@ var TestRunner = /*#__PURE__*/function () {
       return {
         passed: this._passed,
         failed: this._failed,
+        faulted: this._faulted,
         results: this._results,
         errors: this._errors
       };
@@ -1535,10 +1548,7 @@ var TestRunner = /*#__PURE__*/function () {
     key: "run",
     value: function run(tests, onProgress) {
       var _this3 = this;
-      this._passed = 0;
-      this._failed = 0;
-      this._results = [];
-      this._errors = [];
+      this._init();
       return new Promise(function (res) {
         if (tests) {
           if (tests instanceof Test) {
@@ -1609,11 +1619,21 @@ var TestRunner = /*#__PURE__*/function () {
         var t = "(".concat(_this4._getTime(testResult.time), ")");
         if (detailed) {
           var message = "\n" + (i + 1) + ". ";
-          var err = !(0, _base.isNullOrEmpty)(testResult.err) ? testResult.err.toString().split("\n") : [];
+          var err = (0, _base.isObject)(testResult.err) ? testResult.err.toString().split("\n") : [];
           err = err.map(function (msg, i) {
             return "\t".concat(i == err.length - 1 ? "".concat(fgYellow) : "".concat(fgGray, "error ").concat(testResult.err.code, ": ")).concat(msg).concat(reset);
           }).join("\n");
-          if (!testResult.expected) {
+          if ((0, _base.isObject)(testResult.err)) {
+            if (!testResult.expected) {
+              message += "".concat(bright).concat(fgWhite).concat(testResult.test, ": ").concat(fgYellow, "faulted").concat(reset, " ").concat(t);
+              message += "\n";
+              message += "".concat(fgGray).concat(err, " ").concat(reset);
+            } else {
+              message += "".concat(bright).concat(fgWhite).concat(testResult.test, ": ").concat(fgRed, "failed").concat(reset, " ").concat(t);
+              message += "\n";
+              message += "".concat(fgGray).concat(err, " ").concat(reset);
+            }
+          } else if (!testResult.expected) {
             message += "".concat(bright).concat(fgWhite).concat(testResult.test, ": ").concat(fgMagenta, "expect not used").concat(reset, " ").concat(t);
             if (testResult.err) {
               message += "\n";
@@ -1652,7 +1672,7 @@ var TestRunner = /*#__PURE__*/function () {
           _iterator.f();
         }
       }
-      var text = (detailed ? "\n" : "") + "".concat(bright, "Number of tests: ").concat(reset).concat(this._passed + this._failed) + "\n" + "".concat(bright, "Total Time: ").concat(reset).concat(time / 1000, " sec") + "\n\n" + (this._passed > 0 ? "".concat(fgGreen, " ").concat(this._passed, " test(s) passed").concat(reset) : "0 tests passed".concat(reset)) + ", " + (this._failed > 0 ? "".concat(fgRed, " ").concat(this._failed, " test(s) failed").concat(reset) : "0 tests failed".concat(reset)) + (this._unknown > 0 ? ", ".concat(fgMagenta, " ").concat(this._unknown, " test(s) are unknown").concat(reset) : "") + "\n";
+      var text = (detailed ? "\n" : "") + "".concat(bright, "Number of tests: ").concat(reset).concat(this._results.length) + "\n" + "".concat(bright, "Total Time: ").concat(reset).concat(time / 1000, " sec") + "\n\n" + (this._passed > 0 ? "".concat(fgGreen, " ").concat(this._passed, " test(s) passed").concat(reset) : "0 tests passed".concat(reset)) + ", " + (this._failed > 0 ? "".concat(fgRed).concat(this._failed, " test(s) failed").concat(reset) : "0 tests failed".concat(reset)) + (this._faulted > 0 ? ", ".concat(fgYellow).concat(this._faulted, " test(s) faulted").concat(reset) : "") + (this._unknown > 0 ? ", ".concat(fgMagenta).concat(this._unknown, " test(s) are unknown").concat(reset) : "") + "\n";
       console.log(text);
     }
   }, {

package/index.esm.js

@@ -16,7 +16,6 @@ import {
   isIterable,
   isSomeArray,
   isSubClassOf,
-  isNullOrEmpty,
 } from "@locustjs/base";
 import { Exception } from "@locustjs/exception";
 import fs from "fs";
@@ -1310,8 +1309,12 @@ const bgGray = "\x1b[100m";
 
 class TestRunner {
   constructor() {
+    this._init();
+  }
+  _init() {
     this._passed = 0;
     this._failed = 0;
+    this._faulted = 0;
     this._unknown = 0;
     this._results = [];
     this._errors = [];
@@ -1338,7 +1341,13 @@ class TestRunner {
 
     this._results.push(tr);
 
-    if (!tr.expected) {
+    if (isObject(tr.err)) {
+      if (!tr.expected) {
+        this._faulted++;
+      } else {
+        this._failed++;
+      }
+    } else if (!tr.expected) {
       this._unknown++;
     } else if (tr.success) {
       this._passed++;
@@ -1350,15 +1359,13 @@ class TestRunner {
     return {
       passed: this._passed,
       failed: this._failed,
+      faulted: this._faulted,
       results: this._results,
       errors: this._errors,
     };
   }
   run(tests, onProgress) {
-    this._passed = 0;
-    this._failed = 0;
-    this._results = [];
-    this._errors = [];
+    this._init();
 
     return new Promise((res) => {
       if (tests) {
@@ -1434,7 +1441,7 @@ class TestRunner {
 
       if (detailed) {
         let message = "\n" + (i + 1) + ". ";
-        let err = !isNullOrEmpty(testResult.err)
+        let err = isObject(testResult.err)
           ? testResult.err.toString().split("\n")
           : [];
 
@@ -1449,7 +1456,17 @@ class TestRunner {
           )
           .join("\n");
 
-        if (!testResult.expected) {
+        if (isObject(testResult.err)) {
+          if (!testResult.expected) {
+            message += `${bright}${fgWhite}${testResult.test}: ${fgYellow}faulted${reset} ${t}`;
+            message += "\n";
+            message += `${fgGray}${err} ${reset}`;
+          } else {
+            message += `${bright}${fgWhite}${testResult.test}: ${fgRed}failed${reset} ${t}`;
+            message += "\n";
+            message += `${fgGray}${err} ${reset}`;
+          }
+        } else if (!testResult.expected) {
           message += `${bright}${fgWhite}${testResult.test}: ${fgMagenta}expect not used${reset} ${t}`;
 
           if (testResult.err) {
@@ -1488,7 +1505,7 @@ class TestRunner {
 
     const text =
       (detailed ? "\n" : "") +
-      `${bright}Number of tests: ${reset}${this._passed + this._failed}` +
+      `${bright}Number of tests: ${reset}${this._results.length}` +
       "\n" +
       `${bright}Total Time: ${reset}${time / 1000} sec` +
       "\n\n" +
@@ -1497,10 +1514,13 @@ class TestRunner {
         : `0 tests passed${reset}`) +
       ", " +
       (this._failed > 0
-        ? `${fgRed} ${this._failed} test(s) failed${reset}`
+        ? `${fgRed}${this._failed} test(s) failed${reset}`
         : `0 tests failed${reset}`) +
+      (this._faulted > 0
+        ? `, ${fgYellow}${this._faulted} test(s) faulted${reset}`
+        : ``) +
       (this._unknown > 0
-        ? `, ${fgMagenta} ${this._unknown} test(s) are unknown${reset}`
+        ? `, ${fgMagenta}${this._unknown} test(s) are unknown${reset}`
         : ``) +
       "\n";
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@locustjs/test",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description": "This library provides a simple test runner.",
   "main": "index.cjs.js",
   "module": "index.esm.js",