Green

Author: 9swampy

src/GitVersion.Core.Tests/Formatting/BackwardCompatibilityTests.cs

@@ -4,21 +4,12 @@
 
 namespace GitVersion.Core.Tests.Formatting;
 
-/// <summary>
-/// Tests for backward compatibility with legacy .NET composite format syntax (;;)
-/// These tests document the expected behavior before implementing the fix.
-/// </summary>
 [TestFixture]
 public class LegacyFormattingSyntaxTests
 {
-    /// <summary>
-    /// Test that the old ;;'' syntax for zero-value fallbacks still works
-    /// This is the exact case from issue #4654
-    /// </summary>
     [Test]
     public void FormatWith_LegacyZeroFallbackSyntax_ShouldWork()
     {
-        // Arrange
         var semanticVersion = new SemanticVersion
         {
             Major = 6,
@@ -36,119 +27,82 @@ public void FormatWith_LegacyZeroFallbackSyntax_ShouldWork()
             }
         };
 
-        // The exact template from the issue
         const string template = "{MajorMinorPatch}{PreReleaseLabelWithDash}{CommitsSinceVersionSource:0000;;''}";
-        const string expected = "6.13.54-gv60002"; // Should format CommitsSinceVersionSource as 0002, not show literal text
+        const string expected = "6.13.54-gv60002";
 
-        // Act
         var actual = template.FormatWith(semanticVersion, new TestEnvironment());
 
-        // Assert
         actual.ShouldBe(expected);
     }
 
-    /// <summary>
-    /// Test that legacy positive/negative/zero section syntax works
-    /// </summary>
     [Test]
     public void FormatWith_LegacyThreeSectionSyntax_ShouldWork()
     {
-        // Arrange
         var testObject = new { Value = -5 };
         const string template = "{Value:positive;negative;zero}";
         const string expected = "negative";
 
-        // Act
         var actual = template.FormatWith(testObject, new TestEnvironment());
 
-        // Assert
         actual.ShouldBe(expected);
     }
 
-    /// <summary>
-    /// Test that legacy two-section syntax works (positive;negative)
-    /// </summary>
     [Test]
     public void FormatWith_LegacyTwoSectionSyntax_ShouldWork()
     {
-        // Arrange
         var testObject = new { Value = -10 };
         const string template = "{Value:positive;negative}";
         const string expected = "negative";
 
-        // Act
         var actual = template.FormatWith(testObject, new TestEnvironment());
 
-        // Assert
         actual.ShouldBe(expected);
     }
 
-    /// <summary>
-    /// Test that zero values use the third section in legacy syntax
-    /// </summary>
     [Test]
     public void FormatWith_LegacyZeroValue_ShouldUseThirdSection()
     {
-        // Arrange
         var testObject = new { Value = 0 };
         const string template = "{Value:pos;neg;ZERO}";
         const string expected = "ZERO";
 
-        // Act
         var actual = template.FormatWith(testObject, new TestEnvironment());
 
-        // Assert
         actual.ShouldBe(expected);
     }
 
-    /// <summary>
-    /// Test mixed usage: some properties with legacy syntax, others with new syntax
-    /// </summary>
     [Test]
     public void FormatWith_MixedLegacyAndNewSyntax_ShouldWork()
     {
-        // Arrange
         var testObject = new
         {
             OldStyle = 0,
             NewStyle = 42,
             RegularProp = "test"
         };
         const string template = "{OldStyle:pos;neg;''}{NewStyle:0000 ?? 'fallback'}{RegularProp}";
-        const string expected = "0042test"; // Empty string for zero, 0042 for 42, test as-is
+        const string expected = "0042test";
 
-        // Act
         var actual = template.FormatWith(testObject, new TestEnvironment());
 
-        // Assert
         actual.ShouldBe(expected);
     }
 
-    /// <summary>
-    /// Test that complex legacy format with actual .NET format specifiers works
-    /// </summary>
     [Test]
     public void FormatWith_LegacyWithStandardFormatSpecifiers_ShouldWork()
     {
-        // Arrange
         var testObject = new { Amount = 1234.56 };
         const string template = "{Amount:C2;(C2);'No Amount'}";
-        const string expected = "¤1,234.56"; // Should format as currency
+        const string expected = "¤1,234.56";
 
-        // Act
         var actual = template.FormatWith(testObject, new TestEnvironment());
 
-        // Assert
         actual.ShouldBe(expected);
     }
 
-    /// <summary>
-    /// Test that the original failing case from issue #4654 works exactly as expected
-    /// </summary>
     [Test]
     public void FormatWith_Issue4654ExactCase_ShouldWork()
     {
-        // Arrange - recreate the exact scenario from the issue
         var semanticVersion = new SemanticVersion
         {
             Major = 6,
@@ -161,7 +115,6 @@ public void FormatWith_Issue4654ExactCase_ShouldWork()
             }
         };
 
