Add tests for LinkedTreeMap (KF-27, #60)

* implement tests for LinkedTreeMap

* fix assert in list's node dtor

* fix moving of links

* fix LinkedTreeMap behavior, refactor code

* fix LinkedTreeMap move assignment operator

* Refactor tests

* Update include/kf/LinkedTreeMap.h

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Sergey Podobry <sergius@apriorit.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

include/kf/LinkedTreeMap.h

@@ -7,19 +7,19 @@
 namespace kf
 {
     ///////////////////////////////////////////////////////////////////////////////////////////////////
-    // LinkedTreeMap - map container for NT kernel with predictable iteration order, inspired by https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashMap.html
+    // LinkedTreeMap - map container for NT kernel with predictable iteration order,
+    // inspired by https://docs.oracle.com/javase/8/docs/api/java/util/LinkedHashMap.html
 
     template<class K, class V, POOL_TYPE poolType, class LessComparer=std::less<K>>
     class LinkedTreeMap
     {
     public:
-        LinkedTreeMap()
-        {
-        }
+        LinkedTreeMap() noexcept = default;
+        LinkedTreeMap(_Inout_ LinkedTreeMap&& another) noexcept = default;
+        LinkedTreeMap& operator=(_Inout_ LinkedTreeMap&& another) noexcept = default;
 
-        LinkedTreeMap(_Inout_ LinkedTreeMap&& another) : m_table(std::move(another.m_table))
-        {
-        }
+        LinkedTreeMap(const LinkedTreeMap&) = delete;
+        LinkedTreeMap& operator=(const LinkedTreeMap&) = delete;
 
         ~LinkedTreeMap()
         {
@@ -45,14 +45,10 @@ namespace kf
             NTSTATUS status = m_table.insertElement(std::move(node));
             if (!NT_SUCCESS(status))
             {
-                value = std::move(node.m_value);
                 return status;
             }
 
-            auto insertedValue = get(key);
-            ASSERT(insertedValue);
-
-            Node* newNode = CONTAINING_RECORD(insertedValue, Node, m_value);
+            Node* newNode = m_table.lookupElement(Node::fromKey(key));
             ASSERT(newNode);
 
             m_links.addLast(*newNode);
@@ -79,12 +75,14 @@ namespace kf
         V* getByIndex(const ULONG index)
         {
             ULONG currentIndex = 0;
-            auto it = m_links.iterator();
-            while (it.hasNext())
+
+            for (auto it = m_links.iterator(); it.hasNext();)
             {
+                auto node = it.next();
+
                 if (currentIndex == index)
                 {
-                    return &it.next()->m_value;
+                    return &node->m_value;
                 }
 
                 ++currentIndex;
@@ -121,30 +119,16 @@ namespace kf
 
         bool remove(const K& key)
         {
-            auto value = get(key);
-            Node* node = CONTAINING_RECORD(value, Node, m_value);
-            m_links.remove(*node);
-            return m_table.deleteElement(Node::fromKey(key));
-        }
+            auto node = m_table.lookupElement(Node::fromKey(key));
+            if (node == nullptr)
+            {
+                return false;
+            }
 
-        bool removeByObject(const V* value)
-        {
-            Node* node = CONTAINING_RECORD(value, Node, m_value);
             m_links.remove(*node);
             return m_table.deleteElement(*node);
         }
 
-        LinkedTreeMap& operator=(_Inout_ LinkedTreeMap&& another)
-        {
-            m_links = std::move(another.m_links);
-            m_table = std::move(another.m_table);
-            return *this;
-        }
-
-    private:
-        LinkedTreeMap(const LinkedTreeMap&);
-        LinkedTreeMap& operator=(const LinkedTreeMap&);
-
     private:
         struct Node
         {
@@ -157,9 +141,7 @@ namespace kf
             {
             }
 
-            Node(Node&& another) : m_key(std::move(another.m_key)), m_value(std::move(another.m_value)), m_listEntry(std::move(another.m_listEntry))
-            {
-            }
+            Node(Node&& another) noexcept = default;
 
             bool operator<(const Node& another) const
             {
@@ -169,13 +151,11 @@ namespace kf
 
             K m_key;
             V m_value;
-
             DoubleLinkedListEntry m_listEntry;
         };
 
     private:
         GenericTableAvl<Node, poolType> m_table;
-
         DoubleLinkedList<Node, &Node::m_listEntry> m_links;
     };
 }

test/CMakeLists.txt

@@ -44,6 +44,7 @@ wdk_add_driver(kf-test WINVER NTDDI_WIN10 STL
     HexTest.cpp
     MapTest.cpp
     Vector.cpp
+    LinkedTreeMapTest.cpp
     ObserverTest.cpp
     EncodingDetectorTest.cpp
     IntrusivePtrTest.cpp