ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-01-14 01:25:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

Ensure connection open for OE queries and fix connection disposal (#359)

Browse Source 
* Ensure connection open for OE queries and fix connection disposal
- Dispose connection in Metadata service, to ensure we cleanly dispose and don't rely on garbage colleciton
- Fixed issue where if the connection was closed, expanding databases in the Server would fail. This is because SMO doesn't always reopen the connection, certainly not for Server level queries. The solution is to always check if open and reopen.
- Added unit tests for this, which required mocking the relevant IsOpen / OpenConnection methods. Refactored SMO wrapper calls into a dedicated class file to handle this
This commit is contained in:
Kevin Cunnane
2017-05-25 18:26:52 -07:00
committed by GitHub
parent c545b74372
commit bbd0972dde
6 changed files with 218 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/NodeTests.cs
View File

@@ -276,6 +276,74 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.ObjectExplorer
string.Format(CultureInfo.CurrentCulture, SR.TreeNodeError, expectedMsg),
node.ErrorStateMessage);
}
[Fact]
public void QueryContextShouldNotCallOpenOnAlreadyOpenConnection()
{
// given a server connection that will state its connection is open
SetupAndRegisterTestConnectionService();
Server smoServer = new Server(new ServerConnection(new SqlConnection(fakeConnectionString)));
Mock<SmoWrapper> wrapper = SetupSmoWrapperForIsOpenTest(smoServer, isOpen: true);
SmoQueryContext context = new SmoQueryContext(smoServer, ServiceProvider, wrapper.Object);
// when I access the Server property
Server actualServer = context.Server;
// Then I do not expect to have open called
Assert.NotNull(actualServer);
wrapper.Verify(c => c.OpenConnection(It.IsAny<Server>()), Times.Never);
}
private Mock<SmoWrapper> SetupSmoWrapperForIsOpenTest(Server smoServer, bool isOpen)
{
Mock<SmoWrapper> wrapper = new Mock<SmoWrapper>();
int count = 0;
wrapper.Setup(c => c.CreateServer(It.IsAny<SqlConnection>()))
.Returns(() => smoServer);
wrapper.Setup(c => c.IsConnectionOpen(It.IsAny<Server>()))
.Returns(() => isOpen);
wrapper.Setup(c => c.OpenConnection(It.IsAny<Server>()))
.Callback(() => count++)
.Verifiable();
return wrapper;
}
[Fact]
public void QueryContextShouldReopenClosedConnectionWhenGettingServer()
{
// given a server connection that will state its connection is closed
SetupAndRegisterTestConnectionService();
Server smoServer = new Server(new ServerConnection(new SqlConnection(fakeConnectionString)));
Mock<SmoWrapper> wrapper = SetupSmoWrapperForIsOpenTest(smoServer, isOpen: false);
SmoQueryContext context = new SmoQueryContext(smoServer, ServiceProvider, wrapper.Object);
// when I access the Server property
Server actualServer = context.Server;
// Then I expect to have open called
Assert.NotNull(actualServer);
wrapper.Verify(c => c.OpenConnection(It.IsAny<Server>()), Times.Once);
}
[Fact]
public void QueryContextShouldReopenClosedConnectionWhenGettingParent()
{
// given a server connection that will state its connection is closed
SetupAndRegisterTestConnectionService();
Server smoServer = new Server(new ServerConnection(new SqlConnection(fakeConnectionString)));
Mock<SmoWrapper> wrapper = SetupSmoWrapperForIsOpenTest(smoServer, isOpen: false);
SmoQueryContext context = new SmoQueryContext(smoServer, ServiceProvider, wrapper.Object);
context.Parent = smoServer;
// when I access the Parent property
SmoObjectBase actualParent = context.Parent;
// Then I expect to have open called
Assert.NotNull(actualParent);
wrapper.Verify(c => c.OpenConnection(It.IsAny<Server>()), Times.Once);
}
private ConnectionService SetupAndRegisterTestConnectionService()
{
@@ -291,27 +359,31 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.ObjectExplorer
private ServerNode SetupServerNodeWithServer(Server smoServer)
{
Mock<SmoServerCreator> creator = new Mock<SmoServerCreator>();
creator.Setup(c => c.Create(It.IsAny<SqlConnection>()))
Mock<SmoWrapper> creator = new Mock<SmoWrapper>();
creator.Setup(c => c.CreateServer(It.IsAny<SqlConnection>()))
.Returns(() => smoServer);
creator.Setup(c => c.IsConnectionOpen(It.IsAny<Server>()))
.Returns(() => true);
ServerNode node = SetupServerNodeWithCreator(creator.Object);
return node;
}
private ServerNode SetupServerNodeWithExceptionCreator(Exception ex)
{
Mock<SmoServerCreator> creator = new Mock<SmoServerCreator>();
creator.Setup(c => c.Create(It.IsAny<SqlConnection>()))
Mock<SmoWrapper> creator = new Mock<SmoWrapper>();
creator.Setup(c => c.CreateServer(It.IsAny<SqlConnection>()))
.Throws(ex);
creator.Setup(c => c.IsConnectionOpen(It.IsAny<Server>()))
.Returns(() => false);
ServerNode node = SetupServerNodeWithCreator(creator.Object);
return node;
}
private ServerNode SetupServerNodeWithCreator(SmoServerCreator creator)
private ServerNode SetupServerNodeWithCreator(SmoWrapper creator)
{
ServerNode node = new ServerNode(defaultConnParams, ServiceProvider);
node.ServerCreator = creator;
node.SmoWrapper = creator;
return node;
}