Adding SqlPackage Service for supporting Sqlpackage command generation changes (#2556)

ssreerama · web-flow · commit 6858e96a2cb0 · 2026-01-14T11:39:53.000-06:00
* Inital changes: sqlpakcage service with nuget import

* fixing build errors

* adding hint path to use the hybrid package and updated sqlpakcage service

* new updates

* adding test with generic command generation

* latest updates with serialized params

* still have different API method calls

* making the API to generic

* final changes

* refactoring by reusing targetFx variable

* keeping the sqlpackage command line result separate

* removing hintpatha nd using core nuget

* fixing build and tests with sqlpackage .core Nuget

* using new nuget version

* adding command line args DTO

* fixing the issues

* using Builder with latest nuget and updated tests

* refactoring and cpturing the sqlpackage exception

* adding XML comments for the methods

* adding masked option to the command request

* updating sqlpackage core nuget version

* Temporarily adding the Nuget for PR validations, will remove once the nuget publicly available

* Refactoring itno simple classes

* test fixes

* removing local nuget, the core nuget is published to nuget org

* removing the duplicated commandlineArgs and inheriting from the dacfx cmdArgs

* adding loc string and removed undo batchparser change

* vbump core nuget with the latest iteration
diff --git a/Packages.props b/Packages.props
@@ -22,6 +22,7 @@
     <PackageReference Update="Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider" Version="1.1.1" />
     <PackageReference Update="Microsoft.SqlServer.Management.SmoMetadataProvider" Version="170.18.0" />
     <PackageReference Update="Microsoft.SqlServer.DacFx" Version="170.2.70" />
+    <PackageReference Update="Microsoft.SqlPackage.Core" Version="0.1.75-preview" />
     <PackageReference Update="Microsoft.SqlServer.DacFx.Projects" Version="0.5.2-preview" />
     <PackageReference Update="Microsoft.Azure.Kusto.Data" Version="14.0.3" />
     <PackageReference Update="Microsoft.Azure.Kusto.Language" Version="9.0.4" />
@@ -89,4 +90,4 @@
   <ItemGroup>
     <GlobalPackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/src/Microsoft.Kusto.ServiceLayer/Localization/sr.cs b/src/Microsoft.Kusto.ServiceLayer/Localization/sr.cs
@@ -1,5 +1,5 @@
 // WARNING:
-// This file was generated by the Microsoft SQL Server String Resource Tool 9.0.0.0
+// This file was generated by the Microsoft SQL Server String Resource Tool 10.0.0.0
 // from information in sr.strings
 // DO NOT MODIFY THIS FILE'S CONTENTS, THEY WILL BE OVERWRITTEN
 //
diff --git a/src/Microsoft.SqlTools.Credentials/Localization/sr.cs b/src/Microsoft.SqlTools.Credentials/Localization/sr.cs
@@ -1,5 +1,5 @@
 // WARNING:
-// This file was generated by the Microsoft SQL Server String Resource Tool 9.0.0.0
+// This file was generated by the Microsoft SQL Server String Resource Tool 10.0.0.0
 // from information in sr.strings
 // DO NOT MODIFY THIS FILE'S CONTENTS, THEY WILL BE OVERWRITTEN
 //
diff --git a/src/Microsoft.SqlTools.Hosting/Localization/sr.cs b/src/Microsoft.SqlTools.Hosting/Localization/sr.cs
@@ -1,5 +1,5 @@
 // WARNING:
-// This file was generated by the Microsoft SQL Server String Resource Tool 9.0.0.0
+// This file was generated by the Microsoft SQL Server String Resource Tool 10.0.0.0
 // from information in sr.strings
 // DO NOT MODIFY THIS FILE'S CONTENTS, THEY WILL BE OVERWRITTEN
 //
diff --git a/src/Microsoft.SqlTools.ManagedBatchParser/Localization/sr.cs b/src/Microsoft.SqlTools.ManagedBatchParser/Localization/sr.cs
@@ -1,5 +1,5 @@
 // WARNING:
-// This file was generated by the Microsoft SQL Server String Resource Tool 9.0.0.0
+// This file was generated by the Microsoft SQL Server String Resource Tool 10.0.0.0
 // from information in sr.strings
 // DO NOT MODIFY THIS FILE'S CONTENTS, THEY WILL BE OVERWRITTEN
 //
diff --git a/src/Microsoft.SqlTools.ResourceProvider.Core/Localization/sr.cs b/src/Microsoft.SqlTools.ResourceProvider.Core/Localization/sr.cs
@@ -1,5 +1,5 @@
 // WARNING:
-// This file was generated by the Microsoft SQL Server String Resource Tool 9.0.0.0
+// This file was generated by the Microsoft SQL Server String Resource Tool 10.0.0.0
 // from information in sr.strings
 // DO NOT MODIFY THIS FILE'S CONTENTS, THEY WILL BE OVERWRITTEN
 //
diff --git a/src/Microsoft.SqlTools.ResourceProvider.DefaultImpl/Localization/sr.cs b/src/Microsoft.SqlTools.ResourceProvider.DefaultImpl/Localization/sr.cs
@@ -1,5 +1,5 @@
 // WARNING:
-// This file was generated by the Microsoft SQL Server String Resource Tool 9.0.0.0
+// This file was generated by the Microsoft SQL Server String Resource Tool 10.0.0.0
 // from information in sr.strings
 // DO NOT MODIFY THIS FILE'S CONTENTS, THEY WILL BE OVERWRITTEN
 //
diff --git a/src/Microsoft.SqlTools.ServiceLayer/DacFx/Contracts/DeploymentOptions.cs b/src/Microsoft.SqlTools.ServiceLayer/DacFx/Contracts/DeploymentOptions.cs
@@ -283,5 +283,22 @@ public static DeploymentOptions GetDefaultPublishOptions()
 
             return result;
         }