-        // This should work on main branch where PreReleaseLabelWithDash would be empty
         var mainBranchVersion = new SemanticVersion
         {
             Major = 6,
@@ -176,69 +129,44 @@ public void FormatWith_Issue4654ExactCase_ShouldWork()
 
         const string template = "{MajorMinorPatch}{PreReleaseLabelWithDash}{CommitsSinceVersionSource:0000;;''}";
 
-        // Act & Assert for feature branch
         var featureResult = template.FormatWith(semanticVersion, new TestEnvironment());
         featureResult.ShouldBe("6.13.54-gv60002");
 
-        // Act & Assert for main branch (zero commits should show empty string)
         var mainResult = template.FormatWith(mainBranchVersion, new TestEnvironment());
-        mainResult.ShouldBe("6.13.54"); // Empty PreReleaseLabelWithDash and empty string for zero commits
+        mainResult.ShouldBe("6.13.54");
     }
 }
 
-/// <summary>
-/// Tests specifically for the regex pattern changes to ensure backward compatibility
-/// </summary>
 [TestFixture]
 public class LegacyRegexPatternTests
 {
-    /// <summary>
-    /// Test that the ExpandTokensRegex can parse legacy semicolon syntax
-    /// </summary>
     [Test]
     public void ExpandTokensRegex_ShouldParseLegacySemicolonSyntax()
     {
-        // Arrange
         const string input = "{CommitsSinceVersionSource:0000;;''}";
 
-        // Act
         var matches = RegexPatterns.Common.ExpandTokensRegex().Matches(input);
 
-        // Assert
         matches.Count.ShouldBe(1);
         var match = matches[0];
         match.Groups["member"].Value.ShouldBe("CommitsSinceVersionSource");
-
-        // The format group should capture the entire format including semicolons
-        // This test documents what should happen - the format might need to be "0000;;''"
-        // or the regex might need to separate format and fallback parts
         match.Groups["format"].Success.ShouldBeTrue();
-        // The exact capture will depend on implementation - this test will guide the regex design
     }
 
-    /// <summary>
-    /// Test that both new and old syntax can coexist in the same template
-    /// </summary>
     [Test]
     public void ExpandTokensRegex_ShouldHandleMixedSyntax()
     {
-        // Arrange
         const string input = "{NewStyle:0000 ?? 'fallback'} {OldStyle:pos;neg;zero}";
 
-        // Act
         var matches = RegexPatterns.Common.ExpandTokensRegex().Matches(input);
 
-        // Assert
         matches.Count.ShouldBe(2);
 
-        // First match: new syntax
         var newMatch = matches[0];
         newMatch.Groups["member"].Value.ShouldBe("NewStyle");
         newMatch.Groups["fallback"].Value.ShouldBe("fallback");
 
-        // Second match: old syntax  
         var oldMatch = matches[1];
         oldMatch.Groups["member"].Value.ShouldBe("OldStyle");
-        // Format handling for legacy syntax TBD based on implementation approach
     }
-}
+}

src/GitVersion.Core.Tests/Issues/Issue4654Tests.cs

@@ -4,26 +4,13 @@
 
 namespace GitVersion.Core.Tests.Issues;
 
-/// <summary>
-/// Tests for Issue #4654 - Incorrect output for assembly-informational-version
-/// https://github.com/GitTools/GitVersion/issues/4654
-///
-/// These tests document the expected behavior before implementing the fix.
-/// Currently FAILING - will pass once backward compatibility is implemented.
-/// </summary>
 [TestFixture]
 public class Issue4654Tests
 {
-    /// <summary>
-    /// Reproduce the exact issue reported in #4654
-    /// Expected: "6.13.54-gv60002"
-    /// Actual (broken): "6.13.54-gv6-CommitsSinceVersionSource-0000-----"
-    /// </summary>
     [Test]
     [Category("Issue4654")]
     public void Issue4654_ExactReproduction_ShouldFormatCorrectly()
     {
-        // Arrange - exact data from the issue
         var semanticVersion = new SemanticVersion
         {
             Major = 6,
@@ -42,23 +29,17 @@ public void Issue4654_ExactReproduction_ShouldFormatCorrectly()
             }
         };
 
-        // Add derived properties that would be available in real GitVersion
         var extendedVersion = new
         {
-            // Core properties
             semanticVersion.Major,
             semanticVersion.Minor,
             semanticVersion.Patch,
             semanticVersion.BuildMetaData.CommitsSinceVersionSource,
-
-            // Derived properties
             MajorMinorPatch = $"{semanticVersion.Major}.{semanticVersion.Minor}.{semanticVersion.Patch}",
             PreReleaseLabel = semanticVersion.PreReleaseTag.Name,
             PreReleaseLabelWithDash = string.IsNullOrEmpty(semanticVersion.PreReleaseTag.Name)
                 ? ""
                 : $"-{semanticVersion.PreReleaseTag.Name}",
-
-            // Other properties from the issue JSON
             AssemblySemFileVer = "6.13.54.0",
             AssemblySemVer = "6.13.54.0",
             BranchName = "feature/gv6",
@@ -67,55 +48,38 @@ public void Issue4654_ExactReproduction_ShouldFormatCorrectly()
             SemVer = "6.13.54-gv6.1"
         };
 
-        // The exact template from the overrideconfig command
         const string template = "{MajorMinorPatch}{PreReleaseLabelWithDash}{CommitsSinceVersionSource:0000;;''}";
-
-        // Expected result: MajorMinorPatch + PreReleaseLabelWithDash + formatted CommitsSinceVersionSource
         const string expected = "6.13.54-gv60002";
 
-        // Act
         var actual = template.FormatWith(extendedVersion, new TestEnvironment());
 
-        // Assert
         actual.ShouldBe(expected, "The legacy ;;'' syntax should format CommitsSinceVersionSource as 0002, not as literal text");
     }
 
