NUnit tree: add option to show/hide namespace nodes; add folding of n…

…amespace nodes
TestCentric · Oct 21, 2024 · 41704d6 · 41704d6
1 parent 183bfb4
commit 41704d6
Show file tree

Hide file tree

Showing 16 changed files with 389 additions and 6 deletions.
diff --git a/src/TestCentric/testcentric.gui/Presenters/DisplayStrategy.cs b/src/TestCentric/testcentric.gui/Presenters/DisplayStrategy.cs
@@ -176,14 +176,19 @@ public string GroupDisplayName(TestGroup group)
             return string.Format("{0} ({1})", group.Name, group.Count());
         }
 
+        protected virtual string GetTestNodeName(TestNode testNode)
+        {
+            return testNode.Name;
+        }
+
         private string GetTestNodeDisplayName(TestNode testNode)
         {
-            string treeNodeName = testNode.Name;
+            string treeNodeName = GetTestNodeName(testNode);
 
             // Check if test result is available for this node
             ResultNode result = _model.GetResultForTest(testNode.Id);
             if (_settings.Gui.TestTree.ShowTestDuration && result != null)
-                treeNodeName = testNode.Name + $" [{result.Duration:0.000}s]";
+                treeNodeName += $" [{result.Duration:0.000}s]";
 
             return treeNodeName;
         }

diff --git a/src/TestCentric/testcentric.gui/Presenters/NUnitTreeDisplayStrategy.cs b/src/TestCentric/testcentric.gui/Presenters/NUnitTreeDisplayStrategy.cs
@@ -8,7 +8,8 @@
 
 namespace TestCentric.Gui.Presenters
 {
-    using System.IO;
+    using System.Collections.Generic;
+    using System.Linq;
     using Model;
     using Views;
 
@@ -18,6 +19,8 @@ namespace TestCentric.Gui.Presenters
     /// </summary>
     public class NUnitTreeDisplayStrategy : DisplayStrategy
     {
+        private IDictionary<TestNode, string> _foldedNodeNames = new Dictionary<TestNode, string>();
+
         public NUnitTreeDisplayStrategy(ITestTreeView view, ITestModel model)
             : base(view, model) { }
 
@@ -32,17 +35,100 @@ public override string Description
         public override void OnTestLoaded(TestNode testNode, VisualState visualState)
         {
             ClearTree();
+            _foldedNodeNames.Clear();
 
             foreach (var topLevelNode in testNode.Children)
-                _view.Add(MakeTreeNode(topLevelNode, true));
+                _view.Add(CreateNUnitTreeNode(null, topLevelNode));
 
             if (visualState != null)
                 visualState.ApplyTo(_view.TreeView);
             else
                 SetDefaultInitialExpansion();
         }
 
-        protected override VisualState CreateVisualState() => new VisualState("NUNIT_TREE").LoadFrom(_view.TreeView);
+        protected override VisualState CreateVisualState() => new VisualState("NUNIT_TREE", _settings.Gui.TestTree.ShowNamespace).LoadFrom(_view.TreeView);
+
+        protected override string GetTestNodeName(TestNode testNode)
+        {
+            // For folded namespace nodes use the combined name of all folded nodes ("Library.Test.Folder")
+            if (_foldedNodeNames.TryGetValue(testNode, out var name)) 
+                return name;
+
+            return base.GetTestNodeName(testNode);
+        }
+
+        private TreeNode CreateNUnitTreeNode(TreeNode parentNode, TestNode testNode)
+        {
+            TreeNode treeNode = null;
+
+            if (ShowTreeNodeType(testNode))
+            {
+                if (IsNamespaceNode(testNode))
+                    testNode = GetFoldedNamespaceNode(testNode);
+
+                treeNode = MakeTreeNode(testNode, false);
+                parentNode?.Nodes.Add(treeNode);
+                parentNode = treeNode;
+            }
+
+            foreach (TestNode child in testNode.Children)
+            {
+                CreateNUnitTreeNode(parentNode, child);
+            }
+
+            return treeNode;
+        }
+
+        /// <summary>
+        /// Check if a tree node type should be shown or omitted
+        /// Currently we support only omitting the namespace nodes
+        /// </summary>
+        private bool ShowTreeNodeType(TestNode testNode)
+        {
+            if (IsNamespaceNode(testNode))
+                return _settings.Gui.TestTree.ShowNamespace;
+
+            return true;
+        }
+
+        private TestNode GetFoldedNamespaceNode(TestNode testNode)
+        {
+            // Get list of all namespace nodes which can be folded
+            IList<TestNode> foldedNodes = FoldNamespaceNodes(testNode);
+
+            // Get name of folded namespaces and store in dictionary for later usage
+            TestNode resultNode = foldedNodes.Last();
+            _foldedNodeNames[resultNode] = GetFoldedNamespaceName(foldedNodes);
+            return resultNode;
+        }
+
+        private string GetFoldedNamespaceName(IList<TestNode> foldedNamespaces)
+        {
+            var namespaceNames = foldedNamespaces.Select(x => x.Name);
+            return String.Join(".", namespaceNames);
+        }
+
+        private IList<TestNode> FoldNamespaceNodes(TestNode testNode)
+        {
+            if (!IsNamespaceNode(testNode))
+            {
+                return new List<TestNode>();
+            }
+
+            // If a namespace node only contains one child item which is also a namespace node, we can fold them.
+            List<TestNode> namespaceNodes = new List<TestNode>() { testNode };
+            if (testNode.Children.Count == 1 && IsNamespaceNode(testNode.Children[0]))
+            { 
+                namespaceNodes.AddRange(FoldNamespaceNodes(testNode.Children[0]));
+            }
+
+            return namespaceNodes;
+        }
+
+        private bool IsNamespaceNode(TestNode testNode)
+        {
+            return testNode.IsSuite && (testNode.Type == "TestSuite" || testNode.Type == "SetUpFixture");
+        }
 
         private void SetDefaultInitialExpansion()
         {

diff --git a/src/TestCentric/testcentric.gui/Presenters/TestCentricPresenter.cs b/src/TestCentric/testcentric.gui/Presenters/TestCentricPresenter.cs
@@ -265,6 +265,9 @@ void OnRunFinished(ResultNode result)
                     case "TestCentric.Gui.TestTree.FixtureList.GroupBy":
                         _view.GroupBy.SelectedItem = _settings.Gui.TestTree.FixtureList.GroupBy;
                         break;
+                    case "TestCentric.Gui.TestTree.ShowNamespace":
+                        _view.ShowNamespace.Checked = _settings.Gui.TestTree.ShowNamespace;
+                        break;
                 }
             };
 
@@ -489,6 +492,11 @@ void OnRunFinished(ResultNode result)
                 _settings.Gui.TestTree.DisplayFormat = _view.DisplayFormat.SelectedItem;
             };
 
