/*
* ModeShape (http://www.modeshape.org)
*
* 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.modeshape.jcr;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import javax.jcr.Node;
import javax.jcr.PropertyType;
import javax.jcr.RepositoryException;
import javax.jcr.nodetype.NodeType;
import javax.jcr.nodetype.NodeTypeExistsException;
import org.junit.Before;
import org.junit.Test;
import org.modeshape.jcr.api.nodetype.NodeTypeManager;
/**
* Test of CND-based type definitions. These test cases focus on ensuring that an import of a type from a CND file registers the
* expected type rather than attempting to validate all of the type registration functionality already tested in
* {@link TypeRegistrationTest}.
*/
public class NodeTypeRegistrationTest extends SingleUseAbstractTest {
private NodeTypeManager nodeTypeManager;
@Override
@Before
public void beforeEach() throws Exception {
super.beforeEach();
this.nodeTypeManager = session.getWorkspace().getNodeTypeManager();
}
protected InputStream resourceAsStream( String path ) {
return getClass().getClassLoader().getResourceAsStream(path);
}
protected URL resourceAsUrl( String path ) {
return getClass().getClassLoader().getResource(path);
}
protected NodeType assertNodeType( String name ) throws RepositoryException {
NodeType type = nodeTypeManager.getNodeType(name);
assertThat(type, is(notNullValue()));
return type;
}
@Test
public void shouldAccessCustomNodeTypeManagerViaCasting() throws Exception {
NodeTypeManager nodeTypeMgr = session.getWorkspace().getNodeTypeManager();
assertThat(nodeTypeMgr, is(notNullValue()));
}
@Test
public void shouldAccessCustomNodeTypeManagerViaProtectedMethods() throws Exception {
NodeTypeManager nodeTypeMgr = session.workspace().nodeTypeManager();
assertThat(nodeTypeMgr, is(notNullValue()));
}
@Test( expected = IOException.class )
public void shouldFailIfResourceFileCouldNotBeFoundAsRelativeFile() throws Exception {
File file = new File("/this/resource/file/does/not/exist");
assertThat(file.exists(), is(false));
nodeTypeManager.registerNodeTypes(file, true);
}
@Test( expected = IOException.class )
public void shouldFailIfResourceFileCouldNotBeFoundAsUrl() throws Exception {
File file = new File("/this/resource/file/does/not/exist");
assertThat(file.exists(), is(false));
URL url = file.toURI().toURL();
nodeTypeManager.registerNodeTypes(url, true);
}
@Test
public void shouldLoadNodeTypesFromCndResourceFileFoundOnClasspath() throws Exception {
nodeTypeManager.registerNodeTypes(resourceAsStream("cnd/cars.cnd"), true);
assertNodeType("car:Car");
}
@Test
public void shouldLoadNodeTypesFromCndResourceFileFoundWithRelativePathOnFileSystem() throws Exception {
File file = new File("src/test/resources/cnd/cars.cnd");
if (file.exists()) {
nodeTypeManager.registerNodeTypes(file, true);
assertNodeType("car:Car");
}
}
@Test
public void shouldLoadNodeTypesFromCndResourceFileFoundWithAbsolutePathOnFileSystem() throws Exception {
File file = new File("src/test/resources/cnd/cars.cnd");
if (file.exists()) {
nodeTypeManager.registerNodeTypes(file.getAbsoluteFile(), true);
assertNodeType("car:Car");
}
}
@Test
public void shouldLoadNodeTypesFromUrlToCndFile() throws Exception {
nodeTypeManager.registerNodeTypes(resourceAsUrl("cnd/cars.cnd"), true);
assertNodeType("car:Car");
}
@Test( expected = NodeTypeExistsException.class )
public void shouldNotAllowRedefinitionOfExistingTypesFromCndFile() throws Exception {
nodeTypeManager.registerNodeTypes(resourceAsUrl("cnd/existingType.cnd"), false);
// assertNodeType("nt:folder");
}
@Test
public void shouldLoadMagnoliaTypesFromCndFile() throws Exception {
nodeTypeManager.registerNodeTypes(resourceAsUrl("cnd/magnolia.cnd"), true);
assertNodeType("mgnl:contentNode");
}
@Test
public void shouldRegisterValidTypesFromCndFile() throws Exception {
nodeTypeManager.registerNodeTypes(resourceAsUrl("cnd/validType.cnd"), true);
NodeType nodeType = assertNodeType("modetest:testType");
assertThat(nodeType, is(notNullValue()));
assertThat(nodeType.isMixin(), is(true));
assertThat(nodeType.hasOrderableChildNodes(), is(true));
assertThat(nodeType.getDeclaredSupertypes().length, is(2));
assertThat(nodeType.getDeclaredChildNodeDefinitions().length, is(1));
JcrNodeDefinition childNode = (JcrNodeDefinition)nodeType.getDeclaredChildNodeDefinitions()[0];
assertThat(childNode.getName(), is("modetest:namespace"));
assertThat(childNode.getDefaultPrimaryType().getName(), is("mode:namespace"));
assertThat(childNode.getRequiredPrimaryTypes().length, is(1));
assertThat(childNode.getRequiredPrimaryTypes()[0].getName(), is("mode:namespace"));
assertThat(childNode.allowsSameNameSiblings(), is(false));
assertThat(childNode.isMandatory(), is(false));
assertThat(nodeType.getDeclaredPropertyDefinitions().length, is(1));
JcrPropertyDefinition property = (JcrPropertyDefinition)nodeType.getDeclaredPropertyDefinitions()[0];
assertThat(property.getName(), is("*"));
assertThat(property.getRequiredType(), is(PropertyType.STRING));
assertThat(property.getValueConstraints().length, is(3));
assertThat(property.getValueConstraints()[0], is("foo"));
assertThat(property.getValueConstraints()[1], is("bar"));
assertThat(property.getValueConstraints()[2], is("baz"));
assertThat(property.getDefaultValues().length, is(1));
assertThat(property.getDefaultValues()[0].getString(), is("foo"));
}
@Test
public void shouldLoadNodeTypesFromXmlResourceFileFoundOnClasspath() throws Exception {
nodeTypeManager.registerNodeTypes(resourceAsStream("xml/magnolia_forum_nodetypes.xml"), true);
assertNodeType("mgnl:forum");
}
@Test
public void shouldLoadNodeTypesFromXmlResourceFileFoundWithRelativePathOnFileSystem() throws Exception {
File file = new File("src/test/resources/xml/magnolia_forum_nodetypes.xml");
if (file.exists()) {
nodeTypeManager.registerNodeTypes(file, true);
assertNodeType("mgnl:forum");
}
}
@Test
public void shouldLoadNodeTypesFromXmlResourceFileFoundWithAbsolutePathOnFileSystem() throws Exception {
File file = new File("src/test/resources/xml/magnolia_forum_nodetypes.xml");
if (file.exists()) {
nodeTypeManager.registerNodeTypes(file.getAbsoluteFile(), true);
assertNodeType("mgnl:forum");
}
}
@Test
public void shouldLoadNodeTypesFromUrl() throws Exception {
nodeTypeManager.registerNodeTypes(resourceAsUrl("xml/magnolia_forum_nodetypes.xml"), true);
assertNodeType("mgnl:forum");
}
@Test
public void shouldLoadMagnoliaNodeTypesFromXml() throws Exception {
nodeTypeManager.registerNodeTypes(resourceAsStream("xml/magnolia_forum_nodetypes.xml"), true);
assertNodeType("mgnl:forum");
}
@Test
public void shouldLoadOwfeNodeTypesFromXml() throws Exception {
nodeTypeManager.registerNodeTypes(resourceAsStream("xml/owfe_nodetypes.xml"), true);
assertNodeType("expression");
}
@Test
public void shouldLoadCustomNodeTypesFromXml() throws Exception {
nodeTypeManager.registerNodeTypes(resourceAsStream("xml/custom_nodetypes.xml"), true);
assertNodeType("mgnl:reserve");
}
@Test
public void shouldAllowDisjunctiveResidualChildNodeDefinitions() throws Exception {
// This is an extended test of the MODE-698 fix
nodeTypeManager.registerNodeTypes(resourceAsStream("cnd/magnolia.cnd"), true);
assertNodeType("mgnl:contentNode");
Node rootNode = session.getRootNode();
Node branchNode = rootNode.addNode("disjunctiveTest", "nt:unstructured");
Node testNode = branchNode.addNode("testNode", "mgnl:content");
assertTrue(testNode.hasNode("MetaData"));
session.save();
// This residual definition comes from the ancestor - nt:hierarchyNode
testNode.addNode("hierarchyNode", "nt:folder");
// This residual definition comes from mgnl:content
testNode.addNode("baseNode", "nt:unstructured");
session.save();
}
}