+
+        /// <summary>
+        /// Normalizes the 7 overridden options for Publish/Script SqlPackage command generation.
+        /// Resets them to DacFx native defaults so they won't appear as unnecessary /p: parameters.
+        /// Works because: if user changed a value, they changed it to the opposite (which is the DacFx default).
+        /// </summary>
+        public void NormalizePublishDefaults()
+        {
+            // Simply set the 7 STS-overridden options to DacFx defaults
+            BooleanOptionsDictionary[nameof(DacDeployOptions.AllowDropBlockingAssemblies)].Value = false;
+            BooleanOptionsDictionary[nameof(DacDeployOptions.AllowIncompatiblePlatform)].Value = false;
+            BooleanOptionsDictionary[nameof(DacDeployOptions.DropObjectsNotInSource)].Value = false;
+            BooleanOptionsDictionary[nameof(DacDeployOptions.DropPermissionsNotInSource)].Value = false;
+            BooleanOptionsDictionary[nameof(DacDeployOptions.DropRoleMembersNotInSource)].Value = false;
+            BooleanOptionsDictionary[nameof(DacDeployOptions.IgnoreKeywordCasing)].Value = true;
+            BooleanOptionsDictionary[nameof(DacDeployOptions.IgnoreSemicolonBetweenStatements)].Value = true;
+        }
     }
 }
diff --git a/src/Microsoft.SqlTools.ServiceLayer/HostLoader.cs b/src/Microsoft.SqlTools.ServiceLayer/HostLoader.cs
@@ -20,6 +20,7 @@
 using Microsoft.SqlTools.ServiceLayer.Connection;
 using Microsoft.SqlTools.ServiceLayer.Copilot;
 using Microsoft.SqlTools.ServiceLayer.DacFx;
+using Microsoft.SqlTools.ServiceLayer.SqlPackage;
 using Microsoft.SqlTools.ServiceLayer.DisasterRecovery;
 using Microsoft.SqlTools.ServiceLayer.EditData;
 using Microsoft.SqlTools.ServiceLayer.ExecutionPlan;
@@ -136,6 +137,9 @@ private static void InitializeRequestHandlersAndServices(ServiceHost serviceHost
             DacFxService.Instance.InitializeService(serviceHost, commandOptions);
             serviceProvider.RegisterSingleService(DacFxService.Instance);
 
+            SqlPackageService.Instance.InitializeService(serviceHost);
+            serviceProvider.RegisterSingleService(SqlPackageService.Instance);
+
             CmsService.Instance.InitializeService(serviceHost);
             serviceProvider.RegisterSingleService(CmsService.Instance);
 
diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.cs b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.cs
@@ -1,5 +1,5 @@
 // WARNING:
-// This file was generated by the Microsoft SQL Server String Resource Tool 9.0.0.0
+// This file was generated by the Microsoft SQL Server String Resource Tool 10.0.0.0
 // from information in sr.strings
 // DO NOT MODIFY THIS FILE'S CONTENTS, THEY WILL BE OVERWRITTEN
 //
@@ -1623,6 +1623,14 @@ public static string SqlBindingsNet5NotSupported
             }
         }
 
