Improved help command, added Tests for Direct Messages Refinement, draft implementation

naseif · naseif · commit e8f73ff5fb8a · 2023-01-21T20:27:25.000+01:00
diff --git a/Source/LocalNetAppChat/CommandLineArguments/BoolCommandLineOption.cs b/Source/LocalNetAppChat/CommandLineArguments/BoolCommandLineOption.cs
@@ -5,13 +5,14 @@ public class BoolCommandLineOption : IBoolCommandLineOption
     private bool _value = false;
     private bool _hasValue = false;
 
-    public BoolCommandLineOption(string name)
+    public BoolCommandLineOption(string name, string description)
     {
         Name = name;
+        Description = description;
     }
 
     public string Name { get; }
-
+    public string Description { get; }
     public bool IsTypeWithSeparateValue => false;
 
     public bool GetValue()
diff --git a/Source/LocalNetAppChat/CommandLineArguments/ICommandLineOption.cs b/Source/LocalNetAppChat/CommandLineArguments/ICommandLineOption.cs
@@ -3,7 +3,7 @@
 public interface ICommandLineOption
 {
     string Name { get; }
-
+    string Description { get; }
     bool HasNoValueYet();
     bool TryParseFrom(string[] args, ref int position);
     bool IsTypeWithSeparateValue { get; }
diff --git a/Source/LocalNetAppChat/CommandLineArguments/Int32CommandLineOption.cs b/Source/LocalNetAppChat/CommandLineArguments/Int32CommandLineOption.cs
@@ -7,9 +7,10 @@ public class Int32CommandLineOption : WithValueCommandLineOption<int>
 
     public Int32CommandLineOption(
         string name, 
+        string description,
         int defaultValue = 0, 
         int min = Int32.MinValue, 
-        int max = Int32.MaxValue) : base(name, defaultValue)
+        int max = Int32.MaxValue) : base(name, description, defaultValue)
     {
         _min = min;
         _max = max;
diff --git a/Source/LocalNetAppChat/CommandLineArguments/StringCommandLineOption.cs b/Source/LocalNetAppChat/CommandLineArguments/StringCommandLineOption.cs
@@ -3,9 +3,10 @@
 public class StringCommandLineOption : WithValueCommandLineOption<string>
 {
     public StringCommandLineOption(
-        string name, 
+        string name,
+        string description,
         string defaultValue = "") 
-        : base(name, defaultValue)
+        : base(name, description,defaultValue)
     {
     }
 
diff --git a/Source/LocalNetAppChat/CommandLineArguments/WithValueCommandLineOption.cs b/Source/LocalNetAppChat/CommandLineArguments/WithValueCommandLineOption.cs
@@ -3,18 +3,20 @@
 public abstract class WithValueCommandLineOption<T> : IWithValueCommandLineOption<T>
 {
     public string Name { get; }
-
+    public string Description { get; }
     public bool IsTypeWithSeparateValue => true;
 
     private T? _value;
     private bool _hasValue = false;
 
     public WithValueCommandLineOption(
         string name,
+        string description,
         T? defaultValue)
     {
         Name = name;
         _value = defaultValue;
+        Description= description;
     }
 
     public T? GetValue()
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Bot/Plugins/ScriptExecution/ScriptExecutionCommandLineParser.cs b/Source/LocalNetAppChat/LocalNetAppChat.Bot/Plugins/ScriptExecution/ScriptExecutionCommandLineParser.cs
@@ -9,7 +9,7 @@ public Result<ScriptExecutionParameters> Parse(string[] args)
         {
             var parser = new Parser(
                 new ICommandLineOption[] {
-                new StringCommandLineOption("--scriptspath")
+                new StringCommandLineOption("--scriptspath", "Path to the folder where the scripts are located")
                 });
 
             if (!parser.TryParse(args, true))
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Bot/Program.cs b/Source/LocalNetAppChat/LocalNetAppChat.Bot/Program.cs
@@ -30,22 +30,12 @@ public static async Task Main(string[] args)
             if (parameters.Help)
             {
                 ICommandLineOption[] commands = parser.GetCommandsList();
-                string[] commandsDescription =
-                {
-                    "The IP Address the bot should connect to (e.g localhost)",
-                    "The port that the bot should connect to (default: 5000)",
-                    "Whether to connect per HTTP or HTTPs",
-                    "Specifies the bot name, otherwise the name of the machine will be used\", \"Whether to ignore SSL Erros in console.",
-                    "An Authentication password that the bot should send along the requests to be able to perform tasks. (default: 1234)",
-                    "Whether to ignore SSL Erros in console.",
-                    "Prints out the commands and their corresponding descriptioon"
-                };
 
                 List<string> commandsWithDescription = new();
-                
-                for (int i = 0; i < commands.Length; i++)
+
+                foreach (var command in commands)
                 {
-                    commandsWithDescription.Add($"{commands[i].Name}\r\n\t{commandsDescription[i]}");
+                    commandsWithDescription.Add($"{command.Name}\r\n\t{command.Description}");
                 }
 
                 Console.WriteLine($"\nThe LNAC Bot. It's main purpose for now is to execute special commands on the machine it is running on and send the result of the execution to the client who requested it" +
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.ConsoleClient/Program.cs b/Source/LocalNetAppChat/LocalNetAppChat.ConsoleClient/Program.cs
@@ -30,33 +30,12 @@ public static async Task Main(string[] args)
             {
 
                 ICommandLineOption[] commands = parser.GetCommandsList();
-                string[] commandsDescription =
-                {
-                    "Run the client in message mode",
-                    "Run the client in listener mode",
-                    "Uploads a given file to the server",
-                    "Returns a list of all existing files on the server",
-                    "Downloads an existing file from the server",
-                    "Deletes an existing file from the server",
-                    "Runs the client essentially in a listener mode, but when you start typing you are delivered a prompt and with enter you will send the message",
-                    "The IP Address the bot should connect to (e.g localhost)",
-                    "The port that the bot should connect to (default: 5000)",
-                    "Path of the file you want to delete, download or upload from/to the server",
-                    "Whether to connect per HTTP or HTTPs",
-                    "The text message to send to the server. (only when in message mode!)",
-                    "The name of your client. If not specified, your machine name will be sent as clientName to the server",
-                    "An Authentication password that the server requires to allow incoming requests from the client!",
-                    "Whether to ignore SSL Errors in console",
-                    "Path where you want the requested File to be saved at after downloading it",
-                    "Prints out the commands and their corresponding description"
-
-                };
 
                 List<string> commandsWithDescription = new();
 
-                for (int i = 0; i < commands.Length; i++)
+                foreach (var command in commands)
                 {
-                    commandsWithDescription.Add($"{commands[i].Name}\r\n\t{commandsDescription[i]}");
+                    commandsWithDescription.Add($"{command.Name}\r\n\t{command.Description}");
                 }
 
                 Console.WriteLine($"\nThe LNAC Client allows you to communicate with the server as well as with other sub applications." +
@@ -70,13 +49,13 @@ public static async Task Main(string[] args)
   – Start the client in listening mode
     $ LocalNetAppChat.ConsoleClient listener --server ""localhost"" --port 54214 --key 1234 --clientName ""GithubReadMe""
   - Start the client in message mode
-    $ LocalNetAppChat.ConsoleClient message --server ""localhost"" --port 51234 --key 1234 --text ""Hey there, I am client GithubReadMe""
+    $ LocalNetAppChat.ConsoleClient message --server ""localhost"" --port 51234 --key 1234 --text ""Hey I am client Github""
   - Start the client in chat mode
     LocalNetAppChat.ConsoleClient chat --server ""localhost"" --port 54214 --key 1234 --clientName ""GithubReadMe""
   - Upload a file to the server
     $ LocalNetAppChat.ConsoleClient fileupload --server ""localhost"" --port 51234 --key 1234 --file ""./README.md""
   - Download a file from the server
-    $ LocalNetAppChat.ConsoleClient filedownload --server ""localhost"" --port 51234 --key 1234 --file ""./README.md"" --targetPath ""/home/github/Projects""
+    $ LocalNetAppChat.ConsoleClient filedownload --server ""localhost"" --port 51234 --key 1234 --file ""./README.md"" --targetPath ""github/Projects""
   - Deletes a file from the server
     $ LocalNetAppChat.ConsoleClient filedelete --server ""localhost"" --port 51234 --key 1234 --file ""README.md""
   - List all files existing on the server
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/ClientSideCommandLineParser.cs b/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/ClientSideCommandLineParser.cs
@@ -20,24 +20,23 @@ private Parser ParseArgs()
         var parser = new Parser(
             new ICommandLineOption[]
             {
-                new BoolCommandLineOption("message"),
-                new BoolCommandLineOption("listener"),
-                new BoolCommandLineOption("fileupload"),
-                new BoolCommandLineOption("listfiles"),
-                new BoolCommandLineOption("filedownload"),
-                new BoolCommandLineOption("filedelete"),
-                new BoolCommandLineOption("chat"),
-                new StringCommandLineOption("--file"),
-                new StringCommandLineOption("--server", "localhost"),
-                new Int32CommandLineOption("--port", 5000),
-                new BoolCommandLineOption("--https"),
-
-                new StringCommandLineOption("--text"),
-                new StringCommandLineOption("--clientName", Environment.MachineName),
-                new StringCommandLineOption("--key", "1234"),
-                new BoolCommandLineOption("--ignoresslerrors"),
-                new StringCommandLineOption("--targetPath"),
-                new BoolCommandLineOption("--help")
+                new BoolCommandLineOption("message", "Run the client in message mode"),
+                new BoolCommandLineOption("listener", "Run the client in listener mode"),
+                new BoolCommandLineOption("fileupload", "Uploads a given file to the server"),
+                new BoolCommandLineOption("listfiles", "Returns a list of all existing files on the server"),
+                new BoolCommandLineOption("filedownload", "Downloads an existing file from the server"),
+                new BoolCommandLineOption("filedelete", "Deletes an existing file from the server"),
+                new BoolCommandLineOption("chat", "Runs the client essentially in a listener mode, but when you start typing you are delivered a prompt and with enter you will send the message"),
+                new StringCommandLineOption("--file", "Path of the file you want to delete, download or upload from/to the server"),
+                new StringCommandLineOption("--server","The IP Address the bot should connect to (e.g localhost)" ,"localhost"),
+                new Int32CommandLineOption("--port","The port that the bot should connect to (default: 5000)", 5000),
+                new BoolCommandLineOption("--https", "\"Whether to connect per HTTP or HTTPs\""),
+                new StringCommandLineOption("--text", "The text message to send to the server. (only when in message mode!)"),
+                new StringCommandLineOption("--clientName", "The name of your client. If not specified, your machine name will be sent as clientName to the server",Environment.MachineName),
+                new StringCommandLineOption("--key","An Authentication password that the server requires to allow incoming requests from the client!" ,"1234"),
+                new BoolCommandLineOption("--ignoresslerrors", "Whether to ignore SSL Errors in console"),
+                new StringCommandLineOption("--targetPath", "Path where you want the requested File to be saved at after downloading it"),
+                new BoolCommandLineOption("--help", "Prints out the commands and their corresponding description")
             });
         return parser;
     }
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/ServerConnectionCommandLineParser.cs b/Source/LocalNetAppChat/LocalNetAppChat.Domain/Clientside/ServerConnectionCommandLineParser.cs
@@ -14,15 +14,15 @@ private Parser ParseArgs()
     {
         var parser = new Parser(
                new ICommandLineOption[] {
-                new StringCommandLineOption("--server", "localhost"),
-                new Int32CommandLineOption("--port", 5000),
-                new BoolCommandLineOption("--https"),
+                new StringCommandLineOption("--server", "The IP Address the bot should connect to (e.g localhost)","localhost"),
+                new Int32CommandLineOption("--port", "The port the server should connect to (default: 5000)", 5000),
+                new BoolCommandLineOption("--https", "Whether to connect per HTTP or HTTPs"),
 
-                new StringCommandLineOption("--clientName", Environment.MachineName),
-                new StringCommandLineOption("--key", "1234"),
+                new StringCommandLineOption("--clientName","Specifies the bot name, otherwise the name of the machine will be used\", \"Whether to ignore SSL Erros in console.", Environment.MachineName),
+                new StringCommandLineOption("--key", "An Authentication password that the bot should send along the requests to be able to perform tasks. (default: 1234)","1234"),
 
-                new BoolCommandLineOption("--ignoresslerrors"),
-                new BoolCommandLineOption("--help")
+                new BoolCommandLineOption("--ignoresslerrors","Whether to ignore SSL Erros in console."),
+                new BoolCommandLineOption("--help", "Prints out the commands and their corresponding description")
              });
 
         return parser;
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Server.Domain.Tests/Messaging/DirectMessagesReceiverPatternTests.cs b/Source/LocalNetAppChat/LocalNetAppChat.Server.Domain.Tests/Messaging/DirectMessagesReceiverPatternTests.cs
@@ -0,0 +1,84 @@
+﻿using LocalNetAppChat.Domain.Shared;
+using LocalNetAppChat.Server.Domain.Messaging;
+using LocalNetAppChat.Server.Domain.Messaging.MessageProcessing;
+using NUnit.Framework;
+
+namespace LocalNetAppChat.Server.Domain.Tests.Messaging;
+
+[TestFixture]
+public class DirectMessagesReceiverPatternTests
+{
+    [Test]
+    public void The_first_client_that_matches_the_pattern_will_receive_the_message_Way1()
+    {
+        var messageList = GetMessageList();
+
+        messageList.Add(GetTestMessage("gitserver", "/msg build* tueirgendwas"));
+        
+        var messageBuild1 = messageList.GetMessagesForClient("build1");
+        Assert.AreEqual(1, messageBuild1.Length);
+
+        var messageBuild2 = messageList.GetMessagesForClient("build2");
+        Assert.AreEqual(0, messageBuild2.Length);
+    }
+
+    [Test]
+    public void The_first_client_that_matches_the_pattern_will_receive_the_message_Way2()
+    {
+        var messageList = GetMessageList();
+
+        messageList.Add(GetTestMessage("gitserver", "/msg build* tueirgendwas"));
+
+        var messageBuild2 = messageList.GetMessagesForClient("build2");
+        Assert.AreEqual(1, messageBuild2.Length);
+
+        var messageBuild1 = messageList.GetMessagesForClient("build1");
+        Assert.AreEqual(0, messageBuild1.Length);
+    }
+
+    [Test]
+    public void Even_the_same_client_will_not_receive_the_message_twice()
+    {
+        var messageList = GetMessageList();
+
+        messageList.Add(GetTestMessage("gitserver", "/msg build* tueirgendwas"));
+
+        var messageBuild2 = messageList.GetMessagesForClient("build1");
+        Assert.AreEqual(1, messageBuild2.Length);
+
+        var messageBuild1 = messageList.GetMessagesForClient("build1");
+        Assert.AreEqual(0, messageBuild1.Length);
+    }
+
+    [Test]
+    public void When_the_client_does_not_match_the_pattern_it_does_not_receive_the_message()
+    {
+        var messageList = GetMessageList();
+
+        messageList.Add(GetTestMessage("gitserver", "/msg build* tueirgendwas"));
+
+        var messageNichtBuild = messageList.GetMessagesForClient("istnichtbuild");
+        Assert.AreEqual(0, messageNichtBuild.Length);
+    }
+
+    private static IMessageList GetMessageList()
+    {
+        return new SynchronizedCollectionBasedMessageList(
+            TimeSpan.FromHours(1));
+    }
+
+    private static ReceivedMessage GetTestMessage(string clientName, string text ,DateTime? explicitTime = null)
+    {
+        var processors = MessageProcessorFactory.Get(
+            new ThreadSafeCounter(),
+            new DateTimeProviderMock(explicitTime ?? DateTime.Now));
+
+        var message = new LnacMessage(Guid.NewGuid().ToString(), clientName, text,
+            Array.Empty<string>(),
+            true,
+            "Message").ToReceivedMessage();
+
+        return processors.Process(message);
+    }
+
+}
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Server.Domain.Tests/Messaging/ReceiverPatternMatchingTests.cs b/Source/LocalNetAppChat/LocalNetAppChat.Server.Domain.Tests/Messaging/ReceiverPatternMatchingTests.cs
@@ -0,0 +1,25 @@
+﻿using NUnit.Framework;
+
+namespace LocalNetAppChat.Server.Domain.Tests.Messaging;
+
+[TestFixture]
+public class ReceiverPatternMatchingTests
+{
+    [Test]
+    public void The_pattern_does_not_match()
+    {
+        Assert.False(ReceiverPatternMatcher.DoesMatch("Naseif", "_/"));
+        Assert.False(ReceiverPatternMatcher.DoesMatch("Nasei", "Naseif.*"));
+        Assert.False(ReceiverPatternMatcher.DoesMatch("Naseif", "build*"));
+    }
+
+    [Test]
+    public void The_pattern_does_match()
+    {
+        Assert.True(ReceiverPatternMatcher.DoesMatch("build1", "build*"));
+        Assert.True(ReceiverPatternMatcher.DoesMatch("build2", "build*"));
+        Assert.True(ReceiverPatternMatcher.DoesMatch("build3", "build*"));
+        Assert.True(ReceiverPatternMatcher.DoesMatch("Naseif", "Naseif"));
+        Assert.True(ReceiverPatternMatcher.DoesMatch("Naseif", "Naseif*"));
+    }
+}
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Server.Domain/Messaging/ReceiverPatternMatcher.cs b/Source/LocalNetAppChat/LocalNetAppChat.Server.Domain/Messaging/ReceiverPatternMatcher.cs
@@ -0,0 +1,19 @@
+﻿using System.Text.RegularExpressions;
+
+public class PatternConverter
+{
+    public static string ConvertToRegex(string pattern)
+    {
+        string regexPattern = "^" + Regex.Escape(pattern).Replace(@"\*", ".*") + "$";
+        return regexPattern;
+    }
+}
+
+public static class ReceiverPatternMatcher
+{
+    public static bool DoesMatch(string clientName, string pattern)
+    {
+        Regex regex = new(PatternConverter.ConvertToRegex(pattern));
+        return regex.IsMatch(clientName);
+    }
+}
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Server.Domain/SynchronizedCollectionBasedMessageList.cs b/Source/LocalNetAppChat/LocalNetAppChat.Server.Domain/SynchronizedCollectionBasedMessageList.cs
@@ -1,4 +1,5 @@
 ﻿using System.Collections.Concurrent;
+using System.Text.RegularExpressions;
 using LocalNetAppChat.Domain.Shared;
 using LocalNetAppChat.Server.Domain.Messaging;
 
@@ -33,7 +34,7 @@ private void Cleanup()
     public void Add(ReceivedMessage receivedMessage)
     {
         _messages.Add(receivedMessage);
-        
+
         Cleanup();
     }
 
@@ -66,7 +67,7 @@ private ReceivedMessage[] OnlyMessagesAfterIndex(ReceivedMessage[] messages, lon
     private ReceivedMessage[] FilterOutDirectMessagesToTheOtherClients(ReceivedMessage[] messages, string clientId)
     {
         return messages
-                .Where(x => string.IsNullOrEmpty(x.Receiver) || x.Receiver == clientId)
+                .Where(x => string.IsNullOrEmpty(x.Receiver) || x.Receiver == clientId || ReceiverPatternMatcher.DoesMatch(clientId, x.Receiver))
                 .OrderBy(x => x.Id)
                 .ToArray();
     }
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Server/Program.cs b/Source/LocalNetAppChat/LocalNetAppChat.Server/Program.cs
diff --git a/Source/LocalNetAppChat/LocalNetAppChat.Server/Properties/launchSettings.json b/Source/LocalNetAppChat/LocalNetAppChat.Server/Properties/launchSettings.json

Original file line number	Diff line number	Diff line change
`@@ -5,13 +5,14 @@ public class BoolCommandLineOption : IBoolCommandLineOption`
`5`	`5`	`private bool _value = false;`
`6`	`6`	`private bool _hasValue = false;`
`7`	`7`
`8`		`- public BoolCommandLineOption(string name)`
	`8`	`+ public BoolCommandLineOption(string name, string description)`
`9`	`9`	`{`
`10`	`10`	`Name = name;`
	`11`	`+ Description = description;`
`11`	`12`	`}`
`12`	`13`
`13`	`14`	`public string Name { get; }`
`14`		`-`
	`15`	`+ public string Description { get; }`
`15`	`16`	`public bool IsTypeWithSeparateValue => false;`
`16`	`17`
`17`	`18`	`public bool GetValue()`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`public interface ICommandLineOption`
`4`	`4`	`{`
`5`	`5`	`string Name { get; }`
`6`		`-`
	`6`	`+ string Description { get; }`
`7`	`7`	`bool HasNoValueYet();`
`8`	`8`	`bool TryParseFrom(string[] args, ref int position);`
`9`	`9`	`bool IsTypeWithSeparateValue { get; }`
Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,10 @@`
`3`	`3`	`public class StringCommandLineOption : WithValueCommandLineOption<string>`
`4`	`4`	`{`
`5`	`5`	`public StringCommandLineOption(`
`6`		`- string name,`
	`6`	`+ string name,`
	`7`	`+ string description,`
`7`	`8`	`string defaultValue = "")`
`8`		`- : base(name, defaultValue)`
	`9`	`+ : base(name, description,defaultValue)`
`9`	`10`	`{`
`10`	`11`	`}`
`11`	`12`
Original file line number	Diff line number	Diff line change
`@@ -3,18 +3,20 @@`
`3`	`3`	`public abstract class WithValueCommandLineOption<T> : IWithValueCommandLineOption<T>`
`4`	`4`	`{`
`5`	`5`	`public string Name { get; }`
`6`		`-`
	`6`	`+ public string Description { get; }`
`7`	`7`	`public bool IsTypeWithSeparateValue => true;`
`8`	`8`
`9`	`9`	`private T? _value;`
`10`	`10`	`private bool _hasValue = false;`
`11`	`11`
`12`	`12`	`public WithValueCommandLineOption(`
`13`	`13`	`string name,`
	`14`	`+ string description,`
`14`	`15`	`T? defaultValue)`
`15`	`16`	`{`
`16`	`17`	`Name = name;`
`17`	`18`	`_value = defaultValue;`
	`19`	`+ Description= description;`
`18`	`20`	`}`
`19`	`21`
`20`	`22`	`public T? GetValue()`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ public Result<ScriptExecutionParameters> Parse(string[] args)`
`9`	`9`	`{`
`10`	`10`	`var parser = new Parser(`
`11`	`11`	`new ICommandLineOption[] {`
`12`		`- new StringCommandLineOption("--scriptspath")`
	`12`	`+ new StringCommandLineOption("--scriptspath", "Path to the folder where the scripts are located")`
`13`	`13`	`});`
`14`	`14`
`15`	`15`	`if (!parser.TryParse(args, true))`