DOMNodeTest.java

/**
 * Copyright (C) 2010-2017 Structr GmbH
 *
 * This file is part of Structr <http://structr.org>.
 *
 * Structr is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Structr is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Structr.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.structr.web.entity.dom;

import java.util.LinkedList;
import java.util.List;
import static junit.framework.TestCase.fail;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import org.junit.Test;
import org.structr.common.error.FrameworkException;
import org.structr.core.GraphObject;
import org.structr.core.entity.relationship.AbstractChildren;
import org.structr.core.graph.Tx;
import org.structr.web.advanced.DOMTest;
import org.structr.web.entity.dom.relationship.DOMChildren;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.Text;

/**
 *
 *
 */
public class DOMNodeTest extends DOMTest {

	@Test
	public void testAppendChild() {

		try (final Tx tx = app.tx()) {

			Page document = (Page) getDocument();
			assertNotNull(document);

			DOMElement div = (DOMElement) document.createElement("div");
			assertNotNull(div);

			Content content1 = (Content) document.createTextNode("content1");
			Content content2 = (Content) document.createTextNode("content2");
			Content content3 = (Content) document.createTextNode("content3");

			assertNotNull(content1);
			assertNotNull(content2);
			assertNotNull(content3);

			// first step
			div.appendChild(content1);

			// check for correct relationship management
			List<DOMChildren> divRels = toList(div.getOutgoingRelationships(DOMChildren.class));
			assertEquals(1, divRels.size());
			assertEquals(Integer.valueOf(0), divRels.get(0).getProperty(AbstractChildren.position));

			// second step
			div.appendChild(content2);

			// check for correct relationship management
			divRels = toList(div.getOutgoingRelationships(DOMChildren.class));
			assertEquals(2, divRels.size());
			assertEquals(Integer.valueOf(0), divRels.get(0).getProperty(AbstractChildren.position));
			assertEquals(Integer.valueOf(1), divRels.get(1).getProperty(AbstractChildren.position));

			// third step: test removal of old parent when appending an existing node
			div.appendChild(content3);

			// assert that div has 3 children now
			assertEquals(3, div.getChildNodes().getLength());

			// create new container
			Element div2 = document.createElement("div");
			assertNotNull(div2);

			div.appendChild(div2);

			// div should have 4 children by now
			assertEquals(4, div.getChildNodes().getLength());

			// move text node to div2
			div2.appendChild(content3);

				// div should have 3 children now,
			// div2 should have content3 as a child now
			assertEquals(3, div.getChildNodes().getLength());
			assertEquals(content3, div2.getChildNodes().item(0));

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testGetParentNode() {

		try (final Tx tx = app.tx()) {

			Document document = getDocument();
			assertNotNull(document);

			Text content = document.createTextNode("Dies ist ein Test");
			assertNotNull(content);

			Element div = document.createElement("div");
			assertNotNull(div);

			// add child
			div.appendChild(content);

			Node parent = content.getParentNode();

			assertEquals(div, parent);

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testGetChildNodes() {

		try (final Tx tx = app.tx()) {

			Document document = getDocument();
			assertNotNull(document);

			Text test1 = document.createTextNode("test1");
			Text test2 = document.createTextNode("test2");
			Text test3 = document.createTextNode("test3");
			assertNotNull(test1);
			assertNotNull(test2);
			assertNotNull(test3);

			Element div = document.createElement("div");
			assertNotNull(div);

			// add children
			div.appendChild(test1);
			div.appendChild(test2);
			div.appendChild(test3);

			NodeList children = div.getChildNodes();

			assertEquals(test1, children.item(0));
			assertEquals(test2, children.item(1));
			assertEquals(test3, children.item(2));

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testRemoveChildNode() {

		try (final Tx tx = app.tx()) {

			Document document = getDocument();
			assertNotNull(document);

			Text test1 = document.createTextNode("test1");
			Text test2 = document.createTextNode("test2");
			Text test3 = document.createTextNode("test3");
			Text test4 = document.createTextNode("test4");
			Text test5 = document.createTextNode("test5");
			Text test6 = document.createTextNode("test6");
			assertNotNull(test1);
			assertNotNull(test2);
			assertNotNull(test3);
			assertNotNull(test4);
			assertNotNull(test5);
			assertNotNull(test6);

			Element div = document.createElement("div");
			assertNotNull(div);

			// add children
			div.appendChild(test1);
			div.appendChild(test2);
			div.appendChild(test3);
			div.appendChild(test4);
			div.appendChild(test5);

			// note that we do NOT add test6 as a child!
			NodeList children1 = div.getChildNodes();
			assertEquals(test1, children1.item(0));
			assertEquals(test2, children1.item(1));
			assertEquals(test3, children1.item(2));
			assertEquals(test4, children1.item(3));
			assertEquals(test5, children1.item(4));

			// test remove child node method
			div.removeChild(test3);

			NodeList children2 = div.getChildNodes();
			assertEquals(test1, children2.item(0));
			assertEquals(test2, children2.item(1));
			assertEquals(test4, children2.item(2));
			assertEquals(test5, children2.item(3));

			// test remove child node method
			div.removeChild(test1);

			NodeList children3 = div.getChildNodes();
			assertEquals(test2, children3.item(0));
			assertEquals(test4, children3.item(1));
			assertEquals(test5, children3.item(2));

			// and finally, test errors that should be raised
			try {

				div.removeChild(test6);

				fail("Removing a node that is not a child of the given node should raise a DOMException");

			} catch (DOMException dex) {

				assertEquals(DOMException.NOT_FOUND_ERR, dex.code);
			}
			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testSiblingMethods() {

		try (final Tx tx = app.tx()) {

			Document document = getDocument();
			assertNotNull(document);

			Text test1 = document.createTextNode("test1");
			Text test2 = document.createTextNode("test2");
			Text test3 = document.createTextNode("test3");
			Text test4 = document.createTextNode("test4");
			Text test5 = document.createTextNode("test5");

			assertNotNull(test1);
			assertNotNull(test2);
			assertNotNull(test3);
			assertNotNull(test4);
			assertNotNull(test5);

			Element div = document.createElement("div");
			assertNotNull(div);

			// add children
			div.appendChild(test1);
			div.appendChild(test2);
			div.appendChild(test3);
			div.appendChild(test4);
			div.appendChild(test5);

			// test first child
			assertEquals(test1, div.getFirstChild());

			// test last child
			assertEquals(test5, div.getLastChild());

			// test sibling methods
			assertNull(test1.getPreviousSibling());
			assertEquals(test3, test4.getPreviousSibling());
			assertEquals(test2, test1.getNextSibling());
			assertNull(test5.getNextSibling());

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testAppendChildErrors() {

		try (final Tx tx = app.tx()) {

			Document wrongDocument = getDocument();
			Document document = getDocument();

			assertNotNull(document);
			assertNotNull(wrongDocument);

			Text wrongTextNode = wrongDocument.createTextNode("test");

			Text test1 = document.createTextNode("test1");
			Text test2 = document.createTextNode("test2");
			Text test3 = document.createTextNode("test3");
			assertNotNull(test1);
			assertNotNull(test2);
			assertNotNull(test3);

			Element div = document.createElement("div");
			assertNotNull(div);

			// add children
			div.appendChild(test1);
			div.appendChild(test2);
			div.appendChild(test3);

			NodeList children = div.getChildNodes();

			assertEquals(test1, children.item(0));
			assertEquals(test2, children.item(1));
			assertEquals(test3, children.item(2));

			Element div2 = document.createElement("div");
			assertNotNull(div2);

			div.appendChild(div2);

			assertEquals(div, div2.getParentNode());

			try {

				div.appendChild(wrongTextNode);
				fail("Adding a node that was not created using the correct document should raise a DOMException");

			} catch (DOMException dex) {

				assertEquals(DOMException.WRONG_DOCUMENT_ERR, dex.code);
			}

			try {

				div.appendChild(div);
				fail("Adding a node to itself should raise a DOMException");

			} catch (DOMException dex) {

				assertEquals(DOMException.HIERARCHY_REQUEST_ERR, dex.code);
			}

			try {

				div2.appendChild(div);
				fail("Adding one of its own ancestors to a node should raise a DOMException");

			} catch (DOMException dex) {

				assertEquals(DOMException.HIERARCHY_REQUEST_ERR, dex.code);
			}

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testReplaceChild() {

		try (final Tx tx = app.tx()) {

			Document document = getDocument();
			assertNotNull(document);

			Text test1 = document.createTextNode("test1");
			Text test2 = document.createTextNode("test2");
			Text test3 = document.createTextNode("test3");
			Text test4 = document.createTextNode("test4");
			Text test5 = document.createTextNode("test5");
			Text test6 = document.createTextNode("test6");
			assertNotNull(test1);
			assertNotNull(test2);
			assertNotNull(test3);
			assertNotNull(test4);
			assertNotNull(test5);
			assertNotNull(test6);

			Element div = document.createElement("div");
			assertNotNull(div);

			// add children
			div.appendChild(test1);
			div.appendChild(test2);
			div.appendChild(test3);
			div.appendChild(test4);
			div.appendChild(test5);

			// examine children
			NodeList children1 = div.getChildNodes();
			assertEquals(test1, children1.item(0));
			assertEquals(test2, children1.item(1));
			assertEquals(test3, children1.item(2));
			assertEquals(test4, children1.item(3));
			assertEquals(test5, children1.item(4));

			// test replace child
			div.replaceChild(test6, test3);

			// examine children
			NodeList children2 = div.getChildNodes();
			assertEquals(test1, children2.item(0));
			assertEquals(test2, children2.item(1));
			assertEquals(test6, children2.item(2));
			assertEquals(test4, children2.item(3));
			assertEquals(test5, children2.item(4));

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testInsertBefore() {

		try (final Tx tx = app.tx()) {

			Document document = getDocument();
			assertNotNull(document);

			Text test1 = document.createTextNode("test1");
			Text test2 = document.createTextNode("test2");
			Text test3 = document.createTextNode("test3");
			Text test4 = document.createTextNode("test4");
			Text test5 = document.createTextNode("test5");
			Text test6 = document.createTextNode("test6");
			assertNotNull(test1);
			assertNotNull(test2);
			assertNotNull(test3);
			assertNotNull(test4);
			assertNotNull(test5);
			assertNotNull(test6);

			Element div = document.createElement("div");
			assertNotNull(div);

			// add children
			div.appendChild(test1);
			div.appendChild(test2);
			div.appendChild(test3);
			div.appendChild(test4);
			div.appendChild(test5);

			// examine children
			NodeList children1 = div.getChildNodes();
			assertEquals(test1, children1.item(0));
			assertEquals(test2, children1.item(1));
			assertEquals(test3, children1.item(2));
			assertEquals(test4, children1.item(3));
			assertEquals(test5, children1.item(4));

			// test replace child
			div.insertBefore(test6, test3);

			// examine children
			NodeList children2 = div.getChildNodes();
			assertEquals(test1, children2.item(0));
			assertEquals(test2, children2.item(1));
			assertEquals(test6, children2.item(2));
			assertEquals(test3, children2.item(3));
			assertEquals(test4, children2.item(4));
			assertEquals(test5, children2.item(5));

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testReplaceChildWithFragment() {

		try (final Tx tx = app.tx()) {

			Document document = getDocument();
			org.w3c.dom.DocumentFragment fragment = document.createDocumentFragment();

			assertNotNull(document);
			assertNotNull(fragment);

			Text test1 = document.createTextNode("test1");
			Text test2 = document.createTextNode("test2");
			Text test3 = document.createTextNode("test3");
			Text test4 = document.createTextNode("test4");
			Text test5 = document.createTextNode("test5");
			Text test6 = document.createTextNode("test6");
			Text test7 = document.createTextNode("test7");
			Text test8 = document.createTextNode("test8");
			Text test9 = document.createTextNode("test9");
			assertNotNull(test1);
			assertNotNull(test2);
			assertNotNull(test3);
			assertNotNull(test4);
			assertNotNull(test5);
			assertNotNull(test6);
			assertNotNull(test7);
			assertNotNull(test8);
			assertNotNull(test9);

			Element div = document.createElement("div");
			assertNotNull(div);

			// add children
			div.appendChild(test1);
			div.appendChild(test2);
			div.appendChild(test3);
			div.appendChild(test4);
			div.appendChild(test5);

			// examine children
			NodeList children1 = div.getChildNodes();
			assertEquals(test1, children1.item(0));
			assertEquals(test2, children1.item(1));
			assertEquals(test3, children1.item(2));
			assertEquals(test4, children1.item(3));
			assertEquals(test5, children1.item(4));

			// add children to document fragment
			fragment.appendChild(test6);
			fragment.appendChild(test7);
			fragment.appendChild(test8);
			fragment.appendChild(test9);

			// test replace child
			div.replaceChild(fragment, test3);

			// examine children
			NodeList children2 = div.getChildNodes();

			assertEquals(test1, children2.item(0));
			assertEquals(test2, children2.item(1));
			assertEquals(test6, children2.item(2));
			assertEquals(test7, children2.item(3));
			assertEquals(test8, children2.item(4));
			assertEquals(test9, children2.item(5));
			assertEquals(test4, children2.item(6));
			assertEquals(test5, children2.item(7));

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testInsertBeforeWithFragment() {

		try (final Tx tx = app.tx()) {

			Document document = getDocument();
			org.w3c.dom.DocumentFragment fragment = document.createDocumentFragment();

			assertNotNull(document);
			assertNotNull(fragment);

			Text test1 = document.createTextNode("test1");
			Text test2 = document.createTextNode("test2");
			Text test3 = document.createTextNode("test3");
			Text test4 = document.createTextNode("test4");
			Text test5 = document.createTextNode("test5");
			Text test6 = document.createTextNode("test6");
			Text test7 = document.createTextNode("test7");
			Text test8 = document.createTextNode("test8");
			Text test9 = document.createTextNode("test9");
			assertNotNull(test1);
			assertNotNull(test2);
			assertNotNull(test3);
			assertNotNull(test4);
			assertNotNull(test5);
			assertNotNull(test6);
			assertNotNull(test7);
			assertNotNull(test8);
			assertNotNull(test9);

			Element div = document.createElement("div");
			assertNotNull(div);

			// add children
			div.appendChild(test1);
			div.appendChild(test2);
			div.appendChild(test3);
			div.appendChild(test4);
			div.appendChild(test5);

			// examine children
			NodeList children1 = div.getChildNodes();
			assertEquals(test1, children1.item(0));
			assertEquals(test2, children1.item(1));
			assertEquals(test3, children1.item(2));
			assertEquals(test4, children1.item(3));
			assertEquals(test5, children1.item(4));

			// add children to document fragment
			fragment.appendChild(test6);
			fragment.appendChild(test7);
			fragment.appendChild(test8);
			fragment.appendChild(test9);

			// test replace child
			div.insertBefore(fragment, test3);

			// examine children
			NodeList children2 = div.getChildNodes();

			assertEquals(test1, children2.item(0));
			assertEquals(test2, children2.item(1));
			assertEquals(test6, children2.item(2));
			assertEquals(test7, children2.item(3));
			assertEquals(test8, children2.item(4));
			assertEquals(test9, children2.item(5));
			assertEquals(test3, children2.item(6));
			assertEquals(test4, children2.item(7));
			assertEquals(test5, children2.item(8));

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testAppendWithFragment() {

		try (final Tx tx = app.tx()) {

			Document document = getDocument();
			org.w3c.dom.DocumentFragment fragment = document.createDocumentFragment();

			assertNotNull(document);
			assertNotNull(fragment);

			Text test1 = document.createTextNode("test1");
			Text test2 = document.createTextNode("test2");
			Text test3 = document.createTextNode("test3");
			Text test4 = document.createTextNode("test4");
			Text test5 = document.createTextNode("test5");
			Text test6 = document.createTextNode("test6");
			Text test7 = document.createTextNode("test7");
			Text test8 = document.createTextNode("test8");
			Text test9 = document.createTextNode("test9");
			assertNotNull(test1);
			assertNotNull(test2);
			assertNotNull(test3);
			assertNotNull(test4);
			assertNotNull(test5);
			assertNotNull(test6);
			assertNotNull(test7);
			assertNotNull(test8);
			assertNotNull(test9);

			Element div = document.createElement("div");
			assertNotNull(div);

			// add children
			div.appendChild(test1);
			div.appendChild(test2);
			div.appendChild(test3);
			div.appendChild(test4);
			div.appendChild(test5);

			// examine children
			NodeList children1 = div.getChildNodes();
			assertEquals(test1, children1.item(0));
			assertEquals(test2, children1.item(1));
			assertEquals(test3, children1.item(2));
			assertEquals(test4, children1.item(3));
			assertEquals(test5, children1.item(4));

			// add children to document fragment
			fragment.appendChild(test6);
			fragment.appendChild(test7);
			fragment.appendChild(test8);
			fragment.appendChild(test9);

			// test replace child
			div.appendChild(fragment);

			// examine children
			NodeList children2 = div.getChildNodes();

			assertEquals(test1, children2.item(0));
			assertEquals(test2, children2.item(1));
			assertEquals(test3, children2.item(2));
			assertEquals(test4, children2.item(3));
			assertEquals(test5, children2.item(4));
			assertEquals(test6, children2.item(5));
			assertEquals(test7, children2.item(6));
			assertEquals(test8, children2.item(7));
			assertEquals(test9, children2.item(8));

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	@Test
	public void testNormalize() {

		try (final Tx tx = app.tx()) {

			Document document = getDocument();
			org.w3c.dom.DocumentFragment fragment = document.createDocumentFragment();

			assertNotNull(document);
			assertNotNull(fragment);

			final Text test0 = document.createTextNode("test0");
			final Text test1 = document.createTextNode("test1");
			final Text test2 = document.createTextNode("test2");
			final Text test3 = document.createTextNode("test3");
			final Text test4 = document.createTextNode("test4");
			final Text test5 = document.createTextNode("test5");
			final Text test6 = document.createTextNode("test6");
			final Text test7 = document.createTextNode("test7");
			final Text test8 = document.createTextNode("test8");
			final Text test9 = document.createTextNode("test9");

			assertNotNull(test0);
			assertNotNull(test1);
			assertNotNull(test2);
			assertNotNull(test3);
			assertNotNull(test4);
			assertNotNull(test5);
			assertNotNull(test6);
			assertNotNull(test7);
			assertNotNull(test8);
			assertNotNull(test9);

			final Element div = document.createElement("div");
			assertNotNull(div);

			final Element p0 = document.createElement("p");
			final Element p1 = document.createElement("p");
			final Element p2 = document.createElement("p");
			final Element p3 = document.createElement("p");

			assertNotNull(p0);
			assertNotNull(p1);
			assertNotNull(p2);
			assertNotNull(p3);

			div.appendChild(test0);
			div.appendChild(p0);
			div.appendChild(test1);
			div.appendChild(test2);
			div.appendChild(p1);
			div.appendChild(test3);
			div.appendChild(test4);
			div.appendChild(test5);
			div.appendChild(p2);
			div.appendChild(test6);
			div.appendChild(test7);
			div.appendChild(test8);
			div.appendChild(test9);
			div.appendChild(p3);

			// normalize
			div.normalize();

			NodeList children = div.getChildNodes();

			// div should now have 8 children,
			assertEquals(8, children.getLength());

			// check normalized children
			assertEquals("test0", children.item(0).getNodeValue());
			assertEquals(p0, children.item(1));
			assertEquals("test1test2", children.item(2).getNodeValue());
			assertEquals(p1, children.item(3));
			assertEquals("test3test4test5", children.item(4).getNodeValue());
			assertEquals(p2, children.item(5));
			assertEquals("test6test7test8test9", children.item(6).getNodeValue());
			assertEquals(p3, children.item(7));

			tx.success();

		} catch (FrameworkException fex) {

			fail("unexpected exception");
		}

	}

	private <T extends GraphObject> List<T> toList(final Iterable<T> it) {

		List<T> list = new LinkedList();

		for (T obj : it) {

			list.add(obj);

		}

		return list;
	}

}