+        public static string SqlPackageInvalidRequestParameters
+        {
+            get
+            {
+                return Keys.GetString(Keys.SqlPackageInvalidRequestParameters);
+            }
+        }
+
         public static string Statement
         {
             get
@@ -11740,6 +11748,9 @@ public class Keys
             public const string SqlBindingsNet5NotSupported = "SqlBindingsNet5NotSupported";
 
 
+            public const string SqlPackageInvalidRequestParameters = "SqlPackageInvalidRequestParameters";
+
+
             public const string Statement = "Statement";
 
 
diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.resx b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.resx
@@ -1173,6 +1173,10 @@
     <value>Adding SQL bindings is not supported for .NET 5</value>
     <comment></comment>
   </data>
+  <data name="SqlPackageInvalidRequestParameters" xml:space="preserve">
+    <value>Invalid request parameters</value>
+    <comment></comment>
+  </data>
   <data name="Statement" xml:space="preserve">
     <value>Statement</value>
     <comment> Statement</comment>
diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.strings b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.strings
@@ -504,6 +504,10 @@ CouldntFindAzureFunction(string functionName, string fileName) = Couldn't find A
 MoreThanOneAzureFunctionWithName(string functionName, string fileName) = More than one Azure function found with the FunctionName '{0}' in {1}
 SqlBindingsNet5NotSupported = Adding SQL bindings is not supported for .NET 5
 
+############################################################################
+# SqlPackage Service
+
+SqlPackageInvalidRequestParameters = Invalid request parameters
 
 ############################################################################
 # Show Plan
diff --git a/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.xlf b/src/Microsoft.SqlTools.ServiceLayer/Localization/sr.xlf
@@ -7048,6 +7048,11 @@ The Query Processor estimates that implementing the following index could improv
         <target state="new">Query execution completed with errors</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="SqlPackageInvalidRequestParameters">
+        <source>Invalid request parameters</source>
+        <target state="new">Invalid request parameters</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/src/Microsoft.SqlTools.ServiceLayer/Microsoft.SqlTools.ServiceLayer.csproj b/src/Microsoft.SqlTools.ServiceLayer/Microsoft.SqlTools.ServiceLayer.csproj
@@ -70,6 +70,7 @@
     <PackageReference Include="Microsoft.SqlServer.Assessment" />
     <PackageReference Include="Microsoft.SqlServer.DacFx.Projects" />
     <PackageReference Include="Microsoft.SqlServer.DacFx" />
+    <PackageReference Include="Microsoft.SqlPackage.Core" />
     <PackageReference Include="Microsoft.SqlServer.Management.QueryStoreModel" />
     <PackageReference Include="Microsoft.SqlServer.Management.SmoMetadataProvider" />
     <PackageReference Include="Microsoft.SqlServer.Management.SqlParser" />
diff --git a/src/Microsoft.SqlTools.ServiceLayer/SqlPackage/Contracts/CommandLineArguments.cs b/src/Microsoft.SqlTools.ServiceLayer/SqlPackage/Contracts/CommandLineArguments.cs
@@ -0,0 +1,15 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+namespace Microsoft.SqlTools.ServiceLayer.SqlPackage.Contracts
+{
+    /// <summary>
+    /// Command-line arguments for SqlPackage operations containing source/target paths, connection strings, etc.
+    /// Inherits from DacFx CommandLineArguments to avoid duplication and enable direct usage with SqlPackage APIs.
+    /// </summary>
+    public class SqlPackageCommandLineArguments : Microsoft.Data.Tools.Schema.CommandLineTool.CommandLineArguments
+    {
+    }
+}
diff --git a/src/Microsoft.SqlTools.ServiceLayer/SqlPackage/Contracts/GenerateSqlPackageCommandRequest.cs b/src/Microsoft.SqlTools.ServiceLayer/SqlPackage/Contracts/GenerateSqlPackageCommandRequest.cs
@@ -0,0 +1,65 @@
+//
+// 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.Data.Tools.Schema.CommandLineTool.Contracts;
+using Microsoft.SqlServer.Dac;
+using Microsoft.SqlTools.Hosting.Protocol.Contracts;
+
+namespace Microsoft.SqlTools.ServiceLayer.SqlPackage.Contracts
+{
+    /// <summary>
+    /// Parameters for generating SqlPackage command-line strings.
+    /// </summary>
+    public class SqlPackageCommandParams
+    {
+        /// <summary>
+        /// Command-line arguments containing source/target paths, connection strings, etc.
+        /// Populated from UI interactions in the client application.
+        /// </summary>
+        public SqlPackageCommandLineArguments CommandLineArguments { get; set; }
+
+        /// <summary>
+        /// Deployment options (for Publish, Script operations).
+        /// Converted to DacDeployOptions using DacFxUtils.CreateDeploymentOptions.
+        /// </summary>
+        public DacFx.Contracts.DeploymentOptions DeploymentOptions { get; set; }
+
+        /// <summary>
+        /// Extract options (for Extract operation)
+        /// </summary>
+        public DacExtractOptions ExtractOptions { get; set; }
+
+        /// <summary>
+        /// Export options (for Export operation)
+        /// </summary>
+        public DacExportOptions ExportOptions { get; set; }
+
+        /// <summary>
+        /// Import options (for Import operation)
+        /// </summary>
+        public DacImportOptions ImportOptions { get; set; }
+
+        /// <summary>
+        /// SQLCMD variables (for Publish, Script operations)
+        /// </summary>
+        public Dictionary<string, string> Variables { get; set; }
+
+        /// <summary>
+        /// Specifies the masking mode for data operations.
+        /// Values: Masked(Default), Unmasked
+        /// </summary>
+        public MaskMode MaskMode { get; set; }
+    }
+
+    /// <summary>
+    /// Request to generate SqlPackage command based on action
+    /// </summary>
+    public class GenerateSqlPackageCommandRequest
+    {
+        public static readonly RequestType<SqlPackageCommandParams, SqlPackageCommandResult> Type =
+            RequestType<SqlPackageCommandParams, SqlPackageCommandResult>.Create("sqlpackage/generateCommand");
+    }
+}
diff --git a/src/Microsoft.SqlTools.ServiceLayer/SqlPackage/Contracts/SqlPackageCommandResult.cs b/src/Microsoft.SqlTools.ServiceLayer/SqlPackage/Contracts/SqlPackageCommandResult.cs
@@ -0,0 +1,28 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+namespace Microsoft.SqlTools.ServiceLayer.SqlPackage.Contracts
+{
+    /// <summary>
+    /// Generic result for SqlPackage command generation operations
+    /// </summary>
+    public class SqlPackageCommandResult
+    {
+        /// <summary>
+        /// Gets or sets the generated command string
+        /// </summary>
+        public string Command { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether the operation was successful
+        /// </summary>
+        public bool Success { get; set; }
+
+        /// <summary>
+        /// Gets or sets the error message if the operation failed
+        /// </summary>
+        public string ErrorMessage { get; set; }
+    }
+}
diff --git a/src/Microsoft.SqlTools.ServiceLayer/SqlPackage/SqlPackageService.cs b/src/Microsoft.SqlTools.ServiceLayer/SqlPackage/SqlPackageService.cs
diff --git a/src/Microsoft.SqlTools.SqlCore/Localization/sr.cs b/src/Microsoft.SqlTools.SqlCore/Localization/sr.cs
diff --git a/test/Microsoft.SqlTools.ServiceLayer.UnitTests/Microsoft.SqlTools.ServiceLayer.UnitTests.csproj b/test/Microsoft.SqlTools.ServiceLayer.UnitTests/Microsoft.SqlTools.ServiceLayer.UnitTests.csproj
diff --git a/test/Microsoft.SqlTools.ServiceLayer.UnitTests/SqlPackage/SqlPackageServiceTests.cs b/test/Microsoft.SqlTools.ServiceLayer.UnitTests/SqlPackage/SqlPackageServiceTests.cs
