moxy/org.eclipse.persistence.moxy/src/test/java/org/eclipse/persistence/testing/jaxb/xmlmarshaller/MarshallerPropertiesTestCases.java - eclipselink - Git at Google

 /*
  * Copyright (c) 1998, 2021 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
  * http://www.eclipse.org/legal/epl-2.0,
  * or the Eclipse Distribution License v. 1.0 which is available at
  * http://www.eclipse.org/org/documents/edl-v10.php.
  *
  * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
  */

 // Contributors:
 //     Oracle - initial API and implementation from Oracle TopLink
 package org.eclipse.persistence.testing.jaxb.xmlmarshaller;

 import java.io.ByteArrayOutputStream;
 import java.io.InputStream;
 import java.io.StringWriter;

 import jakarta.xml.bind.JAXBContext;
 import jakarta.xml.bind.Marshaller;
 import jakarta.xml.bind.PropertyException;
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.transform.stream.StreamResult;

 import org.w3c.dom.Document;
 import org.eclipse.persistence.jaxb.MarshallerProperties;
 import org.eclipse.persistence.testing.oxm.OXTestCase;
 import org.eclipse.persistence.testing.oxm.mappings.XMLMappingTestCases.FakeSchema;

 public class MarshallerPropertiesTestCases extends OXTestCase {
     private final static String CONTROL_NO_NAMESPACE_XML = "org/eclipse/persistence/testing/oxm/jaxb/Employee_NoNamespaceSchema.xml";
     private final static String CONTROL_NAMESPACE_XML = "org/eclipse/persistence/testing/oxm/jaxb/Employee_NamespaceSchema.xml";
     private final static String CONTROL_BOTH = "org/eclipse/persistence/testing/oxm/jaxb/Employee_BothNamespaceAttr.xml";
     private final static String CONTROL_NONE = "org/eclipse/persistence/testing/oxm/jaxb/Employee_NoSchemaLocation.xml";
     private Marshaller marshaller;
     private DocumentBuilder parser;
     private String contextPath;
     private String originalNNSchemaLocation;
     private String originalSchemaLocation;

     public MarshallerPropertiesTestCases(String name) {
         super(name);
     }

     @Override
     public void setUp() throws Exception {
         contextPath = System.getProperty("jaxb.test.contextpath", JAXBSAXTestSuite.CONTEXT_PATH);

         JAXBContext jaxbContext = JAXBContext.newInstance(contextPath, getClass().getClassLoader());
         marshaller = jaxbContext.createMarshaller();
         DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
         documentBuilderFactory.setNamespaceAware(true);
         documentBuilderFactory.setIgnoringElementContentWhitespace(true);
         parser = documentBuilderFactory.newDocumentBuilder();
         originalNNSchemaLocation = (String)marshaller.getProperty("jaxb.noNamespaceSchemaLocation");
         originalSchemaLocation = (String)marshaller.getProperty("jaxb.schemaLocation");
     }

     @Override
     public void tearDown() throws Exception {
         marshaller.setProperty("jaxb.noNamespaceSchemaLocation", originalNNSchemaLocation);
         marshaller.setProperty("jaxb.schemaLocation", originalSchemaLocation);
     }

     public void testNoNamespaceSchemaLocation() throws Exception {
         Document control = parse(CONTROL_NO_NAMESPACE_XML);
         Document marshalled = parser.newDocument();
         marshaller.setProperty("jaxb.noNamespaceSchemaLocation", "http://www.example.com/Employee.xsd");
         Employee emp = new Employee();
         emp.setID(456);
         marshaller.marshal(emp, marshalled);
         assertXMLIdentical(marshalled, control);
     }

     public void testNamespaceSchemaLocation() throws Exception {
         Document control = parse(CONTROL_NAMESPACE_XML);
         Document marshalled = parser.newDocument();
         marshaller.setProperty("jaxb.schemaLocation", "http://www.example.com/Employee.xsd");
         Employee emp = new Employee();
         emp.setID(456);
         marshaller.marshal(emp, marshalled);
         assertXMLIdentical(control, marshalled);
     }

     public void testBothSchemaLocations() throws Exception {
         Document control = parse(CONTROL_BOTH);
         Document marshalled = parser.newDocument();
         marshaller.setProperty("jaxb.schemaLocation", "http://www.example.com/Employee.xsd");
         marshaller.setProperty("jaxb.noNamespaceSchemaLocation", "file:////ade/mmacivor_toplink10i/tltest/resource/ox/Employee.xsd");
         Employee emp = new Employee();
         emp.setID(456);
         marshaller.marshal(emp, marshalled);
         assertXMLIdentical(control, marshalled);
     }

     public void testNoSchemaLocation() throws Exception {
         Document control = parse(CONTROL_NONE);
         Document marshalled = parser.newDocument();
         Employee emp = new Employee();
         emp.setID(456);
         marshaller.marshal(emp, marshalled);
         assertXMLIdentical(control, marshalled);
     }

     public void testIndentString() throws Exception {
         String customIndentString = "(((custom-<indent)))";
         String escapedIndentString = "(((custom-&lt;indent)))";

         Employee emp = new Employee();
         Address a = new Address();
         a.setCity("aCity");
         a.setState("aState");
         emp.setHomeAddress(a);

         StringWriter sw = new StringWriter();
         marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);

         marshaller.setProperty(MarshallerProperties.INDENT_STRING, customIndentString);
         marshaller.marshal(emp, sw);
         assertTrue("Custom indent string not found in marshalled document or was not escaped.", sw.toString().contains(escapedIndentString));

         marshaller.setProperty("org.glassfish.jaxb.indentString", customIndentString);
         marshaller.marshal(emp, sw);
         assertTrue("Custom indent string not found in marshalled document or was not escaped.", sw.toString().contains(escapedIndentString));

         marshaller.setProperty("com.sun.xml.internal.bind.indentString", customIndentString);
         marshaller.marshal(emp, sw);
         assertTrue("Custom indent string not found in marshalled document or was not escaped.", sw.toString().contains(escapedIndentString));
     }

     public void testXmlHeaders() throws Exception {
         String header = "<!-- Copyright 2012 ACME Corp. -->";

         Employee emp = new Employee();

         // Marshal to Stream
         ByteArrayOutputStream stream = new ByteArrayOutputStream();
         marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", header);
         marshaller.marshal(emp, stream);
         assertTrue("Custom header not written when marshalling to Stream.", new String(stream.toByteArray()).contains(header));

         // Marshal to Writer
         StringWriter writer =  new StringWriter();
         marshaller.marshal(emp, writer);
         assertTrue("Custom header not written when marshalling to Writer.", writer.toString().contains(header));

         // Marshal to Result
         StringWriter writer2 = new StringWriter();
         StreamResult result = new StreamResult(writer2);
         marshaller.marshal(emp, result);
         assertTrue("Custom header not written when marshalling to Result.", writer2.toString().contains(header));

         marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", null);
     }

     public void testXmlHeadersWithValidation() throws Exception {
         String header = "<!-- Copyright 2012 ACME Corp. -->";

         Employee emp = new Employee();

         // Marshal to Stream
         ByteArrayOutputStream stream = new ByteArrayOutputStream();
         marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", header);
         marshaller.setSchema(FakeSchema.INSTANCE);
         marshaller.marshal(emp, stream);
         assertTrue("Custom header not written when marshalling to Stream.", new String(stream.toByteArray()).contains(header));

         // Marshal to Writer
         StringWriter writer =  new StringWriter();
         marshaller.marshal(emp, writer);
         assertTrue("Custom header not written when marshalling to Writer.", writer.toString().contains(header));

         // Marshal to Result
         StringWriter writer2 = new StringWriter();
         StreamResult result = new StreamResult(writer2);
         marshaller.marshal(emp, result);
         assertTrue("Custom header not written when marshalling to Result.", writer2.toString().contains(header));

         marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", null);
         marshaller.setSchema(null);
     }

     public void testXmlHeadersWithNoXmlDeclaration() throws Exception {
         String header = "<!-- Copyright 2012 ACME Corp. -->";

         Employee emp = new Employee();

         // Marshal to Stream
         ByteArrayOutputStream stream = new ByteArrayOutputStream();
         marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", header);
         marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);
         marshaller.marshal(emp, stream);
         assertTrue("Custom header not written when marshalling to Stream.", new String(stream.toByteArray()).contains(header));

         // Marshal to Writer
         StringWriter writer =  new StringWriter();
         marshaller.marshal(emp, writer);
         assertTrue("Custom header not written when marshalling to Writer.", writer.toString().contains(header));

         // Marshal to Result
         StringWriter writer2 = new StringWriter();
         StreamResult result = new StreamResult(writer2);
         marshaller.marshal(emp, result);
         assertTrue("Custom header not written when marshalling to Result.", writer2.toString().contains(header));

         marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", null);
     }

     public void testSetNullPropertyException() {
         boolean caughtException = false;
         try {
             marshaller.setProperty(null, null);
         } catch (IllegalArgumentException e) {
             caughtException = true;
         } catch (Exception e) {
         }
         assertTrue("JAXBMarshaller did not throw IllegalArgumentException as expected.", caughtException);
     }

     public void testGetNullPropertyException() {
         boolean caughtException = false;
         try {
             marshaller.getProperty(null);
         } catch (IllegalArgumentException e) {
             caughtException = true;
         } catch (Exception e) {
         }
         assertTrue("JAXBMarshaller did not throw IllegalArgumentException as expected.", caughtException);
     }

     public void testSetInvalidPropertyException() {
         boolean caughtException = false;
         try {
             marshaller.setProperty("thisIsAnInvalidProperty", "thisIsAnInvalidValue");
         } catch (PropertyException e) {
             caughtException = true;
         } catch (Exception e) {
         }
         assertTrue("JAXBMarshaller did not throw PropertyException as expected.", caughtException);
     }

     public void testGetInvalidPropertyException() {
         boolean caughtException = false;
         try {
             marshaller.getProperty("thisIsAnInvalidProperty");
         } catch (PropertyException e) {
             caughtException = true;
         } catch (Exception e) {
         }
         assertTrue("JAXBMarshaller did not throw PropertyException as expected.", caughtException);
     }

     private Document parse(String resource) throws Exception {
         InputStream stream = getClass().getClassLoader().getResourceAsStream(resource);
         Document document = parser.parse(stream);
         removeEmptyTextNodes(document);
         return document;
     }
 }
	/*
	* Copyright (c) 1998, 2021 Oracle and/or its affiliates. All rights reserved.
	*
	* This program and the accompanying materials are made available under the
	* terms of the Eclipse Public License v. 2.0 which is available at
	* http://www.eclipse.org/legal/epl-2.0,
	* or the Eclipse Distribution License v. 1.0 which is available at
	* http://www.eclipse.org/org/documents/edl-v10.php.
	*
	* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
	*/

	// Contributors:
	// Oracle - initial API and implementation from Oracle TopLink
	package org.eclipse.persistence.testing.jaxb.xmlmarshaller;

	import java.io.ByteArrayOutputStream;
	import java.io.InputStream;
	import java.io.StringWriter;

	import jakarta.xml.bind.JAXBContext;
	import jakarta.xml.bind.Marshaller;
	import jakarta.xml.bind.PropertyException;
	import javax.xml.parsers.DocumentBuilder;
	import javax.xml.parsers.DocumentBuilderFactory;
	import javax.xml.transform.stream.StreamResult;

	import org.w3c.dom.Document;
	import org.eclipse.persistence.jaxb.MarshallerProperties;
	import org.eclipse.persistence.testing.oxm.OXTestCase;
	import org.eclipse.persistence.testing.oxm.mappings.XMLMappingTestCases.FakeSchema;

	public class MarshallerPropertiesTestCases extends OXTestCase {
	private final static String CONTROL_NO_NAMESPACE_XML = "org/eclipse/persistence/testing/oxm/jaxb/Employee_NoNamespaceSchema.xml";
	private final static String CONTROL_NAMESPACE_XML = "org/eclipse/persistence/testing/oxm/jaxb/Employee_NamespaceSchema.xml";
	private final static String CONTROL_BOTH = "org/eclipse/persistence/testing/oxm/jaxb/Employee_BothNamespaceAttr.xml";
	private final static String CONTROL_NONE = "org/eclipse/persistence/testing/oxm/jaxb/Employee_NoSchemaLocation.xml";
	private Marshaller marshaller;
	private DocumentBuilder parser;
	private String contextPath;
	private String originalNNSchemaLocation;
	private String originalSchemaLocation;

	public MarshallerPropertiesTestCases(String name) {
	super(name);
	}

	@Override
	public void setUp() throws Exception {
	contextPath = System.getProperty("jaxb.test.contextpath", JAXBSAXTestSuite.CONTEXT_PATH);

	JAXBContext jaxbContext = JAXBContext.newInstance(contextPath, getClass().getClassLoader());
	marshaller = jaxbContext.createMarshaller();
	DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
	documentBuilderFactory.setNamespaceAware(true);
	documentBuilderFactory.setIgnoringElementContentWhitespace(true);
	parser = documentBuilderFactory.newDocumentBuilder();
	originalNNSchemaLocation = (String)marshaller.getProperty("jaxb.noNamespaceSchemaLocation");
	originalSchemaLocation = (String)marshaller.getProperty("jaxb.schemaLocation");
	}

	@Override
	public void tearDown() throws Exception {
	marshaller.setProperty("jaxb.noNamespaceSchemaLocation", originalNNSchemaLocation);
	marshaller.setProperty("jaxb.schemaLocation", originalSchemaLocation);
	}

	public void testNoNamespaceSchemaLocation() throws Exception {
	Document control = parse(CONTROL_NO_NAMESPACE_XML);
	Document marshalled = parser.newDocument();
	marshaller.setProperty("jaxb.noNamespaceSchemaLocation", "http://www.example.com/Employee.xsd");
	Employee emp = new Employee();
	emp.setID(456);
	marshaller.marshal(emp, marshalled);
	assertXMLIdentical(marshalled, control);
	}

	public void testNamespaceSchemaLocation() throws Exception {
	Document control = parse(CONTROL_NAMESPACE_XML);
	Document marshalled = parser.newDocument();
	marshaller.setProperty("jaxb.schemaLocation", "http://www.example.com/Employee.xsd");
	Employee emp = new Employee();
	emp.setID(456);
	marshaller.marshal(emp, marshalled);
	assertXMLIdentical(control, marshalled);
	}

	public void testBothSchemaLocations() throws Exception {
	Document control = parse(CONTROL_BOTH);
	Document marshalled = parser.newDocument();
	marshaller.setProperty("jaxb.schemaLocation", "http://www.example.com/Employee.xsd");
	marshaller.setProperty("jaxb.noNamespaceSchemaLocation", "file:////ade/mmacivor_toplink10i/tltest/resource/ox/Employee.xsd");
	Employee emp = new Employee();
	emp.setID(456);
	marshaller.marshal(emp, marshalled);
	assertXMLIdentical(control, marshalled);
	}

	public void testNoSchemaLocation() throws Exception {
	Document control = parse(CONTROL_NONE);
	Document marshalled = parser.newDocument();
	Employee emp = new Employee();
	emp.setID(456);
	marshaller.marshal(emp, marshalled);
	assertXMLIdentical(control, marshalled);
	}

	public void testIndentString() throws Exception {
	String customIndentString = "(((custom-<indent)))";
	String escapedIndentString = "(((custom-<indent)))";

	Employee emp = new Employee();
	Address a = new Address();
	a.setCity("aCity");
	a.setState("aState");
	emp.setHomeAddress(a);

	StringWriter sw = new StringWriter();
	marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);

	marshaller.setProperty(MarshallerProperties.INDENT_STRING, customIndentString);
	marshaller.marshal(emp, sw);
	assertTrue("Custom indent string not found in marshalled document or was not escaped.", sw.toString().contains(escapedIndentString));

	marshaller.setProperty("org.glassfish.jaxb.indentString", customIndentString);
	marshaller.marshal(emp, sw);
	assertTrue("Custom indent string not found in marshalled document or was not escaped.", sw.toString().contains(escapedIndentString));

	marshaller.setProperty("com.sun.xml.internal.bind.indentString", customIndentString);
	marshaller.marshal(emp, sw);
	assertTrue("Custom indent string not found in marshalled document or was not escaped.", sw.toString().contains(escapedIndentString));
	}

	public void testXmlHeaders() throws Exception {
	String header = "<!-- Copyright 2012 ACME Corp. -->";

	Employee emp = new Employee();

	// Marshal to Stream
	ByteArrayOutputStream stream = new ByteArrayOutputStream();
	marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", header);
	marshaller.marshal(emp, stream);
	assertTrue("Custom header not written when marshalling to Stream.", new String(stream.toByteArray()).contains(header));

	// Marshal to Writer
	StringWriter writer = new StringWriter();
	marshaller.marshal(emp, writer);
	assertTrue("Custom header not written when marshalling to Writer.", writer.toString().contains(header));

	// Marshal to Result
	StringWriter writer2 = new StringWriter();
	StreamResult result = new StreamResult(writer2);
	marshaller.marshal(emp, result);
	assertTrue("Custom header not written when marshalling to Result.", writer2.toString().contains(header));

	marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", null);
	}

	public void testXmlHeadersWithValidation() throws Exception {
	String header = "<!-- Copyright 2012 ACME Corp. -->";

	Employee emp = new Employee();

	// Marshal to Stream
	ByteArrayOutputStream stream = new ByteArrayOutputStream();
	marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", header);
	marshaller.setSchema(FakeSchema.INSTANCE);
	marshaller.marshal(emp, stream);
	assertTrue("Custom header not written when marshalling to Stream.", new String(stream.toByteArray()).contains(header));

	// Marshal to Writer
	StringWriter writer = new StringWriter();
	marshaller.marshal(emp, writer);
	assertTrue("Custom header not written when marshalling to Writer.", writer.toString().contains(header));

	// Marshal to Result
	StringWriter writer2 = new StringWriter();
	StreamResult result = new StreamResult(writer2);
	marshaller.marshal(emp, result);
	assertTrue("Custom header not written when marshalling to Result.", writer2.toString().contains(header));

	marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", null);
	marshaller.setSchema(null);
	}

	public void testXmlHeadersWithNoXmlDeclaration() throws Exception {
	String header = "<!-- Copyright 2012 ACME Corp. -->";

	Employee emp = new Employee();

	// Marshal to Stream
	ByteArrayOutputStream stream = new ByteArrayOutputStream();
	marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", header);
	marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);
	marshaller.marshal(emp, stream);
	assertTrue("Custom header not written when marshalling to Stream.", new String(stream.toByteArray()).contains(header));

	// Marshal to Writer
	StringWriter writer = new StringWriter();
	marshaller.marshal(emp, writer);
	assertTrue("Custom header not written when marshalling to Writer.", writer.toString().contains(header));

	// Marshal to Result
	StringWriter writer2 = new StringWriter();
	StreamResult result = new StreamResult(writer2);
	marshaller.marshal(emp, result);
	assertTrue("Custom header not written when marshalling to Result.", writer2.toString().contains(header));

	marshaller.setProperty("org.glassfish.jaxb.xmlHeaders", null);
	}

	public void testSetNullPropertyException() {
	boolean caughtException = false;
	try {
	marshaller.setProperty(null, null);
	} catch (IllegalArgumentException e) {
	caughtException = true;
	} catch (Exception e) {
	}
	assertTrue("JAXBMarshaller did not throw IllegalArgumentException as expected.", caughtException);
	}

	public void testGetNullPropertyException() {
	boolean caughtException = false;
	try {
	marshaller.getProperty(null);
	} catch (IllegalArgumentException e) {
	caughtException = true;
	} catch (Exception e) {
	}
	assertTrue("JAXBMarshaller did not throw IllegalArgumentException as expected.", caughtException);
	}

	public void testSetInvalidPropertyException() {
	boolean caughtException = false;
	try {
	marshaller.setProperty("thisIsAnInvalidProperty", "thisIsAnInvalidValue");
	} catch (PropertyException e) {
	caughtException = true;
	} catch (Exception e) {
	}
	assertTrue("JAXBMarshaller did not throw PropertyException as expected.", caughtException);
	}

	public void testGetInvalidPropertyException() {
	boolean caughtException = false;
	try {
	marshaller.getProperty("thisIsAnInvalidProperty");
	} catch (PropertyException e) {
	caughtException = true;
	} catch (Exception e) {
	}
	assertTrue("JAXBMarshaller did not throw PropertyException as expected.", caughtException);
	}

	private Document parse(String resource) throws Exception {
	InputStream stream = getClass().getClassLoader().getResourceAsStream(resource);
	Document document = parser.parse(stream);
	removeEmptyTextNodes(document);
	return document;
	}
	}