com.github.tomakehurst.wiremock.matching.MatchesXPathPattern Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wiremock Show documentation
A web service test double for all occasions
There is a newer version: 3.9.1
/*
 * Copyright (C) 2016-2023 Thomas Akehurst
 *
 * 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 com.github.tomakehurst.wiremock.matching;

import static com.github.tomakehurst.wiremock.common.LocalNotifier.notifier;
import static com.github.tomakehurst.wiremock.common.ParameterUtils.getFirstNonNull;

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.github.tomakehurst.wiremock.common.ListOrSingle;
import com.github.tomakehurst.wiremock.common.xml.*;
import com.github.tomakehurst.wiremock.stubbing.SubEvent;
import java.util.*;
import java.util.stream.Collectors;

@JsonSerialize(using = XPathPatternJsonSerializer.class)
public class MatchesXPathPattern extends PathPattern {

  private final Map xpathNamespaces;

  public MatchesXPathPattern(String xpath) {
    this(xpath, null, null);
  }

  public MatchesXPathPattern(String xpath, StringValuePattern valuePattern) {
    this(xpath, null, valuePattern);
  }

  public MatchesXPathPattern(String xpath, Map namespaces) {
    this(xpath, namespaces, null);
  }

  public MatchesXPathPattern(
      @JsonProperty("matchesXPath") String xpath,
      @JsonProperty("namespaces") Map namespaces,
      @JsonProperty("valuePattern") StringValuePattern valuePattern) {
    super(xpath, valuePattern);
    xpathNamespaces = namespaces == null || namespaces.isEmpty() ? null : namespaces;
  }

  public MatchesXPathPattern withXPathNamespace(String name, String namespaceUri) {
    Map namespaceMap =
        new HashMap<>(getFirstNonNull(xpathNamespaces, new HashMap<>()));
    namespaceMap.put(name, namespaceUri);
    return new MatchesXPathPattern(expectedValue, Collections.unmodifiableMap(namespaceMap));
  }

  public String getMatchesXPath() {
    return expectedValue;
  }

  @JsonGetter("xPathNamespaces")
  public Map getXPathNamespaces() {
    return xpathNamespaces;
  }

  @Override
  protected MatchResult isSimpleMatch(String value) {
    final XmlNodeFindResult xmlNodeFindResult = findXmlNodes(value);
    ListOrSingle nodeList = xmlNodeFindResult.nodes;
    return MatchResult.of(nodeList != null && !nodeList.isEmpty(), xmlNodeFindResult.subEvents);
  }

  @Override
  protected MatchResult isAdvancedMatch(String value) {
    final XmlNodeFindResult xmlNodeFindResult = findXmlNodes(value);
    ListOrSingle nodeList = xmlNodeFindResult.nodes;
    if (nodeList == null || nodeList.isEmpty()) {
      return MatchResult.noMatch(xmlNodeFindResult.subEvents);
    }

    SortedSet results = new TreeSet<>();
    for (XmlNode node : nodeList) {
      results.add(valuePattern.match(node.toString()));
    }

    return results.last();
  }

  @Override
  public ListOrSingle getExpressionResult(String value) {
    ListOrSingle nodeList = findXmlNodes(value).nodes;
    if (nodeList == null || nodeList.isEmpty()) {
      return ListOrSingle.of();
    }

    return ListOrSingle.of(nodeList.stream().map(XmlNode::toString).collect(Collectors.toList()));
  }

  private XmlNodeFindResult findXmlNodes(String value) {
    // For performance reason, don't try to parse non XML value
    if (value == null || !value.trim().startsWith("<")) {
      final String message =
          String.format("Warning: failed to parse the XML document\nXML: %s", value);
      notifier().info(message);
      return new XmlNodeFindResult(null, SubEvent.warning(message));
    }

    try {
      XmlDocument xmlDocument = Xml.parse(value);
      return new XmlNodeFindResult(xmlDocument.findNodes(expectedValue, xpathNamespaces));
    } catch (XmlException e) {
      final String message =
          String.format(
              "Warning: failed to parse the XML document. Reason: %s\nXML: %s",
              e.getMessage(), value);
      notifier().info(message);
      return new XmlNodeFindResult(null, SubEvent.warning(message));
    } catch (XPathException e) {
      final String message = "Warning: failed to evaluate the XPath expression " + expectedValue;
      notifier().info(message);
      return new XmlNodeFindResult(null, SubEvent.warning(message));
    }
  }

  private static class XmlNodeFindResult {
    final ListOrSingle nodes;
    final List subEvents;

    public XmlNodeFindResult(ListOrSingle nodes, SubEvent... subEvents) {
      this.nodes = nodes;
      this.subEvents = List.of(subEvents);
    }
  }
}