4 files changed, 238 insertions, 33 deletions

diff --git a/OpenSim/Tests/Common/Helpers/EntityTransferHelpers.cs b/OpenSim/Tests/Common/Helpers/EntityTransferHelpers.cs
new file mode 100644
index 0000000..6cc7ff2
--- /dev/null
+++ b/OpenSim/Tests/Common/Helpers/EntityTransferHelpers.cs
@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) Contributors, http://opensimulator.org/
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the OpenSimulator Project nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Net;
+using System.Reflection;
+using System.Text;
+using log4net;
+using Nini.Config;
+using NUnit.Framework;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Framework.Communications;
+using OpenSim.Framework.Servers;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.CoreModules.Framework;
+using OpenSim.Tests.Common;
+using OpenSim.Tests.Common.Mock;
+
+namespace OpenSim.Tests.Common
+{
+    public static class EntityTransferHelpers
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+        /// <summary>
+        /// Set up correct handling of the InformClientOfNeighbour call from the source region that triggers the
+        /// viewer to setup a connection with the destination region.
+        /// </summary>
+        /// <param name='tc'></param>
+        /// <param name='neighbourTcs'>
+        /// A list that will be populated with any TestClients set up in response to 
+        /// being informed about a destination region.
+        /// </param>
+        public static void SetUpInformClientOfNeighbour(TestClient tc, List<TestClient> neighbourTcs)
+        {
+            // XXX: Confusingly, this is also used for non-neighbour notification (as in teleports that do not use the
+            // event queue).
+
+            tc.OnTestClientInformClientOfNeighbour += (neighbourHandle, neighbourExternalEndPoint) =>
+            {
+                uint x, y;
+                Utils.LongToUInts(neighbourHandle, out x, out y);
+                x /= Constants.RegionSize;
+                y /= Constants.RegionSize;
+
+                m_log.DebugFormat(
+                    "[TEST CLIENT]: Processing inform client of neighbour located at {0},{1} at {2}", 
+                    x, y, neighbourExternalEndPoint);
+
+                // In response to this message, we are going to make a teleport to the scene we've previous been told
+                // about by test code (this needs to be improved).
+                AgentCircuitData newAgent = tc.RequestClientInfo();
+
+                Scene neighbourScene;
+                SceneManager.Instance.TryGetScene(x, y, out neighbourScene);
+
+                TestClient neighbourTc = new TestClient(newAgent, neighbourScene, SceneManager.Instance);
+                neighbourTcs.Add(neighbourTc);
+                neighbourScene.AddNewClient(neighbourTc, PresenceType.User);
+            };
+        }
+    }
+}
\ No newline at end of file
diff --git a/OpenSim/Tests/Common/Helpers/SceneHelpers.cs b/OpenSim/Tests/Common/Helpers/SceneHelpers.cs
index ea3e348..bdd9093 100644
--- a/OpenSim/Tests/Common/Helpers/SceneHelpers.cs
+++ b/OpenSim/Tests/Common/Helpers/SceneHelpers.cs
@@ -139,7 +139,7 @@ namespace OpenSim.Tests.Common
             SceneCommunicationService scs = new SceneCommunicationService();
 
             TestScene testScene = new TestScene(
-                regInfo, m_acm, scs, m_simDataService, m_estateDataService, false, configSource, null);
+                regInfo, m_acm, scs, m_simDataService, m_estateDataService, configSource, null);
 
             INonSharedRegionModule godsModule = new GodsModule();
             godsModule.Initialise(new IniConfigSource());