+            _view.ShowNamespace.CheckedChanged += () =>
+            {
+                _settings.Gui.TestTree.ShowNamespace = _view.ShowNamespace.Checked;
+            };
+
             _view.GroupBy.SelectionChanged += () =>
             {
                 switch(_view.DisplayFormat.SelectedItem)
@@ -945,6 +953,9 @@ private void UpdateTreeDisplayMenuItem()
                     _view.GroupBy.SelectedItem = _settings.Gui.TestTree.FixtureList.GroupBy;
                     break;
             }
+
+            _view.ShowNamespace.Checked = _settings.Gui.TestTree.ShowNamespace;
+            _view.ShowNamespace.Enabled = displayFormat == "NUNIT_TREE";
         }
 
         private void RunAllTests()

diff --git a/src/TestCentric/testcentric.gui/Presenters/TreeViewPresenter.cs b/src/TestCentric/testcentric.gui/Presenters/TreeViewPresenter.cs
@@ -128,6 +128,7 @@ private void WireUpEvents()
                         }
                     case "TestCentric.Gui.TestTree.TestList.GroupBy":
                     case "TestCentric.Gui.TestTree.FixtureList.GroupBy":
+                    case "TestCentric.Gui.TestTree.ShowNamespace":
                         Strategy?.Reload();
                         break;
                     case "TestCentric.Gui.TestTree.ShowCheckBoxes":
