Fix FakeTimeProvider namespace, add readme

src/Libraries/Microsoft.Extensions.TimeProvider.Testing/FakeTimeProvider.cs

@@ -8,12 +8,12 @@
 using System.Threading;
 using Microsoft.Shared.Diagnostics;
 
-namespace Microsoft.Extensions.Time.Testing;
+namespace Microsoft.Extensions.TimeProvider.Testing;
 
 /// <summary>
 /// Represents a synthetic time provider that can be used to enable deterministic behavior in tests.
 /// </summary>
-public class FakeTimeProvider : TimeProvider
+public class FakeTimeProvider : System.TimeProvider
 {
     internal readonly HashSet<Waiter> Waiters = new();
     private DateTimeOffset _now = new(2000, 1, 1, 0, 0, 0, 0, TimeSpan.Zero);
@@ -111,7 +111,7 @@ public void SetUtcNow(DateTimeOffset value)
     /// <param name="delta">The amount of time to advance the clock by.</param>
     /// <remarks>
     /// Advancing time affects the timers created from this provider, and all other operations that are directly or
-    /// indirectly using this provider as a time source. Whereas when using <see cref="TimeProvider.System"/>, time
+    /// indirectly using this provider as a time source. Whereas when using <see cref="System.TimeProvider.System"/>, time
     /// marches forward automatically in hardware, for the fake time provider the application is responsible for
     /// doing this explicitly by calling this method.
     /// </remarks>

src/Libraries/Microsoft.Extensions.TimeProvider.Testing/Microsoft.Extensions.TimeProvider.Testing.json

@@ -2,64 +2,64 @@
   "Name": "Microsoft.Extensions.TimeProvider.Testing, Version=8.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35",
   "Types": [
     {
-      "Type": "class Microsoft.Extensions.Time.Testing.FakeTimeProvider : System.TimeProvider",
+      "Type": "class Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider : System.TimeProvider",
       "Stage": "Stable",
       "Methods": [
         {
-          "Member": "Microsoft.Extensions.Time.Testing.FakeTimeProvider.FakeTimeProvider();",
+          "Member": "Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.FakeTimeProvider();",
           "Stage": "Stable"
         },
         {
-          "Member": "Microsoft.Extensions.Time.Testing.FakeTimeProvider.FakeTimeProvider(System.DateTimeOffset startDateTime);",
+          "Member": "Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.FakeTimeProvider(System.DateTimeOffset startDateTime);",
           "Stage": "Stable"
         },
         {
-          "Member": "void Microsoft.Extensions.Time.Testing.FakeTimeProvider.Advance(System.TimeSpan delta);",
+          "Member": "void Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.Advance(System.TimeSpan delta);",
           "Stage": "Stable"
         },
         {
-          "Member": "override System.Threading.ITimer Microsoft.Extensions.Time.Testing.FakeTimeProvider.CreateTimer(System.Threading.TimerCallback callback, object? state, System.TimeSpan dueTime, System.TimeSpan period);",
+          "Member": "override System.Threading.ITimer Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.CreateTimer(System.Threading.TimerCallback callback, object? state, System.TimeSpan dueTime, System.TimeSpan period);",
           "Stage": "Stable"
         },
         {
-          "Member": "override long Microsoft.Extensions.Time.Testing.FakeTimeProvider.GetTimestamp();",
+          "Member": "override long Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.GetTimestamp();",
           "Stage": "Stable"
         },
         {
-          "Member": "override System.DateTimeOffset Microsoft.Extensions.Time.Testing.FakeTimeProvider.GetUtcNow();",
+          "Member": "override System.DateTimeOffset Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.GetUtcNow();",
           "Stage": "Stable"
         },
         {
-          "Member": "void Microsoft.Extensions.Time.Testing.FakeTimeProvider.SetLocalTimeZone(System.TimeZoneInfo localTimeZone);",
+          "Member": "void Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.SetLocalTimeZone(System.TimeZoneInfo localTimeZone);",
           "Stage": "Stable"
         },
         {
-          "Member": "void Microsoft.Extensions.Time.Testing.FakeTimeProvider.SetUtcNow(System.DateTimeOffset value);",
+          "Member": "void Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.SetUtcNow(System.DateTimeOffset value);",
           "Stage": "Stable"
         },
         {
-          "Member": "override string Microsoft.Extensions.Time.Testing.FakeTimeProvider.ToString();",
+          "Member": "override string Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.ToString();",
           "Stage": "Stable"
         }
       ],
       "Properties": [
         {
-          "Member": "System.TimeSpan Microsoft.Extensions.Time.Testing.FakeTimeProvider.AutoAdvanceAmount { get; set; }",
+          "Member": "System.TimeSpan Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.AutoAdvanceAmount { get; set; }",
           "Stage": "Stable"
         },
         {
-          "Member": "override System.TimeZoneInfo Microsoft.Extensions.Time.Testing.FakeTimeProvider.LocalTimeZone { get; }",
+          "Member": "override System.TimeZoneInfo Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.LocalTimeZone { get; }",
           "Stage": "Stable"
         },
         {
-          "Member": "System.DateTimeOffset Microsoft.Extensions.Time.Testing.FakeTimeProvider.Start { get; }",
+          "Member": "System.DateTimeOffset Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.Start { get; }",
           "Stage": "Stable"
         },
         {
-          "Member": "override long Microsoft.Extensions.Time.Testing.FakeTimeProvider.TimestampFrequency { get; }",
+          "Member": "override long Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.TimestampFrequency { get; }",
           "Stage": "Stable"
         }
       ]
     }
   ]
-}
+}

