Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document namespace parameter on equalToXml. #335

Merged
merged 1 commit into from
Feb 12, 2025
Merged

document namespace parameter on equalToXml. #335

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions _docs/request-matching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1108,6 +1108,7 @@ The full list of comparison types used by default is as follows:
`SCHEMA_LOCATION`
`NO_NAMESPACE_SCHEMA_LOCATION`
`NODE_TYPE`
`NAMESPACE_PREFIX`
`NAMESPACE_URI`
`TEXT_VALUE`
`PROCESSING_INSTRUCTION_TARGET`
Expand Down Expand Up @@ -1166,6 +1167,56 @@ and
</body>
```
If third argument is passed as `false` then first xml will not match the stub

#### Namespace awareness

To configure how [XML namespaces](https://www.w3schools.com/xml/xml_namespaces.asp) are handled, the
`namespaceAwareness` property can be set.

{% codetabs %}

{% codetab Java %}
```java
.withRequestBody(equalToXml("<body>" +
" <entry>1</entry>" +
" <entry>2</entry>" +
"</body>").withNamespaceAwareness(EqualToXmlPattern.NamespaceAwareness.STRICT))
```
{% endcodetab %}

{% codetab JSON %}
```json
{
"request": {
...
"bodyPatterns" : [ {
"equalToXml" : "<body><entry>1</entry><entry>2</entry></body>",
"namespaceAwareness": "STRICT"
} ]
...
},
...
}
```
{% endcodetab %}

{% endcodetabs %}

The available options for namespace awareness behaviour are `STRICT`, `NONE` and `LEGACY`.

`STRICT` adheres to strict XML namespace comparison.
Namespace prefixes must be bound to a namespace URI.
Namespace prefixes as well as namespace URIs must match (for both elements and attributes), unless explicitly excluded
by the `exemptedComparisons` parameter.

`NONE` does not consider XML namespaces when reading and comparing XML documents.
Namespace prefixes do not need to be bound to a namespace URI and are not considered a separate part of an
element/attribute name (i.e. the entire element/attribute name must match, not just the local name, regardless of
the `exemptedComparisons` parameter).
`xmlns` namespaced attributes are treated no differently to any other attribute.

`LEGACY` is not recommended and is only kept as an option for backwards compatibility.

### XPath

Deems a match if the attribute value is valid XML and matches the XPath expression supplied. An XML document will be considered to match if any elements are returned by the XPath evaluation. WireMock delegates to Java's in-built XPath engine (via XMLUnit), therefore up to (at least) Java 8 it supports XPath version 1.0.
Expand Down