@@ -283,6 +284,8 @@ private void UpdateTreeSettingsFromVisualState(VisualState visualState)
             {
                 _treeSettings.FixtureList.GroupBy = visualState.GroupBy;
             }
+
+            _treeSettings.ShowNamespace = visualState.ShowNamespace;
         }
 
         private void EnsureNonRunnableFilesAreVisible(TestNode testNode)

diff --git a/src/TestCentric/testcentric.gui/Views/IMainView.cs b/src/TestCentric/testcentric.gui/Views/IMainView.cs
@@ -76,6 +76,7 @@ public interface IMainView
         IViewElement DisplayFormatButton { get; }
         ISelection DisplayFormat { get; }
         ISelection GroupBy { get; }
+        IChecked ShowNamespace { get; }
         ICommand RunParametersButton { get; }
 
         IChecked RunSummaryButton { get; }

diff --git a/src/TestCentric/testcentric.gui/Views/TestCentricMainView.cs b/src/TestCentric/testcentric.gui/Views/TestCentricMainView.cs
@@ -87,6 +87,7 @@ public class TestCentricMainView : TestCentricFormBase, IMainView
         private ToolStripMenuItem nunitTreeMenuItem;
         private ToolStripMenuItem fixtureListMenuItem;
         private ToolStripMenuItem testListMenuItem;
+        private ToolStripMenuItem nunitTreeShowNamespaceMenuItem;
         private ToolStripSeparator toolStripSeparator13;
         private ToolStripMenuItem byAssemblyMenuItem;
         private ToolStripMenuItem byFixtureMenuItem;
@@ -175,6 +176,7 @@ public TestCentricMainView() : base("TestCentric")
             GroupBy = new CheckedToolStripMenuGroup(
                 "testGrouping",
                 byAssemblyMenuItem, byFixtureMenuItem, byCategoryMenuItem, byOutcomeMenuItem, byDurationMenuItem);
+            ShowNamespace = new CheckedMenuElement(nunitTreeShowNamespaceMenuItem);
             RunParametersButton = new ToolStripButtonElement(runParametersButton);
             RunSummaryButton = new CheckBoxElement(runSummaryButton);
 
@@ -217,6 +219,7 @@ private void InitializeComponent()
             this.nunitTreeMenuItem = new System.Windows.Forms.ToolStripMenuItem();
             this.fixtureListMenuItem = new System.Windows.Forms.ToolStripMenuItem();
             this.testListMenuItem = new System.Windows.Forms.ToolStripMenuItem();
+            this.nunitTreeShowNamespaceMenuItem = new System.Windows.Forms.ToolStripMenuItem();
             this.toolStripSeparator13 = new System.Windows.Forms.ToolStripSeparator();
             this.byAssemblyMenuItem = new System.Windows.Forms.ToolStripMenuItem();
             this.byFixtureMenuItem = new System.Windows.Forms.ToolStripMenuItem();
@@ -405,13 +408,24 @@ private void InitializeComponent()
             this.displayFormatButton.Size = new System.Drawing.Size(29, 21);
             this.displayFormatButton.Text = "Display";
             this.displayFormatButton.ToolTipText = "Tree Display Format";
+
+            // 
+            // nunitTreeShowNamespaceMenuItem
+            // 
+            this.nunitTreeShowNamespaceMenuItem.Name = "NUNIT_TREE_SHOW_NAMESPACE";
+            this.nunitTreeShowNamespaceMenuItem.Size = new System.Drawing.Size(198, 22);
+            this.nunitTreeShowNamespaceMenuItem.Tag = "NUNIT_TREE_SHOW_NAMESPACE";
+            this.nunitTreeShowNamespaceMenuItem.Text = "Namespace";
+
             // 
             // nunitTreeMenuItem
             // 
             this.nunitTreeMenuItem.Name = "nunitTreeMenuItem";
             this.nunitTreeMenuItem.Size = new System.Drawing.Size(198, 22);
             this.nunitTreeMenuItem.Tag = "NUNIT_TREE";
             this.nunitTreeMenuItem.Text = "NUnit Tree";
