Add ADS Windows support extension with LaunchSsmsDialog command (#4248)

* ADS Windows support extension with LaunchSsmsDialog command * Update readme * Fix spacing * Update download with new file location and name * Update SsmsMin package with bits from latest RC build and addressed some comments. * Update extension name. Add Context menu extension for launching server properties dialog. Remove params interface from public API * Rename folder and update README * Correct README title * Fix a few issues and clean up some stuff. * Update to azdata namespace * Refactor to use async/await and add some more telemetry * Add .bat for running extension tests (currently only Notebook) and set up launch.json with 2 new launch configs for running & debugging extension tests. * Rename files to make it clear these aren't the integration tests * Update launch.config too * Fix spacing and missed file name update * Fix some bugs in buildSsmsMinCommandArgs and add unit tests
2026-02-16 10:58:30 -05:00 · 2019-03-25 14:19:11 -07:00
parent ef1f72f69b
commit b27417da41
19 changed files with 3201 additions and 0 deletions
--- a/extensions/admin-tool-ext-win/src/main.ts
+++ b/extensions/admin-tool-ext-win/src/main.ts
@@ -0,0 +1,144 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+///
+'use strict';
+
+import * as nls from 'vscode-nls';
+import * as path from 'path';
+import * as shelljs from 'shelljs';
+import * as azdata from 'azdata';
+import * as vscode from 'vscode';
+import { IConfig, ServerProvider } from 'service-downloader';
+import { Telemetry } from './telemetry';
+import * as utils from './utils';
+
+const baseConfig = require('./config.json');
+const localize = nls.loadMessageBundle();
+let exePath:string;
+
+// Params to pass to SsmsMin.exe, only an action and server are required - the rest are optional based on the
+// action used. Exported for use in testing.
+export interface LaunchSsmsDialogParams {
+    action: string;
+    server: string;
+    database?: string;
+    user?: string;
+    password?: string;
+    useAad?: boolean;
+    urn?: string;
+}
+
+export async function activate(context: vscode.ExtensionContext): Promise<void> {
+    Telemetry.sendTelemetryEvent('startup/ExtensionActivated');
+
+    // Only supported on Win32 currently, display error message if not that until extensions are able to block install
+    // based on conditions
+    if(process.platform === 'win32') {
+        let config: IConfig = JSON.parse(JSON.stringify(baseConfig));
+        config.installDirectory = path.join(context.extensionPath, config.installDirectory);
+        config.proxy = utils.getConfiguration('http').get('proxy');
+        config.strictSSL = utils.getConfiguration('http').get('proxyStrictSSL') || true;
+
+        const serverdownloader = new ServerProvider(config);
+        const installationStart = Date.now();
+
+        try {
+            let downloadedExePath = await serverdownloader.getOrDownloadServer();
+            const installationComplete = Date.now();
+
+            // Don't register the command if we couldn't find the EXE since it won't be able to do anything
+            if(downloadedExePath) {
+                exePath = downloadedExePath;
+            } else {
+                throw new Error('Could not find SsmsMin.exe after downloading');
+            }
+            // Add the command now that we have the exePath to run the tool with
+            context.subscriptions.push(
+                vscode.commands.registerCommand('adminToolExtWin.launchSsmsServerPropertiesDialog', handleLaunchSsmsServerPropertiesDialogCommand));
+
+            Telemetry.sendTelemetryEvent('startup/ExtensionStarted', {
+                installationTime: String(installationComplete - installationStart),
+                beginningTimestamp: String(installationStart)
+            });
+        }
+        catch(err) {
+            Telemetry.sendTelemetryEvent('startup/ExtensionInitializationFailed', {
+                error: err
+            });
+        }
+    } else {
+        vscode.window.showErrorMessage(localize('adminToolExtWin.onlySupportedOnWindows', 'The Admin Tool Extension is only supported on Windows platforms.'));
+    }
+}
+
+/**
+ * Handler for command to launch SSMS Server Properties dialog
+ * @param connectionId The connection context from the command
+ */
+function handleLaunchSsmsServerPropertiesDialogCommand(connectionContext?: azdata.ObjectExplorerContext) {
+    if(connectionContext && connectionContext.connectionProfile) {
+        launchSsmsDialog(
+            /*action*/'sqla:Properties@Microsoft.SqlServer.Management.Smo.Server',
+            /*connectionProfile*/connectionContext.connectionProfile);
+    }
+}
+
+/**
+ * Launches SsmsMin with parameters from the specified connection
+ * @param action The action to launch
+ * @param params The params used to construct the command
+ * @param urn The URN to pass to SsmsMin
+ */
+function launchSsmsDialog(action:string, connectionProfile: azdata.IConnectionProfile, urn?:string) {
+    if(!exePath) {
+        vscode.window.showErrorMessage(localize('adminToolExtWin.noExeError', 'Unable to find SsmsMin.exe.'));
+        return;
+    }
+
+    Telemetry.sendTelemetryEvent('LaunchSsmsDialog', { 'action': action});
+
+    let params:LaunchSsmsDialogParams = {
+        action:action,
+        server:connectionProfile.serverName,
+        database:connectionProfile.databaseName,
+        password:connectionProfile.password,
+        user:connectionProfile.userName,
+        useAad:connectionProfile.authenticationType === 'AzureMFA',
+        urn: urn};
+    let args = buildSsmsMinCommandArgs(params);
+
+    // This will be an async call since we pass in the callback
+    var proc = shelljs.exec(
+       /*command*/`"${exePath}" ${args}`,
+       /*options*/'',
+       (code, stdout, stderr) => {
+           Telemetry.sendTelemetryEvent('LaunchSsmsDialogResult', {
+               'action': params.action,
+               'returnCode': code,
+               'error': stderr
+           });
+
+            // If we're not using AAD the tool prompts for a password on stdin
+            if(params.useAad !== true) {
+                proc.stdin.end(params.password ? params.password : '');
+            }
+       });
+
+}
+
+/**
+ * Builds the command arguments to pass to SsmsMin.exe. Values are expected to be escaped correctly
+ * already per their - they will be further escaped * for command-line usage but no additional
+ * escaping will occur.
+ * @param params The params used to build up the command parameter string
+ */
+export function buildSsmsMinCommandArgs(params:LaunchSsmsDialogParams): string {
+    return `${params.action ? '-a "' + params.action.replace(/"/g, '\\"') + '"' : ''}\
+${params.server ? ' -S "' + params.server.replace(/"/g, '\\"') + '"' : ''}\
+${params.database ? ' -D "' + params.database.replace(/"/g, '\\"') + '"' : ''}\
+${params.useAad !== true && params.user ? ' -U "' + params.user.replace(/"/g, '\\"') + '"' : ''}\
+${params.useAad === true ? ' -G': ''}\
+${params.urn ? ' -u "' + params.urn.replace(/"/g, '\\"') + '"' : ''}`;
+}