Added unit tests

Author: JamesVaughan

tests/XTMF2.UnitTests/Editing/TestCommentBlock.cs

@@ -222,5 +222,127 @@ public void TestChangingCommentBlockPosition()
                 Assert.AreEqual(newLocation, block.Location);
             });
         }
+
+        [TestMethod]
+        public void TestCommentBlockHeaderDefaultsToEmpty()
+        {
+            TestHelper.RunInModelSystemContext("TestCommentBlockHeaderDefaultsToEmpty", (user, pSession, msSession) =>
+            {
+                CommandError error = null;
+                var ms = msSession.ModelSystem;
+                Assert.IsTrue(msSession.AddCommentBlock(user, ms.GlobalBoundary, "My Comment", new Rectangle(100, 100),
+                    out CommentBlock block, out error), error?.Message);
+                Assert.AreEqual(string.Empty, block.Header, "New comment block header should default to empty string.");
+            });
+        }
+
+        [TestMethod]
+        public void TestSettingCommentBlockHeader()
+        {
+            TestHelper.RunInModelSystemContext("TestSettingCommentBlockHeader", (user, pSession, msSession) =>
+            {
+                CommandError error = null;
+                var ms = msSession.ModelSystem;
+                Assert.IsTrue(msSession.AddCommentBlock(user, ms.GlobalBoundary, "My Comment", new Rectangle(100, 100),
+                    out CommentBlock block, out error), error?.Message);
+                const string header = "My Header";
+                Assert.IsTrue(msSession.SetCommentBlockHeader(user, block, header, out error), error?.Message);
+                Assert.AreEqual(header, block.Header, "The comment block header was not set.");
+            });
+        }
+
+        [TestMethod]
+        public void TestSettingCommentBlockHeaderWithBadUser()
+        {
+            TestHelper.RunInModelSystemContext("TestSettingCommentBlockHeaderWithBadUser", (user, unauthorizedUser, pSession, msSession) =>
+            {
+                CommandError error = null;
+                var ms = msSession.ModelSystem;
+                Assert.IsTrue(msSession.AddCommentBlock(user, ms.GlobalBoundary, "My Comment", new Rectangle(100, 100),
+                    out CommentBlock block, out error), error?.Message);
+                Assert.IsFalse(msSession.SetCommentBlockHeader(unauthorizedUser, block, "Should Fail", out error));
+                Assert.AreEqual(string.Empty, block.Header, "Header should remain empty after unauthorized set.");
+            });
+        }
+
+        [TestMethod]
+        public void TestSettingCommentBlockHeaderUndoRedo()
+        {
+            TestHelper.RunInModelSystemContext("TestSettingCommentBlockHeaderUndoRedo", (user, pSession, msSession) =>
+            {
+                CommandError error = null;
+                var ms = msSession.ModelSystem;
+                Assert.IsTrue(msSession.AddCommentBlock(user, ms.GlobalBoundary, "My Comment", new Rectangle(100, 100),
+                    out CommentBlock block, out error), error?.Message);
+                const string header = "Important Header";
+                Assert.IsTrue(msSession.SetCommentBlockHeader(user, block, header, out error), error?.Message);
+                Assert.AreEqual(header, block.Header);
+                Assert.IsTrue(msSession.Undo(user, out error), error?.Message);
+                Assert.AreEqual(string.Empty, block.Header, "Header should be empty after undo.");
+                Assert.IsTrue(msSession.Redo(user, out error), error?.Message);
+                Assert.AreEqual(header, block.Header, "Header should be restored after redo.");
+            });
+        }
+
+        [TestMethod]
+        public void TestSettingCommentBlockHeaderAllowsEmpty()
+        {
+            TestHelper.RunInModelSystemContext("TestSettingCommentBlockHeaderAllowsEmpty", (user, pSession, msSession) =>
+            {
+                CommandError error = null;
+                var ms = msSession.ModelSystem;
+                Assert.IsTrue(msSession.AddCommentBlock(user, ms.GlobalBoundary, "My Comment", new Rectangle(100, 100),
+                    out CommentBlock block, out error), error?.Message);
+                Assert.IsTrue(msSession.SetCommentBlockHeader(user, block, "Has Header", out error), error?.Message);
+                Assert.IsTrue(msSession.SetCommentBlockHeader(user, block, string.Empty, out error), error?.Message);
+                Assert.AreEqual(string.Empty, block.Header, "Empty header should be accepted.");
+            });
+        }
+
+        [TestMethod]
+        public void TestCommentBlockHeaderPersistence()
+        {
+            const string comment = "My Comment";
+            const string header = "My Header";
+            var location = new Rectangle(100, 100);
+            TestHelper.RunInModelSystemContext("TestCommentBlockHeaderPersistence", (user, pSession, msSession) =>
+            {
+                CommandError error = null;
+                var ms = msSession.ModelSystem;
+                Assert.IsTrue(msSession.AddCommentBlock(user, ms.GlobalBoundary, comment, location,
+                    out CommentBlock block, out error), error?.Message);
+                Assert.IsTrue(msSession.SetCommentBlockHeader(user, block, header, out error), error?.Message);
+                Assert.IsTrue(msSession.Save(out error), error?.Message);
+            }, (user, pSession, msSession) =>
+            {
+                var comBlocks = msSession.ModelSystem.GlobalBoundary.CommentBlocks;
+                Assert.HasCount(1, comBlocks);
+                Assert.AreEqual(comment, comBlocks[0].Comment, "Comment should survive save/load.");
+                Assert.AreEqual(header, comBlocks[0].Header, "Header should survive save/load.");
+            });
+        }
+
+        [TestMethod]
+        public void TestCommentBlockHeaderDefaultsToEmptyOnLoad()
+        {
+            // A model system saved before headers were introduced should load with an empty header.
+            const string comment = "Legacy Comment";
+            var location = new Rectangle(50, 50);
+            TestHelper.RunInModelSystemContext("TestCommentBlockHeaderDefaultsToEmptyOnLoad", (user, pSession, msSession) =>
+            {
+                CommandError error = null;
+                var ms = msSession.ModelSystem;
+                Assert.IsTrue(msSession.AddCommentBlock(user, ms.GlobalBoundary, comment, location,
+                    out CommentBlock block, out error), error?.Message);
+                // Leave the header at the default (empty) and save.
+                Assert.IsTrue(msSession.Save(out error), error?.Message);
+            }, (user, pSession, msSession) =>
+            {
+                var comBlocks = msSession.ModelSystem.GlobalBoundary.CommentBlocks;
+                Assert.HasCount(1, comBlocks);
+                Assert.AreEqual(comment, comBlocks[0].Comment);
+                Assert.AreEqual(string.Empty, comBlocks[0].Header, "Header should default to empty string when absent from file.");
+            });
+        }
     }
 }