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