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.

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

OAK-11000: Test coverage for common JCR operations related to importing content #1622

Open
wants to merge 13 commits into
base: trunk
Choose a base branch
from
Open
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,222 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.jackrabbit.oak.jcr;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.util.HashSet;
import java.util.Set;
import java.util.UUID;

import javax.jcr.Node;
import javax.jcr.Property;
import javax.jcr.PropertyIterator;
import javax.jcr.PropertyType;
import javax.jcr.ReferentialIntegrityException;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
import javax.jcr.nodetype.ConstraintViolationException;
import javax.jcr.nodetype.NodeType;

import org.apache.jackrabbit.oak.fixture.NodeStoreFixture;
import org.junit.Before;
import org.junit.Test;

/**
* Test coverage for common JCR operations related to importing content.
* <p>
* Note that the purpose of these tests is not to check conformance with the JCR
* specification, but to observe the actual behavior of the implementation
* (which may be hard to change).
*/
public class ImportOperationsTest extends AbstractRepositoryTest {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The class name is confusing to me. What about ProtectedPropertyTest because IIUC this is mainly about jcr:uuid and jcr:created for cases when both become protected.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe even split up general protected properties from jcr:uuid into dedicated test classes make sense because the latter imposes additional restrictions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done the remaining; let's discuss splitting later on.


private Session session;
private Node testNode;
private static String TEST_NODE_NAME = "ImportOperationsTest";
private static String TEST_NODE_NAME_REF = "ImportOperationsTest-Reference";
private static String TEST_NODE_NAME_TMP = "ImportOperationsTest-Temp";

public ImportOperationsTest(NodeStoreFixture fixture) {
super(fixture);
}

@Before
public void setup() throws RepositoryException {
this.session = getAdminSession();
this.testNode = session.getRootNode().addNode("import-tests", NodeType.NT_UNSTRUCTURED);
session.save();
}

@Test
public void jcrMixinCreatedOnNtUnstructured() throws RepositoryException {
Node test = testNode.addNode(TEST_NODE_NAME, NodeType.NT_UNSTRUCTURED);
try {
test.setProperty("jcr:created", false);
session.save();
test.addMixin(NodeType.MIX_CREATED);
session.save();
// surprise: setting the mixin succeeds, and the subsequent state of
// the node is inconsistent with the mixin's type definition
assertEquals(false, test.getProperty("jcr:created").getBoolean());
reschke marked this conversation as resolved.
Show resolved Hide resolved
} finally {
test.remove();
session.save();
}
}

@Test
public void jcrMixinReferenceableOnNtUnstructuredBeforeSettingMixin() throws RepositoryException {
Node test = testNode.addNode(TEST_NODE_NAME, NodeType.NT_UNSTRUCTURED);
try {
String testUuid = UUID.randomUUID().toString();
test.setProperty("jcr:uuid", testUuid);
session.save();
test.addMixin(NodeType.MIX_REFERENCEABLE);
session.save();
// surprise: setting the mixin succeeds, and the subsequent state of
// the node doesn't have an autocreated UUID
assertEquals(testUuid, test.getProperty("jcr:uuid").getString());
reschke marked this conversation as resolved.
Show resolved Hide resolved
} finally {
test.remove();
session.save();
}
}

@Test
public void jcrMixinReferenceableOnNtUnstructuredAfterSettingMixin() throws RepositoryException {
Node test = testNode.addNode(TEST_NODE_NAME, NodeType.NT_UNSTRUCTURED);
test.addMixin(NodeType.MIX_REFERENCEABLE);
session.save();
try {
String testUuid = UUID.randomUUID().toString();
test.setProperty("jcr:uuid", testUuid);
session.save();
fail("Setting jcr:uuid after adding mixin:referenceable should fail");
} catch (ConstraintViolationException ex) {
// expected
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is IMHO mandated by the JCR spec as mix:referenceable defines jcr:uuid as protected (so this test rather belongs to the JCR TCK)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's there we could drop it.

} finally {
test.remove();
session.save();
}
}

@Test
public void jcrMixinReferenceableOnNtUnstructuredAfterRemovingMixin() throws RepositoryException {
Node test = testNode.addNode(TEST_NODE_NAME, NodeType.NT_UNSTRUCTURED);
test.addMixin(NodeType.MIX_REFERENCEABLE);
session.save();
try {
test.removeMixin(NodeType.MIX_REFERENCEABLE);
String testUuid = UUID.randomUUID().toString();
test.setProperty("jcr:uuid", testUuid);
session.save();
test.addMixin(NodeType.MIX_REFERENCEABLE);
session.save();
assertEquals(testUuid, test.getProperty("jcr:uuid").getString());
Node check = session.getNodeByIdentifier(testUuid);
assertTrue(test.isSame(check));
} finally {
test.remove();
session.save();
}
}

@Test
public void jcrMixinReferenceableOnNtUnstructuredAfterRemovingMixinButDanglingReference() throws RepositoryException {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JCR TCK?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe; if you can find it. For now I'll leave it here, because having related tests in different places doesn't seem to be helpful.

Node test = testNode.addNode(TEST_NODE_NAME, NodeType.NT_UNSTRUCTURED);
test.addMixin(NodeType.MIX_REFERENCEABLE);
session.save();
Node ref = testNode.addNode(TEST_NODE_NAME_REF, NodeType.NT_UNSTRUCTURED);
ref.setProperty("reference", test.getIdentifier(), PropertyType.REFERENCE);
session.save();

try {
test.removeMixin(NodeType.MIX_REFERENCEABLE);
String testUuid = UUID.randomUUID().toString();
test.setProperty("jcr:uuid", testUuid);
session.save();
fail("Changing jcr:uuid causing a dangling refence should fail");
} catch (ReferentialIntegrityException ex) {
// expected
} finally {
ref.remove();
test.remove();
session.save();
}
}

@Test
public void changeUuidOnReferenceNode() throws RepositoryException {
Node test = testNode.addNode(TEST_NODE_NAME, NodeType.NT_UNSTRUCTURED);
test.addMixin(NodeType.MIX_REFERENCEABLE);
session.save();
Node ref = testNode.addNode(TEST_NODE_NAME_REF, NodeType.NT_UNSTRUCTURED);
ref.setProperty("reference", test.getIdentifier(), PropertyType.REFERENCE);
session.save();

// temporary node for rewriting the references
Node tmp = testNode.addNode(TEST_NODE_NAME_TMP, NodeType.NT_UNSTRUCTURED);
tmp.addMixin(NodeType.MIX_REFERENCEABLE);
session.save();

try {
// find all existing references to the node for which we want to rewrite the jcr:uuid
Set<Property> referrers = getReferrers(test);

// move existing references to TEST_MODE_NAME to TEST_NODE_NAME_TMP
setReferrersTo(referrers, tmp.getIdentifier());
session.save();

// rewrite jcr:uuid
test.removeMixin(NodeType.MIX_REFERENCEABLE);
String testUuid = UUID.randomUUID().toString();
test.setProperty("jcr:uuid", testUuid);
test.addMixin(NodeType.MIX_REFERENCEABLE);
session.save();

// restore references
setReferrersTo(referrers, testUuid);
session.save();
} finally {
tmp.remove();
ref.remove();
test.remove();
session.save();
}
}

private static Set<Property> getReferrers(Node to) throws RepositoryException {
Set<Property> referrers = new HashSet<>();
PropertyIterator pit = to.getReferences();
while (pit.hasNext()) {
referrers.add(pit.nextProperty());
}
return referrers;
}

private static void setReferrersTo(Set<Property> referrers, String identifier) throws RepositoryException {
for (Property p : referrers) {
// add case for multivalued
p.getParent().setProperty(p.getName(), identifier);
}
}
}
Loading