/*
* 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.kernel;
import static com.google.common.base.Preconditions.checkNotNull;
import static org.apache.jackrabbit.oak.api.Type.LONG;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.junit.runners.Parameterized.Parameters;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.apache.jackrabbit.oak.NodeStoreFixture;
import org.apache.jackrabbit.oak.api.CommitFailedException;
import org.apache.jackrabbit.oak.api.PropertyState;
import org.apache.jackrabbit.oak.plugins.memory.MultiStringPropertyState;
import org.apache.jackrabbit.oak.spi.commit.CommitHook;
import org.apache.jackrabbit.oak.spi.commit.CommitInfo;
import org.apache.jackrabbit.oak.spi.commit.EmptyHook;
import org.apache.jackrabbit.oak.spi.commit.Observable;
import org.apache.jackrabbit.oak.spi.commit.Observer;
import org.apache.jackrabbit.oak.spi.state.DefaultNodeStateDiff;
import org.apache.jackrabbit.oak.spi.state.NodeBuilder;
import org.apache.jackrabbit.oak.spi.state.NodeState;
import org.apache.jackrabbit.oak.spi.state.NodeStore;
import org.junit.After;
import org.junit.Assume;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
@RunWith(value = Parameterized.class)
public class NodeStoreTest {
@Parameters
public static Collection<Object[]> fixtures() {
Object[][] fixtures = new Object[][] {
{NodeStoreFixture.MK_IMPL},
{NodeStoreFixture.MONGO_MK},
{NodeStoreFixture.MONGO_NS},
{NodeStoreFixture.SEGMENT_MK},
};
return Arrays.asList(fixtures);
}
private NodeStore store;
private NodeState root;
private NodeStoreFixture fixture;
public NodeStoreTest(NodeStoreFixture fixture) {
this.fixture = fixture;
}
@Before
public void setUp() throws Exception {
store = fixture.createNodeStore();
NodeBuilder builder = store.getRoot().builder();
NodeBuilder test = builder.child("test");
test.setProperty("a", 1);
test.setProperty("b", 2);
test.setProperty("c", 3);
test.child("x");
test.child("y");
test.child("z");
root = store.merge(builder, EmptyHook.INSTANCE, null);
}
@After
public void tearDown() throws Exception {
fixture.dispose(store);
}
@Test
public void getRoot() {
assertEquals(root, store.getRoot());
assertEquals(root.getChildNode("test"), store.getRoot().getChildNode("test"));
assertEquals(root.getChildNode("test").getChildNode("x"),
store.getRoot().getChildNode("test").getChildNode("x"));
assertEquals(root.getChildNode("test").getChildNode("any"),
store.getRoot().getChildNode("test").getChildNode("any"));
assertEquals(root.getChildNode("test").getProperty("a"),
store.getRoot().getChildNode("test").getProperty("a"));
assertEquals(root.getChildNode("test").getProperty("any"),
store.getRoot().getChildNode("test").getProperty("any"));
}
@Test
public void simpleMerge() throws CommitFailedException {
NodeBuilder rootBuilder = store.getRoot().builder();
NodeBuilder testBuilder = rootBuilder.child("test");
NodeBuilder newNodeBuilder = testBuilder.child("newNode");
testBuilder.getChildNode("x").remove();
newNodeBuilder.setProperty("n", 42);
// Assert changes are present in the builder
NodeState testState = rootBuilder.getNodeState().getChildNode("test");
assertTrue(testState.getChildNode("newNode").exists());
assertFalse(testState.getChildNode("x").exists());
assertEquals(42, (long) testState.getChildNode("newNode").getProperty("n").getValue(LONG));
// Assert changes are not yet present in the trunk
testState = store.getRoot().getChildNode("test");
assertFalse(testState.getChildNode("newNode").exists());
assertTrue(testState.getChildNode("x").exists());
store.merge(rootBuilder, EmptyHook.INSTANCE, null);
// Assert changes are present in the trunk
testState = store.getRoot().getChildNode("test");
assertTrue(testState.getChildNode("newNode").exists());
assertFalse(testState.getChildNode("x").exists());
assertEquals(42, (long) testState.getChildNode("newNode").getProperty("n").getValue(LONG));
}
@Test
public void afterCommitHook() throws CommitFailedException, InterruptedException {
Assume.assumeTrue(store instanceof Observable);
final AtomicReference<NodeState> observedRoot =
new AtomicReference<NodeState>(null);
final CountDownLatch latch = new CountDownLatch(2);
((Observable) store).addObserver(new Observer() {
@Override
public void contentChanged(
@Nonnull NodeState root, @Nullable CommitInfo info) {
if (root.getChildNode("test").hasChildNode("newNode")) {
observedRoot.set(checkNotNull(root));
latch.countDown();
}
}
});
NodeState root = store.getRoot();
NodeBuilder rootBuilder= root.builder();
NodeBuilder testBuilder = rootBuilder.child("test");
NodeBuilder newNodeBuilder = testBuilder.child("newNode");
newNodeBuilder.setProperty("n", 42);
testBuilder.getChildNode("a").remove();
store.merge(rootBuilder, EmptyHook.INSTANCE, null);
NodeState newRoot = store.getRoot(); // triggers the observer
latch.await(2, TimeUnit.SECONDS);
NodeState after = observedRoot.get();
assertNotNull(after);
assertTrue(after.getChildNode("test").getChildNode("newNode").exists());
assertFalse(after.getChildNode("test").getChildNode("a").exists());
assertEquals(42, (long) after.getChildNode("test").getChildNode("newNode").getProperty("n").getValue(LONG));
assertEquals(newRoot, after);
}
@Test
public void beforeCommitHook() throws CommitFailedException {
NodeState root = store.getRoot();
NodeBuilder rootBuilder = root.builder();
NodeBuilder testBuilder = rootBuilder.child("test");
NodeBuilder newNodeBuilder = testBuilder.child("newNode");
newNodeBuilder.setProperty("n", 42);
testBuilder.getChildNode("a").remove();
store.merge(rootBuilder, new CommitHook() {
@Override
public NodeState processCommit(NodeState before, NodeState after) {
NodeBuilder rootBuilder = after.builder();
NodeBuilder testBuilder = rootBuilder.child("test");
testBuilder.child("fromHook");
return rootBuilder.getNodeState();
}
}, null);
NodeState test = store.getRoot().getChildNode("test");
assertTrue(test.getChildNode("newNode").exists());
assertTrue(test.getChildNode("fromHook").exists());
assertFalse(test.getChildNode("a").exists());
assertEquals(42, (long) test.getChildNode("newNode").getProperty("n").getValue(LONG));
assertEquals(test, store.getRoot().getChildNode("test"));
}
@Test
public void manyChildNodes() throws CommitFailedException {
NodeBuilder root = store.getRoot().builder();
NodeBuilder parent = root.child("parent");
for (int i = 0; i <= KernelNodeState.MAX_CHILD_NODE_NAMES; i++) {
parent.child("child-" + i);
}
store.merge(root, EmptyHook.INSTANCE, null);
NodeState base = store.getRoot();
root = base.builder();
parent = root.child("parent");
parent.child("child-new");
store.merge(root, EmptyHook.INSTANCE, null);
Diff diff = new Diff();
store.getRoot().compareAgainstBaseState(base, diff);
assertEquals(0, diff.removed.size());
assertEquals(1, diff.added.size());
assertEquals("child-new", diff.added.get(0));
base = store.getRoot();
root = base.builder();
parent = root.getChildNode("parent");
parent.getChildNode("child-new").moveTo(parent, "child-moved");
store.merge(root, EmptyHook.INSTANCE, null);
diff = new Diff();
store.getRoot().compareAgainstBaseState(base, diff);
assertEquals(1, diff.removed.size());
assertEquals("child-new", diff.removed.get(0));
assertEquals(1, diff.added.size());
assertEquals("child-moved", diff.added.get(0));
base = store.getRoot();
root = base.builder();
parent = root.child("parent");
parent.child("child-moved").setProperty("foo", "value");
parent.child("child-moved").setProperty(
new MultiStringPropertyState("bar", Arrays.asList("value")));
store.merge(root, EmptyHook.INSTANCE, null);
diff = new Diff();
store.getRoot().compareAgainstBaseState(base, diff);
assertEquals(0, diff.removed.size());
assertEquals(0, diff.added.size());
assertEquals(2, diff.addedProperties.size());
assertTrue(diff.addedProperties.contains("foo"));
assertTrue(diff.addedProperties.contains("bar"));
base = store.getRoot();
root = base.builder();
parent = root.child("parent");
parent.setProperty("foo", "value");
parent.setProperty(new MultiStringPropertyState(
"bar", Arrays.asList("value")));
store.merge(root, EmptyHook.INSTANCE, null);
diff = new Diff();
store.getRoot().compareAgainstBaseState(base, diff);
assertEquals(0, diff.removed.size());
assertEquals(0, diff.added.size());
assertEquals(2, diff.addedProperties.size());
assertTrue(diff.addedProperties.contains("foo"));
assertTrue(diff.addedProperties.contains("bar"));
base = store.getRoot();
root = base.builder();
parent = root.child("parent");
parent.getChildNode("child-moved").remove();
store.merge(root, EmptyHook.INSTANCE, null);
diff = new Diff();
store.getRoot().compareAgainstBaseState(base, diff);
assertEquals(1, diff.removed.size());
assertEquals(0, diff.added.size());
assertEquals("child-moved", diff.removed.get(0));
}
@Test
public void move() throws CommitFailedException {
NodeBuilder test = store.getRoot().builder().getChildNode("test");
NodeBuilder x = test.getChildNode("x");
NodeBuilder y = test.getChildNode("y");
assertTrue(x.moveTo(y, "xx"));
assertFalse(x.exists());
assertTrue(y.exists());
assertFalse(test.hasChildNode("x"));
assertTrue(y.hasChildNode("xx"));
}
@Test
public void moveNonExisting() throws CommitFailedException {
NodeBuilder test = store.getRoot().builder().getChildNode("test");
NodeBuilder any = test.getChildNode("any");
NodeBuilder y = test.getChildNode("y");
assertFalse(any.moveTo(y, "xx"));
assertFalse(any.exists());
assertTrue(y.exists());
assertFalse(y.hasChildNode("xx"));
}
@Test
public void moveToExisting() throws CommitFailedException {
NodeBuilder test = store.getRoot().builder().getChildNode("test");
NodeBuilder x = test.getChildNode("x");
assertFalse(x.moveTo(test, "y"));
assertTrue(x.exists());
assertTrue(test.hasChildNode("x"));
assertTrue(test.hasChildNode("y"));
}
@Test
public void rename() throws CommitFailedException {
NodeBuilder test = store.getRoot().builder().getChildNode("test");
NodeBuilder x = test.getChildNode("x");
assertTrue(x.moveTo(test, "xx"));
assertFalse(x.exists());
assertFalse(test.hasChildNode("x"));
assertTrue(test.hasChildNode("xx"));
}
@Test
public void renameNonExisting() throws CommitFailedException {
NodeBuilder test = store.getRoot().builder().getChildNode("test");
NodeBuilder any = test.getChildNode("any");
assertFalse(any.moveTo(test, "xx"));
assertFalse(any.exists());
assertFalse(test.hasChildNode("xx"));
}
@Test
public void renameToExisting() throws CommitFailedException {
NodeBuilder test = store.getRoot().builder().getChildNode("test");
NodeBuilder x = test.getChildNode("x");
assertFalse(x.moveTo(test, "y"));
assertTrue(x.exists());
assertTrue(test.hasChildNode("x"));
assertTrue(test.hasChildNode("y"));
}
@Test
public void moveToSelf() throws CommitFailedException {
NodeBuilder test = store.getRoot().builder().getChildNode("test");
NodeBuilder x = test.getChildNode("x");
assertFalse(x.moveTo(test, "x"));
assertTrue(x.exists());
assertTrue(test.hasChildNode("x"));
}
@Test
public void moveToSelfNonExisting() throws CommitFailedException {
NodeBuilder test = store.getRoot().builder().getChildNode("test");
NodeBuilder any = test.getChildNode("any");
assertFalse(any.moveTo(test, "any"));
assertFalse(any.exists());
assertFalse(test.hasChildNode("any"));
}
@Test
public void moveToDescendant() throws CommitFailedException {
NodeBuilder test = store.getRoot().builder().getChildNode("test");
NodeBuilder x = test.getChildNode("x");
if (fixture == NodeStoreFixture.SEGMENT_MK) {
assertTrue(x.moveTo(x, "xx"));
assertFalse(x.exists());
assertFalse(test.hasChildNode("x"));
} else {
assertFalse(x.moveTo(x, "xx"));
assertTrue(x.exists());
assertTrue(test.hasChildNode("x"));
}
}
@Test
public void oak965() throws CommitFailedException {
NodeStore store1 = init(fixture.createNodeStore());
NodeStore store2 = init(fixture.createNodeStore());
try {
NodeState tree1 = store1.getRoot();
NodeState tree2 = store2.getRoot();
tree1.equals(tree2);
} finally {
fixture.dispose(store1);
fixture.dispose(store2);
}
}
private static NodeStore init(NodeStore store) throws CommitFailedException {
NodeBuilder builder = store.getRoot().builder();
builder.setChildNode("root");
store.merge(builder, EmptyHook.INSTANCE, null);
return store;
}
@Test
public void merge() throws CommitFailedException {
NodeState base = store.getRoot();
NodeBuilder builder1 = base.builder();
NodeBuilder builder2 = base.builder();
builder1.setChildNode("node1");
builder2.setChildNode("node2");
store.merge(builder1, EmptyHook.INSTANCE, null);
assertTrue(store.getRoot().hasChildNode("node1"));
assertFalse(store.getRoot().hasChildNode("node2"));
store.merge(builder2, EmptyHook.INSTANCE, null);
assertTrue(store.getRoot().hasChildNode("node1"));
assertTrue(store.getRoot().hasChildNode("node2"));
}
@Test
public void compareAgainstBaseState0() throws CommitFailedException {
compareAgainstBaseState(0);
}
@Test
public void compareAgainstBaseState20() throws CommitFailedException {
compareAgainstBaseState(20);
}
@Test
public void compareAgainstBaseState100() throws CommitFailedException {
compareAgainstBaseState(KernelNodeState.MAX_CHILD_NODE_NAMES);
}
@Test // OAK-1320
public void rebaseWithFailedMerge() throws CommitFailedException {
NodeBuilder rootBuilder = store.getRoot().builder();
rootBuilder.child("foo");
// commit something in between to force rebase
NodeBuilder b = store.getRoot().builder();
b.child("bar");
store.merge(b, EmptyHook.INSTANCE, null);
try {
store.merge(rootBuilder, new CommitHook() {
@Nonnull
@Override
public NodeState processCommit(NodeState before, NodeState after)
throws CommitFailedException {
throw new CommitFailedException("", 0, "commit rejected");
}
}, null);
fail("must throw CommitFailedException");
} catch (CommitFailedException e) {
// expected
}
// merge again
NodeState root = store.merge(rootBuilder, EmptyHook.INSTANCE, null);
assertTrue(root.hasChildNode("bar"));
}
private void compareAgainstBaseState(int childNodeCount) throws CommitFailedException {
NodeState before = store.getRoot();
NodeBuilder builder = before.builder();
for (int k = 0; k < childNodeCount; k++) {
builder.child("c" + k);
}
builder.child("foo").child(":bar").child("quz").setProperty("p", "v");
store.merge(builder, EmptyHook.INSTANCE, null);
NodeState after = store.getRoot();
Diff diff = new Diff();
after.compareAgainstBaseState(before, diff);
assertEquals(0, diff.removed.size());
assertEquals(childNodeCount + 1, diff.added.size());
assertEquals(0, diff.addedProperties.size());
}
private static class Diff extends DefaultNodeStateDiff {
List<String> addedProperties = new ArrayList<String>();
List<String> added = new ArrayList<String>();
List<String> removed = new ArrayList<String>();
@Override
public boolean childNodeAdded(String name, NodeState after) {
added.add(name);
return true;
}
@Override
public boolean childNodeDeleted(String name, NodeState before) {
removed.add(name);
return true;
}
@Override
public boolean childNodeChanged(
String name, NodeState before, NodeState after) {
return after.compareAgainstBaseState(before, this);
}
@Override
public boolean propertyAdded(PropertyState after) {
addedProperties.add(after.getName());
return true;
}
}
}