Ticket #114 : Get and update plugin configuration

Author: habarthierry-hue

docs/documentation/eventmesh/pluginamqp.md

@@ -1,2 +1,29 @@
-# AMQP1.0 protocol plugin
+# AMQP 1.0 protocol plugin
 
+**Name**
+
+ProtocolAmqp
+
+**Description**
+
+AMQP 1.0 protocol.
+
+**Link**
+
+The ZIP file can be downloaded [here]().
+
+**Options**
+
+| Name              | Description                                                                                 | Default value |
+| ----------------- | ------------------------------------------------------------------------------------------- | ------------- |
+| port              | AMQP Port                                                                                   | 5672          |
+| maxFrameSize      | Largest frame size that the sending peer is able to accept on this connection.              | 1000          |
+| maxChannel        | The channel-max value is the highest channel number that can be used on the connection      | 1000          |
+| sessionLinkCredit | Current maximum number of messages that can be handled at the receiver endpoint of the link | 255           |
+| eventMeshVpn      | EventMesh server VPN                                                                        | default       |
+| eventMeshUrl      | EventMesh server URL                                                                        | localhost     |
+| eventMeshPort     | EventMesh server Port                                                                       | 4000          |
+
+## Quick start
+
+TODO

docs/documentation/eventmesh/plugins.md

@@ -15,11 +15,33 @@ A plugin can manually be installed :
 
 ## Enable a plugin
 
-Once the plugin is installed, open a command prompt and execute the command `FaasNet.EventMeshCTL.CLI.exe  enable_plugin -n=<PLUGIN_NAME>` to enable the plugin.
+Once the plugin is installed, open a command prompt and execute the command `FaasNet.EventMeshCTL.CLI.exe  enable_plugin --name=<PLUGIN_NAME>` to enable the plugin.
 
 If the plugin is successfully enabled then a success message is displayed.
 
-The EventMesh server must be restarted to take into consideration the new activated plugins.
+## Configure a plugin
+
+There are two methods to configure a plugin. Either by editing the `appsettings.json` configuration file present inside the plugin directory or by using the CLI.
+
+All the available configuration records can be displayed by executing the command line 
+
+```
+FaasNet.EventMeshCTL.CLI.exe get_plugin_configuration --name=<PLUGIN_NAME>
+```
+
+For each configuration record, the CLI displays :
+* Unique property name.
+* Short description.
+* Configured value (coming from the configuration file).
+
+Any configuration record can be updated like this 
+
+```
+FaasNet.EventMeshCTL.CLI.exe update_plugin_configuration --name=<PLUGIN_NAME> --key=<PROPERTY_KEY> --value=<PROPERTY_VALUE>
+```
+
+> [!IMPORTANT]
+> Once the plugin is properly configured. The EventMesh server must be restarted in order to take into consideration your modifications.
 
 ## Supported plugins
 

docs/documentation/eventmesh/pluginwebsocket.md

@@ -1,2 +1,25 @@
 # Websocket protocol plugin
 
+**Name**
+
+ProtocolWebsocket
+
+**Description**
+
+Support Websocket protocol.
+
+**Link**
+
+The ZIP file can be downloaded [here]().
+
+**Options**
+
+| Name              | Description                                                                                 | Default value |
+| ----------------- | ------------------------------------------------------------------------------------------- | ------------- |
+| port              | Websocket port                                                                              | 2803          |
+| eventMeshUrl      | EventMesh server URL                                                                        | localhost     |
+| eventMeshPort     | EventMesh server Port                                                                       | 4000          |
+
+## Quick start
+
+TODO

src/EventMesh/FaasNet.EventMesh.Client/Constants.cs

@@ -24,7 +24,9 @@ public class Constants
             { Commands.ADD_CLIENT_REQUEST, Commands.ADD_CLIENT_RESPONSE },
             { Commands.GET_ALL_PLUGINS_REQUEST, Commands.GET_ALL_PLUGINS_RESPONSE },
             { Commands.ENABLE_PLUGIN_REQUEST, Commands.ENABLE_PLUGIN_RESPONSE },
-            { Commands.DISABLE_PLUGIN_REQUEST, Commands.DISABLE_PLUGIN_RESPONSE }
+            { Commands.DISABLE_PLUGIN_REQUEST, Commands.DISABLE_PLUGIN_RESPONSE },
+            { Commands.GET_PLUGIN_CONFIGURATION_REQUEST, Commands.GET_PLUGIN_CONFIGURATION_RESPONSE },
+            { Commands.UPDATE_PLUGIN_CONFIGURATION_REQUEST, Commands.UPDATE_PLUGIN_CONFIGURATION_RESPONSE }
         };
     }
 }

