ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-17 02:51:36 -05:00
Code Issues Packages Projects Releases Wiki Activity

Port updates for removing EULA acceptance checkbox from Arc deployments (#12409)

Browse Source 
* controller dropdown field to SQL MIAA and Postgres deployment. (#12217)

* saving first draft

* throw if no controllers

* cleanup

* bug fixes

* bug fixes and caching controller access

* pr comments and bug fixes.

* fixes

* fixes

* comment fix

* remove debug prints

* comment fixes

* remove debug logs

* inputValueTransformer returns string|Promise

* PR feedback

* pr fixes

* remove _ from protected fields

* anonymous to full methods

* small fixes

(cherry picked from commit 9cf80113fc)

* fix option sources (#12387)


(cherry picked from commit fca8b85a72)

* Remove azdata eula acceptance from arc deployments (#12292)

* saving to switch tasks

* activate to exports in extApi

* working version - cleanup pending

* improve messages

* apply pr feedback from a different review

* remove unneeded strings

* redo apiService

* remove async from getVersionFromOutput

* remove _ prefix from protected fields

* error message fix

* throw specif errors from azdata extension

* arrow methods to regular methods

* pr feedback

* expand azdata extension api

* pr feedback

* remove unused var

* pr feedback

(cherry picked from commit ba44a2f02e)

Co-authored-by: Arvind Ranasaria <ranasaria@outlook.com>
This commit is contained in:
Charles Gagnon
2020-09-17 15:05:02 -07:00
committed by GitHub
parent 21bb577da8
commit 94e2016a16
44 changed files with 925 additions and 303 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
extensions/arc/notebooks/arcDeployment/deploy.postgres.existing.arc.ipynb
View File

@@ -85,16 +85,36 @@
"cell_type": "code", "cell_type": "code",
"source": [ "source": [
"# Required Values\n", "# Required Values\n",
"env_var = \"AZDATA_NB_VAR_CONTROLLER_ENDPOINT\" in os.environ\n",
"if env_var:\n",
" controller_endpoint = os.environ[\"AZDATA_NB_VAR_CONTROLLER_ENDPOINT\"]\n",
"else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_CONTROLLER_ENDPOINT was not defined. Exiting\\n')\n",
"\n",
"env_var = \"AZDATA_NB_VAR_CONTROLLER_USERNAME\" in os.environ\n",
"if env_var:\n",
" controller_username = os.environ[\"AZDATA_NB_VAR_CONTROLLER_USERNAME\"]\n",
"else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_CONTROLLER_USERNAME was not defined. Exiting\\n')\n",
"\n",
"env_var = \"AZDATA_NB_VAR_CONTROLLER_PASSWORD\" in os.environ\n",
"if env_var:\n",
" controller_password = os.environ[\"AZDATA_NB_VAR_CONTROLLER_PASSWORD\"]\n",
"else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_CONTROLLER_PASSWORD was not defined. Exiting\\n')\n",
"\n",
"env_var = \"AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_NAME\" in os.environ\n", "env_var = \"AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_NAME\" in os.environ\n",
"if env_var:\n", "if env_var:\n",
" server_group_name = os.environ[\"AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_NAME\"]\n", " server_group_name = os.environ[\"AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_NAME\"]\n",
"else:\n", "else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_NAME was not defined. Exiting\\n')\n", " sys.exit(f'environment variable: AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_NAME was not defined. Exiting\\n')\n",
"\n",
"env_var = \"AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_PASSWORD\" in os.environ\n", "env_var = \"AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_PASSWORD\" in os.environ\n",
"if env_var:\n", "if env_var:\n",
" postgres_password = os.environ[\"AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_PASSWORD\"]\n", " postgres_password = os.environ[\"AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_PASSWORD\"]\n",
"else:\n", "else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_PASSWORD was not defined. Exiting\\n') \n", " sys.exit(f'environment variable: AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_PASSWORD was not defined. Exiting\\n') \n",
"\n",
"env_var = \"AZDATA_NB_VAR_POSTGRES_STORAGE_CLASS_DATA\" in os.environ\n", "env_var = \"AZDATA_NB_VAR_POSTGRES_STORAGE_CLASS_DATA\" in os.environ\n",
"if env_var:\n", "if env_var:\n",
" postgres_storage_class_data = os.environ[\"AZDATA_NB_VAR_POSTGRES_STORAGE_CLASS_DATA\"]\n", " postgres_storage_class_data = os.environ[\"AZDATA_NB_VAR_POSTGRES_STORAGE_CLASS_DATA\"]\n",
@@ -154,6 +174,21 @@
"azdata_cell_guid": "90b0e162-2987-463f-9ce6-12dda1267189" "azdata_cell_guid": "90b0e162-2987-463f-9ce6-12dda1267189"
} }
}, },
{
"cell_type": "code",
"source": [
"# Login to the data controller.\n",
"#\n",
"os.environ[\"AZDATA_PASSWORD\"] = controller_password\n",
"cmd = f'azdata login -e {controller_endpoint} -u {controller_username}'\n",
"out=run_command()"
],
"metadata": {
"azdata_cell_guid": "71366399-5963-4e24-b2f2-6bb5bffba4ec"
},
"outputs": [],
"execution_count": null
},
{ {
"cell_type": "code", "cell_type": "code",
"source": [ "source": [
@@ -177,4 +212,4 @@
"execution_count": null "execution_count": null
} }
] ]
} }

42
extensions/arc/notebooks/arcDeployment/deploy.sql.existing.arc.ipynb
View File

@@ -85,21 +85,42 @@
"cell_type": "code", "cell_type": "code",
"source": [ "source": [
"# Required Values\n", "# Required Values\n",
"env_var = \"AZDATA_NB_VAR_CONTROLLER_ENDPOINT\" in os.environ\n",
"if env_var:\n",
" controller_endpoint = os.environ[\"AZDATA_NB_VAR_CONTROLLER_ENDPOINT\"]\n",
"else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_CONTROLLER_ENDPOINT was not defined. Exiting\\n')\n",
"\n",
"env_var = \"AZDATA_NB_VAR_CONTROLLER_USERNAME\" in os.environ\n",
"if env_var:\n",
" controller_username = os.environ[\"AZDATA_NB_VAR_CONTROLLER_USERNAME\"]\n",
"else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_CONTROLLER_USERNAME was not defined. Exiting\\n')\n",
"\n",
"env_var = \"AZDATA_NB_VAR_CONTROLLER_PASSWORD\" in os.environ\n",
"if env_var:\n",
" controller_password = os.environ[\"AZDATA_NB_VAR_CONTROLLER_PASSWORD\"]\n",
"else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_CONTROLLER_PASSWORD was not defined. Exiting\\n')\n",
"\n",
"env_var = \"AZDATA_NB_VAR_SQL_INSTANCE_NAME\" in os.environ\n", "env_var = \"AZDATA_NB_VAR_SQL_INSTANCE_NAME\" in os.environ\n",
"if env_var:\n", "if env_var:\n",
" mssql_instance_name = os.environ[\"AZDATA_NB_VAR_SQL_INSTANCE_NAME\"]\n", " mssql_instance_name = os.environ[\"AZDATA_NB_VAR_SQL_INSTANCE_NAME\"]\n",
"else:\n", "else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_SQL_INSTANCE_NAME was not defined. Exiting\\n')\n", " sys.exit(f'environment variable: AZDATA_NB_VAR_SQL_INSTANCE_NAME was not defined. Exiting\\n')\n",
"\n",
"env_var = \"AZDATA_NB_VAR_SQL_PASSWORD\" in os.environ\n", "env_var = \"AZDATA_NB_VAR_SQL_PASSWORD\" in os.environ\n",
"if env_var:\n", "if env_var:\n",
" mssql_password = os.environ[\"AZDATA_NB_VAR_SQL_PASSWORD\"]\n", " mssql_password = os.environ[\"AZDATA_NB_VAR_SQL_PASSWORD\"]\n",
"else:\n", "else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_SQL_PASSWORD was not defined. Exiting\\n') \n", " sys.exit(f'environment variable: AZDATA_NB_VAR_SQL_PASSWORD was not defined. Exiting\\n')\n",
"\n",
"env_var = \"AZDATA_NB_VAR_SQL_STORAGE_CLASS_DATA\" in os.environ\n", "env_var = \"AZDATA_NB_VAR_SQL_STORAGE_CLASS_DATA\" in os.environ\n",
"if env_var:\n", "if env_var:\n",
" mssql_storage_class_data = os.environ[\"AZDATA_NB_VAR_SQL_STORAGE_CLASS_DATA\"]\n", " mssql_storage_class_data = os.environ[\"AZDATA_NB_VAR_SQL_STORAGE_CLASS_DATA\"]\n",
"else:\n", "else:\n",
" sys.exit(f'environment variable: AZDATA_NB_VAR_SQL_STORAGE_CLASS_DATA was not defined. Exiting\\n') \n", " sys.exit(f'environment variable: AZDATA_NB_VAR_SQL_STORAGE_CLASS_DATA was not defined. Exiting\\n')\n",
"\n",
"env_var = \"AZDATA_NB_VAR_SQL_STORAGE_CLASS_LOGS\" in os.environ\n", "env_var = \"AZDATA_NB_VAR_SQL_STORAGE_CLASS_LOGS\" in os.environ\n",
"if env_var:\n", "if env_var:\n",
" mssql_storage_class_logs = os.environ[\"AZDATA_NB_VAR_SQL_STORAGE_CLASS_LOGS\"]\n", " mssql_storage_class_logs = os.environ[\"AZDATA_NB_VAR_SQL_STORAGE_CLASS_LOGS\"]\n",
@@ -123,6 +144,21 @@
"azdata_cell_guid": "90b0e162-2987-463f-9ce6-12dda1267189" "azdata_cell_guid": "90b0e162-2987-463f-9ce6-12dda1267189"
} }
}, },
{
"cell_type": "code",
"source": [
"# Login to the data controller.\n",
"#\n",
"os.environ[\"AZDATA_PASSWORD\"] = controller_password\n",
"cmd = f'azdata login -e {controller_endpoint} -u {controller_username}'\n",
"out=run_command()"
],
"metadata": {
"azdata_cell_guid": "1437c536-17e8-4a7f-80c1-aa43ad02686c"
},
"outputs": [],
"execution_count": null
},
{ {
"cell_type": "code", "cell_type": "code",
"source": [ "source": [
@@ -139,4 +175,4 @@
"execution_count": null "execution_count": null
} }
] ]
} }

89
extensions/arc/package.json
View File

