Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CXF-8966 : Validation of nillable tags fails #1558

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

CXF-8966 : Validation of nillable tags fails #1558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 23 additions & 30 deletions core/src/main/java/org/apache/cxf/databinding/source/XMLStreamDataReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.sax.SAXSource;
Expand Down Expand Up @@ -216,33 +215,37 @@ public void close() throws XMLStreamException {
}

private Element validate(XMLStreamReader input) throws XMLStreamException, IOException {
DOMSource ds = read(input);
final Element rootElement;
if (ds.getNode() instanceof Document) {
rootElement = ((Document)ds.getNode()).getDocumentElement();
} else {
rootElement = (Element)ds.getNode();
}

Element rootElement;
WoodstoxValidationImpl impl = new WoodstoxValidationImpl();
XMLStreamWriter nullWriter = null;
XMLStreamReader inputWithoutXop = null;
if (impl.canValidate()) {
nullWriter = StaxUtils.createXMLStreamWriter(new NUllOutputStream());
impl.setupValidation(nullWriter, message.getExchange().getEndpoint(),
message.getExchange().getService().getServiceInfos().get(0));
//filter xop node, which causes validation to fail
XMLStreamReader filteredReader =
StaxUtils.createFilteredReader(input, new StaxStreamFilter(XOP));
try (CachedOutputStream out = new CachedOutputStream()) {
StaxUtils.copy(filteredReader, out);
inputWithoutXop = StaxUtils.createXMLStreamReader(out.getInputStream());
impl.setupValidation(inputWithoutXop, message.getExchange().getEndpoint(),
message.getExchange().getService().getServiceInfos().get(0));
} finally {
filteredReader.close();
}
}
//check if the impl can still validate after the setup, possible issue loading schemas or similar
if (impl.canValidate()) {
//Can use the MSV libs and woodstox to handle the schema validation during
//parsing and processing. Much faster and single traversal
//filter xop node
XMLStreamReader reader = StaxUtils.createXMLStreamReader(ds);
XMLStreamReader filteredReader =
StaxUtils.createFilteredReader(reader,
new StaxStreamFilter(new QName[] {XOP}));
//parsing and processing. Much faster and single traversal
rootElement = StaxUtils.read(inputWithoutXop).getDocumentElement();

StaxUtils.copy(filteredReader, nullWriter);
} else {

DOMSource ds = read(input);
if (ds.getNode() instanceof Document) {
rootElement = ((Document)ds.getNode()).getDocumentElement();
} else {
rootElement = (Element)ds.getNode();
}

//MSV not available, use a slower method of cloning the data, replace the xop's, validate
LOG.fine("NO_MSV_AVAILABLE");
Element newElement = rootElement;
Expand Down Expand Up @@ -314,14 +317,4 @@ public void setProperty(String prop, Object value) {
message = (Message)value;
}
}

static class NUllOutputStream extends OutputStream {
public void write(byte[] b, int off, int len) {
}
public void write(int b) {
}

public void write(byte[] b) throws IOException {
}
}
}
98 changes: 98 additions & 0 deletions core/src/test/java/org/apache/cxf/databinding/source/XMLStreamDataReaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,45 @@
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;

import javax.xml.XMLConstants;
import javax.xml.namespace.QName;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamReader;
import javax.xml.transform.dom.DOMSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;

import org.w3c.dom.Document;

import com.ctc.wstx.msv.W3CSchemaFactory;

import org.apache.cxf.endpoint.Endpoint;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.message.Exchange;
import org.apache.cxf.message.ExchangeImpl;
import org.apache.cxf.message.Message;
import org.apache.cxf.message.MessageImpl;
import org.apache.cxf.service.Service;
import org.apache.cxf.service.ServiceImpl;
import org.apache.cxf.service.model.MessageInfo;
import org.apache.cxf.service.model.MessagePartInfo;
import org.apache.cxf.service.model.ServiceInfo;
import org.apache.cxf.staxutils.StaxUtils;
import org.codehaus.stax2.XMLStreamReader2;
import org.codehaus.stax2.validation.XMLValidationSchema;

import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

