tests/test_map.cpp

Thu, 23 Feb 2023 18:58:15 +0100

author
Mike Becker <universe@uap-core.de>
date
Thu, 23 Feb 2023 18:58:15 +0100
changeset 658
56c62780582e
parent 653
e081643aae2a
child 659
4a06fd63909a
permissions
-rw-r--r--

make hashmap store objects instead of pointers by default - fixes #239

universe@556 1 /*
universe@556 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@556 3 *
universe@556 4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
universe@556 5 *
universe@556 6 * Redistribution and use in source and binary forms, with or without
universe@556 7 * modification, are permitted provided that the following conditions are met:
universe@556 8 *
universe@556 9 * 1. Redistributions of source code must retain the above copyright
universe@556 10 * notice, this list of conditions and the following disclaimer.
universe@556 11 *
universe@556 12 * 2. Redistributions in binary form must reproduce the above copyright
universe@556 13 * notice, this list of conditions and the following disclaimer in the
universe@556 14 * documentation and/or other materials provided with the distribution.
universe@556 15 *
universe@556 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@556 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@556 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@556 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@556 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@556 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@556 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@556 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@556 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@556 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@556 26 * POSSIBILITY OF SUCH DAMAGE.
universe@556 27 */
universe@556 28
universe@556 29 #include "cx/hash_map.h"
universe@556 30 #include "cx/utils.h"
universe@658 31 #include "cx/string.h"
universe@556 32 #include "util_allocator.h"
universe@556 33
universe@556 34 #include <gtest/gtest.h>
universe@556 35 #include <unordered_map>
universe@556 36 #include <unordered_set>
universe@556 37
universe@556 38 struct map_operation {
universe@556 39 enum {
universe@556 40 put, rm
universe@556 41 } op;
universe@556 42 char const *key;
universe@556 43 char const *value;
universe@556 44 };
universe@556 45
universe@556 46 auto generate_map_operations() -> std::vector<map_operation> {
universe@556 47 return {
universe@556 48 {map_operation::put, "key 1", "test"},
universe@556 49 {map_operation::put, "key 2", "blub"},
universe@556 50 {map_operation::put, "key 3", "hallo"},
universe@556 51 {map_operation::put, "key 2", "foobar"},
universe@556 52 {map_operation::put, "key 4", "value 4"},
universe@556 53 {map_operation::put, "key 5", "value 5"},
universe@556 54 {map_operation::put, "key 6", "value 6"},
universe@556 55 {map_operation::rm, "key 4", nullptr},
universe@556 56 {map_operation::put, "key 7", "value 7"},
universe@556 57 {map_operation::put, "key 8", "value 8"},
universe@556 58 {map_operation::rm, "does not exist", nullptr},
universe@556 59 {map_operation::put, "key 9", "value 9"},
universe@556 60 {map_operation::put, "key 6", "other value"},
universe@556 61 {map_operation::put, "key 7", "something else"},
universe@556 62 {map_operation::rm, "key 8", nullptr},
universe@556 63 {map_operation::rm, "key 2", nullptr},
universe@556 64 {map_operation::put, "key 8", "new value"},
universe@556 65 };
universe@556 66 }
universe@556 67
universe@556 68 static void verify_map_contents(
universe@556 69 CxMap *map,
universe@556 70 std::unordered_map<std::string, std::string> const &refmap
universe@556 71 ) {
universe@556 72 // verify key iterator
universe@556 73 {
universe@556 74 auto keyiter = cxMapIteratorKeys(map);
universe@556 75 std::unordered_set<std::string> keys;
universe@563 76 cx_foreach(CxHashKey*, elem, keyiter) {
universe@604 77 keys.insert(std::string(elem->data.cstr, elem->len));
universe@556 78 }
universe@561 79 EXPECT_EQ(keyiter.index, map->size);
universe@556 80 ASSERT_EQ(keys.size(), map->size);
universe@556 81 for (auto &&k: keys) {
universe@556 82 EXPECT_NE(refmap.find(k), refmap.end());
universe@556 83 }
universe@556 84 }
universe@556 85
universe@556 86 // verify value iterator
universe@556 87 {
universe@556 88 auto valiter = cxMapIteratorValues(map);
universe@556 89 std::unordered_set<std::string> values; // we use that the values in our test data are unique strings
universe@556 90 cx_foreach(char const*, elem, valiter) {
universe@556 91 values.insert(std::string(elem));
universe@556 92 }
universe@561 93 EXPECT_EQ(valiter.index, map->size);
universe@556 94 ASSERT_EQ(values.size(), map->size);
universe@556 95 for (auto &&v: values) {
universe@556 96 EXPECT_NE(std::find_if(refmap.begin(), refmap.end(),
universe@556 97 [v](auto const &e) { return e.second == v; }), refmap.end());
universe@556 98 }
universe@556 99 }
universe@556 100
universe@556 101 // verify pair iterator
universe@556 102 {
universe@556 103 auto pairiter = cxMapIterator(map);
universe@556 104 std::unordered_map<std::string, std::string> pairs;
universe@556 105 cx_foreach(CxMapEntry*, entry, pairiter) {
universe@604 106 pairs[std::string(entry->key->data.cstr, entry->key->len)] = std::string((char *) entry->value);
universe@556 107 }
universe@561 108 EXPECT_EQ(pairiter.index, map->size);
universe@556 109 ASSERT_EQ(pairs.size(), refmap.size());
universe@556 110 for (auto &&p: pairs) {
universe@556 111 ASSERT_EQ(p.second, refmap.at(p.first));
universe@556 112 }
universe@556 113 }
universe@556 114 }
universe@556 115
universe@556 116 TEST(CxHashMap, Create) {
universe@556 117 CxTestingAllocator allocator;
universe@658 118 auto map = cxHashMapCreate(&allocator, 1, 0);
universe@556 119 auto hmap = reinterpret_cast<struct cx_hash_map_s *>(map);
universe@556 120 EXPECT_GT(hmap->bucket_count, 0);
universe@556 121 cx_for_n(i, hmap->bucket_count) {
universe@556 122 EXPECT_EQ(hmap->buckets[i], nullptr);
universe@556 123 }
universe@658 124 EXPECT_EQ(map->itemsize, 1);
universe@556 125 EXPECT_EQ(map->size, 0);
universe@556 126 EXPECT_EQ(map->allocator, &allocator);
universe@658 127 EXPECT_FALSE(map->store_pointers);
universe@658 128 cxMapStorePointers(map);
universe@658 129 EXPECT_TRUE(map->store_pointers);
universe@658 130 EXPECT_EQ(map->itemsize, sizeof(void *));
universe@658 131 cxMapStoreObjects(map);
universe@658 132 EXPECT_FALSE(map->store_pointers);
universe@556 133
universe@556 134 cxMapDestroy(map);
universe@556 135 EXPECT_TRUE(allocator.verify());
universe@556 136 }
universe@556 137
universe@556 138 TEST(CxHashMap, BasicOperations) {
universe@556 139 // create the map
universe@556 140 CxTestingAllocator allocator;
universe@658 141 auto map = cxHashMapCreateForPointers(&allocator, 8);
universe@556 142
universe@556 143 // create a reference map
universe@556 144 std::unordered_map<std::string, std::string> refmap;
universe@556 145
universe@556 146 // generate operations
universe@556 147 auto ops = generate_map_operations();
universe@556 148
universe@556 149 // verify iterators for empty map
universe@556 150 verify_map_contents(map, refmap);
universe@556 151
universe@556 152 // execute operations and verify results
universe@556 153 for (auto &&op: ops) {
universe@563 154 CxHashKey key = cx_hash_key_str(op.key);
universe@563 155 key.hash = 0; // force the hash map to compute the hash
universe@556 156 if (op.op == map_operation::put) {
universe@556 157 // execute a put operation and verify that the exact value can be read back
universe@556 158 refmap[std::string(op.key)] = std::string(op.value);
universe@556 159 int result = cxMapPut(map, key, (void *) op.value);
universe@556 160 EXPECT_EQ(result, 0);
universe@556 161 auto added = cxMapGet(map, key);
universe@556 162 EXPECT_EQ(memcmp(op.value, added, strlen(op.value)), 0);
universe@556 163 } else {
universe@556 164 // execute a remove and verify that the removed element was returned (or nullptr)
universe@556 165 auto found = refmap.find(op.key);
universe@556 166 auto removed = cxMapRemove(map, key);
universe@556 167 if (found == refmap.end()) {
universe@556 168 EXPECT_EQ(removed, nullptr);
universe@556 169 } else {
universe@556 170 EXPECT_EQ(std::string((char *) removed), found->second);
universe@556 171 refmap.erase(found);
universe@556 172 }
universe@556 173 }
universe@556 174 // compare the current map state with the reference map
universe@556 175 verify_map_contents(map, refmap);
universe@556 176 }
universe@556 177
universe@556 178 // destroy the map and verify the memory (de)allocations
universe@556 179 cxMapDestroy(map);
universe@556 180 EXPECT_TRUE(allocator.verify());
universe@556 181 }
universe@561 182
universe@561 183 TEST(CxHashMap, RemoveViaIterator) {
universe@561 184 CxTestingAllocator allocator;
universe@658 185 auto map = cxHashMapCreateForPointers(&allocator, 4);
universe@561 186
universe@563 187 cxMapPut(map, cx_hash_key_str("key 1"), (void *) "val 1");
universe@563 188 cxMapPut(map, cx_hash_key_str("key 2"), (void *) "val 2");
universe@563 189 cxMapPut(map, cx_hash_key_str("key 3"), (void *) "val 3");
universe@563 190 cxMapPut(map, cx_hash_key_str("key 4"), (void *) "val 4");
universe@563 191 cxMapPut(map, cx_hash_key_str("key 5"), (void *) "val 5");
universe@563 192 cxMapPut(map, cx_hash_key_str("key 6"), (void *) "val 6");
universe@561 193
universe@630 194 auto iter = cxMapMutIterator(map);
universe@561 195 cx_foreach(CxMapEntry*, entry, iter) {
universe@630 196 if (entry->key->data.cstr[4] % 2 == 1) cxIteratorFlagRemoval(iter);
universe@561 197 }
universe@561 198 EXPECT_EQ(map->size, 3);
universe@561 199 EXPECT_EQ(iter.index, map->size);
universe@561 200
universe@563 201 EXPECT_EQ(cxMapGet(map, cx_hash_key_str("key 1")), nullptr);
universe@563 202 EXPECT_NE(cxMapGet(map, cx_hash_key_str("key 2")), nullptr);
universe@563 203 EXPECT_EQ(cxMapGet(map, cx_hash_key_str("key 3")), nullptr);
universe@563 204 EXPECT_NE(cxMapGet(map, cx_hash_key_str("key 4")), nullptr);
universe@563 205 EXPECT_EQ(cxMapGet(map, cx_hash_key_str("key 5")), nullptr);
universe@563 206 EXPECT_NE(cxMapGet(map, cx_hash_key_str("key 6")), nullptr);
universe@561 207
universe@561 208 cxMapDestroy(map);
universe@561 209 EXPECT_TRUE(allocator.verify());
universe@561 210 }
universe@562 211
universe@562 212 TEST(CxHashMap, RehashNotRequired) {
universe@562 213 CxTestingAllocator allocator;
universe@658 214 auto map = cxHashMapCreateForPointers(&allocator, 8);
universe@562 215
universe@563 216 cxMapPut(map, cx_hash_key_str("key 1"), (void *) "val 1");
universe@563 217 cxMapPut(map, cx_hash_key_str("key 2"), (void *) "val 2");
universe@563 218 cxMapPut(map, cx_hash_key_str("key 3"), (void *) "val 3");
universe@563 219 cxMapPut(map, cx_hash_key_str("key 4"), (void *) "val 4");
universe@563 220 cxMapPut(map, cx_hash_key_str("key 5"), (void *) "val 5");
universe@563 221 cxMapPut(map, cx_hash_key_str("key 6"), (void *) "val 6");
universe@562 222
universe@562 223 // 6/8 does not exceed 0.75, therefore the function should not rehash
universe@562 224 int result = cxMapRehash(map);
universe@562 225 EXPECT_EQ(result, 0);
universe@562 226 EXPECT_EQ(reinterpret_cast<struct cx_hash_map_s *>(map)->bucket_count, 8);
universe@562 227
universe@562 228 cxMapDestroy(map);
universe@562 229 EXPECT_TRUE(allocator.verify());
universe@562 230 }
universe@562 231
universe@562 232 TEST(CxHashMap, Rehash) {
universe@562 233 CxTestingAllocator allocator;
universe@658 234 auto map = cxHashMapCreateForPointers(&allocator, 8);
universe@562 235
universe@563 236 cxMapPut(map, cx_hash_key_str("key 1"), (void *) "val 1");
universe@563 237 cxMapPut(map, cx_hash_key_str("key 2"), (void *) "val 2");
universe@563 238 cxMapPut(map, cx_hash_key_str("key 3"), (void *) "val 3");
universe@563 239 cxMapPut(map, cx_hash_key_str("key 4"), (void *) "val 4");
universe@563 240 cxMapPut(map, cx_hash_key_str("key 5"), (void *) "val 5");
universe@563 241 cxMapPut(map, cx_hash_key_str("key 6"), (void *) "val 6");
universe@563 242 cxMapPut(map, cx_hash_key_str("key 7"), (void *) "val 7");
universe@562 243
universe@562 244 int result = cxMapRehash(map);
universe@562 245 EXPECT_EQ(result, 0);
universe@562 246 EXPECT_EQ(reinterpret_cast<struct cx_hash_map_s *>(map)->bucket_count, 17);
universe@562 247 EXPECT_EQ(map->size, 7);
universe@562 248
universe@563 249 EXPECT_EQ(strcmp((char *) cxMapGet(map, cx_hash_key_str("key 1")), "val 1"), 0);
universe@563 250 EXPECT_EQ(strcmp((char *) cxMapGet(map, cx_hash_key_str("key 2")), "val 2"), 0);
universe@563 251 EXPECT_EQ(strcmp((char *) cxMapGet(map, cx_hash_key_str("key 3")), "val 3"), 0);
universe@563 252 EXPECT_EQ(strcmp((char *) cxMapGet(map, cx_hash_key_str("key 4")), "val 4"), 0);
universe@563 253 EXPECT_EQ(strcmp((char *) cxMapGet(map, cx_hash_key_str("key 5")), "val 5"), 0);
universe@563 254 EXPECT_EQ(strcmp((char *) cxMapGet(map, cx_hash_key_str("key 6")), "val 6"), 0);
universe@563 255 EXPECT_EQ(strcmp((char *) cxMapGet(map, cx_hash_key_str("key 7")), "val 7"), 0);
universe@562 256
universe@562 257 cxMapDestroy(map);
universe@562 258 EXPECT_TRUE(allocator.verify());
universe@594 259 }
universe@594 260
universe@594 261 TEST(CxHashMap, Clear) {
universe@594 262 CxTestingAllocator allocator;
universe@658 263 auto map = cxHashMapCreateForPointers(&allocator, 0);
universe@595 264
universe@594 265 cxMapPut(map, cx_hash_key_str("key 1"), (void *) "val 1");
universe@594 266 cxMapPut(map, cx_hash_key_str("key 2"), (void *) "val 2");
universe@594 267 cxMapPut(map, cx_hash_key_str("key 3"), (void *) "val 3");
universe@594 268
universe@594 269 EXPECT_EQ(map->size, 3);
universe@594 270
universe@594 271 cxMapClear(map);
universe@594 272
universe@594 273 EXPECT_EQ(map->size, 0);
universe@594 274 EXPECT_EQ(cxMapGet(map, cx_hash_key_str("key 1")), nullptr);
universe@594 275 EXPECT_EQ(cxMapGet(map, cx_hash_key_str("key 2")), nullptr);
universe@594 276 EXPECT_EQ(cxMapGet(map, cx_hash_key_str("key 3")), nullptr);
universe@594 277
universe@594 278 cxMapDestroy(map);
universe@594 279 EXPECT_TRUE(allocator.verify());
universe@658 280 }
universe@658 281
universe@658 282 TEST(CxHashMap, StoreUcxStrings) {
universe@658 283 // create the map
universe@658 284 CxTestingAllocator allocator;
universe@658 285 auto map = cxHashMapCreate(&allocator, sizeof(cxstring), 8);
universe@658 286
universe@658 287 // define some strings
universe@658 288 cxstring s1 = CX_STR("this");
universe@658 289 cxstring s2 = CX_STR("is");
universe@658 290 cxstring s3 = CX_STR("a");
universe@658 291 cxstring s4 = CX_STR("test");
universe@658 292 cxstring s5 = CX_STR("setup");
universe@658 293
universe@658 294 // put them into the map
universe@658 295 cxMapPut(map, cx_hash_key_str("s1"), &s1);
universe@658 296 cxMapPut(map, cx_hash_key_str("s2"), &s2);
universe@658 297 cxMapPut(map, cx_hash_key_str("s3"), &s3);
universe@658 298 cxMapPut(map, cx_hash_key_str("s4"), &s4);
universe@658 299
universe@658 300 // overwrite a value
universe@658 301 cxMapPut(map, cx_hash_key_str("s1"), &s5);
universe@658 302
universe@658 303 // look up a string
universe@658 304 auto s3p = reinterpret_cast<cxstring *>(cxMapGet(map, cx_hash_key_str("s3")));
universe@658 305 EXPECT_EQ(s3p->length, s3.length);
universe@658 306 EXPECT_EQ(s3p->ptr, s3.ptr);
universe@658 307 EXPECT_NE(s3p, &s3);
universe@658 308
universe@658 309 // remove a string
universe@658 310 auto r = cxMapRemove(map, cx_hash_key_str("s2"));
universe@658 311 EXPECT_EQ(r, nullptr);
universe@658 312
universe@658 313 // iterate
universe@658 314 auto ref = std::vector{s5.ptr, s3.ptr, s4.ptr};
universe@658 315 auto iter = cxMapIteratorValues(map);
universe@658 316 cx_foreach(cxstring*, s, iter) {
universe@658 317 auto found = std::find(ref.begin(), ref.end(), s->ptr);
universe@658 318 ASSERT_NE(found, ref.end());
universe@658 319 ref.erase(found);
universe@658 320 }
universe@658 321 EXPECT_EQ(ref.size(), 0);
universe@658 322
universe@658 323 cxMapDestroy(map);
universe@658 324 EXPECT_TRUE(allocator.verify());
universe@658 325 }

mercurial