From 132bb07bc98cf122b8a94bcf577af665486b84a9 Mon Sep 17 00:00:00 2001
From: AJ Isaacs <ajisaacs27@gmail.com>
Date: Wed, 30 Sep 2026 01:29:11 -0400
Subject: [PATCH] test(editor): make control assertions handle-state
 independent and order-proving

Quality review of 50884da found the unshown RichTextBox oracle compared
cached CRLF text against the highlighted editor's native LF-normalized
text, which would fail on first Windows execution. Compare generated
text with normalized line endings on both sides instead, capture the
status label and preview state inside the ProgramChanged handler to
prove fallback-before-notify ordering, document the HighlightSpan
UTF-16 and rule-index contract, and pin the null-text argument check.
---
 OpenNest.Core/CNC/ProgramHighlighting.cs      |  9 +++++
 .../CNC/ProgramHighlightingTests.cs           |  5 +++
 .../Controls/ProgramEditorControlTests.cs     | 39 +++++++++++++++----
 3 files changed, 46 insertions(+), 7 deletions(-)

diff --git a/OpenNest.Core/CNC/ProgramHighlighting.cs b/OpenNest.Core/CNC/ProgramHighlighting.cs
index 1aeffe6..2fda4d7 100644
--- a/OpenNest.Core/CNC/ProgramHighlighting.cs
+++ b/OpenNest.Core/CNC/ProgramHighlighting.cs
@@ -4,6 +4,15 @@ using System.Text.RegularExpressions;
 
 namespace OpenNest.CNC;
 
+/// <summary>
+/// A character range in generated G-code assigned by one highlighting rule.
+/// </summary>
+/// <param name="Index">Zero-based UTF-16 index of the first colored character.</param>
+/// <param name="Length">Number of UTF-16 characters to color.</param>
+/// <param name="RuleIndex">
+/// Zero-based rule index: 0 comments, 1 motion modes (G90/G91), 2 rapid moves (G00),
+/// 3 linear moves (G01), 4 arcs (G02/G03).
+/// </param>
 public readonly record struct HighlightSpan(int Index, int Length, int RuleIndex);
 
 /// <summary>Computes cosmetic G-code highlight spans without changing the generated text.</summary>
