Dropped Ledger Tables Folder (#1625)

* support and testing for Dropped Ledger Table folder

* appending DroppedLedgerTables nodetype

* fixing unit tests

* undoing string.Empty

src/Microsoft.SqlTools.ServiceLayer/Localization/sr.cs

@@ -1,5 +1,5 @@
 // WARNING:
-// This file was generated by the Microsoft DataWarehouse String Resource Tool 5.0.0.0
+// This file was generated by the Microsoft DataWarehouse String Resource Tool 4.0.0.0
 // from information in sr.strings
 // DO NOT MODIFY THIS FILE'S CONTENTS, THEY WILL BE OVERWRITTEN
 //
@@ -2045,6 +2045,14 @@ namespace Microsoft.SqlTools.ServiceLayer
             }
         }
 
+        public static string SchemaHierarchy_DroppedLedgerTables
+        {
+            get
+            {
+                return Keys.GetString(Keys.SchemaHierarchy_DroppedLedgerTables);
+            }
+        }
+
         public static string SchemaHierarchy_AlwaysEncryptedKeys
         {
             get
@@ -10645,6 +10653,9 @@ namespace Microsoft.SqlTools.ServiceLayer
             public const string SchemaHierarchy_ExternalTables = "SchemaHierarchy_ExternalTables";
 
 
+            public const string SchemaHierarchy_DroppedLedgerTables = "SchemaHierarchy_DroppedLedgerTables";
+
+
             public const string SchemaHierarchy_AlwaysEncryptedKeys = "SchemaHierarchy_AlwaysEncryptedKeys";
 
 

src/Microsoft.SqlTools.ServiceLayer/Localization/sr.resx

@@ -1280,6 +1280,10 @@
     <value>External Tables</value>
     <comment></comment>
   </data>
+  <data name="SchemaHierarchy_DroppedLedgerTables" xml:space="preserve">
+    <value>Dropped Ledger Tables</value>
+    <comment></comment>
+  </data>
   <data name="SchemaHierarchy_AlwaysEncryptedKeys" xml:space="preserve">
     <value>Always Encrypted Keys</value>
     <comment></comment>

src/Microsoft.SqlTools.ServiceLayer/Localization/sr.strings

@@ -630,6 +630,8 @@ SchemaHierarchy_ExternalResources = External Resources
 
 SchemaHierarchy_ExternalTables = External Tables
 
+SchemaHierarchy_DroppedLedgerTables = Dropped Ledger Tables
+
 SchemaHierarchy_AlwaysEncryptedKeys = Always Encrypted Keys
 
 SchemaHierarchy_ColumnMasterKeys = Column Master Keys

src/Microsoft.SqlTools.ServiceLayer/Localization/sr.xlf

@@ -6321,6 +6321,11 @@ The Query Processor estimates that implementing the following index could improv
         <target state="new">Ledger</target>
         <note></note>
       </trans-unit>
+      <trans-unit id="SchemaHierarchy_DroppedLedgerTables">
+        <source>Dropped Ledger Tables</source>
+        <target state="new">Dropped Ledger Tables</target>
+        <note></note>
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/Nodes/NodeTypes.cs

@@ -139,6 +139,7 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectExplorer.Nodes
         ExternalTable,
         AlwaysEncryptedKeys,
         ColumnMasterKeys,
-        ColumnEncryptionKeys
+        ColumnEncryptionKeys,
+        DroppedLedgerTables,
     }
 }

src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/SmoModel/SmoTreeNodes.cs

@@ -797,6 +797,13 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectExplorer.SmoModel
                         { LedgerTableType.UpdatableLedgerTable }
                     }
                 });
+                filters.Add(new NodePropertyFilter
+                {
+                    Property = "IsDroppedLedgerTable",
+                    Type = typeof(bool),
+                    ValidFor = ValidForFlag.Sql2022|ValidForFlag.AzureV12,
+                    Values = new List<object> { 0 },
+                });
                 return filters;
             }
         }
