Add code for testing event queue messages recevied on region cross.

This is currently disabled pending an improvement in the test code to properly add avatars when an event queue module is present.

5 files changed, 212 insertions, 8 deletions

diff --git a/OpenSim/Region/CoreModules/Framework/EntityTransfer/EntityTransferModule.cs b/OpenSim/Region/CoreModules/Framework/EntityTransfer/EntityTransferModule.cs
index 07c3666..01b1668 100644
--- a/OpenSim/Region/CoreModules/Framework/EntityTransfer/EntityTransferModule.cs
+++ b/OpenSim/Region/CoreModules/Framework/EntityTransfer/EntityTransferModule.cs
@@ -1206,6 +1206,10 @@ namespace OpenSim.Region.CoreModules.Framework.EntityTransfer
                     // region doesn't take it
                     m_entityTransferStateMachine.UpdateInTransit(agent.UUID, AgentTransferState.CleaningUp);
 
+                    m_log.WarnFormat(
+                        "[ENTITY TRANSFER MODULE]: Region {0} would not accept update for agent {1} on cross attempt.  Returning to original region.", 
+                        neighbourRegion.RegionName, agent.Name);
+
                     ReInstantiateScripts(agent);
                     agent.AddToPhysicalScene(isFlying);
 
@@ -1225,6 +1229,7 @@ namespace OpenSim.Region.CoreModules.Framework.EntityTransfer
                                      neighbourRegion.RegionHandle);
                     return agent;
                 }
+
                 // No turning back
                 agent.IsChildAgent = true;
 
diff --git a/OpenSim/Region/CoreModules/ServiceConnectorsOut/Simulation/LocalSimulationConnector.cs b/OpenSim/Region/CoreModules/ServiceConnectorsOut/Simulation/LocalSimulationConnector.cs
index 3c18074..a413546 100644
--- a/OpenSim/Region/CoreModules/ServiceConnectorsOut/Simulation/LocalSimulationConnector.cs
+++ b/OpenSim/Region/CoreModules/ServiceConnectorsOut/Simulation/LocalSimulationConnector.cs
@@ -219,12 +219,15 @@ namespace OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation
             {
 //                    m_log.DebugFormat(
 //                        "[LOCAL SIMULATION CONNECTOR]: Found region {0} {1} to send AgentUpdate",
-//                        s.RegionInfo.RegionName, destination.RegionHandle);
+//                        destination.RegionName, destination.RegionID);
 
                 return m_scenes[destination.RegionID].IncomingChildAgentDataUpdate(cAgentData);
             }
 
-//            m_log.DebugFormat("[LOCAL COMMS]: Did not find region {0} for ChildAgentUpdate", regionHandle);
+//            m_log.DebugFormat(
+//                "[LOCAL COMMS]: Did not find region {0} {1} for ChildAgentUpdate", 
+//                destination.RegionName, destination.RegionID);
+
             return false;
         }
 
@@ -239,7 +242,7 @@ namespace OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation
             // note that we really don't need the GridRegion for this call
             foreach (Scene s in m_scenes.Values)
             {
-                //m_log.Debug("[LOCAL COMMS]: Found region to send ChildAgentUpdate");
+//                m_log.Debug("[LOCAL COMMS]: Found region to send ChildAgentUpdate");
                 s.IncomingChildAgentDataUpdate(cAgentData);
             }
 
diff --git a/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceCrossingTests.cs b/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceCrossingTests.cs
index ef9fff5..81a2fcc 100644
--- a/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceCrossingTests.cs
+++ b/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceCrossingTests.cs
@@ -26,6 +26,7 @@
  */
 
 using System;
+using System.Collections.Generic;
 using System.Reflection;
 using Nini.Config;
 using NUnit.Framework;
