io.github.microcks.util.soapui.assertions.XPathContainsAssertion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microcks-app Show documentation
The newest version!
/*
 * Copyright The Microcks 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 io.github.microcks.util.soapui.assertions;

import io.github.microcks.util.soapui.SoapUIXPathBuilder;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.InputSource;

import javax.xml.xpath.XPathExpression;
import javax.xml.xpath.XPathExpressionException;
import java.io.StringReader;
import java.util.List;
import java.util.Map;

/**
 * An assertion that uses a XPath path expression to extract content and check it's matching expected content.
 * @author laurent
 */
public class XPathContainsAssertion extends WildcardMatchingAssertion {

   /** A simple logger for diagnostic messages. */
   private static Logger log = LoggerFactory.getLogger(XPathContainsAssertion.class);

   /** The XPath expression. Value is a string with a valid XPath expression. */
   public static final String PATH_PARAM = "path";

   /** The expected content param. Value is a string that may contain wildcards if `allowWildcards` is set to true. */
   public static final String EXPECTED_CONTENT_PARAM = "content";


   private String path;

   private String expectedContent;

   private String errorMessage;


   @Override
   public void configure(Map configParams) {
      super.configure(configParams);
      path = configParams.get(PATH_PARAM);
      expectedContent = configParams.get(EXPECTED_CONTENT_PARAM);
   }

   @Override
   public AssertionStatus assertResponse(RequestResponseExchange exchange, ExchangeContext context) {
      log.debug("Asserting XPath on {}, expecting: {}", path, expectedContent);

      if (path == null) {
         errorMessage = "Missing path for XPath assertion";
         return AssertionStatus.FAILED;
      }
      if (expectedContent == null) {
         errorMessage = "Missing content for XPath assertion";
         return AssertionStatus.FAILED;
      }

      try {
         XPathExpression expression = SoapUIXPathBuilder.buildXPathMatcherFromRules(path);
         String result = expression.evaluate(new InputSource(new StringReader(exchange.responseContent())));

         if (allowWildcards) {
            if (!isSimilar(expectedContent, result)) {
               errorMessage = "XPathContains comparison failed for path [" + path + "], expecting [" + expectedContent
                     + "], actual was [" + result + "]";
               return AssertionStatus.FAILED;
            }
         } else {
            if (!expectedContent.equals(result)) {
               errorMessage = "XPathContains comparison failed for path [" + path + "], expecting [" + expectedContent
                     + "], actual was [" + result + "]";
               return AssertionStatus.FAILED;
            }
         }
      } catch (XPathExpressionException e) {
         log.warn("Exception while compiling/evaluating XPath", e);
         errorMessage = "Exception while compiling/evaluating XPath: " + path;
         return AssertionStatus.FAILED;
      }
      return AssertionStatus.VALID;
   }

   @Override
   public List getErrorMessages() {
      return List.of(errorMessage);
   }
}