Add retry for file chunks

.gitignore

@@ -25,6 +25,7 @@ tools/
 # Visual Studio 2015 cache/options directory
 .vs/
 .vscode/
+.idea/
 
 # MSTest test Results
 [Tt]est[Rr]esult*/

Directory.Packages.props

@@ -12,6 +12,7 @@ SPDX-License-Identifier: MPL-2.0
     <PackageVersion Include="C-DEngine" Version="6.104.0" />
     <PackageVersion Include="coverlet.collector" Version="6.0.2" />
     <PackageVersion Include="LiteDB" Version="5.0.21" />
+    <PackageVersion Include="Microsoft.Extensions.Configuration" Version="9.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="9.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Configuration.Binder" Version="9.0.0" />
     <PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="9.0.0" />

REUSE.toml

@@ -0,0 +1,58 @@
+version = 1
+SPDX-PackageName = "Smart Application Framework"
+SPDX-PackageSupplier = "TRUMPF Laser GmbH <support.tls560@trumpf.com>"
+SPDX-PackageDownloadLocation = "https://github.com/TRUMPF-IoT/saf"
+
+[[annotations]]
+path = ".github/**/**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2017-2021 TRUMPF Laser GmbH"
+SPDX-License-Identifier = "MPL-2.0"
+
+[[annotations]]
+path = "**.md"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2017-2021 TRUMPF Laser GmbH"
+SPDX-License-Identifier = "MPL-2.0"
+
+[[annotations]]
+path = "docs/_config.yml"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2017-2021 TRUMPF Laser GmbH"
+SPDX-License-Identifier = "MPL-2.0"
+
+[[annotations]]
+path = "docs/**/**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2017-2021 TRUMPF Laser GmbH"
+SPDX-License-Identifier = "MPL-2.0"
+
+[[annotations]]
+path = "src/**/**.txt"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2017-2021 TRUMPF Laser GmbH"
+SPDX-License-Identifier = "MPL-2.0"
+
+[[annotations]]
+path = "src/**.sln"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2017-2021 TRUMPF Laser GmbH"
+SPDX-License-Identifier = "MPL-2.0"
+
+[[annotations]]
+path = "src/**/**.sln"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2017-2021 TRUMPF Laser GmbH"
+SPDX-License-Identifier = "MPL-2.0"
+
+[[annotations]]
+path = "src/**/**.json"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2017-2021 TRUMPF Laser GmbH"
+SPDX-License-Identifier = "MPL-2.0"
+
+[[annotations]]
+path = "src/**/app.config"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2017-2021 TRUMPF Laser GmbH"
+SPDX-License-Identifier = "MPL-2.0"

src/Toolbox/SAF.Toolbox.Tests/Filetransfer/FileSenderTests.cs

@@ -2,6 +2,7 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 
+using Microsoft.Extensions.Options;
 using NSubstitute;
 using SAF.Common;
 using SAF.Toolbox.FileTransfer;
@@ -15,9 +16,9 @@ public class FileSenderTests
     [Theory]
     [InlineData(1)] // 1 byte
     [InlineData(1024)] // 1 kByte
-    [InlineData(1024 * 3)]  // 3 kByte
+    [InlineData(1024 * 3)] // 3 kByte
     [InlineData(1024 * 1024)] // 1 MByte
-    [InlineData(1024 * 1024 * 3)]  // 3 MByte
+    [InlineData(1024 * 1024 * 3)] // 3 MByte
     [InlineData(FileSender.MaxChunkSize - 1)] // excact chunk size - 1
     [InlineData(FileSender.MaxChunkSize)] // excact chunk size
     [InlineData(FileSender.MaxChunkSize + 1)] // excact chunk size + 1
@@ -30,7 +31,9 @@ public async Task SendInChunksCallsPublishOk(int fileSizeInBytes)
         Action<Message>? senderHandler = null;
         var messaging = Substitute.For<IMessagingInfrastructure>();
         messaging.When(m => m.Subscribe(Arg.Any<string>(), Arg.Any<Action<Message>>()))
-            .Do(args => senderHandler = args.Arg<Action<Message>>());                
+            .Do(args => senderHandler = args.Arg<Action<Message>>());
+        var options = Substitute.For<IOptions<FileSenderConfiguration>>();
+        options.Value.Returns(new FileSenderConfiguration());
 
         var testChannel = $"tests/fileSender/{fileSizeInBytes}";
         var buffer = new byte[fileSizeInBytes];
@@ -43,7 +46,7 @@ public async Task SendInChunksCallsPublishOk(int fileSizeInBytes)
             });
         using (var tempFile = new TemporaryFile($"file{fileSizeInBytes}.tmp", buffer))
         {
-            var fileSender = new FileSender(messaging, null);
+            var fileSender = new FileSender(messaging, null, options);
             var sendResult = await fileSender.SendInChunks(testChannel, tempFile.TempFilePath);
             Assert.Equal(FileTransferStatus.Delivered, sendResult);
         }
