Merge pull request #1748 from jumpserver/pr@dev@feat_dm_db_client

feat: support Dameng local database clients

Author: Aaron3S

electron/src/apps/local-app-launcher.ts

@@ -47,6 +47,7 @@ function dbxUrl(payload) {
 }
 
 function valuesFor(payload): Record<string, string> {
+  const dmConnection = `${username(payload)}/${String(payload.token?.value || "")}@${String(payload.endpoint?.host || "")}:${String(payload.endpoint?.port || "")}`;
   return {
     name: sanitizedName(payload.name),
     protocol: payload.protocol,
@@ -55,6 +56,7 @@ function valuesFor(payload): Record<string, string> {
     host: String(payload.endpoint?.host || ""),
     port: String(payload.endpoint?.port || ""),
     dbname: payload.protocol === "oracle" ? username(payload) : String(payload.asset?.info?.db_name || ""),
+    dameng_disql: shellQuote(dmConnection),
     dbeaver_protocol: payload.protocol === "sqlserver" ? "mssql_jdbc_ms_new" : payload.protocol,
     dbx_url: dbxUrl(payload),
     url: navicatUrl(payload)

electron/tests/application-config.test.ts

@@ -139,6 +139,89 @@ for (const platform of ["macos", "linux", "windows"]) {
   });
 }
 
+for (const platform of ["macos", "linux", "windows"]) {
+  test(`${platform} offers DBeaver for Dameng and launches its native driver`, async (context) => {
+    const appData = await mkdtemp(path.join(os.tmpdir(), "jms-dameng-dbeaver-"));
+    context.after(() => rm(appData, { recursive: true, force: true }));
+    const app = { getPath: () => appData, isPackaged: false };
+    const service = new ApplicationConfigService(app, projectRoot);
+    service.builtInDir = async () => path.join(projectRoot, "plugins", platform);
+    await service.initialize();
+    await service.updateSelection({
+      category: "databases",
+      protocol: "dameng",
+      name: "dbeaver",
+      pluginId: undefined,
+      path: process.execPath
+    });
+    await service.updateSelection({
+      category: "databases",
+      protocol: "dameng",
+      name: "dbeaver",
+      pluginId: undefined,
+      path: undefined,
+      makeDefault: true
+    });
+    const application = (await service.getConfig()).databases.find((item) => item.name === "dbeaver");
+    assert.ok(application?.protocol.includes("dameng"));
+    assert.ok(application.match_first.includes("dameng"));
+
+    const launcher = new LocalApplicationLauncher(app, projectRoot, service, null);
+    let launched = false;
+    launcher.launchExecutable = async (selected, argumentString) => {
+      assert.equal(selected.name, "dbeaver");
+      assert.deepEqual(localAppLauncherInternals.splitArguments(argumentString), [
+        "-con",
+        "name=Dameng|driver=dameng|user=token-id|password=secret|host=gateway.example.com|port=5525|save=false|connect=true"
+      ]);
+      launched = true;
+    };
+    const payload = {
+      protocol: "dameng",
+      name: "Dameng",
+      endpoint: { host: "gateway.example.com", port: 5525 },
+      token: { id: "token-id", value: "secret" },
+      asset: { info: { db_name: "business" } }
+    };
+    await launcher.launch(`jms2://${Buffer.from(JSON.stringify(payload)).toString("base64")}`);
+    assert.equal(launched, true);
+  });
+}
+
+for (const platform of ["macos", "linux"]) {
+  test(`${platform} offers a shell-safe Dameng disql launch`, async (context) => {
+    const appData = await mkdtemp(path.join(os.tmpdir(), "jms-dameng-disql-"));
+    context.after(() => rm(appData, { recursive: true, force: true }));
+    const app = { getPath: () => appData, isPackaged: false };
+    const service = new ApplicationConfigService(app, projectRoot);
+    service.builtInDir = async () => path.join(projectRoot, "plugins", platform);
+    await service.initialize();
+    await service.updateSelection({
+      category: "databases",
+      protocol: "dameng",
+      name: "terminal",
+      pluginId: undefined,
+      path: undefined,
+      makeDefault: true
+    });
+    const launcher = new LocalApplicationLauncher(app, projectRoot, service, null);
+    let launched = false;
+    launcher.launchTerminal = async (selected, command) => {
+      assert.equal(selected.name, "terminal");
+      assert.equal(command, "disql 'token-id/p'\\''a&b@gateway.example.com:5525'");
+      launched = true;
+    };
+    const payload = {
+      protocol: "dameng",
+      name: "Dameng",
+      endpoint: { host: "gateway.example.com", port: 5525 },
+      token: { id: "token-id", value: "p'a&b" }
+    };
+    await launcher.launch(`jms2://${Buffer.from(JSON.stringify(payload)).toString("base64")}`);
+    assert.equal(launched, true);
+  });
+}
+
 for (const [platform, protocol, expectedClient] of [
   ["macos", "ssh", "terminal"],
   ["linux", "ssh", "terminal"],

plugins/linux/linux.dbeaver/connect.json

@@ -11,7 +11,10 @@
   },
   "launch": {
     "type": "args",
-    "template": "-con name={name}|driver={dbeaver_protocol}|user={username}|password={value}|database={dbname}|host={host}|port={port}|save=false|connect=true"
+    "template": "-con name={name}|driver={dbeaver_protocol}|user={username}|password={value}|database={dbname}|host={host}|port={port}|save=false|connect=true",
+    "protocol_templates": {
+      "dameng": "-con name={name}|driver=dameng|user={username}|password={value}|host={host}|port={port}|save=false|connect=true"
+    }
   },
   "display_name": "DBeaver Community"
 }

plugins/linux/linux.dbeaver/manifest.json

@@ -12,6 +12,7 @@
     "mariadb",
     "mysql",
     "oracle",
+    "dameng",
     "postgresql",
     "sqlserver"
   ],

