17 remove the usage of webclientwebclient (#18)

* Refactored the LnacClient (once Server) as the utility to access the server-api. There is now additionally an accessor for the specific method "WebApi". * Increased test coverage for the server side. Extracted access control to separate class. * Added test coverage for MessageProcessing * Server Domain has now 100% test Coverage * Test coverage for Result-Class * Excluding test coverage for several classes where unit tests are not helpful
CleverCodeCravers · Dec 31, 2022 · cd53950 · cd53950
1 parent 7c4e66e
commit cd53950
Show file tree

Hide file tree

Showing 39 changed files with 750 additions and 272 deletions.
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Bot/Program.cs b/Source/LocalNetAppChat/LocalNetAppChat.Bot/Program.cs
@@ -26,9 +26,15 @@ public static async Task Main(string[] args)
 
             var parameters = commandLineParametersResult.Value;
 
-            ILnacServer lnacServer = new LnacServer(
+            var apiAccessor = new WebApiServerApiAccessor(
                 parameters.Server, parameters.Port, parameters.Https, parameters.IgnoreSslErrors,
-                parameters.ClientName, parameters.Key);
+                parameters.Key,
+                parameters.ClientName
+            );
+
+            ILnacClient lnacClient = new LnacClient(
+                apiAccessor,
+                parameters.ClientName);
 
             var publicClientCommands = new ClientCommandCollection();
             if (!Plugins.DefaultFunctionality.DefaultPlugin.AddCommands(publicClientCommands, args))
@@ -47,7 +53,7 @@ public static async Task Main(string[] args)
             {
                 try
                 {
-                    var messages = lnacServer.GetMessages();
+                    var messages = await lnacClient.GetMessages();
 
                     foreach (var message in messages)
                     {
@@ -58,14 +64,14 @@ public static async Task Main(string[] args)
                             if (IsAPrivateMessage(message))
                             {
                                 Result<string> result = privateClientCommands.Execute(message.Message.Text);
-                                await SendResultBack(lnacServer, message.Message.Name, result);
+                                await SendResultBack(lnacClient, message.Message.Name, result);
                                 continue;
                             }
 
                             if (publicClientCommands.IsAKnownCommand(message.Message.Text))
                             {
                                 await SendResultBack(
-                                    lnacServer,
+                                    lnacClient,
                                     message.Message.Name,
                                     publicClientCommands.Execute(message.Message.Text));
                             }
@@ -79,15 +85,15 @@ await SendResultBack(
             }
         }
 
-        private async static Task SendResultBack(ILnacServer lnacServer, string sender, Result<string> result)
+        private async static Task SendResultBack(ILnacClient lnacClient, string sender, Result<string> result)
         {
             if (result.IsSuccess)
             {
-                await lnacServer.SendMessage($"/msg {sender} {result.Value}");
+                await lnacClient.SendMessage($"/msg {sender} {result.Value}");
                 return;
             }
 
-            await lnacServer.SendMessage($"/msg {sender} {result.Error}");
+            await lnacClient.SendMessage($"/msg {sender} {result.Error}");
         }
 
         private static bool IsAPrivateMessage(ReceivedMessage message)

diff --git a/Source/LocalNetAppChat/LocalNetAppChat.ConsoleClient/Program.cs b/Source/LocalNetAppChat/LocalNetAppChat.ConsoleClient/Program.cs
@@ -24,9 +24,14 @@ public static async Task Main(string[] args)
             }
 
             var parameters = commandLineParametersResult.Value;
-            ILnacServer lnacServer = new LnacServer(
+
+            var apiAccessor = new WebApiServerApiAccessor(
                 parameters.Server, parameters.Port, parameters.Https, parameters.IgnoreSslErrors,
-                parameters.ClientName, parameters.Key);
+                parameters.Key,
+                parameters.ClientName
+            );
+
+            ILnacClient lnacClient = new LnacClient(apiAccessor, parameters.ClientName);
 
             var operatingModeCollection = new OperatingModeCollection();
             operatingModeCollection.Add(new SendMessageOperatingMode());
@@ -44,7 +49,7 @@ public static async Task Main(string[] args)
             }
             else
             {
-                await operatingMode?.Run(parameters, output, lnacServer, input)!;
+                await operatingMode?.Run(parameters, output, lnacClient, input)!;
             }
         }
     }

diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Domain.Tests/Shared/CommandMessageTokenizerTests.cs b/Source/LocalNetAppChat/LocalNetAppChat.Domain.Tests/Shared/CommandMessageTokenizerTests.cs
@@ -0,0 +1,17 @@
+using LocalNetAppChat.Domain.Shared;
+using NUnit.Framework;
+
+namespace LocalNetAppChat.Domain.Tests.Shared;
+
+[TestFixture]
+public class CommandMessageTokenizerTests
+{
+    [Test]
+    public void When_in_the_message_there_is_no_space_left_the_rest_is_the_token()
+    {
+        var message= "token";
+        var token = CommandMessageTokenizer.GetToken(ref message);
+        Assert.AreEqual("token", token);
+        Assert.AreEqual("", message);
+    }
+}
diff --git a/...ce/LocalNetAppChat/LocalNetAppChat.Domain.Tests/Shared/MessageForDisplayFormatterTests.cs b/...ce/LocalNetAppChat/LocalNetAppChat.Domain.Tests/Shared/MessageForDisplayFormatterTests.cs
@@ -0,0 +1,36 @@
+using LocalNetAppChat.Domain.Shared;
+using NUnit.Framework;
+
+namespace LocalNetAppChat.Domain.Tests.Shared;
+
+[TestFixture]
+public class MessageForDisplayFormatterTests
+{
+    private string GetFormattedMessage(string receiverPrivateMessage)
+    {
+        var message = new ReceivedMessage(0, new DateTime(2023, 2, 1, 1, 2, 3),
+            receiverPrivateMessage,
+            new LnacMessage("Id", "Name", "Text", Array.Empty<string>(), true, "Message")
+        );
+
+        var result = MessageForDisplayFormatter.GetTextFor(message);
+
+        return result;
+    }
+
+    [Test]
+    public void Normal_message_format_is_correct()
+    {
+        var result = GetFormattedMessage(string.Empty);
+
+        Assert.AreEqual(" - [2023-02-01 01:02:03] Name: Text", result);
+    }
+
+    [Test]
+    public void Private_message_format_is_correct()
+    {
+        var result = GetFormattedMessage("Receiver");
+
+        Assert.AreEqual(" - [2023-02-01 01:02:03] *PRIVATEMSG* Name: Text", result);
+    }
+}
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Domain.Tests/Shared/ResultTests.cs b/Source/LocalNetAppChat/LocalNetAppChat.Domain.Tests/Shared/ResultTests.cs
@@ -0,0 +1,24 @@
+using LocalNetAppChat.Domain.Shared;
+using NUnit.Framework;
+
+namespace LocalNetAppChat.Domain.Tests.Shared;
+
+[TestFixture]
+public class ResultTests
+{
+    [Test]
+    public void When_Result_is_successful_but_without_value_an_exception_is_thrown()
+    {
+        Assert.Throws<ArgumentNullException>(
+            () => Result<string>.Success(null)
+            );
+    }
+
+    [Test]
+    public void When_Result_is_not_Successful_the_error_is_not_empty()
+    {
+        Assert.Throws<ArgumentException>(
+            () => Result<string>.Failure(null)
+        );
+    }
+}
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/ClientSideCommandLineParameters.cs b/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/ClientSideCommandLineParameters.cs
@@ -1,5 +1,8 @@
+using System.Diagnostics.CodeAnalysis;
+
 namespace LocalNetAppChat.Domain.Clientside;
 
+[ExcludeFromCodeCoverage]
 public record ClientSideCommandLineParameters(
     bool Message,
     bool Listener,

diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/MimeMapping.cs b/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/MimeMapping.cs
@@ -1,8 +1,11 @@
+using System.Diagnostics.CodeAnalysis;
+
 namespace LocalNetAppChat.Domain.Clientside;
 
+[ExcludeFromCodeCoverage]
 public class MimeMapping
 {
-    private static Dictionary<string, string> ExtensionMap = new Dictionary<string, string>();
+    private static Dictionary<string, string> ExtensionMap = new();
 
     static MimeMapping()
     {
@@ -207,7 +210,7 @@ public static string GetMimeMapping(string fileExtension)
     {
         if (ExtensionMap.ContainsKey(fileExtension))
             return ExtensionMap[fileExtension];
-        else
-            return ExtensionMap[".*"];
+
+        return ExtensionMap[".*"];
     }
 }
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/ChatOperatingMode.cs b/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/ChatOperatingMode.cs
@@ -11,12 +11,12 @@ public bool IsResponsibleFor(ClientSideCommandLineParameters parameters)
         return parameters.Chat;
     }
 
-    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacServer lnacServer, IInput input)
+    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacClient lnacClient, IInput input)
     {
-        output.WriteLine($"Connecting to server {lnacServer}...");
+        output.WriteLine($"Connecting to server {lnacClient}...");
         while (true)
         {
-            var receivedMessages = lnacServer.GetMessages();
+            var receivedMessages = await lnacClient.GetMessages();
 
             foreach (var receivedMessage in receivedMessages)
             {
@@ -26,7 +26,7 @@ public async Task Run(ClientSideCommandLineParameters parameters, IOutput output
             if (input.IsInputWaiting())
             {
                 var message = input.GetInput();
-                await lnacServer.SendMessage(message);
+                await lnacClient.SendMessage(message);
             }
 
             Thread.Sleep(1000);

diff --git a/...calNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/DeleteFileOperatingMode.cs b/...calNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/DeleteFileOperatingMode.cs
@@ -11,8 +11,8 @@ public bool IsResponsibleFor(ClientSideCommandLineParameters parameters)
         return parameters.FileDelete;
     }
 
-    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacServer lnacServer, IInput input)
+    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacClient lnacClient, IInput input)
     {
-        await lnacServer.DeleteFile(parameters.File);
+        await lnacClient.DeleteFile(parameters.File);
     }
 }