diff --git a/OpenNest.Tests/CNC/ProgramHighlightingTests.cs b/OpenNest.Tests/CNC/ProgramHighlightingTests.cs
index c142b55..ee1ebb4 100644
--- a/OpenNest.Tests/CNC/ProgramHighlightingTests.cs
+++ b/OpenNest.Tests/CNC/ProgramHighlightingTests.cs
@@ -9,6 +9,11 @@ namespace OpenNest.Tests.CNC;
 
 public class ProgramHighlightingTests
 {
+    [Fact]
+    public void ComputeSpans_RejectsNullText()
+    {
+        Assert.Throws<ArgumentNullException>(() => ProgramHighlighting.ComputeSpans(null));
+    }
     [Theory]
     [InlineData("G00", 2, 3)]
     [InlineData("G000", -1, 0)]
diff --git a/OpenNest.WinForms.Tests/Controls/ProgramEditorControlTests.cs b/OpenNest.WinForms.Tests/Controls/ProgramEditorControlTests.cs
index 903a510..a37773b 100644
--- a/OpenNest.WinForms.Tests/Controls/ProgramEditorControlTests.cs
+++ b/OpenNest.WinForms.Tests/Controls/ProgramEditorControlTests.cs
@@ -44,8 +44,17 @@ public class ProgramEditorControlTests
         control.Dock = DockStyle.Fill;
         form.Controls.Add(control);
         form.Show();
+        var status = GetControl<Label>(control, "lblGcode");
+        var preview = GetControl<EntityView>(control, "preview");
         var changes = 0;
-        control.ProgramChanged += (_, _) => changes++;
+        Entity[] beforeClick = Array.Empty<Entity>();
+        var eventStates = new List<(string Label, bool PreviewChanged)>();
+        control.ProgramChanged += (_, _) =>
+        {
+            changes++;
+            // Prove the fallback and preview completed BEFORE the model change was announced.
+            eventStates.Add((status.Text, !preview.Entities.SequenceEqual(beforeClick)));
+        };
 
         control.LoadEntities(CreateEntities());
         Assert.Equal(0, changes); // Loading did not raise ProgramChanged before this repair either.
@@ -56,15 +65,16 @@ public class ProgramEditorControlTests
         var firstContour = Assert.IsType<ContourInfo>(list.Items[0]);
         var oldDirection = firstContour.DirectionLabel;
         var oldProgram = control.Program;
-        var preview = GetControl<EntityView>(control, "preview");
         var oldPreview = preview.Entities.ToArray();
 
+        beforeClick = oldPreview;
         GetControl<Button>(control, "reverseButton").PerformClick();
 
         Assert.NotSame(oldProgram, control.Program);
         Assert.NotEqual(oldDirection, firstContour.DirectionLabel);
         Assert.True(control.IsDirty);
         Assert.Equal(1, changes);
+        AssertHighlightingStateAtEvent(eventStates[0], timeout);
         AssertPreviewRebuilt(preview, oldPreview);
         Assert.Equal(Assert.IsType<Circle>(firstContour.Shape.Entities[0]).Rotation,
             Assert.IsType<Circle>(preview.Entities[0]).Rotation);
@@ -73,6 +83,7 @@ public class ProgramEditorControlTests
 
         oldProgram = control.Program;
         oldPreview = preview.Entities.ToArray();
+        beforeClick = oldPreview;
         GetField<ToolStripMenuItem>(control, "menuMoveDown").PerformClick();
 
         Assert.NotSame(oldProgram, control.Program);
@@ -80,6 +91,7 @@ public class ProgramEditorControlTests
         Assert.Equal(1, list.SelectedIndex);
         Assert.True(control.IsDirty);
         Assert.Equal(2, changes);
+        AssertHighlightingStateAtEvent(eventStates[1], timeout);
         AssertPreviewRebuilt(preview, oldPreview);
         AssertCompleteText(control);
         AssertHighlightingOutcome(control, timeout);
@@ -125,7 +137,7 @@ public class ProgramEditorControlTests
 
         ApplyHighlighting(control);
 
-        Assert.Equal(original, editor.Text);
+        Assert.Equal(NormalizeLineEndings(original), NormalizeLineEndings(editor.Text));
         Assert.Equal(0, editor.SelectionStart);
         Assert.Equal(0, editor.SelectionLength);
         var colors = new[]
@@ -200,6 +212,9 @@ public class ProgramEditorControlTests
         }
     }
 
+    private static string NormalizeLineEndings(string value) =>
+        value.Replace("\r\n", "\n").Replace("\r", "\n");
+
     private static List<Entity> CreateEntities() => new()
     {
         new Circle(3, 3, 1), new Circle(7, 7, 1), new Circle(10, 10, 10),
@@ -211,15 +226,25 @@ public class ProgramEditorControlTests
         var raw = Assert.IsType<string>(typeof(ProgramEditorControl)
             .GetMethod("FormatProgram", BindingFlags.Static | BindingFlags.NonPublic)!
             .Invoke(null, new object[] { control.Program, contours }));
-        // RichTextBox performs its existing newline normalization; compare with the same
-        // generated text assigned to an unhighlighted editor, not with another highlight pass.
-        using var unhighlighted = new RichTextBox { Text = raw };
+        // A RichTextBox with a created handle returns native text with LF-normalized line
+        // endings; before handle creation it returns the cached string as assigned. Compare
+        // against the generated text normalized the same way so the assertion is independent
+        // of the editor's handle state.
         var editor = GetControl<RichTextBox>(control, "gcodeEditor");
         Assert.NotEmpty(raw);
-        Assert.Equal(unhighlighted.Text, editor.Text);
+        Assert.Equal(NormalizeLineEndings(raw), NormalizeLineEndings(editor.Text));
         Assert.True(editor.ReadOnly);
     }
 
+    private static void AssertHighlightingStateAtEvent(
+        (string Label, bool PreviewChanged) state, bool timeout)
+    {
+        // Captured inside the ProgramChanged handler: highlighting fallback and preview
+        // rebuild must already be complete when the model change is announced.
+        Assert.Equal(timeout ? "G-Code (highlighting timed out)" : "G-Code", state.Label);
+        Assert.True(state.PreviewChanged);
+    }
+
     private static void AssertHighlightingOutcome(ProgramEditorControl control, bool timeout)
     {
         var editor = GetControl<RichTextBox>(control, "gcodeEditor");