@@ -532,6 +532,31 @@ namespace OpenSim.Tests.Common
         /// <returns></returns>
         public static ScenePresence AddScenePresence(Scene scene, AgentCircuitData agentData, SceneManager sceneManager)
         {
+            return AddScenePresence(scene, new TestClient(agentData, scene, sceneManager), agentData, sceneManager);
+        }
+
+        /// <summary>
+        /// Add a root agent.
+        /// </summary>
+        /// <remarks>
+        /// This function
+        ///
+        /// 1)  Tells the scene that an agent is coming.  Normally, the login service (local if standalone, from the
+        /// userserver if grid) would give initial login data back to the client and separately tell the scene that the
+        /// agent was coming.
+        ///
+        /// 2)  Connects the agent with the scene
+        ///
+        /// This function performs actions equivalent with notifying the scene that an agent is
+        /// coming and then actually connecting the agent to the scene.  The one step missed out is the very first
+        /// </remarks>
+        /// <param name="scene"></param>
+        /// <param name="agentData"></param>
+        /// <param name="sceneManager"></param>
+        /// <returns></returns>
+        public static ScenePresence AddScenePresence(
+            Scene scene, IClientAPI client, AgentCircuitData agentData, SceneManager sceneManager)
+        {
             // We emulate the proper login sequence here by doing things in four stages
 
             // Stage 0: login
@@ -541,7 +566,7 @@ namespace OpenSim.Tests.Common
             lpsc.m_PresenceService.LoginAgent(agentData.AgentID.ToString(), agentData.SessionID, agentData.SecureSessionID);
 
             // Stages 1 & 2
-            ScenePresence sp = IntroduceClientToScene(scene, sceneManager, agentData, TeleportFlags.ViaLogin);
+            ScenePresence sp = IntroduceClientToScene(scene, client, agentData, TeleportFlags.ViaLogin);
 
             // Stage 3: Complete the entrance into the region.  This converts the child agent into a root agent.
             sp.CompleteMovement(sp.ControllingClient, true);
@@ -558,11 +583,11 @@ namespace OpenSim.Tests.Common
         /// neighbours and where no teleporting takes place.
         /// </param>
         /// <param name='scene'></param>
-        /// <param name='sceneManager></param>
+        /// <param name='testClient'></param>
         /// <param name='agentData'></param>
         /// <param name='tf'></param>
         private static ScenePresence IntroduceClientToScene(
-            Scene scene, SceneManager sceneManager, AgentCircuitData agentData, TeleportFlags tf)
+            Scene scene, IClientAPI client, AgentCircuitData agentData, TeleportFlags tf)
         {
             string reason;
 
@@ -571,10 +596,9 @@ namespace OpenSim.Tests.Common
                 Console.WriteLine("NewUserConnection failed: " + reason);
 
             // Stage 2: add the new client as a child agent to the scene
-            TestClient client = new TestClient(agentData, scene, sceneManager);
             scene.AddNewClient(client, PresenceType.User);
 
-            return scene.GetScenePresence(agentData.AgentID);
+            return scene.GetScenePresence(client.AgentId);
         }
 
         public static ScenePresence AddChildScenePresence(Scene scene, UUID agentId)
@@ -583,7 +607,8 @@ namespace OpenSim.Tests.Common
             acd.child = true;
 
             // XXX: ViaLogin may not be correct for child agents
-            return IntroduceClientToScene(scene, null, acd, TeleportFlags.ViaLogin);
+            TestClient client = new TestClient(acd, scene, null);
+            return IntroduceClientToScene(scene, client, acd, TeleportFlags.ViaLogin);
         }
 
         /// <summary>
diff --git a/OpenSim/Tests/Common/Helpers/TaskInventoryHelpers.cs b/OpenSim/Tests/Common/Helpers/TaskInventoryHelpers.cs
index 0a2b30a..bb4b55f 100644
--- a/OpenSim/Tests/Common/Helpers/TaskInventoryHelpers.cs
+++ b/OpenSim/Tests/Common/Helpers/TaskInventoryHelpers.cs
@@ -46,13 +46,32 @@ namespace OpenSim.Tests.Common
         /// <param name="scene"></param>
         /// <param name="part"></param>
         /// <param name="itemName"></param>
+        /// <param name="itemIDFrag">UUID or UUID stem</param>
+        /// <param name="assetIDFrag">UUID or UUID stem</param>
+        /// <param name="text">The tex to put in the notecard.</param>
+        /// <returns>The item that was added</returns>
+        public static TaskInventoryItem AddNotecard(
+            Scene scene, SceneObjectPart part, string itemName, string itemIDStem, string assetIDStem, string text)
+        {
+            return AddNotecard(
+                scene, part, itemName, TestHelpers.ParseStem(itemIDStem), TestHelpers.ParseStem(assetIDStem), text);
+        }
+
+        /// <summary>
+        /// Add a notecard item to the given part.
+        /// </summary>
+        /// <param name="scene"></param>
+        /// <param name="part"></param>
+        /// <param name="itemName"></param>
         /// <param name="itemID"></param>
         /// <param name="assetID"></param>
+        /// <param name="text">The tex to put in the notecard.</param>
         /// <returns>The item that was added</returns>
