3 files changed, 83 insertions, 61 deletions

diff --git a/OpenSim/Tests/Common/Helpers/EntityTransferHelpers.cs b/OpenSim/Tests/Common/Helpers/EntityTransferHelpers.cs
index 6cc7ff2..52a17e7 100644
--- a/OpenSim/Tests/Common/Helpers/EntityTransferHelpers.cs
+++ b/OpenSim/Tests/Common/Helpers/EntityTransferHelpers.cs
@@ -31,6 +31,7 @@ using System.IO;
 using System.Net;
 using System.Reflection;
 using System.Text;
+using System.Threading;
 using log4net;
 using Nini.Config;
 using NUnit.Framework;
@@ -59,7 +60,8 @@ namespace OpenSim.Tests.Common
         /// 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)
+        public static void SetupInformClientOfNeighbourTriggersNeighbourClientCreate(
+            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).
@@ -75,16 +77,51 @@ namespace OpenSim.Tests.Common
                     "[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);
+                TestClient neighbourTc = new TestClient(newAgent, neighbourScene);
                 neighbourTcs.Add(neighbourTc);
-                neighbourScene.AddNewClient(neighbourTc, PresenceType.User);
+                neighbourScene.AddNewAgent(neighbourTc, PresenceType.User);
+            };
+        }
+
+        /// <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 SetupSendRegionTeleportTriggersDestinationClientCreateAndCompleteMovement(
+            TestClient client, List<TestClient> destinationClients)
+        {
+            client.OnTestClientSendRegionTeleport 
+                += (regionHandle, simAccess, regionExternalEndPoint, locationID, flags, capsURL) =>
+            {
+                uint x, y;
+                Utils.LongToUInts(regionHandle, out x, out y);
+                x /= Constants.RegionSize;
+                y /= Constants.RegionSize;
+
+                m_log.DebugFormat(
+                    "[TEST CLIENT]: Processing send region teleport for destination at {0},{1} at {2}", 
+                    x, y, regionExternalEndPoint);
+
+                AgentCircuitData newAgent = client.RequestClientInfo();
+
+                Scene destinationScene;
+                SceneManager.Instance.TryGetScene(x, y, out destinationScene);
+
+                TestClient destinationClient = new TestClient(newAgent, destinationScene);
+                destinationClients.Add(destinationClient);
+                destinationScene.AddNewAgent(destinationClient, PresenceType.User);
+
+                ThreadPool.UnsafeQueueUserWorkItem(o => destinationClient.CompleteMovement(), null);
             };
         }
     }
diff --git a/OpenSim/Tests/Common/Helpers/SceneHelpers.cs b/OpenSim/Tests/Common/Helpers/SceneHelpers.cs
index bdd9093..4cdfe98 100644
--- a/OpenSim/Tests/Common/Helpers/SceneHelpers.cs
+++ b/OpenSim/Tests/Common/Helpers/SceneHelpers.cs
@@ -447,9 +447,6 @@ namespace OpenSim.Tests.Common
         /// Add a root agent where the details of the agent connection (apart from the id) are unimportant for the test
         /// </summary>
         /// <remarks>
-        /// This can be used for tests where there is only one region or where there are multiple non-neighbour regions
-        /// and teleport doesn't take place.
-        ///
         /// XXX: Use the version of this method that takes the UserAccount structure wherever possible - this will
         /// make the agent circuit data (e.g. first, lastname) consistent with the user account data.
         /// </remarks>
@@ -462,22 +459,6 @@ namespace OpenSim.Tests.Common
         }
 
         /// <summary>
-        /// Add a root agent where the details of the agent connection (apart from the id) are unimportant for the test
-        /// </summary>
-        /// <remarks>
-        /// XXX: Use the version of this method that takes the UserAccount structure wherever possible - this will
-        /// make the agent circuit data (e.g. first, lastname) consistent with the user account data.
-        /// </remarks>
-        /// <param name="scene"></param>
-        /// <param name="agentId"></param>
-        /// <param name="sceneManager"></param>
-        /// <returns></returns>
-        public static ScenePresence AddScenePresence(Scene scene, UUID agentId, SceneManager sceneManager)
-        {
-            return AddScenePresence(scene, GenerateAgentData(agentId), sceneManager);
-        }
-
-        /// <summary>
         /// Add a root agent.
         /// </summary>
         /// <param name="scene"></param>
@@ -508,31 +489,7 @@ namespace OpenSim.Tests.Common
         /// <returns></returns>
         public static ScenePresence AddScenePresence(Scene scene, AgentCircuitData agentData)
         {
-            return AddScenePresence(scene, agentData, null);
-        }
-
-        /// <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, AgentCircuitData agentData, SceneManager sceneManager)
-        {
-            return AddScenePresence(scene, new TestClient(agentData, scene, sceneManager), agentData, sceneManager);
+            return AddScenePresence(scene, new TestClient(agentData, scene), agentData);
         }
 
         /// <summary>