diff --git a/...lNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/DownloadFileOperatingMode.cs b/...lNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/DownloadFileOperatingMode.cs
@@ -11,8 +11,8 @@ public bool IsResponsibleFor(ClientSideCommandLineParameters parameters)
         return parameters.FileDownload;
     }
 
-    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacServer lnacServer, IInput input)
+    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacClient lnacClient, IInput input)
     {
-        await lnacServer.DownloadFile(parameters.File, parameters.TargetPath);
+        await lnacClient.DownloadFile(parameters.File, parameters.TargetPath);
     }
 }
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/IOperatingMode.cs b/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/IOperatingMode.cs
@@ -8,5 +8,5 @@ public interface IOperatingMode
 {
     bool IsResponsibleFor(ClientSideCommandLineParameters parameters);
 
-    Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacServer lnacServer, IInput input);
+    Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacClient lnacClient, IInput input);
 }
diff --git a/...lNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/ListAllFilesOperatingMode.cs b/...lNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/ListAllFilesOperatingMode.cs
@@ -11,13 +11,12 @@ public bool IsResponsibleFor(ClientSideCommandLineParameters parameters)
         return parameters.ListServerFiles;
     }
 
-    public Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacServer lnacServer, IInput input)
+    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacClient lnacClient, IInput input)
     {
-        var files = lnacServer.GetServerFiles();
+        var files = await lnacClient.GetServerFiles();
         foreach (var file in files)
         {
             output.WriteLineUnformatted(file);
         }
-        return Task.CompletedTask;
     }
 }
diff --git a/...LocalNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/ListenerOperatingMode.cs b/...LocalNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/ListenerOperatingMode.cs
@@ -11,14 +11,14 @@ public bool IsResponsibleFor(ClientSideCommandLineParameters parameters)
         return parameters.Listener;
     }
 
-    public Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacServer lnacServer, IInput input)
+    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacClient lnacClient, IInput input)
     {
-        output.WriteLine($"Listening to server {lnacServer}...");
+        output.WriteLine($"Listening to server {lnacClient}...");
         while (true)
         {
             try
             {
-                var receivedMessages = lnacServer.GetMessages();
+                var receivedMessages = await lnacClient.GetMessages();
 
                 foreach (var receivedMessage in receivedMessages)
                 {

diff --git a/...alNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/SendMessageOperatingMode.cs b/...alNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/SendMessageOperatingMode.cs
@@ -11,8 +11,8 @@ public bool IsResponsibleFor(ClientSideCommandLineParameters parameters)
         return parameters.Message;
     }
 
-    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacServer lnacServer, IInput input)
+    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacClient lnacClient, IInput input)
     {
-        await lnacServer.SendMessage(parameters.Text);
+        await lnacClient.SendMessage(parameters.Text);
     }
 }
diff --git a/...calNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/UploadFileOperatingMode.cs b/...calNetAppChat/LocalNetAppChat.Domain/Clientside/OperatingModes/UploadFileOperatingMode.cs
@@ -11,8 +11,8 @@ public bool IsResponsibleFor(ClientSideCommandLineParameters parameters)
         return parameters.FileUpload;
     }
 
-    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacServer lnacServer, IInput input)
+    public async Task Run(ClientSideCommandLineParameters parameters, IOutput output, ILnacClient lnacClient, IInput input)
     {
-        await lnacServer.SendFile(parameters.File);
+        await lnacClient.SendFile(parameters.File);
     }
 }
diff --git a/...main/Clientside/ServerApis/ILnacServer.cs → ...main/Clientside/ServerApis/ILnacClient.cs b/...main/Clientside/ServerApis/ILnacServer.cs → ...main/Clientside/ServerApis/ILnacClient.cs
@@ -2,13 +2,13 @@
 
 namespace LocalNetAppChat.Domain.Clientside.ServerApis;
 
-public interface ILnacServer
+public interface ILnacClient
 {
-    ReceivedMessage[] GetMessages();
+    Task<ReceivedMessage[]> GetMessages();
 
     Task SendMessage(string message, string[]? tags = null, string type = "Message");
-    Task SendFile(string filePath, string type = "Task");
-    string[] GetServerFiles();
+    Task SendFile(string filePath);
+    Task<string[]> GetServerFiles();
     Task DownloadFile(string filename, string targetPath);
     Task DeleteFile(string filename);
 }
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/ServerApis/IServerApiAccessor.cs b/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/ServerApis/IServerApiAccessor.cs
@@ -0,0 +1,11 @@
+namespace LocalNetAppChat.Domain.Clientside;
+
+public interface IServerApiAccessor
+{
+    Task<string> GetAsync(string command);
+    Task<string> PostAsync(string command, Dictionary<string, string> parameters);
+
+    Task<string> PostAsJsonAsync(string command, object data);
+    Task<string> PostFileAsync(string command, string filename, Stream fileStream);
+    Task<Stream> GetFileAsync(string command, string filename);
+}