-        public static TaskInventoryItem AddNotecard(Scene scene, SceneObjectPart part, string itemName, UUID itemID, UUID assetID)
+        public static TaskInventoryItem AddNotecard(
+            Scene scene, SceneObjectPart part, string itemName, UUID itemID, UUID assetID, string text)
         {
             AssetNotecard nc = new AssetNotecard();
-            nc.BodyText = "Hello World!";
+            nc.BodyText = text;
             nc.Encode();
 
             AssetBase ncAsset
@@ -87,8 +106,8 @@ namespace OpenSim.Tests.Common
         /// Add a simple script to the given part.
         /// </summary>
         /// <remarks>
-        /// TODO: Accept input for item and asset IDs to avoid mysterious script failures that try to use any of these
-        /// functions more than once in a test.
+        /// TODO: Accept input for item and asset IDs so that we have completely replicatable regression tests rather
+        /// than a random component.
         /// </remarks>
         /// <param name="scene"></param>
         /// <param name="part"></param>
@@ -102,8 +121,9 @@ namespace OpenSim.Tests.Common
             ast.Source = scriptSource;
             ast.Encode();
 
-            UUID assetUuid = new UUID("00000000-0000-0000-1000-000000000000");
-            UUID itemUuid = new UUID("00000000-0000-0000-1100-000000000000");
+            UUID assetUuid = UUID.Random();
+            UUID itemUuid = UUID.Random();
+
             AssetBase asset
                 = AssetHelpers.CreateAsset(assetUuid, AssetType.LSLText, ast.AssetData, UUID.Zero);
             scene.AssetService.Store(asset);
diff --git a/OpenSim/Tests/Common/Helpers/UserInventoryHelpers.cs b/OpenSim/Tests/Common/Helpers/UserInventoryHelpers.cs
index 87d9410..a1794c9 100644
--- a/OpenSim/Tests/Common/Helpers/UserInventoryHelpers.cs
+++ b/OpenSim/Tests/Common/Helpers/UserInventoryHelpers.cs
@@ -45,6 +45,9 @@ namespace OpenSim.Tests.Common
         /// <summary>
         /// Add an existing scene object as an item in the user's inventory.
         /// </summary>
+        /// <remarks>
+        /// Will be added to the system Objects folder.
+        /// </remarks>
         /// <param name='scene'></param>
         /// <param name='so'></param>
         /// <param name='inventoryIdTail'></param>
@@ -63,7 +66,29 @@ namespace OpenSim.Tests.Common
         }
 
         /// <summary>
-        /// Creates a notecard in the objects folder and specify an item id.
+        /// Add an existing scene object as an item in the user's inventory at the given path.
+        /// </summary>
+        /// <param name='scene'></param>
+        /// <param name='so'></param>
+        /// <param name='inventoryIdTail'></param>
+        /// <param name='assetIdTail'></param>
+        /// <returns>The inventory item created.</returns>
+        public static InventoryItemBase AddInventoryItem(
+            Scene scene, SceneObjectGroup so, int inventoryIdTail, int assetIdTail, string path)
+        {
+            return AddInventoryItem(
+                scene,
+                so.Name,
+                TestHelpers.ParseTail(inventoryIdTail),
+                InventoryType.Object,
+                AssetHelpers.CreateAsset(TestHelpers.ParseTail(assetIdTail), so),
+                so.OwnerID,
+                path);
+        }
+
+        /// <summary>
+        /// Adds the given item to the existing system folder for its type (e.g. an object will go in the "Objects"
+        /// folder).
         /// </summary>
         /// <param name="scene"></param>
         /// <param name="itemName"></param>
