fix flaky HeartbeatEndpointSettingsSyncHostedService tests by polling instead of fixed delay

src/Directory.Packages.props

@@ -106,6 +106,7 @@
     <PackageVersion Include="System.Threading.RateLimiting" Version="$(RuntimeFrameworkVersion)" />
     <PackageVersion Include="Microsoft.Data.SqlClient" Version="7.0.2" />
     <PackageVersion Include="Azure.Core" Version="1.60.0" />
+    <PackageVersion Include="SSH.NET" Version="2026.0.0" />
   </ItemGroup>
   <ItemGroup>
     <GlobalPackageReference Include="Microsoft.Build.Artifacts" Version="6.1.63" />

src/Particular.LicensingComponent.UnitTests/.editorconfig

@@ -6,7 +6,4 @@ dotnet_diagnostic.CA2007.severity = none
 # Cancellation analyzer debt. These fire because Particular.Analyzers is no longer pinned to 0.9.0.
 # They are scheduled work, not accepted exceptions: remove a line once this project has no
 # violations of that rule left, and never add a rule back to this list.
-dotnet_diagnostic.PS0003.severity = none
-dotnet_diagnostic.PS0006.severity = none
-dotnet_diagnostic.PS0017.severity = none
 dotnet_diagnostic.PS0018.severity = none

src/Particular.LicensingComponent.UnitTests/AuditQuery_Tests.cs

@@ -34,7 +34,7 @@ public async Task Should_return_known_endpoints_if_any()
         var auditQuery = new AuditQuery(NullLogger<AuditQuery>.Instance, new EndpointsApi_ReturningTwoEndpoints(), new FakeAuditCountApi(), new FakeConfigurationApi());
 
         //Act
-        var endpoints = (await auditQuery.GetKnownEndpoints(default)).ToList();
+        var endpoints = (await auditQuery.GetKnownEndpoints()).ToList();
 
         //Assert
         Assert.That(endpoints, Is.Not.Null, "Endpoints should be found");
@@ -53,7 +53,7 @@ public async Task Should_return_audit_remotes()
         var auditQuery = new AuditQuery(NullLogger<AuditQuery>.Instance, new FakeEndpointApi(), new FakeAuditCountApi(), new ConfigurationApi_ReturningOneValidAuditConfig());
 
         //Act
-        var remotes = await auditQuery.GetAuditRemotes(default);
+        var remotes = await auditQuery.GetAuditRemotes();
 
         //Assert
         Assert.That(remotes, Is.Not.Null, "Remotes should be found");
@@ -81,7 +81,7 @@ public async Task Should_return_successful_audit_connection_if_instances_exist_a
         var auditQuery = new AuditQuery(NullLogger<AuditQuery>.Instance, new FakeEndpointApi(), new FakeAuditCountApi(), new ConfigurationApi_ReturningOneValidAuditConfig());
 
         //Act
-        var connectionSettingsResult = await auditQuery.TestAuditConnection(default);
+        var connectionSettingsResult = await auditQuery.TestAuditConnection();
 
         //Assert
         Assert.That(connectionSettingsResult, Is.Not.Null, "connectionSettingsResult should be returned");
@@ -103,7 +103,7 @@ public async Task Should_return_diagnostics_and_no_errors_when_no_remotes_define
         var auditQuery = new AuditQuery(NullLogger<AuditQuery>.Instance, new FakeEndpointApi(), new FakeAuditCountApi(), confiApi);
 
         //Act
-        var connectionSettingsResult = await auditQuery.TestAuditConnection(default);
+        var connectionSettingsResult = await auditQuery.TestAuditConnection();
 
         //Assert
         Assert.That(connectionSettingsResult, Is.Not.Null, "connectionSettingsResult should be returned");
@@ -128,7 +128,7 @@ public async Task Should_always_return_diagnostics_and_relevant_errors_when_inva
         var auditQuery = new AuditQuery(NullLogger<AuditQuery>.Instance, new FakeEndpointApi(), new FakeAuditCountApi(), confiApi);
 
         //Act
-        var connectionSettingsResult = await auditQuery.TestAuditConnection(default);
+        var connectionSettingsResult = await auditQuery.TestAuditConnection();
 
         //Assert
         Assert.That(connectionSettingsResult, Is.Not.Null, "connectionSettingsResult should be returned");