@@ -56,9 +59,9 @@ public async Task SendInChunksCallsPublishOk(int fileSizeInBytes)
     [Theory]
     [InlineData(1)] // 1 byte
     [InlineData(1024)] // 1 kByte
-    [InlineData(1024 * 3)]  // 3 kByte
+    [InlineData(1024 * 3)] // 3 kByte
     [InlineData(1024 * 1024)] // 1 MByte
-    [InlineData(1024 * 1024 * 3)]  // 3 MByte
+    [InlineData(1024 * 1024 * 3)] // 3 MByte
     [InlineData(FileSender.MaxChunkSize - 1)] // excact chunk size - 1
     [InlineData(FileSender.MaxChunkSize)] // excact chunk size
     [InlineData(FileSender.MaxChunkSize + 1)] // excact chunk size + 1
@@ -71,6 +74,8 @@ public async Task SendInChunksAllowsWriteAccessToFileAfterSendingLastChunkOk(int
         var messaging = Substitute.For<IMessagingInfrastructure>();
         messaging.When(m => m.Subscribe(Arg.Any<string>(), Arg.Any<Action<Message>>()))
             .Do(args => senderHandler = args.Arg<Action<Message>>());
+        var options = Substitute.For<IOptions<FileSenderConfiguration>>();
+        options.Value.Returns(new FileSenderConfiguration());
 
         var testChannel = $"tests/fileSender/{fileSizeInBytes}";
         var buffer = new byte[fileSizeInBytes];
@@ -93,7 +98,7 @@ public async Task SendInChunksAllowsWriteAccessToFileAfterSendingLastChunkOk(int
                     senderHandler?.Invoke(new Message { Topic = req.ReplyTo, Payload = "OK" });
                 });
 
-            var fileSender = new FileSender(messaging, null);
+            var fileSender = new FileSender(messaging, null, options);
             var sendResult = await fileSender.SendInChunks(testChannel, tempFile.TempFilePath);
             Assert.Equal(FileTransferStatus.Delivered, sendResult);
         }
@@ -121,6 +126,8 @@ public async Task SendInChunksUsesSameUniqueTransferIdForEachChunkOk(int fileSiz
         var messaging = Substitute.For<IMessagingInfrastructure>();
         messaging.When(m => m.Subscribe(Arg.Any<string>(), Arg.Any<Action<Message>>()))
             .Do(args => senderHandler = args.Arg<Action<Message>>());
+        var options = Substitute.For<IOptions<FileSenderConfiguration>>();
+        options.Value.Returns(new FileSenderConfiguration());
 
         var testChannel = $"tests/fileSender/{fileSizeInBytes}";
         var buffer = new byte[fileSizeInBytes];
@@ -139,7 +146,7 @@ public async Task SendInChunksUsesSameUniqueTransferIdForEachChunkOk(int fileSiz
             });
         using (var tempFile = new TemporaryFile($"file{fileSizeInBytes}.tmp", buffer))
         {
-            var fileSender = new FileSender(messaging, null);
+            var fileSender = new FileSender(messaging, null, options);
             var sendResult = await fileSender.SendInChunks(testChannel, tempFile.TempFilePath);
             Assert.Equal(FileTransferStatus.Delivered, sendResult);
         }
@@ -149,23 +156,30 @@ public async Task SendInChunksUsesSameUniqueTransferIdForEachChunkOk(int fileSiz
         messaging.Received(Convert.ToInt32(expectedCalls)).Publish(Arg.Is<Message>(msg => msg.Topic == testChannel));
     }
 
-    [Fact]
-    public async Task SendInChunksWithMissingAnswerReturnsTimedOutOk()
+    [Theory]
+    [InlineData(1)]
+    [InlineData(4)]
+    public async Task SendInChunksWithMissingAnswerReturnsTimedOutOk(int expectedCalls)
     {
         const int fileSizeInBytes = 1024;
 
         var messaging = Substitute.For<IMessagingInfrastructure>();
+        var options = Substitute.For<IOptions<FileSenderConfiguration>>();
+        options.Value.Returns(new FileSenderConfiguration
+        {
+            RetryAttemptsForFailedChunks = expectedCalls - 1
+        });
 
         var testChannel = $"tests/fileSender/{fileSizeInBytes}";
         var buffer = new byte[fileSizeInBytes];
         using (var tempFile = new TemporaryFile($"file{fileSizeInBytes}.tst", buffer))
         {
-            var fileSender = new FileSender(messaging, null);
+            var fileSender = new FileSender(messaging, null, options);
+            fileSender.Timeout = 2000;
             var sendResult = await fileSender.SendInChunks(testChannel, tempFile.TempFilePath);
             Assert.Equal(FileTransferStatus.TimedOut, sendResult);
         }
 
-        var expectedCalls = 1;
         messaging.Received(expectedCalls).Publish(Arg.Is<Message>(msg => msg.Topic == testChannel));
     }
 }