-    /// <summary>
-    /// Test the simpler case without the legacy syntax to ensure basic formatting still works
-    /// </summary>
     [Test]
     [Category("Issue4654")]
     public void Issue4654_WithoutLegacySyntax_ShouldStillWork()
     {
-        // Arrange
         var testData = new
         {
             MajorMinorPatch = "6.13.54",
             PreReleaseLabelWithDash = "-gv6",
             CommitsSinceVersionSource = 2
         };
 
-        // Using new ?? syntax instead of ;;
         const string template = "{MajorMinorPatch}{PreReleaseLabelWithDash}{CommitsSinceVersionSource:0000}";
         const string expected = "6.13.54-gv60002";
 
-        // Act
         var actual = template.FormatWith(testData, new TestEnvironment());
 
-        // Assert
         actual.ShouldBe(expected, "New format syntax should work correctly");
     }
 
-    /// <summary>
-    /// Test that demonstrates the current broken behavior
-    /// This test documents what's currently happening (incorrect output)
-    /// </summary>
     [Test]
     [Category("Issue4654")]
     [Category("CurrentBehavior")]
     public void Issue4654_CurrentBrokenBehavior_DocumentsActualOutput()
     {
-        // Arrange
         var testData = new
         {
             MajorMinorPatch = "6.13.54",
@@ -124,53 +88,38 @@ public void Issue4654_CurrentBrokenBehavior_DocumentsActualOutput()
         };
 
         const string template = "{MajorMinorPatch}{PreReleaseLabelWithDash}{CommitsSinceVersionSource:0000;;''}";
-
-        // This is what we expect it SHOULD return
         const string shouldBe = "6.13.54-gv60002";
 
-        // Act
         var actual = template.FormatWith(testData, new TestEnvironment());
 
-        // Assert - document current broken behavior
-        // This assertion will fail until the fix is implemented
         if (actual == shouldBe)
         {
             Assert.Pass("The issue has been fixed!");
         }
         else
         {
-            // Document what it currently returns
             Console.WriteLine($"Current broken output: {actual}");
             Console.WriteLine($"Expected output: {shouldBe}");
-
-            // This assertion should fail, documenting the current broken state
             actual.ShouldContain("CommitsSinceVersionSource");
-            // Explanation: Currently broken - the property name appears as literal text instead of being formatted
         }
     }
 
-    /// <summary>
-    /// Test edge case: zero value with legacy syntax should use empty fallback
-    /// </summary>
     [Test]
     [Category("Issue4654")]
     public void Issue4654_ZeroValueWithLegacySyntax_ShouldUseEmptyFallback()
     {
-        // Arrange - main branch scenario where commits since version source is 0
         var mainBranchData = new
         {
             MajorMinorPatch = "6.13.54",
-            PreReleaseLabelWithDash = "", // Empty on main branch
-            CommitsSinceVersionSource = 0  // Zero commits
+            PreReleaseLabelWithDash = "",
+            CommitsSinceVersionSource = 0
         };
 
         const string template = "{MajorMinorPatch}{PreReleaseLabelWithDash}{CommitsSinceVersionSource:0000;;''}";
-        const string expected = "6.13.54"; // Should be empty string for zero value
+        const string expected = "6.13.54";
 
-        // Act
         var actual = template.FormatWith(mainBranchData, new TestEnvironment());
 
-        // Assert
         actual.ShouldBe(expected, "Zero values should use the third section (empty string) in legacy ;;'' syntax");
     }
-}
+}