mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-14 01:25:40 -05:00
This is a reworking of the unit tests to permit us to better test events from the service host. This new Event Flow Validator class allows creating a chain of events that can then be validated after execution of the request. Each event can have its own custom validation logic for verifying that the object sent via the service host is correct. It also allows us to validate that the order of events are correct. The big drawback is that (at this time) the validator cannot support asynchronous events or non-determinant ordering of events. We don't need this for the query execution functionality despite messages being sent asynchronously because async messages aren't sent during unit tests (due to the db message event only being present on SqlDbConnection classes). If the need arises to do async or out of order event validation, then I have some ideas for how we can do that. * Applying the event flow validator to the query execution service integration tests * Undoing changes to events that were included in cherry-picked commit * Cleaning up event flow validation to query execution * Add efv to cancel tests * Adding efv to dispose tests * Adding efv to subset tests * Adding efv to SaveResults tests * Copyright
110 lines
4.7 KiB
C#
110 lines
4.7 KiB
C#
//
|
|
// Copyright (c) Microsoft. All rights reserved.
|
|
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
|
|
//
|
|
|
|
using System.Threading.Tasks;
|
|
using Microsoft.SqlTools.ServiceLayer.QueryExecution;
|
|
using Microsoft.SqlTools.ServiceLayer.QueryExecution.Contracts;
|
|
using Microsoft.SqlTools.ServiceLayer.QueryExecution.DataStorage;
|
|
using Microsoft.SqlTools.ServiceLayer.SqlContext;
|
|
using Microsoft.SqlTools.ServiceLayer.Test.Utility;
|
|
using Microsoft.SqlTools.ServiceLayer.Workspace;
|
|
using Moq;
|
|
using Xunit;
|
|
|
|
namespace Microsoft.SqlTools.ServiceLayer.Test.QueryExecution
|
|
{
|
|
public class DisposeTests
|
|
{
|
|
[Fact]
|
|
public void DisposeResultSet()
|
|
{
|
|
// Setup: Mock file stream factory, mock db reader
|
|
var mockFileStreamFactory = new Mock<IFileStreamFactory>();
|
|
var mockDataReader = Common.CreateTestConnection(null, false).CreateCommand().ExecuteReaderAsync().Result;
|
|
|
|
// If: I setup a single resultset and then dispose it
|
|
ResultSet rs = new ResultSet(mockDataReader, Common.Ordinal, Common.Ordinal, mockFileStreamFactory.Object);
|
|
rs.Dispose();
|
|
|
|
// Then: The file that was created should have been deleted
|
|
mockFileStreamFactory.Verify(fsf => fsf.DisposeFile(It.IsAny<string>()), Times.Once);
|
|
}
|
|
|
|
[Fact]
|
|
public async void DisposeExecutedQuery()
|
|
{
|
|
// If:
|
|
// ... I request a query (doesn't matter what kind)
|
|
var workspaceService = Common.GetPrimedWorkspaceService(Common.StandardQuery);
|
|
var queryService = Common.GetPrimedExecutionService(null, true, false, workspaceService);
|
|
var executeParams = new QueryExecuteParams {QuerySelection = null, OwnerUri = Common.OwnerUri};
|
|
var executeRequest = RequestContextMocks.Create<QueryExecuteResult>(null);
|
|
await queryService.HandleExecuteRequest(executeParams, executeRequest.Object);
|
|
await queryService.ActiveQueries[Common.OwnerUri].ExecutionTask;
|
|
|
|
// ... And then I dispose of the query
|
|
var disposeParams = new QueryDisposeParams {OwnerUri = Common.OwnerUri};
|
|
var disposeRequest = new EventFlowValidator<QueryDisposeResult>()
|
|
.AddResultValidation(r =>
|
|
{
|
|
// Then: Messages should be null
|
|
Assert.Null(r.Messages);
|
|
}).Complete();
|
|
await queryService.HandleDisposeRequest(disposeParams, disposeRequest.Object);
|
|
|
|
// Then:
|
|
// ... And the active queries should be empty
|
|
disposeRequest.Validate();
|
|
Assert.Empty(queryService.ActiveQueries);
|
|
}
|
|
|
|
[Fact]
|
|
public async void QueryDisposeMissingQuery()
|
|
{
|
|
// If:
|
|
// ... I attempt to dispose a query that doesn't exist
|
|
var workspaceService = new Mock<WorkspaceService<SqlToolsSettings>>();
|
|
var queryService = Common.GetPrimedExecutionService(null, false, false, workspaceService.Object);
|
|
var disposeParams = new QueryDisposeParams {OwnerUri = Common.OwnerUri};
|
|
|
|
var disposeRequest = new EventFlowValidator<QueryDisposeResult>()
|
|
.AddResultValidation(r =>
|
|
{
|
|
// Then: Messages should not be null
|
|
Assert.NotNull(r.Messages);
|
|
Assert.NotEmpty(r.Messages);
|
|
}).Complete();
|
|
await queryService.HandleDisposeRequest(disposeParams, disposeRequest.Object);
|
|
disposeRequest.Validate();
|
|
}
|
|
|
|
[Fact]
|
|
public async Task ServiceDispose()
|
|
{
|
|
// Setup:
|
|
// ... We need a query service
|
|
var workspaceService = Common.GetPrimedWorkspaceService(Common.StandardQuery);
|
|
var queryService = Common.GetPrimedExecutionService(null, true, false, workspaceService);
|
|
|
|
// If:
|
|
// ... I execute some bogus query
|
|
var queryParams = new QueryExecuteParams { QuerySelection = Common.WholeDocument, OwnerUri = Common.OwnerUri };
|
|
var requestContext = RequestContextMocks.Create<QueryExecuteResult>(null);
|
|
await queryService.HandleExecuteRequest(queryParams, requestContext.Object);
|
|
await queryService.ActiveQueries[Common.OwnerUri].ExecutionTask;
|
|
|
|
// ... And it sticks around as an active query
|
|
Assert.Equal(1, queryService.ActiveQueries.Count);
|
|
|
|
// ... The query execution service is disposed, like when the service is shutdown
|
|
queryService.Dispose();
|
|
|
|
// Then:
|
|
// ... There should no longer be an active query
|
|
Assert.Empty(queryService.ActiveQueries);
|
|
}
|
|
}
|
|
}
|