src/Libraries/Microsoft.Extensions.TimeProvider.Testing/README.md

@@ -1 +1,47 @@
-README
+# Microsoft.Extensions.TimeProvider.Testing
+
+Provides a `FakeTimeProvider` for testing components that depend on `System.TimeProvider`.
+
+## Install the package
+
+From the command-line:
+
+```dotnetcli
+dotnet add package Microsoft.Extensions.TimeProvider.Testing
+```
+
+Or directly in the C# project file:
+
+```xml
+<ItemGroup>
+  <PackageReference Include="Microsoft.Extensions.TimeProvider.Testing" Version="[CURRENTVERSION]" />
+</ItemGroup>
+```
+
+## FakeTimeProvider
+
+`FakeTimeProvider` can be used to manually adjust time to test time dependent components in a deterministic way.
+
+`FakeTimeProvider` derives from TimeProvider and adds the following APIs:
+
+```csharp
+public FakeTimeProvider(DateTimeOffset startDateTime)
+public DateTimeOffset Start { get; }
+public TimeSpan AutoAdvanceAmount
+public void SetUtcNow(DateTimeOffset value)
+public void Advance(TimeSpan delta)
+public void SetLocalTimeZone(TimeZoneInfo localTimeZone)
+```
+
+For example:
+
+```csharp
+var timeProvider = new FakeTimeProvider();
+var myComponent = new MyComponent(timeProvider);
+timeProvider.Advance(TimeSpan.FromSeconds(5));
+myComponent.CheckState();
+```
+
+## Feedback & Contributing
+
+For any feedback or contributions, please visit us in [our GitHub repo](https://github.com/dotnet/extensions).

src/Libraries/Microsoft.Extensions.TimeProvider.Testing/Timer.cs

@@ -6,7 +6,7 @@
 using System.Threading.Tasks;
 using Microsoft.Shared.Diagnostics;
 
-namespace Microsoft.Extensions.Time.Testing;
+namespace Microsoft.Extensions.TimeProvider.Testing;
 
 // This implements the timer abstractions and is a thin wrapper around a waiter object.
 // The main role of this type is to create the waiter, add it to the waiter list, and ensure it gets

src/Libraries/Microsoft.Extensions.TimeProvider.Testing/Waiter.cs

@@ -3,7 +3,7 @@
 
 using System.Threading;
 
-namespace Microsoft.Extensions.Time.Testing;
+namespace Microsoft.Extensions.TimeProvider.Testing;
 
 // We keep all timer state here in order to prevent Timer instances from being self-referential,
 // which would block them being collected when someone forgets to call Dispose on the timer. With

test/Analyzers/Microsoft.Analyzers.Local.Tests/ApiLifecycle/ApiLifecycleAnalyzerTest.cs

@@ -792,9 +792,9 @@ public class InnerType
                 using System;
                 using System.Threading;
 
-                namespace Microsoft.Extensions.Time.Testing;
+                namespace Microsoft.Extensions.TimeProvider.Testing;
 
-                public class FakeTimeProvider : TimeProvider
+                public class FakeTimeProvider : System.TimeProvider
                 {
                     public FakeTimeProvider() { }
                     public FakeTimeProvider(DateTimeOffset startDateTime) { }

test/Analyzers/Microsoft.Analyzers.Local.Tests/ApiLifecycle/Data/Microsoft.Extensions.TimeProvider.Testing.json

@@ -2,64 +2,64 @@
   "Name": "Microsoft.Extensions.TimeProvider.Testing, Version=8.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35",
   "Types": [
     {
-      "Type": "class Microsoft.Extensions.Time.Testing.FakeTimeProvider : System.TimeProvider",
+      "Type": "class Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider : System.TimeProvider",
       "Stage": "Experimental",
       "Methods": [
         {
-          "Member": "Microsoft.Extensions.Time.Testing.FakeTimeProvider.FakeTimeProvider();",
+          "Member": "Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.FakeTimeProvider();",
           "Stage": "Experimental"
         },
         {
-          "Member": "Microsoft.Extensions.Time.Testing.FakeTimeProvider.FakeTimeProvider(System.DateTimeOffset startDateTime);",
+          "Member": "Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.FakeTimeProvider(System.DateTimeOffset startDateTime);",
           "Stage": "Experimental"
         },
         {
-          "Member": "void Microsoft.Extensions.Time.Testing.FakeTimeProvider.Advance(System.TimeSpan delta);",
+          "Member": "void Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.Advance(System.TimeSpan delta);",
           "Stage": "Experimental"
         },
         {
-          "Member": "override System.Threading.ITimer Microsoft.Extensions.Time.Testing.FakeTimeProvider.CreateTimer(System.Threading.TimerCallback callback, object? state, System.TimeSpan dueTime, System.TimeSpan period);",
+          "Member": "override System.Threading.ITimer Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.CreateTimer(System.Threading.TimerCallback callback, object? state, System.TimeSpan dueTime, System.TimeSpan period);",
           "Stage": "Experimental"
         },
         {
-          "Member": "override long Microsoft.Extensions.Time.Testing.FakeTimeProvider.GetTimestamp();",
+          "Member": "override long Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.GetTimestamp();",
           "Stage": "Experimental"
         },
         {
-          "Member": "override System.DateTimeOffset Microsoft.Extensions.Time.Testing.FakeTimeProvider.GetUtcNow();",
+          "Member": "override System.DateTimeOffset Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.GetUtcNow();",
           "Stage": "Experimental"
         },
         {
-          "Member": "void Microsoft.Extensions.Time.Testing.FakeTimeProvider.SetLocalTimeZone(System.TimeZoneInfo localTimeZone);",
+          "Member": "void Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.SetLocalTimeZone(System.TimeZoneInfo localTimeZone);",
           "Stage": "Experimental"
         },
         {
-          "Member": "void Microsoft.Extensions.Time.Testing.FakeTimeProvider.SetUtcNow(System.DateTimeOffset value);",
+          "Member": "void Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.SetUtcNow(System.DateTimeOffset value);",
           "Stage": "Experimental"
         },
         {
-          "Member": "override string Microsoft.Extensions.Time.Testing.FakeTimeProvider.ToString();",
+          "Member": "override string Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.ToString();",
           "Stage": "Experimental"
         }
       ],
       "Properties": [
         {
-          "Member": "System.TimeSpan Microsoft.Extensions.Time.Testing.FakeTimeProvider.AutoAdvanceAmount { get; set; }",
+          "Member": "System.TimeSpan Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.AutoAdvanceAmount { get; set; }",
           "Stage": "Experimental"
         },
         {
-          "Member": "override System.TimeZoneInfo Microsoft.Extensions.Time.Testing.FakeTimeProvider.LocalTimeZone { get; }",
+          "Member": "override System.TimeZoneInfo Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.LocalTimeZone { get; }",
           "Stage": "Experimental"
         },
         {
-          "Member": "System.DateTimeOffset Microsoft.Extensions.Time.Testing.FakeTimeProvider.Start { get; }",
+          "Member": "System.DateTimeOffset Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.Start { get; }",
           "Stage": "Experimental"
         },
         {
-          "Member": "override long Microsoft.Extensions.Time.Testing.FakeTimeProvider.TimestampFrequency { get; }",
+          "Member": "override long Microsoft.Extensions.TimeProvider.Testing.FakeTimeProvider.TimestampFrequency { get; }",
           "Stage": "Experimental"
         }
       ]
     }
   ]
-}
+}