@@ -65,10 +66,11 @@ namespace OpenSim.Region.Framework.Scenes.Tests
         public void TestCrossOnSameSimulator()
         {
             TestHelpers.InMethod();
-            TestHelpers.EnableLogging();
+//            TestHelpers.EnableLogging();
 
             UUID userId = TestHelpers.ParseTail(0x1);
 
+//            TestEventQueueGetModule eqmA = new TestEventQueueGetModule();
             EntityTransferModule etmA = new EntityTransferModule();
             EntityTransferModule etmB = new EntityTransferModule();
             LocalSimulationConnectorModule lscm = new LocalSimulationConnectorModule();
@@ -77,7 +79,7 @@ namespace OpenSim.Region.Framework.Scenes.Tests
             IConfig modulesConfig = config.AddConfig("Modules");
             modulesConfig.Set("EntityTransferModule", etmA.Name);
             modulesConfig.Set("SimulationServices", lscm.Name);
-            IConfig entityTransferConfig = config.AddConfig("EntityTransfer");
+//            IConfig entityTransferConfig = config.AddConfig("EntityTransfer");
 
             // In order to run a single threaded regression test we do not want the entity transfer module waiting
             // for a callback from the destination scene before removing its avatar data.
@@ -89,6 +91,7 @@ namespace OpenSim.Region.Framework.Scenes.Tests
 
             SceneHelpers.SetupSceneModules(new Scene[] { sceneA, sceneB }, config, lscm);
             SceneHelpers.SetupSceneModules(sceneA, config, new CapabilitiesModule(), etmA);
+//            SceneHelpers.SetupSceneModules(sceneA, config, new CapabilitiesModule(), etmA, eqmA);
             SceneHelpers.SetupSceneModules(sceneB, config, new CapabilitiesModule(), etmB);
 
             ScenePresence originalSp = SceneHelpers.AddScenePresence(sceneA, userId, sh.SceneManager);
@@ -98,6 +101,8 @@ namespace OpenSim.Region.Framework.Scenes.Tests
 
 //            Console.WriteLine("First pos {0}", originalSp.AbsolutePosition);
 
+//            eqmA.ClearEvents();
+
             AgentUpdateArgs moveArgs = new AgentUpdateArgs();
             //moveArgs.BodyRotation = Quaternion.CreateFromEulers(Vector3.Zero);
             moveArgs.BodyRotation = Quaternion.CreateFromEulers(new Vector3(0, 0, (float)-(Math.PI / 2)));
@@ -117,6 +122,18 @@ namespace OpenSim.Region.Framework.Scenes.Tests
 //                Console.WriteLine("Pos {0}", originalSp.AbsolutePosition);
             }
 
+            // Need to sort processing of EnableSimulator message on adding scene presences before we can test eqm
+            // messages
+//            Dictionary<UUID, List<TestEventQueueGetModule.Event>> eqmEvents = eqmA.Events;
+//
+//            Assert.That(eqmEvents.Count, Is.EqualTo(1));
+//            Assert.That(eqmEvents.ContainsKey(originalSp.UUID), Is.True);
+//
+//            List<TestEventQueueGetModule.Event> spEqmEvents = eqmEvents[originalSp.UUID];
+//
+//            Assert.That(spEqmEvents.Count, Is.EqualTo(1));
+//            Assert.That(spEqmEvents[0].Name, Is.EqualTo("CrossRegion"));
+
             // sceneA should now only have a child agent
             ScenePresence spAfterCrossSceneA = sceneA.GetScenePresence(originalSp.UUID);
             Assert.That(spAfterCrossSceneA.IsChildAgent, Is.True);
@@ -128,12 +145,12 @@ namespace OpenSim.Region.Framework.Scenes.Tests
 
             TestClient sceneBTc = ((TestClient)spAfterCrossSceneB.ControllingClient);
 
-            bool receivedCompleteMovement = false;
-            sceneBTc.OnReceivedMoveAgentIntoRegion += (ri, pos, look) => receivedCompleteMovement = true;
+            int agentMovementCompleteReceived = 0;
+            sceneBTc.OnReceivedMoveAgentIntoRegion += (ri, pos, look) => agentMovementCompleteReceived++;
 
             sceneBTc.CompleteMovement();
 
-            Assert.That(receivedCompleteMovement, Is.True);
+            Assert.That(agentMovementCompleteReceived, Is.EqualTo(1));
             Assert.That(spAfterCrossSceneB.IsChildAgent, Is.False);
         }
     }