@@ -845,6 +852,14 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectExplorer.SmoModel
                 IsMsShippedOwned = true,
                 SortPriority = SmoTreeNode.NextSortPriority,
             });
+            currentChildren.Add(new FolderNode {
+                NodeValue = SR.SchemaHierarchy_DroppedLedgerTables,
+                NodeType = "Folder",
+                NodeTypeId = NodeTypes.DroppedLedgerTables,
+                IsSystemObject = false,
+                ValidFor = ValidForFlag.Sql2022|ValidForFlag.AzureV12,
+                SortPriority = SmoTreeNode.NextSortPriority,
+            });
         }
 
         internal override Type[] ChildQuerierTypes
@@ -1318,6 +1333,57 @@ namespace Microsoft.SqlTools.ServiceLayer.ObjectExplorer.SmoModel
         }
     }
 
+    [Export(typeof(ChildFactory))]
+    [Shared]
+    internal partial class DroppedLedgerTablesChildFactory : SmoChildFactoryBase
+    {
+        public override IEnumerable<string> ApplicableParents() { return new[] { "DroppedLedgerTables" }; }
+
+        public override IEnumerable<INodeFilter> Filters
+        {
+            get
+            {
+                var filters = new List<INodeFilter>();
+                filters.Add(new NodePropertyFilter
+                {
+                    Property = "IsDroppedLedgerTable",
+                    Type = typeof(bool),
+                    Values = new List<object> { 1 },
+                });
+                return filters;
+            }
+        }
+
+        public override IEnumerable<NodeSmoProperty> SmoProperties
+        {
+            get
+            {
+                var properties = new List<NodeSmoProperty>();
+                properties.Add(new NodeSmoProperty
+                {
+                   Name = "IsDroppedLedgerTable",
+                   ValidFor = ValidForFlag.Sql2022|ValidForFlag.AzureV12
+                });
+                return properties;
+            }
+        }
+
+        internal override Type[] ChildQuerierTypes
+        {
+            get
+            {
+                return new [] { typeof(SqlTableQuerier), };
+            }
+        }
+
+        public override TreeNode CreateChild(TreeNode parent, object context)
+        {
+            var child = new TableTreeNode();
+            InitializeChild(parent, child, context);
+            return child;
+        }
+    }
+
     [Export(typeof(ChildFactory))]
     [Shared]
     internal partial class TableChildFactory : SmoChildFactoryBase

src/Microsoft.SqlTools.ServiceLayer/ObjectExplorer/SmoModel/SmoTreeNodesDefinition.xml

@@ -82,6 +82,7 @@
         <Value>LedgerTableType.AppendOnlyLedgerTable</Value>
         <Value>LedgerTableType.UpdatableLedgerTable</Value>
       </Filter>
+      <Filter Property="IsDroppedLedgerTable" Value="0" Type="bool" ValidFor="Sql2022|AzureV12" />
     </Filters>
     <Properties>
       <Property Name="IsFileTable" ValidFor="Sql2012|Sql2014|Sql2016|Sql2017|Sql2019|Sql2022"/>
@@ -92,6 +93,7 @@
     </Properties>
     <Child Name="SystemTables" IsSystemObject="1"/>
     <Child Name="ExternalTables"/>
+    <Child Name="DroppedLedgerTables" IsDroppedLedgerTable="1"/>
   </Node>
 
   <Node Name="Views" LocLabel="SR.SchemaHierarchy_Views" BaseClass="ModelBased"  Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlView" TreeNode="ViewTreeNode">
@@ -161,6 +163,14 @@
       <Filter Property="IsSystemObject" Value="1" Type="bool" />
     </Filters>
   </Node>