plugins/linux/linux.terminal-db/connect.json

@@ -15,6 +15,7 @@
     "protocol_templates": {
       "redis": "redis-cli -h {host} -p {port} -a {username}@{value}",
       "oracle": "sqlplus {username}/{value}@{host}:{port}/{dbname}",
+      "dameng": "disql {dameng_disql}",
       "postgresql": "psql 'user={username} password={value} host={host} dbname={dbname} port={port}'",
       "mysql": "mysql -u {username} -p{value} -h {host} -P {port} {dbname}",
       "mariadb": "mysql -u {username} -p{value} -h {host} -P {port} {dbname}",

plugins/linux/linux.terminal-db/manifest.json

@@ -13,6 +13,7 @@
     "mongodb",
     "mysql",
     "oracle",
+    "dameng",
     "postgresql",
     "redis",
     "sqlserver"

plugins/macos/macos.dbeaver/connect.json

@@ -11,7 +11,10 @@
   },
   "launch": {
     "type": "args",
-    "template": "-con name={name}|driver={dbeaver_protocol}|user={username}|password={value}|database={dbname}|host={host}|port={port}|save=false|connect=true"
+    "template": "-con name={name}|driver={dbeaver_protocol}|user={username}|password={value}|database={dbname}|host={host}|port={port}|save=false|connect=true",
+    "protocol_templates": {
+      "dameng": "-con name={name}|driver=dameng|user={username}|password={value}|host={host}|port={port}|save=false|connect=true"
+    }
   },
   "display_name": "DBeaver Community"
 }

plugins/macos/macos.dbeaver/manifest.json

@@ -12,6 +12,7 @@
     "mariadb",
     "mysql",
     "oracle",
+    "dameng",
     "postgresql",
     "sqlserver"
   ],

plugins/macos/macos.terminal-db/connect.json

@@ -16,6 +16,7 @@
     "protocol_templates": {
       "redis": "redis-cli -h {host} -p {port} -a {username}@{value}",
       "oracle": "sqlplus {username}/{value}@{host}:{port}/{dbname}",
+      "dameng": "disql {dameng_disql}",
       "postgresql": "psql 'user={username} password={value} host={host} dbname={dbname} port={port}'",
       "mysql": "mysql -u {username} -p{value} -h {host} -P {port} {dbname}",
       "mariadb": "mysql -u {username} -p{value} -h {host} -P {port} {dbname}",

plugins/macos/macos.terminal-db/manifest.json

@@ -13,6 +13,7 @@
     "mongodb",
     "mysql",
     "oracle",
+    "dameng",
     "postgresql",
     "redis",
     "sqlserver"