Port the Azure Resource Explorer extension to core. (#2701)

* Port the Azure Resource Explorer extension to core.

This will enable Azure viewlet by default in the next release.

- Moving this code from the SQL Server 2019 extension to Azure Data Studio core
- Ported tests and verified they work in the integration tests.sh file
- Fixed an issue that caused integration tests to fail if you have a SQL Server 2019 big data cluster endpoint listed, but the extension isn't installed.

extensions/azurecore/src/azureResource/services/accountService.ts

@@ -0,0 +1,32 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 { Event } from 'vscode';
+import { Account, DidChangeAccountsParams } from 'sqlops';
+import { ApiWrapper } from '../../apiWrapper';
+
+import { IAzureResourceAccountService } from '../interfaces';
+
+export class AzureResourceAccountService implements IAzureResourceAccountService {
+	public constructor(
+		apiWrapper: ApiWrapper
+	) {
+		this._apiWrapper = apiWrapper;
+		this._onDidChangeAccounts = this._apiWrapper.onDidChangeAccounts;
+	}
+
+	public async getAccounts(): Promise<Account[]> {
+		return await this._apiWrapper.getAllAccounts();
+	}
+
+	public get onDidChangeAccounts(): Event<DidChangeAccountsParams> {
+		return this._onDidChangeAccounts;
+	}
+
+	private _apiWrapper: ApiWrapper = undefined;
+	private _onDidChangeAccounts: Event<DidChangeAccountsParams> = undefined;
+}

extensions/azurecore/src/azureResource/services/cacheService.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.
+ *--------------------------------------------------------------------------------------------*/
+
+'use strict';
+
+import { ExtensionContext } from "vscode";
+
+import { IAzureResourceCacheService } from "../interfaces";
+
+export class AzureResourceCacheService implements IAzureResourceCacheService {
+	public constructor(
+		public readonly context: ExtensionContext
+	) {
+	}
+
+	public get<T>(key: string): T | undefined {
+		return this.context.workspaceState.get(key);
+	}
+
+	public update<T>(key: string, value: T): void {
+		this.context.workspaceState.update(key, value);
+	}
+}

extensions/azurecore/src/azureResource/services/contextService.ts

@@ -0,0 +1,36 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 { ExtensionContext } from "vscode";
+import { ApiWrapper } from "../../apiWrapper";
+
+import { IAzureResourceContextService } from "../interfaces";
+
+export class AzureResourceContextService implements IAzureResourceContextService {
+	public constructor(
+		context: ExtensionContext,
+		apiWrapper: ApiWrapper
+	) {
+		this._context = context;
+		this._apiWrapper = apiWrapper;
+	}
+
+	public getAbsolutePath(relativePath: string): string {
+		return this._context.asAbsolutePath(relativePath);
+	}
+
+	public executeCommand(commandId: string, ...args: any[]): void {
+		this._apiWrapper.executeCommand(commandId, args);
+	}
+
+	public showErrorMessage(errorMessage: string): void {
+		this._apiWrapper.showErrorMessage(errorMessage);
+	}
+
+	private _context: ExtensionContext = undefined;
+	private _apiWrapper: ApiWrapper = undefined;
+}

extensions/azurecore/src/azureResource/services/credentialService.ts

@@ -0,0 +1,43 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 { Account } from 'sqlops';
+import { TokenCredentials, ServiceClientCredentials } from 'ms-rest';
+import { ApiWrapper } from '../../apiWrapper';
+import * as nls from 'vscode-nls';
+const localize = nls.loadMessageBundle();
+
+import { IAzureResourceCredentialService } from '../interfaces';
+import { AzureResourceCredentialError } from '../errors';
+
+export class AzureResourceCredentialService implements IAzureResourceCredentialService {
+	public constructor(
+		apiWrapper: ApiWrapper
+	) {
+		this._apiWrapper = apiWrapper;
+	}
+
+	public async getCredentials(account: Account): Promise<ServiceClientCredentials[]> {
+		try {
+			let credentials: TokenCredentials[] = [];
+			let tokens = await this._apiWrapper.getSecurityToken(account);
+
+			for (let tenant of account.properties.tenants) {
+				let token = tokens[tenant.id].token;
+				let tokenType = tokens[tenant.id].tokenType;
+
+				credentials.push(new TokenCredentials(token, tokenType));
+			}
+
+			return credentials;
+		} catch (error) {
+			throw new AzureResourceCredentialError(localize('azureResource.services.credentialService.credentialError', 'Failed to get credential for account {0}. Please refresh the account.', account.key.accountId), error);
+		}
+	}
+
+	private _apiWrapper: ApiWrapper = undefined;
+}

extensions/azurecore/src/azureResource/services/databaseServerService.ts

@@ -0,0 +1,39 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 { ServiceClientCredentials } from 'ms-rest';
+import { SqlManagementClient } from 'azure-arm-sql';
+
+import { IAzureResourceDatabaseServerService } from '../interfaces';
+import { AzureResourceSubscription, AzureResourceDatabaseServer } from '../models';
+
+export class AzureResourceDatabaseServerService implements IAzureResourceDatabaseServerService {
+	public async getDatabaseServers(subscription: AzureResourceSubscription, credentials: ServiceClientCredentials[]): Promise<AzureResourceDatabaseServer[]> {
+		let databaseServers: AzureResourceDatabaseServer[] = [];
+		for (let cred of credentials) {
+			let sqlManagementClient = new SqlManagementClient(cred, subscription.id);
+			try {
+				let svrs = await sqlManagementClient.servers.list();
+				svrs.forEach((svr) => databaseServers.push({
+					name: svr.name,
+					fullName: svr.fullyQualifiedDomainName,
+					loginName: svr.administratorLogin,
+					defaultDatabaseName: 'master'
+				}));
+			} catch (error) {
+				if (error.code === 'InvalidAuthenticationTokenTenant' && error.statusCode === 401) {
+					/**
+					 * There may be multiple tenants for an account and it may throw exceptions like following. Just swallow the exception here.
+					 *   The access token is from the wrong issuer. It must match one of the tenants associated with this subscription.
+					 */
+				}
+			}
+		}
+
+		return databaseServers;
+	}
+}

extensions/azurecore/src/azureResource/services/databaseService.ts

@@ -0,0 +1,51 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 { ServiceClientCredentials } from 'ms-rest';
+import { SqlManagementClient } from 'azure-arm-sql';
+
+import { IAzureResourceDatabaseService } from '../interfaces';
+import { AzureResourceSubscription, AzureResourceDatabase } from '../models';
+
+export class AzureResourceDatabaseService implements IAzureResourceDatabaseService {
+	public async getDatabases(subscription: AzureResourceSubscription, credentials: ServiceClientCredentials[]): Promise<AzureResourceDatabase[]> {
+		let databases: AzureResourceDatabase[] = [];
+		for (let cred of credentials) {
+			let sqlManagementClient = new SqlManagementClient(cred, subscription.id);
+			try {
+				let svrs = await sqlManagementClient.servers.list();
+				for (let svr of svrs) {
+					// Extract resource group name from svr.id
+					let svrIdRegExp = new RegExp(`\/subscriptions\/${subscription.id}\/resourceGroups\/(.+)\/providers\/Microsoft\.Sql\/servers\/${svr.name}`);
+					if (!svrIdRegExp.test(svr.id)) {
+						continue;
+					}
+
+					let founds = svrIdRegExp.exec(svr.id);
+					let resouceGroup = founds[1];
+
+					let dbs = await sqlManagementClient.databases.listByServer(resouceGroup, svr.name);
+					dbs.forEach((db) => databases.push({
+						name: db.name,
+						serverName: svr.name,
+						serverFullName: svr.fullyQualifiedDomainName,
+						loginName: svr.administratorLogin
+					}));
+				}
+			} catch (error) {
+				if (error.code === 'InvalidAuthenticationTokenTenant' && error.statusCode === 401) {
+					/**
+					 * There may be multiple tenants for an account and it may throw exceptions like following. Just swallow the exception here.
+					 *   The access token is from the wrong issuer. It must match one of the tenants associated with this subscription.
+					 */
+				}
+			}
+		}
+
+		return databases;
+	}
+}

extensions/azurecore/src/azureResource/services/subscriptionFilterService.ts

@@ -0,0 +1,77 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 { WorkspaceConfiguration, ConfigurationTarget } from 'vscode';
+import { Account } from 'sqlops';
+
+import { IAzureResourceSubscriptionFilterService, IAzureResourceCacheService } from '../interfaces';
+import { AzureResourceSubscription } from '../models';
+
+interface AzureResourceSelectedSubscriptionsCache {
+	selectedSubscriptions: { [accountId: string]: AzureResourceSubscription[]};
+}
+
+export class AzureResourceSubscriptionFilterService implements IAzureResourceSubscriptionFilterService {
+	public constructor(
+		cacheService: IAzureResourceCacheService
+	) {
+		this._cacheService = cacheService;
+	}
+
+	public async getSelectedSubscriptions(account: Account): Promise<AzureResourceSubscription[]> {
+		let selectedSubscriptions: AzureResourceSubscription[] = [];
+
+		const cache = this._cacheService.get<AzureResourceSelectedSubscriptionsCache>(AzureResourceSubscriptionFilterService.CacheKey);
+		if (cache) {
+			selectedSubscriptions = cache.selectedSubscriptions[account.key.accountId];
+		}
+
+		return selectedSubscriptions;
+	}
+
+	public async saveSelectedSubscriptions(account: Account, selectedSubscriptions: AzureResourceSubscription[]): Promise<void> {
+		let selectedSubscriptionsCache: { [accountId: string]: AzureResourceSubscription[]} = {};
+
+		const cache = this._cacheService.get<AzureResourceSelectedSubscriptionsCache>(AzureResourceSubscriptionFilterService.CacheKey);
+		if (cache) {
+			selectedSubscriptionsCache = cache.selectedSubscriptions;
+		}
+
+		if (!selectedSubscriptionsCache) {
+			selectedSubscriptionsCache = {};
+		}
+
+		selectedSubscriptionsCache[account.key.accountId] = selectedSubscriptions;
+
+		this._cacheService.update<AzureResourceSelectedSubscriptionsCache>(AzureResourceSubscriptionFilterService.CacheKey, { selectedSubscriptions: selectedSubscriptionsCache });
+
+		const filters: string[] = [];
+		for (const accountId in selectedSubscriptionsCache) {
+			filters.push(...selectedSubscriptionsCache[accountId].map((subcription) => `${accountId}/${subcription.id}/${subcription.name}`));
+		}
+
+		const resourceFilterConfig = this._config.inspect<string[]>(AzureResourceSubscriptionFilterService.FilterConfigName);
+		let configTarget = ConfigurationTarget.Global;
+		if (resourceFilterConfig) {
+			if (resourceFilterConfig.workspaceFolderValue) {
+				configTarget = ConfigurationTarget.WorkspaceFolder;
+			} else if (resourceFilterConfig.workspaceValue) {
+				configTarget = ConfigurationTarget.Workspace;
+			} else if (resourceFilterConfig.globalValue) {
+				configTarget = ConfigurationTarget.Global;
+			}
+		}
+
+		await this._config.update(AzureResourceSubscriptionFilterService.FilterConfigName, filters, configTarget);
+	}
+
+	private _config: WorkspaceConfiguration = undefined;
+	private _cacheService: IAzureResourceCacheService = undefined;
+
+	private static readonly FilterConfigName = 'resourceFilter';
+	private static readonly CacheKey = 'azureResource.cache.selectedSubscriptions';
+}

extensions/azurecore/src/azureResource/services/subscriptionService.ts

@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 { Account } from 'sqlops';
+import { ServiceClientCredentials } from 'ms-rest';
+import { SubscriptionClient } from 'azure-arm-resource';
+
+import { IAzureResourceSubscriptionService } from '../interfaces';
+import { AzureResourceSubscription } from '../models';
+
+export class AzureResourceSubscriptionService implements IAzureResourceSubscriptionService {
+	public async getSubscriptions(account: Account, credentials: ServiceClientCredentials[]): Promise<AzureResourceSubscription[]> {
+		let subscriptions: AzureResourceSubscription[] = [];
+		for (let cred of credentials) {
+			let subClient = new SubscriptionClient.SubscriptionClient(cred);
+			try {
+				let subs = await subClient.subscriptions.list();
+				subs.forEach((sub) => subscriptions.push({
+					id: sub.subscriptionId,
+					name: sub.displayName
+				}));
+			} catch (error) {
+				// Swallow the exception here.
+			}
+		}
+
+		return subscriptions;
+	}
+}