From 90dd5844d64643246fb8bccf356614eb7e07d61c Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Wed, 26 Sep 2012 21:28:43 +0100
Subject: Add basic undo/redo regression tests.
---
OpenSim/Region/Framework/Scenes/SceneObjectPart.cs | 12 +-
.../Scenes/Tests/SceneObjectUndoRedoTests.cs | 130 +++++++++++++++++++++
.../Scenes/Tests/SceneObjectUserGroupTests.cs | 3 +-
3 files changed, 137 insertions(+), 8 deletions(-)
create mode 100644 OpenSim/Region/Framework/Scenes/Tests/SceneObjectUndoRedoTests.cs
diff --git a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
index 411dcc7..63eb387 100644
--- a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
@@ -3191,9 +3191,9 @@ namespace OpenSim.Region.Framework.Scenes
}
}
- // m_log.DebugFormat(
- // "[SCENE OBJECT PART]: Storing undo state for {0} {1}, forGroup {2}, initial stack size {3}",
- // Name, LocalId, forGroup, m_undo.Count);
+// m_log.DebugFormat(
+// "[SCENE OBJECT PART]: Storing undo state for {0} {1}, forGroup {2}, initial stack size {3}",
+// Name, LocalId, forGroup, m_undo.Count);
if (ParentGroup.GetSceneMaxUndo() > 0)
{
@@ -3204,9 +3204,9 @@ namespace OpenSim.Region.Framework.Scenes
if (m_redo.Count > 0)
m_redo.Clear();
- // m_log.DebugFormat(
- // "[SCENE OBJECT PART]: Stored undo state for {0} {1}, forGroup {2}, stack size now {3}",
- // Name, LocalId, forGroup, m_undo.Count);
+// m_log.DebugFormat(
+// "[SCENE OBJECT PART]: Stored undo state for {0} {1}, forGroup {2}, stack size now {3}",
+// Name, LocalId, forGroup, m_undo.Count);
}
}
}
diff --git a/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUndoRedoTests.cs b/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUndoRedoTests.cs
new file mode 100644
index 0000000..1e317c6
--- /dev/null
+++ b/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUndoRedoTests.cs
@@ -0,0 +1,130 @@
+/*
+ * 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.Reflection;
+using NUnit.Framework;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Framework.Communications;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Tests.Common;
+using OpenSim.Tests.Common.Mock;
+
+namespace OpenSim.Region.Framework.Scenes.Tests
+{
+ ///
+ /// Tests for undo/redo
+ ///
+ public class SceneObjectUndoRedoTests : OpenSimTestCase
+ {
+ [Test]
+ public void TestUndoRedoResizeSceneObject()
+ {
+ TestHelpers.InMethod();
+// TestHelpers.EnableLogging();
+
+ Vector3 firstSize = new Vector3(2, 3, 4);
+ Vector3 secondSize = new Vector3(5, 6, 7);
+
+ Scene scene = new SceneHelpers().SetupScene();
+ SceneObjectGroup g1 = SceneHelpers.AddSceneObject(scene);
+
+ // TODO: It happens to be the case that we are not storing undo states for SOPs which are not yet in a SOG,
+ // which is the way that AddSceneObject() sets up the object (i.e. it creates the SOP first). However,
+ // this is somewhat by chance. Really, we shouldn't be storing undo states at all if the object is not
+ // in a scene.
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(0));
+
+ g1.GroupResize(firstSize);
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(1));
+
+ g1.GroupResize(secondSize);
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(2));
+
+ g1.RootPart.Undo();
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(1));
+ Assert.That(g1.GroupScale, Is.EqualTo(firstSize));
+
+ g1.RootPart.Redo();
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(2));
+ Assert.That(g1.GroupScale, Is.EqualTo(secondSize));
+ }
+
+ [Test]
+ public void TestUndoBeyondAvailable()
+ {
+ TestHelpers.InMethod();
+
+ Vector3 newSize = new Vector3(2, 3, 4);
+
+ Scene scene = new SceneHelpers().SetupScene();
+ SceneObjectGroup g1 = SceneHelpers.AddSceneObject(scene);
+ Vector3 originalSize = g1.GroupScale;
+
+ g1.RootPart.Undo();
+
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(0));
+ Assert.That(g1.GroupScale, Is.EqualTo(originalSize));
+
+ g1.GroupResize(newSize);
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(1));
+ Assert.That(g1.GroupScale, Is.EqualTo(newSize));
+
+ g1.RootPart.Undo();
+ g1.RootPart.Undo();
+
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(0));
+ Assert.That(g1.GroupScale, Is.EqualTo(originalSize));
+ }
+
+ [Test]
+ public void TestRedoBeyondAvailable()
+ {
+ TestHelpers.InMethod();
+
+ Vector3 newSize = new Vector3(2, 3, 4);
+
+ Scene scene = new SceneHelpers().SetupScene();
+ SceneObjectGroup g1 = SceneHelpers.AddSceneObject(scene);
+ Vector3 originalSize = g1.GroupScale;
+
+ g1.RootPart.Redo();
+
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(0));
+ Assert.That(g1.GroupScale, Is.EqualTo(originalSize));
+
+ g1.GroupResize(newSize);
+ g1.RootPart.Undo();
+ g1.RootPart.Redo();
+ g1.RootPart.Redo();
+
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(1));
+ Assert.That(g1.GroupScale, Is.EqualTo(newSize));
+ }
+ }
+}
\ No newline at end of file
diff --git a/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUserGroupTests.cs b/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUserGroupTests.cs
index c7eaff9..2b79271 100644
--- a/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUserGroupTests.cs
+++ b/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUserGroupTests.cs
@@ -44,7 +44,7 @@ using OpenSim.Tests.Common.Mock;
namespace OpenSim.Region.Framework.Scenes.Tests
{
[TestFixture]
- public class SceneObjectUserGroupTests
+ public class SceneObjectUserGroupTests : OpenSimTestCase
{
///
/// Test share with group object functionality
@@ -54,7 +54,6 @@ namespace OpenSim.Region.Framework.Scenes.Tests
public void TestShareWithGroup()
{
TestHelpers.InMethod();
-// log4net.Config.XmlConfigurator.Configure();
UUID userId = UUID.Parse("10000000-0000-0000-0000-000000000001");
--
cgit v1.1
From 327320d1a7acbba969d26c281f92f64ce8ff365f Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Wed, 26 Sep 2012 22:49:44 +0100
Subject: Enforce existing 5 action hardcoded undo limit.
This was present in the code but not enforced, which led to a memory leak over time as part properties were changed, whether by viewer, script or another source.
This commit enforces that limit, which will soon become configurable.
Regression test for undo limit added
Should help with http://opensimulator.org/mantis/view.php?id=6279
---
OpenSim/Region/Framework/Scenes/Scene.cs | 6 ++-
OpenSim/Region/Framework/Scenes/SceneObjectPart.cs | 59 ++++++++++++----------
.../Scenes/Tests/SceneObjectUndoRedoTests.cs | 27 ++++++++++
3 files changed, 65 insertions(+), 27 deletions(-)
diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs
index e9d1d42..872c061 100644
--- a/OpenSim/Region/Framework/Scenes/Scene.cs
+++ b/OpenSim/Region/Framework/Scenes/Scene.cs
@@ -151,7 +151,8 @@ namespace OpenSim.Region.Framework.Scenes
// TODO: need to figure out how allow client agents but deny
// root agents when ACL denies access to root agent
public bool m_strictAccessControl = true;
- public int MaxUndoCount = 5;
+
+ public int MaxUndoCount { get; set; }
// Using this for RegionReady module to prevent LoginsDisabled from changing under our feet;
public bool LoginLock = false;
@@ -931,6 +932,9 @@ namespace OpenSim.Region.Framework.Scenes
WestBorders.Add(westBorder);
BordersLocked = false;
+ // TODO: At some point this should be made configurable.
+ MaxUndoCount = 5;
+
m_eventManager = new EventManager();
m_permissions = new ScenePermissions(this);
diff --git a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
index 63eb387..9e78242 100644
--- a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
@@ -266,8 +266,8 @@ namespace OpenSim.Region.Framework.Scenes
private string m_sitAnimation = "SIT";
private string m_text = String.Empty;
private string m_touchName = String.Empty;
- private readonly Stack m_undo = new Stack(5);
- private readonly Stack m_redo = new Stack(5);
+ private readonly List m_undo = new List(5);
+ private readonly List m_redo = new List(5);
private bool m_passTouches = false;
private bool m_passCollisions = false;
@@ -3176,7 +3176,7 @@ namespace OpenSim.Region.Framework.Scenes
{
if (m_undo.Count > 0)
{
- UndoState last = m_undo.Peek();
+ UndoState last = m_undo[m_undo.Count - 1];
if (last != null)
{
// TODO: May need to fix for group comparison
@@ -3199,7 +3199,10 @@ namespace OpenSim.Region.Framework.Scenes
{
UndoState nUndo = new UndoState(this, forGroup);
- m_undo.Push(nUndo);
+ m_undo.Add(nUndo);
+
+ if (m_undo.Count > ParentGroup.GetSceneMaxUndo())
+ m_undo.RemoveAt(0);
if (m_redo.Count > 0)
m_redo.Clear();
@@ -3245,21 +3248,24 @@ namespace OpenSim.Region.Framework.Scenes
if (m_undo.Count > 0)
{
- UndoState goback = m_undo.Pop();
+ UndoState goback = m_undo[m_undo.Count - 1];
+ m_undo.RemoveAt(m_undo.Count - 1);
- if (goback != null)
+ UndoState nUndo = null;
+
+ if (ParentGroup.GetSceneMaxUndo() > 0)
{
- UndoState nUndo = null;
-
- if (ParentGroup.GetSceneMaxUndo() > 0)
- {
- nUndo = new UndoState(this, goback.ForGroup);
- }
+ nUndo = new UndoState(this, goback.ForGroup);
+ }
+
+ goback.PlaybackState(this);
- goback.PlaybackState(this);
+ if (nUndo != null)
+ {
+ m_redo.Add(nUndo);
- if (nUndo != null)
- m_redo.Push(nUndo);
+ if (m_redo.Count > ParentGroup.GetSceneMaxUndo())
+ m_redo.RemoveAt(0);
}
}
@@ -3279,20 +3285,21 @@ namespace OpenSim.Region.Framework.Scenes
if (m_redo.Count > 0)
{
- UndoState gofwd = m_redo.Pop();
-
- if (gofwd != null)
+ UndoState gofwd = m_redo[m_redo.Count - 1];
+ m_redo.RemoveAt(m_redo.Count - 1);
+
+ if (ParentGroup.GetSceneMaxUndo() > 0)
{
- if (ParentGroup.GetSceneMaxUndo() > 0)
- {
- UndoState nUndo = new UndoState(this, gofwd.ForGroup);
-
- m_undo.Push(nUndo);
- }
-
- gofwd.PlayfwdState(this);
+ UndoState nUndo = new UndoState(this, gofwd.ForGroup);
+
+ m_undo.Add(nUndo);
+
+ if (m_undo.Count > ParentGroup.GetSceneMaxUndo())
+ m_undo.RemoveAt(0);
}
+ gofwd.PlayfwdState(this);
+
// m_log.DebugFormat(
// "[SCENE OBJECT PART]: Handled redo request for {0} {1}, stack size now {2}",
// Name, LocalId, m_redo.Count);
diff --git a/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUndoRedoTests.cs b/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUndoRedoTests.cs
index 1e317c6..c93562d 100644
--- a/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUndoRedoTests.cs
+++ b/OpenSim/Region/Framework/Scenes/Tests/SceneObjectUndoRedoTests.cs
@@ -76,6 +76,33 @@ namespace OpenSim.Region.Framework.Scenes.Tests
}
[Test]
+ public void TestUndoLimit()
+ {
+ TestHelpers.InMethod();
+
+ Vector3 firstSize = new Vector3(2, 3, 4);
+ Vector3 secondSize = new Vector3(5, 6, 7);
+ Vector3 thirdSize = new Vector3(8, 9, 10);
+ Vector3 fourthSize = new Vector3(11, 12, 13);
+
+ Scene scene = new SceneHelpers().SetupScene();
+ scene.MaxUndoCount = 2;
+ SceneObjectGroup g1 = SceneHelpers.AddSceneObject(scene);
+
+ g1.GroupResize(firstSize);
+ g1.GroupResize(secondSize);
+ g1.GroupResize(thirdSize);
+ g1.GroupResize(fourthSize);
+
+ g1.RootPart.Undo();
+ g1.RootPart.Undo();
+ g1.RootPart.Undo();
+
+ Assert.That(g1.RootPart.UndoCount, Is.EqualTo(0));
+ Assert.That(g1.GroupScale, Is.EqualTo(secondSize));
+ }
+
+ [Test]
public void TestUndoBeyondAvailable()
{
TestHelpers.InMethod();
--
cgit v1.1