UpdateSmokeTest

/*
 * 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.tck.tests.crud;

import static org.apache.chemistry.opencmis.tck.CmisTestResultStatus.FAILURE;
import static org.apache.chemistry.opencmis.tck.CmisTestResultStatus.WARNING;

import java.util.HashMap;
import java.util.Map;

import org.apache.chemistry.opencmis.client.api.Document;
import org.apache.chemistry.opencmis.client.api.Folder;
import org.apache.chemistry.opencmis.client.api.ObjectId;
import org.apache.chemistry.opencmis.client.api.Session;
import org.apache.chemistry.opencmis.commons.PropertyIds;
import org.apache.chemistry.opencmis.commons.definitions.DocumentTypeDefinition;
import org.apache.chemistry.opencmis.commons.definitions.PropertyDefinition;
import org.apache.chemistry.opencmis.commons.enums.Action;
import org.apache.chemistry.opencmis.commons.enums.Updatability;
import org.apache.chemistry.opencmis.tck.CmisTestResult;
import org.apache.chemistry.opencmis.tck.impl.AbstractSessionTest;

/**
 * Update smoke test.
 */
public class UpdateSmokeTest extends AbstractSessionTest {

    private static final String DOC_NAME1 = "updatetest1.txt";
    private static final String DOC_NAME2 = "updatetest2.txt";
    private static final String FOLDER_NAME1 = "updatetest1";
    private static final String FOLDER_NAME2 = "updatetest2";

    @Override
    public void init(Map<String, String> parameters) {
        super.init(parameters);
        setName("Update Smoke Test");
        setDescription("Creates a document, updates its name and finally deletes it.");
    }

    @Override
    public void run(Session session) {
        try {
            // create test folder
            Folder testFolder = createTestFolder(session);

            // document test
            updateDocument(session, testFolder);

            // folder test
            updateFolder(session, testFolder);
        } finally {
            // clean up
            deleteTestFolder();
        }
    }

    private void updateDocument(Session session, Folder testFolder) {
        CmisTestResult f;

        // create document
        Document doc1 = createDocument(session, testFolder, DOC_NAME1, "rename me!");
        Document workDoc = doc1;

        f = createResult(FAILURE, "Document name doesn't match the given name!");
        addResult(assertEquals(DOC_NAME1, doc1.getName(), null, f));

        // test if check out is required
        boolean checkedout = false;
        DocumentTypeDefinition type = (DocumentTypeDefinition) doc1.getType();
        PropertyDefinition<?> namePropDef = type.getPropertyDefinitions().get(PropertyIds.NAME);
        if (namePropDef.getUpdatability() == Updatability.WHENCHECKEDOUT
                || (!doc1.getAllowableActions().getAllowableActions().contains(Action.CAN_UPDATE_PROPERTIES) && Boolean.TRUE
                        .equals(type.isVersionable()))) {
            workDoc = (Document) session.getObject(doc1.checkOut(), SELECT_ALL_NO_CACHE_OC);
            checkedout = true;
        }

        // update
        Map<String, Object> properties = new HashMap<String, Object>();
        properties.put(PropertyIds.NAME, DOC_NAME2);

        ObjectId newId = workDoc.updateProperties(properties, false);
        Document doc2 = (Document) session.getObject(newId, SELECT_ALL_NO_CACHE_OC);

        addResult(checkObject(session, doc2, getAllProperties(doc2), "Updated document compliance"));

        f = createResult(FAILURE, "Document name doesn't match updated value!");
        addResult(assertEquals(DOC_NAME2, doc2.getName(), null, f));

        // delete
        if (!workDoc.getId().equals(doc2.getId())) {
            deleteObject(doc2);
        }

        // cancel a possible check out
        if (checkedout) {
            workDoc.cancelCheckOut();
        }

        if (!doc1.getId().equals(doc2.getId())) {
            if (exists(doc1)) {
                deleteObject(doc1);
            }
        }
    }

    private void updateFolder(Session session, Folder testFolder) {
        CmisTestResult f;

        Folder folder = createFolder(session, testFolder, FOLDER_NAME1);

        f = createResult(FAILURE, "Folder name doesn't match the given name!");
        addResult(assertEquals(FOLDER_NAME1, folder.getName(), null, f));

        // update
        Map<String, Object> properties = new HashMap<String, Object>();
        properties.put(PropertyIds.NAME, FOLDER_NAME2);

        ObjectId newId = folder.updateProperties(properties, false);

        f = createResult(WARNING, "Folder id changed after name update! The folder id should never change!");
        addResult(assertEquals(folder.getId(), newId.getId(), null, f));

        // get the new folder object and check the new name
        folder.refresh();

        f = createResult(FAILURE, "Folder name doesn't match updated value!");
        addResult(assertEquals(FOLDER_NAME2, folder.getName(), null, f));

        // update again with the same name
        folder.rename(FOLDER_NAME2, true);

        f = createResult(FAILURE, "Folder name doesn't match updated value!");
        addResult(assertEquals(FOLDER_NAME2, folder.getName(), null, f));

        deleteObject(folder);
    }
}