@@ -148,15 +148,15 @@ public async Task Should_return_correct_audit_count()
         var auditQuery = new AuditQuery(NullLogger<AuditQuery>.Instance, new FakeEndpointApi(), new AuditCountApi_ReturningThreeAuditCounts(), new FakeConfigurationApi());
 
         //Act
-        var auditCount = await auditQuery.GetAuditCountForEndpoint("Endpoint1", default);
+        var auditCount = await auditQuery.GetAuditCountForEndpoint("Endpoint1");
 
         Assert.That(auditCount, Is.Not.Null, "AuditCount should be returned");
         Assert.That(auditCount.Count, Is.EqualTo(3), "Invalid number of audit counts");
     }
 
     class ConfigurationApi_ReturningOneValidAuditConfig : IConfigurationApi
     {
-        public Task<object> GetConfig(CancellationToken cancellationToken) => throw new NotImplementedException();
+        public Task<object> GetConfig(CancellationToken cancellationToken = default) => throw new NotImplementedException();
 
         public Task<RemoteConfiguration[]> GetRemoteConfigs(CancellationToken cancellationToken = default)
         {
@@ -165,12 +165,12 @@ public Task<RemoteConfiguration[]> GetRemoteConfigs(CancellationToken cancellati
             return Task.FromResult<RemoteConfiguration[]>([remote]);
         }
 
-        public Task<RootUrls> GetUrls(string baseUrl, CancellationToken cancellationToken) => throw new NotImplementedException();
+        public Task<RootUrls> GetUrls(string baseUrl, CancellationToken cancellationToken = default) => throw new NotImplementedException();
     }
 
     class ConfigurationApi_Configurable : IConfigurationApi
     {
-        public Task<object> GetConfig(CancellationToken cancellationToken) => throw new NotImplementedException();
+        public Task<object> GetConfig(CancellationToken cancellationToken = default) => throw new NotImplementedException();
 
         public Task<RemoteConfiguration[]> GetRemoteConfigs(CancellationToken cancellationToken = default)
         {
@@ -184,7 +184,7 @@ public Task<RemoteConfiguration[]> GetRemoteConfigs(CancellationToken cancellati
             return Task.FromResult<RemoteConfiguration[]>([remote]);
         }
 
-        public Task<RootUrls> GetUrls(string baseUrl, CancellationToken cancellationToken) => throw new NotImplementedException();
+        public Task<RootUrls> GetUrls(string baseUrl, CancellationToken cancellationToken = default) => throw new NotImplementedException();
 
         public bool ReturnAuditConfig { get; set; }
         public string RemoteStatus { get; set; }
@@ -194,7 +194,7 @@ public Task<RemoteConfiguration[]> GetRemoteConfigs(CancellationToken cancellati
 
     class EndpointsApi_ReturningTwoEndpoints : IEndpointsApi
     {
-        public Task<List<Endpoint>> GetEndpoints(CancellationToken cancellationToken)
+        public Task<List<Endpoint>> GetEndpoints(CancellationToken cancellationToken = default)
         {
             return Task.FromResult<List<Endpoint>>([
                 new Endpoint { Id = Guid.NewGuid(), Name = "Endpoint1" },
@@ -206,7 +206,7 @@ public Task<List<Endpoint>> GetEndpoints(CancellationToken cancellationToken)
 
     class AuditCountApi_ReturningThreeAuditCounts : IAuditCountApi
     {
-        public async Task<IList<AuditCount>> GetEndpointAuditCounts(string endpoint, CancellationToken cancellationToken)
+        public async Task<IList<AuditCount>> GetEndpointAuditCounts(string endpoint, CancellationToken cancellationToken = default)
         {
             var auditCounts = new List<AuditCount>
             {

src/Particular.LicensingComponent.UnitTests/AuditThroughputCollectorHostedService_Tests.cs

@@ -133,7 +133,7 @@ await Task.Run(async () =>
             } while (!token.IsCancellationRequested);
         });
 
-        Endpoint foundEndpoint = await DataStore.GetEndpoint(endpointName, ThroughputSource.Audit, default);
+        Endpoint foundEndpoint = await DataStore.GetEndpoint(endpointName, ThroughputSource.Audit);
 
         //Assert
         Assert.That(foundEndpoint, Is.Not.Null, $"Expected endpoint {endpointName} not found.");
@@ -181,9 +181,9 @@ await Task.Run(async () =>
         });
         await auditThroughputCollectorHostedService.StopAsync(token2);
 
-        Endpoint foundEndpoint = await DataStore.GetEndpoint(endpointName, ThroughputSource.Audit, default);
+        Endpoint foundEndpoint = await DataStore.GetEndpoint(endpointName, ThroughputSource.Audit);
         IDictionary<string, IEnumerable<ThroughputData>> foundEndpointThroughput =
-            await DataStore.GetEndpointThroughputByQueueName([endpointName], default);
+            await DataStore.GetEndpointThroughputByQueueName([endpointName]);
         ThroughputData[] throughputData = foundEndpointThroughput[endpointName].ToArray();
 
         // Assert
@@ -210,19 +210,19 @@ class AuditQuery_NoAuditRemotes : IAuditQuery
         public Func<RemoteInstanceInformation, bool> ValidRemoteInstances => r => true;
 
         public Task<IEnumerable<AuditCount>> GetAuditCountForEndpoint(string endpointUrlName,
-            CancellationToken cancellationToken) => Task.FromResult<IEnumerable<AuditCount>>([]);
+            CancellationToken cancellationToken = default) => Task.FromResult<IEnumerable<AuditCount>>([]);
 
-        public Task<List<RemoteInstanceInformation>> GetAuditRemotes(CancellationToken cancellationToken) =>
+        public Task<List<RemoteInstanceInformation>> GetAuditRemotes(CancellationToken cancellationToken = default) =>
             Task.FromResult<List<RemoteInstanceInformation>>([]);
 
-        public Task<IEnumerable<ServiceControlEndpoint>> GetKnownEndpoints(CancellationToken cancellationToken)
+        public Task<IEnumerable<ServiceControlEndpoint>> GetKnownEndpoints(CancellationToken cancellationToken = default)
         {
             InstanceParameter = true;
 
             return Task.FromResult<IEnumerable<ServiceControlEndpoint>>([]);
         }
 
-        public Task<ConnectionSettingsTestResult> TestAuditConnection(CancellationToken cancellationToken) =>
+        public Task<ConnectionSettingsTestResult> TestAuditConnection(CancellationToken cancellationToken = default) =>
             Task.FromResult(
                 new ConnectionSettingsTestResult { ConnectionSuccessful = true, ConnectionErrorMessages = [] });
 
@@ -243,23 +243,23 @@ public AuditQuery_WithOneEndpoint(string endpointName, long throughputCount, Dat
         public Func<RemoteInstanceInformation, bool> ValidRemoteInstances => r => true;
 
         public Task<IEnumerable<AuditCount>> GetAuditCountForEndpoint(string endpointUrlName,
-            CancellationToken cancellationToken)
+            CancellationToken cancellationToken = default)
         {
             var auditCount = new AuditCount { UtcDate = ThroughputDate, Count = ThroughputCount };
 
             return Task.FromResult(new List<AuditCount> { auditCount }.AsEnumerable());
         }
 
-        public Task<List<RemoteInstanceInformation>> GetAuditRemotes(CancellationToken cancellationToken) =>
+        public Task<List<RemoteInstanceInformation>> GetAuditRemotes(CancellationToken cancellationToken = default) =>
             Task.FromResult<List<RemoteInstanceInformation>>([]);
 
-        public Task<IEnumerable<ServiceControlEndpoint>> GetKnownEndpoints(CancellationToken cancellationToken)
+        public Task<IEnumerable<ServiceControlEndpoint>> GetKnownEndpoints(CancellationToken cancellationToken = default)
         {
             var scEndpoint = new ServiceControlEndpoint { Name = EndpointName, HeartbeatsEnabled = true };
             return Task.FromResult<IEnumerable<ServiceControlEndpoint>>([scEndpoint]);
         }
 
-        public Task<ConnectionSettingsTestResult> TestAuditConnection(CancellationToken cancellationToken) =>
+        public Task<ConnectionSettingsTestResult> TestAuditConnection(CancellationToken cancellationToken = default) =>
             Task.FromResult(
                 new ConnectionSettingsTestResult { ConnectionSuccessful = true, ConnectionErrorMessages = [] });
 
@@ -275,19 +275,19 @@ class AuditQuery_ThrowingAnExceptionOnKnownEndpointsCall : IAuditQuery
         public Func<RemoteInstanceInformation, bool> ValidRemoteInstances => r => true;
 
         public Task<IEnumerable<AuditCount>> GetAuditCountForEndpoint(string endpointUrlName,
-            CancellationToken cancellationToken) => throw new NotImplementedException();
+            CancellationToken cancellationToken = default) => throw new NotImplementedException();
 
-        public Task<List<RemoteInstanceInformation>> GetAuditRemotes(CancellationToken cancellationToken) =>
+        public Task<List<RemoteInstanceInformation>> GetAuditRemotes(CancellationToken cancellationToken = default) =>
             Task.FromResult<List<RemoteInstanceInformation>>([]);
 
-        public Task<IEnumerable<ServiceControlEndpoint>> GetKnownEndpoints(CancellationToken cancellationToken)
+        public Task<IEnumerable<ServiceControlEndpoint>> GetKnownEndpoints(CancellationToken cancellationToken = default)
         {
             InstanceParameter = true;
 
             throw new Exception("Oops");
         }
 
-        public Task<ConnectionSettingsTestResult> TestAuditConnection(CancellationToken cancellationToken) =>
+        public Task<ConnectionSettingsTestResult> TestAuditConnection(CancellationToken cancellationToken = default) =>
             throw new NotImplementedException();
 
         public bool InstanceParameter { get; set; }
@@ -303,17 +303,17 @@ class BrokerThroughputQuery_WithSanitization : IBrokerThroughputQuery
 
         public KeyDescriptionPair[] Settings => throw new NotImplementedException();
 
-        public IAsyncEnumerable<IBrokerQueue> GetQueueNames(CancellationToken cancellationToken) =>
+        public IAsyncEnumerable<IBrokerQueue> GetQueueNames(CancellationToken cancellationToken = default) =>
             throw new NotImplementedException();
 
         public IAsyncEnumerable<QueueThroughput> GetThroughputPerDay(IBrokerQueue brokerQueue, DateOnly startDate,
-            CancellationToken cancellationToken) => throw new NotImplementedException();
+            CancellationToken cancellationToken = default) => throw new NotImplementedException();
 
         public bool HasInitialisationErrors(out string errorMessage) => throw new NotImplementedException();
         public void Initialize(ReadOnlyDictionary<string, string> settings) => throw new NotImplementedException();
 
         public Task<(bool Success, List<string> Errors, string Diagnostics)> TestConnection(
-            CancellationToken cancellationToken) => throw new NotImplementedException();
+            CancellationToken cancellationToken = default) => throw new NotImplementedException();
 
         public string SanitizeEndpointName(string endpointName)
         {

src/Particular.LicensingComponent.UnitTests/BrokerThroughputCollectorHostedServiceTests.cs

@@ -138,7 +138,7 @@ public void Initialize(ReadOnlyDictionary<string, string> settings)
         }
 
         public async IAsyncEnumerable<QueueThroughput> GetThroughputPerDay(IBrokerQueue brokerQueue, DateOnly startDate,
-            [EnumeratorCancellation] CancellationToken cancellationToken)
+            [EnumeratorCancellation] CancellationToken cancellationToken = default)
         {
             GetGetThroughputPerDay++;
 
@@ -148,7 +148,7 @@ public async IAsyncEnumerable<QueueThroughput> GetThroughputPerDay(IBrokerQueue
         }
 
         public async IAsyncEnumerable<IBrokerQueue> GetQueueNames(
-            [EnumeratorCancellation] CancellationToken cancellationToken)
+            [EnumeratorCancellation] CancellationToken cancellationToken = default)
         {
             if (GetQueueNamesCalls++ % 2 == 0)
             {
@@ -168,7 +168,7 @@ public async IAsyncEnumerable<IBrokerQueue> GetQueueNames(
         public KeyDescriptionPair[] Settings { get; } = [];
 
         public Task<(bool Success, List<string> Errors, string Diagnostics)> TestConnection(
-            CancellationToken cancellationToken) => throw new NotImplementedException();
+            CancellationToken cancellationToken = default) => throw new NotImplementedException();
 
         public string SanitizeEndpointName(string endpointName) => endpointName;
         public string SanitizedEndpointNameCleanser(string endpointName) => endpointName;
@@ -187,15 +187,15 @@ public void Initialize(ReadOnlyDictionary<string, string> settings)
         }
 
         public async IAsyncEnumerable<QueueThroughput> GetThroughputPerDay(IBrokerQueue brokerQueue, DateOnly startDate,
-            [EnumeratorCancellation] CancellationToken cancellationToken)
+            [EnumeratorCancellation] CancellationToken cancellationToken = default)
         {
             await Task.CompletedTask;
 
             yield break;
         }
 
         public async IAsyncEnumerable<IBrokerQueue> GetQueueNames(
-            [EnumeratorCancellation] CancellationToken cancellationToken)
+            [EnumeratorCancellation] CancellationToken cancellationToken = default)
         {
             yield return new DefaultBrokerQueue("sales@one") { SanitizedName = "sales" };
             yield return new DefaultBrokerQueue("sales@two") { SanitizedName = "sales" };
@@ -211,7 +211,7 @@ public async IAsyncEnumerable<IBrokerQueue> GetQueueNames(
         public KeyDescriptionPair[] Settings { get; } = [];
 
         public Task<(bool Success, List<string> Errors, string Diagnostics)> TestConnection(
-            CancellationToken cancellationToken) => throw new NotImplementedException();
+            CancellationToken cancellationToken = default) => throw new NotImplementedException();
 
         public string SanitizeEndpointName(string endpointName) => endpointName;
         public string SanitizedEndpointNameCleanser(string endpointName) => endpointName;
@@ -232,7 +232,7 @@ public void Initialize(ReadOnlyDictionary<string, string> settings)
         }
 
         public async IAsyncEnumerable<QueueThroughput> GetThroughputPerDay(IBrokerQueue brokerQueue, DateOnly startDate,
-            [EnumeratorCancellation] CancellationToken cancellationToken)
+            [EnumeratorCancellation] CancellationToken cancellationToken = default)
         {
             await Task.CompletedTask;
 
@@ -242,7 +242,7 @@ public async IAsyncEnumerable<QueueThroughput> GetThroughputPerDay(IBrokerQueue
         }
 
         public async IAsyncEnumerable<IBrokerQueue> GetQueueNames(
-            [EnumeratorCancellation] CancellationToken cancellationToken)
+            [EnumeratorCancellation] CancellationToken cancellationToken = default)
         {
             yield return new DefaultBrokerQueue("marketing");
             yield return new DefaultBrokerQueue("customer");
@@ -256,7 +256,7 @@ public async IAsyncEnumerable<IBrokerQueue> GetQueueNames(
         public KeyDescriptionPair[] Settings { get; } = [];
 
         public Task<(bool Success, List<string> Errors, string Diagnostics)> TestConnection(
-            CancellationToken cancellationToken) => throw new NotImplementedException();
+            CancellationToken cancellationToken = default) => throw new NotImplementedException();
 
         public string SanitizeEndpointName(string endpointName) => endpointName;
         public string SanitizedEndpointNameCleanser(string endpointName) => endpointName;

src/Particular.LicensingComponent.UnitTests/Infrastructure/DataStoreBuilder.cs

@@ -3,6 +3,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using Contracts;
 using Persistence;
@@ -122,7 +123,7 @@ public async Task Build()
     {
         foreach (Endpoint endpoint in endpoints)
         {
-            await store.SaveEndpoint(endpoint, default);
+            await store.SaveEndpoint(endpoint);
         }
 
         ;
@@ -132,7 +133,7 @@ public async Task Build()
             foreach (ThroughputData throughput in throughputList)
             {
                 await store.RecordEndpointThroughput(endpointId.Name, throughput.ThroughputSource,
-                    throughput.Select(entry => new EndpointDailyThroughput(entry.Key, entry.Value)).ToList(), default);
+                    throughput.Select(entry => new EndpointDailyThroughput(entry.Key, entry.Value)).ToList());
             }
         }
     }

src/Particular.LicensingComponent.UnitTests/Infrastructure/FakeAuditCountApi.cs

@@ -8,6 +8,6 @@
 
     class FakeAuditCountApi : IAuditCountApi
     {
-        public Task<IList<ServiceControl.Api.Contracts.AuditCount>> GetEndpointAuditCounts(string endpoint, CancellationToken cancellationToken) => throw new NotImplementedException();
+        public Task<IList<ServiceControl.Api.Contracts.AuditCount>> GetEndpointAuditCounts(string endpoint, CancellationToken cancellationToken = default) => throw new NotImplementedException();
     }
 }