Testability aids (#55)

* Uniform logging
* Report plugin with all needed (hopefully) data
* API to get/set plugin settings

Author: kendarorg

README.md

@@ -96,6 +96,7 @@ java -jar protocol-runner.jar -protocol http -proxy 9999 \
 * Plugin-based architecture
 * Custom maven repository on [https://maven.kendar.org](https://maven.kendar.org/maven2/releases/org/kendar/protocol/)
 * More than 70% Test coverage, more than 550 tests
+* Environment-based dynamic settings (see TPM_REPLACE)
 
 The configuration is based on command line parameters or a json properties file
 for the usage check [here](docs/properties.md)
@@ -132,6 +133,9 @@ If you want to go on the specific functions by protocol:
 
 ```
 The Protocol Master
+If an environment variable exists TPM_REPLACE=a=b,c=d,e=f
+every occurrence of %a% in config file is replaced with 
+b value and so on
 
 	un     	unattended	Unattended run (default false)
 	cfg    	config    	Load config file

pom.xml

@@ -24,7 +24,7 @@
     </modules>
 
     <properties>
-        <revision>2.3.3</revision>
+        <revision>2.3.4</revision>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.compiler.target>17</maven.compiler.target>
         <maven.compiler.source>17</maven.compiler.source>

protocol-amqp-091/src/main/java/org/kendar/amqp/v09/apis/AmqpPublishPluginApis.java

@@ -48,7 +48,7 @@ public AmqpPublishPluginApis(AmqpPublishPlugin descriptor, String id, String ins
                     body = Ko.class,
                     description = "In case of errors"
             )},
-            tags = {"plugins/{#protocol}/{#protocolInstanceId}"})
+            tags = {"plugins/{#protocol}/{#protocolInstanceId}/publish-plugin"})
     public void getConnections(Request request, Response response) {
         var pInstance = getDescriptor().getProtocolInstance();
         var result = new ArrayList<AmqpConnection>();

protocol-amqp-091/src/main/java/org/kendar/amqp/v09/plugins/AmqpReplayPlugin.java

@@ -96,7 +96,7 @@ protected void sendBackResponses(ProtoContext context, List<StorageItem> storage
                         var bd = mapper.deserialize(out, BasicDeliver.class);
                         var tag = (String) ctx.getValue("BASIC_CONSUME_CT_" + bd.getConsumeOrigin());
 
-                        log.debug("Delivering " + "BASIC_CONSUME_CT_" + bd.getConsumeOrigin() + " " + tag);
+                        log.trace("BasicDeliver tag{}", tag);
                         if (tag != null && !tag.isEmpty()) {
                             bd.setConsumerTag(tag);
                         }

protocol-amqp-091/src/main/java/org/kendar/amqp/v09/plugins/AmqpReportPlugin.java

@@ -64,4 +64,27 @@ public boolean handle(PluginContext pluginContext, ProtocolPhase phase, BodyFram
         ));
         return false;
     }
+
+    public boolean handle(PluginContext pluginContext, ProtocolPhase phase, Object in, BodyFrame out) {
+        if (!isActive() && phase!=ProtocolPhase.ASYNC_RESPONSE) return false;
+
+        var context = pluginContext.getContext();
+        var connectionId = context.getContextId();
+        var channel = out.getChannel();
+        var routingKey = context.getValue("BASIC_PUBLISH_RK_" + out.getChannel());
+        var exchange = context.getValue("BASIC_PUBLISH_XC_" + out.getChannel());
+        var payload = mapper.toHumanReadable(out.getContent());
+
+        var duration = System.currentTimeMillis() - pluginContext.getStart();
+        EventsQueue.send(new ReportDataEvent(
+                getInstanceId(),
+                getProtocol(),
+                String.format("RECEIVE:%s:%s", exchange, routingKey),
+                connectionId,
+                pluginContext.getStart(),
+                duration,
+                Map.of("body", payload, "channel", channel + "")
+        ));
+        return false;
+    }
 }

protocol-amqp-091/src/test/java/org/kendar/amqp/v09/ExchangeTest.java

@@ -81,7 +81,7 @@ void testExchange() throws URISyntaxException, NoSuchAlgorithmException, KeyMana
         assertTrue(Square.results.containsKey("Square of 4 is: 16"));
         assertTrue(Square.results.containsKey("Square of 5 is: 25"));
         var events = getEvents().stream().collect(Collectors.toList());
-        assertEquals(7, events.size());
+        assertEquals(12, events.size());
         assertEquals(2, events.stream().filter(e -> e.getQuery().equalsIgnoreCase("CONNECT")).count());
     }
 }

protocol-common-jdbc/src/main/java/org/kendar/sql/jdbc/JdbcProxy.java

@@ -378,7 +378,7 @@ public ProxyConnection connect(NetworkProtoContext context) {
             }
             return new ProxyConnection(connection);
         } catch (SQLException e) {
-            log.warn("Error connection {}", getConnectionString(), e);
+            log.warn("Error connection `{}`", getConnectionString());
             return new ProxyConnection(null);
         }
     }

protocol-common/src/main/java/org/kendar/annotations/multi/TpmRequest.java

@@ -32,6 +32,13 @@
      */
     Class<?> body() default Object.class;
 
+    /**
+     * Function to call for body type
+     *
+     * @return
+     */
+    String bodyMethod() default "";
+
     /**
      * If optional
      *

protocol-common/src/main/java/org/kendar/annotations/multi/TpmResponse.java

@@ -39,6 +39,13 @@
      */
     Class<?> body() default Object.class;
 
+    /**
+     * Function to call for body type
+     *
+     * @return
+     */
+    String bodyMethod() default "";
+
     /**
      * Returned headers
      *

protocol-common/src/main/java/org/kendar/apis/FilterDescriptor.java

@@ -17,6 +17,8 @@
 import org.kendar.apis.utils.GenericFilterExecutor;
 import org.kendar.apis.utils.IdBuilder;
 import org.kendar.plugins.base.ProtocolPluginApiHandler;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.lang.annotation.IncompleteAnnotationException;
 import java.lang.reflect.InvocationTargetException;
@@ -204,6 +206,19 @@ public boolean matches(Request req) {
         }
         return true;
     }
+    private static final Logger log = LoggerFactory.getLogger(FilterDescriptor.class);
+
+    public Object invokeOnFilterClass(String name,Object...args){
+        if(name==null || name.isEmpty()) return null;
+        try {
+            var method = filterClass.getClass().getMethod(name);
+            method.setAccessible(true);
+            return method.invoke(filterClass, args);
+        }catch (Exception e) {
+            log.error("Error retrieving data from {}",filterClass.getClass().getName(),e);
+            return null;
+        }
+    }
 
     /**
      * Run the callback associate with the address

protocol-common/src/main/java/org/kendar/cli/CommandOption.java

@@ -24,6 +24,13 @@ public class CommandOption implements CommandItem {
     private boolean present;
     private String subChoicesDescription;
     private CommandItem parent;
+    private boolean multiple;
+    private Consumer<List<String>> multiCallback;
+
+    public CommandOption asMultiple() {
+        this.multiple = true;
+        return this;
+    }
 
     private CommandOption(String shortCommand, String description) {
 
@@ -144,8 +151,15 @@ public List<String> getValues() {
     }
 
     public void setValues(List<String> values) {
-        this.values = values;
-        if (callback != null) {
+        if(this.values == null){
+            this.values = values;
+        }else{
+            this.values.addAll(values);
+        }
+
+        if (multiCallback != null) {
+            multiCallback.accept(this.values);
+        }else if (callback != null) {
             if (!this.isHasParameter()) {
                 callback.accept(null);
             } else {
@@ -209,6 +223,11 @@ public CommandOption withCallback(Consumer<String> callback) {
         return this;
     }
 
+    public CommandOption withMultiCallback(Consumer<List<String>> callback) {
+        this.multiCallback = callback;
+        return this;
+    }
+
     public String getSubChoicesDescription() {
         return subChoicesDescription;
     }
@@ -264,7 +283,7 @@ public boolean hasSubOptions() {
     }
 
     public void parseInternal(List<MainArg> mainArgs) {
-        parseListOfCommands(mainArgs, subOptions, this);
+        parseListOfCommands(mainArgs, subOptions, this,false);
     }
 
     public List<CommandOption> getCommandOptions() {
@@ -282,4 +301,8 @@ public CommandItem getParent() {
     public void setParent(CommandItem parent) {
         this.parent = parent;
     }
+
+    public boolean isMultiple() {
+        return multiple;
+    }
 }

protocol-common/src/main/java/org/kendar/cli/CommandOptions.java

@@ -29,7 +29,7 @@ public static CommandOptions of(String id, String description) {
         return new CommandOptions(id, description);
     }
 
-    protected static void parseListOfCommands(List<MainArg> mainArgs, List<CommandOption> co, CommandItem caller) {
+    protected static void parseListOfCommands(List<MainArg> mainArgs, List<CommandOption> co, CommandItem caller,boolean multiple) {
         for (CommandOption item : co) {
             var matchingArgIndex = 0;
             var foundedMatchingArg = false;
@@ -74,6 +74,12 @@ protected static void parseListOfCommands(List<MainArg> mainArgs, List<CommandOp
                 }
                 item.setValues(arg.get().getValues());
                 item.setPresent();
+                if(item.isMultiple()){
+                    parseListOfCommands(mainArgs,co,caller,true);
+                }
+                if(multiple){
+                    break;
+                }
                 if (item.hasSubOptions()) {
                     item.parseInternal(mainArgs);
                 }
@@ -119,7 +125,7 @@ protected static void parseListOfCommands(List<MainArg> mainArgs, List<CommandOp
     protected static void printHelpListOfCommands(ArrayList<HelpLine> result, List<CommandOption> co) {
         for (var item : co) {
             if (item.hasSubChoices()) continue;
-            result.add(new HelpLine(item.getShortCommand(), item.getLongCommand(), item.getDescription(), null));
+            result.add(new HelpLine(item.getShortCommand(), item.getLongCommand(), item.getDescription(), null, item.isMultiple()));
             if (item.hasSubOptions()) {
                 for (var choice : item.getCommandOptions()) {
                     if (choice.getDescription() != null) {
@@ -132,7 +138,7 @@ protected static void printHelpListOfCommands(ArrayList<HelpLine> result, List<C
             if (!item.hasSubChoices()) continue;
             var choices = item.getSubChoices().stream().map(CommandOptions::getId).collect(Collectors.toCollection(HashSet::new));
             var availableChoices = String.join("|", choices);
-            result.add(new HelpLine(item.getShortCommand(), item.getLongCommand(), item.getDescription(), availableChoices));
+            result.add(new HelpLine(item.getShortCommand(), item.getLongCommand(), item.getDescription(), availableChoices,item.isMultiple()));
             if (item.getSubChoicesDescription() != null) {
                 result.add(new HelpLine(item.getSubChoicesDescription()));
             }
@@ -217,7 +223,7 @@ public void parse(List<MainArg> mainArgs, boolean ignoreMissing) {
     }
 
     public void parseInternal(List<MainArg> mainArgs) {
-        parseListOfCommands(mainArgs, commandOptions, this);
+        parseListOfCommands(mainArgs, commandOptions, this,false);
     }
 
     public boolean hasOption(String id) {

protocol-common/src/main/java/org/kendar/cli/CommandParser.java

@@ -133,6 +133,9 @@ public String buildHelp() {
                 if (item.getAvailableOptions() != null) {
                     description += "\nOptions: " + item.getAvailableOptions();
                 }
+                if (item.isMultiple()) {
+                    description += "\nRepeatable";
+                }
                 String[] split = description.split("[\r\n\f]+");
                 for (int i = 0; i < split.length; i++) {
                     var descline = split[i];

protocol-common/src/main/java/org/kendar/cli/HelpLine.java

@@ -6,13 +6,15 @@ public class HelpLine {
     private String longCommand;
     private String description;
     private String availableOptions;
+    private boolean multiple;
 
-    public HelpLine(String shortCommand, String longCommand, String description, String availableOptions) {
+    public HelpLine(String shortCommand, String longCommand, String description, String availableOptions,boolean multiple) {
         this.shortCommand = shortCommand;
         this.longCommand = longCommand;
         this.description = description;
         this.availableOptions = availableOptions;
         this.block = false;
+        this.multiple = multiple;
     }
 
     public HelpLine(String description) {
@@ -64,4 +66,12 @@ public String getAvailableOptions() {
     public void setAvailableOptions(String availableOptions) {
         this.availableOptions = availableOptions;
     }
+
+    public boolean isMultiple() {
+        return multiple;
+    }
+
+    public void setMultiple(boolean multiple) {
+        this.multiple = multiple;
+    }
 }

protocol-common/src/main/java/org/kendar/di/annotations/TpmNamed.java

@@ -5,10 +5,6 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-/**
- * Assign a base DNS/address to respond to
- * Mandatory for @FilterClass
- */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE, ElementType.PARAMETER})
 public @interface TpmNamed {

protocol-common/src/main/java/org/kendar/events/ReportDataEvent.java

@@ -34,9 +34,13 @@ public ReportDataEvent(String instanceId,
     @Override
     public String toString() {
         return "ReportDataEvent{" +
-                "protocol='" + protocol + '\'' +
-                ", instanceId='" + instanceId + '\'' +
+                "instanceId='" + instanceId + '\'' +
+                ", protocol='" + protocol + '\'' +
                 ", query='" + query + '\'' +
+                ", connectionId=" + connectionId +
+                ", timestamp=" + timestamp +
+                ", duration=" + duration +
+                ", tags=" + tags +
                 '}';
     }
 

protocol-common/src/main/java/org/kendar/plugins/MockPlugin.java

@@ -94,11 +94,9 @@ protected abstract void writeOutput(T request, K response,
     protected abstract List<MockStorage> firstCheckOnMainPart(T request);
 
     @Override
-    public ProtocolPluginDescriptor initialize(GlobalSettings global, ProtocolSettings protocol, PluginSettings pluginSetting) {
-
-        super.initialize(global, protocol, pluginSetting);
+    protected boolean handleSettingsChanged(){
         if (getSettings().getDataDir() == null) {
-            return null;
+            return false;
         }
         mocksDir = getSettings().getDataDir();
         if (!Files.exists(Path.of(mocksDir).toAbsolutePath())) {
@@ -109,6 +107,14 @@ public ProtocolPluginDescriptor initialize(GlobalSettings global, ProtocolSettin
             }
         }
         loadMocks();
+        return true;
+    }
+    @Override
+    public ProtocolPluginDescriptor initialize(GlobalSettings global, ProtocolSettings protocol, PluginSettings pluginSetting) {
+
+        super.initialize(global, protocol, pluginSetting);
+        if(!handleSettingsChanged())return null;
+
         return this;
 
     }

protocol-common/src/main/java/org/kendar/plugins/RecordPlugin.java

@@ -126,10 +126,16 @@ public List<ProtocolPhase> getPhases() {
         return List.of(ProtocolPhase.PRE_CALL, ProtocolPhase.POST_CALL, ProtocolPhase.ASYNC_RESPONSE);
     }
 
+    @Override
+    protected boolean handleSettingsChanged(){
+        ignoreTrivialCalls = ((BasicRecordPluginSettings) getSettings()).isIgnoreTrivialCalls();
+        return true;
+    }
+
     @Override
     public ProtocolPluginDescriptor initialize(GlobalSettings global, ProtocolSettings protocol, PluginSettings pluginSetting) {
-        ignoreTrivialCalls = ((BasicRecordPluginSettings) pluginSetting).isIgnoreTrivialCalls();
         super.initialize(global, protocol, pluginSetting);
+        handleSettingsChanged();
         return this;
     }
 
@@ -168,7 +174,7 @@ private void disconnectAll() {
                         context.disconnect(((ProxyConnection) contextConnection).getConnection());
                         context.setValue("CONNECTION", null);
                     } catch (Exception e) {
-                        log.debug("Error disconnecting connection {}", contextKvp.getKey(), e);
+                        log.debug("Error disconnecting {}", contextKvp.getKey(), e);
                     }
                     pi.getContextsCache().remove(contextKvp.getKey());
                 }