@@ -547,20 +547,7 @@
], ],
"when": true "when": true
} }
], ]
"agreement": {
"template": "%arc.control.plane.arc.data.controller.agreement%",
"links": [
{
"text": "%microsoft.agreement.privacy.statement%",
"url": "https://go.microsoft.com/fwlink/?LinkId=853010"
},
{
"text": "%arc.agreement.azdata.eula%",
"url": "https://aka.ms/eula-azdata-en"
}
]
}
}, },
{ {
"name": "arc.sql", "name": "arc.sql",
@@ -571,18 +558,6 @@
"light": "./images/miaa.svg", "light": "./images/miaa.svg",
"dark": "./images/miaa.svg" "dark": "./images/miaa.svg"
}, },
"options": [
{
"name": "resourceType",
"displayName": "%resource.type.picker.display.name%",
"values": [
{
"name": "sql.managed.instance",
"displayName": "%sql.managed.instance.display.name%"
}
]
}
],
"providers": [ "providers": [
{ {
"dialog": { "dialog": {
@@ -599,6 +574,25 @@
{ {
"title": "%arc.sql.settings.section.title%", "title": "%arc.sql.settings.section.title%",
"fields": [ "fields": [
{
"label": "%arc.controller%",
"variableName": "AZDATA_NB_VAR_ARC_CONTROLLER",
"type": "options",
"editable": false,
"required": true,
"options": {
"source": {
"type": "ArcControllersOptionsSource",
"variableNames": {
"endpoint": "AZDATA_NB_VAR_CONTROLLER_ENDPOINT",
"username": "AZDATA_NB_VAR_CONTROLLER_USERNAME",
"password": "AZDATA_NB_VAR_CONTROLLER_PASSWORD"
}
},
"optionsType": "dropdown"
},
"labelWidth": "100%"
},
{ {
"label": "%arc.sql.instance.name%", "label": "%arc.sql.instance.name%",
"variableName": "AZDATA_NB_VAR_SQL_INSTANCE_NAME", "variableName": "AZDATA_NB_VAR_SQL_INSTANCE_NAME",
@@ -653,7 +647,7 @@
"version": "20.1.0" "version": "20.1.0"
} }
], ],
"when": "resourceType=sql.managed.instance" "when": "true"
} }
], ],
"agreement": { "agreement": {
@@ -666,10 +660,6 @@
{ {
"text": "%arc.agreement.sql.terms.conditions%", "text": "%arc.agreement.sql.terms.conditions%",
"url": "https://go.microsoft.com/fwlink/?linkid=2045708" "url": "https://go.microsoft.com/fwlink/?linkid=2045708"
},
{
"text": "%arc.agreement.azdata.eula%",
"url": "https://aka.ms/eula-azdata-en"
} }
] ]
} }
@@ -683,18 +673,6 @@
"light": "./images/postgres.svg", "light": "./images/postgres.svg",
"dark": "./images/postgres.svg" "dark": "./images/postgres.svg"
}, },
"options": [
{
"name": "resourceType",
"displayName": "%resource.type.picker.display.name%",
"values": [
{
"name": "postgres",
"displayName": "%postgres.server.group.display.name%"
}
]
}
],
"providers": [ "providers": [
{ {
"dialog": { "dialog": {
@@ -711,6 +689,25 @@
{ {
"title": "%arc.postgres.settings.section.title%", "title": "%arc.postgres.settings.section.title%",
"fields": [ "fields": [
{
"label": "%arc.controller%",
"variableName": "AZDATA_NB_VAR_ARC_CONTROLLER",
"type": "options",
"editable": false,
"required": true,
"options": {
"source": {
"type": "ArcControllersOptionsSource",
"variableNames": {
"endpoint": "AZDATA_NB_VAR_CONTROLLER_ENDPOINT",
"username": "AZDATA_NB_VAR_CONTROLLER_USERNAME",
"password": "AZDATA_NB_VAR_CONTROLLER_PASSWORD"
}
},
"optionsType": "dropdown"
},
"labelWidth": "100%"
},
{ {
"label": "%arc.postgres.server.group.name%", "label": "%arc.postgres.server.group.name%",
"variableName": "AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_NAME", "variableName": "AZDATA_NB_VAR_POSTGRES_SERVER_GROUP_NAME",
@@ -810,7 +807,7 @@
"version": "20.1.0" "version": "20.1.0"
} }
], ],
"when": "resourceType=postgres" "when": "true"
} }
], ],
"agreement": { "agreement": {
@@ -823,10 +820,6 @@
{ {
"text": "%arc.agreement.postgres.terms.conditions%", "text": "%arc.agreement.postgres.terms.conditions%",
"url": "https://go.microsoft.com/fwlink/?linkid=2045708" "url": "https://go.microsoft.com/fwlink/?linkid=2045708"
},
{
"text": "%arc.agreement.azdata.eula%",
"url": "https://aka.ms/eula-azdata-en"
} }
] ]
} }

9
extensions/arc/package.nls.json
View File

@@ -65,7 +65,6 @@
"arc.control.plane.summary.location": "Location", "arc.control.plane.summary.location": "Location",
"arc.control.plane.arc.data.controller.agreement": "I accept {0} and {1}.", "arc.control.plane.arc.data.controller.agreement": "I accept {0} and {1}.",
"microsoft.agreement.privacy.statement":"Microsoft Privacy Statement", "microsoft.agreement.privacy.statement":"Microsoft Privacy Statement",
"arc.agreement.azdata.eula":"azdata license terms",
"deploy.arc.control.plane.action":"Script to notebook", "deploy.arc.control.plane.action":"Script to notebook",
@@ -73,9 +72,9 @@
"resource.type.arc.postgres.display.name": "PostgreSQL server groups - Azure Arc (preview)", "resource.type.arc.postgres.display.name": "PostgreSQL server groups - Azure Arc (preview)",
"resource.type.arc.sql.description": "Managed SQL Instance service for app developers in a customer-managed environment", "resource.type.arc.sql.description": "Managed SQL Instance service for app developers in a customer-managed environment",
"resource.type.arc.postgres.description": "Deploy PostgreSQL server groups into an Azure Arc environment", "resource.type.arc.postgres.description": "Deploy PostgreSQL server groups into an Azure Arc environment",
"resource.type.picker.display.name": "Resource Type", "arc.controller": "Target Azure Arc Controller",
"sql.managed.instance.display.name": "Azure SQL managed instance - Azure Arc",
"postgres.server.group.display.name": "PostgreSQL server groups - Azure Arc",
"arc.sql.new.dialog.title": "Deploy Azure SQL managed instance - Azure Arc (preview)", "arc.sql.new.dialog.title": "Deploy Azure SQL managed instance - Azure Arc (preview)",
"arc.sql.settings.section.title": "SQL Connection information", "arc.sql.settings.section.title": "SQL Connection information",
"arc.azure.section.title": "Azure information", "arc.azure.section.title": "Azure information",
@@ -108,7 +107,7 @@
"arc.postgres.server.group.cores.limit": "Max CPU cores (per node) to allow", "arc.postgres.server.group.cores.limit": "Max CPU cores (per node) to allow",
"arc.postgres.server.group.memory.request": "Min memory MB (per node) to reserve", "arc.postgres.server.group.memory.request": "Min memory MB (per node) to reserve",
"arc.postgres.server.group.memory.limit": "Max memory MB (per node) to allow", "arc.postgres.server.group.memory.limit": "Max memory MB (per node) to allow",
"arc.agreement": "I accept {0}, {1} and {2}.", "arc.agreement": "I accept {0} and {1}.",
"arc.agreement.sql.terms.conditions":"Azure SQL managed instance - Azure Arc terms and conditions", "arc.agreement.sql.terms.conditions":"Azure SQL managed instance - Azure Arc terms and conditions",
"arc.agreement.postgres.terms.conditions":"PostgreSQL server groups - Azure Arc terms and conditions", "arc.agreement.postgres.terms.conditions":"PostgreSQL server groups - Azure Arc terms and conditions",
"arc.deploy.action":"Deploy" "arc.deploy.action":"Deploy"

26
extensions/arc/src/extension.ts
View File

@@ -5,9 +5,10 @@
import * as arc from 'arc'; import * as arc from 'arc';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { UserCancelledError } from './common/utils';
import { IconPathHelper, refreshActionId } from './constants'; import { IconPathHelper, refreshActionId } from './constants';
import * as loc from './localizedConstants'; import * as loc from './localizedConstants';
import { ConnectToControllerDialog } from './ui/dialogs/connectControllerDialog'; import { ConnectToControllerDialog, PasswordToControllerDialog } from './ui/dialogs/connectControllerDialog';
import { AzureArcTreeDataProvider } from './ui/tree/azureArcTreeDataProvider'; import { AzureArcTreeDataProvider } from './ui/tree/azureArcTreeDataProvider';
import { ControllerTreeNode } from './ui/tree/controllerTreeNode'; import { ControllerTreeNode } from './ui/tree/controllerTreeNode';
import { TreeNode } from './ui/tree/treeNode'; import { TreeNode } from './ui/tree/treeNode';
@@ -57,11 +58,24 @@ export async function activate(context: vscode.ExtensionContext): Promise<arc.IE
await checkArcDeploymentExtension(); await checkArcDeploymentExtension();
return { return {
getRegisteredDataControllers: async () => { getRegisteredDataControllers: async () => (await treeDataProvider.getChildren())
return (await treeDataProvider.getChildren()) .filter(node => node instanceof ControllerTreeNode)
.filter(node => node instanceof ControllerTreeNode) .map(node => ({
.map(node => (node as ControllerTreeNode).model.info); label: (node as ControllerTreeNode).model.label,
info: (node as ControllerTreeNode).model.info
})),
getControllerPassword: async (controllerInfo: arc.ControllerInfo) => {
return await treeDataProvider.getPassword(controllerInfo);
},
reacquireControllerPassword: async (controllerInfo: arc.ControllerInfo) => {
let model;
const dialog = new PasswordToControllerDialog(treeDataProvider);
dialog.showDialog(controllerInfo);
model = await dialog.waitForClose();
if (!model) {
throw new UserCancelledError();
}
return model.password;
} }
}; };
} }

5
extensions/arc/src/localizedConstants.ts
View File

@@ -73,6 +73,7 @@ export const indirect = localize('arc.indirect', "Indirect");
export const loading = localize('arc.loading', "Loading..."); export const loading = localize('arc.loading', "Loading...");
export const refreshToEnterCredentials = localize('arc.refreshToEnterCredentials', "Refresh node to enter credentials"); export const refreshToEnterCredentials = localize('arc.refreshToEnterCredentials', "Refresh node to enter credentials");
export const connectToController = localize('arc.connectToController', "Connect to Existing Controller"); export const connectToController = localize('arc.connectToController', "Connect to Existing Controller");
export const passwordToController = localize('arc.passwordToController', "Provide Password to Controller");
export const controllerUrl = localize('arc.controllerUrl', "Controller URL"); export const controllerUrl = localize('arc.controllerUrl', "Controller URL");
export const controllerName = localize('arc.controllerName', "Name"); export const controllerName = localize('arc.controllerName', "Name");
export const defaultControllerName = localize('arc.defaultControllerName', "arc-dc"); export const defaultControllerName = localize('arc.defaultControllerName', "arc-dc");
@@ -81,6 +82,7 @@ export const password = localize('arc.password', "Password");
export const rememberPassword = localize('arc.rememberPassword', "Remember Password"); export const rememberPassword = localize('arc.rememberPassword', "Remember Password");
export const connect = localize('arc.connect', "Connect"); export const connect = localize('arc.connect', "Connect");
export const cancel = localize('arc.cancel', "Cancel"); export const cancel = localize('arc.cancel', "Cancel");
export const ok = localize('arc.ok', "Ok");
export const notConfigured = localize('arc.notConfigured', "Not Configured"); export const notConfigured = localize('arc.notConfigured', "Not Configured");
// Database States - see https://docs.microsoft.com/sql/relational-databases/databases/database-states // Database States - see https://docs.microsoft.com/sql/relational-databases/databases/database-states
@@ -156,3 +158,6 @@ export function invalidResourceDeletionName(name: string): string { return local
export function couldNotFindAzureResource(name: string): string { return localize('arc.couldNotFindAzureResource', "Could not find Azure resource for {0}", name); } export function couldNotFindAzureResource(name: string): string { return localize('arc.couldNotFindAzureResource', "Could not find Azure resource for {0}", name); }
export function passwordResetFailed(error: any): string { return localize('arc.passwordResetFailed', "Failed to reset password. {0}", getErrorMessage(error)); } export function passwordResetFailed(error: any): string { return localize('arc.passwordResetFailed', "Failed to reset password. {0}", getErrorMessage(error)); }
export function errorConnectingToController(error: any): string { return localize('arc.errorConnectingToController', "Error connecting to controller. {0}", getErrorMessage(error)); } export function errorConnectingToController(error: any): string { return localize('arc.errorConnectingToController', "Error connecting to controller. {0}", getErrorMessage(error)); }
export function passwordAcquisitionFailed(error: any): string { return localize('arc.passwordAcquisitionFailed', "Failed to acquire password. {0}", getErrorMessage(error)); }
export const invalidPassword = localize('arc.invalidPassword', "The password did not work, try again.");
export function errorVerifyingPassword(error: any): string { return localize('arc.errorVerifyingPassword', "Error encountered while verifying password. {0}", getErrorMessage(error)); }

8
extensions/arc/src/typings/arc.d.ts vendored
View File

@@ -35,7 +35,13 @@ declare module 'arc' {
resources: ResourceInfo[] resources: ResourceInfo[]
}; };
export interface DataController {
label: string,
info: ControllerInfo
}
export interface IExtension { export interface IExtension {
getRegisteredDataControllers(): Promise<ControllerInfo[]>; getRegisteredDataControllers(): Promise<DataController[]>;
getControllerPassword(controllerInfo: ControllerInfo): Promise<string>;
reacquireControllerPassword(controllerInfo: ControllerInfo, password: string, retryCount?: number): Promise<string>;
} }
} }

261
extensions/arc/src/ui/dialogs/connectControllerDialog.ts
View File

