datagrok-tools 4.6.4 → 4.7.0

package/bin/commands/help.js

@@ -4,13 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.help = void 0;
-var HELP = "\nUsage: grok <command>\n\nDatagrok's package management tool\n\nCommands:\n    add       Add an object template\n    api       Create wrapper functions\n    check     Check package content (function signatures, etc.)\n    config    Create and manage config files\n    create    Create a package\n    publish   Upload a package\n\nTo get help on a particular command, use:\n    grok <command> --help\n\nRead more about the package development workflow:\nhttps://datagrok.ai/help/develop/develop\n";
+var HELP = "\nUsage: grok <command>\n\nDatagrok's package management tool\n\nCommands:\n    add       Add an object template\n    api       Create wrapper functions\n    check     Check package content (function signatures, etc.)\n    config    Create and manage config files\n    create    Create a package\n    publish   Upload a package\n    test      Run package tests\n\nTo get help on a particular command, use:\n    grok <command> --help\n\nRead more about the package development workflow:\nhttps://datagrok.ai/help/develop/develop\n";
 var HELP_ADD = "\nUsage: grok add <entity> <name>\n\nAdd an object template to your package:\n\ngrok add app <name>\ngrok add connection <name>\ngrok add detector <semantic-type-name>\ngrok add function [tag] <name>\ngrok add query <name>\ngrok add script [tag] <language> <name>\ngrok add view <name>\ngrok add viewer <name>\ngrok add tests\n\nPlease note that entity names may only include letters and numbers\n\nSupported languages for scripts:\njavascript, julia, node, octave, python, r\n\nAvailable tags:\npanel, init\n";
 var HELP_API = "\nUsage: grok api\n\nCreate wrapper functions for package scripts and queries\n";
 var HELP_CONFIG = "\nUsage: grok config\n\nCreate or update a configuration file\n\nOptions:\n[--reset] [--server] [--alias] [--key]\n\n--reset     Restore the default config file template\n--server    Use to add a server to the config (`grok config add --alias alias --server url --key key`)\n--alias     Use in conjunction with the `server` option to set the server name\n--key       Use in conjunction with the `server` option to set the developer key\n--default   Use in conjunction with the `server` option to set the added server as default\n";
 var HELP_CREATE = "\nUsage: grok create [name]\n\nCreate a package:\n\ngrok create         Create a package in the current working directory\ngrok create <name>  Create a package in a folder with the specified name\n\nPlease note that the package name may only include letters, numbers, underscores, or hyphens\n\nOptions:\n[--eslint] [--ide] [--js|--ts] [--jest]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--js        Create a JavaScript package\n--ts        Create a TypeScript package (default)\n--jest      Add a configuration for jest\n";
 var HELP_PUBLISH = "\nUsage: grok publish [host]\n\nUpload a package\n\nOptions:\n[--build|--rebuild] [--debug|--release] [--key] [--suffix]\n\nRunning `grok publish` is the same as running `grok publish defaultHost --build --debug`\n";
 var HELP_CHECK = "\nUsage: grok check\n\nOptions:\n[--dir]\n\n--dir       Check all packages in a specified directory\n\nCheck package content (function signatures, import statements of external modules, etc.)\n";
+var HELP_TEST = "\nUsage: grok test\n\nOptions:\n[--host]\n\n--host       Host alias as in the config file\n\nRun package tests\n\nSee instructions:\nhttps://datagrok.ai/help/develop/how-to/test-packages#local-testing\n";
 var HELP_MIGRATE = "\nUsage: grok migrate\n\nSwitch to `grok` tools by copying your keys to the config\nfile and converting your scripts in the `package.json` file\n";
 var help = {
   add: HELP_ADD,
@@ -19,6 +20,7 @@ var help = {
   config: HELP_CONFIG,
   create: HELP_CREATE,
   publish: HELP_PUBLISH,
+  test: HELP_TEST,
   help: HELP
 };
 exports.help = help;

package/bin/commands/test.js

@@ -0,0 +1,96 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.test = test;
+
+var _child_process = require("child_process");
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var _os = _interopRequireDefault(require("os"));
+
+var _path = _interopRequireDefault(require("path"));
+
+var _jsYaml = _interopRequireDefault(require("js-yaml"));
+
+var utils = _interopRequireWildcard(require("../utils/utils"));
+
+var color = _interopRequireWildcard(require("../utils/color-utils"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+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 nArgs = args['_'].length;
+  var curDir = process.cwd();
+
+  var grokDir = _path["default"].join(_os["default"].homedir(), '.grok');
+
+  var confPath = _path["default"].join(grokDir, 'config.yaml');
+
+  if (nArgs > 1 || options.length > 1 || options.length === 1 && options[0] !== 'host') return false;
+
+  if (!utils.isPackageDir(curDir)) {
+    color.error('File `package.json` not found. Run the command from the package directory');
+    return false;
+  }
+
+  if (!_fs["default"].existsSync(confPath)) {
+    color.error("File `".concat(confPath, "` not found. Run `grok config` to set up the config file"));
+    return false;
+  }
+
+  var config = _jsYaml["default"].load(_fs["default"].readFileSync(confPath, {
+    encoding: 'utf-8'
+  }));
+
+  if (args.host) {
+    if (args.host in config.servers) {
+      process.env.HOST = args.host;
+      console.log('Environment variable `HOST` is set to', args.host);
+    } else {
+      color.error("Unknown server alias. Please add it to ".concat(confPath));
+      return false;
+    }
+  } else if (config["default"]) {
+    process.env.HOST = config["default"];
+    console.log('Environment variable `HOST` is set to', config["default"]);
+  }
+
+  var packageData = JSON.parse(_fs["default"].readFileSync(_path["default"].join(curDir, 'package.json'), {
+    encoding: 'utf-8'
+  }));
+  var fullName = packageData.friendlyName || packageData.fullName;
+
+  if (fullName) {
+    process.env.TARGET_PACKAGE = fullName;
+    console.log('Environment variable `TARGET_PACKAGE` is set to', process.env.TARGET_PACKAGE);
+  } else {
+    color.error('Invalid full package name. Set `friendlyName` or `fullName` field in `package.json`');
+    return false;
+  }
+
+  color.info("Publishing package \"".concat(process.env.TARGET_PACKAGE, "\" to ").concat(process.env.HOST, "..."));
+  (0, _child_process.exec)("grok publish ".concat(process.platform === 'win32' ? '%HOST%' : '${HOST}'), function (err, stdout, stderr) {
+    if (err) throw err;else {
+      console.log(stdout);
+      color.error(stderr);
+    }
+    color.info('Starting tests...');
+    (0, _child_process.exec)('npm run test', function (err, stdout, stderr) {
+      if (err) throw err;else {
+        console.log(stdout);
+        console.log(stderr);
+      }
+    });
+  });
+  return true;
+}

package/bin/grok.js

@@ -9,6 +9,7 @@ const commands = {
   config: require('./commands/config').config,
   create: require('./commands/create').create,
   publish: require('./commands/publish').publish,
+  test: require('./commands/test').test,
 };
 
 const command = argv['_'][0];

package/entity-template/test.ts

@@ -9,4 +9,8 @@ category('Examples', () => {
   test('Fail', () => {
     throw 'Exception';
   });
+
+  test('Skipped', async () => {
+    expect(1 === 1 , false);
+  }, {skipReason: 'TASK-ID'});
 });

package/package.json

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