Added unit tests for FetchInventoryDescendents http://wiki.secondlife.com/wiki/Linden_Lab_Official:Inventory_API#Fetch_Inventory_Descendents

Also, consolidated the location of the files that handle inventory capabilities.

4 files changed, 217 insertions, 0 deletions

diff --git a/OpenSim/Capabilities/Handlers/FetchInventoryDescendents/FetchInvDescHandler.cs b/OpenSim/Capabilities/Handlers/FetchInventory/FetchInvDescHandler.cs
index 810096f..810096f 100644
--- a/OpenSim/Capabilities/Handlers/FetchInventoryDescendents/FetchInvDescHandler.cs
+++ b/OpenSim/Capabilities/Handlers/FetchInventory/FetchInvDescHandler.cs
diff --git a/OpenSim/Capabilities/Handlers/FetchInventoryDescendents/FetchInvDescServerConnector.cs b/OpenSim/Capabilities/Handlers/FetchInventory/FetchInvDescServerConnector.cs
index 6fbe173..6fbe173 100644
--- a/OpenSim/Capabilities/Handlers/FetchInventoryDescendents/FetchInvDescServerConnector.cs
+++ b/OpenSim/Capabilities/Handlers/FetchInventory/FetchInvDescServerConnector.cs
diff --git a/OpenSim/Capabilities/Handlers/FetchInventory2/FetchInventory2Handler.cs b/OpenSim/Capabilities/Handlers/FetchInventory/FetchInventory2Handler.cs
index b67b326..b67b326 100644
--- a/OpenSim/Capabilities/Handlers/FetchInventory2/FetchInventory2Handler.cs
+++ b/OpenSim/Capabilities/Handlers/FetchInventory/FetchInventory2Handler.cs
diff --git a/OpenSim/Capabilities/Handlers/FetchInventory/Tests/FetchInventoryDescendents2HandlerTests.cs b/OpenSim/Capabilities/Handlers/FetchInventory/Tests/FetchInventoryDescendents2HandlerTests.cs
new file mode 100644
index 0000000..1064c7b
--- /dev/null
+++ b/OpenSim/Capabilities/Handlers/FetchInventory/Tests/FetchInventoryDescendents2HandlerTests.cs
@@ -0,0 +1,217 @@
+/*
+ * 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.Linq;
+using System.Net;
+using log4net;
+using log4net.Config;
+using NUnit.Framework;
+using OpenMetaverse;
+using OpenSim.Capabilities.Handlers;
+using OpenSim.Framework;
+using OpenSim.Framework.Servers.HttpServer;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Services.Interfaces;
+using OpenSim.Tests.Common;
+
+namespace OpenSim.Capabilities.Handlers.FetchInventory.Tests
+{
+    [TestFixture]
+    public class FetchInventoryDescendents2HandlerTests : OpenSimTestCase
+    {
+        private UUID m_userID = UUID.Zero;
+        private Scene m_scene;
+        private UUID m_rootFolderID;
+        private int m_rootDescendents;
+        private UUID m_notecardsFolder;
+        private UUID m_objectsFolder;
+
+        private void Init()
+        {
+            // CreateInventoryFolder an inventory
+
+            m_scene = new SceneHelpers().SetupScene();
+
+            m_scene.InventoryService.CreateUserInventory(m_userID);
+
+            m_rootFolderID = m_scene.InventoryService.GetRootFolder(m_userID).ID;
+
+            InventoryFolderBase of = m_scene.InventoryService.GetFolderForType(m_userID, AssetType.Object);
+            m_objectsFolder = of.ID;
+
+            // Add an object
+            InventoryItemBase item = new InventoryItemBase(new UUID("b0000000-0000-0000-0000-00000000000b"), m_userID);
+            item.AssetID = UUID.Random();
+            item.AssetType = (int)AssetType.Object;
+            item.Folder = m_objectsFolder;
+            item.Name = "Some Object";
+            m_scene.InventoryService.AddItem(item);
+
+            InventoryFolderBase ncf = m_scene.InventoryService.GetFolderForType(m_userID, AssetType.Notecard);
+            m_notecardsFolder = ncf.ID;
+
+            // Add a notecard
+            item = new InventoryItemBase(new UUID("10000000-0000-0000-0000-000000000001"), m_userID);
+            item.AssetID = UUID.Random();
+            item.AssetType = (int)AssetType.Notecard;
+            item.Folder = m_notecardsFolder;
+            item.Name = "Test Notecard 1";
+            m_scene.InventoryService.AddItem(item);
+            // Add another notecard
+            item.ID = new UUID("20000000-0000-0000-0000-000000000002");
+            item.AssetID = new UUID("a0000000-0000-0000-0000-00000000000a");
+            item.Name = "Test Notecard 2";
+            m_scene.InventoryService.AddItem(item);
+
+            // Add a folder
+            InventoryFolderBase folder = new InventoryFolderBase(new UUID("f0000000-0000-0000-0000-00000000000f"), "Test Folder", m_userID, m_rootFolderID);
+            m_scene.InventoryService.AddFolder(folder);
+
+            // Add a link to notecard 2 in Test Folder
+            item.AssetID = item.ID; // use item ID of notecard 2
+            item.ID = new UUID("40000000-0000-0000-0000-000000000004");
+            item.AssetType = (int)AssetType.Link;
+            item.Folder = folder.ID;
+            item.Name = "Link to notecard";
+            m_scene.InventoryService.AddItem(item);
+
+            // Add a link to the Objects folder in Test Folder
+            item.AssetID = m_scene.InventoryService.GetFolderForType(m_userID, AssetType.Object).ID; // use item ID of Objects folder
+            item.ID = new UUID("50000000-0000-0000-0000-000000000005");
+            item.AssetType = (int)AssetType.LinkFolder;
+            item.Folder = folder.ID;
+            item.Name = "Link to Objects folder";
+            m_scene.InventoryService.AddItem(item);
+
+            InventoryCollection coll = m_scene.InventoryService.GetFolderContent(m_userID, m_rootFolderID);
+            m_rootDescendents = coll.Items.Count + coll.Folders.Count;
+            Console.WriteLine("Number of descendents: " + m_rootDescendents);
+        }
+
+        [Test]
+        public void Test_001_SimpleFolder()
+        {
+            TestHelpers.InMethod();
+
+            Init();
+
+            FetchInvDescHandler handler = new FetchInvDescHandler(m_scene.InventoryService, null);
+            TestOSHttpRequest req = new TestOSHttpRequest();
+            TestOSHttpResponse resp = new TestOSHttpResponse();
+
+            string request = "<llsd><map><key>folders</key><array><map><key>fetch_folders</key><integer>1</integer><key>fetch_items</key><boolean>1</boolean><key>folder_id</key><uuid>";
+            request += m_rootFolderID;
+            request += "</uuid><key>owner_id</key><uuid>00000000-0000-0000-0000-000000000000</uuid><key>sort_order</key><integer>1</integer></map></array></map></llsd>";
+            
+            string llsdresponse = handler.FetchInventoryDescendentsRequest(request, "/FETCH", string.Empty, req, resp);
+
+            Assert.That(llsdresponse != null, Is.True, "Incorrect null response");
+            Assert.That(llsdresponse != string.Empty, Is.True, "Incorrect empty response");
+            Assert.That(llsdresponse.Contains("00000000-0000-0000-0000-000000000000"), Is.True, "Response should contain userID");
+
+            string descendents = "descendents</key><integer>" + m_rootDescendents + "</integer>";
+            Assert.That(llsdresponse.Contains(descendents), Is.True, "Incorrect number of descendents");
+            Console.WriteLine(llsdresponse);
+        }
+
+        [Test]
+        public void Test_002_MultipleFolders()
+        {
+            TestHelpers.InMethod();
+
+            FetchInvDescHandler handler = new FetchInvDescHandler(m_scene.InventoryService, null);
+            TestOSHttpRequest req = new TestOSHttpRequest();
+            TestOSHttpResponse resp = new TestOSHttpResponse();
+
+            string request = "<llsd><map><key>folders</key><array>";
+            request += "<map><key>fetch_folders</key><integer>1</integer><key>fetch_items</key><boolean>1</boolean><key>folder_id</key><uuid>";
+            request += m_rootFolderID;
+            request += "</uuid><key>owner_id</key><uuid>00000000-0000-0000-0000-000000000000</uuid><key>sort_order</key><integer>1</integer></map>";
+            request += "<map><key>fetch_folders</key><integer>1</integer><key>fetch_items</key><boolean>1</boolean><key>folder_id</key><uuid>";
+            request += m_notecardsFolder;
+            request += "</uuid><key>owner_id</key><uuid>00000000-0000-0000-0000-000000000000</uuid><key>sort_order</key><integer>1</integer></map>";
+            request += "</array></map></llsd>";
+
+            string llsdresponse = handler.FetchInventoryDescendentsRequest(request, "/FETCH", string.Empty, req, resp);
+            Console.WriteLine(llsdresponse);
+
+            string descendents = "descendents</key><integer>" + m_rootDescendents + "</integer>";
+            Assert.That(llsdresponse.Contains(descendents), Is.True, "Incorrect number of descendents for root folder");
+            descendents = "descendents</key><integer>2</integer>";
+            Assert.That(llsdresponse.Contains(descendents), Is.True, "Incorrect number of descendents for Notecard folder");
+
+            Assert.That(llsdresponse.Contains("10000000-0000-0000-0000-000000000001"), Is.True, "Notecard 1 is missing from response");
+            Assert.That(llsdresponse.Contains("20000000-0000-0000-0000-000000000002"), Is.True, "Notecard 2 is missing from response");
+        }
+
+        [Test]
+        public void Test_003_Links()
+        {
+            TestHelpers.InMethod();
+
+            FetchInvDescHandler handler = new FetchInvDescHandler(m_scene.InventoryService, null);
+            TestOSHttpRequest req = new TestOSHttpRequest();
+            TestOSHttpResponse resp = new TestOSHttpResponse();
+
+            string request = "<llsd><map><key>folders</key><array><map><key>fetch_folders</key><integer>1</integer><key>fetch_items</key><boolean>1</boolean><key>folder_id</key><uuid>";
+            request += "f0000000-0000-0000-0000-00000000000f";
+            request += "</uuid><key>owner_id</key><uuid>00000000-0000-0000-0000-000000000000</uuid><key>sort_order</key><integer>1</integer></map></array></map></llsd>";
+
+            string llsdresponse = handler.FetchInventoryDescendentsRequest(request, "/FETCH", string.Empty, req, resp);
+            Console.WriteLine(llsdresponse);
+
+            string descendents = "descendents</key><integer>2</integer>";
+            Assert.That(llsdresponse.Contains(descendents), Is.True, "Incorrect number of descendents for Test Folder");
+
+            // Make sure that the note card link is included
+            Assert.That(llsdresponse.Contains("Link to notecard"), Is.True, "Link to notecard is missing");
+            
+            //Make sure the notecard item itself is included
+            Assert.That(llsdresponse.Contains("Test Notecard 2"), Is.True, "Notecard 2 item (the source) is missing");
+
+            // Make sure that the source item is before the link item
+            int pos1 = llsdresponse.IndexOf("Test Notecard 2");
+            int pos2 = llsdresponse.IndexOf("Link to notecard");
+            Assert.Less(pos1, pos2, "Source of link is after link");
+
+            // Make sure the folder link is included
+            Assert.That(llsdresponse.Contains("Link to Objects folder"), Is.True, "Link to Objects folder is missing");
+
+            // Make sure the objects inside the Objects folder are included
+            // Note: I'm not entirely sure this is needed, but that's what I found in the implementation
+            Assert.That(llsdresponse.Contains("Some Object"), Is.True, "Some Object item (contents of the source) is missing");
+
+            // Make sure that the source item is before the link item
+            pos1 = llsdresponse.IndexOf("Some Object");
+            pos2 = llsdresponse.IndexOf("Link to Objects folder");
+            Assert.Less(pos1, pos2, "Contents of source of folder link is after folder link");
+        }
+    }
+
+}
\ No newline at end of file