trunk/chemistry-opencmis-server/chemistry-opencmis-server-inmemory/src/test/java/org/apache/chemistry/opencmis/inmemory/NavigationServiceTest.java

/*
 * 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.chemistry.opencmis.inmemory;

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

import java.math.BigInteger;
import java.util.ArrayList;
import java.util.List;

import org.apache.chemistry.opencmis.commons.PropertyIds;
import org.apache.chemistry.opencmis.commons.data.ObjectData;
import org.apache.chemistry.opencmis.commons.data.ObjectInFolderContainer;
import org.apache.chemistry.opencmis.commons.data.ObjectInFolderData;
import org.apache.chemistry.opencmis.commons.data.ObjectInFolderList;
import org.apache.chemistry.opencmis.commons.data.Properties;
import org.apache.chemistry.opencmis.commons.data.PropertyData;
import org.apache.chemistry.opencmis.commons.enums.IncludeRelationships;
import org.apache.chemistry.opencmis.commons.exceptions.CmisInvalidArgumentException;
import org.apache.chemistry.opencmis.inmemory.types.DocumentTypeCreationHelper;
import org.apache.chemistry.opencmis.util.repository.ObjectGenerator;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


public class NavigationServiceTest extends AbstractServiceTest {
    private static final Logger log = LoggerFactory.getLogger(NavigationServiceTest.class);
    private static final int NUM_ROOT_FOLDERS = 10;
    private String fLevel1FolderId;

    @Override
    @Before
    public void setUp() {
        super.setUp();
    }

    @Override
    @After
    public void tearDown() {
        super.tearDown();
    }

    @Test
    public void testGetChildren() {
        log.info("starting testGetChildren() ...");
        createLevel1Folders();

        log.info("test getting all objects with getChildren");
        BigInteger maxItems = BigInteger.valueOf(NUM_ROOT_FOLDERS * 2);
        BigInteger skipCount = BigInteger.valueOf(0);
        ObjectInFolderList result = fNavSvc.getChildren(fRepositoryId, fRootFolderId, "*", null, false,
                IncludeRelationships.NONE, null, true, maxItems, skipCount, null);
        List<ObjectInFolderData> folders = result.getObjects();
        log.info(" found " + folders.size() + " folders in getChildren()");
        for (ObjectInFolderData folder : folders) {
            log.info("   found folder id " + folder.getObject().getId() + " path segment " + folder.getPathSegment());
        }
        assertEquals(NUM_ROOT_FOLDERS, folders.size());

        log.info("test paging with getChildren");
        maxItems = BigInteger.valueOf(3);
        skipCount = BigInteger.valueOf(3);
        result = fNavSvc.getChildren(fRepositoryId, fRootFolderId, "*", null, false, IncludeRelationships.NONE, null,
                true, maxItems, skipCount, null);
        folders = result.getObjects();
        log.info(" found " + folders.size() + " folders in getChildren()");
        for (ObjectInFolderData folder : folders) {
            log.info("   found folder id " + folder.getObject().getId() + " path segment " + folder.getPathSegment());
        }
        assertEquals(3, folders.size());
        assertEquals("Folder 3", folders.get(0).getPathSegment());
        assertTrue(result.getNumItems().longValue() > 0);
        log.info("... testGetChildren() finished.");
    }

    @Test
    public void testGetFolderTree() {
        log.info("starting testGetFolderTree() ...");
        createFolderHierachy(3, 5);

        log.info("test getting all objects with getFolderTree");
        BigInteger depth = BigInteger.valueOf(-1);
        Boolean includePathSegments = true;
        String propertyFilter = "*";
        String renditionFilter = null;
        Boolean includeAllowableActions = false;
        String objectId = fRootFolderId;

        List<ObjectInFolderContainer> tree = fNavSvc.getFolderTree(fRepositoryId, objectId, depth, propertyFilter,
                includeAllowableActions, IncludeRelationships.NONE, renditionFilter, includePathSegments, null);

        log.info("Descendants for object id " + objectId + " are: ");
        for (ObjectInFolderContainer folder : tree) {
            logFolderContainer(folder, 0);
        }

        log.info("... testGetFolderTree() finished.");
    }

    private void logFolderContainer(ObjectInFolderContainer folder, int depth) {
        StringBuilder prefix = new StringBuilder();
        for (int i = 0; i < depth; i++) {
            prefix.append("   ");
        }

        log.info(prefix + "name: " + folder.getObject().getPathSegment());
        List<ObjectInFolderContainer> children = folder.getChildren();
        if (null != children) {
            for (ObjectInFolderContainer child : children) {
                logFolderContainer(child, depth + 1);
            }
        }
    }

    @Test
    public void testGetDescendants() {
        log.info("starting testGetDescendants() ...");
        final int numLevels = 3;
        final int childrenPerLevel = 3;
        int objCount = createFolderHierachy(numLevels, childrenPerLevel);

        log.info("test getting all objects with getDescendants");
        List<ObjectInFolderContainer> result = fNavSvc.getDescendants(fRepositoryId, fRootFolderId,
                BigInteger.valueOf(-1), "*", Boolean.TRUE, IncludeRelationships.NONE, null, Boolean.TRUE, null);

        for (ObjectInFolderContainer obj : result) {
            log.info("   found folder id " + obj.getObject().getObject().getId() + " path segment "
                    + obj.getObject().getPathSegment());
        }
        int sizeOfDescs = getSizeOfDescendants(result);
        assertEquals(objCount, sizeOfDescs);

        log.info("test getting one level with getDescendants");
        result = fNavSvc.getDescendants(fRepositoryId, fRootFolderId, BigInteger.valueOf(1), "*", Boolean.TRUE,
                IncludeRelationships.NONE, null, Boolean.TRUE, null);

        for (ObjectInFolderContainer obj : result) {
            log.info("   found folder id " + obj.getObject().getObject().getId() + " path segment "
                    + obj.getObject().getPathSegment());
        }
        sizeOfDescs = getSizeOfDescendants(result);
        assertEquals(childrenPerLevel, sizeOfDescs);

        log.info("test getting two levels with getDescendants");
        result = fNavSvc.getDescendants(fRepositoryId, fRootFolderId, BigInteger.valueOf(2), "*", Boolean.TRUE,
                IncludeRelationships.NONE, null, Boolean.TRUE, null);

        for (ObjectInFolderContainer obj : result) {
            log.info("   found folder id " + obj.getObject().getObject().getId() + " path segment "
                    + obj.getObject().getPathSegment());
        }
        sizeOfDescs = getSizeOfDescendants(result);
        assertEquals(childrenPerLevel * childrenPerLevel + childrenPerLevel, sizeOfDescs);

        log.info("... testGetDescendants() finished.");
    }

    @Test
    public void testGetFolderParent() {
        log.info("starting testGetFolderParent() ...");
        createLevel1Folders();
        String folderId = fLevel1FolderId;

        ObjectData result = fNavSvc.getFolderParent(fRepositoryId, folderId, null, null);
        log.info(" found parent for id \'" + folderId + "\' is \'" + result.getId() + "\'");
        assertEquals(fRootFolderId, result.getId()); // should be root folder

        folderId = fRootFolderId;
        try {
            result = fNavSvc.getFolderParent(fRepositoryId, folderId, null, null);
            log.info(" found parent for id " + folderId + " is " + result.getId());
            fail("Should not be possible to get parent for root folder");
        } catch (Exception e) {
            assertEquals(CmisInvalidArgumentException.class, e.getClass());
            log.info(" getParent() for root folder raised expected exception");
        }
        log.info("... testGetFolderParent() finished.");
    }

    @Test
    public void testGetPaging() {
        log.info("starting testGetPaging() ...");
        // create a folder
        String folderId = super.createFolder("PagingFolder", fRootFolderId, DocumentTypeCreationHelper
                .getCmisFolderType().getId());

        // create some documents
        for (int i = 0; i < 10; i++) {
            super.createDocument("File-" + i, folderId, "cmis:document", true);
        }
        log.info("test getting all objects with getChildren");
        // get first page
        BigInteger maxItems = BigInteger.valueOf(3);
        BigInteger skipCount = BigInteger.valueOf(0);
        ObjectInFolderList result = fNavSvc.getChildren(fRepositoryId, folderId, "*", null, false,
                IncludeRelationships.NONE, null, true, maxItems, skipCount, null);
        List<ObjectInFolderData> files = result.getObjects();
        log.info(" found " + files.size() + " files in getChildren()");
        for (ObjectInFolderData file : files) {
            log.info("   found folder id " + file.getObject().getId() + " path segment " + file.getPathSegment());
        }
        assertEquals(3, files.size());
        assertEquals(BigInteger.valueOf(10), result.getNumItems());
        assertTrue(result.hasMoreItems());

        // get second page
        maxItems = BigInteger.valueOf(3);
        skipCount = BigInteger.valueOf(3);
        result = fNavSvc.getChildren(fRepositoryId, folderId, "*", null, false, IncludeRelationships.NONE, null, true,
                maxItems, skipCount, null);
        files = result.getObjects();
        log.info(" found " + files.size() + " files in getChildren()");
        for (ObjectInFolderData file : files) {
            log.info("   found folder id " + file.getObject().getId() + " path segment " + file.getPathSegment());
        }
        assertEquals(3, files.size());
        assertEquals(BigInteger.valueOf(10), result.getNumItems());
        assertTrue(result.hasMoreItems());

        // get third page
        maxItems = BigInteger.valueOf(3);
        skipCount = BigInteger.valueOf(9);
        result = fNavSvc.getChildren(fRepositoryId, folderId, "*", null, false, IncludeRelationships.NONE, null, true,
                maxItems, skipCount, null);
        files = result.getObjects();
        log.info(" found " + files.size() + " files in getChildren()");
        for (ObjectInFolderData file : files) {
            log.info("   found folder id " + file.getObject().getId() + " path segment " + file.getPathSegment());
        }
        assertEquals(1, files.size());
        assertEquals(BigInteger.valueOf(10), result.getNumItems());
        assertFalse(result.hasMoreItems());
        log.info("... testGetPaging() finished.");

    }

    private int getSizeOfDescendants(List<ObjectInFolderContainer> objs) {
        int sum = 0;
        if (null != objs) {
            sum = objs.size();
            for (ObjectInFolderContainer obj : objs) {
                if (null != obj.getChildren()) {
                    sum += getSizeOfDescendants(obj.getChildren());
                }
            }
        }
        return sum;
    }

    private void createLevel1Folders() {
        for (int i = 0; i < NUM_ROOT_FOLDERS; i++) {
            List<PropertyData<?>> properties = new ArrayList<PropertyData<?>>();
            properties.add(fFactory.createPropertyIdData(PropertyIds.NAME, "Folder " + i));
            properties.add(fFactory.createPropertyIdData(PropertyIds.OBJECT_TYPE_ID, DocumentTypeCreationHelper
                    .getCmisFolderType().getId()));
            Properties props = fFactory.createPropertiesData(properties);
            String id = fObjSvc.createFolder(fRepositoryId, props, fRootFolderId, null, null, null, null);
            if (i == 3) {
                fLevel1FolderId = id;
            }
        }
    }

    private int createFolderHierachy(int levels, int childrenPerLevel) {

        ObjectGenerator gen = new ObjectGenerator(fFactory, fNavSvc, fObjSvc, fRepSvc, fRepositoryId,
                ObjectGenerator.ContentKind.LOREM_IPSUM_TEXT);
        gen.createFolderHierachy(levels, childrenPerLevel, fRootFolderId);
        int objCount = gen.getObjectsInTotal();
        return objCount;
    }

}