From cf6d02d2b4a5d29fcba7075f90de5c6cdb59995b Mon Sep 17 00:00:00 2001 From: Charles Gagnon Date: Tue, 28 Jul 2020 08:43:10 -0700 Subject: [PATCH] azdata improvements (#11516) * azdata improvements * Don't error on sudo command stderr either * Improve output channel logging for commands * Fix childprocess stuff * pr comments * Fix compile errors * more pr comments --- extensions/azdata/package.json | 1 - extensions/azdata/src/azdata.ts | 35 ++---- extensions/azdata/src/common/childProcess.ts | 47 +++++--- extensions/azdata/src/common/httpClient.ts | 51 ++++++-- extensions/azdata/src/common/promise.ts | 25 ++++ extensions/azdata/src/extension.ts | 30 +++-- extensions/azdata/src/localizedConstants.ts | 10 +- extensions/azdata/src/test/azdata.test.ts | 2 +- .../src/test/common/childProcess.test.ts | 13 +- .../azdata/src/test/common/httpClient.test.ts | 111 +++++++++++++----- .../azdata/src/test/common/promise.test.ts | 30 +++++ extensions/azdata/yarn.lock | 5 - 12 files changed, 255 insertions(+), 105 deletions(-) create mode 100644 extensions/azdata/src/common/promise.ts create mode 100644 extensions/azdata/src/test/common/promise.test.ts diff --git a/extensions/azdata/package.json b/extensions/azdata/package.json index 9711ed0851..fcb2c873f4 100644 --- a/extensions/azdata/package.json +++ b/extensions/azdata/package.json @@ -22,7 +22,6 @@ "dependencies": { "request": "^2.88.2", "sudo-prompt": "^9.2.1", - "uuid": "^8.2.0", "vscode-nls": "^4.1.2", "which": "^2.0.2" }, diff --git a/extensions/azdata/src/azdata.ts b/extensions/azdata/src/azdata.ts index 954917b4f4..eb4d45b938 100644 --- a/extensions/azdata/src/azdata.ts +++ b/extensions/azdata/src/azdata.ts @@ -4,8 +4,6 @@ *--------------------------------------------------------------------------------------------*/ import * as os from 'os'; -import * as path from 'path'; -import * as uuid from 'uuid'; import * as vscode from 'vscode'; import { HttpClient } from './common/httpClient'; import * as loc from './localizedConstants'; @@ -32,9 +30,6 @@ export async function findAzdata(outputChannel: vscode.OutputChannel): Promise { const statusDisposable = vscode.window.setStatusBarMessage(loc.installingAzdata); + outputChannel.show(); outputChannel.appendLine(loc.installingAzdata); try { switch (process.platform) { @@ -62,13 +58,13 @@ export async function downloadAndInstallAzdata(outputChannel: vscode.OutputChann await downloadAndInstallAzdataWin32(outputChannel); break; case 'darwin': - await installAzdataDarwin(); + await installAzdataDarwin(outputChannel); break; case 'linux': await installAzdataLinux(outputChannel); break; default: - throw new Error(`Platform ${process.platform} is unsupported`); + throw new Error(loc.platformUnsupported(process.platform)); } } finally { statusDisposable.dispose(); @@ -80,17 +76,18 @@ export async function downloadAndInstallAzdata(outputChannel: vscode.OutputChann * @param outputChannel Channel used to display diagnostic information */ async function downloadAndInstallAzdataWin32(outputChannel: vscode.OutputChannel): Promise { - const downloadPath = path.join(os.tmpdir(), `azdata-msi-${uuid.v4()}.msi`); - outputChannel.appendLine(loc.downloadingTo('azdata-cli.msi', downloadPath)); - await HttpClient.download(`${azdataHostname}/${azdataUri}`, downloadPath, outputChannel); - await executeCommand('msiexec', ['/i', downloadPath], outputChannel); + const downloadFolder = os.tmpdir(); + const downloadedFile = await HttpClient.download(`${azdataHostname}/${azdataUri}`, downloadFolder, outputChannel); + await executeCommand('msiexec', ['/qn', '/i', downloadedFile], outputChannel); } /** * Runs commands to install azdata on MacOS */ -async function installAzdataDarwin(): Promise { - throw new Error('Not yet implemented'); +async function installAzdataDarwin(outputChannel: vscode.OutputChannel): Promise { + await executeCommand('brew', ['tap', 'microsoft/azdata-cli-release'], outputChannel); + await executeCommand('brew', ['update'], outputChannel); + await executeCommand('brew', ['install', 'azdata-cli'], outputChannel); } /** @@ -104,7 +101,7 @@ async function installAzdataLinux(outputChannel: vscode.OutputChannel): Promise< // Download and install the signing key await executeSudoCommand('curl -sL https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/microsoft.asc.gpg > /dev/null', outputChannel); // Add the azdata repository information - const release = (await executeCommand('lsb_release', ['-rs'], outputChannel)).trim(); + const release = (await executeCommand('lsb_release', ['-rs'], outputChannel)).stdout.trim(); await executeSudoCommand(`add-apt-repository "$(wget -qO- https://packages.microsoft.com/config/ubuntu/${release}/mssql-server-2019.list)"`, outputChannel); // Update repository information and install azdata await executeSudoCommand('apt-get update', outputChannel); @@ -120,14 +117,6 @@ async function findAzdataWin32(outputChannel: vscode.OutputChannel): Promise { - throw new Error('Not yet implemented'); -} - /** * Gets the version using a known azdata path * @param path The path to the azdata executable @@ -137,7 +126,7 @@ async function findSpecificAzdata(path: string, outputChannel: vscode.OutputChan const versionOutput = await executeCommand(path, ['--version'], outputChannel); return { path: path, - version: parseVersion(versionOutput) + version: parseVersion(versionOutput.stdout) }; } diff --git a/extensions/azdata/src/common/childProcess.ts b/extensions/azdata/src/common/childProcess.ts index 0162c89a0b..9a318f2002 100644 --- a/extensions/azdata/src/common/childProcess.ts +++ b/extensions/azdata/src/common/childProcess.ts @@ -9,23 +9,25 @@ import * as sudo from 'sudo-prompt'; import * as loc from '../localizedConstants'; /** - * Wrapper error for when an unexpected exit code was recieved + * Wrapper error for when an unexpected exit code was received */ export class ExitCodeError extends Error { constructor(public code: number) { - super(`Unexpected exit code ${code}`); + super(loc.unexpectedExitCode(code)); } } +export type ProcessOutput = { stdout: string, stderr: string }; + /** * Executes the specified command. Throws an error for a non-0 exit code or if stderr receives output * @param command The command to execute * @param args Optional args to pass, every arg and arg value must be a separate item in the array * @param outputChannel Channel used to display diagnostic information */ -export async function executeCommand(command: string, args?: string[], outputChannel?: vscode.OutputChannel): Promise { +export async function executeCommand(command: string, args: string[], outputChannel: vscode.OutputChannel): Promise { return new Promise((resolve, reject) => { - outputChannel?.appendLine(loc.executingCommand(command, args ?? [])); + outputChannel.appendLine(loc.executingCommand(command, args)); const stdoutBuffers: Buffer[] = []; const stderrBuffers: Buffer[] = []; const child = cp.spawn(command, args, { shell: true }); @@ -33,12 +35,20 @@ export async function executeCommand(command: string, args?: string[], outputCha child.stderr.on('data', (b: Buffer) => stderrBuffers.push(b)); child.on('error', reject); child.on('exit', code => { - if (stderrBuffers.length > 0) { - reject(new Error(Buffer.concat(stderrBuffers).toString('utf8').trim())); - } else if (code) { - reject(new ExitCodeError(code)); + const stdout = Buffer.concat(stdoutBuffers).toString('utf8').trim(); + const stderr = Buffer.concat(stderrBuffers).toString('utf8').trim(); + if (stdout) { + outputChannel.appendLine(loc.stdoutOutput(stdout)); + } + if (stderr) { + outputChannel.appendLine(loc.stdoutOutput(stderr)); + } + if (code) { + const err = new ExitCodeError(code); + outputChannel.appendLine(err.message); + reject(err); } else { - resolve(Buffer.concat(stdoutBuffers).toString('utf8').trim()); + resolve({ stdout: stdout, stderr: stderr }); } }); }); @@ -51,16 +61,23 @@ export async function executeCommand(command: string, args?: string[], outputCha * @param args The additional args * @param outputChannel Channel used to display diagnostic information */ -export async function executeSudoCommand(command: string, outputChannel?: vscode.OutputChannel): Promise { - return new Promise((resolve, reject) => { - outputChannel?.appendLine(loc.executingCommand(`sudo ${command}`, [])); +export async function executeSudoCommand(command: string, outputChannel: vscode.OutputChannel): Promise { + return new Promise((resolve, reject) => { + outputChannel.appendLine(loc.executingCommand(`sudo ${command}`, [])); sudo.exec(command, { name: vscode.env.appName }, (error, stdout, stderr) => { + stdout = stdout?.toString() ?? ''; + stderr = stderr?.toString() ?? ''; + if (stdout) { + outputChannel.appendLine(loc.stdoutOutput(stdout)); + } + if (stderr) { + outputChannel.appendLine(loc.stdoutOutput(stderr)); + } if (error) { + outputChannel.appendLine(loc.unexpectedCommandError(error.message)); reject(error); - } else if (stderr) { - reject(stderr.toString('utf8')); } else { - resolve(stdout ? stdout.toString('utf8') : ''); + resolve({ stdout: stdout, stderr: stderr }); } }); }); diff --git a/extensions/azdata/src/common/httpClient.ts b/extensions/azdata/src/common/httpClient.ts index 8d006b3cf9..555ed05906 100644 --- a/extensions/azdata/src/common/httpClient.ts +++ b/extensions/azdata/src/common/httpClient.ts @@ -6,6 +6,7 @@ import * as vscode from 'vscode'; import * as fs from 'fs'; import * as request from 'request'; +import * as path from 'path'; import * as loc from '../localizedConstants'; const DownloadTimeout = 20000; @@ -13,12 +14,13 @@ const DownloadTimeout = 20000; export namespace HttpClient { /** - * Downloads a file from the given URL + * Downloads a file from the given URL, resolving to the full path of the downloaded file when complete * @param downloadUrl The URL to download the file from - * @param targetPath The path to download the file to + * @param targetFolder The folder to download the file to * @param outputChannel Channel used to display diagnostic information + * @returns Full path to the downloaded file */ - export function download(downloadUrl: string, targetPath: string, outputChannel: vscode.OutputChannel): Promise { + export function download(downloadUrl: string, targetFolder: string, outputChannel: vscode.OutputChannel): Promise { return new Promise((resolve, reject) => { let totalMegaBytes: number | undefined = undefined; let receivedBytes = 0; @@ -35,6 +37,20 @@ export namespace HttpClient { outputChannel.appendLine(response.statusMessage); return reject(response.statusMessage); } + const filename = path.basename(response.request.path); + const targetPath = path.join(targetFolder, filename); + outputChannel.appendLine(loc.downloadingTo(filename, targetPath)); + // Wait to create the WriteStream until here so we can use the actual + // filename based off of the URI. + downloadRequest.pipe(fs.createWriteStream(targetPath)) + .on('close', async () => { + outputChannel.appendLine(loc.downloadFinished); + resolve(targetPath); + }) + .on('error', (downloadError) => { + reject(downloadError); + downloadRequest.abort(); + }); let contentLength = response.headers['content-length']; let totalBytes = parseInt(contentLength || '0'); totalMegaBytes = totalBytes / (1024 * 1024); @@ -51,14 +67,29 @@ export namespace HttpClient { } } }); - downloadRequest.pipe(fs.createWriteStream(targetPath)) - .on('close', async () => { - outputChannel.appendLine(loc.downloadFinished); - resolve(); - }) - .on('error', (downloadError) => { + }); + } + + /** + * Gets the filename for the specified URL - following redirects as needed + * @param url The URL to get the filename of + */ + export async function getFilename(url: string, outputChannel: vscode.OutputChannel): Promise { + outputChannel.appendLine(loc.gettingFilenameOfUrl(url)); + return new Promise((resolve, reject) => { + let httpRequest = request.get(url, { timeout: DownloadTimeout }) + .on('error', downloadError => { reject(downloadError); - downloadRequest.abort(); + }) + .on('response', (response) => { + if (response.statusCode !== 200) { + return reject(response.statusMessage); + } + // We don't want to actually download the file so abort the request now + httpRequest.abort(); + const filename = path.basename(response.request.path); + outputChannel.appendLine(loc.gotFilenameOfUrl(response.request.path, filename)); + resolve(filename); }); }); } diff --git a/extensions/azdata/src/common/promise.ts b/extensions/azdata/src/common/promise.ts new file mode 100644 index 0000000000..53f62a287b --- /dev/null +++ b/extensions/azdata/src/common/promise.ts @@ -0,0 +1,25 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the Source EULA. See License.txt in the project root for license information. + *--------------------------------------------------------------------------------------------*/ + +/** + * Deferred promise + */ +export class Deferred { + promise: Promise; + resolve!: (value?: T | PromiseLike) => void; + reject!: (reason?: any) => void; + constructor() { + this.promise = new Promise((resolve, reject) => { + this.resolve = resolve; + this.reject = reject; + }); + } + + then(onfulfilled?: (value: T) => TResult | Thenable, onrejected?: (reason: any) => TResult | Thenable): Thenable; + then(onfulfilled?: (value: T) => TResult | Thenable, onrejected?: (reason: any) => void): Thenable; + then(onfulfilled?: (value: T) => TResult | Thenable, onrejected?: (reason: any) => TResult | Thenable): Thenable { + return this.promise.then(onfulfilled, onrejected); + } +} diff --git a/extensions/azdata/src/extension.ts b/extensions/azdata/src/extension.ts index 9851fcc561..1ed819047e 100644 --- a/extensions/azdata/src/extension.ts +++ b/extensions/azdata/src/extension.ts @@ -10,9 +10,7 @@ import { ExitCodeError } from './common/childProcess'; export async function activate(): Promise { const outputChannel = vscode.window.createOutputChannel('azdata'); - if (false) { - await checkForAzdata(outputChannel); - } + await checkForAzdata(outputChannel); } async function checkForAzdata(outputChannel: vscode.OutputChannel): Promise { @@ -20,16 +18,22 @@ async function checkForAzdata(outputChannel: vscode.OutputChannel): Promise console.log(`Unexpected error prompting to install azdata ${e}`)); + } +} + +async function promptToInstallAzdata(outputChannel: vscode.OutputChannel): Promise { + const response = await vscode.window.showErrorMessage(loc.couldNotFindAzdataWithPrompt, loc.install, loc.cancel); + if (response === loc.install) { + try { + await downloadAndInstallAzdata(outputChannel); + vscode.window.showInformationMessage(loc.azdataInstalled); + } catch (err) { + // Windows: 1602 is User Cancelling installation - not unexpected so don't display + if (!(err instanceof ExitCodeError) || err.code !== 1602) { + vscode.window.showWarningMessage(loc.installError(err)); } } } diff --git a/extensions/azdata/src/localizedConstants.ts b/extensions/azdata/src/localizedConstants.ts index 8372fe1d18..6f325578c1 100644 --- a/extensions/azdata/src/localizedConstants.ts +++ b/extensions/azdata/src/localizedConstants.ts @@ -15,8 +15,16 @@ export const installingAzdata = localize('azdata.installingAzdata', "Installing export const azdataInstalled = localize('azdata.azdataInstalled', "azdata was successfully installed. Restarting Azure Data Studio is required to complete configuration - features will not be activated until this is done."); export const cancel = localize('azdata.cancel', "Cancel"); export function downloadingTo(name: string, location: string): string { return localize('azdata.downloadingTo', "Downloading {0} to {1}", name, location); } +export function executingCommand(command: string, args: string[]): string { return localize('azdata.executingCommand', "Executing command \"{0} {1}\"", command, args?.join(' ')); } +export function stdoutOutput(stdout: string): string { return localize('azdat.stdoutOutput', "stdout : {0}", stdout); } +export function stderrOutput(stderr: string): string { return localize('azdat.stderrOutput', "stderr : {0}", stderr); } +export function gettingFilenameOfUrl(url: string): string { return localize('azdata.gettingFilenameOfUrl', "Getting filename of resource at URL {0}", url); } +export function gotFilenameOfUrl(url: string, filename: string): string { return localize('azdata.gotFilenameOfUrl', "Got filename {0} from URL {1}", filename, url); } + export function couldNotFindAzdata(err: any): string { return localize('azdata.couldNotFindAzdata', "Could not find azdata. Error : {0}", err.message ?? err); } export const couldNotFindAzdataWithPrompt = localize('azdata.couldNotFindAzdataWithPrompt', "Could not find azdata, install it now? If not then some features will not be able to function."); export const downloadError = localize('azdata.downloadError', "Error while downloading"); export function installError(err: any): string { return localize('azdata.installError', "Error installing azdata : {0}", err.message ?? err); } -export function executingCommand(command: string, args: string[]): string { return localize('azdata.executingCommand', "Executing command \"{0} {1}\"", command, args?.join(' ')); } +export function platformUnsupported(platform: string): string { return localize('azdata.platformUnsupported', "Platform '{0}' is currently unsupported", platform); } +export function unexpectedCommandError(errMsg: string): string { return localize('azdata.unexpectedCommandError', "Unexpected error executing command : {0}", errMsg); } +export function unexpectedExitCode(code: number): string { return localize('azdata.unexpectedExitCode', "Unexpected exit code from command : {0}", code); } diff --git a/extensions/azdata/src/test/azdata.test.ts b/extensions/azdata/src/test/azdata.test.ts index 0af94bfd03..4206cc18c8 100644 --- a/extensions/azdata/src/test/azdata.test.ts +++ b/extensions/azdata/src/test/azdata.test.ts @@ -27,7 +27,7 @@ describe('azdata', function () { describe('findAzdata', function () { // Mock call to --version to simulate azdata being installed - sinon.stub(childProcess, 'executeCommand').returns(Promise.resolve('v1.0.0')); + sinon.stub(childProcess, 'executeCommand').returns(Promise.resolve({ stdout: 'v1.0.0', stderr: '' })); it('successful', async function (): Promise { sinon.stub(utils, 'searchForCmd').returns(Promise.resolve('C:\\path\\to\\azdata.cmd')); await should(azdata.findAzdata(outputChannelMock.object)).not.be.rejected(); diff --git a/extensions/azdata/src/test/common/childProcess.test.ts b/extensions/azdata/src/test/common/childProcess.test.ts index 08925f7af0..fc03995288 100644 --- a/extensions/azdata/src/test/common/childProcess.test.ts +++ b/extensions/azdata/src/test/common/childProcess.test.ts @@ -9,21 +9,22 @@ import * as TypeMoq from 'typemoq'; import { executeCommand } from '../../common/childProcess'; describe('ChildProcess', function () { - [undefined, [], ['test']].forEach(args => { + const outputChannelMock = TypeMoq.Mock.ofType(); + + [[], ['test']].forEach(args => { it(`Output channel is used with ${JSON.stringify(args)} args`, async function (): Promise { - const outputChannelMock = TypeMoq.Mock.ofType(); await executeCommand('echo', args, outputChannelMock.object); - outputChannelMock.verify(x => x.appendLine(TypeMoq.It.isAny()), TypeMoq.Times.once()); + outputChannelMock.verify(x => x.appendLine(TypeMoq.It.isAny()), TypeMoq.Times.atLeastOnce()); }); }); it('Gets expected output', async function (): Promise { const echoOutput = 'test'; - const output = await executeCommand('echo', [echoOutput]); - should(output).equal(echoOutput); + const output = await executeCommand('echo', [echoOutput], outputChannelMock.object); + should(output.stdout).equal(echoOutput); }); it('Invalid command errors', async function (): Promise { - await should(executeCommand('sdfkslkf')).be.rejected(); + await should(executeCommand('invalid_command', [], outputChannelMock.object)).be.rejected(); }); }); diff --git a/extensions/azdata/src/test/common/httpClient.test.ts b/extensions/azdata/src/test/common/httpClient.test.ts index 9b2bcc9a5a..0c7f108a12 100644 --- a/extensions/azdata/src/test/common/httpClient.test.ts +++ b/extensions/azdata/src/test/common/httpClient.test.ts @@ -7,15 +7,14 @@ import * as vscode from 'vscode'; import * as should from 'should'; import * as TypeMoq from 'typemoq'; import { HttpClient } from '../../common/httpClient'; -import * as path from 'path'; import * as os from 'os'; import * as fs from 'fs'; -import * as uuid from 'uuid'; import * as nock from 'nock'; import * as sinon from 'sinon'; import { PassThrough } from 'stream'; +import { Deferred } from '../../common/promise'; -describe('HttpClient', function () { +describe('HttpClient', function (): void { let outputChannelMock: TypeMoq.IMock; @@ -28,36 +27,88 @@ describe('HttpClient', function () { nock.enableNetConnect(); }); - it('downloads file successfully', async function (): Promise { - const downloadPath = path.join(os.tmpdir(), `azdata-httpClientTest-${uuid.v4()}.txt`); - await HttpClient.download('https://raw.githubusercontent.com/microsoft/azuredatastudio/main/README.md', downloadPath, outputChannelMock.object); - // Verify file was downloaded correctly - await fs.promises.stat(downloadPath); + describe('download', function(): void { + it('downloads file successfully', async function (): Promise { + nock('https://127.0.0.1') + .get('/README.md') + .replyWithFile(200, __filename); + const downloadFolder = os.tmpdir(); + const downloadPath = await HttpClient.download('https://127.0.0.1/README.md', downloadFolder, outputChannelMock.object); + // Verify file was downloaded correctly + await fs.promises.stat(downloadPath); + }); + + it('errors on response stream error', async function (): Promise { + const downloadFolder = os.tmpdir(); + nock('https://127.0.0.1') + .get('/') + .replyWithError('Unexpected Error'); + const downloadPromise = HttpClient.download('https://127.0.0.1', downloadFolder, outputChannelMock.object); + + await should(downloadPromise).be.rejected(); + }); + + it('rejects on non-OK status code', async function (): Promise { + const downloadFolder = os.tmpdir(); + nock('https://127.0.0.1') + .get('/') + .reply(404, ''); + const downloadPromise = HttpClient.download('https://127.0.0.1', downloadFolder, outputChannelMock.object); + + await should(downloadPromise).be.rejected(); + }); + + it('errors on write stream error', async function (): Promise { + const downloadFolder = os.tmpdir(); + const mockWriteStream = new PassThrough(); + const deferredPromise = new Deferred(); + sinon.stub(fs, 'createWriteStream').callsFake(() => { + deferredPromise.resolve(); + return mockWriteStream; + }); + nock('https://127.0.0.1') + .get('/') + .reply(200, ''); + const downloadPromise = HttpClient.download('https://127.0.0.1', downloadFolder, outputChannelMock.object); + // Wait for the stream to be created before throwing the error or HttpClient will miss the event + await deferredPromise; + try { + // Passthrough streams will throw the error we emit so just no-op and + // let the HttpClient handler handle the error + mockWriteStream.emit('error', 'Unexpected write error'); + } catch (err) { } + await should(downloadPromise).be.rejected(); + }); }); - it('errors on response stream error', async function (): Promise { - const downloadPath = path.join(os.tmpdir(), `azdata-httpClientTest-error-${uuid.v4()}.txt`); - nock('https://127.0.0.1') - .get('/') - .replyWithError('Unexpected Error'); - const downloadPromise = HttpClient.download('https://127.0.0.1', downloadPath, outputChannelMock.object); + describe('getFilename', function(): void { + it('Gets filename correctly', async function (): Promise { + const filename = 'azdata-cli-20.0.0.msi'; + nock('https://127.0.0.1') + .get(`/${filename}`) + .reply(200); + const receivedFilename = await HttpClient.getFilename(`https://127.0.0.1/${filename}`, outputChannelMock.object); - await should(downloadPromise).be.rejected(); + should(receivedFilename).equal(filename); + }); + + it('errors on response error', async function (): Promise { + nock('https://127.0.0.1') + .get('/') + .replyWithError('Unexpected Error'); + const getFilenamePromise = HttpClient.getFilename('https://127.0.0.1', outputChannelMock.object); + + await should(getFilenamePromise).be.rejected(); + }); + + it('rejects on non-OK status code', async function (): Promise { + nock('https://127.0.0.1') + .get('/') + .reply(404, ''); + const getFilenamePromise = HttpClient.getFilename('https://127.0.0.1', outputChannelMock.object); + + await should(getFilenamePromise).be.rejected(); + }); }); - it('errors on write stream error', async function (): Promise { - const downloadPath = path.join(os.tmpdir(), `azdata-httpClientTest-error-${uuid.v4()}.txt`); - const mockWriteStream = new PassThrough(); - sinon.stub(fs, 'createWriteStream').returns(mockWriteStream); - nock('https://127.0.0.1') - .get('/') - .reply(200, ''); - const downloadPromise = HttpClient.download('https://127.0.0.1', downloadPath, outputChannelMock.object); - try { - // Passthrough streams will throw the error we emit so just no-op and - // let the HttpClient handler handle the error - mockWriteStream.emit('error', 'Unexpected write error'); - } catch (err) { } - await should(downloadPromise).be.rejected(); - }); }); diff --git a/extensions/azdata/src/test/common/promise.test.ts b/extensions/azdata/src/test/common/promise.test.ts new file mode 100644 index 0000000000..32247b9607 --- /dev/null +++ b/extensions/azdata/src/test/common/promise.test.ts @@ -0,0 +1,30 @@ +/*--------------------------------------------------------------------------------------------- + * Copyright (c) Microsoft Corporation. All rights reserved. + * Licensed under the Source EULA. See License.txt in the project root for license information. + *--------------------------------------------------------------------------------------------*/ + +import * as should from 'should'; +import { Deferred } from '../../common/promise'; + +describe('DeferredPromise', function (): void { + + it('Resolves correctly', async function(): Promise { + const deferred = new Deferred(); + deferred.resolve(); + await should(deferred.promise).be.resolved(); + }); + + it('Rejects correctly', async function(): Promise { + const deferred = new Deferred(); + deferred.reject(); + await should(deferred.promise).be.rejected(); + }); + + it('Chains then correctly', function(done): void { + const deferred = new Deferred(); + deferred.then( () => { + done(); + }); + deferred.resolve(); + }); +}); diff --git a/extensions/azdata/yarn.lock b/extensions/azdata/yarn.lock index 1736cccc24..0019b31838 100644 --- a/extensions/azdata/yarn.lock +++ b/extensions/azdata/yarn.lock @@ -1242,11 +1242,6 @@ uuid@^3.3.2: resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.4.0.tgz#b23e4358afa8a202fe7a100af1f5f883f02007ee" integrity sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A== -uuid@^8.2.0: - version "8.2.0" - resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.2.0.tgz#cb10dd6b118e2dada7d0cd9730ba7417c93d920e" - integrity sha512-CYpGiFTUrmI6OBMkAdjSDM0k5h8SkkiTP4WAjQgDgNB1S3Ou9VBEvr6q0Kv2H1mMk7IWfxYGpMH5sd5AvcIV2Q== - verror@1.10.0: version "1.10.0" resolved "https://registry.yarnpkg.com/verror/-/verror-1.10.0.tgz#3a105ca17053af55d6e270c1f8288682e18da400"