+  <Node Name="DroppedLedgerTables" LocLabel="SR.SchemaHierarchy_DroppedLedgerTables" BaseClass="ModelBased" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlTable" TreeNode="TableTreeNode" ValidFor="Sql2022|AzureV12">
+    <Filters >
+      <Filter Property="IsDroppedLedgerTable" Value="1" Type="bool" />
+    </Filters>
+    <Properties>
+      <Property Name="IsDroppedLedgerTable" ValidFor="Sql2022|AzureV12"/>
+    </Properties>
+  </Node>
   <!--
   <Node Name="FileTables" LocLabel="SR.SchemaHierarchy_FileTables" BaseClass="ModelBased" Strategy="MultipleElementsOfType" ChildQuerierTypes="SqlTable" TreeNode="TableTreeNode" ValidFor="Sql2012|Sql2014|Sql2016|Sql2017|Sql2019|Sql2022">
     <Filters >

test/Microsoft.SqlTools.ServiceLayer.IntegrationTests/ObjectExplorer/ObjectExplorerServiceTests.cs

@@ -10,6 +10,7 @@ using System.IO;
 using System.Linq;
 using System.Reflection;
 using System.Text;
+using System.Text.RegularExpressions;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.SqlTools.ServiceLayer.Connection.Contracts;
@@ -242,8 +243,8 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.ObjectExplorer
         //This takes take long to run so not a good test for CI builds
         public async Task VerifySystemObjects()
         {
-            string queryFileName = null;
+            string queryFileName = string.Empty;
-            string baselineFileName = null;
+            string baselineFileName = string.Empty;
             string databaseName = "#testDb#";
             await TestServiceProvider.CalculateRunTime(() => VerifyObjectExplorerTest(databaseName, queryFileName, "SystemOBjects", baselineFileName, true), true);
         }
@@ -473,9 +474,13 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.ObjectExplorer
                 {
                     string actual = stringBuilder.ToString();
 
-                    // write output to a bin directory for easier comparison
+                    // Dropped ledger objects have a randomly generated GUID appended to their name when they are deleted
-                    string outputRegeneratedFolder = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location),
+                    // For testing purposes, those guids need to be replaced with a deterministic string
-                        @"ObjectExplorerServiceTests\Baselines\Regenerated");
+                    actual = Regex.Replace(actual, "[A-Z0-9]{32}", "<<NonDeterministic>>");
+
+                    // Write output to a bin directory for easier comparison
+                    string assemblyPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location) ?? string.Empty;
+                    string outputRegeneratedFolder = Path.Combine(assemblyPath, @"ObjectExplorerServiceTests\Baselines\Regenerated");
                     string outputRegeneratedFilePath = Path.Combine(outputRegeneratedFolder, baselineFileName);
                     string msg = "";
 
@@ -488,8 +493,8 @@ namespace Microsoft.SqlTools.ServiceLayer.IntegrationTests.ObjectExplorer
                     }
                     catch (Exception e)
                     {
-                        //We don't want to fail the test completely if we failed to write the regenerated baseline
+                        // We don't want to fail the test completely if we failed to write the regenerated baseline
-                        //(especially if the test passed).
+                        // (especially if the test passed).
                         msg = $"Errors also occurred while attempting to write the new baseline file {outputRegeneratedFilePath} : {e.Message}";
                     }
 

test/Microsoft.SqlTools.ServiceLayer.Test.Common/TestData/ObjectExplorer/Baselines/AllSqlObjects.txt