/**
*
Expand Down Expand Up @@ -92,6 +118,78 @@ public void testParseNullByte() throws Exception {
((XMLStreamReader)obj).close();
}

@Test
public void testValid() throws Exception {
testValidate("resources/schema.xsd", "resources/test-valid.xml", false);
}

@Test
public void testInValid() throws Exception {
testValidate("resources/schema.xsd", "resources/test-invalid.xml", true);
}


private void testValidate(String schemaPath, String xmlPath, boolean exceptionExpected) throws Exception {

//create schema
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
documentBuilderFactory.setNamespaceAware(true);
DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
URL schemaURI = getClass().getResource(schemaPath);
Document wsdl = documentBuilder.parse(schemaURI.openStream());
String wsdlSystemId = schemaURI.toExternalForm();
DOMSource source = new DOMSource(wsdl);
source.setSystemId(wsdlSystemId);
source.setSystemId(wsdlSystemId);

XMLValidationSchema schemaw3c =
W3CSchemaFactory.newInstance(XMLValidationSchema.SCHEMA_ID_W3C_SCHEMA).createSchema(schemaURI);
SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
Schema schema = schemaFactory.newSchema(schemaURI);

XMLStreamDataReader reader = new XMLStreamDataReader();
reader.setSchema(schema);


InputStream testIS = getClass().getResourceAsStream(xmlPath);
Message msg = new MessageImpl();
Exchange exchange = new ExchangeImpl();

ServiceInfo serviceInfo = new ServiceInfo();

Endpoint endpoint = mock(Endpoint.class);
when(endpoint.get(XMLValidationSchema.class.getName())).thenReturn(schemaw3c);

Service svc = new ServiceImpl(serviceInfo);

exchange.put(Service.class, svc);
exchange.put(Endpoint.class, endpoint);

msg.setExchange(exchange);
msg.setContent(InputStream.class, testIS);
reader.setProperty(Message.class.getName(), msg);

XMLInputFactory xmlFactory = XMLInputFactory.newInstance();
XMLStreamReader2 xmlStreamReader = (XMLStreamReader2) xmlFactory.createXMLStreamReader(testIS, "utf-8");

MessageInfo messageInfo = new MessageInfo(null,
MessageInfo.Type.INPUT,
new QName("http://www.test.org/services",
"NullTestOperationRequest"));
MessagePartInfo messagePartInfo = new MessagePartInfo(new QName(
"http://www.test.org/services", "NullTestOperationRequest"), messageInfo);
messagePartInfo.setElement(true);
boolean exceptionCaught = false;
try {
reader.read(messagePartInfo, xmlStreamReader);
} catch (Fault fault) {
exceptionCaught = true;
} catch (Exception exc) {
fail(exc.getMessage());
}
assertEquals(exceptionExpected, exceptionCaught);
}

private static class TestInputStream extends ByteArrayInputStream {
private boolean closed;

Expand Down
11 changes: 11 additions & 0 deletions core/src/test/java/org/apache/cxf/databinding/source/resources/schema.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.test.org/service/">
<xsd:element name="NullTestOperationRequest" nillable="true">
<xsd:complexType>
<xsd:sequence>
<xsd:element nillable="true" name="inInt" type="xsd:int" maxOccurs="1" minOccurs="0" ></xsd:element>
<xsd:element nillable="true" name="inInteger" type="xsd:integer" maxOccurs="1" minOccurs="0" ></xsd:element>
<xsd:element nillable="true" name="inString" type="xsd:string" maxOccurs="1" minOccurs="0" ></xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
5 changes: 5 additions & 0 deletions core/src/test/java/org/apache/cxf/databinding/source/resources/test-invalid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<ser:NullTestOperationRequest xmlns:ser="http://www.test.org/service/">

<inInt xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="false"/>

</ser:NullTestOperationRequest>
7 changes: 7 additions & 0 deletions core/src/test/java/org/apache/cxf/databinding/source/resources/test-valid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<ser:NullTestOperationRequest xmlns:ser="http://www.test.org/service/">

<inInt xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
<inInteger xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
<inString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>

</ser:NullTestOperationRequest>