From 7d8d6122fcebe407c9a8e63b145422737e80919d Mon Sep 17 00:00:00 2001
From: Raluca Munteanu <raluca.munteanu@ness.com>
Date: Wed, 20 Apr 2016 12:25:07 +0000
Subject: [PATCH] Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)    125546 mrogers:
 Integration test javadoc

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/services/full-installer/branches/5.1.N@125615 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
---
 .../test/java/EndToEndIntegrationTest.java    | 24 ++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/enterprise-update-test/src/test/java/EndToEndIntegrationTest.java b/enterprise-update-test/src/test/java/EndToEndIntegrationTest.java
index 53fec9617c..259be63951 100644
--- a/enterprise-update-test/src/test/java/EndToEndIntegrationTest.java
+++ b/enterprise-update-test/src/test/java/EndToEndIntegrationTest.java
@@ -92,7 +92,29 @@ public class EndToEndIntegrationTest
         initTargetDir();    
     }
     
-    
+    /**
+     * Compare an instance of alfresco that has been installed and 
+     * then updated via the update package for the current build with a freshly 
+     * installed instance of the current build.  Some differences such as files containing 
+     * the installation path are allowed.  Other differences will be detected by the test.
+     * <p>
+     * The maven build installs two instances of alfresco, an instance that is
+     * to be updated <i>update</i>, ${base.alfresco.instance}
+     * and a <i>reference</i> instance, ${this.alfresco.instance} which is the 
+     * current build.
+     * <p>
+     * The output of the test is a boolean pass/fail but as a side-effect a report 
+     * of the test is also produced, <i>installation-diff-report.html</i> and 
+     * <i>installation-diff-report.zip</i>.   The zip file should be empty in a 
+     * successful execution. If there are unexpected differences then these will 
+     * be added to the zip file. 
+     * <p>
+     * The patterns of files to [test | ignore | allow special processing] are currently 
+     * contained within the FileTreeCompareImpl.java class as are the patterns allowed 
+     * during special processing.
+     * 
+     * @see FileTreeCompareImpl
+     */
     @Test
     public void testEndToEndUpdate() throws Exception
     {