ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-01-24 09:35:37 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add tests for refresh scripting action (#8648)

Browse Source 
* Add tests for refresh action

* Revert changes to make tree public

* Move tests into subsuite
This commit is contained in:
Charles Gagnon
2019-12-12 16:04:28 -08:00
committed by GitHub
parent 829717f5de
commit 5bf85a2855
5 changed files with 340 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
src/sql/workbench/contrib/scripting/browser/scriptingActions.ts
View File

@@ -26,6 +26,7 @@ import { ILogService } from 'vs/platform/log/common/log';
import { getErrorMessage } from 'vs/base/common/errors';
import { INotificationService } from 'vs/platform/notification/common/notification';
import { localize } from 'vs/nls';
import { ServicesAccessor } from 'vs/editor/browser/editorExtensions';
//#region -- Data Explorer
export const SCRIPT_AS_CREATE_COMMAND_ID = 'dataExplorer.scriptAsCreate';
@@ -310,22 +311,24 @@ CommandsRegistry.registerCommand({
// Refresh Action for Scriptable objects
CommandsRegistry.registerCommand({
id: OE_REFRESH_COMMAND_ID,
handler: async (accessor, args: ObjectExplorerActionsContext): Promise<void> => {
const objectExplorerService = accessor.get(IObjectExplorerService);
const logService = accessor.get(ILogService);
const notificationService = accessor.get(INotificationService);
const treeNode = await getTreeNode(args, objectExplorerService);
const tree = objectExplorerService.getServerTreeView().tree;
try {
await objectExplorerService.refreshTreeNode(treeNode.getSession(), treeNode);
await tree.refresh(treeNode);
} catch (err) {
// Display message to the user but also log the entire error to the console for the stack trace
notificationService.error(localize('refreshError', "An error occurred refreshing node '{0}': {1}", args.nodeInfo.label, getErrorMessage(err)));
logService.error(err);
}
}
handler: handleOeRefreshCommand
});
export async function handleOeRefreshCommand(accessor: ServicesAccessor, args: ObjectExplorerActionsContext): Promise<void> {
const objectExplorerService = accessor.get(IObjectExplorerService);
const logService = accessor.get(ILogService);
const notificationService = accessor.get(INotificationService);
const treeNode = await getTreeNode(args, objectExplorerService);
const tree = objectExplorerService.getServerTreeView().tree;
try {
await objectExplorerService.refreshTreeNode(treeNode.getSession(), treeNode);
await tree.refresh(treeNode);
} catch (err) {
// Display message to the user but also log the entire error to the console for the stack trace
notificationService.error(localize('refreshError', "An error occurred refreshing node '{0}': {1}", args.nodeInfo.label, getErrorMessage(err)));
logService.error(err);
}
}
//#endregion
//#region -- explorer widget

91
src/sql/workbench/contrib/scripting/test/browser/scriptingActions.test.ts Normal file
View File

@@ -0,0 +1,91 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as azdata from 'azdata';
import * as TypeMoq from 'typemoq';
import { handleOeRefreshCommand } from 'sql/workbench/contrib/scripting/browser/scriptingActions';
import { ObjectExplorerActionsContext } from 'sql/workbench/contrib/objectExplorer/browser/objectExplorerActions';
import { mssqlProviderName } from 'sql/platform/connection/common/constants';
import { ServiceCollection } from 'vs/platform/instantiation/common/serviceCollection';
import { InstantiationService } from 'vs/platform/instantiation/common/instantiationService';
import { TestCapabilitiesService } from 'sql/platform/capabilities/test/common/testCapabilitiesService';
import { IObjectExplorerService } from 'sql/workbench/services/objectExplorer/browser/objectExplorerService';
import { TreeNode } from 'sql/workbench/contrib/objectExplorer/common/treeNode';
import { ILogService, NullLogService } from 'vs/platform/log/common/log';
import { INotificationService } from 'vs/platform/notification/common/notification';
import { TestNotificationService } from 'vs/platform/notification/test/common/testNotificationService';
import { NodeType } from 'sql/workbench/contrib/objectExplorer/common/nodeType';
import { ServerTreeView } from 'sql/workbench/contrib/objectExplorer/browser/serverTreeView';
import { createObjectExplorerServiceMock } from 'sql/workbench/services/objectExplorer/test/browser/testObjectExplorerService';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { ITree } from 'vs/base/parts/tree/browser/tree';
import { TestTree } from 'sql/workbench/contrib/objectExplorer/test/browser/treeMock';
import { TestConnectionManagementService } from 'sql/platform/connection/test/common/testConnectionManagementService';
const connection: azdata.IConnectionProfile = {
options: [],
connectionName: '',
serverName: 'server1',
databaseName: 'database',
userName: 'user',
password: 'password',
authenticationType: '',
providerName: mssqlProviderName,
groupId: '',
groupFullName: '',
savePassword: true,
saveProfile: true,
id: 'server1'
};
const nodeInfo: azdata.NodeInfo = {
nodePath: 'MyServer',
nodeStatus: '',
nodeSubType: '',
nodeType: 'Server',
isLeaf: false,
label: 'MyServer',
metadata: undefined,
errorMessage: ''
};
const treeNode = new TreeNode(NodeType.Database, 'db node', false, '', '', '', undefined, undefined, undefined, undefined);
const oeActionArgs: ObjectExplorerActionsContext = { connectionProfile: connection, isConnectionNode: false, nodeInfo: nodeInfo };
let instantiationService: IInstantiationService;
let logServiceMock: TypeMoq.Mock<ILogService>;
let treeMock: TypeMoq.Mock<ITree>;
suite('Scripting Actions', () => {
setup(() => {
const collection = new ServiceCollection();
instantiationService = new InstantiationService(collection);
const capabilitiesService = new TestCapabilitiesService();
const connectionManagementServiceMock = TypeMoq.Mock.ofType(TestConnectionManagementService, TypeMoq.MockBehavior.Loose);
const serverTreeViewMock = TypeMoq.Mock.ofType(ServerTreeView, TypeMoq.MockBehavior.Loose, connectionManagementServiceMock.object, instantiationService, undefined, undefined, undefined, undefined, capabilitiesService);
treeMock = TypeMoq.Mock.ofType(TestTree);
serverTreeViewMock.setup(x => x.tree).returns(() => treeMock.object);
collection.set(IObjectExplorerService, createObjectExplorerServiceMock({ serverTreeView: serverTreeViewMock.object, treeNode: treeNode }).object);
logServiceMock = TypeMoq.Mock.ofInstance(new NullLogService());
collection.set(ILogService, logServiceMock.object);
collection.set(INotificationService, new TestNotificationService());
});
suite('objectExplorer.refreshNode', () => {
test('refresh should be called when action is invoked', async () => {
await instantiationService.invokeFunction(handleOeRefreshCommand, oeActionArgs);
treeMock.verify(x => x.refresh(TypeMoq.It.isAny()), TypeMoq.Times.once());
});
test('errors should be logged when refresh throws', async () => {
treeMock.setup(x => x.refresh(TypeMoq.It.isAny())).throws(new Error());
await instantiationService.invokeFunction(handleOeRefreshCommand, oeActionArgs);
treeMock.verify(x => x.refresh(TypeMoq.It.isAny()), TypeMoq.Times.once());
logServiceMock.verify(x => x.error(TypeMoq.It.isAny()), TypeMoq.Times.once());
});
});
});