@saltcorn/cli 0.7.2-beta.0 → 0.7.2-beta.10

package/src/commands/rm-tenant.js

@@ -3,6 +3,7 @@
  * @module commands/rm-tenant
  */
 const { Command, flags } = require("@oclif/command");
+const {cli} = require("cli-ux");
 
 /**
  * RmTenantCommand Class
@@ -14,9 +15,23 @@ class RmTenantCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    const { args } = this.parse(RmTenantCommand);
+
+
+    const { flags } = this.parse(RmTenantCommand);
+
     const { deleteTenant } = require("@saltcorn/admin-models/models/tenant");
-    await deleteTenant(args.tenant);
+
+    if (!flags.force) {
+      const ans = await cli.confirm(
+        `This will delete tenant ${flags.tenant}. Attention! All tenant data will be lost!\nContinue (y/n)?`);
+      if (!ans) {
+        console.log(`Success: Command execution canceled`);
+        this.exit(1);
+      }
+    }
+    // make changes
+    await deleteTenant(flags.tenant);
+
     this.exit(0);
   }
 }
@@ -24,18 +39,36 @@ class RmTenantCommand extends Command {
 /**
  * @type {object}
  */
-RmTenantCommand.args = [
+RmTenantCommand.args = []; /*[
   { name: "tenant", required: true, description: "Tenant to remove" },
 ];
-
+*/
 /**
  * @type {string}
  */
-RmTenantCommand.description = `Remove a tenant`;
+RmTenantCommand.description = `Remove a tenant.
+Attention! All tenant data will be lost!
+It recommended to make backup of tenant before perform this command.
+`;
+
+/**
+ * @type {object}
+ */
+RmTenantCommand.help = `Remove a tenant.
+Attention! All tenant data will be lost!
+It recommended to make backup of tenant before perform this command.
+`;
 
 /**
  * @type {object}
  */
-RmTenantCommand.flags = {};
+RmTenantCommand.flags = {
+  force: flags.boolean({ char: "f", description: "force command execution" }),
+  tenant: flags.string({
+    char: "t",
+    description: "tenant",
+    required: true,
+  }),
+};
 
 module.exports = RmTenantCommand;

package/src/commands/run-tests.js

@@ -32,26 +32,34 @@ class RunTestsCommand extends Command {
     return res;
   }
 
-  /**
-   *
-   * @param {*} env
-   * @returns {Promise<void>}
-   */
-  async e2etest(env) {
+  async prepareTestServer(env, port) {
+    let serverEnv = JSON.parse(JSON.stringify(env));
+    serverEnv.SQLITE_FILEPATH = "/tmp/sctestdb_server";
     spawnSync("packages/saltcorn-cli/bin/saltcorn", ["fixtures", "-r"], {
       stdio: "inherit",
-      env,
+      env: serverEnv,
     });
 
     const server = spawn(
       "packages/saltcorn-cli/bin/saltcorn",
-      ["serve", "-p", "2987"],
+      ["serve", "-p", port],
       {
         stdio: "inherit",
-        env,
+        env: serverEnv,
       }
     );
     await sleep(2000);
+    return server;
+  }
+
+  /**
+   *
+   * @param {*} env
+   * @returns {Promise<void>}
+   */
+  async e2etest(env) {
+    const port = 2987;
+    const server = await this.prepareTestServer(env, port);
     const res = await this.do_test(
       "npm",
       ["run", "gotest"],
@@ -63,6 +71,23 @@ class RunTestsCommand extends Command {
     if (res.status !== 0) this.exit(res.status);
   }
 
+  /**
+   *
+   * @param {*} env
+   */
+  async remoteQueryTest(env, jestParams) {
+    const port = 3000;
+    env.jwt_secret = require("@saltcorn/data/db").connectObj.jwt_secret;
+    const server = await this.prepareTestServer(env, port);
+    const res = await this.do_test(
+      "npm",
+      ["run", "remote-queries-test", ...jestParams],
+      env,
+      "packages/saltcorn-data"
+    );
+    server.kill();
+    if (res.status !== 0) this.exit(res.status);
+  }
   /**
    *
    * @param {object} args
@@ -91,9 +116,6 @@ class RunTestsCommand extends Command {
     this.validateCall(args, flags);
     var env;
 
-    spawnSync("npm", ["run", "tsc"], {
-      stdio: "inherit",
-    });
     const db = require("@saltcorn/data/db");
     if (db.isSQLite) {
       const testdbpath = "/tmp/sctestdb";
@@ -103,6 +125,9 @@ class RunTestsCommand extends Command {
       await db.changeConnection({ database: "saltcorn_test" });
       env = { ...process.env, PGDATABASE: "saltcorn_test" };
     }
+    spawnSync("npm", ["run", "tsc"], {
+      stdio: "inherit",
+    });
     const fixtures = require("@saltcorn/data/db/fixtures");
     const reset = require("@saltcorn/data/db/reset_schema");
     await reset();
@@ -123,17 +148,20 @@ class RunTestsCommand extends Command {
     }
     if (args.package === "core") {
       await this.do_test("npm", ["run", "test", ...jestParams], env);
+    } else if (args.package === "view-queries") {
+      await this.remoteQueryTest(env, jestParams);
     } else if (args.package === "e2e") {
       await this.e2etest(env);
     } else if (args.package) {
       const cwd = "packages/" + args.package;
       await this.do_test("npm", ["run", "test", ...jestParams], env, cwd);
     } else {
-      const lerna = process.platform === "win32" ? "lerna.cmd" : "lerna";
+      const cwd = ".";
       await this.do_test(
-        lerna,
-        ["run", "test", "--stream", ...jestParams],
-        env
+        "npm",
+        ["--workspaces", "run", "test", ...jestParams],
+        env,
+        cwd
       );
       //await this.e2etest(env);
     }

package/src/commands/setup.js

@@ -1,4 +1,5 @@
 /**
+ * Set up new saltcorn configuration
  * @category saltcorn-cli
  * @module commands/setup
  */
@@ -14,22 +15,32 @@ const { is } = require("contractis");
 const path = require("path");
 const fs = require("fs");
 const inquirer = require("inquirer");
-var tcpPortUsed = require("tcp-port-used");
+const tcpPortUsed = require("tcp-port-used");
 const { spawnSync } = require("child_process");
-var sudo = require("sudo");
+const sudo = require("sudo");
+const crypto = require("crypto");
 
 /**
- * 
+ * Generate password for user
  * @returns {string}
  */
+// todo deduplicate code - the same function in User
 const gen_password = () => {
   const s = is.str.generate().replace(" ", "");
   if (s.length > 7) return s;
   else return gen_password();
 };
+/**
+ * Generate jwt secret
+ * @returns {string}
+ */
+const genJwtSecret = () => {
+  return crypto.randomBytes(64).toString("hex");
+};
 
 /**
- * 
+ * Ask for platform run mode (dev - run manually, server - run as system service)
+ *
  * @returns {Promise<object>}
  */
 const askDevServer = async () => {
@@ -58,8 +69,8 @@ const askDevServer = async () => {
 };
 
 /**
- * 
- * @param {*} mod 
+ * Unload module
+ * @param {*} mod
  */
 const unloadModule = (mod) => {
   var name = require.resolve(mod);
@@ -67,13 +78,19 @@ const unloadModule = (mod) => {
 };
 
 /**
+ * Set up platform run mode (dev - run manually, server - run as system service)
  * @returns {Promise<void>}
  */
 const setupDevMode = async () => {
   const dbPath = path.join(defaultDataPath, "scdb.sqlite");
   fs.promises.mkdir(defaultDataPath, { recursive: true });
   const session_secret = gen_password();
-  await write_connection_config({ sqlite_path: dbPath, session_secret });
+  const jwt_secret = genJwtSecret();
+  await write_connection_config({
+    sqlite_path: dbPath,
+    session_secret,
+    jwt_secret,
+  });
 
   if (!fs.existsSync(dbPath)) {
     unloadModule("@saltcorn/data/db");
@@ -85,6 +102,8 @@ const setupDevMode = async () => {
 };
 
 /**
+ * Check for locally running database (ip 127.0.0.1, port 5432)
+ *
  * @returns {Promise<void>}
  */
 const check_db = async () => {
@@ -115,8 +134,8 @@ const check_db = async () => {
 };
 
 /**
- * 
- * @param {*} args 
+ * Execute Linux commands
+ * @param {*} args
  * @returns {Promise<void>}
  */
 const asyncSudo = (args) => {
@@ -136,8 +155,8 @@ const asyncSudo = (args) => {
 };
 
 /**
- * 
- * @param {*} args 
+ * Execute Postgres commands
+ * @param {*} args
  * @returns {Promise<void>}
  */
 const asyncSudoPostgres = (args) => {
@@ -145,8 +164,8 @@ const asyncSudoPostgres = (args) => {
 };
 
 /**
- * 
- * @param {string} for_who 
+ * Ask for passworf
+ * @param {string} for_who
  * @returns {Promise<string>}
  */
 const get_password = async (for_who) => {
@@ -163,6 +182,7 @@ const get_password = async (for_who) => {
 };
 
 /**
+ * Install Database
  * @returns {Promise<void>}
  */
 const install_db = async () => {
@@ -204,6 +224,7 @@ const install_db = async () => {
     `ALTER SCHEMA public OWNER TO ${user};`,
   ]);
   const session_secret = await get_password("session secret");
+  const jwt_secret = genJwtSecret();
   await write_connection_config({
     host: "localhost",
     port: 5432,
@@ -211,12 +232,13 @@ const install_db = async () => {
     user,
     password: scpass,
     session_secret,
+    jwt_secret,
     multi_tenant: false,
   });
 };
 
 /**
- * 
+ * Ask for Database parameters
  * @returns {Promise<object>}
  */
 const prompt_connection = async () => {
@@ -236,6 +258,7 @@ const prompt_connection = async () => {
     required: true,
   });
   const session_secret = await get_password("session secret");
+  const jwt_secret = genJwtSecret();
   return {
     host: host || "localhost",
     port: port || 5432,
@@ -243,11 +266,13 @@ const prompt_connection = async () => {
     user: user || "saltcorn",
     password: password,
     session_secret,
+    jwt_secret,
     multi_tenant: false,
   };
 };
 
 /**
+ * Write platform config
  * @returns {Promise<void>}
  */
 const setup_connection_config = async () => {
@@ -256,8 +281,8 @@ const setup_connection_config = async () => {
 };
 
 /**
- * 
- * @param {object} connobj 
+ *
+ * @param {object} connobj
  * @returns {Promise<void>}
  */
 const write_connection_config = async (connobj) => {
@@ -290,16 +315,16 @@ const setup_connection = async () => {
 };
 
 /**
- * 
- * @param {object} db 
- * @param {string} tblname 
+ *
+ * @param {object} db
+ * @param {string} tblname
  * @returns {Promise<boolean>}
  */
 const table_exists = async (db, tblname) => {
-  const { rows } = await db.query(`SELECT EXISTS 
+  const { rows } = await db.query(`SELECT EXISTS
     (
         SELECT 1
-        FROM information_schema.tables 
+        FROM information_schema.tables
         WHERE table_schema = 'public'
         AND table_name = '${tblname}'
     );`);
@@ -346,7 +371,7 @@ class SetupCommand extends Command {
    * @returns {Promise<void>}
    */
   async run() {
-    console.log("Run setip");
+    console.log("Run setup");
     const mode = await askDevServer();
     if (mode == "server") {
       // check if i already know how to connect
@@ -367,7 +392,7 @@ class SetupCommand extends Command {
  */
 SetupCommand.description = `Set up a new system
 ...
-This will attempt to install or connect a database, and set up a 
+This will attempt to install or connect a database, and set up a
 configuration file
 `;
 

package/src/common.js

@@ -2,10 +2,11 @@
  * @category saltcorn-cli
  * @module common
  */
-
+// todo need to be reorganized
 /**
- * @param {object} ten
- * @param {function} f
+ * Execute function for specified tenant
+ * @param {object} ten - specified tenant
+ * @param {function} f  - function
  * @returns {Promise<void>}
  */
 const maybe_as_tenant = async (ten, f) => {
@@ -13,7 +14,11 @@ const maybe_as_tenant = async (ten, f) => {
   const db = require("@saltcorn/data/db");
   return await db.runWithTenant(ten, f);
 };
-
+/**
+ * Init specified tenant
+ * @param tenant - specified tenant
+ * @returns {Promise<void>}
+ */
 const init_some_tenants = async (tenant) => {
   const { loadAllPlugins } = require("@saltcorn/server/load_plugins");
   const { init_multi_tenant } = require("@saltcorn/data/db/state");
@@ -24,6 +29,7 @@ const init_some_tenants = async (tenant) => {
 };
 
 /**
+ * parse JSON or String
  * @param {string} s
  * @returns {object}
  */
@@ -36,12 +42,14 @@ const parseJSONorString = (s) => {
 };
 
 /**
- * @param {numer} ms
+ * Sleep ms miliseconds
+ * @param {number} ms
  * @returns {Promise<void>}
  */
 function sleep(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
+
 module.exports = {
   maybe_as_tenant,
   parseJSONorString,

package/src/index.js

@@ -10,7 +10,10 @@
  * @property {module:commands/backup} backup
  * @property {module:commands/create-tenant} create-tenant
  * @property {module:commands/create-user} create-user
+ * @property {module:commands/create-user} delete-tenants
+ * @property {module:commands/create-user} delete-user
  * @property {module:commands/fixtures} fixtures
+ * @property {module:commands/fixtures} get-cfg
  * @property {module:commands/info} info
  * @property {module:commands/install-pack} install-pack
  * @property {module:commands/install-plugin} install-plugin
@@ -18,17 +21,21 @@
  * @property {module:commands/localize-plugin} localize-plugin
  * @property {module:commands/make-migration} make-migration
  * @property {module:commands/migrate} migrate
+ * @property {module:commands/modify-user} modify-user
  * @property {module:commands/plugins} plugins
  * @property {module:commands/release} release
  * @property {module:commands/reset-schema} reset-schema
  * @property {module:commands/restore} restore
  * @property {module:commands/rm-tenant} rm-tenant
  * @property {module:commands/run-benchmark} run-benchmark
+ * @property {module:commands/run-benchmark} run-test
+ * @property {module:commands/setup} scheduler
  * @property {module:commands/setup} setup
+ * @property {module:commands/setup} setup-benchmark
  * @property {module:commands/test-plugin} test-plugin
  * @property {module:commands/transform-field} transform-field
- * 
+ *
  * @category saltcorn-cli
- */ 
+ */
 
 module.exports = require("@oclif/command");

package/CHANGELOG.md

@@ -1,8 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [0.4.5](https://github.com/saltcorn/saltcorn/compare/v0.4.5-beta.1...v0.4.5) (2021-05-07)
-
-**Note:** Version bump only for package @saltcorn/cli