test/Libraries/Microsoft.AspNetCore.Diagnostics.Middleware.Tests/Logging/AcceptanceTests.cs

@@ -24,7 +24,7 @@
 using Microsoft.Extensions.Http.Diagnostics;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Testing;
-using Microsoft.Extensions.Time.Testing;
+using Microsoft.Extensions.TimeProvider.Testing;
 using Microsoft.Net.Http.Headers;
 using Microsoft.Shared.Text;
 using Xunit;

test/Libraries/Microsoft.AspNetCore.Diagnostics.Middleware.Tests/Logging/ApiRoutingController.cs

@@ -9,7 +9,7 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Compliance.Testing;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Extensions.Time.Testing;
+using Microsoft.Extensions.TimeProvider.Testing;
 
 namespace Microsoft.AspNetCore.Diagnostics.Logging.Test.Controllers;
 

test/Libraries/Microsoft.Extensions.Diagnostics.Probes.Tests/TcpEndpointHealthCheckServiceTests.cs

@@ -7,7 +7,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging.Testing;
-using Microsoft.Extensions.Time.Testing;
+using Microsoft.Extensions.TimeProvider.Testing;
 using Xunit;
 
 namespace Microsoft.Extensions.Diagnostics.Probes.Test;

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/CalculatorTests.cs