src/EventMesh/FaasNet.EventMesh.Client/EventMeshClient.cs

@@ -208,6 +208,39 @@ public EventMeshClient(string url = Constants.DefaultUrl, int port = Constants.D
             }
         }
 
+        public async Task<ICollection<PluginConfigurationRecordResponse>> GetPluginConfiguration(string pluginName, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            using (var udpClient = new UdpClient())
+            {
+                var writeCtx = new WriteBufferContext();
+                var package = PackageRequestBuilder.GetPluginConfiguration(pluginName);
+                package.Serialize(writeCtx);
+                var payload = writeCtx.Buffer.ToArray();
+                await udpClient.SendAsync(payload, payload.Count(), new IPEndPoint(_ipAddr, _port)).WithCancellation(cancellationToken);
+                var resultPayload = await udpClient.ReceiveAsync().WithCancellation(cancellationToken);
+                var readCtx = new ReadBufferContext(resultPayload.Buffer);
+                var packageResult = Package.Deserialize(readCtx);
+                EnsureSuccessStatus(package, packageResult);
+                return (packageResult as GetPluginConfigurationResponse).Records;
+            }
+        }
+
+        public async Task UpdatePluginConfiguration(string pluginName, string propertyKey, string propertyValue, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            using (var udpClient = new UdpClient())
+            {
+                var writeCtx = new WriteBufferContext();
+                var package = PackageRequestBuilder.UpdatePluginConfiguration(pluginName, propertyKey, propertyValue);
+                package.Serialize(writeCtx);
+                var payload = writeCtx.Buffer.ToArray();
+                await udpClient.SendAsync(payload, payload.Count(), new IPEndPoint(_ipAddr, _port)).WithCancellation(cancellationToken);
+                var resultPayload = await udpClient.ReceiveAsync().WithCancellation(cancellationToken);
+                var readCtx = new ReadBufferContext(resultPayload.Buffer);
+                var packageResult = Package.Deserialize(readCtx);
+                EnsureSuccessStatus(package, packageResult);
+            }
+        }
+
         internal static void EnsureSuccessStatus(Package packageRequest, Package packageResponse)
         {
             if (packageResponse.Header.Status != HeaderStatus.SUCCESS) throw new RuntimeClientResponseException(packageResponse.Header.Status, packageResponse.Header.Error);

src/EventMesh/FaasNet.EventMesh.Client/Messages/Commands.cs

@@ -126,6 +126,22 @@ public class Commands : IEquatable<Commands>
         /// Result returned when a plugin is disabled.
         /// </summary>
         public static Commands DISABLE_PLUGIN_RESPONSE = new Commands(29, "DISABLE_PLUGIN_RESPONSE");
+        /// <summary>
+        /// Request sent to get the plugin configuration.
+        /// </summary>
+        public static Commands GET_PLUGIN_CONFIGURATION_REQUEST = new Commands(30, "GET_PLUGIN_CONFIGURATION_REQUEST");
+        /// <summary>
+        /// Result returned to get the plugin configuration
+        /// </summary>
+        public static Commands GET_PLUGIN_CONFIGURATION_RESPONSE = new Commands(31, "GET_PLUGIN_CONFIGURATION_RESPONSE");
+        /// <summary>
+        /// Request sent to update the plugin configuration.
+        /// </summary>
+        public static Commands UPDATE_PLUGIN_CONFIGURATION_REQUEST = new Commands(32, "UPDATE_PLUGIN_CONFIGURATION_REQUEST");
+        /// <summary>
+        /// Result returned when the plugin configuration is updated.
+        /// </summary>
+        public static Commands UPDATE_PLUGIN_CONFIGURATION_RESPONSE = new Commands(33, "UPDATE_PLUGIN_CONFIGURATION_RESPONSE");
 
 
         private Commands(int code)

src/EventMesh/FaasNet.EventMesh.Client/Messages/Errors.cs

@@ -21,6 +21,7 @@ public class Errors : IEquatable<Errors>
         public static Errors UNKNOWN_SOURCE_VPN = new Errors("UNKNOWN_SOURCE_VPN");
         public static Errors UNKNOWN_TARGET_VPN = new Errors("UNKNOWN_TARGET_VPN");
         public static Errors UNKNOWN_PLUGIN = new Errors("UNKNOWN_PLUGIN");
+        public static Errors UNKNOWN_PLUGIN_PROPERTY = new Errors("UNKNOWN_PLUGIN_PROPERTY");
         public static Errors UNAUTHORIZED_PUBLISH = new Errors("UNAUTHORIZED_PUBLISH");
         public static Errors UNAUTHORIZED_SUBSCRIBE = new Errors("UNAUTHORIZED_SUBSCRIBE");
         public static Errors SESSION_LIFETIME_TOOLONG = new Errors("SESSION_LIFETIME_TOOLONG");

src/EventMesh/FaasNet.EventMesh.Client/Messages/GetPluginConfigurationRequest.cs

@@ -0,0 +1,20 @@
+using FaasNet.RaftConsensus.Client.Messages;
+
+namespace FaasNet.EventMesh.Client.Messages
+{
+    public class GetPluginConfigurationRequest : Package
+    {
+        public string Name { get; set; }
+
+        public override void Serialize(WriteBufferContext context)
+        {
+            base.Serialize(context);
+            context.WriteString(Name);
+        }
+
+        public void Extract(ReadBufferContext context)
+        {
+            Name = context.NextString();
+        }
+    }
+}

src/EventMesh/FaasNet.EventMesh.Client/Messages/GetPluginConfigurationResponse.cs

@@ -0,0 +1,60 @@
+using FaasNet.RaftConsensus.Client.Messages;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace FaasNet.EventMesh.Client.Messages
+{
+    public class GetPluginConfigurationResponse : Package
+    {
+        public GetPluginConfigurationResponse()
+        {
+            Records = new List<PluginConfigurationRecordResponse>();
+        }
+
+        public ICollection<PluginConfigurationRecordResponse> Records { get; set; }
+
+        public override void Serialize(WriteBufferContext context)
+        {
+            base.Serialize(context);
+            context.WriteInteger(Records.Count());
+            foreach (var record in Records) record.Serialize(context);
+        }
+
+        public void Extract(ReadBufferContext context)
+        {
+            var result = new List<PluginConfigurationRecordResponse>();
+            int length = context.NextInt();
+            for (var i = 0; i < length; i++) result.Add(PluginConfigurationRecordResponse.Extract(context));
+            Records = result;
+        }
+    }
+
+    public class PluginConfigurationRecordResponse
+    {
+        public PluginConfigurationRecordResponse(string name, string description, string defaultValue, string configuredValue)
+        {
+            Name = name;
+            Description = description;
+            DefaultValue = defaultValue;
+            ConfiguredValue = configuredValue;
+        }
+
+        public string Name { get; private set; }
+        public string Description { get; private set; }
+        public string DefaultValue { get; private set; }
+        public string ConfiguredValue { get; private set; }
+
+        public void Serialize(WriteBufferContext context)
+        {
+            context.WriteString(Name);
+            context.WriteString(Description);
+            context.WriteString(DefaultValue);
+            context.WriteString(ConfiguredValue);
+        }
+
+        public static PluginConfigurationRecordResponse Extract(ReadBufferContext context)
+        {
+            return new PluginConfigurationRecordResponse(context.NextString(), context.NextString(), context.NextString(), context.NextString());
+        }
+    }
+}

src/EventMesh/FaasNet.EventMesh.Client/Messages/Package.cs

@@ -176,6 +176,27 @@ public static Package Deserialize(ReadBufferContext context)
                 return result;
             }
 
+            if(Commands.GET_PLUGIN_CONFIGURATION_REQUEST == header.Command)
+            {
+                var result = new GetPluginConfigurationRequest { Header = header };
+                result.Extract(context);
+                return result;
+            }
+
+            if(Commands.GET_PLUGIN_CONFIGURATION_RESPONSE == header.Command)
+            {
+                var result = new GetPluginConfigurationResponse { Header = header };
+                if (header.Status == HeaderStatus.SUCCESS) result.Extract(context);
+                return result;
+            }
+
+            if (Commands.UPDATE_PLUGIN_CONFIGURATION_REQUEST == header.Command)
+            {
+                var result = new UpdatePluginConfigurationRequest { Header = header };
+                if (header.Status == HeaderStatus.SUCCESS) result.Extract(context);
+                return result;
+            }
+
             return new Package
             {
                 Header = header