1   /*
2    * $Id: FilteringXmlMessageSplitterTestCase.java 7976 2007-08-21 14:26:13Z dirk.olmes $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSource, Inc.  All rights reserved.  http://www.mulesource.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.routing.outbound;
12  
13  import org.mule.impl.MuleMessage;
14  import org.mule.impl.endpoint.MuleEndpointURI;
15  import org.mule.tck.AbstractMuleTestCase;
16  import org.mule.tck.MuleTestUtils;
17  import org.mule.umo.UMOMessage;
18  import org.mule.umo.UMOSession;
19  import org.mule.umo.endpoint.UMOEndpoint;
20  import org.mule.util.IOUtils;
21  
22  import com.mockobjects.constraint.Constraint;
23  import com.mockobjects.dynamic.C;
24  import com.mockobjects.dynamic.Mock;
25  
26  import java.util.HashMap;
27  import java.util.Map;
28  
29  import org.dom4j.Document;
30  import org.dom4j.DocumentHelper;
31  
32  public class FilteringXmlMessageSplitterTestCase extends AbstractMuleTestCase
33  {
34      private UMOEndpoint endpoint1;
35      private UMOEndpoint endpoint2;
36      private UMOEndpoint endpoint3;
37      private FilteringXmlMessageSplitter xmlSplitter;
38  
39      // @Override
40      protected void doSetUp() throws Exception
41      {
42          // setup endpoints
43          endpoint1 = getTestEndpoint("Test1Endpoint", UMOEndpoint.ENDPOINT_TYPE_SENDER);
44          endpoint1.setEndpointURI(new MuleEndpointURI("test://endpointUri.1"));
45          endpoint2 = getTestEndpoint("Test2Endpoint", UMOEndpoint.ENDPOINT_TYPE_SENDER);
46          endpoint2.setEndpointURI(new MuleEndpointURI("test://endpointUri.2"));
47          endpoint3 = getTestEndpoint("Test3Endpoint", UMOEndpoint.ENDPOINT_TYPE_SENDER);
48          endpoint3.setEndpointURI(new MuleEndpointURI("test://endpointUri.3"));
49  
50          // setup splitter
51          xmlSplitter = new FilteringXmlMessageSplitter();
52          xmlSplitter.setValidateSchema(true);
53          xmlSplitter.setExternalSchemaLocation("purchase-order.xsd");
54  
55          // The xml document declares a default namespace, thus
56          // we need to workaround it by specifying it both in
57          // the namespaces and in the splitExpression
58          Map namespaces = new HashMap();
59          namespaces.put("e", "http://www.example.com");
60          xmlSplitter.setSplitExpression("/e:purchaseOrder/e:items/e:item");
61          xmlSplitter.setNamespaces(namespaces);
62          xmlSplitter.addEndpoint(endpoint1);
63          xmlSplitter.addEndpoint(endpoint2);
64          xmlSplitter.addEndpoint(endpoint3);
65      }
66  
67      public void testStringPayloadXmlMessageSplitter() throws Exception
68      {
69          String payload = IOUtils.getResourceAsString("purchase-order.xml", getClass());
70          internalTestSuccessfulXmlSplitter(payload);
71      }
72      
73      public void testStringPayloadXmlMessageSplitterWithoutXsd() throws Exception
74      {
75       xmlSplitter.setExternalSchemaLocation(null);
76       xmlSplitter.setValidateSchema(false);
77          String payload = IOUtils.getResourceAsString("purchase-order.xml", getClass());
78          internalTestSuccessfulXmlSplitter(payload);
79      }
80  
81      public void testDom4JDocumentPayloadXmlMessageSplitter() throws Exception
82      {
83          String payload = IOUtils.getResourceAsString("purchase-order.xml", getClass());
84          Document doc = DocumentHelper.parseText(payload);
85          internalTestSuccessfulXmlSplitter(doc);
86      }
87  
88      public void testByteArrayPayloadXmlMessageSplitter() throws Exception
89      {
90          String payload = IOUtils.getResourceAsString("purchase-order.xml", getClass());
91          internalTestSuccessfulXmlSplitter(payload.getBytes());
92      }
93  
94      private void internalTestSuccessfulXmlSplitter(Object payload) throws Exception
95      {
96          Mock session = MuleTestUtils.getMockSession();
97  
98          UMOMessage message = new MuleMessage(payload);
99  
100         assertTrue(xmlSplitter.isMatch(message));
101         final ItemNodeConstraint itemNodeConstraint = new ItemNodeConstraint();
102         session.expect("dispatchEvent", C.args(itemNodeConstraint, C.eq(endpoint1)));
103         session.expect("dispatchEvent", C.args(itemNodeConstraint, C.eq(endpoint1)));
104         xmlSplitter.route(message, (UMOSession)session.proxy(), false);
105         session.verify();
106 
107         message = new MuleMessage(payload);
108 
109         session.expectAndReturn("sendEvent", C.args(itemNodeConstraint, C.eq(endpoint1)), message);
110         session.expectAndReturn("sendEvent", C.args(itemNodeConstraint, C.eq(endpoint1)), message);
111         UMOMessage result = xmlSplitter.route(message, (UMOSession)session.proxy(), true);
112         assertNotNull(result);
113         assertEquals(message, result);
114         session.verify();
115     }
116 
117     public void testXsdNotFoundThrowsException() throws Exception
118     {
119         final String invalidSchemaLocation = "non-existent.xsd";
120         Mock session = MuleTestUtils.getMockSession();
121 
122         UMOEndpoint endpoint1 = getTestEndpoint("Test1Endpoint", UMOEndpoint.ENDPOINT_TYPE_SENDER);
123         endpoint1.setEndpointURI(new MuleEndpointURI("test://endpointUri.1"));
124 
125         FilteringXmlMessageSplitter splitter = new FilteringXmlMessageSplitter();
126         splitter.setValidateSchema(true);
127         splitter.setExternalSchemaLocation(invalidSchemaLocation);
128 
129         String payload = IOUtils.getResourceAsString("purchase-order.xml", getClass());
130 
131         UMOMessage message = new MuleMessage(payload);
132 
133         assertTrue(splitter.isMatch(message));
134         try
135         {
136             splitter.route(message, (UMOSession)session.proxy(), false);
137             fail("Should have thrown an exception, because XSD is not found.");
138         }
139         catch (IllegalArgumentException iaex)
140         {
141             assertTrue("Wrong exception?", iaex.getMessage().indexOf(
142                 "Couldn't find schema at " + invalidSchemaLocation) != -1);
143         }
144         session.verify();
145     }
146 
147     public void testUnsupportedTypePayloadIsIgnored() throws Exception
148     {
149         Exception unsupportedPayload = new Exception();
150 
151         Mock session = MuleTestUtils.getMockSession();
152 
153         UMOMessage message = new MuleMessage(unsupportedPayload);
154 
155         assertTrue(xmlSplitter.isMatch(message));
156         xmlSplitter.route(message, (UMOSession)session.proxy(), false);
157         session.verify();
158 
159         message = new MuleMessage(unsupportedPayload);
160 
161         UMOMessage result = xmlSplitter.route(message, (UMOSession)session.proxy(), true);
162         assertNull(result);
163         session.verify();
164     }
165 
166     public void testInvalidXmlPayloadThrowsException() throws Exception
167     {
168         Mock session = MuleTestUtils.getMockSession();
169 
170         FilteringXmlMessageSplitter splitter = new FilteringXmlMessageSplitter();
171 
172         UMOMessage message = new MuleMessage("This is not XML.");
173 
174         try
175         {
176             splitter.route(message, (UMOSession)session.proxy(), false);
177             fail("No exception thrown.");
178         }
179         catch (IllegalArgumentException iaex)
180         {
181             assertTrue("Wrong exception message.", iaex.getMessage().startsWith(
182                 "Failed to initialise the payload: "));
183         }
184 
185     }
186 
187     private class ItemNodeConstraint implements Constraint
188     {
189         public boolean eval(Object o)
190         {
191             final UMOMessage message = (UMOMessage)o;
192             final Object payload = message.getPayload();
193             assertTrue("Wrong class type for node.", payload instanceof Document);
194 
195             Document node = (Document)payload;
196 
197             final String partNumber = node.getRootElement().attributeValue("partNum");
198 
199             return "872-AA".equals(partNumber) || "926-AA".equals(partNumber);
200         }
201     }
202 }