Fix failing unit tests

Matthias Gessinger · commonsensesoftware · commit 2fae696524f4 · 2026-02-14T12:53:49.000-08:00
diff --git a/src/Abstractions/src/Asp.Versioning.Abstractions/DeprecationPolicy.cs b/src/Abstractions/src/Asp.Versioning.Abstractions/DeprecationPolicy.cs
@@ -73,6 +73,6 @@ public bool IsEffective( DateTimeOffset? dateTimeOffset )
             return true;
         }
 
-        return date < when;
+        return date <= when;
     }
 }
diff --git a/src/AspNet/WebApi/src/Asp.Versioning.WebApi.ApiExplorer/ApiExplorer/VersionedApiExplorer.cs b/src/AspNet/WebApi/src/Asp.Versioning.WebApi.ApiExplorer/ApiExplorer/VersionedApiExplorer.cs
@@ -238,13 +238,11 @@ protected virtual ApiDescriptionGroupCollection InitializeApiDescriptions()
         }
 
         var routes = FlattenRoutes( Configuration.Routes ).ToArray();
-        var sunsetPolicyManager = Configuration.GetSunsetPolicyManager();
-        var deprecationPolicyManager = Configuration.GetDeprecationPolicyManager();
 
         foreach ( var apiVersion in FlattenApiVersions( controllerMappings ) )
         {
-            sunsetPolicyManager.TryGetPolicy( apiVersion, out var sunsetPolicy );
-            deprecationPolicyManager.TryGetPolicy( apiVersion, out var deprecationPolicy );
+            SunsetPolicyManager.TryGetPolicy( apiVersion, out var sunsetPolicy );
+            DeprecationPolicyManager.TryGetPolicy( apiVersion, out var deprecationPolicy );
 
             for ( var i = 0; i < routes.Length; i++ )
             {
diff --git a/src/AspNet/WebApi/test/Asp.Versioning.WebApi.Tests/DefaultApiVersionReporterTest.cs b/src/AspNet/WebApi/test/Asp.Versioning.WebApi.Tests/DefaultApiVersionReporterTest.cs
@@ -13,8 +13,8 @@ public class DefaultApiVersionReporterTest
     public void report_should_add_expected_headers()
     {
         // arrange
-        var sunsetDate = DateTimeOffset.Now;
-        var deprecationDate = DateTimeOffset.Now;
+        var sunsetDate = DateTimeOffset.UtcNow.AddDays( 2 );
+        var deprecationDate = DateTimeOffset.UtcNow.AddDays( 1 );
         var reporter = new DefaultApiVersionReporter( new TestSunsetPolicyManager( sunsetDate ), new TestDeprecationPolicyManager( deprecationDate ) );
         var configuration = new HttpConfiguration();
         var request = new HttpRequestMessage();
@@ -57,13 +57,11 @@ public void report_should_add_expected_headers()
         headers.GetValues( "api-supported-versions" ).Should().Equal( "1.0, 2.0" );
         headers.GetValues( "api-deprecated-versions" ).Should().Equal( "0.9" );
         headers.GetValues( "Sunset" )
-               .Single()
                .Should()
-               .Be( sunsetDate.ToString( "r" ) );
+               .ContainSingle( sunsetDate.ToString( "r" ) );
         headers.GetValues( "Deprecation" )
-               .Single()
                .Should()
-               .Be( $"@{unixTimestamp}" );
+               .ContainSingle( $"@{unixTimestamp}" );
         headers.GetValues( "Link" )
                .Should()
                .BeEquivalentTo( [
diff --git a/src/AspNetCore/WebApi/test/Asp.Versioning.Http.Tests/DefaultApiVersionReporterTest.cs b/src/AspNetCore/WebApi/test/Asp.Versioning.Http.Tests/DefaultApiVersionReporterTest.cs
@@ -12,8 +12,8 @@ public class DefaultApiVersionReporterTest
     public void report_should_add_expected_headers()
     {
         // arrange
-        var sunsetDate = DateTimeOffset.Now;
-        var deprecationDate = DateTimeOffset.Now;
+        var sunsetDate = DateTimeOffset.UtcNow.AddDays( 2 );
+        var deprecationDate = DateTimeOffset.UtcNow.AddDays( 1 );
         var reporter = new DefaultApiVersionReporter( new TestSunsetPolicyManager( sunsetDate ), new TestDeprecationPolicyManager( deprecationDate ) );
         var httpContext = new Mock<HttpContext>();
         var features = new Mock<IFeatureCollection>();
@@ -65,17 +65,18 @@ public void report_should_add_expected_headers()
 
         headers["api-supported-versions"].Should().Equal( "1.0, 2.0" );
         headers["api-deprecated-versions"].Should().Equal( "0.9" );
-        headers["Sunset"].Single()
-                         .Should()
-                         .Be( sunsetDate.ToString( "r" ) );
-        headers["Deprecation"].Single()
-                              .Should()
-                              .Be( $"@{unixTimestamp}" );
-        headers["Link"].Should()
-                       .BeEquivalentTo( [
-                            "<http://docs.api.com/sunset.html>; rel=\"sunset\"",
-                            "<http://docs.api.com/deprecation.html>; rel=\"deprecation\"",
-                       ] );
+        headers["Sunset"]
+            .Should()
+            .ContainSingle( sunsetDate.ToString( "r" ) );
+        headers["Deprecation"]
+            .Should()
+            .ContainSingle( $"@{unixTimestamp}" );
+        headers["Link"]
+            .Should()
+            .BeEquivalentTo( [
+                "<http://docs.api.com/sunset.html>; rel=\"sunset\"",
+                "<http://docs.api.com/deprecation.html>; rel=\"deprecation\"",
+            ] );
     }
 
     private sealed class TestSunsetPolicyManager : IPolicyManager<SunsetPolicy>
diff --git a/src/Client/src/Asp.Versioning.Http.Client/System.Net.Http/HttpResponseMessageExtensions.cs b/src/Client/src/Asp.Versioning.Http.Client/System.Net.Http/HttpResponseMessageExtensions.cs
@@ -19,7 +19,7 @@ public static class HttpResponseMessageExtensions
     private const string Link = nameof( Link );
 
 #if NETSTANDARD1_1
-    private static readonly DateTime UnixEpoch = new DateTime( 1970, 1, 1 );
+    private static readonly DateTime UnixEpoch = new DateTime( 1970, 1, 1, 0, 0, 0, DateTimeKind.Utc );
 #endif
 
     /// <summary>
@@ -82,7 +82,7 @@ public static SunsetPolicy ReadSunsetPolicy( this HttpResponseMessage response )
     public static string ToDeprecationHeaderValue( this DateTimeOffset deprecationDate )
     {
         var unixTimestamp = deprecationDate.ToUnixTimeSeconds();
-        return unixTimestamp.ToString( "'@'0", CultureInfo.CurrentCulture );
+        return unixTimestamp.ToString( "'@'0", CultureInfo.InvariantCulture );
     }
 
     /// <summary>
@@ -100,7 +100,7 @@ public static DeprecationPolicy ReadDeprecationPolicy( this HttpResponseMessage
 
         if ( headers.TryGetValues( Deprecation, out var values ) )
         {
-            var culture = CultureInfo.CurrentCulture;
+            var culture = CultureInfo.InvariantCulture;
             var style = NumberStyles.Integer;
 
             foreach ( var value in values )
diff --git a/src/Client/test/Asp.Versioning.Http.Client.Tests/System.Net.Http/HttpResponseMessageExtensionsTest.cs b/src/Client/test/Asp.Versioning.Http.Client.Tests/System.Net.Http/HttpResponseMessageExtensionsTest.cs
@@ -10,7 +10,7 @@ public class HttpResponseMessageExtensionsTest
     public void read_sunset_policy_should_parse_response()
     {
         // arrange
-        var date = DateTimeOffset.Now;
+        var date = DateTimeOffset.UtcNow;
         var request = new HttpRequestMessage( HttpMethod.Get, "http://tempuri.org" );
         var response = new HttpResponseMessage() { RequestMessage = request };
 
@@ -35,7 +35,7 @@ public void read_sunset_policy_should_parse_response()
     public void read_sunset_policy_should_use_greatest_date()
     {
         // arrange
-        var date = DateTimeOffset.Now;
+        var date = DateTimeOffset.UtcNow;
         var expected = date.AddDays( 14 );
         var request = new HttpRequestMessage( HttpMethod.Get, "http://tempuri.org" );
         var response = new HttpResponseMessage() { RequestMessage = request };
@@ -91,7 +91,7 @@ public void read_sunset_policy_should_ignore_unrelated_links()
     public void read_deprecation_policy_should_parse_response()
     {
         // arrange
-        var date = DateTimeOffset.Now;
+        var date = DateTimeOffset.UtcNow;
         var request = new HttpRequestMessage( HttpMethod.Get, "http://tempuri.org" );
         var response = new HttpResponseMessage() { RequestMessage = request };
 
@@ -116,7 +116,7 @@ public void read_deprecation_policy_should_parse_response()
     public void read_deprecation_policy_should_use_smallest_date()
     {
         // arrange
-        var date = DateTimeOffset.Now;
+        var date = DateTimeOffset.UtcNow;
         var expected = date.Subtract( TimeSpan.FromDays( 14 ) );
         var request = new HttpRequestMessage( HttpMethod.Get, "http://tempuri.org" );
         var response = new HttpResponseMessage() { RequestMessage = request };
diff --git a/src/Client/test/Asp.Versioning.Http.Client.Tests/net#.0/ApiVersionHandlerLoggerTTest.cs b/src/Client/test/Asp.Versioning.Http.Client.Tests/net#.0/ApiVersionHandlerLoggerTTest.cs
@@ -23,8 +23,8 @@ public async Task on_api_deprecated_should_log_message()
         var date = DateTimeOffset.Now;
         var expected = "API version 1.0 for http://tempuri.org has been deprecated since <unspecified> and will " +
                       $"sunset on {date.ToUniversalTime()}. Additional information: " +
-                      "API Policy (en): http://tempuri.org/policy/en, " +
-                      "API Política (es): http://tempuri.org/policy/es";
+                      "[API Policy (en): http://tempuri.org/policy/en, " +
+                      "API Política (es): http://tempuri.org/policy/es]";
 
         response.Headers.Add( "sunset", date.ToString( "r" ) );
         response.Headers.Add( "link", "<policy/en>; rel=\"sunset\"; type=\"text/html\"; title=\"API Policy\"; hreflang=\"en\"" );
diff --git a/src/Common/src/Common/DefaultApiVersionReporter.cs b/src/Common/src/Common/DefaultApiVersionReporter.cs
@@ -104,6 +104,7 @@ public void Report( HttpResponse response, ApiVersionModel apiVersionModel )
 
         if ( deprecationPolicyManager.TryResolvePolicy( name, version, out var deprecationPolicy ) )
         {
+            // Only emit a deprecation header if the deprecation policy becomes effective before the sunset date.
             if ( deprecationPolicy.IsEffective( sunsetDate ) )
             {
                 response.WriteDeprecationPolicy( deprecationPolicy );
diff --git a/src/Common/test/Common.Tests/DeprecationPolicyBuilderTest.cs b/src/Common/test/Common.Tests/DeprecationPolicyBuilderTest.cs
@@ -51,7 +51,7 @@ public void link_should_should_return_existing_builder()
     }
 
     [Fact]
-    public void build_should_construct_sunset_policy()
+    public void build_should_construct_deprecation_policy()
     {
         // arrange
         var builder = new DeprecationPolicyBuilder( default, ApiVersion.Default );
@@ -66,6 +66,6 @@ public void build_should_construct_sunset_policy()
         policy.Should().BeEquivalentTo(
             new DeprecationPolicy(
                 new DateTimeOffset( new DateTime( 2022, 2, 1 ) ),
-                new LinkHeaderValue( new Uri( "http://tempuri.org" ), "sunset" ) ) );
+                new LinkHeaderValue( new Uri( "http://tempuri.org" ), "deprecation" ) ) );
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,6 @@ public bool IsEffective( DateTimeOffset? dateTimeOffset )`
`73`	`73`	`return true;`
`74`	`74`	`}`
`75`	`75`
`76`		`- return date < when;`
	`76`	`+ return date <= when;`
`77`	`77`	`}`
`78`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -238,13 +238,11 @@ protected virtual ApiDescriptionGroupCollection InitializeApiDescriptions()`
`238`	`238`	`}`
`239`	`239`
`240`	`240`	`var routes = FlattenRoutes( Configuration.Routes ).ToArray();`
`241`		`- var sunsetPolicyManager = Configuration.GetSunsetPolicyManager();`
`242`		`- var deprecationPolicyManager = Configuration.GetDeprecationPolicyManager();`
`243`	`241`
`244`	`242`	`foreach ( var apiVersion in FlattenApiVersions( controllerMappings ) )`
`245`	`243`	`{`
`246`		`- sunsetPolicyManager.TryGetPolicy( apiVersion, out var sunsetPolicy );`
`247`		`- deprecationPolicyManager.TryGetPolicy( apiVersion, out var deprecationPolicy );`
	`244`	`+ SunsetPolicyManager.TryGetPolicy( apiVersion, out var sunsetPolicy );`
	`245`	`+ DeprecationPolicyManager.TryGetPolicy( apiVersion, out var deprecationPolicy );`
`248`	`246`
`249`	`247`	`for ( var i = 0; i < routes.Length; i++ )`
`250`	`248`	`{`
Original file line number	Diff line number	Diff line change
`@@ -104,6 +104,7 @@ public void Report( HttpResponse response, ApiVersionModel apiVersionModel )`
`104`	`104`
`105`	`105`	`if ( deprecationPolicyManager.TryResolvePolicy( name, version, out var deprecationPolicy ) )`
`106`	`106`	`{`
	`107`	`+ // Only emit a deprecation header if the deprecation policy becomes effective before the sunset date.`
`107`	`108`	`if ( deprecationPolicy.IsEffective( sunsetDate ) )`
`108`	`109`	`{`
`109`	`110`	`response.WriteDeprecationPolicy( deprecationPolicy );`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public void link_should_should_return_existing_builder()`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`[Fact]`
`54`		`- public void build_should_construct_sunset_policy()`
	`54`	`+ public void build_should_construct_deprecation_policy()`
`55`	`55`	`{`
`56`	`56`	`// arrange`
`57`	`57`	`var builder = new DeprecationPolicyBuilder( default, ApiVersion.Default );`
`@@ -66,6 +66,6 @@ public void build_should_construct_sunset_policy()`
`66`	`66`	`policy.Should().BeEquivalentTo(`
`67`	`67`	`new DeprecationPolicy(`
`68`	`68`	`new DateTimeOffset( new DateTime( 2022, 2, 1 ) ),`
`69`		`- new LinkHeaderValue( new Uri( "http://tempuri.org" ), "sunset" ) ) );`
	`69`	`+ new LinkHeaderValue( new Uri( "http://tempuri.org" ), "deprecation" ) ) );`
`70`	`70`	`}`
`71`	`71`	`}`