Adding schema based object folders in OE (#1849)

* Making node types automated

* Adding schema based OE

* added folder types in NodeTypes

* Fixing stuff

* Moving schema to parent and cleaning up some code

* Replacing strings with nameof

* Sorting nodetypes generated by tt

* Adding option to put folders after nodes

* Fixing folder and children order

* Fixing tests

* Formatting file

* Formatting tt files

* Fixing tt

* fixing types

* Update src/Microsoft.SqlTools.ServiceLayer/SqlContext/ObjectExplorerSettings.cs

Co-authored-by: Charles Gagnon <chgagnon@microsoft.com>

* Fixing stuff

* Updating schema definitions and adding more logs

* Fixing copyright

* Adding Integration and Unit Tests

* Fixing test

---------

Co-authored-by: Charles Gagnon <chgagnon@microsoft.com>

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

@@ -0,0 +1,66 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+using System;
+using System.Linq;
+using Microsoft.SqlServer.Management.Smo;
+using Microsoft.SqlTools.ServiceLayer.ObjectExplorer;
+using Microsoft.SqlTools.ServiceLayer.ObjectExplorer.Nodes;
+using Microsoft.SqlTools.ServiceLayer.ObjectExplorer.SmoModel;
+using Microsoft.SqlTools.ServiceLayer.SqlContext;
+using Microsoft.SqlTools.ServiceLayer.Workspace;
+using Moq;
+using NUnit.Framework;
+
+namespace Microsoft.SqlTools.ServiceLayer.UnitTests.ObjectExplorer
+{
+    class GroupBySchemaTests
+    {
+        Mock<DatabaseChildFactory> factory;
+        Mock<TreeNode> node;
+
+        [SetUp]
+        public void init()
+        {
+            factory = new Mock<DatabaseChildFactory>();
+            factory.SetupGet(c => c.ChildQuerierTypes).Returns(null as Type[]);
+            factory.Setup(c => c.CreateChild(It.IsAny<TreeNode>(), It.IsAny<SqlSmoObject>())).Returns((TreeNode node, Schema obj) => {
+                return new TreeNode(){
+                    Label = obj.Name,
+                    NodeType = nameof(NodeTypes.Schemas)
+                };
+            });
+            factory.CallBase = true;
+            Mock<SmoQueryContext> context = new Mock<SmoQueryContext>(new Server(), null);
+            context.CallBase = true;
+            context.Object.ValidFor = ValidForFlag.None;
+            
+            node = new Mock<TreeNode>();
+            node.Setup(n => n.GetContext()).Returns(context.Object);
+        }
+
+        [Test]
+        public void SchemaBasedFoldersExcludedWhenGroupBySchemaIsEnabled()
+        {
+            WorkspaceService<SqlToolsSettings>.Instance.CurrentSettings.SqlTools.ObjectExplorer = new ObjectExplorerSettings() { GroupBySchema = true };
+            var children = factory.Object.Expand(node.Object, true, "TestDB", true, new System.Threading.CancellationToken());
+            Assert.False(children.Any(c => c.Label == "Tables"), "Tables subfolder in database should be excluded when group by schema is enabled");
+            Assert.False(children.Any(c => c.Label == "Views"), "Views subfolder in database should be excluded when group by schema is enabled");
+            Assert.False(children.Any(c => c.Label == "Synonyms"), "Synonyms subfolder in database should be excluded when group by schema is enabled");
+        }
+
+        [Test]
+        public void SchemaBasedFoldersIncludedWhenGroupBySchemaIsDisabled()
+        {
+            WorkspaceService<SqlToolsSettings>.Instance.CurrentSettings.SqlTools.ObjectExplorer = new ObjectExplorerSettings() { GroupBySchema = false };
+            var children = factory.Object.Expand(node.Object, true, "TestDB", true, new System.Threading.CancellationToken());
+            Assert.True(children.Any(c => c.Label == "Tables"), "Tables subfolder in database should be included when group by schema is disabled");
+            Assert.True(children.Any(c => c.Label == "Views"), "Views subfolder in database should be included when group by schema is disabled");
+            Assert.True(children.Any(c => c.Label == "Synonyms"), "Synonyms subfolder in database should be included when group by schema is disabled");
+        }
+
+        
+    }
+
+}

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

@@ -193,5 +193,30 @@ namespace Microsoft.SqlTools.ServiceLayer.UnitTests.ObjectExplorer
             string expectedTableQuerierFilters = "[(@IsSystemObject = 1) and ((@IsSystemObject = 1))]";
             Assert.That(invalidQuerierType, Is.EqualTo(expectedTableQuerierFilters), "GetPropertyFilter did not construct the URN filter string as expected when excluding filters that don't match the querier type.");
         }
+        [Test]
+        public void TestAddPropertyFiltersToExistingURNs()
+        {
+            var Node = new List<NodePropertyFilter> {
+                    TemporalFilter,
+                    LedgerHistoryFilter
+                };
+            
+            var nodeList = new List<INodeFilter> {
+                new NodePropertyFilter(){
+                    Property = "Schema",
+                    Values = new List<object> {"jsdafl983!@$#%535343]]]][[["},
+                    Type = typeof(string),
+                    ValidFor = ValidForFlag.Sql2022OrHigher
+                }
+            };
+
+            string allFiltersValid = INodeFilter.GetPropertyFilter(Node, typeof(SqlHistoryTableQuerier), ValidForFlag.Sql2022OrHigher);
+            string expectedAllFilters = "[(@TemporalType = 1) and (@LedgerType = 1)]";
+            Assert.That(allFiltersValid, Is.EqualTo(expectedAllFilters), "GetPropertyFilter did not construct the URN filter string as expected");
+
+            string newUrn = INodeFilter.AddPropertyFilterToFilterString(allFiltersValid, nodeList, typeof(SqlHistoryTableQuerier), ValidForFlag.Sql2022OrHigher);
+            string expectedNewUrn = "[(@TemporalType = 1) and (@LedgerType = 1) and (@Schema = 'jsdafl983!@$#%535343]]]][[[')]";
+            Assert.That(newUrn, Is.EqualTo(expectedNewUrn), "GetPropertyFilter did not construct the URN filter string as expected");
+        }
     }
 }