Extract PathMatcher and add tests

NaikSoftware · NaikSoftware · commit fc6fc14907ca · 2019-01-21T01:20:08.000+02:00
diff --git a/example-client/build.gradle b/example-client/build.gradle
@@ -7,7 +7,7 @@ buildscript {
         google()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.2.1'
+        classpath 'com.android.tools.build:gradle:3.3.0'
         classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
     }
 }
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
-#Tue Sep 05 08:26:08 MST 2017
+#Sun Jan 20 23:59:55 EET 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.1-all.zip
diff --git a/lib/build.gradle b/lib/build.gradle
@@ -7,7 +7,7 @@ buildscript {
         google()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.2.1'
+        classpath 'com.android.tools.build:gradle:3.3.0'
         classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
         classpath 'org.codehaus.groovy:groovy-android-gradle-plugin:2.0.0'
     }
@@ -59,7 +59,7 @@ dependencies {
     api 'com.squareup.okhttp3:okhttp:3.12.1'
     implementation 'com.android.support:support-annotations:28.0.0'
     testImplementation 'com.andrewreitz:spock-android:2.0.0'
-    testImplementation 'org.testcontainers:testcontainers:1.8.0'
+    testImplementation 'org.testcontainers:testcontainers:1.10.5'
     testImplementation 'org.spockframework:spock-core:1.1-groovy-2.4'
     testImplementation 'org.java-websocket:Java-WebSocket:1.3.6'
     testImplementation 'com.squareup.okhttp3:okhttp:3.12.1'
diff --git a/lib/src/main/java/ua/naiksoftware/stomp/StompClient.java b/lib/src/main/java/ua/naiksoftware/stomp/StompClient.java
@@ -19,6 +19,8 @@
 import io.reactivex.subjects.PublishSubject;
 import ua.naiksoftware.stomp.dto.StompCommand;
 import ua.naiksoftware.stomp.dto.StompMessage;
+import ua.naiksoftware.stomp.pathmatcher.PathMatcher;
+import ua.naiksoftware.stomp.pathmatcher.SimplePathMatcher;
 import ua.naiksoftware.stomp.provider.ConnectionProvider;
 import ua.naiksoftware.stomp.dto.LifecycleEvent;
 import ua.naiksoftware.stomp.dto.StompHeader;
@@ -43,7 +45,7 @@ public class StompClient {
     private PublishSubject<StompMessage> mMessageStream;
     private ConcurrentHashMap<String, Flowable<StompMessage>> mStreamMap;
     private final BehaviorSubject<Boolean> mConnectionStream;
-    private Parser parser;
+    private PathMatcher pathMatcher;
     private Disposable mLifecycleDisposable;
     private Disposable mMessagesDisposable;
     private List<StompHeader> mHeaders;
@@ -56,27 +58,7 @@ public StompClient(ConnectionProvider connectionProvider) {
         mMessageStream = PublishSubject.create();
         mStreamMap = new ConcurrentHashMap<>();
         mConnectionStream = BehaviorSubject.createDefault(false);
-        parser = Parser.NONE;
-    }
-
-    public enum Parser {
-        NONE,
-        RABBITMQ
-    }
-
-    /**
-     * Set the wildcard parser for Topic subscription.
-     * <p>
-     * Right now, the only options are NONE and RABBITMQ.
-     * <p>
-     * When set to RABBITMQ, topic subscription allows for RMQ-style wildcards.
-     * <p>
-     * See more info <a href="https://www.rabbitmq.com/tutorials/tutorial-five-java.html">here</a>.
-     *
-     * @param parser Set to NONE by default
-     */
-    public void setParser(Parser parser) {
-        this.parser = parser;
+        pathMatcher = new SimplePathMatcher();
     }
 
     /**
@@ -243,7 +225,7 @@ public Flowable<StompMessage> topic(@NonNull String destPath, List<StompHeader>
         else if (!mStreamMap.containsKey(destPath))
             mStreamMap.put(destPath,
                     mMessageStream
-                            .filter(msg -> matches(destPath, msg))
+                            .filter(msg -> pathMatcher.matches(destPath, msg))
                             .toFlowable(BackpressureStrategy.BUFFER)
                             .doOnSubscribe(disposable -> subscribePath(destPath, headerList).subscribe())
                             .doFinally(() -> unsubscribePath(destPath).subscribe())
@@ -267,56 +249,19 @@ public void setLegacyWhitespace(boolean legacyWhitespace) {
         this.legacyWhitespace = legacyWhitespace;
     }
 
-    private boolean matches(String path, StompMessage msg) {
-        String dest = msg.findHeader(StompHeader.DESTINATION);
-        if (dest == null) return false;
-        boolean ret;
-
-        switch (parser) {
-            case NONE:
-                ret = path.equals(dest);
-                break;
-
-            case RABBITMQ:
-                // for example string "lorem.ipsum.*.sit":
-
-                // split it up into ["lorem", "ipsum", "*", "sit"]
-                String[] split = path.split("\\.");
-                ArrayList<String> transformed = new ArrayList<>();
-                // check for wildcards and replace with corresponding regex
-                for (String s : split) {
-                    switch (s) {
-                        case "*":
-                            transformed.add("[^.]+");
-                            break;
-                        case "#":
-                            // TODO: make this work with zero-word
-                            // e.g. "lorem.#.dolor" should ideally match "lorem.dolor"
-                            transformed.add(".*");
-                            break;
-                        default:
-                            transformed.add(s);
-                            break;
-                    }
-                }
-                // at this point, 'transformed' looks like ["lorem", "ipsum", "[^.]+", "sit"]
-                StringBuilder sb = new StringBuilder();
-                for (String s : transformed) {
-                    if (sb.length() > 0) sb.append("\\.");
-                    sb.append(s);
-                }
-                String join = sb.toString();
-                // join = "lorem\.ipsum\.[^.]+\.sit"
-
-                ret = dest.matches(join);
-                break;
-
-            default:
-                ret = false;
-                break;
-        }
-
-        return ret;
+    /**
+     * Set the wildcard or other matcher for Topic subscription.
+     * <p>
+     * Right now, the only options are simple, rmq supported.
+     * But you can write you own matcher by implementing {@link PathMatcher}
+     * <p>
+     * When set to {@link ua.naiksoftware.stomp.pathmatcher.RabbitPathMatcher}, topic subscription allows for RMQ-style wildcards.
+     * <p>
+     *
+     * @param pathMatcher Set to {@link SimplePathMatcher} by default
+     */
+    public void setPathMatcher(PathMatcher pathMatcher) {
+        this.pathMatcher = pathMatcher;
     }
 
     private Completable subscribePath(String destinationPath, @Nullable List<StompHeader> headerList) {
diff --git a/lib/src/main/java/ua/naiksoftware/stomp/dto/StompHeader.java b/lib/src/main/java/ua/naiksoftware/stomp/dto/StompHeader.java
@@ -28,4 +28,9 @@ public String getKey() {
     public String getValue() {
         return mValue;
     }
+
+    @Override
+    public String toString() {
+        return "StompHeader{" + mKey + '=' + mValue + '}';
+    }
 }
diff --git a/lib/src/main/java/ua/naiksoftware/stomp/dto/StompMessage.java b/lib/src/main/java/ua/naiksoftware/stomp/dto/StompMessage.java
@@ -93,4 +93,13 @@ public static StompMessage from(@Nullable String data) {
 
         return new StompMessage(command, headers, payload);
     }
+
+    @Override
+    public String toString() {
+        return "StompMessage{" +
+                "command='" + mStompCommand + '\'' +
+                ", headers=" + mStompHeaders +
+                ", payload='" + mPayload + '\'' +
+                '}';
+    }
 }
diff --git a/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/PathMatcher.java b/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/PathMatcher.java
@@ -0,0 +1,8 @@
+package ua.naiksoftware.stomp.pathmatcher;
+
+import ua.naiksoftware.stomp.dto.StompMessage;
+
+public interface PathMatcher {
+
+    boolean matches(String path, StompMessage msg);
+}
diff --git a/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/RabbitPathMatcher.java b/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/RabbitPathMatcher.java
@@ -0,0 +1,51 @@
+package ua.naiksoftware.stomp.pathmatcher;
+
+import ua.naiksoftware.stomp.dto.StompHeader;
+import ua.naiksoftware.stomp.dto.StompMessage;
+
+import java.util.ArrayList;
+
+public class RabbitPathMatcher implements PathMatcher {
+
+    /**
+     * RMQ-style wildcards.
+     * See more info <a href="https://www.rabbitmq.com/tutorials/tutorial-five-java.html">here</a>.
+     */
+    @Override
+    public boolean matches(String path, StompMessage msg) {
+        String dest = msg.findHeader(StompHeader.DESTINATION);
+        if (dest == null) return false;
+
+        // for example string "lorem.ipsum.*.sit":
+
+        // split it up into ["lorem", "ipsum", "*", "sit"]
+        String[] split = path.split("\\.");
+        ArrayList<String> transformed = new ArrayList<>();
+        // check for wildcards and replace with corresponding regex
+        for (String s : split) {
+            switch (s) {
+                case "*":
+                    transformed.add("[^.]+");
+                    break;
+                case "#":
+                    // TODO: make this work with zero-word
+                    // e.g. "lorem.#.dolor" should ideally match "lorem.dolor"
+                    transformed.add(".*");
+                    break;
+                default:
+                    transformed.add(s.replaceAll("\\*", ".*"));
+                    break;
+            }
+        }
+        // at this point, 'transformed' looks like ["lorem", "ipsum", "[^.]+", "sit"]
+        StringBuilder sb = new StringBuilder();
+        for (String s : transformed) {
+            if (sb.length() > 0) sb.append("\\.");
+            sb.append(s);
+        }
+        String join = sb.toString();
+        // join = "lorem\.ipsum\.[^.]+\.sit"
+
+        return dest.matches(join);
+    }
+}
diff --git a/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SimplePathMatcher.java b/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SimplePathMatcher.java
@@ -0,0 +1,14 @@
+package ua.naiksoftware.stomp.pathmatcher;
+
+import ua.naiksoftware.stomp.dto.StompHeader;
+import ua.naiksoftware.stomp.dto.StompMessage;
+
+public class SimplePathMatcher implements PathMatcher {
+
+    @Override
+    public boolean matches(String path, StompMessage msg) {
+        String dest = msg.findHeader(StompHeader.DESTINATION);
+        if (dest == null) return false;
+        else return path.equals(dest);
+    }
+}
diff --git a/lib/src/test/groovy/ua/naiksoftware/stomp/Configuration.groovy b/lib/src/test/groovy/ua/naiksoftware/stomp/Configuration.groovy
@@ -5,6 +5,7 @@ import groovy.util.logging.Slf4j
 import org.testcontainers.containers.BindMode
 import org.testcontainers.containers.GenericContainer
 import org.testcontainers.containers.output.OutputFrame
+import org.testcontainers.containers.startupcheck.StartupCheckStrategy
 import org.testcontainers.containers.wait.strategy.Wait
 import spock.lang.Shared
 import spock.lang.Specification
@@ -30,7 +31,7 @@ class Configuration extends AndroidSpecification {
                 .withCommand('java -jar /app.jar')
                 .withLogConsumer({ frame -> println frame.utf8String })
 //                .waitingFor(Wait.forHttp('/health'))
-                .withExposedPorts(80)
+                .withExposedPorts(8080)
         testServer.start()
         return testServer
     }
diff --git a/lib/src/test/groovy/ua/naiksoftware/stomp/ConnectionTests.groovy b/lib/src/test/groovy/ua/naiksoftware/stomp/ConnectionTests.groovy
@@ -11,7 +11,7 @@ class ConnectionTests extends Configuration {
         given:
         def client = Stomp.over(Stomp.ConnectionProvider.OKHTTP,
                 'ws://' + Configuration.testServer.getContainerIpAddress()
-                        + ':' + Configuration.testServer.getMappedPort(80) + '/example-endpoint/websocket')
+                        + ':' + Configuration.testServer.getFirstMappedPort() + '/example-endpoint/websocket')
         client.connect()
         def testSubscriber = new TestSubscriber<LifecycleEvent>()
 
diff --git a/lib/src/test/groovy/ua/naiksoftware/stomp/PathMatcherTests.groovy b/lib/src/test/groovy/ua/naiksoftware/stomp/PathMatcherTests.groovy
@@ -0,0 +1,28 @@
+package ua.naiksoftware.stomp
+
+import ua.naiksoftware.stomp.dto.StompCommand
+import ua.naiksoftware.stomp.dto.StompHeader
+import ua.naiksoftware.stomp.dto.StompMessage
+import ua.naiksoftware.stomp.pathmatcher.RabbitPathMatcher
+
+class PathMatcherTests extends Configuration {
+
+    def "rmq-style matcher must return expected value"() {
+        given:
+        def matcher = new RabbitPathMatcher()
+
+        expect:
+        matcher.matches(path, message(dest)) == value
+
+        where:
+        path              |          dest          | value
+        'lorem/*/ipsum'   | 'lorem/any/ipsum'      | true
+        'lorem/*/ipsum'   | 'lorem/ipsum'          | false
+        'lorem/*/prefix*' | 'lorem/ipsum/prefix123'| true
+        'lorem/*/pref*3'  | 'lorem/ipsum/prefix123'| true
+    }
+
+    def message(String dest) {
+        return new StompMessage(StompCommand.MESSAGE, [new StompHeader(StompHeader.DESTINATION, dest)], null)
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ buildscript {`
`7`	`7`	`google()`
`8`	`8`	`}`
`9`	`9`	`dependencies {`
`10`		`- classpath 'com.android.tools.build:gradle:3.2.1'`
	`10`	`+ classpath 'com.android.tools.build:gradle:3.3.0'`
`11`	`11`	`classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'`
`12`	`12`	`}`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,4 +28,9 @@ public String getKey() {`
`28`	`28`	`public String getValue() {`
`29`	`29`	`return mValue;`
`30`	`30`	`}`
	`31`	`+`
	`32`	`+ @Override`
	`33`	`+ public String toString() {`
	`34`	`+ return "StompHeader{" + mKey + '=' + mValue + '}';`
	`35`	`+ }`
`31`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -93,4 +93,13 @@ public static StompMessage from(@Nullable String data) {`
`93`	`93`
`94`	`94`	`return new StompMessage(command, headers, payload);`
`95`	`95`	`}`
	`96`	`+`
	`97`	`+ @Override`
	`98`	`+ public String toString() {`
	`99`	`+ return "StompMessage{" +`
	`100`	`+ "command='" + mStompCommand + '\'' +`
	`101`	`+ ", headers=" + mStompHeaders +`
	`102`	`+ ", payload='" + mPayload + '\'' +`
	`103`	`+ '}';`
	`104`	`+ }`
`96`	`105`	`}`