@@ -5,6 +5,7 @@
import { ControllerInfo } from 'arc'; import { ControllerInfo } from 'arc';
import * as azdata from 'azdata'; import * as azdata from 'azdata';
import * as azdataExt from 'azdata-ext';
import { v4 as uuid } from 'uuid'; import { v4 as uuid } from 'uuid';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { Deferred } from '../../common/promise'; import { Deferred } from '../../common/promise';
@@ -12,94 +13,136 @@ import * as loc from '../../localizedConstants';
import { ControllerModel } from '../../models/controllerModel'; import { ControllerModel } from '../../models/controllerModel';
import { InitializingComponent } from '../components/initializingComponent'; import { InitializingComponent } from '../components/initializingComponent';
import { AzureArcTreeDataProvider } from '../tree/azureArcTreeDataProvider'; import { AzureArcTreeDataProvider } from '../tree/azureArcTreeDataProvider';
import { getErrorMessage } from '../../common/utils';
export type ConnectToControllerDialogModel = { controllerModel: ControllerModel, password: string }; export type ConnectToControllerDialogModel = { controllerModel: ControllerModel, password: string };
export class ConnectToControllerDialog extends InitializingComponent { abstract class ControllerDialogBase extends InitializingComponent {
private modelBuilder!: azdata.ModelBuilder; protected modelBuilder!: azdata.ModelBuilder;
protected dialog: azdata.window.Dialog;
private urlInputBox!: azdata.InputBoxComponent; protected urlInputBox!: azdata.InputBoxComponent;
private nameInputBox!: azdata.InputBoxComponent; protected nameInputBox!: azdata.InputBoxComponent;
private usernameInputBox!: azdata.InputBoxComponent; protected usernameInputBox!: azdata.InputBoxComponent;
private passwordInputBox!: azdata.InputBoxComponent; protected passwordInputBox!: azdata.InputBoxComponent;
private rememberPwCheckBox!: azdata.CheckBoxComponent;
private _completionPromise = new Deferred<ConnectToControllerDialogModel | undefined>(); protected getComponents(): (azdata.FormComponent<azdata.Component> & { layout?: azdata.FormItemLayout | undefined; })[] {
return [
private _id!: string; {
component: this.urlInputBox,
constructor(private _treeDataProvider: AzureArcTreeDataProvider) { title: loc.controllerUrl,
super(); required: true
}, {
component: this.nameInputBox,
title: loc.controllerName,
required: false
}, {
component: this.usernameInputBox,
title: loc.username,
required: true
}, {
component: this.passwordInputBox,
title: loc.password,
required: true
}
];
} }
public showDialog(controllerInfo?: ControllerInfo, password?: string): azdata.window.Dialog { protected abstract fieldToFocusOn(): azdata.Component;
this._id = controllerInfo?.id ?? uuid(); protected readonlyFields(): azdata.InputBoxComponent[] { return []; }
const dialog = azdata.window.createModelViewDialog(loc.connectToController);
dialog.cancelButton.onClick(() => this.handleCancel());
dialog.registerContent(async view => {
this.modelBuilder = view.modelBuilder;
this.urlInputBox = this.modelBuilder.inputBox() protected initializeFields(controllerInfo: ControllerInfo | undefined, password: string | undefined) {
.withProperties<azdata.InputBoxProperties>({ this.urlInputBox = this.modelBuilder.inputBox()
value: controllerInfo?.url, .withProperties<azdata.InputBoxProperties>({
// If we have a model then we're editing an existing connection so don't let them modify the URL value: controllerInfo?.url,
readOnly: !!controllerInfo // If we have a model then we're editing an existing connection so don't let them modify the URL
}).component(); readOnly: !!controllerInfo
this.nameInputBox = this.modelBuilder.inputBox() }).component();
.withProperties<azdata.InputBoxProperties>({ this.nameInputBox = this.modelBuilder.inputBox()
value: controllerInfo?.name .withProperties<azdata.InputBoxProperties>({
}).component(); value: controllerInfo?.name
this.usernameInputBox = this.modelBuilder.inputBox() }).component();
.withProperties<azdata.InputBoxProperties>({ this.usernameInputBox = this.modelBuilder.inputBox()
value: controllerInfo?.username .withProperties<azdata.InputBoxProperties>({
}).component(); value: controllerInfo?.username
this.passwordInputBox = this.modelBuilder.inputBox() }).component();
.withProperties<azdata.InputBoxProperties>({ this.passwordInputBox = this.modelBuilder.inputBox()
inputType: 'password', .withProperties<azdata.InputBoxProperties>({
value: password inputType: 'password',
}) value: password
.component(); }).component();
this.rememberPwCheckBox = this.modelBuilder.checkBox() }
.withProperties<azdata.CheckBoxProperties>({
label: loc.rememberPassword, protected completionPromise = new Deferred<ConnectToControllerDialogModel | undefined>();
checked: controllerInfo?.rememberPassword protected id!: string;
}).component();
constructor(protected treeDataProvider: AzureArcTreeDataProvider, title: string) {
super();
this.dialog = azdata.window.createModelViewDialog(title);
}
public showDialog(controllerInfo?: ControllerInfo, password: string | undefined = undefined): azdata.window.Dialog {
this.id = controllerInfo?.id ?? uuid();
this.dialog.cancelButton.onClick(() => this.handleCancel());
this.dialog.registerContent(async (view) => {
this.modelBuilder = view.modelBuilder;
this.initializeFields(controllerInfo, password);
let formModel = this.modelBuilder.formContainer() let formModel = this.modelBuilder.formContainer()
.withFormItems([{ .withFormItems([{
components: [ components: this.getComponents(),
{
component: this.urlInputBox,
title: loc.controllerUrl,
required: true
}, {
component: this.nameInputBox,
title: loc.controllerName,
required: false
}, {
component: this.usernameInputBox,
title: loc.username,
required: true
}, {
component: this.passwordInputBox,
title: loc.password,
required: true
}, {
component: this.rememberPwCheckBox,
title: ''
}
],
title: '' title: ''
}]).withLayout({ width: '100%' }).component(); }]).withLayout({ width: '100%' }).component();
await view.initializeModel(formModel); await view.initializeModel(formModel);
this.urlInputBox.focus(); await this.fieldToFocusOn().focus();
this.readonlyFields().forEach(f => f.readOnly = true);
this.initialized = true; this.initialized = true;
}); });
dialog.registerCloseValidator(async () => await this.validate()); this.dialog.registerCloseValidator(async () => await this.validate());
dialog.okButton.label = loc.connect; this.dialog.okButton.label = loc.connect;
dialog.cancelButton.label = loc.cancel; this.dialog.cancelButton.label = loc.cancel;
azdata.window.openDialog(dialog); azdata.window.openDialog(this.dialog);
return dialog; return this.dialog;
}
public abstract async validate(): Promise<boolean>;
private handleCancel(): void {
this.completionPromise.resolve(undefined);
}
public waitForClose(): Promise<ConnectToControllerDialogModel | undefined> {
return this.completionPromise.promise;
}
}
export class ConnectToControllerDialog extends ControllerDialogBase {
protected rememberPwCheckBox!: azdata.CheckBoxComponent;
protected fieldToFocusOn() {
return this.urlInputBox;
}
protected getComponents() {
return [
...super.getComponents(),
{
component: this.rememberPwCheckBox,
title: ''
}];
}
protected initializeFields(controllerInfo: ControllerInfo | undefined, password: string | undefined) {
super.initializeFields(controllerInfo, password);
this.rememberPwCheckBox = this.modelBuilder.checkBox()
.withProperties<azdata.CheckBoxProperties>({
label: loc.rememberPassword,
checked: controllerInfo?.rememberPassword
}).component();
}
constructor(treeDataProvider: AzureArcTreeDataProvider) {
super(treeDataProvider, loc.connectToController);
} }
public async validate(): Promise<boolean> { public async validate(): Promise<boolean> {
@@ -120,32 +163,86 @@ export class ConnectToControllerDialog extends InitializingComponent {
url = `${url}:30080`; url = `${url}:30080`;
} }
const controllerInfo: ControllerInfo = { const controllerInfo: ControllerInfo = {
id: this._id, id: this.id,
url: url, url: url,
name: this.nameInputBox.value ?? '', name: this.nameInputBox.value ?? '',
username: this.usernameInputBox.value, username: this.usernameInputBox.value,
rememberPassword: this.rememberPwCheckBox.checked ?? false, rememberPassword: this.rememberPwCheckBox.checked ?? false,
resources: [] resources: []
}; };
const controllerModel = new ControllerModel(this._treeDataProvider, controllerInfo, this.passwordInputBox.value); const controllerModel = new ControllerModel(this.treeDataProvider, controllerInfo, this.passwordInputBox.value);
try { try {
// Validate that we can connect to the controller, this also populates the controllerRegistration from the connection response. // Validate that we can connect to the controller, this also populates the controllerRegistration from the connection response.
await controllerModel.refresh(false); await controllerModel.refresh(false);
// default info.name to the name of the controller instance if the user did not specify their own and to a pre-canned default if for some weird reason controller endpoint returned instanceName is also not a valid value // default info.name to the name of the controller instance if the user did not specify their own and to a pre-canned default if for some weird reason controller endpoint returned instanceName is also not a valid value
controllerModel.info.name = controllerModel.info.name || controllerModel.controllerConfig?.metadata.name || loc.defaultControllerName; controllerModel.info.name = controllerModel.info.name || controllerModel.controllerConfig?.metadata.name || loc.defaultControllerName;
} catch (err) { } catch (err) {
vscode.window.showErrorMessage(loc.connectToControllerFailed(this.urlInputBox.value, err)); this.dialog.message = {
text: loc.connectToControllerFailed(this.urlInputBox.value, err),
level: azdata.window.MessageLevel.Error
};
return false; return false;
} }
this._completionPromise.resolve({ controllerModel: controllerModel, password: this.passwordInputBox.value }); this.completionPromise.resolve({ controllerModel: controllerModel, password: this.passwordInputBox.value });
return true;
}
}
export class PasswordToControllerDialog extends ControllerDialogBase {
constructor(treeDataProvider: AzureArcTreeDataProvider) {
super(treeDataProvider, loc.passwordToController);
}
protected fieldToFocusOn() {
return this.passwordInputBox;
}
protected readonlyFields() {
return [
this.urlInputBox,
this.nameInputBox,
this.usernameInputBox
];
}
public async validate(): Promise<boolean> {
if (!this.passwordInputBox.value) {
return false;
}
const azdataApi = <azdataExt.IExtension>vscode.extensions.getExtension(azdataExt.extension.name)?.exports;
try {
await azdataApi.azdata.login(this.urlInputBox.value!, this.usernameInputBox.value!, this.passwordInputBox.value);
} catch (e) {
if (getErrorMessage(e).match(/Wrong username or password/i)) {
this.dialog.message = {
text: loc.invalidPassword,
level: azdata.window.MessageLevel.Error
};
return false;
} else {
this.dialog.message = {
text: loc.errorVerifyingPassword(e),
level: azdata.window.MessageLevel.Error
};
return false;
}
}
const controllerInfo: ControllerInfo = {
id: this.id,
url: this.urlInputBox.value!,
name: this.nameInputBox.value!,
username: this.usernameInputBox.value!,
rememberPassword: false,
resources: []
};
const controllerModel = new ControllerModel(this.treeDataProvider, controllerInfo, this.passwordInputBox.value);
this.completionPromise.resolve({ controllerModel: controllerModel, password: this.passwordInputBox.value });
return true; return true;
} }
private handleCancel(): void { public showDialog(controllerInfo?: ControllerInfo): azdata.window.Dialog {
this._completionPromise.resolve(undefined); const dialog = super.showDialog(controllerInfo);
} dialog.okButton.label = loc.ok;
return dialog;
public waitForClose(): Promise<ConnectToControllerDialogModel | undefined> {
return this._completionPromise.promise;
} }
} }

50
extensions/azdata/src/azdata.ts
View File

