Support C# format strings in config

Author: 9swampy

src/GitVersion.Core.Tests/Extensions/ShouldlyExtensions.cs

@@ -0,0 +1,24 @@
+namespace GitVersion.Core.Tests.Extensions;
+
+public static class ShouldlyExtensions
+{
+    /// <summary>
+    /// Asserts that the action throws an exception of type TException
+    /// with the expected message.
+    /// </summary>
+    public static void ShouldThrowWithMessage<TException>(this Action action, string expectedMessage) where TException : Exception
+    {
+        var ex = Should.Throw<TException>(action);
+        ex.Message.ShouldBe(expectedMessage);
+    }
+
+    /// <summary>
+    /// Asserts that the action throws an exception of type TException,
+    /// and allows further assertion on the exception instance.
+    /// </summary>
+    public static void ShouldThrow<TException>(this Action action, Action<TException> additionalAssertions) where TException : Exception
+    {
+        var ex = Should.Throw<TException>(action);
+        additionalAssertions(ex);
+    }
+}

src/GitVersion.Core.Tests/Extensions/StringFormatWithExtensionTests.cs

@@ -244,4 +244,29 @@ public void FormatProperty_NullObject_WithFallback_QuotedAndEmpty()
         var actual = target.FormatWith(propertyObject, this.environment);
         Assert.That(actual, Is.EqualTo(""));
     }
+
+    [Test]
+    public void FormatAssemblyInformationalVersionWithSemanticVersionCustomFormattedCommitsSinceVersionSource()
+    {
+        var semanticVersion = new SemanticVersion
+        {
+            Major = 1,
+            Minor = 2,
+            Patch = 3,
+            PreReleaseTag = new SemanticVersionPreReleaseTag(string.Empty, 9, true),
+            BuildMetaData = new SemanticVersionBuildMetaData("Branch.main")
+            {
+                Branch = "main",
+                VersionSourceSha = "versionSourceSha",
+                Sha = "commitSha",
+                ShortSha = "commitShortSha",
+                CommitsSinceVersionSource = 42,
+                CommitDate = DateTimeOffset.Parse("2014-03-06 23:59:59Z")
+            }
+        };
+        const string target = "{Major}.{Minor}.{Patch}-{CommitsSinceVersionSource:0000}";
+        const string expected = "1.2.3-0042";
+        var actual = target.FormatWith(semanticVersion, this.environment);
+        Assert.That(actual, Is.EqualTo(expected));
+    }
 }

src/GitVersion.Core.Tests/Helpers/DateFormatterTests.cs

@@ -0,0 +1,39 @@
+using GitVersion.Helpers;
+
+namespace GitVersion.Tests.Helpers;
+
+[TestFixture]
+public class DateFormatterTests
+{
+    [Test]
+    public void Priority_ShouldBe2() => new DateFormatter().Priority.ShouldBe(2);
+
+    [Test]
+    public void TryFormat_NullValue_ReturnsFalse()
+    {
+        var sut = new DateFormatter();
+        var result = sut.TryFormat(null, "yyyy-MM-dd", out var formatted);
+        result.ShouldBeFalse();
+        formatted.ShouldBeEmpty();
+    }
+
+    [TestCase("2021-01-01", "date:yyyy-MM-dd", "2021-01-01")]
+    [TestCase("2021-01-01T12:00:00Z", "date:yyyy-MM-ddTHH:mm:ssZ", "2021-01-01T12:00:00Z")]
+    public void TryFormat_ValidDateFormats_ReturnsExpectedResult(string input, string format, string expected)
+    {
+        var date = DateTime.Parse(input);
+        var sut = new DateFormatter();
+        var result = sut.TryFormat(date, format, out var formatted);
+        result.ShouldBeTrue();
+        formatted.ShouldBe(expected);
+    }
+
+    [Test]
+    public void TryFormat_UnsupportedFormat_ReturnsFalse()
+    {
+        var sut = new DateFormatter();
+        var result = sut.TryFormat(DateTime.Now, "unsupported", out var formatted);
+        result.ShouldBeFalse();
+        formatted.ShouldBeEmpty();
+    }
+}

src/GitVersion.Core.Tests/Helpers/FormattableFormatterTests.cs

@@ -0,0 +1,41 @@
+using GitVersion.Helpers;
+
+namespace GitVersion.Tests.Helpers;
+
+[TestFixture]
+public class FormattableFormatterTests
+{
+    [Test]
+    public void Priority_ShouldBe2() => new FormattableFormatter().Priority.ShouldBe(2);
+
+    [Test]
+    public void TryFormat_NullValue_ReturnsFalse()
+    {
+        var sut = new FormattableFormatter();
+        var result = sut.TryFormat(null, "G", out var formatted);
+        result.ShouldBeFalse();
+        formatted.ShouldBeEmpty();
+    }
+
+    [TestCase(123.456, "F2", "123.46")]
+    [TestCase(1234.456, "F2", "1234.46")]
+    public void TryFormat_ValidFormats_ReturnsExpectedResult(object input, string format, string expected)
+    {
+        var sut = new FormattableFormatter();
+        var result = sut.TryFormat(input, format, out var formatted);
+        result.ShouldBeTrue();
+        formatted.ShouldBe(expected);
+    }
+
+    [TestCase(123.456, "C", "Format 'C' is not supported in FormattableFormatter")]
+    [TestCase(123.456, "P", "Format 'P' is not supported in FormattableFormatter")]
+    [TestCase(1234567890, "N0", "Format 'N0' is not supported in FormattableFormatter")]
+    [TestCase(1234567890, "Z", "Format 'Z' is not supported in FormattableFormatter")]
+    public void TryFormat_UnsupportedFormat_ReturnsFalse(object input, string format, string expected)
+    {
+        var sut = new FormattableFormatter();
+        var result = sut.TryFormat(input, format, out var formatted);
+        result.ShouldBeFalse();
+        formatted.ShouldBe(expected);
+    }
+}