ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-16 18:46:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

update .net sdk location strings now that .net 6 is supported (#17757)

Browse Source 
* update .net install strings now that .net 6 is supported

* copy old setting value to new setting

* update strings

* add link to issue
This commit is contained in:
Kim Santiago
2021-12-02 15:32:07 -08:00
committed by GitHub
parent 8b09ba8844
commit 43d235ea42
6 changed files with 25 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
extensions/sql-database-projects/package.json
View File

@@ -44,9 +44,9 @@
{ {
"title": "%sqlDatabaseProjects.Settings%", "title": "%sqlDatabaseProjects.Settings%",
"properties": { "properties": {
"sqlDatabaseProjects.netCoreSDKLocation": { "sqlDatabaseProjects.dotnetSDK Location": {
"type": "string", "type": "string",
"description": "%sqlDatabaseProjects.netCoreInstallLocation%" "description": "%sqlDatabaseProjects.dotnetInstallLocation%"
}, },
"sqlDatabaseProjects.netCoreDoNotAsk": { "sqlDatabaseProjects.netCoreDoNotAsk": {
"type": "boolean", "type": "boolean",

2
extensions/sql-database-projects/package.nls.json
View File

@@ -33,7 +33,7 @@
"sqlDatabaseProjects.generateProjectFromOpenApiSpec": "Generate SQL Project from OpenAPI/Swagger spec", "sqlDatabaseProjects.generateProjectFromOpenApiSpec": "Generate SQL Project from OpenAPI/Swagger spec",
"sqlDatabaseProjects.Settings": "Database Projects", "sqlDatabaseProjects.Settings": "Database Projects",
"sqlDatabaseProjects.netCoreInstallLocation": "Full path to .NET Core SDK on the machine.", "sqlDatabaseProjects.dotnetInstallLocation": "Full path to .NET SDK on the machine.",
"sqlDatabaseProjects.netCoreDoNotAsk": "Whether to prompt the user to install .NET Core when not detected.", "sqlDatabaseProjects.netCoreDoNotAsk": "Whether to prompt the user to install .NET Core when not detected.",
"sqlDatabaseProjects.nodejsDoNotAsk": "Whether to prompt the user to install Node.js when not detected.", "sqlDatabaseProjects.nodejsDoNotAsk": "Whether to prompt the user to install Node.js when not detected.",
"sqlDatabaseProjects.autorestSqlVersion": "Which version of Autorest.Sql to use from NPM. Latest will be used if not set.", "sqlDatabaseProjects.autorestSqlVersion": "Which version of Autorest.Sql to use from NPM. Latest will be used if not set.",

6
extensions/sql-database-projects/src/common/constants.ts
View File

@@ -330,9 +330,9 @@ export const postDeployScriptFriendlyName = localize('postDeployScriptFriendlyNa
// Build // Build
export const NetCoreInstallationConfirmation: string = localize('sqlDatabaseProjects.NetCoreInstallationConfirmation', "The .NET Core SDK cannot be located. Project build will not work. Please install .NET Core SDK version 3.1 or update the .NET Core SDK location in settings if already installed."); export const DotnetInstallationConfirmation: string = localize('sqlDatabaseProjects.DotnetInstallationConfirmation', "The .NET SDK cannot be located. Project build will not work. Please install .NET Core SDK version 3.1 or higher or update the .NET SDK location in settings if already installed.");
export function NetCoreSupportedVersionInstallationConfirmation(installedVersion: string) { return localize('sqlDatabaseProjects.NetCoreSupportedVersionInstallationConfirmation', "Currently installed .NET Core SDK version is {0}, which is not supported. Project build will not work. Please install .NET Core SDK version 3.1 or update the .NET Core SDK supported version location in settings if already installed.", installedVersion); } export function NetCoreSupportedVersionInstallationConfirmation(installedVersion: string) { return localize('sqlDatabaseProjects.NetCoreSupportedVersionInstallationConfirmation', "Currently installed .NET Core SDK version is {0}, which is not supported. Project build will not work. Please install .NET Core SDK version 3.1 or higher or update the .NET SDK supported version location in settings if already installed.", installedVersion); }
export const UpdateNetCoreLocation: string = localize('sqlDatabaseProjects.UpdateNetCoreLocation', "Update Location"); export const UpdateDotnetLocation: string = localize('sqlDatabaseProjects.UpdateDotnetLocation', "Update Location");
export const projectsOutputChannel = localize('sqlDatabaseProjects.outputChannel', "Database Projects"); export const projectsOutputChannel = localize('sqlDatabaseProjects.outputChannel', "Database Projects");
// Prompt buttons // Prompt buttons

9
extensions/sql-database-projects/src/controllers/mainController.ts
View File

@@ -10,7 +10,7 @@ import * as templates from '../templates/templates';
import * as path from 'path'; import * as path from 'path';
import { ProjectsController } from './projectController'; import { ProjectsController } from './projectController';
import { NetCoreTool } from '../tools/netcoreTool'; import { DBProjectConfigurationKey, DotnetInstallLocationKey, NetCoreInstallLocationKey, NetCoreTool } from '../tools/netcoreTool';
import { IconPathHelper } from '../common/iconHelper'; import { IconPathHelper } from '../common/iconHelper';
import { WorkspaceTreeItem } from 'dataworkspace'; import { WorkspaceTreeItem } from 'dataworkspace';
import * as constants from '../common/constants'; import * as constants from '../common/constants';
@@ -45,6 +45,13 @@ export default class MainController implements vscode.Disposable {
} }
public async activate(): Promise<SqlDatabaseProjectProvider> { public async activate(): Promise<SqlDatabaseProjectProvider> {
// upgrade path from former netCoreSDKLocation setting to dotnetSDK Location setting
// copy old setting's value to new setting
const oldNetCoreInstallSetting = vscode.workspace.getConfiguration(DBProjectConfigurationKey)[NetCoreInstallLocationKey];
if (oldNetCoreInstallSetting && !vscode.workspace.getConfiguration(DBProjectConfigurationKey)[DotnetInstallLocationKey]) {
await vscode.workspace.getConfiguration(DBProjectConfigurationKey).update(DotnetInstallLocationKey, oldNetCoreInstallSetting, true);
}
await this.initializeDatabaseProjects(); await this.initializeDatabaseProjects();
return new SqlDatabaseProjectProvider(this.projectsController); return new SqlDatabaseProjectProvider(this.projectsController);
} }

6
extensions/sql-database-projects/src/test/netCoreTool.test.ts
View File

@@ -9,7 +9,7 @@ import * as fs from 'fs';
import * as path from 'path'; import * as path from 'path';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import * as sinon from 'sinon'; import * as sinon from 'sinon';
import { NetCoreTool, DBProjectConfigurationKey, NetCoreInstallLocationKey, NetCoreNonWindowsDefaultPath } from '../tools/netcoreTool'; import { NetCoreTool, DBProjectConfigurationKey, DotnetInstallLocationKey, NetCoreNonWindowsDefaultPath } from '../tools/netcoreTool';
import { getQuotedPath } from '../common/utils'; import { getQuotedPath } from '../common/utils';
import { isNullOrUndefined } from 'util'; import { isNullOrUndefined } from 'util';
import { generateTestFolderPath } from './testUtils'; import { generateTestFolderPath } from './testUtils';
@@ -29,7 +29,7 @@ describe('NetCoreTool: Net core tests', function (): void {
it('Should override dotnet default value with settings', async function (): Promise<void> { it('Should override dotnet default value with settings', async function (): Promise<void> {
try { try {
// update settings and validate // update settings and validate
await vscode.workspace.getConfiguration(DBProjectConfigurationKey).update(NetCoreInstallLocationKey, 'test value path', true); await vscode.workspace.getConfiguration(DBProjectConfigurationKey).update(DotnetInstallLocationKey, 'test value path', true);
const netcoreTool = new NetCoreTool(testContext.outputChannel); const netcoreTool = new NetCoreTool(testContext.outputChannel);
sinon.stub(netcoreTool, 'showInstallDialog').returns(Promise.resolve()); sinon.stub(netcoreTool, 'showInstallDialog').returns(Promise.resolve());
should(netcoreTool.netcoreInstallLocation).equal('test value path'); // the path in settings should be taken should(netcoreTool.netcoreInstallLocation).equal('test value path'); // the path in settings should be taken
@@ -37,7 +37,7 @@ describe('NetCoreTool: Net core tests', function (): void {
} }
finally { finally {
// clean again // clean again
await vscode.workspace.getConfiguration(DBProjectConfigurationKey).update(NetCoreInstallLocationKey, '', true); await vscode.workspace.getConfiguration(DBProjectConfigurationKey).update(DotnetInstallLocationKey, '', true);
} }
}); });

15
extensions/sql-database-projects/src/tools/netcoreTool.ts
View File

@@ -11,19 +11,20 @@ import * as semver from 'semver';
import { isNullOrUndefined } from 'util'; import { isNullOrUndefined } from 'util';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import * as nls from 'vscode-nls'; import * as nls from 'vscode-nls';
import { DoNotAskAgain, Install, NetCoreInstallationConfirmation, NetCoreSupportedVersionInstallationConfirmation, UpdateNetCoreLocation } from '../common/constants'; import { DoNotAskAgain, Install, DotnetInstallationConfirmation, NetCoreSupportedVersionInstallationConfirmation, UpdateDotnetLocation } from '../common/constants';
import * as utils from '../common/utils'; import * as utils from '../common/utils';
import { ShellCommandOptions, ShellExecutionHelper } from './shellExecutionHelper'; import { ShellCommandOptions, ShellExecutionHelper } from './shellExecutionHelper';
const localize = nls.loadMessageBundle(); const localize = nls.loadMessageBundle();
export const DBProjectConfigurationKey: string = 'sqlDatabaseProjects'; export const DBProjectConfigurationKey: string = 'sqlDatabaseProjects';
export const NetCoreInstallLocationKey: string = 'netCoreSDKLocation'; export const NetCoreInstallLocationKey: string = 'netCoreSDKLocation';
export const DotnetInstallLocationKey: string = 'dotnetSDK Location';
export const NetCoreDoNotAskAgainKey: string = 'netCoreDoNotAsk'; export const NetCoreDoNotAskAgainKey: string = 'netCoreDoNotAsk';
export const NetCoreNonWindowsDefaultPath = '/usr/local/share'; export const NetCoreNonWindowsDefaultPath = '/usr/local/share';
export const winPlatform: string = 'win32'; export const winPlatform: string = 'win32';
export const macPlatform: string = 'darwin'; export const macPlatform: string = 'darwin';
export const linuxPlatform: string = 'linux'; export const linuxPlatform: string = 'linux';
export const minSupportedNetCoreVersionForBuild: string = '3.1.0'; export const minSupportedNetCoreVersionForBuild: string = '3.1.0'; // TODO: watch out for EOL support in Dec 2022 https://github.com/microsoft/azuredatastudio/issues/17800
export const enum netCoreInstallState { export const enum netCoreInstallState {
netCoreNotPresent, netCoreNotPresent,
@@ -66,12 +67,12 @@ export class NetCoreTool extends ShellExecutionHelper {
public async showInstallDialog(): Promise<void> { public async showInstallDialog(): Promise<void> {
let result; let result;
if (this.netCoreInstallState === netCoreInstallState.netCoreNotPresent) { if (this.netCoreInstallState === netCoreInstallState.netCoreNotPresent) {
result = await vscode.window.showErrorMessage(NetCoreInstallationConfirmation, UpdateNetCoreLocation, Install, DoNotAskAgain); result = await vscode.window.showErrorMessage(DotnetInstallationConfirmation, UpdateDotnetLocation, Install, DoNotAskAgain);
} else { } else {
result = await vscode.window.showErrorMessage(NetCoreSupportedVersionInstallationConfirmation(this.netCoreSdkInstalledVersion!), UpdateNetCoreLocation, Install, DoNotAskAgain); result = await vscode.window.showErrorMessage(NetCoreSupportedVersionInstallationConfirmation(this.netCoreSdkInstalledVersion!), UpdateDotnetLocation, Install, DoNotAskAgain);
} }
if (result === UpdateNetCoreLocation) { if (result === UpdateDotnetLocation) {
//open settings //open settings
await vscode.commands.executeCommand('workbench.action.openGlobalSettings'); await vscode.commands.executeCommand('workbench.action.openGlobalSettings');
} else if (result === Install) { } else if (result === Install) {
@@ -93,7 +94,7 @@ export class NetCoreTool extends ShellExecutionHelper {
} }
public get netcoreInstallLocation(): string { public get netcoreInstallLocation(): string {
return vscode.workspace.getConfiguration(DBProjectConfigurationKey)[NetCoreInstallLocationKey] || return vscode.workspace.getConfiguration(DBProjectConfigurationKey)[DotnetInstallLocationKey] ||
this.defaultLocalInstallLocationByDistribution; this.defaultLocalInstallLocationByDistribution;
} }
@@ -194,7 +195,7 @@ export class NetCoreTool extends ShellExecutionHelper {
if (!(await this.findOrInstallNetCore(skipVersionSupportedCheck))) { if (!(await this.findOrInstallNetCore(skipVersionSupportedCheck))) {
if (this.netCoreInstallState === netCoreInstallState.netCoreNotPresent) { if (this.netCoreInstallState === netCoreInstallState.netCoreNotPresent) {
throw new DotNetError(NetCoreInstallationConfirmation); throw new DotNetError(DotnetInstallationConfirmation);
} else { } else {
throw new DotNetError(NetCoreSupportedVersionInstallationConfirmation(this.netCoreSdkInstalledVersion!)); throw new DotNetError(NetCoreSupportedVersionInstallationConfirmation(this.netCoreSdkInstalledVersion!));
} }