@@ -552,10 +509,9 @@ namespace OpenSim.Tests.Common
         /// </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)
+            Scene scene, IClientAPI client, AgentCircuitData agentData)
         {
             // We emulate the proper login sequence here by doing things in four stages
 
@@ -578,10 +534,6 @@ namespace OpenSim.Tests.Common
         /// Introduce an agent into the scene by adding a new client.
         /// </summary>
         /// <returns>The scene presence added</returns>
-        /// <param name='sceneManager'>
-        /// Scene manager.  Can be null if there is only one region in the test or multiple regions that are not
-        /// neighbours and where no teleporting takes place.
-        /// </param>
         /// <param name='scene'></param>
         /// <param name='testClient'></param>
         /// <param name='agentData'></param>
@@ -596,7 +548,7 @@ namespace OpenSim.Tests.Common
                 Console.WriteLine("NewUserConnection failed: " + reason);
 
             // Stage 2: add the new client as a child agent to the scene
-            scene.AddNewClient(client, PresenceType.User);
+            scene.AddNewAgent(client, PresenceType.User);
 
             return scene.GetScenePresence(client.AgentId);
         }
@@ -607,7 +559,7 @@ namespace OpenSim.Tests.Common
             acd.child = true;
 
             // XXX: ViaLogin may not be correct for child agents
-            TestClient client = new TestClient(acd, scene, null);
+            TestClient client = new TestClient(acd, scene);
             return IntroduceClientToScene(scene, client, acd, TeleportFlags.ViaLogin);
         }
 
diff --git a/OpenSim/Tests/Common/Helpers/UserInventoryHelpers.cs b/OpenSim/Tests/Common/Helpers/UserInventoryHelpers.cs
index a1794c9..b3b75af 100644
--- a/OpenSim/Tests/Common/Helpers/UserInventoryHelpers.cs
+++ b/OpenSim/Tests/Common/Helpers/UserInventoryHelpers.cs
@@ -218,12 +218,37 @@ namespace OpenSim.Tests.Common
         public static InventoryFolderBase CreateInventoryFolder(
             IInventoryService inventoryService, UUID userId, string path, bool useExistingFolders)
         {
+            return CreateInventoryFolder(inventoryService, userId, UUID.Random(), path, useExistingFolders);
+        }
+
+        /// <summary>
+        /// Create inventory folders starting from the user's root folder.
+        /// </summary>
+        /// <param name="inventoryService"></param>
+        /// <param name="userId"></param>
+        /// <param name="folderId"></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, UUID folderId, string path, bool useExistingFolders)
+        {
             InventoryFolderBase rootFolder = inventoryService.GetRootFolder(userId);
 
             if (null == rootFolder)
                 return null;
 
-            return CreateInventoryFolder(inventoryService, rootFolder, path, useExistingFolders);
+            return CreateInventoryFolder(inventoryService, folderId, rootFolder, path, useExistingFolders);
         }
 
         /// <summary>
@@ -235,6 +260,7 @@ namespace OpenSim.Tests.Common
         /// TODO: May need to make it an option to create duplicate folders.
         /// </remarks>
         /// <param name="inventoryService"></param>
+        /// <param name="folderId">ID of the folder to create</param>
         /// <param name="parentFolder"></param>
         /// <param name="path">
         /// The folder to create.
@@ -249,7 +275,7 @@ namespace OpenSim.Tests.Common
         /// 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, bool useExistingFolders)
+            IInventoryService inventoryService, UUID folderId, InventoryFolderBase parentFolder, string path, bool useExistingFolders)
         {
             string[] components = path.Split(new string[] { PATH_DELIMITER }, 2, StringSplitOptions.None);
 
@@ -262,9 +288,16 @@ namespace OpenSim.Tests.Common
             {
 //                Console.WriteLine("Creating folder {0} at {1}", components[0], parentFolder.Name);
 
+                UUID folderIdForCreate;
+
+                if (components.Length > 1)
+                    folderIdForCreate = UUID.Random();
+                else
+                    folderIdForCreate = folderId;
+
                 folder 
                     = new InventoryFolderBase(
-                        UUID.Random(), components[0], parentFolder.Owner, (short)AssetType.Unknown, parentFolder.ID, 0);
+                        folderIdForCreate, components[0], parentFolder.Owner, (short)AssetType.Unknown, parentFolder.ID, 0);
                 
                 inventoryService.AddFolder(folder);
             }
@@ -274,7 +307,7 @@ namespace OpenSim.Tests.Common
 //            }
 
             if (components.Length > 1)
-                return CreateInventoryFolder(inventoryService, folder, components[1], useExistingFolders);
+                return CreateInventoryFolder(inventoryService, folderId, folder, components[1], useExistingFolders);
             else
                 return folder;
         }