在 Java 中使用 WireMock 和 SOAP Web Services

我是WireMock的创造者。

我最近使用WireMock在客户端项目上模拟了一组SOAP接口，所以我可以证明这是可能的。至于它比SOAP UI更好还是更差，我会说有一些明显的优点，但有一些权衡。一个主要的好处是相对容易部署和编程访问/配置，并支持HTTPS和低级故障注入等。但是，您需要做更多的工作来解析和生成 SOAP 有效负载 - 它不会像 SOAP UI 那样从 WSDL 生成代码/存根。

我的经验是，像SOAP UI这样的工具会让你更快地入门，但从长远来看，当你的测试套件增长到微不足道的时候，往往会导致更高的维护成本。

反过来解决你的观点：1）如果你想让你的模拟在某个地方的服务器上运行，最简单的方法是按照你所描述的运行独立的JAR。我建议不要尝试将其部署到容器中 - 此选项实际上仅在没有其他选择时才存在。

但是，如果您只想运行集成测试或完全独立的功能测试，我建议使用JUnit规则。我想说的是，如果a）你正在将其他部署的系统插入其中，或者b）你正在从非JVM语言使用它，那么在专用进程中运行它是一个好主意。

2）您需要通过以下3种方式之一对其进行配置：1）Java API，2）基于HTTP的JSON，或3）JSON文件。3）可能最接近你习惯的SOAP UI。

3） 请参阅 http://wiremock.org/stubbing.html，了解大量使用 JSON 和 Java 的存根示例。由于 SOAP 倾向于绑定到固定端点 URL，因此您可能需要 。当我过去对 SOAP 进行存根处理时，我倾向于在整个请求正文中进行 XML 匹配（请参见 http://wiremock.org/stubbing.html#xml-body-matching）。我建议投资编写一些Java构建器来发出您需要的请求和响应正文XML。urlEqualTo(...)

4）Mock Server和Betamax都是WireMock的成熟替代品，但AFAIK它们没有提供任何更明确的SOAP支持。

我迟到了三年多，但是我花了一段时间来解决同样的问题，所以我虽然值得记录我的解决方案作为答案，这样它可能会让其他人免于从头开始手动处理SOAP有效负载的头痛。

我做了一个合理的研究，试图为我的集成测试套件解决这个问题。尝试了各种方法，包括 CXF 自定义生成的服务器、SOAP-UI、受 CGLIB 影响的库，可在测试上下文中替换真正的客户端。

我最终使用WireMock和自定义请求匹配器来处理所有的-yness。SOAP

它的要点是一个类，它处理 SOAP 请求的取消合并和 SOAP 响应的封送处理，以便提供一个方便的包装器来测试只需要 JAXB 生成对象并且永远不必关心 SOAP 细节的作者。

响应封送处理

/**
 * Accepts a WebService response object (as defined in the WSDL) and marshals
 * to a SOAP envelope String.
 */
public <T> String serializeObject(T object) {
    ByteArrayOutputStream byteArrayOutputStream;
    Class clazz = object.getClass();
    String responseRootTag = StringUtils.uncapitalize(clazz.getSimpleName());
    QName payloadName = new QName("your_namespace_URI", responseRootTag, "namespace_prefix");

    try {
        JAXBContext jaxbContext = JAXBContext.newInstance(clazz);
        Marshaller objectMarshaller = jaxbContext.createMarshaller();

        JAXBElement<T> jaxbElement = new JAXBElement<>(payloadName, clazz, null, object);
        Document document = DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument();
        objectMarshaller.marshal(jaxbElement, document);

        SOAPMessage soapMessage = MessageFactory.newInstance().createMessage();
        SOAPBody body = soapMessage.getSOAPPart().getEnvelope().getBody();
        body.addDocument(document);

        byteArrayOutputStream = new ByteArrayOutputStream();
        soapMessage.saveChanges();
        soapMessage.writeTo(byteArrayOutputStream);
    } catch (Exception e) {
        throw new RuntimeException(String.format("Exception trying to serialize [%s] to a SOAP envelope", object), e);
    }

    return byteArrayOutputStream.toString();
}

请求取消马歇尔

/**
 * Accepts a WebService request object (as defined in the WSDL) and unmarshals
 * to the supplied type.
 */
public <T> T deserializeSoapRequest(String soapRequest, Class<T> clazz) {

    XMLInputFactory xif = XMLInputFactory.newFactory();
    JAXBElement<T> jb;
    try {
        XMLStreamReader xsr = xif.createXMLStreamReader(new StringReader(soapRequest));

        // Advance the tag iterator to the tag after Body, eg the start of the SOAP payload object
        do {
            xsr.nextTag();
        } while(!xsr.getLocalName().equals("Body"));
        xsr.nextTag();

        JAXBContext jc = JAXBContext.newInstance(clazz);
        Unmarshaller unmarshaller = jc.createUnmarshaller();
        jb = unmarshaller.unmarshal(xsr, clazz);
        xsr.close();
    } catch (Exception e) {
        throw new RuntimeException(String.format("Unable to deserialize request to type: %s. Request \n %s", clazz, soapRequest), e);
    }

    return jb.getValue();
}

private XPath getXPathFactory() {

    Map<String, String> namespaceUris = new HashMap<>();
    namespaceUris.put("xml", XMLConstants.XML_NS_URI);
    namespaceUris.put("soap", "http://schemas.xmlsoap.org/soap/envelope/");       
    // Add additional namespaces to this map        

    XPath xpath = XPathFactory.newInstance().newXPath();

    xpath.setNamespaceContext(new NamespaceContext() {
        public String getNamespaceURI(String prefix) {
            if (namespaceUris.containsKey(prefix)) {
                return namespaceUris.get(prefix);
            } else {
                return XMLConstants.NULL_NS_URI;
            }
        }

        public String getPrefix(String uri) {
            throw new UnsupportedOperationException();
        }

        public Iterator getPrefixes(String uri) {
            throw new UnsupportedOperationException();
        }
    });

    return xpath;
}

除此之外，还有一些 XPath 实用程序，用于查看请求有效负载并查看所请求的操作。

所有的 SOAP 处理都是开始工作最繁琐的部分。从那里开始，它只是创建自己的API来补充WireMocks。例如

public <T> void stubOperation(String operation, Class<T> clazz, Predicate<T> predicate, Object response) {
    wireMock.stubFor(requestMatching(
                     new SoapObjectMatcher<>(context, clazz, operation, predicate))
                    .willReturn(aResponse()
                    .withHeader("Content-Type", "text/xml")
                    .withBody(serializeObject(response))));
}

结果，你最终会得到一个很好的，精益的测试。

SoapContext context = new SoapContext(...) // URIs, QName, Prefix, ect
context.stubOperation("createUser", CreateUser.class, (u) -> "myUser".equals(u.getUserName()), new CreateUserResponse());

soapClient.createUser("myUser");