Changes to discover and perform azdata update (#11906)

* WIP * first version with working tests * fixes needed after merge from main * Linux untest changes and merge from other changes from mac * after testing getTextContent * rename 2 methods * linux discovery * tested code on linux * using release.json for update discovery on linux * comment added * dead code removed * coomments * revert unrelated change * revert testing changes * PR feedback * remove SendOutputChannelToConsole * cleanup * pr feedback * PR Feedback * pr feedback * pr feedback * merge from main * merge from main * cleanup and pr feedback * pr feedback * pr feedback. * pr feedback Co-authored-by: chgagnon <chgagnon@microsoft.com>
2026-02-16 18:46:40 -05:00 · 2020-08-27 13:25:54 -07:00
parent b715e6ed82
commit 00c7600b05
10 changed files with 521 additions and 148 deletions
--- a/extensions/azdata/src/test/azdata.test.ts
+++ b/extensions/azdata/src/test/azdata.test.ts
@@ -3,29 +3,30 @@
 *  Licensed under the Source EULA. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

-import * as azdata from '../azdata';
-import * as sinon from 'sinon';
-import * as childProcess from '../common/childProcess';
+import * as path from 'path';
+import { SemVer } from 'semver';
 import * as should from 'should';
+import * as sinon from 'sinon';
+import * as vscode from 'vscode';
+import * as azdata from '../azdata';
+import * as childProcess from '../common/childProcess';
+import { HttpClient } from '../common/httpClient';
 import * as utils from '../common/utils';
-import * as nock from 'nock';
+import * as loc from '../localizedConstants';
+
+const oldAzdataMock = <azdata.AzdataTool>{path:'/path/to/azdata', cachedVersion: new SemVer('0.0.0')};

 describe('azdata', function () {
-
 	afterEach(function (): void {
 		sinon.restore();
-		nock.cleanAll();
-		nock.enableNetConnect();
 	});

 	describe('findAzdata', function () {
 		it('successful', async function (): Promise<void> {
-			if (process.platform === 'win32') {
-				// Mock searchForCmd to return a path to azdata.cmd
-				sinon.stub(utils, 'searchForCmd').returns(Promise.resolve('C:\\path\\to\\azdata.cmd'));
-			}
+			// Mock searchForCmd to return a path to azdata.cmd
+			sinon.stub(utils, 'searchForCmd').returns(Promise.resolve('/path/to/azdata'));
 			// Mock call to --version to simulate azdata being installed
-			sinon.stub(childProcess, 'executeCommand').returns(Promise.resolve({ stdout: 'v1.0.0', stderr: '' }));
+			sinon.stub(childProcess, 'executeCommand').returns(Promise.resolve({ stdout: '1.0.0', stderr: '' }));
 			await should(azdata.findAzdata()).not.be.rejected();
 		});
 		it('unsuccessful', async function (): Promise<void> {
@@ -40,26 +41,221 @@ describe('azdata', function () {
 		});
 	});

-	// TODO: Install not implemented on linux yet
-	describe('downloadAndInstallAzdata', function (): void {
-		it('successful download & install', async function (): Promise<void> {
-			sinon.stub(childProcess, 'executeCommand').returns(Promise.resolve({ stdout: '', stderr: '' }));
-			if (process.platform === 'linux') {
-				sinon.stub(childProcess, 'executeSudoCommand').returns(Promise.resolve({ stdout: '', stderr: '' }));
+	describe('installAzdata', function (): void {
+		it('successful install', async function (): Promise<void> {
+			switch (process.platform) {
+				case 'win32':
+					await testWin32SuccessfulInstall();
+					break;
+				case 'darwin':
+					await testDarwinSuccessfulInstall();
+					break;
+				case 'linux':
+					await testLinuxSuccessfulInstall();
+					break;
 			}
-			nock(azdata.azdataHostname)
-				.get(`/${azdata.azdataUri}`)
-				.replyWithFile(200, __filename);
-			const downloadPromise = azdata.downloadAndInstallAzdata();
-			await downloadPromise;
 		});

-		it('errors on unsuccessful download', async function (): Promise<void> {
-			nock('https://aka.ms')
-				.get('/azdata-msi')
-				.reply(404);
-			const downloadPromise = azdata.downloadAndInstallAzdata();
-			await should(downloadPromise).be.rejected();
+		if (process.platform === 'win32') {
+			it('unsuccessful download - win32', async function (): Promise<void> {
+				sinon.stub(HttpClient, 'downloadFile').rejects();
+				const downloadPromise = azdata.installAzdata();
+				await should(downloadPromise).be.rejected();
+			});
+		}
+
+		it('unsuccessful install', async function (): Promise<void> {
+			switch (process.platform) {
+				case 'win32':
+					await testWin32UnsuccessfulInstall();
+					break;
+				case 'darwin':
+					await testDarwinUnsuccessfulInstall();
+					break;
+				case 'linux':
+					await testLinuxUnsuccessfulInstall();
+					break;
+			}
+		});
+	});
+
+	describe('upgradeAzdata', function (): void {
+		beforeEach(function (): void {
+			sinon.stub(vscode.window, 'showInformationMessage').returns(Promise.resolve(<any>loc.yes));
+		});
+
+		it('successful upgrade', async function (): Promise<void> {
+			const releaseJson = {
+				win32: {
+					'version': '9999.999.999',
+					'link': 'https://download.com/azdata-20.0.1.msi'
+				},
+				darwin: {
+					'version': '9999.999.999'
+				},
+				linux: {
+					'version': '9999.999.999'
+				}
+			};
+			switch (process.platform) {
+				case 'win32':
+					await testWin32SuccessfulUpgrade(releaseJson);
+					break;
+
+				case 'darwin':
+					await testDarwinSuccessfulUpgrade();
+					break;
+				case 'linux':
+					await testLinuxSuccessfulUpgrade(releaseJson);
+					break;
+			}
+		});
+
+
+		it('unsuccessful upgrade', async function (): Promise<void> {
+			switch (process.platform) {
+				case 'win32':
+					await testWin32UnsuccessfulUpgrade();
+					break;
+				case 'darwin':
+					await testDarwinUnsuccessfulUpgrade();
+					break;
+
+				case 'linux':
+					await testLinuxUnsuccessfulUpgrade();
+			}
+		});
+
+		describe('discoverLatestAvailableAzdataVersion', function (): void {
+			this.timeout(20000);
+			it(`finds latest available version of azdata successfully`, async function (): Promise<void> {
+				// if the latest version is not discovered then the following call throws failing the test
+				await azdata.discoverLatestAvailableAzdataVersion();
+			});
 		});
 	});
 });
+
+async function testLinuxUnsuccessfulUpgrade() {
+	const executeSudoCommandStub = sinon.stub(childProcess, 'executeSudoCommand').rejects();
+	const upgradePromise = azdata.checkAndUpgradeAzdata(oldAzdataMock);
+	await should(upgradePromise).be.rejected();
+	should(executeSudoCommandStub.calledOnce).be.true();
+}
+
+async function testDarwinUnsuccessfulUpgrade() {
+	const executeCommandStub = sinon.stub(childProcess, 'executeCommand').rejects();
+	const upgradePromise = azdata.checkAndUpgradeAzdata(oldAzdataMock);
+	await should(upgradePromise).be.rejected();
+	should(executeCommandStub.calledOnce).be.true();
+}
+
+async function testWin32UnsuccessfulUpgrade() {
+	sinon.stub(HttpClient, 'downloadFile').returns(Promise.resolve(__filename));
+	sinon.stub(childProcess, 'executeCommand').rejects();
+	const upgradePromise = azdata.checkAndUpgradeAzdata(oldAzdataMock);
+	await should(upgradePromise).be.rejected();
+}
+
+async function testLinuxSuccessfulUpgrade(releaseJson: { win32: { version: string; }; darwin: { version: string; }; linux: { version: string; }; }) {
+	sinon.stub(HttpClient, 'getTextContent').returns(Promise.resolve(JSON.stringify(releaseJson)));
+	const executeCommandStub = sinon.stub(childProcess, 'executeCommand').returns(Promise.resolve({ stdout: 'success', stderr: '' }));
+	const executeSudoCommandStub = sinon.stub(childProcess, 'executeSudoCommand').returns(Promise.resolve({ stdout: 'success', stderr: '' }));
+	await azdata.checkAndUpgradeAzdata(oldAzdataMock);
+	should(executeSudoCommandStub.callCount).be.equal(6);
+	should(executeCommandStub.calledOnce).be.true();
+}
+
+async function testDarwinSuccessfulUpgrade() {
+	const brewInfoOutput = [{
+		name: 'azdata-cli',
+		full_name: 'microsoft/azdata-cli-release/azdata-cli',
+		versions: {
+			'stable': '9999.999.999',
+			'devel': null,
+			'head': null,
+			'bottle': true
+		}
+	}];
+	const executeCommandStub = sinon.stub(childProcess, 'executeCommand')
+		.onThirdCall() //third call is brew info azdata-cli --json which needs to return json of new available azdata versions.
+		.callsFake(async (command: string, args: string[]) => {
+			should(command).be.equal('brew');
+			should(args).deepEqual(['info', 'azdata-cli', '--json']);
+			return Promise.resolve({
+				stderr: '',
+				stdout: JSON.stringify(brewInfoOutput)
+			});
+		})
+		.callsFake(async (_command: string, _args: string[]) => { // return success on all other command executions
+			return Promise.resolve({ stdout: 'success', stderr: '' });
+		});
+	await azdata.checkAndUpgradeAzdata(oldAzdataMock);
+	should(executeCommandStub.callCount).be.equal(6);
+}
+
+async function testWin32SuccessfulUpgrade(releaseJson: { win32: { version: string; link: string; }; darwin: { version: string; }; linux: { version: string; }; }) {
+	sinon.stub(HttpClient, 'getTextContent').returns(Promise.resolve(JSON.stringify(releaseJson)));
+	sinon.stub(HttpClient, 'downloadFile').returns(Promise.resolve(__filename));
+	const executeCommandStub = sinon.stub(childProcess, 'executeCommand').callsFake(async (command: string, args: string[]) => {
+		should(command).be.equal('msiexec');
+		should(args[0]).be.equal('/qn');
+		should(args[1]).be.equal('/i');
+		should(path.basename(args[2])).be.equal(azdata.azdataUri);
+		return { stdout: 'success', stderr: '' };
+	});
+	await azdata.checkAndUpgradeAzdata(oldAzdataMock);
+	should(executeCommandStub.calledOnce).be.true();
+}
+
+async function testWin32SuccessfulInstall() {
+	sinon.stub(HttpClient, 'downloadFile').returns(Promise.resolve(__filename));
+	const executeCommandStub = sinon.stub(childProcess, 'executeCommand').callsFake(async (command: string, args: string[]) => {
+		should(command).be.equal('msiexec');
+		should(args[0]).be.equal('/qn');
+		should(args[1]).be.equal('/i');
+		should(path.basename(args[2])).be.equal(azdata.azdataUri);
+		return { stdout: 'success', stderr: '' };
+	});
+	await azdata.installAzdata();
+	should(executeCommandStub.calledOnce).be.true();
+}
+
+async function testDarwinSuccessfulInstall() {
+	const executeCommandStub = sinon.stub(childProcess, 'executeCommand').callsFake(async (command: string, _args: string[]) => {
+		should(command).be.equal('brew');
+		return { stdout: 'success', stderr: '' };
+	});
+	await azdata.installAzdata();
+	should(executeCommandStub.calledThrice).be.true();
+}
+
+async function testLinuxSuccessfulInstall() {
+	const executeCommandStub = sinon.stub(childProcess, 'executeCommand').returns(Promise.resolve({ stdout: 'success', stderr: '' }));
+	const executeSudoCommandStub = sinon.stub(childProcess, 'executeSudoCommand').returns(Promise.resolve({ stdout: 'success', stderr: '' }));
+	await azdata.installAzdata();
+	should(executeSudoCommandStub.callCount).be.equal(6);
+	should(executeCommandStub.calledOnce).be.true();
+}
+
+async function testLinuxUnsuccessfulInstall() {
+	const executeSudoCommandStub = sinon.stub(childProcess, 'executeSudoCommand').rejects();
+	const downloadPromise = azdata.installAzdata();
+	await should(downloadPromise).be.rejected();
+	should(executeSudoCommandStub.calledOnce).be.true();
+}
+
+async function testDarwinUnsuccessfulInstall() {
+	const executeCommandStub = sinon.stub(childProcess, 'executeCommand').rejects();
+	const downloadPromise = azdata.installAzdata();
+	await should(downloadPromise).be.rejected();
+	should(executeCommandStub.calledOnce).be.true();
+}
+
+async function testWin32UnsuccessfulInstall() {
+	const executeCommandStub = sinon.stub(childProcess, 'executeCommand').rejects();
+	sinon.stub(HttpClient, 'downloadFile').returns(Promise.resolve(__filename));
+	const downloadPromise = azdata.installAzdata();
+	await should(downloadPromise).be.rejected();
+	should(executeCommandStub.calledOnce).be.true();
+}
--- a/extensions/azdata/src/test/common/httpClient.test.ts
+++ b/extensions/azdata/src/test/common/httpClient.test.ts
@@ -3,13 +3,13 @@
 *  Licensed under the Source EULA. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

-import * as should from 'should';
-import { HttpClient } from '../../common/httpClient';
-import * as os from 'os';
 import * as fs from 'fs';
 import * as nock from 'nock';
+import * as os from 'os';
+import * as should from 'should';
 import * as sinon from 'sinon';
 import { PassThrough } from 'stream';
+import { HttpClient } from '../../common/httpClient';
 import { Deferred } from '../../common/promise';

 describe('HttpClient', function (): void {
@@ -17,15 +17,16 @@ describe('HttpClient', function (): void {
 	afterEach(function (): void {
 		nock.cleanAll();
 		nock.enableNetConnect();
+		sinon.restore();
 	});

-	describe('download', function(): void {
+	describe('downloadFile', function (): void {
 		it('downloads file successfully', async function (): Promise<void> {
 			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);
+			const downloadPath = await HttpClient.downloadFile('https://127.0.0.1/README.md', downloadFolder);
 			// Verify file was downloaded correctly
 			await fs.promises.stat(downloadPath);
 		});
@@ -35,8 +36,7 @@ describe('HttpClient', function (): void {
 			nock('https://127.0.0.1')
 				.get('/')
 				.replyWithError('Unexpected Error');
-			const downloadPromise = HttpClient.download('https://127.0.0.1', downloadFolder);
-
+			const downloadPromise = HttpClient.downloadFile('https://127.0.0.1', downloadFolder);
 			await should(downloadPromise).be.rejected();
 		});

@@ -45,8 +45,7 @@ describe('HttpClient', function (): void {
 			nock('https://127.0.0.1')
 				.get('/')
 				.reply(404, '');
-			const downloadPromise = HttpClient.download('https://127.0.0.1', downloadFolder);
-
+			const downloadPromise = HttpClient.downloadFile('https://127.0.0.1', downloadFolder);
 			await should(downloadPromise).be.rejected();
 		});

@@ -61,7 +60,7 @@ describe('HttpClient', function (): void {
 			nock('https://127.0.0.1')
 				.get('/')
 				.reply(200, '');
-			const downloadPromise = HttpClient.download('https://127.0.0.1', downloadFolder);
+			const downloadPromise = HttpClient.downloadFile('https://127.0.0.1', downloadFolder);
 			// Wait for the stream to be created before throwing the error or HttpClient will miss the event
 			await deferredPromise;
 			try {
@@ -73,34 +72,29 @@ describe('HttpClient', function (): void {
 		});
 	});

-	describe('getFilename', function(): void {
-		it('Gets filename correctly', async function (): Promise<void> {
-			const filename = 'azdata-cli-20.0.0.msi';
+	describe('getTextContent', function (): void {
+		it.skip('Gets file contents correctly', async function (): Promise<void> {
 			nock('https://127.0.0.1')
-				.get(`/${filename}`)
-				.reply(200);
-			const receivedFilename = await HttpClient.getFilename(`https://127.0.0.1/${filename}`);
-
-			should(receivedFilename).equal(filename);
+				.get('/arbitraryFile')
+				.replyWithFile(200, __filename);
+			const receivedContents = await HttpClient.getTextContent(`https://127.0.0.1/arbitraryFile`);
+			should(receivedContents).equal(await fs.promises.readFile(__filename));
 		});

-		it('errors on response error', async function (): Promise<void> {
+		it('rejects on response error', async function (): Promise<void> {
 			nock('https://127.0.0.1')
 				.get('/')
 				.replyWithError('Unexpected Error');
-			const getFilenamePromise = HttpClient.getFilename('https://127.0.0.1');
-
-			await should(getFilenamePromise).be.rejected();
+			const getFileContentsPromise = HttpClient.getTextContent('https://127.0.0.1/', );
+			await should(getFileContentsPromise).be.rejected();
 		});

 		it('rejects on non-OK status code', async function (): Promise<void> {
 			nock('https://127.0.0.1')
 				.get('/')
 				.reply(404, '');
-			const getFilenamePromise = HttpClient.getFilename('https://127.0.0.1');
-
-			await should(getFilenamePromise).be.rejected();
+			const getFileContentsPromise = HttpClient.getTextContent('https://127.0.0.1/', );
+			await should(getFileContentsPromise).be.rejected();
 		});
 	});
-
 });
--- a/extensions/azdata/src/test/common/utils.test.ts
+++ b/extensions/azdata/src/test/common/utils.test.ts
@@ -2,16 +2,15 @@
 *  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 { searchForCmd as searchForExe } from '../../common/utils';

 describe('utils', function () {
-	describe('searchForExe', function(): void {
-		it('finds exe successfully', async function(): Promise<void> {
+	describe('searchForExe', function (): void {
+		it('finds exe successfully', async function (): Promise<void> {
 			await searchForExe('node');
 		});
-		it('throws for non-existent exe', async function(): Promise<void> {
+		it('throws for non-existent exe', async function (): Promise<void> {
 			await should(searchForExe('someFakeExe')).be.rejected();
 		});
 	});