Add TestSameSimulatorNeighbouringRegionsV2() regression test for v2 entity transfer protocl

OpenSim/Region/Framework/Scenes/Tests/ScenePresenceTeleportTests.cs

@@ -30,6 +30,7 @@ using System.Collections.Generic;
 using System.IO;
 using System.Net;
 using System.Text;
+using System.Threading;
 using Nini.Config;
 using NUnit.Framework;
 using OpenMetaverse;
@@ -107,7 +108,7 @@ namespace OpenSim.Region.Framework.Scenes.Tests
         }
 
         [Test]
-        public void TestSameSimulatorIsolatedRegions()
+        public void TestSameSimulatorIsolatedRegionsV1()
         {
             TestHelpers.InMethod();
 //            TestHelpers.EnableLogging();
@@ -428,7 +429,7 @@ namespace OpenSim.Region.Framework.Scenes.Tests
         }
 
         [Test]
-        public void TestSameSimulatorNeighbouringRegions()
+        public void TestSameSimulatorNeighbouringRegionsV1()
         {
             TestHelpers.InMethod();
 //            TestHelpers.EnableLogging();
@@ -510,6 +511,90 @@ namespace OpenSim.Region.Framework.Scenes.Tests
             // position instead).
 //            Assert.That(sp.Lookat, Is.EqualTo(teleportLookAt));
 
+//            TestHelpers.DisableLogging();
+        }
+
+        [Test]
+        public void TestSameSimulatorNeighbouringRegionsV2()
+        {
+            TestHelpers.InMethod();
+//            TestHelpers.EnableLogging();
+
+            UUID userId = TestHelpers.ParseTail(0x1);
+
+            EntityTransferModule etmA = new EntityTransferModule();
+            EntityTransferModule etmB = new EntityTransferModule();
+            LocalSimulationConnectorModule lscm = new LocalSimulationConnectorModule();
+
+            IConfigSource config = new IniConfigSource();
+            IConfig modulesConfig = config.AddConfig("Modules");
+            modulesConfig.Set("EntityTransferModule", etmA.Name);
+            modulesConfig.Set("SimulationServices", lscm.Name);
+
+            SceneHelpers sh = new SceneHelpers();
+            TestScene sceneA = sh.SetupScene("sceneA", TestHelpers.ParseTail(0x100), 1000, 1000);
+            TestScene sceneB = sh.SetupScene("sceneB", TestHelpers.ParseTail(0x200), 1001, 1000);
+
+            SceneHelpers.SetupSceneModules(new Scene[] { sceneA, sceneB }, config, lscm);
+            SceneHelpers.SetupSceneModules(sceneA, config, new CapabilitiesModule(), etmA);
+            SceneHelpers.SetupSceneModules(sceneB, config, new CapabilitiesModule(), etmB);
+
+            Vector3 teleportPosition = new Vector3(10, 11, 12);
+            Vector3 teleportLookAt = new Vector3(20, 21, 22);
+
+            AgentCircuitData acd = SceneHelpers.GenerateAgentData(userId);
+            TestClient tc = new TestClient(acd, sceneA);
+            List<TestClient> destinationTestClients = new List<TestClient>();
+            EntityTransferHelpers.SetUpInformClientOfNeighbour(tc, destinationTestClients);
+
+            ScenePresence beforeSceneASp = SceneHelpers.AddScenePresence(sceneA, tc, acd);
+            beforeSceneASp.AbsolutePosition = new Vector3(30, 31, 32);
+
+            Assert.That(beforeSceneASp, Is.Not.Null);
+            Assert.That(beforeSceneASp.IsChildAgent, Is.False);
+
+            ScenePresence beforeSceneBSp = sceneB.GetScenePresence(userId);
+            Assert.That(beforeSceneBSp, Is.Not.Null);
+            Assert.That(beforeSceneBSp.IsChildAgent, Is.True);
+
+            // Here, we need to make clientA's receipt of SendRegionTeleport trigger clientB's CompleteMovement().  This
+            // is to operate the teleport V2 mechanism where the EntityTransferModule will first request the client to
+            // CompleteMovement to the region and then call UpdateAgent to the destination region to confirm the receipt
+            // Both these operations will occur on different threads and will wait for each other.
+            // We have to do this via ThreadPool directly since FireAndForget has been switched to sync for the V1
+            // test protocol, where we are trying to avoid unpredictable async operations in regression tests.
+            tc.OnTestClientSendRegionTeleport 
+                += (regionHandle, simAccess, regionExternalEndPoint, locationID, flags, capsURL) 
+                    => ThreadPool.UnsafeQueueUserWorkItem(o => destinationTestClients[0].CompleteMovement(), null);
+
+            sceneA.RequestTeleportLocation(
+                beforeSceneASp.ControllingClient,
+                sceneB.RegionInfo.RegionHandle,
+                teleportPosition,
+                teleportLookAt,
+                (uint)TeleportFlags.ViaLocation);
+
+            ScenePresence afterSceneASp = sceneA.GetScenePresence(userId);
+            Assert.That(afterSceneASp, Is.Not.Null);
+            Assert.That(afterSceneASp.IsChildAgent, Is.True);
+
+            ScenePresence afterSceneBSp = sceneB.GetScenePresence(userId);
+            Assert.That(afterSceneBSp, Is.Not.Null);
+            Assert.That(afterSceneBSp.IsChildAgent, Is.False);
+            Assert.That(afterSceneBSp.Scene.RegionInfo.RegionName, Is.EqualTo(sceneB.RegionInfo.RegionName));
+            Assert.That(afterSceneBSp.AbsolutePosition, Is.EqualTo(teleportPosition));
+
+            Assert.That(sceneA.GetRootAgentCount(), Is.EqualTo(0));
+            Assert.That(sceneA.GetChildAgentCount(), Is.EqualTo(1));
+            Assert.That(sceneB.GetRootAgentCount(), Is.EqualTo(1));
+            Assert.That(sceneB.GetChildAgentCount(), Is.EqualTo(0));
+
+            // TODO: Add assertions to check correct circuit details in both scenes.
+
+            // Lookat is sent to the client only - sp.Lookat does not yield the same thing (calculation from camera
+            // position instead).
+//            Assert.That(sp.Lookat, Is.EqualTo(teleportLookAt));
+
 //            TestHelpers.DisableLogging();
         }
     }