@@ -1,3 +1,21 @@
+NodeType: Table Label: HumanResources.MSSQL_DroppedLedgerTable_Ledger_For_Drop_<<NonDeterministic>> SubType: Status:
+NodeType: Column Label: BusinessEntityID (int, not null) SubType: Status:
+NodeType: Column Label: NationalIDNumber (nvarchar(15), not null) SubType: Status:
+NodeType: Column Label: LoginID (nvarchar(256), not null) SubType: Status:
+NodeType: Column Label: OrganizationNode (hierarchyid, null) SubType: Status:
+NodeType: Column Label: ledger_start_transaction_id (bigint, not null) SubType: Status:
+NodeType: Column Label: ledger_end_transaction_id (bigint, null) SubType: Status:
+NodeType: Column Label: ledger_start_sequence_number (bigint, not null) SubType: Status:
+NodeType: Column Label: ledger_end_sequence_number (bigint, null) SubType: Status:
+NodeType: HistoryTable Label: HumanResources.MSSQL_DroppedLedgerHistory_Ledger_For_Drop_History_<<NonDeterministic>> (History) SubType:LedgerHistory Status:
+NodeType: Column Label: BusinessEntityID (int, not null) SubType: Status:
+NodeType: Column Label: NationalIDNumber (nvarchar(15), not null) SubType: Status:
+NodeType: Column Label: LoginID (nvarchar(256), not null) SubType: Status:
+NodeType: Column Label: OrganizationNode (hierarchyid, null) SubType: Status:
+NodeType: Column Label: ledger_start_transaction_id (bigint, not null) SubType: Status:
+NodeType: Column Label: ledger_end_transaction_id (bigint, null) SubType: Status:
+NodeType: Column Label: ledger_start_sequence_number (bigint, not null) SubType: Status:
+NodeType: Column Label: ledger_end_sequence_number (bigint, null) SubType: Status:
 NodeType: Table Label: dbo.tableWithAllDataTypes SubType: Status:
 NodeType: Column Label: cDecimal (decimal(18,5), null) SubType: Status:
 NodeType: Column Label: cNumeric (numeric(18,2), null) SubType: Status:
@@ -198,6 +216,15 @@ NodeType: Column Label: ledger_transaction_id (bigint, null) SubType: Status:
 NodeType: Column Label: ledger_sequence_number (bigint, null) SubType: Status:
 NodeType: Column Label: ledger_operation_type (int, not null) SubType: Status:
 NodeType: Column Label: ledger_operation_type_desc (nvarchar(6), not null) SubType: Status:
+NodeType: View Label: HumanResources.MSSQL_DroppedLedgerView_Ledger_For_Drop_Ledger_<<NonDeterministic>> (Ledger) SubType:Ledger Status:
+NodeType: Column Label: BusinessEntityID (int, not null) SubType: Status:
+NodeType: Column Label: NationalIDNumber (nvarchar(15), not null) SubType: Status:
+NodeType: Column Label: LoginID (nvarchar(256), not null) SubType: Status:
+NodeType: Column Label: OrganizationNode (hierarchyid, null) SubType: Status:
+NodeType: Column Label: ledger_transaction_id (bigint, null) SubType: Status:
+NodeType: Column Label: ledger_sequence_number (bigint, null) SubType: Status:
+NodeType: Column Label: ledger_operation_type (int, not null) SubType: Status:
+NodeType: Column Label: ledger_operation_type_desc (nvarchar(6), not null) SubType: Status:
 NodeType: View Label: HumanResources.vEmployee SubType: Status:
 NodeType: Column Label: BusinessEntityID (int, not null) SubType: Status:
 NodeType: Column Label: Title (nvarchar(8), null) SubType: Status:

test/Microsoft.SqlTools.ServiceLayer.Test.Common/TestData/ObjectExplorer/TestScripts/AllSqlObjects.sql

@@ -219,6 +219,29 @@
 
 GO
 
+/****** Object:  Table [HumanResources].[Ledger_For_Drop]    Script Date: 7/19/2022 01:28:00 PM ******/
+SET ANSI_NULLS ON
+GO
+
+SET QUOTED_IDENTIFIER ON
+GO
+
+CREATE TABLE [HumanResources].[Ledger_For_Drop](
+	[BusinessEntityID] [int] NOT NULL,
+	[NationalIDNumber] [nvarchar](15) NOT NULL,
+	[LoginID] [nvarchar](256) NOT NULL,
+	[OrganizationNode] [hierarchyid] NULL
+)WITH (
+	LEDGER = ON,
+	SYSTEM_VERSIONING = ON ( HISTORY_TABLE = [HumanResources].[Ledger_For_Drop_History] )
+)
+
+GO
+
+DROP TABLE [HumanResources].[Ledger_For_Drop]
+
+GO
+
 /****** Object:  Table [HumanResources].[Employee]    Script Date: 4/27/2017 11:50:15 AM ******/
 SET ANSI_NULLS ON
 GO

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ObjectExplorer/NodePathGeneratorTests.cs

