Unit test for type form filter

* experimenting to see if Mockito would allow us to unit test code previously difficult to test



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

rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/forms/RecordsManagementTypeFormFilter.java

@@ -145,7 +145,7 @@ public class RecordsManagementTypeFormFilter extends RecordsManagementFormFilter
 
         Map<QName, PropertyDefinition> customProps = rmAdminService.getCustomPropertyDefinitions(customisableType);
 
-        if (customProps != null)
+        if (customProps != null && customProps.isEmpty() == false)
         {
 	        if (logger.isDebugEnabled() == true)
 	        {

rm-server/unit-test/java/org/alfresco/module/org_alfresco_module_rm/AllUnitTestSuite.java

@@ -18,6 +18,7 @@
  */
 package org.alfresco.module.org_alfresco_module_rm;
 
+import org.alfresco.module.org_alfresco_module_rm.forms.RecordsManagementTypeFormFilterUnitTest;
 import org.alfresco.module.org_alfresco_module_rm.record.RecordMetadataBootstrapUnitTest;
 import org.alfresco.module.org_alfresco_module_rm.record.RecordServiceImplUnitTest;
 import org.junit.runner.RunWith;
@@ -34,7 +35,8 @@ import org.junit.runners.Suite.SuiteClasses;
 @SuiteClasses(
 {
     RecordMetadataBootstrapUnitTest.class,
-    RecordServiceImplUnitTest.class
+    RecordServiceImplUnitTest.class,
+    RecordsManagementTypeFormFilterUnitTest.class
 })
 public class AllUnitTestSuite
 {

rm-server/unit-test/java/org/alfresco/module/org_alfresco_module_rm/BaseUnitTest.java

@@ -20,6 +20,7 @@ package org.alfresco.module.org_alfresco_module_rm;
 
 import static org.mockito.Mockito.when;
 
+import org.alfresco.module.org_alfresco_module_rm.identifier.IdentifierService;
 import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
 import org.alfresco.service.cmr.dictionary.DictionaryService;
 import org.alfresco.service.cmr.repository.NodeRef;
@@ -28,6 +29,7 @@ import org.alfresco.service.cmr.repository.StoreRef;
 import org.alfresco.service.namespace.NamespaceService;
 import org.alfresco.service.namespace.QName;
 import org.alfresco.util.GUID;
+import org.alfresco.util.collections.CollectionUtils;
 import org.junit.Before;
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
@@ -45,6 +47,7 @@ public class BaseUnitTest implements RecordsManagementModel
     @Mock(name="nodeService")       protected NodeService mockedNodeService; 
     @Mock(name="dictionaryService") protected DictionaryService mockedDictionaryService;
     @Mock(name="namespaceService")  protected NamespaceService mockedNamespaceService; 
+    @Mock(name="identifierService") protected IdentifierService mockedIdentifierService;
     
     @Before
     public void before()
@@ -57,6 +60,7 @@ public class BaseUnitTest implements RecordsManagementModel
         
         // set-up namespace service
         when(mockedNamespaceService.getNamespaceURI(RM_PREFIX)).thenReturn(RM_URI);
+        when(mockedNamespaceService.getPrefixes(RM_URI)).thenReturn(CollectionUtils.unmodifiableSet(RM_PREFIX));
         
     }
     

rm-server/unit-test/java/org/alfresco/module/org_alfresco_module_rm/forms/RecordsManagementTypeFormFilterUnitTest.java

@@ -0,0 +1,176 @@
+/*
+ * Copyright (C) 2005-2014 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.module.org_alfresco_module_rm.forms;
+
+import static org.mockito.Matchers.any;
+import static org.mockito.Matchers.anyListOf;
+import static org.mockito.Matchers.anyString;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyZeroInteractions;
+import static org.mockito.Mockito.when;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.alfresco.module.org_alfresco_module_rm.BaseUnitTest;
+import org.alfresco.module.org_alfresco_module_rm.admin.RecordsManagementAdminService;
+import org.alfresco.repo.forms.Field;
+import org.alfresco.repo.forms.FieldDefinition;
+import org.alfresco.repo.forms.Form;
+import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
+import org.alfresco.service.cmr.dictionary.PropertyDefinition;
+import org.alfresco.service.cmr.dictionary.TypeDefinition;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.namespace.QName;
+import org.junit.Test;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.Spy;
+
+/**
+ * RecordsManagementTypeFormFilter Unit Test
+ * 
+ * @author Roy Wetherall
+ * @since 2.2
+ */
+public class RecordsManagementTypeFormFilterUnitTest extends BaseUnitTest
+{
+    private static final QName MY_CUSTOM_TYPE = generateQName();
+    
+    @Mock private Form mockForm;
+    @Mock private TypeDefinition mockTypeDefinition;
+    @Mock(name="recordsManagementAdminService") private RecordsManagementAdminService mockRecordsManagementAdminService;
+    
+    @Spy @InjectMocks RecordsManagementTypeFormFilter typeFormFilter;
+
+    /**
+     * Test addCustomRMProperties - no custom properties found
+     */
+    @Test
+    public void testAddCustomRMPropertiesNoneFound()
+    {        
+        typeFormFilter.addCustomRMProperties(MY_CUSTOM_TYPE, mockForm);
+        verifyZeroInteractions(mockForm);        
+    }
+    
+    /**
+     * Test that non-customisable types are being treated correctly
+     */
+    @Test
+    public void testAfterGenerateNotCustomisable()
+    {
+        when(mockTypeDefinition.getName()).thenReturn(MY_CUSTOM_TYPE);
+        when(mockRecordsManagementAdminService.isCustomisable(MY_CUSTOM_TYPE)).thenReturn(false);
+        
+        typeFormFilter.afterGenerate(mockTypeDefinition, null, null, mockForm, null);
+        
+        verify(typeFormFilter, never()).addCustomRMProperties(any(QName.class), any(Form.class));
+    }
+    
+    /**
+     * Test that customisable types are being treated correctly
+     */
+    @Test
+    public void testAfterGenerateCustomisable()
+    {
+        when(mockTypeDefinition.getName()).thenReturn(MY_CUSTOM_TYPE);
+        when(mockRecordsManagementAdminService.isCustomisable(MY_CUSTOM_TYPE)).thenReturn(true);
+        
+        typeFormFilter.afterGenerate(mockTypeDefinition, null, null, mockForm, null);
+        
+        verify(typeFormFilter, times(1)).addCustomRMProperties(any(QName.class), any(Form.class));
+    }
+    
+    /**
+     * Test the default values for certain properties are being set correctly
+     */
+    @Test
+    public void testDefaultFormValues()
+    {
+        List<FieldDefinition> defs = new ArrayList<FieldDefinition>(3); 
+        FieldDefinition idDef = mockFieldDefinition("rma:identifier");
+        defs.add(idDef);
+        FieldDefinition vrDef = mockFieldDefinition("rma:vitalRecordIndicator");
+        defs.add(vrDef);
+        FieldDefinition rpDef = mockFieldDefinition("rma:reviewPeriod");
+        defs.add(rpDef);
+        
+        when(mockForm.getFieldDefinitions()).thenReturn(defs);
+        
+        typeFormFilter.afterGenerate(mockTypeDefinition, null, null, mockForm, null);
+        
+        verify(mockedIdentifierService).generateIdentifier(any(QName.class), any(NodeRef.class));
+        verify(idDef).setDefaultValue(anyString());
+        verify(vrDef).setDefaultValue(Boolean.FALSE.toString());
+        verify(rpDef).setDefaultValue("none|0");
+    }
+    
+    /**
+     * Helper to mock field definition
+     */
+    private FieldDefinition mockFieldDefinition(String name)
+    {
+        FieldDefinition def = mock(FieldDefinition.class);
+        when(def.getName()).thenReturn(name);
+        return def;
+    }
+        
+    /**
+     * Test addCustomRMProperties - two custom properties found
+     */
+    @Test
+    public void testAddCustomRMProperties()
+    {        
+        // map of custom properties
+        Map<QName, PropertyDefinition> properties = mockPropertyDefintionMap(2);
+        
+        // setup rm admin service to return properties for my custom type
+        when(mockRecordsManagementAdminService.getCustomPropertyDefinitions(MY_CUSTOM_TYPE)).thenReturn(properties);
+        
+        // call method
+        typeFormFilter.addCustomRMProperties(MY_CUSTOM_TYPE, mockForm);
+        
+        // ensure that two custom properties have been added to the form
+        verify(mockForm, times(1)).addFields(anyListOf(Field.class));       
+    }
+    
+    /**
+     * Helper method to createa a mock property definition map
+     */
+    private Map<QName, PropertyDefinition> mockPropertyDefintionMap(int size)
+    {
+        Map<QName, PropertyDefinition> properties = new HashMap<QName, PropertyDefinition>(size);
+        for (int i = 0; i < size; i++)
+        {
+            QName name = generateQName();
+            PropertyDefinition propDef = mock(PropertyDefinition.class);
+            when(propDef.getName()).thenReturn(name);
+            DataTypeDefinition mockDataTypeDefinition = mock(DataTypeDefinition.class);
+            when(mockDataTypeDefinition.getName()).thenReturn(DataTypeDefinition.TEXT);
+            when(propDef.getDataType()).thenReturn(mockDataTypeDefinition);
+            properties.put(name, propDef);
+        }        
+        return properties;        
+    }
+}