src/Toolbox/SAF.Toolbox.Tests/SAF.Toolbox.Tests.csproj

@@ -12,6 +12,7 @@ SPDX-License-Identifier: MPL-2.0
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Configuration" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
     <PackageReference Include="NSubstitute" />

src/Toolbox/SAF.Toolbox.Tests/ServiceCollectionExtensionsTests.cs

@@ -1,9 +1,14 @@
 // SPDX-FileCopyrightText: 2017-2021 TRUMPF Laser GmbH
 //
 // SPDX-License-Identifier: MPL-2.0
+
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 using NSubstitute;
 using SAF.Common;
+using SAF.Toolbox.FileTransfer;
 using SAF.Toolbox.Heartbeat;
 using SAF.Toolbox.RequestClient;
 using Xunit;
@@ -47,7 +52,7 @@ public void AddHeartbeatPoolAddsServiceOnlyOnceOk()
     [Fact]
     public void AddRequestClientAddsServiceAndRequiredServicesOk()
     {
-        _services.AddSingleton(sp => Substitute.For<IMessagingInfrastructure>());
+        _services.AddSingleton(_ => Substitute.For<IMessagingInfrastructure>());
         _services.AddRequestClient();
 
         using var provider = _services.BuildServiceProvider();
@@ -58,7 +63,7 @@ public void AddRequestClientAddsServiceAndRequiredServicesOk()
     [Fact]
     public void AddRequestClientAddsServiceAfterAddHeartbeatPoolOk()
     {
-        _services.AddSingleton(sp => Substitute.For<IMessagingInfrastructure>());
+        _services.AddSingleton(_ => Substitute.For<IMessagingInfrastructure>());
         _services.AddHeartbeatPool();
         _services.AddRequestClient();
 
@@ -70,7 +75,7 @@ public void AddRequestClientAddsServiceAfterAddHeartbeatPoolOk()
     [Fact]
     public void AddRequestClientAddsServiceOnlyOnceOk()
     {
-        _services.AddSingleton(sp => Substitute.For<IMessagingInfrastructure>());
+        _services.AddSingleton(_ => Substitute.For<IMessagingInfrastructure>());
 
         _services.AddRequestClient();
         _services.AddRequestClient();
@@ -82,4 +87,50 @@ public void AddRequestClientAddsServiceOnlyOnceOk()
         Assert.Single(provider.GetServices<IRequestClient>());
         Assert.NotNull(provider.GetService<IRequestClient>());
     }
+
+    [Fact]
+    public void AddFileSenderWithoutConfigAddsServiceWithDefaultConfigOk()
+    {
+        // Arrange
+        _services.AddSingleton(_ => Substitute.For<IMessagingInfrastructure>());
+        _services.AddSingleton(_ => Substitute.For<ILogger<FileSender>>());
+
+        // Act
+        _services.AddFileSender();
+
+        using var provider = _services.BuildServiceProvider();
+        var fileSender = provider.GetService<IFileSender>();
+        var options = provider.GetService<IOptions<FileSenderConfiguration>>();
+
+        // Assert
+        Assert.NotNull(fileSender);
+        Assert.NotNull(options);
+        Assert.NotNull(options.Value);
+        Assert.Equal(0, options.Value.RetryAttemptsForFailedChunks);
+    }
+
+    [Fact]
+    public void AddFileSenderWithConfigAddsServiceWithSpecificConfigOk()
+    {
+        // Arrange
+        _services.AddSingleton(_ => Substitute.For<IMessagingInfrastructure>());
+        _services.AddSingleton(_ => Substitute.For<ILogger<FileSender>>());
+        var config = new ConfigurationBuilder().AddInMemoryCollection(new Dictionary<string, string>
+        {
+            { "FileSender:RetryAttemptsForFailedChunks", "5" }
+        }!).Build();
+
+        // Act
+        _services.AddFileSender(config);
+
+        using var provider = _services.BuildServiceProvider();
+        var fileSender = provider.GetService<IFileSender>();
+        var options = provider.GetService<IOptions<FileSenderConfiguration>>();
+
+        // Assert
+        Assert.NotNull(fileSender);
+        Assert.NotNull(options);
+        Assert.NotNull(options.Value);
+        Assert.Equal(5, options.Value.RetryAttemptsForFailedChunks);
+    }
 }

src/Toolbox/SAF.Toolbox/FileSenderConfiguration.cs

@@ -0,0 +1,10 @@
+// SPDX-FileCopyrightText: 2017-2024 TRUMPF Laser GmbH
+//
+// SPDX-License-Identifier: MPL-2.0
+
+namespace SAF.Toolbox;
+
+public class FileSenderConfiguration
+{
+    public int RetryAttemptsForFailedChunks { get; set; } = 0;
+}