SWS-544 - Add test framework for Spring WS client

Author: poutsma

test/pom.xml

@@ -49,5 +49,9 @@
             <artifactId>xmlunit</artifactId>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-test</artifactId>
+        </dependency>
     </dependencies>
 </project>

test/src/main/java/org/springframework/ws/mock/client2/DiffMatcher.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2005-2010 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.springframework.ws.mock.client2;
+
+import java.io.IOException;
+import java.net.URI;
+
+import org.springframework.ws.WebServiceMessage;
+import org.springframework.xml.transform.TransformerObjectSupport;
+
+import org.custommonkey.xmlunit.Diff;
+
+import static org.custommonkey.xmlunit.XMLAssert.assertXMLEqual;
+import static org.custommonkey.xmlunit.XMLAssert.fail;
+
+/**
+ * Implementation of {@link RequestMatcher} based on XMLUnit's {@link Diff}.
+ *
+ * @author Arjen Poutsma
+ * @since 2.0
+ */
+abstract class DiffMatcher extends TransformerObjectSupport implements RequestMatcher {
+
+    public final void match(URI uri, WebServiceMessage request) throws IOException, AssertionError {
+        try {
+            Diff diff = createDiff(request);
+            assertXMLEqual(diff, true);
+        }
+        catch (IOException ex) {
+            throw ex;
+        }
+        catch (Exception ex) {
+            fail("Could not create Diff: " + ex.getMessage());
+        }
+    }
+
+    /**
+     * Creates a {@link org.custommonkey.xmlunit.Diff} for the given request message.
+     *
+     * @param request the request message
+     * @return the diff
+     * @throws Exception in case of errors
+     */
+    protected abstract Diff createDiff(WebServiceMessage request) throws Exception;
+
+}

test/src/main/java/org/springframework/ws/mock/client2/ErrorResponseCallback.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2005-2010 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.springframework.ws.mock.client2;
+
+import java.io.IOException;
+
+import org.springframework.ws.WebServiceMessage;
+
+/**
+ * Implementation of {@link ResponseCallback} that holds an error message.
+ *
+ * @author Arjen Poutsma
+ * @author Lukas Krecan
+ * @since 2.0
+ */
+class ErrorResponseCallback implements ResponseCallback {
+
+    private final String errorMessage;
+
+    ErrorResponseCallback(String errorMessage) {
+        this.errorMessage = errorMessage;
+    }
+
+    public void doWithResponse(WebServiceMessage response, WebServiceMessage request) throws IOException {
+        // Do nothing
+    }
+
+    String getErrorMessage() {
+        return errorMessage;
+    }
+}

test/src/main/java/org/springframework/ws/mock/client2/ExceptionResponseCallback.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2005-2010 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.springframework.ws.mock.client2;
+
+import java.io.IOException;
+
+import org.springframework.ws.WebServiceMessage;
+
+/**
+ * Implementation of {@link ResponseCallback} that responds by throwing either an {@link IOException} or a {@link
+ * RuntimeException}.
+ *
+ * @author Arjen Poutsma
+ * @since 2.0
+ */
+class ExceptionResponseCallback implements ResponseCallback {
+
+    private final Exception exception;
+
+    ExceptionResponseCallback(IOException exception) {
+        this.exception = exception;
+    }
+
+    ExceptionResponseCallback(RuntimeException exception) {
+        this.exception = exception;
+    }
+
+    public void doWithResponse(WebServiceMessage request, WebServiceMessage response) throws IOException {
+        if (exception instanceof IOException) {
+            throw (IOException) exception;
+        }
+        else {
+            throw (RuntimeException) exception;
+        }
+    }
+}

test/src/main/java/org/springframework/ws/mock/client2/MockSenderConnection.java