@@ -2,7 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
-using Microsoft.Extensions.Time.Testing;
+using Microsoft.Extensions.TimeProvider.Testing;
 using Xunit;
 
 namespace Microsoft.Extensions.Diagnostics.ResourceMonitoring.Test;

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/Helpers/DummyProvider.cs

@@ -2,7 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
-using Microsoft.Extensions.Time.Testing;
+using Microsoft.Extensions.TimeProvider.Testing;
 
 namespace Microsoft.Extensions.Diagnostics.ResourceMonitoring.Test.Helpers;
 

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/Linux/AcceptanceTest.cs

@@ -13,7 +13,7 @@
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Hosting.Testing;
 using Microsoft.Extensions.Options;
-using Microsoft.Extensions.Time.Testing;
+using Microsoft.Extensions.TimeProvider.Testing;
 using Microsoft.TestUtilities;
 using Xunit;
 
@@ -180,7 +180,7 @@ public Task ResourceUtilizationTracker_Reports_The_Same_Values_As_One_Can_Observ
 
         using var host = FakeHost.CreateBuilder().ConfigureServices(x =>
             x.AddLogging()
-            .AddSingleton<TimeProvider>(clock)
+            .AddSingleton<System.TimeProvider>(clock)
             .AddSingleton<IUserHz>(new FakeUserHz(100))
             .AddSingleton<IFileSystem>(fileSystem)
             .AddSingleton<IResourceUtilizationPublisher>(new GenericPublisher(_ => e.Set()))

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/Linux/LinuxCountersTests.cs

@@ -38,7 +38,7 @@ public void LinuxCounters_Registers_Instruments()
         });
 
         var parser = new LinuxUtilizationParser(fileSystem: fileSystem, new FakeUserHz(100));
-        var provider = new LinuxUtilizationProvider(options, parser, meterFactoryMock.Object, TimeProvider.System);
+        var provider = new LinuxUtilizationProvider(options, parser, meterFactoryMock.Object, System.TimeProvider.System);
 
         using var listener = new MeterListener
         {

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/Providers/ConditionallyFaultProvider.cs

@@ -2,7 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
-using Microsoft.Extensions.Time.Testing;
+using Microsoft.Extensions.TimeProvider.Testing;
 
 namespace Microsoft.Extensions.Diagnostics.ResourceMonitoring.Test.Providers;
 

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/Providers/FakeProvider.cs

@@ -2,7 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
-using Microsoft.Extensions.Time.Testing;
+using Microsoft.Extensions.TimeProvider.Testing;
 
 namespace Microsoft.Extensions.Diagnostics.ResourceMonitoring.Test.Providers;
 

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/Providers/FaultProvider.cs

@@ -2,7 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
-using Microsoft.Extensions.Time.Testing;
+using Microsoft.Extensions.TimeProvider.Testing;
 
 namespace Microsoft.Extensions.Diagnostics.ResourceMonitoring.Test.Providers;
 

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/ResourceMonitoringExtensionsTests.cs

@@ -33,7 +33,7 @@ public void AddResourceUtilization_AddsResourceMonitoringService_ToServicesColle
     {
         using var provider = new ServiceCollection()
             .AddLogging()
-            .AddSingleton<TimeProvider>(TimeProvider.System)
+            .AddSingleton<System.TimeProvider>(System.TimeProvider.System)
             .AddResourceMonitoring(builder =>
             {
                 builder.Services.AddSingleton<ISnapshotProvider, FakeProvider>();
@@ -53,7 +53,7 @@ public void AddResourceUtilization_AddsResourceMonitoringService_ToServicesColle
     {
         using var provider = new ServiceCollection()
             .AddLogging()
-            .AddSingleton<TimeProvider>(TimeProvider.System)
+            .AddSingleton<System.TimeProvider>(System.TimeProvider.System)
             .AddResourceMonitoring()
             .BuildServiceProvider();
 
@@ -69,7 +69,7 @@ public void AddResourceUtilization_AddsResourceMonitoringService_AsHostedService
     {
         using var provider = new ServiceCollection()
             .AddLogging()
-            .AddSingleton<TimeProvider>(TimeProvider.System)
+            .AddSingleton<System.TimeProvider>(System.TimeProvider.System)
             .AddResourceMonitoring(builder =>
             {
                 builder.Services.AddSingleton<ISnapshotProvider, FakeProvider>();
@@ -93,7 +93,7 @@ public void ConfigureResourceUtilization_InitializeTrackerProperly()
             {
                 services.AddResourceMonitoring(builder =>
                 {
-                    builder.Services.AddSingleton<TimeProvider>(TimeProvider.System);
+                    builder.Services.AddSingleton<System.TimeProvider>(System.TimeProvider.System);
                     builder.Services.AddSingleton<ISnapshotProvider, FakeProvider>();
                     builder.AddPublisher<EmptyPublisher>();
                 });