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

Splitting out default DacFx options for Publish and Schema Compare (#1126)

Browse Source 
* Splitting out schema comp and publish defaults

* Added test

* Correcting comments, changing scope

* Moving DeploymentOptions to DacFx folder due to dependency hierarchy between DacFx and SchemaCompare
This commit is contained in:
Benjin Dubishar
2020-11-25 14:44:34 -08:00
committed by GitHub
parent 4f42b17226
commit 25c542319e
10 changed files with 130 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

301
src/Microsoft.SqlTools.ServiceLayer/SchemaCompare/Contracts/DeploymentOptions.cs
View File

@@ -1,301 +0,0 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System.IO;
using System.Threading.Tasks;
using Microsoft.SqlServer.Dac;
namespace Microsoft.SqlTools.ServiceLayer.SchemaCompare.Contracts
{
/// <summary>
/// Class to define deployment options.
/// Keeping the order and defaults same as DacFx
/// The default values here should also match the default values in ADS UX
/// </summary>
public class DeploymentOptions
{
public bool IgnoreTableOptions { get; set; }
public bool IgnoreSemicolonBetweenStatements { get; set; }
public bool IgnoreRouteLifetime { get; set; }
public bool IgnoreRoleMembership { get; set; }
public bool IgnoreQuotedIdentifiers { get; set; }
public bool IgnorePermissions { get; set; }
public bool IgnorePartitionSchemes { get; set; }
public bool IgnoreObjectPlacementOnPartitionScheme { get; set; }
public bool IgnoreNotForReplication { get; set; }
public bool IgnoreLoginSids { get; set; }
public bool IgnoreLockHintsOnIndexes { get; set; }
public bool IgnoreKeywordCasing { get; set; }
public bool IgnoreIndexPadding { get; set; }
public bool IgnoreIndexOptions { get; set; }
public bool IgnoreIncrement { get; set; }
public bool IgnoreIdentitySeed { get; set; }
public bool IgnoreUserSettingsObjects { get; set; }
public bool IgnoreFullTextCatalogFilePath { get; set; }
public bool IgnoreWhitespace { get; set; }
public bool IgnoreWithNocheckOnForeignKeys { get; set; }
public bool VerifyCollationCompatibility { get; set; }
public bool UnmodifiableObjectWarnings { get; set; }
public bool TreatVerificationErrorsAsWarnings { get; set; }
public bool ScriptRefreshModule { get; set; }
public bool ScriptNewConstraintValidation { get; set; }
public bool ScriptFileSize { get; set; }
public bool ScriptDeployStateChecks { get; set; }
public bool ScriptDatabaseOptions { get; set; }
public bool ScriptDatabaseCompatibility { get; set; }
public bool ScriptDatabaseCollation { get; set; }
public bool RunDeploymentPlanExecutors { get; set; }
public bool RegisterDataTierApplication { get; set; }
public bool PopulateFilesOnFileGroups { get; set; }
public bool NoAlterStatementsToChangeClrTypes { get; set; }
public bool IncludeTransactionalScripts { get; set; }
public bool IncludeCompositeObjects { get; set; }
public bool AllowUnsafeRowLevelSecurityDataMovement { get; set; }
public bool IgnoreWithNocheckOnCheckConstraints { get; set; }
public bool IgnoreFillFactor { get; set; }
public bool IgnoreFileSize { get; set; }
public bool IgnoreFilegroupPlacement { get; set; }
public bool DoNotAlterReplicatedObjects { get; set; }
public bool DoNotAlterChangeDataCaptureObjects { get; set; }
public bool DisableAndReenableDdlTriggers { get; set; }
public bool DeployDatabaseInSingleUserMode { get; set; }
public bool CreateNewDatabase { get; set; }
public bool CompareUsingTargetCollation { get; set; }
public bool CommentOutSetVarDeclarations { get; set; }
public int CommandTimeout { get; set; } = 120;
public int LongRunningCommandTimeout { get; set; } = 0;
public int DatabaseLockTimeout { get; set; } = 60;
public bool BlockWhenDriftDetected { get; set; }
public bool BlockOnPossibleDataLoss { get; set; }
public bool BackupDatabaseBeforeChanges { get; set; }
public bool AllowIncompatiblePlatform { get; set; }
public bool AllowDropBlockingAssemblies { get; set; }
public string AdditionalDeploymentContributorArguments { get; set; }
public string AdditionalDeploymentContributors { get; set; }
public bool DropConstraintsNotInSource { get; set; }
public bool DropDmlTriggersNotInSource { get; set; }
public bool DropExtendedPropertiesNotInSource { get; set; }
public bool DropIndexesNotInSource { get; set; }
public bool IgnoreFileAndLogFilePath { get; set; }
public bool IgnoreExtendedProperties { get; set; }
public bool IgnoreDmlTriggerState { get; set; }
public bool IgnoreDmlTriggerOrder { get; set; }
public bool IgnoreDefaultSchema { get; set; }
public bool IgnoreDdlTriggerState { get; set; }
public bool IgnoreDdlTriggerOrder { get; set; }
public bool IgnoreCryptographicProviderFilePath { get; set; }
public bool VerifyDeployment { get; set; }
public bool IgnoreComments { get; set; }
public bool IgnoreColumnCollation { get; set; }
public bool IgnoreAuthorizer { get; set; }
public bool IgnoreAnsiNulls { get; set; }
public bool GenerateSmartDefaults { get; set; }
public bool DropStatisticsNotInSource { get; set; }
public bool DropRoleMembersNotInSource { get; set; }
public bool DropPermissionsNotInSource { get; set; }
public bool DropObjectsNotInSource { get; set; }
public bool IgnoreColumnOrder { get; set; }
public bool IgnoreTablePartitionOptions { get; set; } // DW Specific
public string AdditionalDeploymentContributorPaths { get; set; } = string.Empty;
public ObjectType[] DoNotDropObjectTypes { get; set; } = null;
public ObjectType[] ExcludeObjectTypes { get; set; } =
{
ObjectType.ServerTriggers,
ObjectType.Routes,
ObjectType.LinkedServerLogins,
ObjectType.Endpoints,
ObjectType.ErrorMessages,
ObjectType.Files,
ObjectType.Logins,
ObjectType.LinkedServers,
ObjectType.Credentials,
ObjectType.DatabaseScopedCredentials,
ObjectType.DatabaseEncryptionKeys,
ObjectType.MasterKeys,
ObjectType.DatabaseAuditSpecifications,
ObjectType.Audits,
ObjectType.ServerAuditSpecifications,
ObjectType.CryptographicProviders,
ObjectType.ServerRoles,
ObjectType.EventSessions,
ObjectType.DatabaseOptions,
ObjectType.EventNotifications,
ObjectType.ServerRoleMembership,
ObjectType.AssemblyFiles,
};
public DeploymentOptions()
{
DacDeployOptions options = new DacDeployOptions();
// Adding these defaults to ensure behavior similarity with other tools. Dacfx and SSMS import/export wizards use these defaults.
// Tracking the full fix : https://github.com/microsoft/azuredatastudio/issues/5599
options.AllowDropBlockingAssemblies = true;
options.AllowIncompatiblePlatform = true;
options.DropObjectsNotInSource = true;
options.DropPermissionsNotInSource = true;
options.DropRoleMembersNotInSource = true;
options.IgnoreKeywordCasing = false;
options.IgnoreSemicolonBetweenStatements = false;
System.Reflection.PropertyInfo[] deploymentOptionsProperties = this.GetType().GetProperties();
foreach (var deployOptionsProp in deploymentOptionsProperties)
{
var prop = options.GetType().GetProperty(deployOptionsProp.Name);
// Note that we set excluded object types here since dacfx has this value as null;
if (prop != null && deployOptionsProp.Name != "ExcludeObjectTypes")
{
deployOptionsProp.SetValue(this, prop.GetValue(options));
}
}
}
public DeploymentOptions(DacDeployOptions options)
{
SetOptions(options);
}
/// <summary>
/// initialize deployment options from the options in a publish profile.xml
/// </summary>
/// <param name="options">options created from the profile</param>
/// <param name="profilePath"></param>
public async Task InitializeFromProfile(DacDeployOptions options, string profilePath)
{
// check if defaults need to be set if they aren't specified in the profile
string contents = await File.ReadAllTextAsync(profilePath);
if (!contents.Contains("<AllowDropBlockingAssemblies>"))
{
options.AllowDropBlockingAssemblies = true;
}
if (!contents.Contains("<AllowIncompatiblePlatform>"))
{
options.AllowIncompatiblePlatform = true;
}
if (!contents.Contains("<DropObjectsNotInSource>"))
{
options.DropObjectsNotInSource = true;
}
if (!contents.Contains("<DropPermissionsNotInSource>"))
{
options.DropPermissionsNotInSource = true;
}
if (!contents.Contains("<DropRoleMembersNotInSource>"))
{
options.DropRoleMembersNotInSource = true;
}
if (!contents.Contains("<IgnoreKeywordCasing>"))
{
options.IgnoreKeywordCasing = false;
}
if (!contents.Contains("<IgnoreSemicolonBetweenStatements>"))
{
options.IgnoreSemicolonBetweenStatements = false;
}
SetOptions(options);
}
public void SetOptions(DacDeployOptions options)
{
System.Reflection.PropertyInfo[] deploymentOptionsProperties = this.GetType().GetProperties();
foreach (var deployOptionsProp in deploymentOptionsProperties)
{
var prop = options.GetType().GetProperty(deployOptionsProp.Name);
if (prop != null)
{
deployOptionsProp.SetValue(this, prop.GetValue(options));
}
}
}
}
}

6
src/Microsoft.SqlTools.ServiceLayer/SchemaCompare/Contracts/SchemaCompareOpenScmpRequest.cs
View File

@@ -2,10 +2,10 @@
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using Microsoft.SqlTools.Hosting.Protocol.Contracts;
using Microsoft.SqlTools.ServiceLayer.TaskServices;
using Microsoft.SqlTools.ServiceLayer.Utility;
using System.Collections.Generic;
using Microsoft.SqlTools.Hosting.Protocol.Contracts;
using Microsoft.SqlTools.ServiceLayer.DacFx.Contracts;
using Microsoft.SqlTools.ServiceLayer.Utility;
namespace Microsoft.SqlTools.ServiceLayer.SchemaCompare.Contracts
{

1
src/Microsoft.SqlTools.ServiceLayer/SchemaCompare/Contracts/SchemaCompareOptionsRequest.cs
View File

@@ -4,6 +4,7 @@
//
using Microsoft.SqlTools.Hosting.Protocol.Contracts;
using Microsoft.SqlTools.ServiceLayer.DacFx.Contracts;
using Microsoft.SqlTools.ServiceLayer.Utility;
namespace Microsoft.SqlTools.ServiceLayer.SchemaCompare.Contracts

3
src/Microsoft.SqlTools.ServiceLayer/SchemaCompare/Contracts/SchemaCompareRequest.cs
View File

@@ -2,12 +2,13 @@
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System.Collections.Generic;
using Microsoft.SqlServer.Dac.Compare;
using Microsoft.SqlTools.Hosting.Protocol.Contracts;
using Microsoft.SqlTools.ServiceLayer.Connection.Contracts;
using Microsoft.SqlTools.ServiceLayer.DacFx.Contracts;
using Microsoft.SqlTools.ServiceLayer.TaskServices;
using Microsoft.SqlTools.ServiceLayer.Utility;
using System.Collections.Generic;
namespace Microsoft.SqlTools.ServiceLayer.SchemaCompare.Contracts
{

13
src/Microsoft.SqlTools.ServiceLayer/SchemaCompare/SchemaCompareOpenScmpOperation.cs
View File

@@ -2,20 +2,17 @@
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using Microsoft.SqlServer.Dac;
using Microsoft.SqlServer.Dac.Compare;
using Microsoft.SqlTools.ServiceLayer.Connection;
using Microsoft.SqlTools.ServiceLayer.SchemaCompare.Contracts;
using Microsoft.SqlTools.ServiceLayer.TaskServices;
using Microsoft.SqlTools.Utility;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text.RegularExpressions;
using System.Threading;
using System.Xml;
using System.Xml.Linq;
using Microsoft.SqlServer.Dac.Compare;
using Microsoft.SqlTools.ServiceLayer.DacFx.Contracts;
using Microsoft.SqlTools.ServiceLayer.SchemaCompare.Contracts;
using Microsoft.SqlTools.ServiceLayer.TaskServices;
using Microsoft.SqlTools.Utility;
namespace Microsoft.SqlTools.ServiceLayer.SchemaCompare
{

18
src/Microsoft.SqlTools.ServiceLayer/SchemaCompare/SchemaCompareService.cs
View File

@@ -2,19 +2,19 @@
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using Microsoft.SqlTools.Hosting.Protocol;
using Microsoft.SqlTools.ServiceLayer.Connection;
using Microsoft.SqlTools.ServiceLayer.SchemaCompare.Contracts;
using Microsoft.SqlTools.ServiceLayer.Hosting;
using Microsoft.SqlTools.ServiceLayer.TaskServices;
using System;
using System.Collections.Concurrent;
using System.Diagnostics;
using System.Threading.Tasks;
using Microsoft.SqlServer.Dac.Compare;
using Microsoft.SqlTools.Hosting.Protocol;
using Microsoft.SqlTools.ServiceLayer.Connection;
using Microsoft.SqlTools.ServiceLayer.DacFx.Contracts;
using Microsoft.SqlTools.ServiceLayer.Hosting;
using Microsoft.SqlTools.ServiceLayer.SchemaCompare.Contracts;
using Microsoft.SqlTools.ServiceLayer.TaskServices;
using Microsoft.SqlTools.ServiceLayer.Utility;
using Microsoft.SqlTools.Utility;
using System.Diagnostics;
using System.Threading;
namespace Microsoft.SqlTools.ServiceLayer.SchemaCompare
{
@@ -278,8 +278,8 @@ namespace Microsoft.SqlTools.ServiceLayer.SchemaCompare
{
try
{
// this does not need to be an async operation since this only creates and resturn the default opbject
DeploymentOptions options = new DeploymentOptions();
// this does not need to be an async operation since this only creates and returns the default object
DeploymentOptions options = DeploymentOptions.GetDefaultSchemaCompareOptions();
await requestContext.SendResult(new SchemaCompareOptionsResult()
{

13
src/Microsoft.SqlTools.ServiceLayer/SchemaCompare/SchemaCompareUtils.cs
View File

@@ -2,16 +2,17 @@
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using Microsoft.SqlServer.Dac;
using Microsoft.SqlServer.Dac.Compare;
using Microsoft.SqlServer.Dac.Model;
using Microsoft.SqlTools.ServiceLayer.Connection;
using Microsoft.SqlTools.ServiceLayer.SchemaCompare.Contracts;
using Microsoft.SqlTools.ServiceLayer.Utility;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text.RegularExpressions;
using Microsoft.SqlServer.Dac;
using Microsoft.SqlServer.Dac.Compare;
using Microsoft.SqlServer.Dac.Model;
using Microsoft.SqlTools.ServiceLayer.Connection;
using Microsoft.SqlTools.ServiceLayer.DacFx.Contracts;
using Microsoft.SqlTools.ServiceLayer.SchemaCompare.Contracts;
using Microsoft.SqlTools.ServiceLayer.Utility;
namespace Microsoft.SqlTools.ServiceLayer.SchemaCompare
{