DocumentCacheTest.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.test.cluster;

import org.junit.Assert;
import org.junit.Test;
import org.xwiki.model.reference.AttachmentReference;
import org.xwiki.model.reference.DocumentReference;
import org.xwiki.model.reference.LocalDocumentReference;
import org.xwiki.rest.model.jaxb.Attachment;
import org.xwiki.rest.model.jaxb.Attachments;
import org.xwiki.rest.model.jaxb.Page;
import org.xwiki.rest.resources.attachments.AttachmentsResource;
import org.xwiki.test.cluster.framework.AbstractClusterHttpTest;

/**
 * Verify the document cache update based on distributed events.
 * 
 * @version $Id: eb38095b3aa8a19ad0187ef3303f4175b3a72894 $
 */
public class DocumentCacheTest extends AbstractClusterHttpTest
{
    private final static String TEST_SPACE = "Test";

    @Test
    public void testDocumentModifiedCacheSync() throws Exception
    {
        Page page = new Page();
        page.setSpace(TEST_SPACE);
        page.setName("CacheSync");

        LocalDocumentReference documentReference = new LocalDocumentReference(page.getSpace(), page.getName());

        // 1) Edit a page on XWiki 0
        getUtil().switchExecutor(0);
        page.setContent("content");
        getUtil().rest().save(page);
        Assert.assertEquals("content", getUtil().rest().<Page>get(documentReference).getContent());

        // 2) Modify content of the page on XWiki 1
        getUtil().switchExecutor(1);
        page.setContent("modified content");
        getUtil().rest().save(page);
        Assert.assertEquals("modified content", getUtil().rest().<Page>get(documentReference).getContent());

        // ASSERT) The content in XWiki 0 should be the one set than in XWiki 1
        // Since it can take time for the Cluster to propagate the change, we need to wait and set up a timeout.
        getUtil().switchExecutor(0);
        long t1 = System.currentTimeMillis();
        long t2;
        String result;
        while (!(result = getUtil().rest().<Page>get(documentReference).getContent())
            .equalsIgnoreCase("modified content")) {
            t2 = System.currentTimeMillis();
            if (t2 - t1 > 10000L) {
                Assert.fail("Content should have been [modified content] but was [" + result + "]");
            }
            Thread.sleep(100);
        }
    }

    @Test
    public void testDocumentDeletedCacheSync() throws Exception
    {
        Page page = new Page();
        page.setSpace(TEST_SPACE);
        page.setName("CacheSync");

        LocalDocumentReference documentReference = new LocalDocumentReference(page.getSpace(), page.getName());

        // 1) Make sure page exist on XWiki 0
        getUtil().switchExecutor(0);
        page.setContent("content");
        getUtil().rest().save(page);
        Assert.assertEquals("content", getUtil().rest().<Page>get(documentReference).getContent());

        // 2) Delete page on XWiki 1
        getUtil().switchExecutor(1);
        // Need superadmin to delete document
        getUtil().loginAsSuperAdmin();
        getUtil().rest().delete(documentReference);
        Assert.assertFalse(getUtil().rest().exists(documentReference));

        // ASSERT) The document should be deleted on XWiki 0
        // Since it can take time for the Cluster to propagate the change, we need to wait and set up a timeout.
        getUtil().switchExecutor(0);
        long t1 = System.currentTimeMillis();
        long t2;
        while (getUtil().rest().exists(documentReference)) {
            t2 = System.currentTimeMillis();
            if (t2 - t1 > 10000L) {
                Assert.fail("Document shoud not exist anymore");
            }
            Thread.sleep(100);
        }
    }

    @Test
    public void testDocumentCacheSyncForAttachments() throws Exception
    {
        Page page = new Page();
        page.setSpace(TEST_SPACE);
        page.setName("AttachementCacheSync");

        AttachmentReference attachmentReference = new AttachmentReference("file.ext",
            new DocumentReference(getUtil().getCurrentWiki(), page.getSpace(), page.getName()));

        // 1) Edit a page on XWiki 0
        getUtil().switchExecutor(0);
        page.setContent("content");
        getUtil().rest().save(page);

        // 2) Add attachment to the page on XWiki 1
        getUtil().switchExecutor(1);
        getUtil().rest().attachFile(attachmentReference, "content".getBytes(), true);

        // ASSERT) The content in XWiki 0 should be the one set than in XWiki 1
        // Since it can take time for the Cluster to propagate the change, we need to wait and set up a timeout.
        getUtil().switchExecutor(0);
        long t1 = System.currentTimeMillis();
        long t2;
        while (!hasAttachment(attachmentReference)) {
            t2 = System.currentTimeMillis();
            if (t2 - t1 > 10000L) {
                Assert.fail("Failed to find attachment");
            }
            Thread.sleep(100);
        }
    }

    private boolean hasAttachment(AttachmentReference attachmentReference) throws Exception
    {
        Attachments attachments =
            getUtil().rest().get(AttachmentsResource.class, attachmentReference.getDocumentReference());
        for (Attachment attachment : attachments.getAttachments()) {
            System.out.println(attachment.getName());
            if (attachment.getName().equals(attachmentReference.getName())) {
                return true;
            }
        }

        return false;
    }
}