Unit tests for Alfresco aspect setting CMIS extensions

- Pioneered hybrid Surf/Chemistry approach to unit testing REST calls in the build
- Corrections to javascript library and Abdera extension
- Checking in source for Spring Surf Webscript test classes, generated with "mvn source:test-jar"

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@19433 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

config/alfresco/templates/webscripts/org/alfresco/cmis/lib/modify.lib.js

@@ -113,7 +113,7 @@ function updateNode(node, entry, exclude, validator)
         if (extension != null)
         {
             // Add and remove aspects
-            cmis.setAspects(node, extension.aspectsToAdd, extension.aspectsToRemove);
+            cmis.setAspects(node, extension.aspectsToRemove, extension.aspectsToAdd);
 
             // Apply the provided properties of the aspects
             unpackProperties(node, null, extension.properties, exclude, validator, vals);

source/java/org/alfresco/repo/cmis/rest/SetAspectsExtension.java

@@ -82,11 +82,12 @@ public class SetAspectsExtension extends ExtensibleElementWrapper
     public Set<String> getAspectsToAdd()
     {
         Set<String> aspects = new TreeSet<String>();
-        for (Element aspect = getFirstChild(ASPECTS_TO_ADD); aspect != null; aspect = aspect
+        for (Element aspect : this)
-                .getNextSibling(ASPECTS_TO_ADD))
+        {
+            if (aspect.getQName().equals(ASPECTS_TO_ADD))
             {
                 aspects.add(aspect.getText());
-
+            }
         }
         return aspects;
     }
@@ -99,11 +100,12 @@ public class SetAspectsExtension extends ExtensibleElementWrapper
     public Set<String> getAspectsToRemove()
     {
         Set<String> aspects = new TreeSet<String>();
-        for (Element aspect = getFirstChild(ASPECTS_TO_REMOVE); aspect != null; aspect = aspect
+        for (Element aspect : this)
-                .getNextSibling(ASPECTS_TO_REMOVE))
+        {
+            if (aspect.getQName().equals(ASPECTS_TO_REMOVE))
             {
                 aspects.add(aspect.getText());
-
+            }
         }
         return aspects;
     }

source/java/org/alfresco/repo/cmis/rest/test/AspectTest.addAspects.cmisatomentry.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns="http://www.w3.org/2005/Atom" xmlns:cmisra="http://docs.oasis-open.org/ns/cmis/restatom/200908/"
+    xmlns:cmis="http://docs.oasis-open.org/ns/cmis/core/200908/">
+    <id>urn:uuid:00000000-0000-0000-0000-000000000000</id>
+    <title>Aspect Test</title>
+    <updated>2010-01-01T00:00:00Z</updated>
+    <author>admin</author>
+    <summary>Aspect Test (summary)</summary>
+    <content type="text">Content</content>
+    <cmisra:object>
+        <cmis:properties>
+            <cmis:propertyId propertyDefinitionId="cmis:objectTypeId">
+                <cmis:value>cmis:document</cmis:value>
+            </cmis:propertyId>
+            <alf:setAspects xmlns:alf="http://www.alfresco.org">
+                <alf:aspectsToAdd>P:cm:syndication</alf:aspectsToAdd>
+                <alf:aspectsToAdd>P:cm:summarizable</alf:aspectsToAdd>
+                <alf:properties>
+                    <cmis:propertyString propertyDefinitionId="cm:summary">
+                        <cmis:value>Aspect Test (summary)</cmis:value>
+                    </cmis:propertyString>
+                    <!--  Add a property without explicitly adding its aspect. Should be automatically added. -->
+                    <cmis:propertyString propertyDefinitionId="cm:author">
+                        <cmis:value>David Ward</cmis:value>
+                    </cmis:propertyString>
+                </alf:properties>
+            </alf:setAspects>
+        </cmis:properties>
+    </cmisra:object>
+</entry>

source/java/org/alfresco/repo/cmis/rest/test/AspectTest.createObject.atomentry.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<entry xmlns="http://www.w3.org/2005/Atom" xmlns:cmisra="http://docs.oasis-open.org/ns/cmis/restatom/200908/"
+    xmlns:cmis="http://docs.oasis-open.org/ns/cmis/core/200908/">
+    <id>urn:uuid:00000000-0000-0000-0000-000000000000</id>
+    <title>${NAME}</title>
+    <updated>2010-01-01T00:00:00Z</updated>
+    <author>admin</author>
+    <link rel="alternate" href="" />
+    <summary>${NAME} (summary)</summary>
+    <cmisra:object>
+        <cmis:properties>
+            <cmis:propertyId propertyDefinitionId="cmis:objectTypeId">
+                <cmis:value>${TYPE}</cmis:value>
+            </cmis:propertyId>
+        </cmis:properties>
+    </cmisra:object>
+</entry>

source/java/org/alfresco/repo/cmis/rest/test/AspectTest.java

@@ -0,0 +1,228 @@
+/*
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco 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 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco 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 Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.alfresco.repo.cmis.rest.test;
+
+import java.io.Reader;
+import java.io.StringReader;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import javax.xml.namespace.QName;
+
+import org.alfresco.repo.cmis.rest.AlfrescoCMISExtensionFactory;
+import org.alfresco.repo.web.scripts.BaseWebScriptTest;
+import org.apache.abdera.Abdera;
+import org.apache.abdera.factory.Factory;
+import org.apache.abdera.i18n.iri.IRI;
+import org.apache.abdera.model.Document;
+import org.apache.abdera.model.Element;
+import org.apache.abdera.model.Entry;
+import org.apache.abdera.model.Link;
+import org.apache.abdera.model.Service;
+import org.apache.abdera.parser.Parser;
+import org.apache.chemistry.abdera.ext.CMISConstants;
+import org.apache.chemistry.abdera.ext.CMISObject;
+import org.apache.chemistry.abdera.ext.CMISProperty;
+import org.apache.chemistry.tck.atompub.client.CMISClient;
+import org.apache.chemistry.tck.atompub.utils.ResourceLoader;
+import org.junit.Assert;
+import org.springframework.extensions.webscripts.TestWebScriptServer.GetRequest;
+import org.springframework.extensions.webscripts.TestWebScriptServer.PostRequest;
+import org.springframework.extensions.webscripts.TestWebScriptServer.PutRequest;
+import org.springframework.extensions.webscripts.TestWebScriptServer.Request;
+import org.springframework.extensions.webscripts.TestWebScriptServer.Response;
+
+/**
+ * Tests Alfresco CMIS REST API extensions for Aspects.
+ */
+public class AspectTest extends BaseWebScriptTest
+{
+    private static final QName ELEMENT_PROPERTIES = new QName("http://www.alfresco.org", "properties");
+    private static final QName ELEMENT_APPLIED_ASPECTS = new QName("http://www.alfresco.org", "appliedAspects");
+
+    private static final String URL_CMIS = "/cmis";
+
+    private Abdera abdera;
+    private Parser parser;
+    private Factory factory;
+
+    public AspectTest() {
+        // construct Abdera Service
+        abdera = new Abdera();
+        factory = abdera.getFactory();
+        factory.registerExtension(new AlfrescoCMISExtensionFactory());
+        parser = factory.newParser();
+
+        // construct test templates
+        localTemplates = new ResourceLoader('/' + AspectTest.class.getPackage().getName().replace('.', '/') + '/');
+        
+        // Create a dummy client. We won't / can't use it to make requests.
+        cmisClient = new CMISClient(null, null, null, null);
+    }
+    private CMISClient cmisClient;
+    private ResourceLoader localTemplates;
+    private Service cmisService;
+    private Entry testCaseFolder;
+
+    @Override
+    public void setUp() throws Exception
+    {
+        super.setUp();
+                
+        setDefaultRunAs("admin");
+        
+        Request req = new GetRequest(URL_CMIS);
+        Response res = sendRequest(req, 200);
+        String xml = res.getContentAsString();
+        Assert.assertNotNull(xml);
+        Assert.assertTrue(xml.length() > 0);
+        cmisService = parse(new StringReader(xml));
+        Assert.assertNotNull(cmisService);
+        IRI rootFolderHREF = cmisClient.getRootCollection(cmisClient.getWorkspace(cmisService));
+        Assert.assertNotNull(rootFolderHREF);
+        String folderName = getClass().getSimpleName() + System.currentTimeMillis() + " - " + getName();
+        testCaseFolder = createObject(rootFolderHREF, folderName, "cmis:folder");
+    }
+
+    private <T extends Element> T parse(Reader doc) {
+        Document<T> entryDoc = parser.parse(doc);
+        return entryDoc.getRoot();
+    }
+    
+    private Entry createObject(IRI parent, String name, String type) throws Exception {
+        String createFolder = localTemplates.load("AspectTest.createObject.atomentry.xml");
+        createFolder = createFolder.replace("${NAME}", name);
+        createFolder = createFolder.replace("${TYPE}", type);
+        Request req = new PostRequest(parent.toString(), createFolder, CMISConstants.MIMETYPE_ENTRY);
+        Response res = sendRequest(req, 201);
+        Assert.assertNotNull(res);
+        String xml = res.getContentAsString();
+        Entry entry = parse(new StringReader(xml));
+        Assert.assertNotNull(entry);
+        return entry;
+    }
+    
+    public void testAspectSet() throws Exception
+    {
+        // create document for checkout
+        Link children = cmisClient.getChildrenLink(testCaseFolder);
+        Entry document = createObject(children.getHref(), getName(), "cmis:document");
+        Request documentReq = new GetRequest(document.getSelfLink().getHref().toString());
+        Response documentRes = sendRequest(documentReq, 200);
+        Assert.assertNotNull(documentRes);
+        String xml = documentRes.getContentAsString();
+        Assert.assertNotNull(xml);
+
+        // checkout
+        IRI checkedoutHREF = cmisClient.getCheckedOutCollection(cmisClient.getWorkspace(cmisService));
+        Request checkoutReq = new PostRequest(checkedoutHREF.toString(), xml, CMISConstants.MIMETYPE_ENTRY);
+        Response pwcRes = sendRequest(checkoutReq, 201);
+        Assert.assertNotNull(pwcRes);
+        Entry pwc = parse(new StringReader(pwcRes.getContentAsString()));
+        Assert.assertNotNull(pwc);
+
+        // Apply some aspects to the working copy
+        String updateFile = localTemplates.load("AspectTest.addAspects.cmisatomentry.xml");
+
+        Request updateReq = new PutRequest(pwc.getEditLink().getHref().toString(), updateFile,
+                CMISConstants.MIMETYPE_ENTRY);
+        Response pwcUpdatedres = sendRequest(updateReq, 200);
+        Assert.assertNotNull(pwcUpdatedres);
+        Entry updated = parse(new StringReader(pwcUpdatedres.getContentAsString()));
+
+        {
+            Set<String> appliedAspects = new HashSet<String>(5);
+            Map<String, String> aspectProperties = new HashMap<String, String>(11);
+            extractAspectsAndProperties(updated, appliedAspects, aspectProperties);
+            assertContains(appliedAspects, "P:cm:syndication", "P:cm:summarizable", "P:cm:author");
+            assertEquals("Aspect Test (summary)", aspectProperties.get("cm:summary"));
+            assertEquals("David Ward", aspectProperties.get("cm:author"));
+        }
+
+        // check in with updated aspects
+        String checkinFile = localTemplates.load("AspectTest.removeAndAddAspects.cmisatomentry.xml");
+        String checkinUrl = pwc.getSelfLink().getHref().toString();
+        Request checkinReq = new PutRequest(checkinUrl, checkinFile, CMISConstants.MIMETYPE_ENTRY).setArgs(Collections
+                .singletonMap("checkin", "true"));
+        Response checkinRes = sendRequest(checkinReq, 200);
+        Assert.assertNotNull(checkinRes);
+        Entry checkedIn = parse(new StringReader(checkinRes.getContentAsString()));
+        {
+            Set<String> appliedAspects = new HashSet<String>(5);
+            Map<String, String> aspectProperties = new HashMap<String, String>(11);
+            extractAspectsAndProperties(checkedIn, appliedAspects, aspectProperties);
+            assertContains(appliedAspects, "P:cm:syndication", "P:cm:summarizable", "P:cm:countable");
+            assertDoesNotContain(appliedAspects, "P:cm:author");
+            assertEquals("Aspect Test (new summary)", aspectProperties.get("cm:summary"));
+            assertNull(aspectProperties.get("cm:author"));
+        }
+    }
+
+    /**
+     * @param document
+     * @param appliedAspects
+     * @param aspectProperties
+     */
+    private void extractAspectsAndProperties(Entry document, Set<String> appliedAspects,
+            Map<String, String> aspectProperties)
+    {
+        CMISObject documentObject = document.getExtension(CMISConstants.OBJECT);
+        Assert.assertNotNull(documentObject);
+        Element aspectEl = documentObject.getProperties().getExtension(new QName("http://www.alfresco.org", "aspects"));
+        Assert.assertNotNull(aspectEl);
+        for (Element child : aspectEl)
+        {
+            if (child.getQName().equals(ELEMENT_APPLIED_ASPECTS))
+            {
+                appliedAspects.add(child.getText());
+            }
+            else if (child.getQName().equals(ELEMENT_PROPERTIES))
+            {
+                for (Element propertyEl : child)
+                {
+                    if (propertyEl instanceof CMISProperty)
+                    {
+                        CMISProperty prop = (CMISProperty) propertyEl;
+                        aspectProperties.put(prop.getId(), prop.getStringValue());
+                    }
+                }
+            }
+            else
+            {
+                fail("Unexpected element: " + child.getQName());
+            }
+        }
+    }
+
+    private void assertContains(Set<String> actual, String... expected)
+    {
+        Assert.assertTrue(actual.containsAll(Arrays.asList(expected)));
+    }
+
+    private void assertDoesNotContain(Set<String> actual, String... unexpected)
+    {
+        Set<String> copy = new HashSet<String>(actual);
+        copy.retainAll(Arrays.asList(unexpected));
+        Assert.assertTrue(copy.isEmpty());
+    }
+}

source/java/org/alfresco/repo/cmis/rest/test/AspectTest.removeAndAddAspects.cmisatomentry.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns="http://www.w3.org/2005/Atom" xmlns:cmisra="http://docs.oasis-open.org/ns/cmis/restatom/200908/"
+    xmlns:cmis="http://docs.oasis-open.org/ns/cmis/core/200908/">
+    <id>urn:uuid:00000000-0000-0000-0000-000000000000</id>
+    <title>Aspect Test</title>
+    <updated>2010-01-01T00:00:00Z</updated>
+    <author>admin</author>
+    <summary>Aspect Test (summary)</summary>
+    <content type="text">Content</content>
+    <cmisra:object>
+        <cmis:properties>
+            <cmis:propertyId propertyDefinitionId="cmis:objectTypeId">
+                <cmis:value>cmis:document</cmis:value>
+            </cmis:propertyId>
+            <alf:setAspects xmlns:alf="http://www.alfresco.org">
+                <alf:aspectsToAdd>P:cm:countable</alf:aspectsToAdd>
+                <alf:aspectsToRemove>P:cm:author</alf:aspectsToRemove>
+                <alf:properties>
+                    <cmis:propertyString propertyDefinitionId="cm:summary">
+                        <cmis:value>Aspect Test (new summary)</cmis:value>
+                    </cmis:propertyString>
+                </alf:properties>
+            </alf:setAspects>
+        </cmis:properties>
+    </cmisra:object>
+</entry>