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

Fix TargetName for assessment items (#968) (#969)

Browse Source 
* Remove the second appearance of server name in TargetName property
* Replace slash with colon as database name separator in TargetName to avoid ambiguity
Fixes #968
This commit is contained in:
Aleksei Guzev
2020-06-08 23:26:25 +03:00
committed by GitHub
parent 836687a41d
commit ca5cbf76e6
2 changed files with 120 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
src/Microsoft.SqlTools.ServiceLayer/SqlAssessment/SqlAssessmentService.cs
View File

@@ -69,7 +69,7 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlAssessment
/// <summary> /// <summary>
/// Gets the <see cref="Engine"/> used to run assessment operations. /// Gets the <see cref="Engine"/> used to run assessment operations.
/// </summary> /// </summary>
private Engine Engine { get; } = new Engine(); internal Engine Engine { get; } = new Engine();
/// <summary> /// <summary>
/// Gets the instance of the connection service, /// Gets the instance of the connection service,
@@ -356,19 +356,23 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlAssessment
foreach (var r in resultsList) foreach (var r in resultsList)
{ {
var targetName = target.Type != SqlObjectType.Server
? $"{target.ServerName}:{target.Name}"
: target.Name;
var item = new CheckInfo() var item = new CheckInfo()
{ {
CheckId = r.Id, CheckId = r.Id,
Description = r.Description, Description = r.Description,
DisplayName = r.DisplayName, DisplayName = r.DisplayName,
HelpLink = r.HelpLink, HelpLink = r.HelpLink,
Level = r.Level.ToString(), Level = r.Level.ToString(),
TargetName = $"{target.ServerName}/{target.Name}", TargetName = targetName,
Tags = r.Tags.ToArray(), Tags = r.Tags.ToArray(),
TargetType = target.Type, TargetType = target.Type,
RulesetName = Engine.Configuration.DefaultRuleset.Name, RulesetName = Engine.Configuration.DefaultRuleset.Name,
RulesetVersion = Engine.Configuration.DefaultRuleset.Version.ToString() RulesetVersion = Engine.Configuration.DefaultRuleset.Version.ToString()
}; };
result.Add(item); result.Add(item);
} }
@@ -379,20 +383,20 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlAssessment
private AssessmentResultItem TranslateAssessmentResult(IAssessmentResult r) private AssessmentResultItem TranslateAssessmentResult(IAssessmentResult r)
{ {
var item = new AssessmentResultItem var item = new AssessmentResultItem
{ {
CheckId = r.Check.Id, CheckId = r.Check.Id,
Description = r.Check.Description, Description = r.Check.Description,
DisplayName = r.Check.DisplayName, DisplayName = r.Check.DisplayName,
HelpLink = r.Check.HelpLink, HelpLink = r.Check.HelpLink,
Level = r.Check.Level.ToString(), Level = r.Check.Level.ToString(),
Message = r.Message, Message = r.Message,
TargetName = r.TargetPath, TargetName = r.TargetPath,
Tags = r.Check.Tags.ToArray(), Tags = r.Check.Tags.ToArray(),
TargetType = r.TargetType, TargetType = r.TargetType,
RulesetVersion = Engine.Configuration.DefaultRuleset.Version.ToString(), RulesetVersion = Engine.Configuration.DefaultRuleset.Version.ToString(),
RulesetName = Engine.Configuration.DefaultRuleset.Name, RulesetName = Engine.Configuration.DefaultRuleset.Name,
Timestamp = r.Timestamp Timestamp = r.Timestamp
}; };
if (r is IAssessmentNote) if (r is IAssessmentNote)
{ {
@@ -426,7 +430,7 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlAssessment
Platform = server.Platform, Platform = server.Platform,
ServerName = server.Name, ServerName = server.Name,
Type = SqlObjectType.Database, Type = SqlObjectType.Database,
Urn = $"{server.Name}/{databaseName}", Urn = $"{server.Name}:{databaseName}",
Version = server.Version Version = server.Version
}; };
} }

117
test/Microsoft.SqlTools.ServiceLayer.IntegrationTests/SqlAssessment/SqlAssessmentServiceTests.cs
View File

@@ -5,12 +5,16 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Reflection; using System.Reflection;
using System.Threading.Tasks; using System.Threading.Tasks;
using Microsoft.SqlServer.Management.Assessment; using Microsoft.SqlServer.Management.Assessment;
using Microsoft.SqlTools.ServiceLayer.Connection; using Microsoft.SqlTools.ServiceLayer.Connection;
using Microsoft.SqlTools.ServiceLayer.Connection.Contracts; using Microsoft.SqlTools.ServiceLayer.Connection.Contracts;
using Microsoft.SqlTools.ServiceLayer.Connection.ReliableConnection;
using Microsoft.SqlTools.ServiceLayer.IntegrationTests.Utility; using Microsoft.SqlTools.ServiceLayer.IntegrationTests.Utility;
using Microsoft.SqlTools.ServiceLayer.SqlAssessment; using Microsoft.SqlTools.ServiceLayer.SqlAssessment;
using Microsoft.SqlTools.ServiceLayer.SqlAssessment.Contracts; using Microsoft.SqlTools.ServiceLayer.SqlAssessment.Contracts;
@@ -27,40 +31,57 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.SqlAssessment
private static readonly string[] AllowedSeverityLevels = { "Information", "Warning", "Critical" }; private static readonly string[] AllowedSeverityLevels = { "Information", "Warning", "Critical" };
[Fact]
public async void InvokeSqlAssessmentServerTest()
{
var liveConnection = LiveConnectionHelper.InitLiveConnectionInfo("master");
var connection = liveConnection.ConnectionInfo.AllConnections.FirstOrDefault();
Debug.Assert(connection != null, "Live connection is always expected providing a connection");
var serverInfo = ReliableConnectionHelper.GetServerVersion(connection);
var response = await CallAssessment<AssessmentResultItem>(
nameof(SqlAssessmentService.InvokeSqlAssessment),
SqlObjectType.Server,
liveConnection);
Assert.All(
response.Items,
i =>
{
Assert.NotNull(i.Message);
Assert.NotEmpty(i.Message);
Assert.Equal(serverInfo.ServerName, i.TargetName);
if (i.Kind == 0)
{
AssertInfoPresent(i);
}
});
}
[Fact] [Fact]
public async void GetAssessmentItemsServerTest() public async void GetAssessmentItemsServerTest()
{ {
var liveConnection = LiveConnectionHelper.InitLiveConnectionInfo("master");
var connection = liveConnection.ConnectionInfo.AllConnections.FirstOrDefault();
Debug.Assert(connection != null, "Live connection is always expected providing a connection");
var serverInfo = ReliableConnectionHelper.GetServerVersion(connection);
var response = await CallAssessment<CheckInfo>( var response = await CallAssessment<CheckInfo>(
nameof(SqlAssessmentService.GetAssessmentItems), nameof(SqlAssessmentService.GetAssessmentItems),
SqlObjectType.Server); SqlObjectType.Server,
liveConnection);
Assert.All( Assert.All(
response.Items, response.Items,
i => i =>
{ {
AssertInfoPresent(i); AssertInfoPresent(i);
}); Assert.Equal(serverInfo.ServerName, i.TargetName);
}
[Fact]
public async void InvokeSqlAssessmentServerTest()
{
var response = await CallAssessment<AssessmentResultItem>(
nameof(SqlAssessmentService.InvokeSqlAssessment),
SqlObjectType.Server);
Assert.All(
response.Items,
i =>
{
Assert.NotNull(i.Message);
Assert.NotEmpty(i.Message);
if (i.Kind == 0)
{
AssertInfoPresent(i);
}
}); });
} }
@@ -68,16 +89,17 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.SqlAssessment
public async void GetAssessmentItemsDatabaseTest() public async void GetAssessmentItemsDatabaseTest()
{ {
const string DatabaseName = "tempdb"; const string DatabaseName = "tempdb";
var liveConnection = LiveConnectionHelper.InitLiveConnectionInfo(DatabaseName);
var response = await CallAssessment<CheckInfo>( var response = await CallAssessment<CheckInfo>(
nameof(SqlAssessmentService.GetAssessmentItems), nameof(SqlAssessmentService.GetAssessmentItems),
SqlObjectType.Database, SqlObjectType.Database,
DatabaseName); liveConnection);
Assert.All( Assert.All(
response.Items, response.Items,
i => i =>
{ {
StringAssert.EndsWith("/" + DatabaseName, i.TargetName); StringAssert.EndsWith(":" + DatabaseName, i.TargetName);
AssertInfoPresent(i); AssertInfoPresent(i);
}); });
} }
@@ -86,16 +108,17 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.SqlAssessment
public async void InvokeSqlAssessmentIDatabaseTest() public async void InvokeSqlAssessmentIDatabaseTest()
{ {
const string DatabaseName = "tempdb"; const string DatabaseName = "tempdb";
var liveConnection = LiveConnectionHelper.InitLiveConnectionInfo(DatabaseName);
var response = await CallAssessment<AssessmentResultItem>( var response = await CallAssessment<AssessmentResultItem>(
nameof(SqlAssessmentService.InvokeSqlAssessment), nameof(SqlAssessmentService.InvokeSqlAssessment),
SqlObjectType.Database, SqlObjectType.Database,
DatabaseName); liveConnection);
Assert.All( Assert.All(
response.Items, response.Items,
i => i =>
{ {
StringAssert.EndsWith("/" + DatabaseName, i.TargetName); StringAssert.EndsWith(":" + DatabaseName, i.TargetName);
Assert.NotNull(i.Message); Assert.NotNull(i.Message);
Assert.NotEmpty(i.Message); Assert.NotEmpty(i.Message);
@@ -109,10 +132,9 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.SqlAssessment
private static async Task<AssessmentResult<TResult>> CallAssessment<TResult>( private static async Task<AssessmentResult<TResult>> CallAssessment<TResult>(
string methodName, string methodName,
SqlObjectType sqlObjectType, SqlObjectType sqlObjectType,
string databaseName = "master") LiveConnectionHelper.TestConnectionResult liveConnection)
where TResult : AssessmentItemInfo where TResult : AssessmentItemInfo
{ {
var liveConnection = LiveConnectionHelper.InitLiveConnectionInfo(databaseName);
var connInfo = liveConnection.ConnectionInfo; var connInfo = liveConnection.ConnectionInfo;
AssessmentResult<TResult> response; AssessmentResult<TResult> response;
@@ -121,6 +143,8 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.SqlAssessment
TestServiceProvider.Instance.ConnectionService, TestServiceProvider.Instance.ConnectionService,
TestServiceProvider.Instance.WorkspaceService)) TestServiceProvider.Instance.WorkspaceService))
{ {
AddTestRules(service);
string randomUri = Guid.NewGuid().ToString(); string randomUri = Guid.NewGuid().ToString();
AssessmentParams requestParams = AssessmentParams requestParams =
new AssessmentParams { OwnerUri = randomUri, TargetType = sqlObjectType }; new AssessmentParams { OwnerUri = randomUri, TargetType = sqlObjectType };
@@ -164,6 +188,41 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.SqlAssessment
return response; return response;
} }
private static void AddTestRules(SqlAssessmentService service)
{
const string TestRuleset = @"
{
'name': 'Tags & Checks',
'version': '0.3',
'schemaVersion': '1.0',
'rules': [
{
'id': 'ServerRule',
'itemType': 'definition',
'tags': [ 'Test' ],
'displayName': 'Test server check',
'description': 'This check always fails for testing purposes.',
'message': 'This check intentionally fails',
'target': { 'type': 'Server' }
},
{
'id': 'DatabaseRule',
'itemType': 'definition',
'tags': [ 'Test' ],
'displayName': 'Test server check',
'description': 'This check always fails for testing purposes.',
'message': 'This check intentionally fails',
'target': { 'type': 'Database' }
}
]
}
";
using (var reader = new StringReader(TestRuleset))
{
service.Engine.PushRuleFactoryJson(reader);
}
}
private void AssertInfoPresent(AssessmentItemInfo item) private void AssertInfoPresent(AssessmentItemInfo item)
{ {
Assert.NotNull(item.CheckId); Assert.NotNull(item.CheckId);