+            nunitTreeMenuItem.DropDownItems.AddRange(new System.Windows.Forms.ToolStripItem[] { nunitTreeShowNamespaceMenuItem });
+
             // 
             // fixtureListMenuItem
             // 
@@ -1124,6 +1138,7 @@ public int SplitterPosition
         public IViewElement DisplayFormatButton { get; private set; }
         public ISelection DisplayFormat { get; private set; }
         public ISelection GroupBy { get; private set; }
+        public IChecked ShowNamespace { get; private set; }
         public ICommand RunParametersButton { get; private set; }
 
         public IChecked RunSummaryButton { get; private set; }

diff --git a/src/TestCentric/testcentric.gui/VisualState.cs b/src/TestCentric/testcentric.gui/VisualState.cs
@@ -30,6 +30,12 @@ public VisualState(string strategyID)
             DisplayStrategy = strategyID;
         }
 
+        public VisualState(string strategyID, bool showNamespace)
+        {
+            DisplayStrategy = strategyID;
+            ShowNamespace = showNamespace;
+        }
+
         public VisualState(string strategyID, string groupID)
         {
             if (strategyID == "NUNIT_TREE")
@@ -53,6 +59,8 @@ public VisualState(string strategyID, string groupID)
         //[XmlAttribute, DefaultValue(false)]
         public bool ShowCheckBoxes;
 
+        public bool ShowNamespace;
+
         // TODO: Categories not yet supported
         //public List<string> SelectedCategories;
         //public bool ExcludeCategories;
@@ -250,6 +258,7 @@ public void ReadXml(XmlReader reader)
             // GroupBy is null for NUnitTree strategy, otherwise required
             if (GroupBy == null && strategy != "NUNIT_TREE") GroupBy = "ASSEMBLY";
             ShowCheckBoxes = reader.GetAttribute("ShowCheckBoxes") == "True";
+            ShowNamespace = reader.GetAttribute("ShowNamespace") == "True";
 
             while (reader.Read())
             {
@@ -364,7 +373,9 @@ public void WriteXml(XmlWriter writer)
                 writer.WriteAttributeString("GroupBy", GroupBy);
             if (ShowCheckBoxes)
                 writer.WriteAttributeString("ShowCheckBoxes", "True");
-
+            if (ShowNamespace)
+                writer.WriteAttributeString("ShowNamespace", "True");
+
             WriteVisualTreeNodes(Nodes);
 
             void WriteVisualTreeNodes(List<VisualTreeNode> nodes)

diff --git a/src/TestCentric/tests/Presenters/Main/CommandTests.cs b/src/TestCentric/tests/Presenters/Main/CommandTests.cs
@@ -349,5 +349,19 @@ public void SelectedTestsChanged_TestSelected_CommandIsEnabled()
             // Assert
             Assert.That(_view.RunSelectedButton.Enabled, Is.True);
         }
+
+        [TestCase(true)]
+        [TestCase(false)]
+        public void ShowNamespaceChanged_ChangesModelSetting(bool isChecked)
+        {
+            // Arrange
+            _view.ShowNamespace.Checked.Returns(isChecked);
+
+            // Act
+            _view.ShowNamespace.CheckedChanged += Raise.Event<CommandHandler>();
+
+            // Assert
+            Assert.That(_model.Settings.Gui.TestTree.ShowNamespace, Is.EqualTo(isChecked));
+        }
     }
 }
diff --git a/src/TestCentric/tests/Presenters/Main/WhenSettingsChanged.cs b/src/TestCentric/tests/Presenters/Main/WhenSettingsChanged.cs
@@ -44,5 +44,16 @@ public void TestListGroupBy_SettingChanged_MenuItemIsUpdated(string groupBy)
             // 2. Assert
             _view.GroupBy.SelectedItem = groupBy;
         }
+
+        [TestCase(true)]
+        [TestCase(false)]
+        public void ShowNamespace_SettingChanged_MenuItemIsUpdated(bool showNamespace)
+        {
+            // 1. Act
+            _settings.Gui.TestTree.ShowNamespace = showNamespace;
+
+            // 2. Assert
+            _view.ShowNamespace.Checked = showNamespace;
+        }
     }
 }