@@ -4,6 +4,7 @@
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import * as azdataExt from 'azdata-ext'; import * as azdataExt from 'azdata-ext';
import * as fs from 'fs';
import * as os from 'os'; import * as os from 'os';
import { SemVer } from 'semver'; import { SemVer } from 'semver';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
@@ -13,7 +14,6 @@ import Logger from './common/logger';
import { getErrorMessage, searchForCmd } from './common/utils'; import { getErrorMessage, searchForCmd } from './common/utils';
import { azdataAcceptEulaKey, azdataConfigSection, azdataFound, azdataHostname, azdataInstallKey, azdataReleaseJson, azdataUpdateKey, azdataUri, debugConfigKey, eulaAccepted, eulaUrl, microsoftPrivacyStatementUrl } from './constants'; import { azdataAcceptEulaKey, azdataConfigSection, azdataFound, azdataHostname, azdataInstallKey, azdataReleaseJson, azdataUpdateKey, azdataUri, debugConfigKey, eulaAccepted, eulaUrl, microsoftPrivacyStatementUrl } from './constants';
import * as loc from './localizedConstants'; import * as loc from './localizedConstants';
import * as fs from 'fs';
const enum AzdataDeployOption { const enum AzdataDeployOption {
dontPrompt = 'dontPrompt', dontPrompt = 'dontPrompt',
@@ -24,9 +24,6 @@ const enum AzdataDeployOption {
* Interface for an object to interact with the azdata tool installed on the box. * Interface for an object to interact with the azdata tool installed on the box.
*/ */
export interface IAzdataTool extends azdataExt.IAzdataApi { export interface IAzdataTool extends azdataExt.IAzdataApi {
path: string,
cachedVersion: SemVer
/** /**
* Executes azdata with the specified arguments (e.g. --version) and returns the result * Executes azdata with the specified arguments (e.g. --version) and returns the result
* @param args The args to pass to azdata * @param args The args to pass to azdata
@@ -39,9 +36,26 @@ export interface IAzdataTool extends azdataExt.IAzdataApi {
* An object to interact with the azdata tool installed on the box. * An object to interact with the azdata tool installed on the box.
*/ */
export class AzdataTool implements IAzdataTool { export class AzdataTool implements IAzdataTool {
public cachedVersion: SemVer;
constructor(public path: string, version: string) { private _semVersion: SemVer;
this.cachedVersion = new SemVer(version); constructor(private _path: string, version: string) {
this._semVersion = new SemVer(version);
}
/**
* The semVersion corresponding to this installation of azdata. version() method should have been run
* before fetching this value to ensure that correct value is returned. This is almost always correct unless
* Azdata has gotten reinstalled in the background after this IAzdataApi object was constructed.
*/
public getSemVersion() {
return this._semVersion;
}
/**
* gets the path where azdata tool is installed
*/
public getPath() {
return this._path;
} }
public arc = { public arc = {
@@ -110,8 +124,8 @@ export class AzdataTool implements IAzdataTool {
* It also updates the cachedVersion property based on the return value from the tool. * It also updates the cachedVersion property based on the return value from the tool.
*/ */
public async version(): Promise<azdataExt.AzdataOutput<string>> { public async version(): Promise<azdataExt.AzdataOutput<string>> {
const output = await executeAzdataCommand(`"${this.path}"`, ['--version']); const output = await executeAzdataCommand(`"${this._path}"`, ['--version']);
this.cachedVersion = new SemVer(parseVersion(output.stdout)); this._semVersion = new SemVer(parseVersion(output.stdout));
return { return {
logs: [], logs: [],
stdout: output.stdout.split(os.EOL), stdout: output.stdout.split(os.EOL),
@@ -122,7 +136,7 @@ export class AzdataTool implements IAzdataTool {
public async executeCommand<R>(args: string[], additionalEnvVars?: { [key: string]: string }): Promise<azdataExt.AzdataOutput<R>> { public async executeCommand<R>(args: string[], additionalEnvVars?: { [key: string]: string }): Promise<azdataExt.AzdataOutput<R>> {
try { try {
const output = JSON.parse((await executeAzdataCommand(`"${this.path}"`, args.concat(['--output', 'json']), additionalEnvVars)).stdout); const output = JSON.parse((await executeAzdataCommand(`"${this._path}"`, args.concat(['--output', 'json']), additionalEnvVars)).stdout);
return { return {
logs: <string[]>output.log, logs: <string[]>output.log,
stdout: <string[]>output.stdout, stdout: <string[]>output.stdout,
@@ -136,12 +150,12 @@ export class AzdataTool implements IAzdataTool {
// to get the correct stderr out. The actual value we get is something like // to get the correct stderr out. The actual value we get is something like
// ERROR: { stderr: '...' } // ERROR: { stderr: '...' }
// so we also need to trim off the start that isn't a valid JSON blob // so we also need to trim off the start that isn't a valid JSON blob
err.stderr = JSON.parse(err.stderr.substring(err.stderr.indexOf('{'))).stderr; err.stderr = JSON.parse(err.stderr.substring(err.stderr.indexOf('{'), err.stderr.indexOf('}') + 1)).stderr;
} catch (err) { } catch (err) {
// it means this was probably some other generic error (such as command not being found) // it means this was probably some other generic error (such as command not being found)
// check if azdata still exists if it does then rethrow the original error if not then emit a new specific error. // check if azdata still exists if it does then rethrow the original error if not then emit a new specific error.
try { try {
await fs.promises.access(this.path); await fs.promises.access(this._path);
//this.path exists //this.path exists
throw err; // rethrow the error throw err; // rethrow the error
} catch (e) { } catch (e) {
@@ -176,7 +190,7 @@ export async function findAzdata(): Promise<IAzdataTool> {
try { try {
const azdata = await findSpecificAzdata(); const azdata = await findSpecificAzdata();
await vscode.commands.executeCommand('setContext', azdataFound, true); // save a context key that azdata was found so that command for installing azdata is no longer available in commandPalette and that for updating it is. await vscode.commands.executeCommand('setContext', azdataFound, true); // save a context key that azdata was found so that command for installing azdata is no longer available in commandPalette and that for updating it is.
Logger.log(loc.foundExistingAzdata(azdata.path, azdata.cachedVersion.raw)); Logger.log(loc.foundExistingAzdata(azdata.getPath(), azdata.getSemVersion().raw));
return azdata; return azdata;
} catch (err) { } catch (err) {
Logger.log(loc.couldNotFindAzdata(err)); Logger.log(loc.couldNotFindAzdata(err));
@@ -262,12 +276,12 @@ export async function checkAndInstallAzdata(userRequested: boolean = false): Pro
*/ */
export async function checkAndUpdateAzdata(currentAzdata?: IAzdataTool, userRequested: boolean = false): Promise<boolean> { export async function checkAndUpdateAzdata(currentAzdata?: IAzdataTool, userRequested: boolean = false): Promise<boolean> {
if (currentAzdata !== undefined) { if (currentAzdata !== undefined) {
const newVersion = await discoverLatestAvailableAzdataVersion(); const newSemVersion = await discoverLatestAvailableAzdataVersion();
if (newVersion.compare(currentAzdata.cachedVersion) === 1) { if (newSemVersion.compare(currentAzdata.getSemVersion()) === 1) {
Logger.log(loc.foundAzdataVersionToUpdateTo(newVersion.raw, currentAzdata.cachedVersion.raw)); Logger.log(loc.foundAzdataVersionToUpdateTo(newSemVersion.raw, currentAzdata.getSemVersion().raw));
return await promptToUpdateAzdata(newVersion.raw, userRequested); return await promptToUpdateAzdata(newSemVersion.raw, userRequested);
} else { } else {
Logger.log(loc.currentlyInstalledVersionIsLatest(currentAzdata.cachedVersion.raw)); Logger.log(loc.currentlyInstalledVersionIsLatest(currentAzdata.getSemVersion().raw));
} }
} else { } else {
Logger.log(loc.updateCheckSkipped); Logger.log(loc.updateCheckSkipped);

46
extensions/azdata/src/extension.ts
View File

@@ -12,7 +12,6 @@ import * as loc from './localizedConstants';
let localAzdata: IAzdataTool | undefined = undefined; let localAzdata: IAzdataTool | undefined = undefined;
let eulaAccepted: boolean = false; let eulaAccepted: boolean = false;
export async function activate(context: vscode.ExtensionContext): Promise<azdataExt.IExtension> { export async function activate(context: vscode.ExtensionContext): Promise<azdataExt.IExtension> {
vscode.commands.registerCommand('azdata.acceptEula', async () => { vscode.commands.registerCommand('azdata.acceptEula', async () => {
eulaAccepted = await promptForEula(context.globalState, true /* userRequested */); eulaAccepted = await promptForEula(context.globalState, true /* userRequested */);
@@ -59,26 +58,27 @@ export async function activate(context: vscode.ExtensionContext): Promise<azdata
}); });
return { return {
isEulaAccepted: () => !!context.globalState.get<boolean>(constants.eulaAccepted),
azdata: { azdata: {
arc: { arc: {
dc: { dc: {
create: async (namespace: string, name: string, connectivityMode: string, resourceGroup: string, location: string, subscription: string, profileName?: string, storageClass?: string) => { create: async (namespace: string, name: string, connectivityMode: string, resourceGroup: string, location: string, subscription: string, profileName?: string, storageClass?: string) => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdataOrEulaNotAccepted();
return localAzdata!.arc.dc.create(namespace, name, connectivityMode, resourceGroup, location, subscription, profileName, storageClass); return localAzdata!.arc.dc.create(namespace, name, connectivityMode, resourceGroup, location, subscription, profileName, storageClass);
}, },
endpoint: { endpoint: {
list: async () => { list: async () => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdataOrEulaNotAccepted();
return localAzdata!.arc.dc.endpoint.list(); return localAzdata!.arc.dc.endpoint.list();
} }
}, },
config: { config: {
list: async () => { list: async () => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdataOrEulaNotAccepted();
return localAzdata!.arc.dc.config.list(); return localAzdata!.arc.dc.config.list();
}, },
show: async () => { show: async () => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdataOrEulaNotAccepted();
return localAzdata!.arc.dc.config.show(); return localAzdata!.arc.dc.config.show();
} }
} }
@@ -86,11 +86,11 @@ export async function activate(context: vscode.ExtensionContext): Promise<azdata
postgres: { postgres: {
server: { server: {
list: async () => { list: async () => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdataOrEulaNotAccepted();
return localAzdata!.arc.postgres.server.list(); return localAzdata!.arc.postgres.server.list();
}, },
show: async (name: string) => { show: async (name: string) => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdataOrEulaNotAccepted();
return localAzdata!.arc.postgres.server.show(name); return localAzdata!.arc.postgres.server.show(name);
} }
} }
@@ -98,41 +98,53 @@ export async function activate(context: vscode.ExtensionContext): Promise<azdata
sql: { sql: {
mi: { mi: {
delete: async (name: string) => { delete: async (name: string) => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdataOrEulaNotAccepted();
return localAzdata!.arc.sql.mi.delete(name); return localAzdata!.arc.sql.mi.delete(name);
}, },
list: async () => { list: async () => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdataOrEulaNotAccepted();
return localAzdata!.arc.sql.mi.list(); return localAzdata!.arc.sql.mi.list();
}, },
show: async (name: string) => { show: async (name: string) => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdataOrEulaNotAccepted();
return localAzdata!.arc.sql.mi.show(name); return localAzdata!.arc.sql.mi.show(name);
} }
} }
} }
}, },
getPath: () => {
throwIfNoAzdata();
return localAzdata!.getPath();
},
login: async (endpoint: string, username: string, password: string) => { login: async (endpoint: string, username: string, password: string) => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdataOrEulaNotAccepted();
return localAzdata!.login(endpoint, username, password); return localAzdata!.login(endpoint, username, password);
}, },
getSemVersion: () => {
throwIfNoAzdata();
return localAzdata!.getSemVersion();
},
version: async () => { version: async () => {
await throwIfNoAzdataOrEulaNotAccepted(); throwIfNoAzdata();
return localAzdata!.version(); return localAzdata!.version();
} }
} }
}; };
} }
async function throwIfNoAzdataOrEulaNotAccepted(): Promise<void> { function throwIfNoAzdataOrEulaNotAccepted(): void {
if (!localAzdata) { throwIfNoAzdata();
Logger.log(loc.noAzdata);
throw new Error(loc.noAzdata);
}
if (!eulaAccepted) { if (!eulaAccepted) {
Logger.log(loc.eulaNotAccepted); Logger.log(loc.eulaNotAccepted);
throw new Error(loc.eulaNotAccepted); throw new Error(loc.eulaNotAccepted);
} }
} }
function throwIfNoAzdata() {
if (!localAzdata) {
Logger.log(loc.noAzdata);
throw new Error(loc.noAzdata);
}
}
export function deactivate(): void { } export function deactivate(): void { }

10
extensions/azdata/src/localizedConstants.ts
View File

@@ -23,7 +23,7 @@ export const decline = localize('azdata.decline', "Decline");
export const doNotAskAgain = localize('azdata.doNotAskAgain', "Don't Ask Again"); export const doNotAskAgain = localize('azdata.doNotAskAgain', "Don't Ask Again");
export const askLater = localize('azdata.askLater', "Ask Later"); export const askLater = localize('azdata.askLater', "Ask Later");
export const downloadingTo = (name: string, location: string): string => localize('azdata.downloadingTo', "Downloading {0} to {1}", name, location); export const downloadingTo = (name: string, location: string): string => localize('azdata.downloadingTo', "Downloading {0} to {1}", name, location);
export const executingCommand = (command: string, args: string[]): string => localize('azdata.executingCommand', "Executing command \"{0} {1}\"", command, args?.join(' ')); export const executingCommand = (command: string, args: string[]): string => localize('azdata.executingCommand', "Executing command: '{0} {1}'", command, args?.join(' '));
export const stdoutOutput = (stdout: string): string => localize('azdata.stdoutOutput', "stdout: {0}", stdout); export const stdoutOutput = (stdout: string): string => localize('azdata.stdoutOutput', "stdout: {0}", stdout);
export const stderrOutput = (stderr: string): string => localize('azdata.stderrOutput', "stderr: {0}", stderr); export const stderrOutput = (stderr: string): string => localize('azdata.stderrOutput', "stderr: {0}", stderr);
export const checkingLatestAzdataVersion = localize('azdata.checkingLatestAzdataVersion', "Checking for latest available version of azdata"); export const checkingLatestAzdataVersion = localize('azdata.checkingLatestAzdataVersion', "Checking for latest available version of azdata");
@@ -56,11 +56,11 @@ export const userRequestedInstall = localize('azdata.userRequestedInstall', "Use
export const userRequestedUpdate = localize('azdata.userRequestedUpdate', "User requested to update Azure Data CLI using 'Azure Data CLI: Check for Update' command"); export const userRequestedUpdate = localize('azdata.userRequestedUpdate', "User requested to update Azure Data CLI using 'Azure Data CLI: Check for Update' command");
export const userRequestedAcceptEula = localize('azdata.acceptEula', "User requested to be prompted for accepting EULA by invoking 'Azure Data CLI: Accept EULA' command"); export const userRequestedAcceptEula = localize('azdata.acceptEula', "User requested to be prompted for accepting EULA by invoking 'Azure Data CLI: Accept EULA' command");
export const updateCheckSkipped = localize('azdata.updateCheckSkipped', "No check for new Azure Data CLI version availability performed as Azure Data CLI was not found to be installed"); export const updateCheckSkipped = localize('azdata.updateCheckSkipped', "No check for new Azure Data CLI version availability performed as Azure Data CLI was not found to be installed");
export const eulaNotAccepted = localize('azdata.eulaNotAccepted', "Microsoft Privacy statement and Azure Data CLI license terms have not been accepted, [accept the EULA](command:azdata.acceptEula) to use the features that require it."); export const eulaNotAccepted = localize('azdata.eulaNotAccepted', "Microsoft Privacy statement and Azure Data CLI license terms have not been accepted. Execute the command: [Azure Data CLI: Accept EULA](command:azdata.acceptEula) to accept EULA to enable the features that requires Azure Data CLI.");
export const installManually = (expectedVersion: string, instructionsUrl: string) => localize('azdata.installManually', "Azure Data CLI is not installed. Version: {0} needs to be installed or some features may not work. Please install it manually using these [instructions]({1}). Restart ADS when installation is done.", expectedVersion, instructionsUrl); export const installManually = (expectedVersion: string, instructionsUrl: string) => localize('azdata.installManually', "Azure Data CLI is not installed. Version: {0} needs to be installed or some features may not work. Please install it manually using these [instructions]({1}). Restart ADS when installation is done.", expectedVersion, instructionsUrl);
export const installCorrectVersionManually = (currentVersion: string, expectedVersion: string, instructionsUrl: string) => localize('azdata.installCorrectVersionManually', "Azure Data CLI version: {0} is installed, version: {1} needs to be installed or some features may not work. Please uninstall the current version and then install the correct version manually using these [instructions]({2}). Restart ADS when installation is done.", currentVersion, expectedVersion, instructionsUrl); export const installCorrectVersionManually = (currentVersion: string, expectedVersion: string, instructionsUrl: string) => localize('azdata.installCorrectVersionManually', "Azure Data CLI version: {0} is installed, version: {1} needs to be installed or some features may not work. Please uninstall the current version and then install the correct version manually using these [instructions]({2}). Restart ADS when installation is done.", currentVersion, expectedVersion, instructionsUrl);
export const promptForEula = (privacyStatementUrl: string, eulaUrl: string) => localize('azdata.promptForEula', "It is required to accept the [Microsoft Privacy Statement]({0}) and the [Azure Data CLI license terms]({1}) to use this extension. Declining this will result in some features not working.", privacyStatementUrl, eulaUrl); export const promptForEula = (privacyStatementUrl: string, eulaUrl: string) => localize('azdata.promptForEula', "It is required to accept the [Microsoft Privacy Statement]({0}) and the [Azure Data CLI license terms]({1}) to use this extension. Declining this will result in some features not working.", privacyStatementUrl, eulaUrl);
export const promptForEulaLog = (privacyStatementUrl: string, eulaUrl: string) => promptLog(promptForEula(privacyStatementUrl, eulaUrl)); export const promptForEulaLog = (privacyStatementUrl: string, eulaUrl: string) => promptLog(promptForEula(privacyStatementUrl, eulaUrl));
export const userResponseToEulaPrompt = (response: string | undefined) => localize('azdata.promptForEulaResponse', "User response to Eula prompt: {0}", response); export const userResponseToEulaPrompt = (response: string | undefined) => localize('azdata.promptForEulaResponse', "User response to EULA prompt: {0}", response);
export const eulaAcceptedStateOnStartup = (eulaAccepted: boolean) => localize('azdata.eulaAcceptedStateOnStartup', "eulaAccepted state on startup: {0}", eulaAccepted); export const eulaAcceptedStateOnStartup = (eulaAccepted: boolean) => localize('azdata.eulaAcceptedStateOnStartup', "'EULA Accepted' state on startup: {0}", eulaAccepted);
export const eulaAcceptedStateUpdated = (eulaAccepted: boolean) => localize('azdata.eulaAcceptedStateUpdated', "Updated 'eulaAccepted' state to: {0}", eulaAccepted); export const eulaAcceptedStateUpdated = (eulaAccepted: boolean) => localize('azdata.eulaAcceptedStateUpdated', "Updated 'EULA Accepted' state to: {0}", eulaAccepted);

5
extensions/azdata/src/test/azdata.test.ts
View File

@@ -4,7 +4,6 @@
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import * as path from 'path'; import * as path from 'path';
import { SemVer } from 'semver';
import * as should from 'should'; import * as should from 'should';
import * as sinon from 'sinon'; import * as sinon from 'sinon';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
@@ -12,10 +11,10 @@ import * as azdata from '../azdata';
import * as childProcess from '../common/childProcess'; import * as childProcess from '../common/childProcess';
import { HttpClient } from '../common/httpClient'; import { HttpClient } from '../common/httpClient';
import * as utils from '../common/utils'; import * as utils from '../common/utils';
import * as loc from '../localizedConstants';
import * as constants from '../constants'; import * as constants from '../constants';
import * as loc from '../localizedConstants';
const oldAzdataMock = <azdata.AzdataTool>{ path: '/path/to/azdata', cachedVersion: new SemVer('0.0.0') }; const oldAzdataMock = new azdata.AzdataTool('/path/to/azdata', '0.0.0');
const releaseJson = { const releaseJson = {
win32: { win32: {
'version': '9999.999.999', 'version': '9999.999.999',

14
extensions/azdata/src/typings/azdata-ext.d.ts vendored
View File

@@ -4,6 +4,8 @@
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
declare module 'azdata-ext' { declare module 'azdata-ext' {
import { SemVer } from 'semver';
/** /**
* Covers defining what the azdata extension exports to other extensions * Covers defining what the azdata extension exports to other extensions
* *
@@ -80,7 +82,7 @@ declare module 'azdata-ext' {
location: string, // "eastus2euap", location: string, // "eastus2euap",
resourceGroup: string, // "my-rg", resourceGroup: string, // "my-rg",
subscription: string, // "a5082b29-8c6e-4bc5-8ddd-8ef39dfebc39" subscription: string, // "a5082b29-8c6e-4bc5-8ddd-8ef39dfebc39"
}, },
controller: { controller: {
'enableBilling': string, // "True" 'enableBilling': string, // "True"
'logs.rotation.days': string, // "7" 'logs.rotation.days': string, // "7"
@@ -224,12 +226,20 @@ declare module 'azdata-ext' {
show(name: string): Promise<AzdataOutput<SqlMiShowResult>> show(name: string): Promise<AzdataOutput<SqlMiShowResult>>
} }
} }
} },
getPath(): string,
login(endpoint: string, username: string, password: string): Promise<AzdataOutput<any>>, login(endpoint: string, username: string, password: string): Promise<AzdataOutput<any>>,
/**
* The semVersion corresponding to this installation of azdata. version() method should have been run
* before fetching this value to ensure that correct value is returned. This is almost always correct unless
* Azdata has gotten reinstalled in the background after this IAzdataApi object was constructed.
*/
getSemVersion(): SemVer,
version(): Promise<AzdataOutput<string>> version(): Promise<AzdataOutput<string>>
} }
export interface IExtension { export interface IExtension {
azdata: IAzdataApi; azdata: IAzdataApi;
isEulaAccepted(): boolean;
} }
} }

6
extensions/resource-deployment/package.json
View File

@@ -397,18 +397,20 @@
"dependencies": { "dependencies": {
"linux-release-info": "^2.0.0", "linux-release-info": "^2.0.0",
"promisify-child-process": "^3.1.1", "promisify-child-process": "^3.1.1",
"semver": "^7.3.2",
"sudo-prompt": "9.1.1", "sudo-prompt": "9.1.1",
"vscode-nls": "^4.0.0", "vscode-nls": "^4.0.0",
"yamljs": "^0.3.0" "yamljs": "^0.3.0"
}, },
"devDependencies": { "devDependencies": {
"@types/mocha": "^5.2.5", "@types/mocha": "^5.2.5",
"@types/semver": "^7.3.1",
"@types/yamljs": "0.2.30", "@types/yamljs": "0.2.30",
"mocha": "^5.2.0", "mocha": "^5.2.0",
"mocha-junit-reporter": "^1.17.0", "mocha-junit-reporter": "^1.17.0",
"mocha-multi-reporters": "^1.1.7", "mocha-multi-reporters": "^1.1.7",
"should": "^13.2.3",
"typemoq": "^2.1.0", "typemoq": "^2.1.0",
"vscodetestcover": "^1.1.0", "vscodetestcover": "^1.1.0"
"should": "^13.2.3"
} }
} }

83
extensions/resource-deployment/src/helpers/cacheManager.ts Normal file
View File

@@ -0,0 +1,83 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { Deferred } from './promise';
const enum Status {
notStarted,
inProgress,
done
}
interface State<T> {
entry?: T,
error?: Error,
status: Status,
id: number,
pendingOperation: Deferred<void>
}
/**
* An implementation of Cache Manager which ensures that only one call to populate cache miss is pending at a given time.
* All remaining calls for retrieval are awaited until the one in progress finishes and then all awaited calls are resolved with the value
* from the cache.
*/
export class CacheManager<K, T> {
private _cache = new Map<K, State<T>>();
private _id = 0;
public async getCacheEntry(key: K, retrieveEntry: (key: K) => Promise<T>): Promise<T> {
const cacheHit: State<T> | undefined = this._cache.get(key);
// each branch either throws or returns the password.
if (cacheHit === undefined) {
// populate a new state entry and add it to the cache
const state: State<T> = {
status: Status.notStarted,
id: this._id++,
pendingOperation: new Deferred<void>()
};
this._cache.set(key, state);
// now that we have the state entry initialized, retry to fetch the cacheEntry
let returnValue: T = await this.getCacheEntry(key, retrieveEntry);
await state.pendingOperation;
return returnValue!;
} else {
switch (cacheHit.status) {
case Status.notStarted: {
cacheHit.status = Status.inProgress;
// retrieve and populate the missed cache hit.
try {
cacheHit.entry = await retrieveEntry(key);
} catch (error) {
cacheHit.error = error;
} finally {
cacheHit.status = Status.done;
// we do not reject here even in error case because we do not want our awaits on pendingOperation to throw
// We track our own error state and when all done we throw if an error had happened. This results
// in the rejection of the promised returned by this method.
cacheHit.pendingOperation.resolve();
}
return await this.getCacheEntry(key, retrieveEntry);
}
case Status.inProgress: {
await cacheHit.pendingOperation;
return await this.getCacheEntry(key, retrieveEntry);
}
case Status.done: {
if (cacheHit.error !== undefined) {
await cacheHit.pendingOperation;
throw cacheHit.error;
}
else {
await cacheHit.pendingOperation;
return cacheHit.entry!;
}
}
}
}
}
}

84
extensions/resource-deployment/src/helpers/optionSources.ts Normal file
View File

@@ -0,0 +1,84 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as arc from 'arc';
import { CategoryValue } from 'azdata';
import { IOptionsSource } from '../interfaces';
import * as loc from '../localizedConstants';
import { apiService } from '../services/apiService';
import { throwUnless } from '../utils';
import { CacheManager } from './cacheManager';
export enum OptionsSourceType {
ArcControllersOptionsSource = 'ArcControllersOptionsSource'
}
export abstract class OptionsSource implements IOptionsSource {
get type(): OptionsSourceType { return this._type; }
get variableNames(): { [index: string]: string; } { return this._variableNames; }
abstract async getOptions(): Promise<string[] | CategoryValue[]>;
abstract async getVariableValue(variableName: string, input: string): Promise<string>;
abstract getIsPassword(variableName: string): boolean;
constructor(private _variableNames: { [index: string]: string }, private _type: OptionsSourceType) {
}
}
export class ArcControllersOptionsSource extends OptionsSource {
private _cacheManager = new CacheManager<string, string>();
async getOptions(): Promise<string[] | CategoryValue[]> {
const controllers = await apiService.arcApi.getRegisteredDataControllers();
throwUnless(controllers !== undefined && controllers.length !== 0, loc.noControllersConnected);
return controllers.map(ci => {
return ci.label;
});
}
async getVariableValue(variableName: string, controllerLabel: string): Promise<string> {
const retrieveVariable = async (key: string) => {
const [variableName, controllerLabel] = JSON.parse(key);
const controllers = await apiService.arcApi.getRegisteredDataControllers();
const controller = controllers!.find(ci => ci.label === controllerLabel);
throwUnless(controller !== undefined, loc.noControllerInfoFound(controllerLabel));
switch (variableName) {
case 'endpoint':
return controller.info.url;
case 'username':
return controller.info.username;
case 'password':
const fetchedPassword = await this.getPassword(controller);
return fetchedPassword;
default:
throw new Error(loc.variableValueFetchForUnsupportedVariable(variableName));
}
};
const variableValue = await this._cacheManager.getCacheEntry(JSON.stringify([variableName, controllerLabel]), retrieveVariable);
return variableValue;
}
private async getPassword(controller: arc.DataController): Promise<string> {
let password = await apiService.arcApi.getControllerPassword(controller.info);
if (!password) {
password = await apiService.arcApi.reacquireControllerPassword(controller.info, password);
}
throwUnless(password !== undefined, loc.noPasswordFound(controller.label));
return password;
}
getIsPassword(variableName: string): boolean {
switch (variableName) {
case 'endpoint':
case 'username':
return false;
case 'password':
return true;
default:
throw new Error(loc.isPasswordFetchForUnsupportedVariable(variableName));
}
}
}

25
extensions/resource-deployment/src/helpers/promise.ts Normal file
View File

@@ -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<T> {
promise: Promise<T>;
resolve!: (value?: T | PromiseLike<T>) => void;
reject!: (reason?: any) => void;
constructor() {
this.promise = new Promise<T>((resolve, reject) => {
this.resolve = resolve;
this.reject = reject;
});
}
then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Thenable<TResult>;
then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => void): Thenable<TResult>;
then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Thenable<TResult> {
return this.promise.then(onfulfilled, onrejected);
}
}

13
extensions/resource-deployment/src/interfaces.ts
View File

@@ -5,6 +5,7 @@
import * as azdata from 'azdata'; import * as azdata from 'azdata';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { OptionsSourceType } from './helpers/optionSources';
export const NoteBookEnvironmentVariablePrefix = 'AZDATA_NB_VAR_'; export const NoteBookEnvironmentVariablePrefix = 'AZDATA_NB_VAR_';
@@ -171,9 +172,18 @@ export type ComponentCSSStyles = {
[key: string]: string; [key: string]: string;
}; };
export interface IOptionsSource {
readonly type: OptionsSourceType,
readonly variableNames: { [index: string]: string; },
getOptions(): Promise<string[] | azdata.CategoryValue[]>,
getVariableValue(variableName: string, input: string): Promise<string>;
getIsPassword(variableName: string): boolean;
}
export interface OptionsInfo { export interface OptionsInfo {
values: string[] | azdata.CategoryValue[], values?: string[] | azdata.CategoryValue[],
source?: IOptionsSource,
defaultValue: string, defaultValue: string,
optionsType?: OptionsType optionsType?: OptionsType
} }
@@ -363,6 +373,7 @@ export interface ITool {
finishInitialization(): Promise<void>; finishInitialization(): Promise<void>;
install(): Promise<void>; install(): Promise<void>;
isSameOrNewerThan(version: string): boolean; isSameOrNewerThan(version: string): boolean;
validateEula(): boolean;
} }
export const enum BdcDeploymentType { export const enum BdcDeploymentType {

19
extensions/resource-deployment/src/localizedConstants.ts
View File

@@ -4,6 +4,8 @@
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import * as nls from 'vscode-nls'; import * as nls from 'vscode-nls';
import { FieldType, OptionsType } from './interfaces';
import { OptionsSourceType } from './helpers/optionSources';
const localize = nls.loadMessageBundle(); const localize = nls.loadMessageBundle();
@@ -13,12 +15,23 @@ export const resourceGroup = localize('azure.account.resourceGroup', "Resource G
export const location = localize('azure.account.location', "Azure Location"); export const location = localize('azure.account.location', "Azure Location");
export const browse = localize('filePicker.browse', "Browse"); export const browse = localize('filePicker.browse', "Browse");
export const select = localize('filePicker.select', "Select"); export const select = localize('filePicker.select', "Select");
export const kubeConfigFilePath = localize('kubeConfigClusterPicker.kubeConfigFilePatht', "Kube config file path"); export const kubeConfigFilePath = localize('kubeConfigClusterPicker.kubeConfigFilePath', "Kube config file path");
export const clusterContextNotFound = localize('kubeConfigClusterPicker.clusterContextNotFound', "No cluster context information found"); export const clusterContextNotFound = localize('kubeConfigClusterPicker.clusterContextNotFound', "No cluster context information found");
export const signIn = localize('azure.signin', "Sign in…"); export const signIn = localize('azure.signin', "Sign in…");
export const refresh = localize('azure.refresh', "Refresh"); export const refresh = localize('azure.refresh', "Refresh");
export const createNewResourceGroup = localize('azure.resourceGroup.createNewResourceGroup', "Create a new resource group"); export const createNewResourceGroup = localize('azure.resourceGroup.createNewResourceGroup', "Create a new resource group");
export const NewResourceGroupAriaLabel = localize('azure.resourceGroup.NewResourceGroupAriaLabel', "New resource group name"); export const NewResourceGroupAriaLabel = localize('azure.resourceGroup.NewResourceGroupAriaLabel', "New resource group name");
export const realm = localize('deployCluster.Realm', "Realm"); export const realm = localize('deployCluster.Realm', "Realm");
export const unexpectedOptionsSourceType = (type: OptionsSourceType) => localize('optionsSourceType.Invalid', "Invalid options source type:{0}", type);
export const unknownFieldTypeError = (type: FieldType) => localize('UnknownFieldTypeError', "Unknown field type: \"{0}\"", type);
export const variableValueFetchForUnsupportedVariable = (variableName: string) => localize('getVariableValue.unknownVariableName', "Attempt to get variable value for unknown variable:{0}", variableName);
export const isPasswordFetchForUnsupportedVariable = (variableName: string) => localize('getIsPassword.unknownVariableName', "Attempt to get isPassword for unknown variable:{0}", variableName);
export const noControllersConnected = localize('noControllersConnected', "No Azure ARC controllers are currently connected. Please run the command: 'Connect to Existing Azure Arc Controller' and then try again");
export const noOptionsSourceDefined = (optionsSourceType: string) => localize('noOptionsSourceDefined', "No OptionsSource defined for type: {0}", optionsSourceType);
export const noControllerInfoFound = (name: string) => localize('noControllerInfoFound', "controllerInfo could not be found with name: {0}", name);
export const noPasswordFound = (controllerName: string) => localize('noPasswordFound', "Password could not be retrieved for controller: {0} and user did not provide a password. Please retry later.", controllerName);
export const optionsNotDefined = (fieldType: FieldType) => localize('optionsNotDefined', "FieldInfo.options was not defined for field type: {0}", fieldType);
export const optionsNotObjectOrArray = localize('optionsNotObjectOrArray', "FieldInfo.options must be an object if it is not an array");
export const optionsTypeNotFound = localize('optionsTypeNotFound', "When FieldInfo.options is an object it must have 'optionsType' property");
export const optionsTypeRadioOrDropdown = localize('optionsTypeRadioOrDropdown', "When optionsType is not {0} then it must be {1}", OptionsType.Radio, OptionsType.Dropdown);
export const azdataEulaNotAccepted = localize('azdataEulaNotAccepted', "Deployment cannot continue. Azure Data CLI license terms have not been accepted. Execute the command: [Azure Data CLI: Accept EULA] to accept EULA to enable the features that requires Azure Data CLI.");

22
extensions/resource-deployment/src/services/apiService.ts
View File

@@ -3,28 +3,22 @@
* Licensed under the Source EULA. See License.txt in the project root for license information. * Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import * as arc from 'arc';
import * as azdataExt from 'azdata-ext';
import * as azurecore from 'azurecore'; import * as azurecore from 'azurecore';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
export interface IApiService { export interface IApiService {
getAzurecoreApi(): Promise<azurecore.IExtension>; readonly azurecoreApi: azurecore.IExtension;
readonly azdataApi: azdataExt.IExtension;
readonly arcApi: arc.IExtension;
} }
class ApiService implements IApiService { class ApiService implements IApiService {
private azurecoreApi: azurecore.IExtension | undefined;
constructor() { } constructor() { }
public get azurecoreApi() { return vscode.extensions.getExtension(azurecore.extension.name)?.exports; }
public async getAzurecoreApi(): Promise<azurecore.IExtension> { public get azdataApi() { return vscode.extensions.getExtension(azdataExt.extension.name)?.exports; }
if (!this.azurecoreApi) { public get arcApi() { return vscode.extensions.getExtension(arc.extension.name)?.exports; }
this.azurecoreApi = <azurecore.IExtension>(await vscode.extensions.getExtension(azurecore.extension.name)?.activate());
if (!this.azurecoreApi) {
throw new Error('Unable to retrieve azurecore API');
}
}
return this.azurecoreApi;
}
} }
export const apiService: IApiService = new ApiService(); export const apiService: IApiService = new ApiService();

17
extensions/resource-deployment/src/services/arcService.ts
View File

@@ -1,17 +0,0 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as arc from 'arc';
import * as vscode from 'vscode';
export class ArcService {
private _arcApi: arc.IExtension;
constructor() {
this._arcApi = vscode.extensions.getExtension(arc.extension.name)?.exports;
}
public async getRegisteredDataControllers(): Promise<arc.ControllerInfo[]> {
return await this._arcApi.getRegisteredDataControllers();
}
}

51
extensions/resource-deployment/src/services/tools/azdataTool.ts
View File

@@ -8,10 +8,11 @@ import { SemVer } from 'semver';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import * as nls from 'vscode-nls'; import * as nls from 'vscode-nls';
import { AzdataInstallLocationKey, DeploymentConfigurationKey } from '../../constants'; import { AzdataInstallLocationKey, DeploymentConfigurationKey } from '../../constants';
import { Command, OsDistribution, ToolType } from '../../interfaces'; import { Command, OsDistribution, ToolStatus, ToolType } from '../../interfaces';
import { apiService } from '../apiService';
import { IPlatformService } from '../platformService'; import { IPlatformService } from '../platformService';
import { dependencyType, ToolBase } from './toolBase'; import { dependencyType, ToolBase } from './toolBase';
import { SemVerProxy } from './SemVerProxy'; import * as loc from '../../localizedConstants';
const localize = nls.loadMessageBundle(); const localize = nls.loadMessageBundle();
export const AzdataToolName = 'azdata'; export const AzdataToolName = 'azdata';
@@ -44,25 +45,57 @@ export class AzdataTool extends ToolBase {
return 'https://docs.microsoft.com/sql/big-data-cluster/deploy-install-azdata'; return 'https://docs.microsoft.com/sql/big-data-cluster/deploy-install-azdata';
} }
public validateEula(): boolean {
if (apiService.azdataApi.isEulaAccepted()) {
return true;
} else {
this.setStatusDescription(loc.azdataEulaNotAccepted);
return false;
}
}
/* unused */
protected get versionCommand(): Command { protected get versionCommand(): Command {
return { return {
command: 'azdata -v' command: ''
}; };
} }
/* unused */
protected get discoveryCommand(): Command { protected get discoveryCommand(): Command {
return { return {
command: this.discoveryCommandString('azdata') command: ''
}; };
} }
/**
* updates the version and status for the tool.
*/
protected async updateVersionAndStatus(): Promise<void> {
this.setStatusDescription('');
await this.addInstallationSearchPathsToSystemPath();
const commandOutput = await apiService.azdataApi.azdata.version();
this.version = apiService.azdataApi.azdata.getSemVersion();
if (this.version) {
if (this.autoInstallSupported) {
// set the installationPath
this.setInstallationPathOrAdditionalInformation(apiService.azdataApi.azdata.getPath());
}
this.setStatus(ToolStatus.Installed);
}
else {
this.setInstallationPathOrAdditionalInformation(localize('deployCluster.GetToolVersionErrorInformation', "Error retrieving version information. See output channel '{0}' for more details", this.outputChannelName));
this.setStatusDescription(localize('deployCluster.GetToolVersionError', "Error retrieving version information.{0}Invalid output received, get version command output: '{1}' ", EOL, commandOutput.stderr.join(EOL)));
this.setStatus(ToolStatus.NotInstalled);
}
}
protected getVersionFromOutput(output: string): SemVer | undefined { protected getVersionFromOutput(output: string): SemVer | undefined {
let version: SemVer | undefined = undefined; return apiService.azdataApi.azdata.getSemVersion();
if (output && output.split(EOL).length > 0) {
version = new SemVerProxy(output.split(EOL)[0].replace(/ /g, ''));
}
return version;
} }
protected async getSearchPaths(): Promise<string[]> { protected async getSearchPaths(): Promise<string[]> {
switch (this.osDistribution) { switch (this.osDistribution) {
case OsDistribution.win32: case OsDistribution.win32:

14
extensions/resource-deployment/src/services/tools/toolBase.ts
View File

@@ -58,6 +58,8 @@ export abstract class ToolBase implements ITool {
protected abstract readonly versionCommand: Command; protected abstract readonly versionCommand: Command;
public validateEula(): boolean { return true; }
public get dependencyMessages(): string[] { public get dependencyMessages(): string[] {
return (this.dependenciesByOsType.get(this.osDistribution) || []).map((msgType: dependencyType) => messageByDependencyType.get(msgType)!); return (this.dependenciesByOsType.get(this.osDistribution) || []).map((msgType: dependencyType) => messageByDependencyType.get(msgType)!);
} }
@@ -126,10 +128,18 @@ export abstract class ToolBase implements ITool {
return this._statusDescription; return this._statusDescription;
} }
protected setStatusDescription(value: string | undefined): void {
this._statusDescription = value;
}
public get installationPathOrAdditionalInformation(): string | undefined { public get installationPathOrAdditionalInformation(): string | undefined {
return this._installationPathOrAdditionalInformation; return this._installationPathOrAdditionalInformation;
} }
protected setInstallationPathOrAdditionalInformation(value: string | undefined) {
this._installationPathOrAdditionalInformation = value;
}
protected get installationCommands(): Command[] | undefined { protected get installationCommands(): Command[] | undefined {
return this.allInstallationCommands.get(this.osDistribution); return this.allInstallationCommands.get(this.osDistribution);
} }
@@ -250,7 +260,7 @@ export abstract class ToolBase implements ITool {
/** /**
* updates the version and status for the tool. * updates the version and status for the tool.
*/ */
private async updateVersionAndStatus(): Promise<void> { protected async updateVersionAndStatus(): Promise<void> {
this._statusDescription = ''; this._statusDescription = '';
await this.addInstallationSearchPathsToSystemPath(); await this.addInstallationSearchPathsToSystemPath();
const commandOutput = await this.platformService.runCommand( const commandOutput = await this.platformService.runCommand(
@@ -306,7 +316,7 @@ export abstract class ToolBase implements ITool {
} }
isSameOrNewerThan(version?: string): boolean { isSameOrNewerThan(version?: string): boolean {
return !version || (this._version ? SemVerCompare(this._version, version) >= 0 : false); return !version || (this._version ? SemVerCompare(this._version.raw, version) >= 0 : false);
} }
private _pendingVersionAndStatusUpdate!: Promise<void>; private _pendingVersionAndStatusUpdate!: Promise<void>;

5
extensions/resource-deployment/src/test/apiService.test.ts
View File

@@ -8,9 +8,8 @@ import assert = require('assert');
import { apiService } from '../services/apiService'; import { apiService } from '../services/apiService';
suite('API Service Tests', function (): void { suite('API Service Tests', function (): void {
test('getAzurecoreApi returns azure api', () => {
test('getAzurecoreApi returns azure api', async () => { const api = apiService.azurecoreApi;
const api = await apiService.getAzurecoreApi();
assert(api !== undefined); assert(api !== undefined);
}); });
}); });

1
extensions/resource-deployment/src/typings/ref.d.ts vendored
View File

@@ -7,6 +7,7 @@
/// <reference path='../../../../src/sql/azdata.d.ts'/> /// <reference path='../../../../src/sql/azdata.d.ts'/>
/// <reference path='../../../../src/sql/azdata.proposed.d.ts'/> /// <reference path='../../../../src/sql/azdata.proposed.d.ts'/>
/// <reference path='../../../arc/src/typings/arc.d.ts'/> /// <reference path='../../../arc/src/typings/arc.d.ts'/>
/// <reference path='../../../azdata/src/typings/azdata-ext.d.ts'/>
/// <reference path='../../../azurecore/src/azurecore.d.ts'/> /// <reference path='../../../azurecore/src/azurecore.d.ts'/>
/// <reference path='../../../azurecore/src/azureResource/azure-resource.d.ts'/> /// <reference path='../../../azurecore/src/azureResource/azure-resource.d.ts'/>
/// <reference types='@types/node'/> /// <reference types='@types/node'/>

4
extensions/resource-deployment/src/ui/deployClusterWizard/pages/azureSettingsPage.ts
View File

@@ -176,11 +176,11 @@ export class AzureSettingsPage extends WizardPageBase<DeployClusterWizard> {
}); });
} }
public onLeave(): void { public async onLeave(): Promise<void> {
this.wizard.wizardObject.registerNavigationValidator((pcInfo) => { this.wizard.wizardObject.registerNavigationValidator((pcInfo) => {
return true; return true;
}); });
setModelValues(this.inputComponents, this.wizard.model); await setModelValues(this.inputComponents, this.wizard.model);
Object.assign(this.wizard.inputComponents, this.inputComponents); Object.assign(this.wizard.inputComponents, this.inputComponents);
} }
} }

4
extensions/resource-deployment/src/ui/deployClusterWizard/pages/clusterSettingsPage.ts
View File

@@ -289,8 +289,8 @@ export class ClusterSettingsPage extends WizardPageBase<DeployClusterWizard> {
}); });
} }
public onLeave() { public async onLeave(): Promise<void> {
setModelValues(this.inputComponents, this.wizard.model); await setModelValues(this.inputComponents, this.wizard.model);
Object.assign(this.wizard.inputComponents, this.inputComponents); Object.assign(this.wizard.inputComponents, this.inputComponents);
if (this.wizard.model.authenticationMode === AuthenticationMode.ActiveDirectory) { if (this.wizard.model.authenticationMode === AuthenticationMode.ActiveDirectory) {
const variableDNSPrefixMapping: { [s: string]: string } = {}; const variableDNSPrefixMapping: { [s: string]: string } = {};

2
extensions/resource-deployment/src/ui/deployClusterWizard/pages/deploymentProfilePage.ts
View File

@@ -233,7 +233,7 @@ export class DeploymentProfilePage extends WizardPageBase<DeployClusterWizard> {
}); });
} }
public onLeave() { public async onLeave(): Promise<void> {
this.wizard.wizardObject.registerNavigationValidator((pcInfo) => { this.wizard.wizardObject.registerNavigationValidator((pcInfo) => {
return true; return true;
}); });

4
extensions/resource-deployment/src/ui/deployClusterWizard/pages/serviceSettingsPage.ts
View File

@@ -400,8 +400,8 @@ export class ServiceSettingsPage extends WizardPageBase<DeployClusterWizard> {
}); });
} }
public onLeave(): void { public async onLeave(): Promise<void> {
setModelValues(this.inputComponents, this.wizard.model); await setModelValues(this.inputComponents, this.wizard.model);
Object.assign(this.wizard.inputComponents, this.inputComponents); Object.assign(this.wizard.inputComponents, this.inputComponents);
this.wizard.wizardObject.registerNavigationValidator((pcInfo) => { this.wizard.wizardObject.registerNavigationValidator((pcInfo) => {
return true; return true;

2
extensions/resource-deployment/src/ui/deployClusterWizard/pages/summaryPage.ts
View File

@@ -326,7 +326,7 @@ export class SummaryPage extends WizardPageBase<DeployClusterWizard> {
this.form.addFormItems(this.formItems); this.form.addFormItems(this.formItems);
} }
public onLeave() { public async onLeave(): Promise<void> {
this.wizard.hideCustomButtons(); this.wizard.hideCustomButtons();
this.wizard.wizardObject.message = { text: '' }; this.wizard.wizardObject.message = { text: '' };
} }

2
extensions/resource-deployment/src/ui/deployClusterWizard/pages/targetClusterPage.ts
View File

@@ -74,7 +74,7 @@ export class TargetClusterContextPage extends WizardPageBase<DeployClusterWizard
}); });
} }
public onLeave() { public async onLeave(): Promise<void> {
this.wizard.wizardObject.registerNavigationValidator((e) => { this.wizard.wizardObject.registerNavigationValidator((e) => {
return true; return true;
}); });

6
extensions/resource-deployment/src/ui/deploymentInputDialog.ts
View File

@@ -94,9 +94,9 @@ export class DeploymentInputDialog extends DialogBase {
}); });
} }
protected onComplete(): void { protected async onComplete(): Promise<void> {
const model: Model = new Model(); const model: Model = new Model();
setModelValues(this.inputComponents, model); await setModelValues(this.inputComponents, model);
if (instanceOfNotebookBasedDialogInfo(this.dialogInfo)) { if (instanceOfNotebookBasedDialogInfo(this.dialogInfo)) {
model.setEnvironmentVariables(); model.setEnvironmentVariables();
if (this.dialogInfo.runNotebook) { if (this.dialogInfo.runNotebook) {
@@ -110,7 +110,7 @@ export class DeploymentInputDialog extends DialogBase {
}); });
} }
} else { } else {
vscode.commands.executeCommand(this.dialogInfo.command, model); await vscode.commands.executeCommand(this.dialogInfo.command, model);
} }
} }

6
extensions/resource-deployment/src/ui/dialogBase.ts
View File

@@ -27,12 +27,12 @@ export abstract class DialogBase {
this.dispose(); this.dispose();
} }
private onOkButtonClicked(): void { private async onOkButtonClicked(): Promise<void> {
this.onComplete(); await this.onComplete();
this.dispose(); this.dispose();
} }
protected onComplete(): void { protected async onComplete(): Promise<void> {
} }
protected dispose(): void { protected dispose(): void {

136
extensions/resource-deployment/src/ui/modelViewUtils.ts
View File

@@ -3,27 +3,28 @@
* Licensed under the Source EULA. See License.txt in the project root for license information. * Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import * as azdata from 'azdata'; import * as azdata from 'azdata';
import { azureResource } from 'azureResource';
import * as fs from 'fs'; import * as fs from 'fs';
import { EOL, homedir as os_homedir } from 'os'; import { EOL, homedir as os_homedir } from 'os';
import * as path from 'path'; import * as path from 'path';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import * as nls from 'vscode-nls'; import * as nls from 'vscode-nls';
import { azureResource } from 'azureResource'; import { ArcControllersOptionsSource, OptionsSourceType } from '../helpers/optionSources';
import { AzureAccountFieldInfo, AzureLocationsFieldInfo, ComponentCSSStyles, DialogInfoBase, FieldInfo, FieldType, FilePickerFieldInfo, KubeClusterContextFieldInfo, LabelPosition, NoteBookEnvironmentVariablePrefix, OptionsInfo, OptionsType, PageInfoBase, RowInfo, SectionInfo, TextCSSStyles } from '../interfaces'; import { AzureAccountFieldInfo, AzureLocationsFieldInfo, ComponentCSSStyles, DialogInfoBase, FieldInfo, FieldType, FilePickerFieldInfo, IOptionsSource, KubeClusterContextFieldInfo, LabelPosition, NoteBookEnvironmentVariablePrefix, OptionsInfo, OptionsType, PageInfoBase, RowInfo, SectionInfo, TextCSSStyles } from '../interfaces';
import * as loc from '../localizedConstants'; import * as loc from '../localizedConstants';
import { apiService } from '../services/apiService'; import { apiService } from '../services/apiService';
import { getDefaultKubeConfigPath, getKubeConfigClusterContexts } from '../services/kubeService'; import { getDefaultKubeConfigPath, getKubeConfigClusterContexts } from '../services/kubeService';
import { assert, getDateTimeString, getErrorMessage } from '../utils'; import { KubeCtlTool, KubeCtlToolName } from '../services/tools/kubeCtlTool';
import { IToolsService } from '../services/toolsService';
import { getDateTimeString, getErrorMessage, throwUnless } from '../utils';
import { WizardInfoBase } from './../interfaces'; import { WizardInfoBase } from './../interfaces';
import { Model } from './model'; import { Model } from './model';
import { RadioGroupLoadingComponentBuilder } from './radioGroupLoadingComponentBuilder'; import { RadioGroupLoadingComponentBuilder } from './radioGroupLoadingComponentBuilder';
import { IToolsService } from '../services/toolsService';
import { KubeCtlToolName, KubeCtlTool } from '../services/tools/kubeCtlTool';
const localize = nls.loadMessageBundle(); const localize = nls.loadMessageBundle();
export type Validator = () => { valid: boolean, message: string }; export type Validator = () => { valid: boolean, message: string };
export type InputValueTransformer = (inputValue: string) => string; export type InputValueTransformer = (inputValue: string) => string | Promise<string>;
export type InputComponent = azdata.TextComponent | azdata.InputBoxComponent | azdata.DropDownComponent | azdata.CheckBoxComponent | RadioGroupLoadingComponentBuilder; export type InputComponent = azdata.TextComponent | azdata.InputBoxComponent | azdata.DropDownComponent | azdata.CheckBoxComponent | RadioGroupLoadingComponentBuilder;
export type InputComponentInfo = { export type InputComponentInfo = {
component: InputComponent; component: InputComponent;
@@ -353,7 +354,7 @@ function addLabelInputPairToContainer(view: azdata.ModelView, components: azdata
async function processField(context: FieldContext): Promise<void> { async function processField(context: FieldContext): Promise<void> {
switch (context.fieldInfo.type) { switch (context.fieldInfo.type) {
case FieldType.Options: case FieldType.Options:
processOptionsTypeField(context); await processOptionsTypeField(context);
break; break;
case FieldType.DateTimeText: case FieldType.DateTimeText:
processDateTimeTextField(context); processDateTimeTextField(context);
@@ -390,12 +391,23 @@ async function processField(context: FieldContext): Promise<void> {
await processKubeStorageClassField(context); await processKubeStorageClassField(context);
break; break;
default: default:
throw new Error(localize('UnknownFieldTypeError', "Unknown field type: \"{0}\"", context.fieldInfo.type)); throw new Error(loc.unknownFieldTypeError(context.fieldInfo.type));
} }
} }
function processOptionsTypeField(context: FieldContext): void { function disableControlButtons(container: azdata.window.Dialog | azdata.window.Wizard): void {
assert(context.fieldInfo.options !== undefined, `FieldInfo.options must be defined for FieldType:${FieldType.Options}`); if ('okButton' in container) {
container.okButton.enabled = false;
} else {
container.doneButton.enabled = false;
container.nextButton.enabled = false;
container.backButton.enabled = false;
container.customButtons.forEach(b => b.enabled = false);
}
}
async function processOptionsTypeField(context: FieldContext): Promise<void> {
throwUnless(context.fieldInfo.options !== undefined, loc.optionsNotDefined(context.fieldInfo.type));
if (Array.isArray(context.fieldInfo.options)) { if (Array.isArray(context.fieldInfo.options)) {
context.fieldInfo.options = <OptionsInfo>{ context.fieldInfo.options = <OptionsInfo>{
values: context.fieldInfo.options, values: context.fieldInfo.options,
@@ -403,17 +415,69 @@ function processOptionsTypeField(context: FieldContext): void {
optionsType: OptionsType.Dropdown optionsType: OptionsType.Dropdown
}; };
} }
assert(typeof context.fieldInfo.options === 'object', `FieldInfo.options must be an object if it is not an array`); throwUnless(typeof context.fieldInfo.options === 'object', loc.optionsNotObjectOrArray);
assert('optionsType' in context.fieldInfo.options, `When FieldInfo.options is an object it must have 'optionsType' property`); throwUnless('optionsType' in context.fieldInfo.options, loc.optionsTypeNotFound);
if (context.fieldInfo.options.source) {
try {
let optionsSource: IOptionsSource;
switch (context.fieldInfo.options.source.type) {
case OptionsSourceType.ArcControllersOptionsSource:
optionsSource = new ArcControllersOptionsSource(context.fieldInfo.options.source.variableNames, context.fieldInfo.options.source.type);
break;
default:
throw new Error(loc.noOptionsSourceDefined(context.fieldInfo.options.source.type));
}
context.fieldInfo.options.source = optionsSource;
context.fieldInfo.options.values = await context.fieldInfo.options.source.getOptions();
}
catch (e) {
disableControlButtons(context.container);
context.container.message = {
text: getErrorMessage(e),
description: '',
level: azdata.window.MessageLevel.Error
};
context.fieldInfo.options.values = [];
}
context.fieldInfo.subFields = context.fieldInfo.subFields || [];
}
let optionsComponent: InputComponent;
if (context.fieldInfo.options.optionsType === OptionsType.Radio) { if (context.fieldInfo.options.optionsType === OptionsType.Radio) {
processRadioOptionsTypeField(context); optionsComponent = await processRadioOptionsTypeField(context);
} else { } else {
assert(context.fieldInfo.options.optionsType === OptionsType.Dropdown, `When optionsType is not ${OptionsType.Radio} then it must be ${OptionsType.Dropdown}`); throwUnless(context.fieldInfo.options.optionsType === OptionsType.Dropdown, loc.optionsTypeRadioOrDropdown);
processDropdownOptionsTypeField(context); optionsComponent = processDropdownOptionsTypeField(context);
}
if (context.fieldInfo.options.source) {
const optionsSource = context.fieldInfo.options.source;
for (const key of Object.keys(optionsSource.variableNames ?? {})) {
context.fieldInfo.subFields!.push({
label: context.fieldInfo.label,
variableName: optionsSource.variableNames[key]
});
context.onNewInputComponentCreated(optionsSource.variableNames[key], {
component: optionsComponent,
inputValueTransformer: async (controllerName: string) => {
try {
const variableValue = await optionsSource.getVariableValue(key, controllerName);
return variableValue;
} catch (e) {
disableControlButtons(context.container);
context.container.message = {
text: getErrorMessage(e),
description: '',
level: azdata.window.MessageLevel.Error
};
return '';
}
},
isPassword: optionsSource.getIsPassword(key)
});
}
} }
} }
function processDropdownOptionsTypeField(context: FieldContext): void { function processDropdownOptionsTypeField(context: FieldContext): azdata.DropDownComponent {
const label = createLabel(context.view, { text: context.fieldInfo.label, description: context.fieldInfo.description, required: context.fieldInfo.required, width: context.fieldInfo.labelWidth, cssStyles: context.fieldInfo.labelCSSStyles }); const label = createLabel(context.view, { text: context.fieldInfo.label, description: context.fieldInfo.description, required: context.fieldInfo.required, width: context.fieldInfo.labelWidth, cssStyles: context.fieldInfo.labelCSSStyles });
const options = context.fieldInfo.options as OptionsInfo; const options = context.fieldInfo.options as OptionsInfo;
const dropdown = createDropdown(context.view, { const dropdown = createDropdown(context.view, {
@@ -427,6 +491,7 @@ function processDropdownOptionsTypeField(context: FieldContext): void {
dropdown.fireOnTextChange = true; dropdown.fireOnTextChange = true;
context.onNewInputComponentCreated(context.fieldInfo.variableName!, { component: dropdown }); context.onNewInputComponentCreated(context.fieldInfo.variableName!, { component: dropdown });
addLabelInputPairToContainer(context.view, context.components, label, dropdown, context.fieldInfo); addLabelInputPairToContainer(context.view, context.components, label, dropdown, context.fieldInfo);
return dropdown;
} }
function processDateTimeTextField(context: FieldContext): void { function processDateTimeTextField(context: FieldContext): void {
@@ -579,8 +644,8 @@ function processEvaluatedTextField(context: FieldContext): ReadOnlyFieldInputs {
const readOnlyField = processReadonlyTextField(context, false /*allowEvaluation*/); const readOnlyField = processReadonlyTextField(context, false /*allowEvaluation*/);
context.onNewInputComponentCreated(context.fieldInfo.variableName || context.fieldInfo.label, { context.onNewInputComponentCreated(context.fieldInfo.variableName || context.fieldInfo.label, {
component: readOnlyField.text!, component: readOnlyField.text!,
inputValueTransformer: () => { inputValueTransformer: async () => {
readOnlyField.text!.value = substituteVariableValues(context.inputComponents, context.fieldInfo.defaultValue); readOnlyField.text!.value = await substituteVariableValues(context.inputComponents, context.fieldInfo.defaultValue);
return readOnlyField.text?.value!; return readOnlyField.text?.value!;
} }
}); });
@@ -596,14 +661,15 @@ function processEvaluatedTextField(context: FieldContext): ReadOnlyFieldInputs {
* @param inputValue * @param inputValue
* @param inputComponents * @param inputComponents
*/ */
function substituteVariableValues(inputComponents: InputComponents, inputValue?: string): string | undefined { async function substituteVariableValues(inputComponents: InputComponents, inputValue?: string): Promise<string | undefined> {
Object.keys(inputComponents) await Promise.all(Object.keys(inputComponents)
.filter(key => key.startsWith(NoteBookEnvironmentVariablePrefix)) .filter(key => key.startsWith(NoteBookEnvironmentVariablePrefix))
.forEach(key => { .map(async key => {
const value = getInputComponentValue(inputComponents, key) ?? '<undefined>'; const value = (await getInputComponentValue(inputComponents, key)) ?? '<undefined>';
const re: RegExp = new RegExp(`\\\$\\\(${key}\\\)`, 'gi'); const re: RegExp = new RegExp(`\\\$\\\(${key}\\\)`, 'gi');
inputValue = inputValue?.replace(re, value); inputValue = inputValue?.replace(re, value);
}); })
);
return inputValue; return inputValue;
} }
@@ -984,7 +1050,7 @@ async function handleSelectedAccountChanged(
} }
try { try {
const response = await (await apiService.getAzurecoreApi()).getSubscriptions(selectedAccount, true); const response = await apiService.azurecoreApi.getSubscriptions(selectedAccount, true);
if (!response) { if (!response) {
return; return;
} }
@@ -1099,7 +1165,7 @@ async function handleSelectedSubscriptionChanged(context: AzureAccountFieldConte
return; return;
} }
try { try {
const response = await (await apiService.getAzurecoreApi()).getResourceGroups(selectedAccount, selectedSubscription, true); const response = await apiService.azurecoreApi.getResourceGroups(selectedAccount, selectedSubscription, true);
if (!response) { if (!response) {
return; return;
} }
@@ -1150,8 +1216,7 @@ async function processAzureLocationsField(context: AzureLocationsFieldContext):
width: context.fieldInfo.labelWidth, width: context.fieldInfo.labelWidth,
cssStyles: context.fieldInfo.labelCSSStyles cssStyles: context.fieldInfo.labelCSSStyles
}); });
const azurecoreApi = await apiService.getAzurecoreApi(); const locationValues = context.fieldInfo.locations?.map(l => { return { name: l, displayName: apiService.azurecoreApi.getRegionDisplayName(l) }; });
const locationValues = context.fieldInfo.locations?.map(l => { return { name: l, displayName: azurecoreApi.getRegionDisplayName(l) }; });
const locationDropdown = createDropdown(context.view, { const locationDropdown = createDropdown(context.view, {
defaultValue: locationValues?.find(l => l.name === context.fieldInfo.defaultValue), defaultValue: locationValues?.find(l => l.name === context.fieldInfo.defaultValue),
width: context.fieldInfo.inputWidth, width: context.fieldInfo.inputWidth,
@@ -1174,7 +1239,7 @@ async function processAzureLocationsField(context: AzureLocationsFieldContext):
label: label.value!, label: label.value!,
variableName: context.fieldInfo.displayLocationVariableName variableName: context.fieldInfo.displayLocationVariableName
}); });
context.onNewInputComponentCreated(context.fieldInfo.displayLocationVariableName, { component: locationDropdown, inputValueTransformer: (value => azurecoreApi.getRegionDisplayName(value)) }); context.onNewInputComponentCreated(context.fieldInfo.displayLocationVariableName, { component: locationDropdown, inputValueTransformer: (value => apiService.azurecoreApi.getRegionDisplayName(value)) });
} }
addLabelInputPairToContainer(context.view, context.components, label, locationDropdown, context.fieldInfo); addLabelInputPairToContainer(context.view, context.components, label, locationDropdown, context.fieldInfo);
return locationDropdown; return locationDropdown;
@@ -1207,14 +1272,14 @@ export function getPasswordMismatchMessage(fieldName: string): string {
return localize('passwordNotMatch', "{0} doesn't match the confirmation password", fieldName); return localize('passwordNotMatch', "{0} doesn't match the confirmation password", fieldName);
} }
export function setModelValues(inputComponents: InputComponents, model: Model): void { export async function setModelValues(inputComponents: InputComponents, model: Model): Promise<void> {
Object.keys(inputComponents).forEach(key => { await Promise.all(Object.keys(inputComponents).map(async key => {
const value = getInputComponentValue(inputComponents, key); const value = await getInputComponentValue(inputComponents, key);
model.setPropertyValue(key, value); model.setPropertyValue(key, value);
}); }));
} }
function getInputComponentValue(inputComponents: InputComponents, key: string): string | undefined { async function getInputComponentValue(inputComponents: InputComponents, key: string): Promise<string | undefined> {
const input = inputComponents[key].component; const input = inputComponents[key].component;
if (input === undefined) { if (input === undefined) {
return undefined; return undefined;
@@ -1236,7 +1301,10 @@ function getInputComponentValue(inputComponents: InputComponents, key: string):
} }
const inputValueTransformer = inputComponents[key].inputValueTransformer; const inputValueTransformer = inputComponents[key].inputValueTransformer;
if (inputValueTransformer) { if (inputValueTransformer) {
value = inputValueTransformer(value || ''); value = inputValueTransformer(value ?? '');
if (typeof value !== 'string') {
value = await value;
}
} }
return value; return value;
} }

2
extensions/resource-deployment/src/ui/notebookWizard/notebookWizard.ts
View File

@@ -58,7 +58,7 @@ export class NotebookWizard extends WizardBase<NotebookWizard, NotebookWizardPag
} }
protected async onOk(): Promise<void> { protected async onOk(): Promise<void> {
setModelValues(this.inputComponents, this.model); await setModelValues(this.inputComponents, this.model);
const env: NodeJS.ProcessEnv = {}; const env: NodeJS.ProcessEnv = {};
this.model.setEnvironmentVariables(env, (varName) => { this.model.setEnvironmentVariables(env, (varName) => {
const isPassword = !!this.inputComponents[varName]?.isPassword; const isPassword = !!this.inputComponents[varName]?.isPassword;

2
extensions/resource-deployment/src/ui/notebookWizard/notebookWizardAutoSummaryPage.ts
View File

@@ -33,7 +33,7 @@ export class NotebookWizardAutoSummaryPage extends NotebookWizardPage {
}); });
} }
public onLeave(): void { public async onLeave(): Promise<void> {
this.wizard.wizardObject.message = { text: '' }; this.wizard.wizardObject.message = { text: '' };
} }

4
extensions/resource-deployment/src/ui/notebookWizard/notebookWizardPage.ts
View File

@@ -57,7 +57,7 @@ export class NotebookWizardPage extends WizardPageBase<NotebookWizard> {
}); });
} }
public onLeave(): void { public async onLeave(): Promise<void> {
// The following callback registration clears previous navigation validators. // The following callback registration clears previous navigation validators.
this.wizard.wizardObject.registerNavigationValidator((pcInfo) => { this.wizard.wizardObject.registerNavigationValidator((pcInfo) => {
return true; return true;
@@ -66,7 +66,7 @@ export class NotebookWizardPage extends WizardPageBase<NotebookWizard> {
public async onEnter(): Promise<void> { public async onEnter(): Promise<void> {
if (this.pageInfo.isSummaryPage) { if (this.pageInfo.isSummaryPage) {
setModelValues(this.wizard.inputComponents, this.wizard.model); await setModelValues(this.wizard.inputComponents, this.wizard.model);
} }
this.wizard.wizardObject.registerNavigationValidator((pcInfo) => { this.wizard.wizardObject.registerNavigationValidator((pcInfo) => {

29
extensions/resource-deployment/src/ui/resourceTypePickerDialog.ts
View File

@@ -26,6 +26,7 @@ export class ResourceTypePickerDialog extends DialogBase {
private _agreementContainer!: azdata.DivContainer; private _agreementContainer!: azdata.DivContainer;
private _agreementCheckboxChecked: boolean = false; private _agreementCheckboxChecked: boolean = false;
private _installToolButton: azdata.window.Button; private _installToolButton: azdata.window.Button;
private _recheckEulaButton: azdata.window.Button;
private _installationInProgress: boolean = false; private _installationInProgress: boolean = false;
private _tools: ITool[] = []; private _tools: ITool[] = [];
@@ -37,10 +38,15 @@ export class ResourceTypePickerDialog extends DialogBase {
super(localize('resourceTypePickerDialog.title', "Select the deployment options"), 'ResourceTypePickerDialog', true); super(localize('resourceTypePickerDialog.title', "Select the deployment options"), 'ResourceTypePickerDialog', true);
this._selectedResourceType = defaultResourceType; this._selectedResourceType = defaultResourceType;
this._installToolButton = azdata.window.createButton(localize('deploymentDialog.InstallToolsButton', "Install tools")); this._installToolButton = azdata.window.createButton(localize('deploymentDialog.InstallToolsButton', "Install tools"));
this._recheckEulaButton = azdata.window.createButton(localize('deploymentDialog.RecheckEulaButton', "Validate EULA"));
this._toDispose.push(this._installToolButton.onClick(() => { this._toDispose.push(this._installToolButton.onClick(() => {
this.installTools().catch(error => console.log(error)); this.installTools().catch(error => console.log(error));
})); }));
this._dialogObject.customButtons = [this._installToolButton]; this._toDispose.push(this._recheckEulaButton.onClick(() => {
this._dialogObject.message = { text: '' }; // clear any previous message.
this._dialogObject.okButton.enabled = this.validateToolsEula(); // re-enable the okButton if validation succeeds.
}));
this._dialogObject.customButtons = [this._installToolButton, this._recheckEulaButton];
this._installToolButton.hidden = true; this._installToolButton.hidden = true;
this._dialogObject.okButton.label = localize('deploymentDialog.OKButtonText', "Select"); this._dialogObject.okButton.label = localize('deploymentDialog.OKButtonText', "Select");
this._dialogObject.okButton.enabled = false; // this is enabled after all tools are discovered. this._dialogObject.okButton.enabled = false; // this is enabled after all tools are discovered.
@@ -270,12 +276,12 @@ export class ResourceTypePickerDialog extends DialogBase {
return [tool.displayName, tool.description, tool.displayStatus, tool.fullVersion || '', toolRequirement.version || '', tool.installationPathOrAdditionalInformation || '']; return [tool.displayName, tool.description, tool.displayStatus, tool.fullVersion || '', toolRequirement.version || '', tool.installationPathOrAdditionalInformation || ''];
}); });
this._installToolButton.hidden = erroredOrFailedTool || minVersionCheckFailed || (toolsToAutoInstall.length === 0); this._installToolButton.hidden = erroredOrFailedTool || minVersionCheckFailed || (toolsToAutoInstall.length === 0);
this._dialogObject.okButton.enabled = !erroredOrFailedTool && messages.length === 0 && !minVersionCheckFailed && (toolsToAutoInstall.length === 0); this._dialogObject.okButton.enabled = !erroredOrFailedTool && messages.length === 0 && !minVersionCheckFailed && (toolsToAutoInstall.length === 0) && this.validateToolsEula();
if (messages.length !== 0) { if (messages.length !== 0) {
if (messages.length > 1) { if (messages.length > 1) {
messages = messages.map(message => `• ${message}`); messages = messages.map(message => `• ${message}`);
} }
messages.push(localize('deploymentDialog.VersionInformationDebugHint', "You will need to restart Azure Data Studio if the tools are installed manually after Azure Data Studio is launched to pick up the updated PATH environment variable. You may find additional details in 'Deployments' output channel")); messages.push(localize('deploymentDialog.VersionInformationDebugHint', "You will need to restart Azure Data Studio if the tools are installed manually to pick up the change. You may find additional details in 'Deployments' and 'azdata' output channels"));
this._dialogObject.message = { this._dialogObject.message = {
level: azdata.window.MessageLevel.Error, level: azdata.window.MessageLevel.Error,
text: messages.join(EOL) text: messages.join(EOL)
@@ -305,6 +311,21 @@ export class ResourceTypePickerDialog extends DialogBase {
this._toolsLoadingComponent.loading = false; this._toolsLoadingComponent.loading = false;
} }
private validateToolsEula(): boolean {
const validationSucceeded = this._tools.every(tool => {
const eulaValidated = tool.validateEula();
if (!eulaValidated) {
this._dialogObject.message = {
level: azdata.window.MessageLevel.Error,
text: tool.statusDescription!
};
}
return eulaValidated;
});
this._recheckEulaButton.hidden = validationSucceeded;
return validationSucceeded;
}
private get toolRequirements() { private get toolRequirements() {
return this.getCurrentProvider().requiredTools; return this.getCurrentProvider().requiredTools;
} }
@@ -347,7 +368,7 @@ export class ResourceTypePickerDialog extends DialogBase {
return this._selectedResourceType.getProvider(options)!; return this._selectedResourceType.getProvider(options)!;
} }
protected onComplete(): void { protected async onComplete(): Promise<void> {
this.toolsService.toolsForCurrentProvider = this._tools; this.toolsService.toolsForCurrentProvider = this._tools;
this.resourceTypeService.startDeployment(this.getCurrentProvider()); this.resourceTypeService.startDeployment(this.getCurrentProvider());
} }

2
extensions/resource-deployment/src/ui/wizardBase.ts
View File

@@ -31,7 +31,7 @@ export abstract class WizardBase<T, P extends WizardPageBase<T>, M extends Model
this.toDispose.push(this.wizardObject.onPageChanged(async (e) => { this.toDispose.push(this.wizardObject.onPageChanged(async (e) => {
let previousPage = this.pages[e.lastPage]; let previousPage = this.pages[e.lastPage];
let newPage = this.pages[e.newPage]; let newPage = this.pages[e.newPage];
previousPage.onLeave(); await previousPage.onLeave();
await newPage.onEnter(); await newPage.onEnter();
})); }));

2
extensions/resource-deployment/src/ui/wizardPageBase.ts
View File

@@ -25,7 +25,7 @@ export abstract class WizardPageBase<T> {
public async onEnter(): Promise<void> { } public async onEnter(): Promise<void> { }
public onLeave(): void { } public async onLeave(): Promise<void> { }
public abstract initialize(): void; public abstract initialize(): void;

10
extensions/resource-deployment/src/utils.ts
View File

@@ -40,7 +40,15 @@ export function setEnvironmentVariablesForInstallPaths(tools: ITool[], env: Node
} }
} }
export function assert(condition: boolean, message?: string): asserts condition { /**
* Throws an Error with given {@link message} unless {@link condition} is true.
* This also tells the typescript compiler that the condition is 'truthy' in the remainder of the scope
* where this function was called.
*
* @param condition
* @param message
*/
export function throwUnless(condition: boolean, message?: string): asserts condition {
if (!condition) { if (!condition) {
throw new Error(message); throw new Error(message);
} }

10
extensions/resource-deployment/yarn.lock
View File

@@ -194,6 +194,11 @@
resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-5.2.7.tgz#315d570ccb56c53452ff8638738df60726d5b6ea" resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-5.2.7.tgz#315d570ccb56c53452ff8638738df60726d5b6ea"
integrity sha512-NYrtPht0wGzhwe9+/idPaBB+TqkY9AhTvOLMkThm0IoEfLaiVQZwBwyJ5puCkO3AUCWrmcoePjp2mbFocKy4SQ== integrity sha512-NYrtPht0wGzhwe9+/idPaBB+TqkY9AhTvOLMkThm0IoEfLaiVQZwBwyJ5puCkO3AUCWrmcoePjp2mbFocKy4SQ==
"@types/semver@^7.3.1":
version "7.3.4"
resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.3.4.tgz#43d7168fec6fa0988bb1a513a697b29296721afb"
integrity sha512-+nVsLKlcUCeMzD2ufHEYuJ9a2ovstb6Dp52A5VsoKxDXgvE051XgHI/33I1EymwkRGQkwnA0LkhnUzituGs4EQ==
"@types/yamljs@0.2.30": "@types/yamljs@0.2.30":
version "0.2.30" version "0.2.30"
resolved "https://registry.yarnpkg.com/@types/yamljs/-/yamljs-0.2.30.tgz#d034e1d329e46e8d0f737c9a8db97f68f81b5382" resolved "https://registry.yarnpkg.com/@types/yamljs/-/yamljs-0.2.30.tgz#d034e1d329e46e8d0f737c9a8db97f68f81b5382"
@@ -694,6 +699,11 @@ semver@^6.0.0, semver@^6.3.0:
resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d" resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw== integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==
semver@^7.3.2:
version "7.3.2"
resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.2.tgz#604962b052b81ed0786aae84389ffba70ffd3938"
integrity sha512-OrOb32TeeambH6UrhtShmF7CRDqhL6/5XpPNp2DuRH6+9QLw/orhp72j87v8Qa1ScDkvrrBNpZcDejAirJmfXQ==
should-equal@^2.0.0: should-equal@^2.0.0:
version "2.0.0" version "2.0.0"
resolved "https://registry.yarnpkg.com/should-equal/-/should-equal-2.0.0.tgz#6072cf83047360867e68e98b09d71143d04ee0c3" resolved "https://registry.yarnpkg.com/should-equal/-/should-equal-2.0.0.tgz#6072cf83047360867e68e98b09d71143d04ee0c3"

54
samples/sample-resource-deployment/package.json
View File

@@ -91,6 +91,28 @@
"optionsType": "radio" "optionsType": "radio"
} }
}, },
{
"type": "options",
"label": "%wizard.data.controllers%",
"required": true,
"variableName": "AZDATA_NB_VAR_CONTROLLER",
"editable": false,
"options": {
"source": {
"type": "ArcControllersOptionsSource",
"variableNames": {
"endpoint": "AZDATA_NB_VAR_CONTROLLER_ENDPOINT",
"username": "AZDATA_NB_VAR_CONTROLLER_USERNAME",
"password": "AZDATA_NB_VAR_CONTROLLER_PASSWORD"
}
},
"values":[
"ignored1",
"ignored2"
],
"optionsType": "dropdown"
}
},
{ {
"label": "%wizard.dropdown.options.field%", "label": "%wizard.dropdown.options.field%",
"variableName": "AZDATA_NB_VAR_DROPDOWN_OPTIONS", "variableName": "AZDATA_NB_VAR_DROPDOWN_OPTIONS",
@@ -245,7 +267,37 @@
"type": "readonly_text", "type": "readonly_text",
"isEvaluated": true, "isEvaluated": true,
"defaultValue": "$(AZDATA_NB_VAR_PROFILE)" "defaultValue": "$(AZDATA_NB_VAR_PROFILE)"
} },
{
"label": "%wizard.dropdown.options.field%",
"type": "readonly_text",
"isEvaluated": true,
"defaultValue": "$(AZDATA_NB_VAR_DROPDOWN_OPTIONS)"
},
{
"label": "%wizard.summary.controller%",
"type": "readonly_text",
"isEvaluated": true,
"defaultValue": "$(AZDATA_NB_VAR_CONTROLLER)"
},
{
"label": "%wizard.summary.controller.endpoint%",
"type": "readonly_text",
"isEvaluated": true,
"defaultValue": "$(AZDATA_NB_VAR_CONTROLLER_ENDPOINT)"
},
{
"label": "%wizard.summary.controller.username%",
"type": "readonly_text",
"isEvaluated": true,
"defaultValue": "$(AZDATA_NB_VAR_CONTROLLER_USERNAME)"
},
{
"label": "%wizard.summary.controller.password%",
"type": "readonly_text",
"isEvaluated": true,
"defaultValue": "$(AZDATA_NB_VAR_CONTROLLER_PASSWORD)"
}
] ]
} }
] ]

5
samples/sample-resource-deployment/package.nls.json
View File

@@ -28,6 +28,7 @@
"wizard.kube.cluster.context": "Cluster context", "wizard.kube.cluster.context": "Cluster context",
"wizard.cluster.config.profile.title": "Choose the config profile", "wizard.cluster.config.profile.title": "Choose the config profile",
"wizard.cluster.config.profile": "Config profile", "wizard.cluster.config.profile": "Config profile",
"wizard.data.controllers": "Pick a data controller",
"wizard.dropdown.options.field": "dropdown field", "wizard.dropdown.options.field": "dropdown field",
"wizard.project.details.title": "Project details", "wizard.project.details.title": "Project details",
"wizard.project.details.description": "Project details for Contoso corporation", "wizard.project.details.description": "Project details for Contoso corporation",
@@ -44,6 +45,10 @@
"wizard.summary.kube.config.file.path": "Kube config file path", "wizard.summary.kube.config.file.path": "Kube config file path",
"wizard.summary.cluster.context": "Cluster context", "wizard.summary.cluster.context": "Cluster context",
"wizard.summary.profile": "Config profile", "wizard.summary.profile": "Config profile",
"wizard.summary.controller": "Controller",
"wizard.summary.controller.endpoint": "Controller endpoint",
"wizard.summary.controller.username": "Controller username",
"wizard.summary.controller.password": "Controller password",
"wizard.data.controller.agreement": "I accept {0} and {1}.", "wizard.data.controller.agreement": "I accept {0} and {1}.",
"contoso.agreement.privacy.statement":"contoso Privacy Statement", "contoso.agreement.privacy.statement":"contoso Privacy Statement",
"wizard.agreement.contosoCmd.eula":"contoso cmd license terms", "wizard.agreement.contosoCmd.eula":"contoso cmd license terms",