1.1-3. Updates to (mostly) regex filter

anders-wartoft · anders-wartoft · commit 1b061844f706 · 2025-06-10T12:15:41.000+02:00
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 target
 
-.vscode
+.vscode
+.DS_Store
diff --git a/README.md b/README.md
@@ -18,6 +18,10 @@ java -jar target/LogGenerator{version}.jar -i kafka -ci test3 -t OUTPUT -b 192.1
 When running the last command, press Ctrl-C to see the gaps in the received data. Since we started the counter on 100, there should at least be one gap: 1-99.
 
 ### Latest Release Notes
+#### 1.1-3
+Added a parameter {all} to regex filter, so a regex filter can wrap the log in a new string. Also, fixed a bug that hindered the regex filter to escape quotes (changing " to \").
+Minor documentation updates.
+
 #### 1.1-2
 Update of documentation. E.g., -h is no longer valid as --hostname shorthand. Also, update of `-f guard`. In 1.1-1, the `-f guard` command removed all content in the event but not the event itself, so if the event was written to file, an empty line would be the result. In 1.1-2, the event is correctly removed.
 
@@ -387,7 +391,7 @@ There must be a capture group in the regex. The text matched by the capture grou
 
 Parameters: `-f regex --regex {regex to find} --value {value to insert instead of the part matched by the regex} [--time-offset {offset in milliseconds}]`
 
-Example: `-f regex --regex "<(\d+)>" -value "<2>"`
+Example: `-f regex --regex "<(\d+)>" --value "<2>"`
 
 If you have a file with a lot of logs, like:
 
@@ -399,6 +403,29 @@ Then the following invocation will change the date to today:
 
 You can also use the --time-offset to change the date to a date that is not the current date. For example, if you want to send events with a date that is one day ago, use `-f regex --regex "([a-zA-Z]{3} [a-zA-Z]{3} \d\d \d\d:\d\d:\d\d\.\d{3})" --value "{date:EEE MMM HH:mm:ss.sss}" --time-offset -86400000`
 
+There is also a way to wrap the result. E.g., if you have a string
+`
+TestString
+`
+and want to wrap that in json, you can use
+```json
+java -jar LogGenerator-{version}.jar -i static --string TestString -f regex --regex "^.*$" --value "{\"parameter\": \"{all}\"}" -l 1 -o cmd
+```
+Result:
+```json
+{"parameter": "TestString"}
+```
+
+in case the static string contains quotes, then use a regex filter to change those first:
+```json
+java -jar LogGenerator-{version}.jar -i static --string "{\"parameter\":\"TestString\"}" -f regex --regex "\"" --value "\\\\\"" -f regex --regex "^.*$" --value "{\"parameter\": \"{all}\"}" -l 1 -o cmd
+```
+resulting in:
+```json
+{"parameter": "{\"a\":\"TestString\"}"}
+```
+
+
 #### Replace variables
 Variable substitution will be present for template, regex and header processing. If a file is loaded as "file" or template "none" then the (processor intensive) substitutions will not be loaded.
 
diff --git a/dependency-reduced-pom.xml b/dependency-reduced-pom.xml
@@ -4,7 +4,7 @@
   <groupId>nu.sitia.LogGenerator</groupId>
   <artifactId>LogGenerator</artifactId>
   <name>LogGenerator</name>
-  <version>1.1-2</version>
+  <version>1.1-3</version>
   <url>http://maven.apache.org</url>
   <build>
     <plugins>
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
   <groupId>nu.sitia.LogGenerator</groupId>
   <artifactId>LogGenerator</artifactId>
-  <version>1.1-2</version>
+  <version>1.1-3</version>
   <packaging>jar</packaging>
 
   <name>LogGenerator</name>
diff --git a/src/main/java/nu/sitia/loggenerator/filter/RegexFilter.java b/src/main/java/nu/sitia/loggenerator/filter/RegexFilter.java
@@ -25,6 +25,7 @@
 import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.logging.Logger;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -119,8 +120,10 @@ private String filter(String toFilter) {
             // Create a new date that represents now. Then, add the
             // offset provided by the user (positive for future and negative for in the past
             final Date date = new Date(new Date().getTime() + this.timeOffset);
-            String newValue = substitution.substitute(value, new HashMap<>(), date);
-            return toFilter.replaceAll(matcher.group(), newValue);
+            HashMap<String, String> replaceMap = new HashMap<>();
+            replaceMap.put("all", toFilter);
+            String newValue = substitution.substitute(value, replaceMap, date);
+            return matcher.replaceAll(Matcher.quoteReplacement(newValue));
         }
         return toFilter;
     }
