[GH-251] Added hide-operation-in-expected option

Author: Nikita-Smirnov-Exactpro

README.md

@@ -1,4 +1,4 @@
-# th2 check1 (4.8.0)
+# th2 check1 (4.9.0)
 
 ## Overview
 
@@ -145,6 +145,7 @@ spec:
     check-null-value-as-empty: false
     enable-checkpoint-events-publication: true
     await-root-event-storing-on-wait-for-result: false
+    hide-operation-in-expected: false
     rules-execution-threads: 1
   pins:
     mq:
@@ -204,6 +205,7 @@ spec:
     decimal-precision: '0.00001'
     enable-checkpoint-events-publication: true
     await-root-event-storing-on-wait-for-result: false
+    hide-operation-in-expected: false
     rules-execution-threads: 1
 ```
 
@@ -292,6 +294,21 @@ spec:
 ```
 _Disabled by default._
 
+#### hide-operation-in-expected
+
+Hides operation name from expected values for operations: `IN`, `NOT_IN`, `LIKE`, `NOT_LIKE`, `WILDCARD`, `NOT_WILDCARD`
+
+| operation      | option false              | option true      |
+|----------------|---------------------------|------------------|
+| `IN`           | `IN [opt-1, opt-2]`       | `[opt-1, opt-2]` |
+| `NOT_IN`       | `NOT_IN [opt-1, opt-2]`   | `[opt-1, opt-2]` |
+| `LIKE`         | `LIKE regex.*`            | `regex.*`        |
+| `NOT_LIKE`     | `NOT_LIKE regex.*`        | `regex.*`        |
+| `WILDCARD`     | `WILDCARD wildcard?*`     | `wildcard?*`     |
+| `NOT_WILDCARD` | `NOT_WILDCARD wildcard?*` | `wildcard?*`     |
+
+_Disabled by default._
+
 ## Required pins
 
 The Check1 component has two types of pin:
@@ -334,6 +351,20 @@ The `th2_check1_active_tasks_number` metric separate rules with label `rule_type
 
 ## Release Notes
 
+### 4.9.0
+
++ [[GH-251] Filter with either IN, NOT_IN, LIKE, NOT_LIKE, WILDCARD, NOT_WILDCARD operation adds the operation name before expected value into event](https://github.com/th2-net/th2-check1/issues/251)
+  + Added [hide-operation-in-expected](#hide-operation-in-expected)
++ Update:
+  + th2-plugin: `0.3.10` (bom: `4.14.3`)
+  + kotlin: `2.3.0`
+  + rxjava: `3.1.12`
+  + common: `5.17.0-dev`
+  + common-utils: `5.4.0-dev`
+  + grpc-check1: `4.5.1`
+  + grpc-lw-data-provider: `2.6.0-dev`
+  + lw-data-provider-utils: `0.0.8-dev`
+
 ### 4.8.0
 + Added `await-root-event-storing-on-wait-for-result` option.
 + Update:

gradle.properties

@@ -1,4 +1,4 @@
 kotlin.code.style=official
-release_version=4.8.0
+release_version=4.9.0
 description='th2 check1 box'
 vcs_url=https://github.com/th2-net/th2-check1

src/main/java/com/exactpro/th2/check1/event/VerificationEntryUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 Exactpro (Exactpro Systems Limited)
+ * Copyright 2020-2025 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.
@@ -25,20 +25,26 @@
 import com.exactpro.th2.common.event.bean.VerificationStatus;
 import com.exactpro.th2.common.grpc.FilterOperation;
 import com.exactpro.th2.sailfish.utils.filter.IOperationFilter;
+import com.exactpro.th2.sailfish.utils.filter.ListContainFilter;
+import com.exactpro.th2.sailfish.utils.filter.RegExFilter;
+import com.exactpro.th2.sailfish.utils.filter.WildcardFilter;
 import com.exactpro.th2.sailfish.utils.filter.util.FilterUtils;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.LinkedHashMap;
 import java.util.Map.Entry;
 import java.util.Objects;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
+import static com.exactpro.sf.comparison.Formatter.formatForHtml;
+
 public class VerificationEntryUtils {
 
-    public static VerificationEntry createVerificationEntry(ComparisonResult result) {
+    public static VerificationEntry createVerificationEntry(ComparisonResult result, boolean hideOperationInExpected) {
         VerificationEntry verificationEntry = new VerificationEntry();
         verificationEntry.setActual(convertActual(result));
-        verificationEntry.setExpected(convertExpectedResult(result));
+        verificationEntry.setExpected(convertExpectedResult(result, hideOperationInExpected));
         verificationEntry.setStatus(toVerificationStatus(result));
         verificationEntry.setKey(result.isKey());
         verificationEntry.setOperation(resolveOperation(result));
@@ -47,7 +53,7 @@ public static VerificationEntry createVerificationEntry(ComparisonResult result)
             verificationEntry.setFields(result.getResults().entrySet().stream()
                     .collect(Collectors.toMap(
                             Entry::getKey,
-                            entry -> createVerificationEntry(entry.getValue()),
+                            entry -> createVerificationEntry(entry.getValue(), hideOperationInExpected),
                             (entry1, entry2) -> entry1,
                             LinkedHashMap::new)));
             verificationEntry.setType("collection");
@@ -105,8 +111,32 @@ private static VerificationStatus toVerificationStatus(ComparisonResult result)
         }
     }
 
-    private static String convertExpectedResult(ComparisonResult result) {
-        return result.getExpected() == null ? null : Formatter.formatExpected(result);
+    public static VerificationEntry createVerificationEntry(ComparisonResult result) {
+        return createVerificationEntry(result, false);
+    }
+
+    private static String convertExpectedResult(ComparisonResult result, boolean hideOperationInExpected) {
+        if (result.getExpected() == null) {
+            return null;
+        }
+        if (hideOperationInExpected) {
+            // this code is modified copy of Formatter.formatExpected method
+            Object expected = result.getExpected();
+
+            if (expected instanceof IComparisonFilter) {
+                if (expected instanceof RegExFilter) {
+                    return ((Pattern)((RegExFilter) expected).getValue()).pattern();
+                } else if (expected instanceof ListContainFilter) {
+                    return ((ListContainFilter) expected).getValue().toString();
+                } else if (expected instanceof WildcardFilter) {
+                    return ((WildcardFilter) expected).getValue().toString();
+                }
+                return ((IComparisonFilter) expected).getCondition(result.getActual());
+            }
+
+            return formatForHtml(expected, true);
+        }
+        return Formatter.formatExpected(result);
     }
 
     private static String extractHint(ComparisonResult result) {

src/main/java/com/exactpro/th2/check1/event/bean/builder/VerificationBuilder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2020 Exactpro (Exactpro Systems Limited)
+ * Copyright 2020-2025 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.
@@ -19,34 +19,45 @@
 import java.util.Map;
 
 import com.exactpro.sf.comparison.ComparisonResult;
-import com.exactpro.th2.check1.event.VerificationEntryUtils;
 import com.exactpro.th2.common.event.IBodyData;
 import com.exactpro.th2.common.event.bean.Verification;
 import com.exactpro.th2.common.event.bean.VerificationEntry;
 import com.exactpro.th2.common.grpc.MessageFilter;
 import com.exactpro.th2.common.grpc.MetadataFilter;
 
+import static com.exactpro.th2.check1.event.VerificationEntryUtils.createVerificationEntry;
+
+@SuppressWarnings("unused")
 public class VerificationBuilder {
 
     public static final String VERIFICATION_TYPE = "verification";
     public static final String PASSED_STATUS = "PASSED";
     public static final String FAILED_STATUS = "FAILED";
 
     protected String status;
-    protected Map<String, VerificationEntry> fields = new HashMap<>();
+    protected final Map<String, VerificationEntry> fields = new HashMap<>();
+    protected final boolean hideOperationInExpected;
+
+    public VerificationBuilder(boolean hideOperationInExpected) {
+        this.hideOperationInExpected = hideOperationInExpected;
+    }
+
+    public VerificationBuilder() {
+        this(false);
+    }
 
     public VerificationBuilder status(String status) {
         this.status = status;
         return this;
     }
 
     public VerificationBuilder verification(String fieldName, ComparisonResult comparisonResult, MessageFilter messageFilter, boolean listItemAsSeparate) {
-        fields.put(fieldName, VerificationEntryUtils.createVerificationEntry(comparisonResult));
+        fields.put(fieldName, createVerificationEntry(comparisonResult, hideOperationInExpected));
         return this;
     }
 
     public VerificationBuilder verification(String fieldName, ComparisonResult comparisonResult, MetadataFilter messageFilter) {
-        fields.put(fieldName, VerificationEntryUtils.createVerificationEntry(comparisonResult));
+        fields.put(fieldName, createVerificationEntry(comparisonResult, hideOperationInExpected));
         return this;
     }
 

src/main/kotlin/com/exactpro/th2/check1/configuration/Check1Configuration.kt

@@ -70,4 +70,7 @@ class Check1Configuration(
 
     @field:JsonProperty(value = "await-root-event-storing-on-wait-for-result", defaultValue = "false")
     val awaitRootEventStoringOnWaitForResult: Boolean = false,
+
+    @field:JsonProperty(value = "hide-operation-in-expected", defaultValue = "false")
+    val hideOperationInExpected: Boolean = false
 )

src/main/kotlin/com/exactpro/th2/check1/entities/RuleConfiguration.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2023 Exactpro (Exactpro Systems Limited)
+ * Copyright 2021-2025 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.
@@ -25,7 +25,8 @@ data class RuleConfiguration(
     val decimalPrecision: Double,
     val maxEventBatchContentSize: Int,
     val isCheckNullValueAsEmpty: Boolean,
-    val defaultCheckSimpleCollectionsOrder: Boolean
+    val defaultCheckSimpleCollectionsOrder: Boolean,
+    val hideOperationInExpected: Boolean,
 ) {
     init {
         require(!timePrecision.isNegative) { "Time precision cannot be negative" }

src/main/kotlin/com/exactpro/th2/check1/rule/AbstractCheckTask.kt

@@ -781,7 +781,7 @@ abstract class AbstractCheckTask(
         protoFilter: RootMessageFilter,
         comparisonResult: ComparisonResult
     ): Event {
-        val verificationComponent = VerificationBuilder()
+        val verificationComponent = VerificationBuilder(ruleConfiguration.hideOperationInExpected)
         comparisonResult.results.forEach { (key: String?, value: ComparisonResult?) ->
             verificationComponent.verification(key, value, protoFilter.messageFilter, true)
         }
@@ -804,7 +804,7 @@ abstract class AbstractCheckTask(
         metadataFilter: MetadataFilter,
         comparisonResult: ComparisonResult
     ): Event {
-        val verificationComponent = VerificationBuilder()
+        val verificationComponent = VerificationBuilder(ruleConfiguration.hideOperationInExpected)
         comparisonResult.results.forEach { (key: String?, value: ComparisonResult?) ->
             verificationComponent.verification(key, value, metadataFilter)
         }

src/main/kotlin/com/exactpro/th2/check1/rule/RuleFactory.kt

@@ -55,6 +55,7 @@ class RuleFactory(
     private val decimalPrecision = configuration.decimalPrecision
     private val isCheckNullValueAsEmpty = configuration.isCheckNullValueAsEmpty
     private val defaultCheckSimpleCollectionsOrder = configuration.isDefaultCheckSimpleCollectionsOrder
+    private val hideOperationInExpected = configuration.hideOperationInExpected
 
     fun createCheckRule(
         request: CheckRuleRequest,
@@ -81,7 +82,8 @@ class RuleFactory(
                     timePrecision,
                     decimalPrecision, maxEventBatchContentSize,
                     isCheckNullValueAsEmpty,
-                    defaultCheckSimpleCollectionsOrder
+                    defaultCheckSimpleCollectionsOrder,
+                    hideOperationInExpected,
                 )
 
                 CheckRuleTask(
@@ -129,7 +131,8 @@ class RuleFactory(
                     decimalPrecision,
                     maxEventBatchContentSize,
                     isCheckNullValueAsEmpty,
-                    defaultCheckSimpleCollectionsOrder
+                    defaultCheckSimpleCollectionsOrder,
+                    hideOperationInExpected,
                 )
 
                 SequenceCheckRuleTask(
@@ -177,7 +180,8 @@ class RuleFactory(
                     decimalPrecision,
                     maxEventBatchContentSize,
                     isCheckNullValueAsEmpty,
-                    defaultCheckSimpleCollectionsOrder
+                    defaultCheckSimpleCollectionsOrder,
+                    hideOperationInExpected,
                 )
 
                 NoMessageCheckTask(
@@ -219,7 +223,8 @@ class RuleFactory(
                         decimalPrecision,
                         maxEventBatchContentSize,
                         isCheckNullValueAsEmpty,
-                        defaultCheckSimpleCollectionsOrder
+                        defaultCheckSimpleCollectionsOrder,
+                        hideOperationInExpected,
                 )
 
                 SilenceCheckTask(

src/test/kotlin/com/exactpro/th2/check1/entities/RuleConfigurationTest.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 Exactpro (Exactpro Systems Limited)
+ * Copyright 2020-2025 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.
@@ -27,11 +27,14 @@ class RuleConfigurationTest {
     fun `check that time precision is negative`() {
         val exception = assertThrows<IllegalArgumentException> {
             RuleConfiguration(
-                    TaskTimeout(0, 0), null, Duration.ofSeconds(-1),
-                    0.005,
-                    1,
-                    true,
-                    true
+                taskTimeout = TaskTimeout(0, 0),
+                description = null,
+                timePrecision = Duration.ofSeconds(-1),
+                decimalPrecision = 0.005,
+                maxEventBatchContentSize = 1,
+                isCheckNullValueAsEmpty = true,
+                defaultCheckSimpleCollectionsOrder = true,
+                hideOperationInExpected = false,
             )
         }
         assertEquals(exception.message, "Time precision cannot be negative")
@@ -41,11 +44,14 @@ class RuleConfigurationTest {
     fun `check that decimal precision is negative`() {
         val exception = assertThrows<IllegalArgumentException> {
             RuleConfiguration(
-                    TaskTimeout(0, 0), null, Duration.ofSeconds(1),
-                    -0.005,
-                    1,
-                    true,
-                    true
+                taskTimeout = TaskTimeout(0, 0),
+                description = null,
+                timePrecision = Duration.ofSeconds(1),
+                decimalPrecision = -0.005,
+                maxEventBatchContentSize = 1,
+                isCheckNullValueAsEmpty = true,
+                defaultCheckSimpleCollectionsOrder = true,
+                hideOperationInExpected = false,
             )
         }
         assertEquals(exception.message, "Decimal precision cannot be negative")
@@ -57,13 +63,14 @@ class RuleConfigurationTest {
 
         val exception = assertThrows<IllegalArgumentException> {
             RuleConfiguration(
-                    TaskTimeout(0, 0),
-                    null,
-                    Duration.ofSeconds(1),
-                    0.005,
-                    maxEventBatchContentSize,
-                    true,
-                    true
+                taskTimeout = TaskTimeout(0, 0),
+                description = null,
+                timePrecision = Duration.ofSeconds(1),
+                decimalPrecision = 0.005,
+                maxEventBatchContentSize = maxEventBatchContentSize,
+                isCheckNullValueAsEmpty = true,
+                defaultCheckSimpleCollectionsOrder = true,
+                hideOperationInExpected = false,
             )
         }
         assertEquals(exception.message, "'maxEventBatchContentSize' should be greater than zero, actual: $maxEventBatchContentSize")
@@ -75,13 +82,14 @@ class RuleConfigurationTest {
 
         val exception = assertThrows<IllegalArgumentException> {
             RuleConfiguration(
-                    TaskTimeout(timeout, 0),
-                    null,
-                    Duration.ofSeconds(1),
-                    0.005,
-                    1,
-                    true,
-                    true
+                taskTimeout = TaskTimeout(timeout, 0),
+                description = null,
+                timePrecision = Duration.ofSeconds(1),
+                decimalPrecision = 0.005,
+                maxEventBatchContentSize = 1,
+                isCheckNullValueAsEmpty = true,
+                defaultCheckSimpleCollectionsOrder = true,
+                hideOperationInExpected = false,
             )
         }
         assertEquals(exception.message, "'timeout' should be set or be greater than zero, actual: $timeout")