docs: uuid v4 validation matcher

in addition to #1248.
citrusframework · Nov 10, 2024 · d2bf6d1 · d2bf6d1
1 parent 133951c
commit d2bf6d1
Show file tree

Hide file tree

Showing 5 changed files with 134 additions and 2 deletions.
diff --git a/...se/src/main/java/org/citrusframework/validation/matcher/core/UuidV4ValidationMatcher.java b/...se/src/main/java/org/citrusframework/validation/matcher/core/UuidV4ValidationMatcher.java
@@ -24,9 +24,10 @@
 import java.util.UUID;
 
 /**
- * UuidValidationMatcher checks if valid UUID version 4 is present
+ * This validation matcher checks if a valid UUID version 4 is present.
  */
 public class UuidV4ValidationMatcher implements ValidationMatcher {
+
     @Override
     public void validate(String fieldName, String value, List<String> controlParameters, TestContext context) throws ValidationException {
         try {

diff --git a/...rc/test/java/org/citrusframework/integration/validation/DateRangeValidationMatcherIT.java b/...rc/test/java/org/citrusframework/integration/validation/DateRangeValidationMatcherIT.java
@@ -25,6 +25,7 @@
  * @since 2.5
  */
 public class DateRangeValidationMatcherIT  extends TestNGCitrusSpringSupport {
+
     @Test
     @CitrusTestSource(type = TestLoader.SPRING)
     public void DateRangeValidationMatcherIT() {}

diff --git a/...g/src/test/java/org/citrusframework/integration/validation/UuidV4ValidationMatcherIT.java b/...g/src/test/java/org/citrusframework/integration/validation/UuidV4ValidationMatcherIT.java
@@ -0,0 +1,30 @@
+/*
+ * Copyright the original author or authors.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.citrusframework.integration.validation;
+
+import org.citrusframework.annotations.CitrusTestSource;
+import org.citrusframework.common.TestLoader;
+import org.citrusframework.testng.spring.TestNGCitrusSpringSupport;
+import org.testng.annotations.Test;
+
+public class UuidV4ValidationMatcherIT extends TestNGCitrusSpringSupport {
+
+    @Test
+    @CitrusTestSource(type = TestLoader.SPRING)
+    public void UuidV4ValidationMatcherIT() {
+    }
+}
diff --git a/...c/test/resources/org/citrusframework/integration/validation/UuidV4ValidationMatcherIT.xml b/...c/test/resources/org/citrusframework/integration/validation/UuidV4ValidationMatcherIT.xml
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<spring:beans xmlns="http://www.citrusframework.org/schema/testcase"
+        xmlns:spring="http://www.springframework.org/schema/beans"
+        xmlns:http="http://www.citrusframework.org/schema/http/testcase"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+                  http://www.citrusframework.org/schema/testcase http://www.citrusframework.org/schema/testcase/citrus-testcase.xsd
+                  http://www.citrusframework.org/schema/http/testcase http://www.citrusframework.org/schema/http/testcase/citrus-http-testcase.xsd">
+  <testcase name="UuidV4ValidationMatcherIT">
+    <meta-info>
+      <author>bbortt</author>
+      <creationdate>2014-11-10</creationdate>
+      <status>FINAL</status>
+      <last-updated-by>bbortt</last-updated-by>
+      <last-updated-on>2014-11-10T00:00:00</last-updated-on>
+    </meta-info>
+
+    <description>
+      Tests the @isUUIDv4()@ validator
+    </description>
+
+    <variables>
+      <variable name="validUuid" value="653ce6fd-dca4-4672-bbc0-16e2b74b8b81"/>
+      <variable name="invalidUuid" value="019314e4-1eab-70a2-84cc-1b1328b36cdb"/>
+    </variables>
+
+    <actions>
+      <send endpoint="helloEndpoint">
+        <message>
+          <data>Hello Citrus!</data>
+        </message>
+        <header>
+          <element name="message-id" value="${validUuid}"/>
+        </header>
+      </send>
+
+      <receive endpoint="helloEndpoint">
+        <message type="plaintext">
+          <data>Hello Citrus!</data>
+        </message>
+        <header>
+          <element name="message-id" value="@isUUIDv4()@"/>
+        </header>
+      </receive>
+
+      <send endpoint="helloEndpoint">
+        <message>
+          <data>Hello Citrus!</data>
+        </message>
+        <header>
+          <element name="message-id" value="${invalidUuid}"/>
+        </header>
+      </send>
+
+      <assert exception="org.citrusframework.exceptions.ValidationException"
+          message="UuidV4ValidationMatcher failed for field 'message-id'. Received value '${invalidUuid}' is not a uuid v4.">
+        <when>
+          <receive endpoint="helloEndpoint">
+            <message type="plaintext">
+              <data>Hello Citrus!</data>
+            </message>
+            <header>
+              <element name="message-id" value="@isUUIDv4()@"/>
+            </header>
+          </receive>
+        </when>
+      </assert>
+    </actions>
+  </testcase>
+</spring:beans>
diff --git a/src/manual/validation-matchers.adoc b/src/manual/validation-matchers.adoc
@@ -1,5 +1,5 @@
 [[validation-matcher]]
-= Validation matcher
+= Validation Matchers
 
 Message validation in Citrus is essential. The framework offers several validation mechanisms for different message types and formats. With test variables we are able to check for simple value equality. We ensure that message entries are equal to predefined expected values. Validation matcher add powerful assertion functionality on top of that. You just can use the predefined validation matcher functionalities in order to perform more complex assertions like *contains* or *isNumber* in your validation statements.
 
@@ -393,3 +393,33 @@ You can now skip all whitespaces in your control value.
 ----
 <value>@trimAllWhitespaces('somevalue')@</value>
 ----
+
+[[matcher-is-uuid-v4]]
+== isUUIDv4()
+
+This validation matcher checks if a valid UUID version 4 is present.
+Given the `<variable name="validUuid" value="653ce6fd-dca4-4672-bbc0-16e2b74b8b81"/>`, usage is as following.
+
+.Example `isUUIDv4()` validation
+[source,xml]
+----
+<actions>
+    <send endpoint="helloEndpoint">
+        <message>
+            <data>Hello Citrus!</data>
+        </message>
+        <header>
+            <element name="message-id" value="${validUuid}"/>
+        </header>
+    </send>
+
+    <receive endpoint="helloEndpoint">
+        <message type="plaintext">
+            <data>Hello Citrus!</data>
+        </message>
+        <header>
+            <element name="message-id" value="@isUUIDv4()@"/>
+        </header>
+    </receive>
+</actions>
+----