@@ -0,0 +1,135 @@
+/*
+ * Copyright 2005-2010 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.springframework.ws.mock.client2;
+
+import java.io.IOException;
+import java.net.URI;
+import java.util.LinkedList;
+import java.util.List;
+
+import org.springframework.util.Assert;
+import org.springframework.ws.WebServiceMessage;
+import org.springframework.ws.WebServiceMessageFactory;
+import org.springframework.ws.transport.FaultAwareWebServiceConnection;
+
+/**
+ * Mock implementation of {@link FaultAwareWebServiceConnection}. Implements {@link ResponseActions} to form a fluent
+ * API.
+ *
+ * @author Arjen Poutsma
+ * @author Lukas Krecan
+ * @since 2.0
+ */
+class MockSenderConnection implements FaultAwareWebServiceConnection, ResponseActions {
+
+    private final List<RequestMatcher> requestMatchers = new LinkedList<RequestMatcher>();
+
+    private URI uri;
+
+    private boolean lastConnection = false;
+
+    private WebServiceMessage request;
+
+    private ResponseCallback responseCallback;
+
+    void addRequestMatcher(RequestMatcher requestMatcher) {
+        Assert.notNull(requestMatcher, "'requestMatcher' must not be null");
+        requestMatchers.add(requestMatcher);
+    }
+
+    void setUri(URI uri) {
+        Assert.notNull(uri, "'uri' must not be null");
+        this.uri = uri;
+    }
+
+    void lastConnection() {
+        lastConnection = true;
+    }
+
+    // ResponseActions implementation
+
+    public ResponseActions andExpect(RequestMatcher requestMatcher) {
+        addRequestMatcher(requestMatcher);
+        return this;
+    }
+
+    public void andRespond(ResponseCallback responseCallback) {
+        Assert.notNull(responseCallback, "'responseCallback' must not be null");
+        this.responseCallback = responseCallback;
+    }
+
+    // FaultAwareWebServiceConnection implementation
+
+    public void send(WebServiceMessage message) throws IOException {
+        if (!requestMatchers.isEmpty()) {
+            for (RequestMatcher requestMatcher : requestMatchers) {
+                requestMatcher.match(uri, message);
+            }
+        }
+        else {
+            throw new AssertionError("Unexpected send() for [" + message + "]");
+        }
+        this.request = message;
+    }
+
+    public WebServiceMessage receive(WebServiceMessageFactory messageFactory) throws IOException {
+        if (responseCallback != null) {
+            WebServiceMessage response = messageFactory.createWebServiceMessage();
+            responseCallback.doWithResponse(request, response);
+            return response;
+        }
+        else {
+            return null;
+        }
+    }
+
+    public URI getUri() {
+        return uri;
+    }
+
+    public boolean hasError() throws IOException {
+        return responseCallback instanceof ErrorResponseCallback;
+    }
+
+    public String getErrorMessage() throws IOException {
+        if (responseCallback instanceof ErrorResponseCallback) {
+            return ((ErrorResponseCallback) responseCallback).getErrorMessage();
+        }
+        else {
+            return null;
+        }
+    }
+
+    public boolean hasFault() throws IOException {
+        return responseCallback instanceof SoapFaultResponseCallback;
+    }
+
+    public void setFault(boolean fault) throws IOException {
+        // Do nothing
+    }
+
+    public void close() throws IOException {
+        requestMatchers.clear();
+        request = null;
+        responseCallback = null;
+        uri = null;
+        if (lastConnection) {
+            MockWebServiceMessageSenderHolder.clear();
+        }
+    }
+
+}

test/src/main/java/org/springframework/ws/mock/client2/MockWebServiceMessageSender.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2005-2010 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.springframework.ws.mock.client2;
+
+import java.io.IOException;
+import java.net.URI;
+import java.util.Iterator;
+import java.util.LinkedList;
+import java.util.List;
+
+import org.springframework.util.Assert;
+import org.springframework.ws.transport.WebServiceMessageSender;
+
+import static org.junit.Assert.assertTrue;
+
+class MockWebServiceMessageSender implements WebServiceMessageSender {
+
+    private final List<MockSenderConnection> expectedConnections = new LinkedList<MockSenderConnection>();
+
+    private Iterator<MockSenderConnection> connectionIterator;
+
+    public MockSenderConnection createConnection(URI uri) throws IOException {
+        Assert.notNull(uri, "'uri' must not be null");
+        if (connectionIterator == null) {
+            connectionIterator = expectedConnections.iterator();
+        }
+        assertTrue("No further connections expected", connectionIterator.hasNext());
+
+        MockSenderConnection currentConnection = connectionIterator.next();
+        currentConnection.setUri(uri);
+        if (!connectionIterator.hasNext()) {
+            currentConnection.lastConnection();
+        }
+        return currentConnection;
+    }
+
+    /** Always returns {@code true}. */
+    public boolean supports(URI uri) {
+        return true;
+    }
+
+    MockSenderConnection expectNewConnection() {
+        MockSenderConnection connection = new MockSenderConnection();
+        expectedConnections.add(connection);
+        return connection;
+    }
+
+}