diff --git a/OpenSim/Tests/Common/Mock/TestEventQueueGetModule.cs b/OpenSim/Tests/Common/Mock/TestEventQueueGetModule.cs
new file mode 100644
index 0000000..6707019
--- /dev/null
+++ b/OpenSim/Tests/Common/Mock/TestEventQueueGetModule.cs
@@ -0,0 +1,178 @@
+/*
+ * 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;
+using System.Collections.Generic;
+using System.Net;
+using System.Reflection;
+using System.Threading;
+using log4net;
+using Nini.Config;
+using Mono.Addins;
+using OpenMetaverse;
+using OpenMetaverse.StructuredData;
+using OpenSim.Framework;
+using OpenSim.Framework.Servers;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Tests.Common
+{
+    public class TestEventQueueGetModule : IEventQueue, INonSharedRegionModule
+    {
+        public class Event 
+        {
+            public string Name { get; set; }
+            public object[] Args { get; set; }
+
+            public Event(string name, object[] args)
+            {
+                name = Name;
+                args = Args;
+            }
+        }
+
+        public Dictionary<UUID, List<Event>> Events { get; set; }
+
+        public void Initialise(IConfigSource source) {}
+
+        public void Close() {}
+
+        public void AddRegion(Scene scene) 
+        {
+            Events = new Dictionary<UUID, List<Event>>();
+            scene.RegisterModuleInterface<IEventQueue>(this);
+        }
+
+        public void RemoveRegion (Scene scene) {}
+
+        public void RegionLoaded (Scene scene) {}
+
+        public string Name { get { return "TestEventQueueGetModule"; } }
+
+        public Type ReplaceableInterface { get { return null; } }
+
+        private void AddEvent(UUID avatarID, string name, params object[] args)
+        {
+            Console.WriteLine("Adding event {0} for {1}", name, avatarID);
+
+            List<Event> avEvents;
+
+            if (!Events.ContainsKey(avatarID))
+            {
+                avEvents = new List<Event>();
+                Events[avatarID] = avEvents;
+            }
+            else
+            {
+                avEvents = Events[avatarID];
+            }
+
+            avEvents.Add(new Event(name, args));
+        }
+
+        public void ClearEvents()
+        {
+            if (Events != null)
+                Events.Clear();
+        }
+
+        public bool Enqueue(OSD o, UUID avatarID)
+        {
+            AddEvent(avatarID, "Enqueue", o);
+            return true;
+        }
+
+        public void DisableSimulator(ulong handle, UUID avatarID)
+        {
+            AddEvent(avatarID, "DisableSimulator", handle);
+        }
+
+        public void EnableSimulator (ulong handle, IPEndPoint endPoint, UUID avatarID)
+        {
+            AddEvent(avatarID, "EnableSimulator", handle);
+        }
+
+        public void EstablishAgentCommunication (UUID avatarID, IPEndPoint endPoint, string capsPath)
+        {
+            AddEvent(avatarID, "EstablishAgentCommunication", endPoint, capsPath);
+        }
+
+        public void TeleportFinishEvent (ulong regionHandle, byte simAccess, IPEndPoint regionExternalEndPoint, uint locationID, uint flags, string capsURL, UUID agentID)
+        {
+            AddEvent(agentID, "TeleportFinishEvent", regionHandle, simAccess, regionExternalEndPoint, locationID, flags, capsURL);
+        }
+
+        public void CrossRegion (ulong handle, Vector3 pos, Vector3 lookAt, IPEndPoint newRegionExternalEndPoint, string capsURL, UUID avatarID, UUID sessionID)
+        {
+            AddEvent(avatarID, "CrossRegion", handle, pos, lookAt, newRegionExternalEndPoint, capsURL, sessionID);
+        }
+
+        public void ChatterboxInvitation(
+            UUID sessionID, string sessionName, UUID fromAgent, string message, UUID toAgent, string fromName, 
+            byte dialog, uint timeStamp, bool offline, int parentEstateID, Vector3 position, uint ttl, 
+            UUID transactionID, bool fromGroup, byte[] binaryBucket)
+        {
+            AddEvent(
+                toAgent, "ChatterboxInvitation", sessionID, sessionName, fromAgent, message, toAgent, fromName, dialog, 
+                timeStamp, offline, parentEstateID, position, ttl, transactionID, fromGroup, binaryBucket);
+        }
+
+        public void ChatterBoxSessionAgentListUpdates (UUID sessionID, UUID fromAgent, UUID toAgent, bool canVoiceChat, bool isModerator, bool textMute)
+        {
+            AddEvent(toAgent, "ChatterBoxSessionAgentListUpdates", sessionID, fromAgent, canVoiceChat, isModerator, textMute);
+        }
+
+        public void ParcelProperties (OpenMetaverse.Messages.Linden.ParcelPropertiesMessage parcelPropertiesMessage, UUID avatarID)
+        {
+            AddEvent(avatarID, "ParcelProperties", parcelPropertiesMessage);
+        }
+
+        public void GroupMembership (OpenMetaverse.Packets.AgentGroupDataUpdatePacket groupUpdate, UUID avatarID)
+        {
+            AddEvent(avatarID, "GroupMembership", groupUpdate);
+        }
+
+        public OSD ScriptRunningEvent (UUID objectID, UUID itemID, bool running, bool mono)
+        {
+            Console.WriteLine("ONE");
+            throw new System.NotImplementedException ();
+        }
+
+        public OSD BuildEvent (string eventName, OSD eventBody)
+        {
+            Console.WriteLine("TWO");
+            throw new System.NotImplementedException ();
+        }
+
+        public void partPhysicsProperties (uint localID, byte physhapetype, float density, float friction, float bounce, float gravmod, UUID avatarID)
+        {
+            AddEvent(avatarID, "partPhysicsProperties", localID, physhapetype, density, friction, bounce, gravmod);
+        }
+    }
+}
\ No newline at end of file
diff --git a/prebuild.xml b/prebuild.xml
index 2b8e963..0045128 100644
--- a/prebuild.xml
+++ b/prebuild.xml
@@ -2833,6 +2833,7 @@
       <Reference name="Nini" path="../../../bin/"/>
       <Reference name="nunit.framework" path="../../../bin/"/>
       <Reference name="OpenMetaverse" path="../../../bin/"/>
+      <Reference name="OpenMetaverse.StructuredData" path="../../../bin/"/>
       <Reference name="OpenMetaverseTypes" path="../../../bin/"/>
       <Reference name="OpenSim.Data"/>
       <Reference name="OpenSim.Data.Null"/>