@@ -48,7 +48,9 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.ObjectExplorer
                 "testServer/Databases/testDatabase/Tables/testSchema.testTable",
                 "testServer/Databases/System Databases/testDatabase/Tables/testSchema.testTable",
                 "testServer/Databases/testDatabase/Tables/System Tables/testSchema.testTable",
-                "testServer/Databases/System Databases/testDatabase/Tables/System Tables/testSchema.testTable"
+                "testServer/Databases/System Databases/testDatabase/Tables/System Tables/testSchema.testTable",
+                "testServer/Databases/testDatabase/Tables/Dropped Ledger Tables/testSchema.testTable",
+                "testServer/Databases/System Databases/testDatabase/Tables/Dropped Ledger Tables/testSchema.testTable"
             };
 
             Assert.AreEqual(expectedPaths.Count, paths.Count);
@@ -61,11 +63,12 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.ObjectExplorer
         [Test]
         public void FindCorrectPathsForTableWithDatabaseRoot()
         {
-            var paths = NodePathGenerator.FindNodePaths(databaseSession, "Table", "testSchema", "testTable", null);
+            var paths = NodePathGenerator.FindNodePaths(databaseSession, "Table", "testSchema", "testTable", string.Empty);
             var expectedPaths = new List<string>
             {
                 "testServer/testDatabase/Tables/testSchema.testTable",
-                "testServer/testDatabase/Tables/System Tables/testSchema.testTable"
+                "testServer/testDatabase/Tables/System Tables/testSchema.testTable",
+                "testServer/testDatabase/Tables/Dropped Ledger Tables/testSchema.testTable"
             };
 
             Assert.AreEqual(expectedPaths.Count, paths.Count);
@@ -85,6 +88,8 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.ObjectExplorer
                 "testServer/Databases/System Databases/testDatabase/Tables/testSchema.testTable/Columns/testColumn",
                 "testServer/Databases/testDatabase/Tables/System Tables/testSchema.testTable/Columns/testColumn",
                 "testServer/Databases/System Databases/testDatabase/Tables/System Tables/testSchema.testTable/Columns/testColumn",
+                "testServer/Databases/testDatabase/Tables/Dropped Ledger Tables/testSchema.testTable/Columns/testColumn",
+                "testServer/Databases/System Databases/testDatabase/Tables/Dropped Ledger Tables/testSchema.testTable/Columns/testColumn",
                 "testServer/Databases/testDatabase/Views/testSchema.testTable/Columns/testColumn",
                 "testServer/Databases/System Databases/testDatabase/Views/testSchema.testTable/Columns/testColumn",
                 "testServer/Databases/testDatabase/Views/System Views/testSchema.testTable/Columns/testColumn",
@@ -106,6 +111,7 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.ObjectExplorer
             {
                 "testServer/testDatabase/Tables/testSchema.testTable/Columns/testColumn",
                 "testServer/testDatabase/Tables/System Tables/testSchema.testTable/Columns/testColumn",
+                "testServer/testDatabase/Tables/Dropped Ledger Tables/testSchema.testTable/Columns/testColumn",
                 "testServer/testDatabase/Views/testSchema.testTable/Columns/testColumn",
                 "testServer/testDatabase/Views/System Views/testSchema.testTable/Columns/testColumn"
             };
@@ -120,7 +126,7 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.ObjectExplorer
         [Test]
         public void FindCorrectPathsForDatabase()
         {
-            var paths = NodePathGenerator.FindNodePaths(serverSession, "Database", null, databaseName, null);
+            var paths = NodePathGenerator.FindNodePaths(serverSession, "Database", null, databaseName, string.Empty);
             var expectedPaths = new List<string>
             {
                 "testServer/Databases/testDatabase",