diff --git a/src/main/java/nu/sitia/loggenerator/inputitems/TCPInputItem.java b/src/main/java/nu/sitia/loggenerator/inputitems/TCPInputItem.java
@@ -49,7 +49,7 @@ public boolean setParameter(String key, String value) {
         if (key != null && (key.equalsIgnoreCase("--help") || key.equalsIgnoreCase("-h"))) {
             System.out.println("TCPInputItem. Read from a TCP socket\n" +
                     "Parameters:\n" +
-                    "--hostname <hostname> (-h <hostname>)\n" +
+                    "--hostname <hostname> (-hn <hostname>)\n" +
                     "  The hostname to bind to. If not specified, bind to all interfaces\n" +
                     "--port <port> (-p <port>)\n" +
                     "  The port to listen on\n");
@@ -58,7 +58,7 @@ public boolean setParameter(String key, String value) {
         if (super.setParameter(key, value)) {
             return true;
         }
-        if (key != null && (key.equalsIgnoreCase("--hostname") || key.equalsIgnoreCase("-h"))) {
+        if (key != null && (key.equalsIgnoreCase("--hostname") || key.equalsIgnoreCase("-hn"))) {
             this.hostName = value;
             logger.fine("hostname " + value);
             return true;
diff --git a/src/main/java/nu/sitia/loggenerator/inputitems/UDPInputItem.java b/src/main/java/nu/sitia/loggenerator/inputitems/UDPInputItem.java
@@ -50,7 +50,7 @@ public boolean setParameter(String key, String value) {
         if (key != null && (key.equalsIgnoreCase("--help") || key.equalsIgnoreCase("-h"))) {
             System.out.println("UDPInputItem. Read from a UDP socket\n" +
                     "Parameters:\n" +
-                    "--hostname <hostname> (-h <hostname>)\n" +
+                    "--hostname <hostname> (-hn <hostname>)\n" +
                     "  The hostname to bind to. If not specified, bind to all interfaces\n" +
                     "--port <port> (-p <port>)\n" +
                     "  The port to listen on\n");
@@ -59,7 +59,7 @@ public boolean setParameter(String key, String value) {
         if (super.setParameter(key, value)) {
             return true;
         }
-        if (key != null && (key.equalsIgnoreCase("--hostname") || key.equalsIgnoreCase("-h"))) {
+        if (key != null && (key.equalsIgnoreCase("--hostname") || key.equalsIgnoreCase("-hn"))) {
             this.hostName = value;
             logger.fine("hostname " + value);
             return true;
diff --git a/src/main/java/nu/sitia/loggenerator/outputitems/TCPOutputItem.java b/src/main/java/nu/sitia/loggenerator/outputitems/TCPOutputItem.java
@@ -52,14 +52,14 @@ public boolean setParameter(String key, String value) {
         if (key != null && (key.equalsIgnoreCase("--help") || key.equalsIgnoreCase("-h"))) {
             System.out.println("TCPOutputItem. Write to TCP socket\n" +
                     "Parameters:\n" +
-                    "--hostname, -h <hostname> The hostname to connect to\n" +
+                    "--hostname, -hn <hostname> The hostname to connect to\n" +
                     "--port, -p <port> The port to connect to\n");
             System.exit(1);
         }
         if (super.setParameter(key, value)) {
             return true;
         }
-        if (key != null && (key.equalsIgnoreCase("--hostname") || key.equalsIgnoreCase("-h"))) {
+        if (key != null && (key.equalsIgnoreCase("--hostname") || key.equalsIgnoreCase("-hn"))) {
             this.hostName = value;
             logger.fine("hostname " + value);
             return true;
diff --git a/src/main/java/nu/sitia/loggenerator/outputitems/UDPOutputItem.java b/src/main/java/nu/sitia/loggenerator/outputitems/UDPOutputItem.java
@@ -56,14 +56,14 @@ public boolean setParameter(String key, String value) {
         if (key != null && (key.equalsIgnoreCase("--help") || key.equalsIgnoreCase("-h"))) {
             System.out.println("UDPOutputItem. Write to UDP socket\n" +
                     "Parameters:\n" +
-                    "--hostname, -h <hostname> The hostname to connect to\n" +
+                    "--hostname, -hn <hostname> The hostname to connect to\n" +
                     "--port, -p <port> The port to connect to\n");
             System.exit(1);
         }
         if (super.setParameter(key, value)) {
             return true;
         }
-        if (key != null && (key.equalsIgnoreCase("--hostname") || key.equalsIgnoreCase("-h"))) {
+        if (key != null && (key.equalsIgnoreCase("--hostname") || key.equalsIgnoreCase("-hn"))) {
             this.hostName = value;
             logger.fine("hostname " + value);
             return true;
diff --git a/src/test/java/nu/sitia/loggenerator/filter/RegexTest.java b/src/test/java/nu/sitia/loggenerator/filter/RegexTest.java
@@ -50,5 +50,49 @@ public void testRegex() {
         assertNotSame(template, result.get(0));
     }
 
+    /**
+     * Test regex.
+     */
+    public void testRegexReplaceQuotes() {
+        String template = "2050-01-01T10:00:00.001001Z \"Some\" event here";
+        String expected = "2050-01-01T10:00:00.001001Z \\\"Some\\\" event here";
+        String regex = "\"";
+        String value = "\\\"";
+
+        RegexFilter regexFilter = new RegexFilter(null);
+        regexFilter.setParameter("--regex", regex);
+        regexFilter.setParameter("--value", value);
+        regexFilter.afterPropertiesSet();
+
+        List<String> result = regexFilter.filter(List.of(template));
+
+        assertEquals(expected, result.get(0));
+    }
+
+    /**
+     * Test regex.
+     */
+    public void testRegexReplacement() {
+        String template = "2050-01-01T10:00:00.001001Z \"Some\" event here";
+        String regex = "^.*$";
+        String value = "{\"message\":\"{all}\"}";
+        String expected = "{\"message\":\"2050-01-01T10:00:00.001001Z \\\"Some\\\" event here\"}";
+
+        // First, fix the quotes
+        RegexFilter quoteFilter = new RegexFilter(null);
+        quoteFilter.setParameter("--regex", "\"");
+        quoteFilter.setParameter("--value", "\\\\\"");
+        quoteFilter.afterPropertiesSet();
+        List<String> quotedResult = quoteFilter.filter(List.of(template));
+
+        RegexFilter regexFilter = new RegexFilter(null);
+        regexFilter.setParameter("--regex", regex);
+        regexFilter.setParameter("--value", value);
+        regexFilter.afterPropertiesSet();
+
+        List<String> result = regexFilter.filter(List.of(quotedResult.get(0)));
+
+        assertEquals(expected, result.get(0));
+    }
 
 }

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 target
 -.vscode
 +.vscode
 +.DS_Store