datagrok-tools 4.12.3 → 4.12.4

package/README.md

@@ -118,4 +118,19 @@ Read more about package development in [Datagrok's documentation](https://datagr
   save a test run result, add the `--csv` flag (the report will be saved in a
   CSV file in the package folder). You can find more details in [local package testing
   instructions](https://datagrok.ai/help/develop/how-to/test-packages#local-testing).
+
+  Table with all available flags:
+  | Flag           | Description                                                               |
+  |----------------|---------------------------------------------------------------------------|
+  | catchUnhandled | Whether or not to catch unhandled exceptions during tests                 |
+  | category       | Runs tests of a specific category                                         |
+  | csv            | Saves tests run results as a CSV file in the package folder               |
+  | gui            | Disables the headless browser mode                                        |
+  | host           | Specify server alias                                                      |
+  | record         | Records the test execution process in mp4 format                          |
+  | report         | Sends a report on test results                                            |
+  | skip-build     | Skips package build step                                                   |
+  | skip-publish   | Skips package publish step                                                 |
+  | verbose        | Prints detailed information about passed and skipped tests in the console |
+
 - `link` command is used for public plugins development to link `datagrok-api` and libraries.

package/bin/commands/check.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.check = check;
+exports.checkChangelog = checkChangelog;
 exports.checkFuncSignatures = checkFuncSignatures;
 exports.checkImportStatements = checkImportStatements;
 exports.checkPackageFile = checkPackageFile;
@@ -85,6 +86,7 @@ function check(args) {
       isWebpack: isWebpack,
       externals: externals
     })));
+    warnings.push.apply(warnings, (0, _toConsumableArray2["default"])(checkChangelog(packagePath)));
     if (warnings.length) {
       console.log("Checking package ".concat(_path["default"].basename(packagePath), "..."));
       warn(warnings);
@@ -398,6 +400,34 @@ function checkPackageFile(packagePath, options) {
   }
   return warnings;
 }
+function checkChangelog(packagePath) {
+  var warnings = [];
+  var clf;
+  try {
+    clf = _fs["default"].readFileSync(_path["default"].join(packagePath, 'CHANGELOG.md'), {
+      encoding: 'utf-8'
+    });
+  } catch (e) {
+    return ['CHANGELOG.md file does not exist'];
+  }
+  var regex = /^##[^#].*$/gm;
+  var h2 = clf.match(regex);
+  if (!h2) return ['No versions found in CHANGELOG.md'];
+  regex = /^## \d+\.\d+\.\d+ \(\d{4}-\d{2}-\d{2}\).*$/;
+  var _iterator7 = _createForOfIteratorHelper(h2),
+    _step7;
+  try {
+    for (_iterator7.s(); !(_step7 = _iterator7.n()).done;) {
+      var h = _step7.value;
+      if (!regex.test(h)) warnings.push("CHANGELOG: '".concat(h, "' does not match the h2 format"));
+    }
+  } catch (err) {
+    _iterator7.e(err);
+  } finally {
+    _iterator7.f();
+  }
+  return warnings;
+}
 function warn(warnings) {
   warnings.forEach(function (w) {
     return color.warn(w);
@@ -411,11 +441,11 @@ function getFuncMetadata(script) {
     inputs: [],
     outputs: []
   };
-  var _iterator7 = _createForOfIteratorHelper(script.split('\n')),
-    _step7;
+  var _iterator8 = _createForOfIteratorHelper(script.split('\n')),
+    _step8;
   try {
-    for (_iterator7.s(); !(_step7 = _iterator7.n()).done;) {
-      var line = _step7.value;
+    for (_iterator8.s(); !(_step8 = _iterator8.n()).done;) {
+      var line = _step8.value;
       if (!line) continue;
       var match = line.match(utils.paramRegex);
       if (match) {
@@ -444,9 +474,9 @@ function getFuncMetadata(script) {
       }
     }
   } catch (err) {
-    _iterator7.e(err);
+    _iterator8.e(err);
   } finally {
-    _iterator7.f();
+    _iterator8.f();
   }
   return funcData;
 }

package/bin/commands/test.js

@@ -22,7 +22,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function test(args) {
   var options = Object.keys(args).slice(1);
-  var commandOptions = ['host', 'csv', 'gui', 'catchUnhandled', 'report', 'skip-build', 'skip-publish', 'category', 'record'];
+  var commandOptions = ['host', 'csv', 'gui', 'catchUnhandled', 'report', 'skip-build', 'skip-publish', 'category', 'record', 'verbose'];
   var nArgs = args['_'].length;
   var curDir = process.cwd();
   var grokDir = _path["default"].join(_os["default"].homedir(), '.grok');
@@ -170,6 +170,10 @@ function test(args) {
                       var skipReport = '';
                       var passReport = '';
                       var failReport = '';
+                      var countReport = {
+                        skip: 0,
+                        pass: 0
+                      };
                       if (df == null) {
                         failed = true;
                         failReport = "Fail reason: No package tests found".concat(options.category ? " for category \"".concat(options.category, "\"") : '');
@@ -177,7 +181,8 @@ function test(args) {
                           failReport: failReport,
                           skipReport: skipReport,
                           passReport: passReport,
-                          failed: failed
+                          failed: failed,
+                          countReport: countReport
                         });
                       }
                       var cStatus = df.columns.byName('success');
@@ -190,8 +195,10 @@ function test(args) {
                         if (cStatus.get(i)) {
                           if (cSkipped.get(i)) {
                             skipReport += "Test result : Skipped : ".concat(cTime.get(i), " : ").concat(targetPackage, ".").concat(cCat.get(i), ".").concat(cName.get(i), " : ").concat(cMessage.get(i), "\n");
+                            countReport.skip += 1;
                           } else {
                             passReport += "Test result : Success : ".concat(cTime.get(i), " : ").concat(targetPackage, ".").concat(cCat.get(i), ".").concat(cName.get(i), " : ").concat(cMessage.get(i), "\n");
+                            countReport.pass += 1;
                           }
                         } else {
                           failed = true;
@@ -204,7 +211,8 @@ function test(args) {
                         skipReport: skipReport,
                         passReport: passReport,
                         failed: failed,
-                        csv: csv
+                        csv: csv,
+                        countReport: countReport
                       });
                     })["catch"](function (e) {
                       return reject(e);
@@ -263,8 +271,8 @@ function test(args) {
                 _fs["default"].writeFileSync(_path["default"].join(curDir, 'test-report.csv'), r.csv, 'utf8');
                 color.info('Saved `test-report.csv`\n');
               }
-              if (r.passReport) console.log(r.passReport);
-              if (r.skipReport) console.log(r.skipReport);
+              if (r.passReport && args.verbose) console.log(r.passReport);else console.log('Passed tests: ' + r.countReport.pass);
+              if (r.skipReport && args.verbose) console.log(r.skipReport);else console.log('Skipped tests: ' + r.countReport.skip);
               if (r.failed) {
                 console.log(r.failReport);
                 color.fail('Tests failed.');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datagrok-tools",
-  "version": "4.12.3",
+  "version": "4.12.4",
   "description": "Utility to upload and publish packages to Datagrok",
   "homepage": "https://github.com/datagrok-ai/public/tree/master/tools#readme",
   "dependencies": {