[TH2-5157] Added NOT_WILDCARD filter operation, which filter a fiel…

…d which isn't matched by wildcard expression.
th2-net · Jan 26, 2024 · 4b7fb60 · 4b7fb60
1 parent 681e43e
commit 4b7fb60
Show file tree

Hide file tree

Showing 5 changed files with 96 additions and 154 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# th2 common library (Java) (5.7.2)
+# th2 common library (Java) (5.8.0)
 
 ## Usage
 
@@ -148,6 +148,7 @@ Filters format:
     * `EMPTY` - the filter passes if the field is empty
     * `NOT_EMPTY` - the filter passes if the field is not empty
     * `WILDCARD` - filters the field by wildcard expression
+    * `NOT_WILDCARD` - filters the field which isn't matched by wildcard expression
 
 ```json
 {
@@ -501,6 +502,9 @@ dependencies {
 
 ## Release notes
 
+### 5.8.0-dev
++ Added `NOT_WILDCARD` filter operation, which filter a field which isn't matched by wildcard expression.
+
 ### 5.7.2-dev
 + Event builder checks is the book name from attached message match to the event book name
 

diff --git a/gradle.properties b/gradle.properties
@@ -1,5 +1,5 @@
 #
-# Copyright 2022-2023 Exactpro (Exactpro Systems Limited)
+# Copyright 2022-2024 Exactpro (Exactpro Systems Limited)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-release_version=5.7.3
+release_version=5.8.0
 description='th2 common library (Java)'
 vcs_url=https://github.com/th2-net/th2-common-j
 kapt.include.compile.classpath=false
diff --git a/src/main/kotlin/com/exactpro/th2/common/schema/filter/strategy/impl/FieldValueChecker.kt b/src/main/kotlin/com/exactpro/th2/common/schema/filter/strategy/impl/FieldValueChecker.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 Exactpro (Exactpro Systems Limited)
+ * Copyright 2022-2024 Exactpro (Exactpro Systems Limited)
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -27,4 +27,5 @@ fun FieldFilterConfiguration.checkFieldValue(value: String?) =
         FieldFilterOperation.EMPTY -> value.isNullOrEmpty()
         FieldFilterOperation.NOT_EMPTY -> !value.isNullOrEmpty()
         FieldFilterOperation.WILDCARD -> FilenameUtils.wildcardMatch(value, expectedValue)
+        FieldFilterOperation.NOT_WILDCARD -> !FilenameUtils.wildcardMatch(value, expectedValue)
     }
diff --git a/...kotlin/com/exactpro/th2/common/schema/message/configuration/MessageRouterConfiguration.kt b/...kotlin/com/exactpro/th2/common/schema/message/configuration/MessageRouterConfiguration.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 Exactpro (Exactpro Systems Limited)
+ * Copyright 2020-2024 Exactpro (Exactpro Systems Limited)
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -92,7 +92,8 @@ enum class FieldFilterOperation {
     NOT_EQUAL,
     EMPTY,
     NOT_EMPTY,
-    WILDCARD
+    WILDCARD,
+    NOT_WILDCARD,
 }
 
 data class GlobalNotificationConfiguration(

diff --git a/...tlin/com/exactpro/th2/common/schema/message/impl/rabbitmq/transport/TransportUtilsTest.kt b/...tlin/com/exactpro/th2/common/schema/message/impl/rabbitmq/transport/TransportUtilsTest.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Exactpro (Exactpro Systems Limited)
+ * Copyright 2023-2024 Exactpro (Exactpro Systems Limited)
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@ import com.exactpro.th2.common.schema.filter.strategy.impl.AbstractTh2MsgFilterS
 import com.exactpro.th2.common.schema.filter.strategy.impl.AbstractTh2MsgFilterStrategy.SESSION_ALIAS_KEY
 import com.exactpro.th2.common.schema.filter.strategy.impl.AbstractTh2MsgFilterStrategy.SESSION_GROUP_KEY
 import com.exactpro.th2.common.schema.message.configuration.FieldFilterConfiguration
+import com.exactpro.th2.common.schema.message.configuration.FieldFilterOperation
 import com.exactpro.th2.common.schema.message.configuration.FieldFilterOperation.EQUAL
 import com.exactpro.th2.common.schema.message.configuration.FieldFilterOperation.NOT_EMPTY
 import com.exactpro.th2.common.schema.message.configuration.FieldFilterOperation.NOT_EQUAL
@@ -34,6 +35,7 @@ import org.apache.commons.collections4.MultiMapUtils
 import org.junit.jupiter.api.DynamicTest
 import org.junit.jupiter.api.TestFactory
 import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.CsvSource
 import org.junit.jupiter.params.provider.ValueSource
 import java.time.Instant
 import kotlin.test.assertNull
@@ -101,180 +103,114 @@ class TransportUtilsTest {
             .setSessionGroup(strValue)
             .build()
         assertSame(group, listOf<RouterFilter>().filter(group))
+    }
+
+    @ParameterizedTest
+    @CsvSource(
+        "abc,abc,!abc,EQUAL",
+        "abc,!abc,abc,NOT_EQUAL",
+        "'','',abc,EMPTY",
+        "'',abc,'',NOT_EMPTY",
+        "abc_*,abc_,_abc_,WILDCARD",
+        "abc_*,abc_123,_abc_,WILDCARD",
+        "abc_?,abc_1,abc_,WILDCARD",
+        "abc_?,abc_a,abc_12,WILDCARD",
+        "abc_*,_abc_,abc_,NOT_WILDCARD",
+        "abc_*,_abc_,abc_123,NOT_WILDCARD",
+        "abc_?,abc_,abc_1,NOT_WILDCARD",
+        "abc_?,abc_12,abc_a,NOT_WILDCARD",
+    )
+    fun `filter operation test`(filterValue: String, validValue: String, invalidValue: String, operation: String) {
+        val filters = listOf(
+            MqRouterFilterConfiguration(
+                MultiMapUtils.newListValuedHashMap<String, FieldFilterConfiguration>().apply {
+                    put(
+                        SESSION_ALIAS_KEY,
+                        FieldFilterConfiguration(
+                            SESSION_ALIAS_KEY,
+                            filterValue,
+                            FieldFilterOperation.valueOf(operation)
+                        )
+                    )
+                },
+                emptyMultiMap()
+            )
+        )
+
+        val batch = EMPTY_MESSAGE_ID.toBuilder().setSessionAlias(validValue).build().toBatch()
+        assertSame(batch, filters.filter(batch), "'$validValue' matched by '$filterValue'[$operation] filter")
 
+        assertNull(filters.filter(
+            EMPTY_MESSAGE_ID.toBuilder().setSessionAlias(invalidValue).build().toBatch()
+        ), "'$validValue' isn't matched by '$filterValue'[$operation] filter")
     }
 
     @TestFactory
     fun `filter test`(): Collection<DynamicTest> {
         return listOf(
             DynamicTest.dynamicTest("empty batch") {
-                val batch = GroupBatch.builder()
-                    .setBook("")
-                    .setSessionGroup("")
-                    .addGroup(
-                        MessageGroup.builder()
-                            .addMessage(
-                                ParsedMessage.builder()
-                                    .setId(
-                                        MessageId.builder()
-                                            .setSessionAlias("")
-                                            .setDirection(Direction.OUTGOING)
-                                            .setSequence(1)
-                                            .setTimestamp(Instant.now())
-                                            .build()
-                                    )
-                                    .setType("")
-                                    .setBody(emptyMap())
-                                    .build()
-                            )
-                            .build()
-                    ).build()
+                val batch = EMPTY_MESSAGE_ID.toBatch()
                 assertNull(routerFilters.filter(batch))
             },
             DynamicTest.dynamicTest("only book match") {
-                val batch = GroupBatch.builder()
-                    .setBook(bookA)
-                    .setSessionGroup("")
-                    .addGroup(
-                        MessageGroup.builder()
-                            .addMessage(
-                                ParsedMessage.builder()
-                                    .setId(
-                                        MessageId.builder()
-                                            .setSessionAlias("")
-                                            .setDirection(Direction.OUTGOING)
-                                            .setSequence(1)
-                                            .setTimestamp(Instant.now())
-                                            .build()
-                                    )
-                                    .setType("")
-                                    .setBody(emptyMap())
-                                    .build()
-                            )
-                            .build()
-                    ).build()
+                val batch = EMPTY_MESSAGE_ID.toBatch(book = bookA)
                 assertNull(routerFilters.filter(batch))
             },
             DynamicTest.dynamicTest("only book and group match") {
-                val batch = GroupBatch.builder()
-                    .setBook(bookA)
-                    .setSessionGroup(groupA)
-                    .addGroup(
-                        MessageGroup.builder()
-                            .addMessage(
-                                ParsedMessage.builder()
-                                    .setId(
-                                        MessageId.builder()
-                                            .setSessionAlias("")
-                                            .setDirection(Direction.OUTGOING)
-                                            .setSequence(1)
-                                            .setTimestamp(Instant.now())
-                                            .build()
-                                    )
-                                    .setType("")
-                                    .setBody(emptyMap())
-                                    .build()
-                            )
-                            .build()
-                    ).build()
+                val batch = EMPTY_MESSAGE_ID.toBatch(book = bookA, sessionGroup = groupA)
                 assertNull(routerFilters.filter(batch))
             },
             DynamicTest.dynamicTest("only book, group, protocol match") {
-                val batch = GroupBatch.builder()
-                    .setBook(bookA)
-                    .setSessionGroup(groupA)
-                    .addGroup(
-                        MessageGroup.builder()
-                            .addMessage(
-                                ParsedMessage.builder()
-                                    .setProtocol(protocolA)
-                                    .setId(
-                                        MessageId.builder()
-                                            .setSessionAlias("")
-                                            .setDirection(Direction.OUTGOING)
-                                            .setSequence(1)
-                                            .setTimestamp(Instant.now())
-                                            .build()
-                                    )
-                                    .setType("")
-                                    .setBody(emptyMap())
-                                    .build()
-                            )
-                            .build()
-                    ).build()
+                val batch = EMPTY_MESSAGE_ID
+                    .toBatch(book = bookA, sessionGroup = groupA, protocol = protocolA)
                 assertNull(routerFilters.filter(batch))
             },
             DynamicTest.dynamicTest("with partial message match") {
-                val batch = GroupBatch.builder()
-                    .setBook(bookA)
-                    .setSessionGroup(groupA)
-                    .addGroup(
-                        MessageGroup.builder()
-                            .addMessage(
-                                ParsedMessage.builder()
-                                    .setProtocol(protocolA)
-                                    .setId(
-                                        MessageId.builder()
-                                            .setSessionAlias("")
-                                            .setDirection(Direction.OUTGOING)
-                                            .setSequence(1)
-                                            .setTimestamp(Instant.now())
-                                            .build()
-                                    )
-                                    .setType(msgType)
-                                    .setBody(emptyMap())
-                                    .build()
-                            )
-                            .build()
-                    ).build()
+                val batch = EMPTY_MESSAGE_ID
+                    .toBatch(book = bookA, sessionGroup = groupA, type = msgType, protocol = protocolA)
                 assertNull(routerFilters.filter(batch))
             },
             DynamicTest.dynamicTest("full match for A") {
-                val batch = GroupBatch.builder()
-                    .setBook(bookA)
-                    .setSessionGroup(groupA)
-                    .addGroup(
-                        MessageGroup.builder()
-                            .addMessage(
-                                ParsedMessage.builder()
-                                    .setType(msgType)
-                                    .setBody(emptyMap())
-                                    .setProtocol(protocolA)
-                                    .apply {
-                                        idBuilder()
-                                            .setSessionAlias("alias")
-                                            .setDirection(Direction.OUTGOING)
-                                            .setSequence(1)
-                                            .setTimestamp(Instant.now())
-                                    }.build()
-                            )
-                            .build()
-                    ).build()
+                val batch = EMPTY_MESSAGE_ID.toBuilder().setSessionAlias("alias").build()
+                    .toBatch(book = bookA, sessionGroup = groupA, type = msgType, protocol = protocolA)
                 assertSame(batch, routerFilters.filter(batch))
             },
             DynamicTest.dynamicTest("full match for B") {
-                val batch = GroupBatch.builder()
-                    .setBook(bookB)
-                    .setSessionGroup(groupB)
-                    .addGroup(
-                        MessageGroup.builder()
-                            .addMessage(
-                                ParsedMessage.builder()
-                                    .setType(msgType)
-                                    .setBody(emptyMap())
-                                    .setProtocol(protocolB)
-                                    .apply {
-                                        idBuilder()
-                                            .setSessionAlias("alias")
-                                            .setDirection(Direction.INCOMING)
-                                            .setSequence(1)
-                                            .setTimestamp(Instant.now())
-                                    }.build()
-                            )
-                            .build()
-                    ).build()
+                val batch = EMPTY_MESSAGE_ID.toBuilder()
+                    .setSessionAlias("alias").setDirection(Direction.INCOMING).build()
+                    .toBatch(book = bookB, sessionGroup = groupB, type = msgType, protocol = protocolB)
                 assertSame(batch, routerFilters.filter(batch))
             },
         )
     }
+
+    companion object {
+        private val EMPTY_MESSAGE_ID = MessageId.builder()
+            .setSessionAlias("")
+            .setDirection(Direction.OUTGOING)
+            .setSequence(1)
+            .setTimestamp(Instant.now())
+            .build()
+
+        private fun MessageId.toBatch(
+            book: String = "",
+            sessionGroup: String = "",
+            type: String = "",
+            protocol: String = "",
+        ) = GroupBatch.builder()
+            .setBook(book)
+            .setSessionGroup(sessionGroup)
+            .addGroup(
+                MessageGroup.builder()
+                    .addMessage(
+                        ParsedMessage.builder()
+                            .setId(this)
+                            .setType(type)
+                            .setProtocol(protocol)
+                            .setBody(emptyMap())
+                            .build()
+                    )
+                    .build()
+            ).build()
+    }
 }