@@ -75,6 +100,25 @@ namespace OpenSim.Tests.Common
         private static InventoryItemBase AddInventoryItem(
             Scene scene, string itemName, UUID itemId, InventoryType itemType, AssetBase asset, UUID userId)
         {
+            return AddInventoryItem(
+                scene, itemName, itemId, itemType, asset, userId, 
+                scene.InventoryService.GetFolderForType(userId, (AssetType)asset.Type).Name);
+        }
+
+        /// <summary>
+        /// Adds the given item to an inventory folder
+        /// </summary>
+        /// <param name="scene"></param>
+        /// <param name="itemName"></param>
+        /// <param name="itemId"></param>
+        /// <param name="itemType"></param>
+        /// <param name="asset">The serialized asset for this item</param>
+        /// <param name="userId"></param>
+        /// <param name="path">Existing inventory path at which to add.</param>
+        /// <returns></returns>
+        private static InventoryItemBase AddInventoryItem(
+            Scene scene, string itemName, UUID itemId, InventoryType itemType, AssetBase asset, UUID userId, string path)
+        {
             scene.AssetService.Store(asset);
 
             InventoryItemBase item = new InventoryItemBase();
@@ -85,7 +129,7 @@ namespace OpenSim.Tests.Common
             item.AssetType = asset.Type;
             item.InvType = (int)itemType;
 
-            InventoryFolderBase folder = scene.InventoryService.GetFolderForType(userId, (AssetType)asset.Type);
+            InventoryFolderBase folder = InventoryArchiveUtils.FindFoldersByPath(scene.InventoryService, userId, path)[0];
 
             item.Folder = folder.ID;
             scene.AddInventoryItem(item);
@@ -156,58 +200,83 @@ namespace OpenSim.Tests.Common
         /// <summary>
         /// Create inventory folders starting from the user's root folder.
         /// </summary>
-        ///
-        /// Ignores any existing folders with the same name
-        /// 
         /// <param name="inventoryService"></param>
         /// <param name="userId"></param>
         /// <param name="path">
         /// The folders to create.  Multiple folders can be specified on a path delimited by the PATH_DELIMITER
         /// </param>
+        /// <param name="useExistingFolders">
+        /// If true, then folders in the path which already the same name are
+        /// used.  This applies to the terminal folder as well.  
+        /// If false, then all folders in the path are created, even if there is already a folder at a particular
+        /// level with the same name.
+        /// </param>
         /// <returns>
         /// The folder created.  If the path contains multiple folders then the last one created is returned.
         /// Will return null if the root folder could not be found.
         /// </returns>
         public static InventoryFolderBase CreateInventoryFolder(
-            IInventoryService inventoryService, UUID userId, string path)
+            IInventoryService inventoryService, UUID userId, string path, bool useExistingFolders)
         {
             InventoryFolderBase rootFolder = inventoryService.GetRootFolder(userId);
 
             if (null == rootFolder)
                 return null;
 
-            return CreateInventoryFolder(inventoryService, rootFolder, path);
+            return CreateInventoryFolder(inventoryService, rootFolder, path, useExistingFolders);
         }
 
         /// <summary>
         /// Create inventory folders starting from a given parent folder
         /// </summary>
-        ///
-        /// Ignores any existing folders with the same name
-        /// 
+        /// <remarks>
+        /// If any stem of the path names folders that already exist then these are not recreated.  This includes the 
+        /// final folder.
+        /// TODO: May need to make it an option to create duplicate folders.
+        /// </remarks>
         /// <param name="inventoryService"></param>
         /// <param name="parentFolder"></param>
         /// <param name="path">
-        /// The folders to create.  Multiple folders can be specified on a path delimited by the PATH_DELIMITER
+        /// The folder to create.
+        /// </param>
+        /// <param name="useExistingFolders">
+        /// If true, then folders in the path which already the same name are
+        /// used.  This applies to the terminal folder as well.  
+        /// If false, then all folders in the path are created, even if there is already a folder at a particular
+        /// level with the same name.
         /// </param>
         /// <returns>
         /// The folder created.  If the path contains multiple folders then the last one created is returned.
         /// </returns>
         public static InventoryFolderBase CreateInventoryFolder(
-            IInventoryService inventoryService, InventoryFolderBase parentFolder, string path)
+            IInventoryService inventoryService, InventoryFolderBase parentFolder, string path, bool useExistingFolders)
         {
             string[] components = path.Split(new string[] { PATH_DELIMITER }, 2, StringSplitOptions.None);
 
-            InventoryFolderBase newFolder 
-                = new InventoryFolderBase(
-                    UUID.Random(), components[0], parentFolder.Owner, (short)AssetType.Unknown, parentFolder.ID, 0);
-            
-            inventoryService.AddFolder(newFolder);
+            InventoryFolderBase folder = null;
+
+            if (useExistingFolders)
+                folder = InventoryArchiveUtils.FindFolderByPath(inventoryService, parentFolder, components[0]);
+
+            if (folder == null)
+            {
+//                Console.WriteLine("Creating folder {0} at {1}", components[0], parentFolder.Name);
+
+                folder 
+                    = new InventoryFolderBase(
+                        UUID.Random(), components[0], parentFolder.Owner, (short)AssetType.Unknown, parentFolder.ID, 0);
+                
+                inventoryService.AddFolder(folder);
+            }
+//            else
+//            {
+//                Console.WriteLine("Found existing folder {0}", folder.Name);
+//            }
 
             if (components.Length > 1)
-                return CreateInventoryFolder(inventoryService, newFolder, components[1]);
+                return CreateInventoryFolder(inventoryService, folder, components[1], useExistingFolders);
             else
-                return newFolder;
+                return folder;
         }
 
         /// <summary>
@@ -237,7 +306,7 @@ namespace OpenSim.Tests.Common
         /// <returns>An empty list if no matching folders were found</returns>
         public static List<InventoryFolderBase> GetInventoryFolders(IInventoryService inventoryService, UUID userId, string path)
         {
-            return InventoryArchiveUtils.FindFolderByPath(inventoryService, userId, path);
+            return InventoryArchiveUtils.FindFoldersByPath(inventoryService, userId, path);
         }
 
         /// <summary>