Take advantage of the fact that stasis_unsubscribe now returns NULL
[asterisk/asterisk.git] / tests / test_stasis.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file \brief Test Stasis message bus.
21  *
22  * \author\verbatim David M. Lee, II <dlee@digium.com> \endverbatim
23  *
24  * \ingroup tests
25  */
26
27 /*** MODULEINFO
28         <depend>TEST_FRAMEWORK</depend>
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/astobj2.h"
37 #include "asterisk/module.h"
38 #include "asterisk/stasis.h"
39 #include "asterisk/test.h"
40
41 static const char *test_category = "/stasis/core/";
42
43 AST_TEST_DEFINE(message_type)
44 {
45         RAII_VAR(struct stasis_message_type *, uut, NULL, ao2_cleanup);
46
47         switch (cmd) {
48         case TEST_INIT:
49                 info->name = __func__;
50                 info->category = test_category;
51                 info->summary = "Test basic message_type functions";
52                 info->description = "Test basic message_type functions";
53                 return AST_TEST_NOT_RUN;
54         case TEST_EXECUTE:
55                 break;
56         }
57
58         ast_test_validate(test, NULL == stasis_message_type_create(NULL));
59         uut = stasis_message_type_create("SomeMessage");
60         ast_test_validate(test, 0 == strcmp(stasis_message_type_name(uut), "SomeMessage"));
61
62         return AST_TEST_PASS;
63 }
64
65 AST_TEST_DEFINE(message)
66 {
67         RAII_VAR(struct stasis_message_type *, type, NULL, ao2_cleanup);
68         RAII_VAR(struct stasis_message *, uut, NULL, ao2_cleanup);
69         RAII_VAR(char *, data, NULL, ao2_cleanup);
70         char *expected = "SomeData";
71         struct timeval expected_timestamp;
72         struct timeval time_diff;
73
74         switch (cmd) {
75         case TEST_INIT:
76                 info->name = __func__;
77                 info->category = test_category;
78                 info->summary = "Test basic message functions";
79                 info->description = "Test basic message functions";
80                 return AST_TEST_NOT_RUN;
81         case TEST_EXECUTE:
82                 break;
83         }
84
85
86         type = stasis_message_type_create("SomeMessage");
87
88         ast_test_validate(test, NULL == stasis_message_create(NULL, NULL));
89         ast_test_validate(test, NULL == stasis_message_create(type, NULL));
90
91         data = ao2_alloc(strlen(expected) + 1, NULL);
92         strcpy(data, expected);
93         expected_timestamp = ast_tvnow();
94         uut = stasis_message_create(type, data);
95
96         ast_test_validate(test, NULL != uut);
97         ast_test_validate(test, type == stasis_message_type(uut));
98         ast_test_validate(test, 0 == strcmp(expected, stasis_message_data(uut)));
99         ast_test_validate(test, 2 == ao2_ref(data, 0)); /* uut has ref to data */
100
101         time_diff = ast_tvsub(*stasis_message_timestamp(uut), expected_timestamp);
102         /* 10ms is certainly long enough for the two calls to complete */
103         ast_test_validate(test, time_diff.tv_sec == 0);
104         ast_test_validate(test, time_diff.tv_usec < 10000);
105
106         ao2_ref(uut, -1);
107         uut = NULL;
108         ast_test_validate(test, 1 == ao2_ref(data, 0)); /* uut unreffed data */
109
110         return AST_TEST_PASS;
111 }
112
113 struct consumer {
114         ast_mutex_t lock;
115         ast_cond_t out;
116         struct stasis_message **messages_rxed;
117         size_t messages_rxed_len;
118         int ignore_subscriptions;
119         int complete;
120 };
121
122 static void consumer_dtor(void *obj) {
123         struct consumer *consumer = obj;
124
125         ast_mutex_destroy(&consumer->lock);
126         ast_cond_destroy(&consumer->out);
127
128         while (consumer->messages_rxed_len > 0) {
129                 ao2_cleanup(consumer->messages_rxed[--consumer->messages_rxed_len]);
130         }
131         ast_free(consumer->messages_rxed);
132         consumer->messages_rxed = NULL;
133 }
134
135 static struct consumer *consumer_create(int ignore_subscriptions) {
136         RAII_VAR(struct consumer *, consumer, NULL, ao2_cleanup);
137
138         consumer = ao2_alloc(sizeof(*consumer), consumer_dtor);
139
140         if (!consumer) {
141                 return NULL;
142         }
143
144         consumer->ignore_subscriptions = ignore_subscriptions;
145         consumer->messages_rxed = ast_malloc(0);
146         if (!consumer->messages_rxed) {
147                 return NULL;
148         }
149
150         ast_mutex_init(&consumer->lock);
151         ast_cond_init(&consumer->out, NULL);
152
153         ao2_ref(consumer, +1);
154         return consumer;
155 }
156
157 static void consumer_exec(void *data, struct stasis_subscription *sub, struct stasis_topic *topic, struct stasis_message *message)
158 {
159         struct consumer *consumer = data;
160         RAII_VAR(struct consumer *, consumer_needs_cleanup, NULL, ao2_cleanup);
161         SCOPED_MUTEX(lock, &consumer->lock);
162
163         if (!consumer->ignore_subscriptions || stasis_message_type(message) != stasis_subscription_change()) {
164
165                 ++consumer->messages_rxed_len;
166                 consumer->messages_rxed = ast_realloc(consumer->messages_rxed, sizeof(*consumer->messages_rxed) * consumer->messages_rxed_len);
167                 ast_assert(consumer->messages_rxed != NULL);
168                 consumer->messages_rxed[consumer->messages_rxed_len - 1] = message;
169                 ao2_ref(message, +1);
170         }
171
172         if (stasis_subscription_final_message(sub, message)) {
173                 consumer->complete = 1;
174                 consumer_needs_cleanup = consumer;
175         }
176
177         ast_cond_signal(&consumer->out);
178 }
179
180 static int consumer_wait_for(struct consumer *consumer, size_t expected_len)
181 {
182         struct timeval start = ast_tvnow();
183         struct timespec end = {
184                 .tv_sec = start.tv_sec + 30,
185                 .tv_nsec = start.tv_usec * 1000
186         };
187
188         SCOPED_MUTEX(lock, &consumer->lock);
189
190         while (consumer->messages_rxed_len < expected_len) {
191                 int r = ast_cond_timedwait(&consumer->out, &consumer->lock, &end);
192                 if (r == ETIMEDOUT) {
193                         break;
194                 }
195                 ast_assert(r == 0); /* Not expecting any othet types of errors */
196         }
197         return consumer->messages_rxed_len;
198 }
199
200 static int consumer_wait_for_completion(struct consumer *consumer)
201 {
202         struct timeval start = ast_tvnow();
203         struct timespec end = {
204                 .tv_sec = start.tv_sec + 30,
205                 .tv_nsec = start.tv_usec * 1000
206         };
207
208         SCOPED_MUTEX(lock, &consumer->lock);
209
210         while (!consumer->complete) {
211                 int r = ast_cond_timedwait(&consumer->out, &consumer->lock, &end);
212                 if (r == ETIMEDOUT) {
213                         break;
214                 }
215                 ast_assert(r == 0); /* Not expecting any othet types of errors */
216         }
217         return consumer->complete;
218 }
219
220 static int consumer_should_stay(struct consumer *consumer, size_t expected_len)
221 {
222         struct timeval start = ast_tvnow();
223         struct timeval diff = {
224                 .tv_sec = 0,
225                 .tv_usec = 100000 /* wait for 100ms */
226         };
227         struct timeval end_tv = ast_tvadd(start, diff);
228         struct timespec end = {
229                 .tv_sec = end_tv.tv_sec,
230                 .tv_nsec = end_tv.tv_usec * 1000
231         };
232
233         SCOPED_MUTEX(lock, &consumer->lock);
234
235         while (consumer->messages_rxed_len == expected_len) {
236                 int r = ast_cond_timedwait(&consumer->out, &consumer->lock, &end);
237                 if (r == ETIMEDOUT) {
238                         break;
239                 }
240                 ast_assert(r == 0); /* Not expecting any othet types of errors */
241         }
242         return consumer->messages_rxed_len;
243 }
244
245 AST_TEST_DEFINE(subscription_messages)
246 {
247         RAII_VAR(struct stasis_topic *, topic, NULL, ao2_cleanup);
248         RAII_VAR(struct stasis_subscription *, uut, NULL, stasis_unsubscribe);
249         RAII_VAR(char *, test_data, NULL, ao2_cleanup);
250         RAII_VAR(struct stasis_message_type *, test_message_type, NULL, ao2_cleanup);
251         RAII_VAR(struct stasis_message *, test_message, NULL, ao2_cleanup);
252         RAII_VAR(struct consumer *, consumer, NULL, ao2_cleanup);
253         RAII_VAR(char *, expected_uniqueid, NULL, ast_free);
254         int complete;
255         struct stasis_subscription_change *change;
256
257         switch (cmd) {
258         case TEST_INIT:
259                 info->name = __func__;
260                 info->category = test_category;
261                 info->summary = "Test subscribe/unsubscribe messages";
262                 info->description = "Test subscribe/unsubscribe messages";
263                 return AST_TEST_NOT_RUN;
264         case TEST_EXECUTE:
265                 break;
266         }
267
268         topic = stasis_topic_create("TestTopic");
269         ast_test_validate(test, NULL != topic);
270
271         consumer = consumer_create(0);
272         ast_test_validate(test, NULL != consumer);
273
274         uut = stasis_subscribe(topic, consumer_exec, consumer);
275         ast_test_validate(test, NULL != uut);
276         ao2_ref(consumer, +1);
277         expected_uniqueid = ast_strdup(stasis_subscription_uniqueid(uut));
278
279         uut = stasis_unsubscribe(uut);
280         complete = consumer_wait_for_completion(consumer);
281         ast_test_validate(test, 1 == complete);
282
283         ast_test_validate(test, 2 == consumer->messages_rxed_len);
284         ast_test_validate(test, stasis_subscription_change() == stasis_message_type(consumer->messages_rxed[0]));
285         ast_test_validate(test, stasis_subscription_change() == stasis_message_type(consumer->messages_rxed[1]));
286
287         change = stasis_message_data(consumer->messages_rxed[0]);
288         ast_test_validate(test, topic == change->topic);
289         ast_test_validate(test, 0 == strcmp("Subscribe", change->description));
290         ast_test_validate(test, 0 == strcmp(expected_uniqueid, change->uniqueid));
291
292         change = stasis_message_data(consumer->messages_rxed[1]);
293         ast_test_validate(test, topic == change->topic);
294         ast_test_validate(test, 0 == strcmp("Unsubscribe", change->description));
295         ast_test_validate(test, 0 == strcmp(expected_uniqueid, change->uniqueid));
296
297         return AST_TEST_PASS;
298 }
299
300 AST_TEST_DEFINE(publish)
301 {
302         RAII_VAR(struct stasis_topic *, topic, NULL, ao2_cleanup);
303         RAII_VAR(struct stasis_subscription *, uut, NULL, stasis_unsubscribe);
304         RAII_VAR(char *, test_data, NULL, ao2_cleanup);
305         RAII_VAR(struct stasis_message_type *, test_message_type, NULL, ao2_cleanup);
306         RAII_VAR(struct stasis_message *, test_message, NULL, ao2_cleanup);
307         RAII_VAR(struct consumer *, consumer, NULL, ao2_cleanup);
308         int actual_len;
309         const char *actual;
310
311         switch (cmd) {
312         case TEST_INIT:
313                 info->name = __func__;
314                 info->category = test_category;
315                 info->summary = "Test simple subscriptions";
316                 info->description = "Test simple subscriptions";
317                 return AST_TEST_NOT_RUN;
318         case TEST_EXECUTE:
319                 break;
320         }
321
322         topic = stasis_topic_create("TestTopic");
323         ast_test_validate(test, NULL != topic);
324
325         consumer = consumer_create(1);
326         ast_test_validate(test, NULL != consumer);
327
328         uut = stasis_subscribe(topic, consumer_exec, consumer);
329         ast_test_validate(test, NULL != uut);
330         ao2_ref(consumer, +1);
331
332         test_data = ao2_alloc(1, NULL);
333         ast_test_validate(test, NULL != test_data);
334         test_message_type = stasis_message_type_create("TestMessage");
335         test_message = stasis_message_create(test_message_type, test_data);
336
337         stasis_publish(topic, test_message);
338
339         actual_len = consumer_wait_for(consumer, 1);
340         ast_test_validate(test, 1 == actual_len);
341         actual = stasis_message_data(consumer->messages_rxed[0]);
342         ast_test_validate(test, test_data == actual);
343
344         return AST_TEST_PASS;
345 }
346
347 AST_TEST_DEFINE(unsubscribe_stops_messages)
348 {
349         RAII_VAR(struct stasis_topic *, topic, NULL, ao2_cleanup);
350         RAII_VAR(struct consumer *, consumer, NULL, ao2_cleanup);
351         RAII_VAR(struct stasis_subscription *, uut, NULL, stasis_unsubscribe);
352         RAII_VAR(char *, test_data, NULL, ao2_cleanup);
353         RAII_VAR(struct stasis_message_type *, test_message_type, NULL, ao2_cleanup);
354         RAII_VAR(struct stasis_message *, test_message, NULL, ao2_cleanup);
355         int actual_len;
356
357         switch (cmd) {
358         case TEST_INIT:
359                 info->name = __func__;
360                 info->category = test_category;
361                 info->summary = "Test simple subscriptions";
362                 info->description = "Test simple subscriptions";
363                 return AST_TEST_NOT_RUN;
364         case TEST_EXECUTE:
365                 break;
366         }
367
368         topic = stasis_topic_create("TestTopic");
369         ast_test_validate(test, NULL != topic);
370
371         consumer = consumer_create(1);
372         ast_test_validate(test, NULL != consumer);
373
374         uut = stasis_subscribe(topic, consumer_exec, consumer);
375         ast_test_validate(test, NULL != uut);
376         ao2_ref(consumer, +1);
377
378         uut = stasis_unsubscribe(uut);
379
380         test_data = ao2_alloc(1, NULL);
381         ast_test_validate(test, NULL != test_data);
382         test_message_type = stasis_message_type_create("TestMessage");
383         test_message = stasis_message_create(test_message_type, test_data);
384
385         stasis_publish(topic, test_message);
386
387         actual_len = consumer_should_stay(consumer, 0);
388         ast_test_validate(test, 0 == actual_len);
389
390         return AST_TEST_PASS;
391 }
392
393
394 AST_TEST_DEFINE(forward)
395 {
396         RAII_VAR(struct stasis_topic *, parent_topic, NULL, ao2_cleanup);
397         RAII_VAR(struct stasis_topic *, topic, NULL, ao2_cleanup);
398
399         RAII_VAR(struct consumer *, parent_consumer, NULL, ao2_cleanup);
400         RAII_VAR(struct consumer *, consumer, NULL, ao2_cleanup);
401
402         RAII_VAR(struct stasis_subscription *, forward_sub, NULL, stasis_unsubscribe);
403         RAII_VAR(struct stasis_subscription *, parent_sub, NULL, stasis_unsubscribe);
404         RAII_VAR(struct stasis_subscription *, sub, NULL, stasis_unsubscribe);
405
406         RAII_VAR(char *, test_data, NULL, ao2_cleanup);
407         RAII_VAR(struct stasis_message_type *, test_message_type, NULL, ao2_cleanup);
408         RAII_VAR(struct stasis_message *, test_message, NULL, ao2_cleanup);
409         int actual_len;
410
411         switch (cmd) {
412         case TEST_INIT:
413                 info->name = __func__;
414                 info->category = test_category;
415                 info->summary = "Test sending events to a parent topic";
416                 info->description = "Test sending events to a parent topic.\n"
417                         "This test creates three topics (one parent, two children)\n"
418                         "and publishes a message to one child, and verifies it's\n"
419                         "only seen by that child and the parent";
420                 return AST_TEST_NOT_RUN;
421         case TEST_EXECUTE:
422                 break;
423         }
424
425         parent_topic = stasis_topic_create("ParentTestTopic");
426         ast_test_validate(test, NULL != parent_topic);
427         topic = stasis_topic_create("TestTopic");
428         ast_test_validate(test, NULL != topic);
429
430         forward_sub = stasis_forward_all(topic, parent_topic);
431         ast_test_validate(test, NULL != forward_sub);
432
433         parent_consumer = consumer_create(1);
434         ast_test_validate(test, NULL != parent_consumer);
435         consumer = consumer_create(1);
436         ast_test_validate(test, NULL != consumer);
437
438         parent_sub = stasis_subscribe(parent_topic, consumer_exec, parent_consumer);
439         ast_test_validate(test, NULL != parent_sub);
440         ao2_ref(parent_consumer, +1);
441         sub = stasis_subscribe(topic, consumer_exec, consumer);
442         ast_test_validate(test, NULL != sub);
443         ao2_ref(consumer, +1);
444
445         test_data = ao2_alloc(1, NULL);
446         ast_test_validate(test, NULL != test_data);
447         test_message_type = stasis_message_type_create("TestMessage");
448         test_message = stasis_message_create(test_message_type, test_data);
449
450         stasis_publish(topic, test_message);
451
452         actual_len = consumer_wait_for(consumer, 1);
453         ast_test_validate(test, 1 == actual_len);
454         actual_len = consumer_wait_for(parent_consumer, 1);
455         ast_test_validate(test, 1 == actual_len);
456
457         return AST_TEST_PASS;
458 }
459
460 struct cache_test_data {
461         char *id;
462         char *value;
463 };
464
465 static void cache_test_data_dtor(void *obj)
466 {
467         struct cache_test_data *data = obj;
468         ast_free(data->id);
469         ast_free(data->value);
470 }
471
472 static struct stasis_message *cache_test_message_create(struct stasis_message_type *type, const char *name, const char *value)
473 {
474         RAII_VAR(struct cache_test_data *, data, NULL, ao2_cleanup);
475
476         data = ao2_alloc(sizeof(*data), cache_test_data_dtor);
477         if (data == NULL) {
478                 return NULL;
479         }
480
481         ast_assert(name != NULL);
482         ast_assert(value != NULL);
483
484         data->id = ast_strdup(name);
485         data->value = ast_strdup(value);
486         if (!data->id || !data->value) {
487                 return NULL;
488         }
489
490         return stasis_message_create(type, data);
491 }
492
493 static const char *cache_test_data_id(struct stasis_message *message) {
494         struct cache_test_data *cachable = stasis_message_data(message);
495
496         if (0 != strcmp("Cacheable", stasis_message_type_name(stasis_message_type(message)))) {
497                 return NULL;
498         }
499         return cachable->id;
500 }
501
502 AST_TEST_DEFINE(cache_passthrough)
503 {
504         RAII_VAR(struct stasis_message_type *, non_cache_type, NULL, ao2_cleanup);
505         RAII_VAR(struct stasis_topic *, topic, NULL, ao2_cleanup);
506         RAII_VAR(struct stasis_caching_topic *, caching_topic, NULL, stasis_caching_unsubscribe);
507         RAII_VAR(struct consumer *, consumer, NULL, ao2_cleanup);
508         RAII_VAR(struct stasis_subscription *, sub, NULL, stasis_unsubscribe);
509         RAII_VAR(struct stasis_message *, test_message, NULL, ao2_cleanup);
510         int actual_len;
511         struct stasis_message_type *actual_type;
512
513         switch (cmd) {
514         case TEST_INIT:
515                 info->name = __func__;
516                 info->category = test_category;
517                 info->summary = "Test passing messages through cache topic unscathed.";
518                 info->description = "Test passing messages through cache topic unscathed.";
519                 return AST_TEST_NOT_RUN;
520         case TEST_EXECUTE:
521                 break;
522         }
523
524         non_cache_type = stasis_message_type_create("NonCacheable");
525         ast_test_validate(test, NULL != non_cache_type);
526         topic = stasis_topic_create("SomeTopic");
527         ast_test_validate(test, NULL != topic);
528         caching_topic = stasis_caching_topic_create(topic, cache_test_data_id);
529         ast_test_validate(test, NULL != caching_topic);
530         consumer = consumer_create(1);
531         ast_test_validate(test, NULL != consumer);
532         sub = stasis_subscribe(stasis_caching_get_topic(caching_topic), consumer_exec, consumer);
533         ast_test_validate(test, NULL != sub);
534         ao2_ref(consumer, +1);
535
536         test_message = cache_test_message_create(non_cache_type, "1", "1");
537         ast_test_validate(test, NULL != test_message);
538
539         stasis_publish(topic, test_message);
540
541         actual_len = consumer_wait_for(consumer, 1);
542         ast_test_validate(test, 1 == actual_len);
543
544         actual_type = stasis_message_type(consumer->messages_rxed[0]);
545         ast_test_validate(test, non_cache_type == actual_type);
546
547         ast_test_validate(test, test_message == consumer->messages_rxed[0]);
548
549         return AST_TEST_PASS;
550 }
551
552 AST_TEST_DEFINE(cache)
553 {
554         RAII_VAR(struct stasis_message_type *, cache_type, NULL, ao2_cleanup);
555         RAII_VAR(struct stasis_topic *, topic, NULL, ao2_cleanup);
556         RAII_VAR(struct stasis_caching_topic *, caching_topic, NULL, stasis_caching_unsubscribe);
557         RAII_VAR(struct consumer *, consumer, NULL, ao2_cleanup);
558         RAII_VAR(struct stasis_subscription *, sub, NULL, stasis_unsubscribe);
559         RAII_VAR(struct stasis_message *, test_message1_1, NULL, ao2_cleanup);
560         RAII_VAR(struct stasis_message *, test_message2_1, NULL, ao2_cleanup);
561         RAII_VAR(struct stasis_message *, test_message2_2, NULL, ao2_cleanup);
562         RAII_VAR(struct stasis_message *, test_message1_clear, NULL, ao2_cleanup);
563         int actual_len;
564         struct stasis_cache_update *actual_update;
565         struct ao2_container *cache_dump;
566
567         switch (cmd) {
568         case TEST_INIT:
569                 info->name = __func__;
570                 info->category = test_category;
571                 info->summary = "Test passing messages through cache topic unscathed.";
572                 info->description = "Test passing messages through cache topic unscathed.";
573                 return AST_TEST_NOT_RUN;
574         case TEST_EXECUTE:
575                 break;
576         }
577
578         cache_type = stasis_message_type_create("Cacheable");
579         ast_test_validate(test, NULL != cache_type);
580         topic = stasis_topic_create("SomeTopic");
581         ast_test_validate(test, NULL != topic);
582         caching_topic = stasis_caching_topic_create(topic, cache_test_data_id);
583         ast_test_validate(test, NULL != caching_topic);
584         consumer = consumer_create(1);
585         ast_test_validate(test, NULL != consumer);
586         sub = stasis_subscribe(stasis_caching_get_topic(caching_topic), consumer_exec, consumer);
587         ast_test_validate(test, NULL != sub);
588         ao2_ref(consumer, +1);
589
590         test_message1_1 = cache_test_message_create(cache_type, "1", "1");
591         ast_test_validate(test, NULL != test_message1_1);
592         test_message2_1 = cache_test_message_create(cache_type, "2", "1");
593         ast_test_validate(test, NULL != test_message2_1);
594
595         /* Post a couple of snapshots */
596         stasis_publish(topic, test_message1_1);
597         stasis_publish(topic, test_message2_1);
598         actual_len = consumer_wait_for(consumer, 2);
599         ast_test_validate(test, 2 == actual_len);
600
601         /* Dump the cache to ensure that it has the correct number of items in it */
602         cache_dump = stasis_cache_dump(caching_topic, NULL);
603         ast_test_validate(test, 2 == ao2_container_count(cache_dump));
604         ao2_ref(cache_dump, -1);
605         cache_dump = NULL;
606
607         /* Check for new snapshot messages */
608         ast_test_validate(test, stasis_cache_update() == stasis_message_type(consumer->messages_rxed[0]));
609         actual_update = stasis_message_data(consumer->messages_rxed[0]);
610         ast_test_validate(test, topic == actual_update->topic);
611         ast_test_validate(test, NULL == actual_update->old_snapshot);
612         ast_test_validate(test, test_message1_1 == actual_update->new_snapshot);
613         ast_test_validate(test, test_message1_1 == stasis_cache_get(caching_topic, cache_type, "1"));
614         /* stasis_cache_get returned a ref, so unref test_message1_1 */
615         ao2_ref(test_message1_1, -1);
616
617         ast_test_validate(test, stasis_cache_update() == stasis_message_type(consumer->messages_rxed[1]));
618         actual_update = stasis_message_data(consumer->messages_rxed[1]);
619         ast_test_validate(test, topic == actual_update->topic);
620         ast_test_validate(test, NULL == actual_update->old_snapshot);
621         ast_test_validate(test, test_message2_1 == actual_update->new_snapshot);
622         ast_test_validate(test, test_message2_1 == stasis_cache_get(caching_topic, cache_type, "2"));
623         /* stasis_cache_get returned a ref, so unref test_message2_1 */
624         ao2_ref(test_message2_1, -1);
625
626         /* Update snapshot 2 */
627         test_message2_2 = cache_test_message_create(cache_type, "2", "2");
628         ast_test_validate(test, NULL != test_message2_2);
629         stasis_publish(topic, test_message2_2);
630
631         actual_len = consumer_wait_for(consumer, 3);
632         ast_test_validate(test, 3 == actual_len);
633
634         actual_update = stasis_message_data(consumer->messages_rxed[2]);
635         ast_test_validate(test, topic == actual_update->topic);
636         ast_test_validate(test, test_message2_1 == actual_update->old_snapshot);
637         ast_test_validate(test, test_message2_2 == actual_update->new_snapshot);
638         ast_test_validate(test, test_message2_2 == stasis_cache_get(caching_topic, cache_type, "2"));
639         /* stasis_cache_get returned a ref, so unref test_message2_2 */
640         ao2_ref(test_message2_2, -1);
641
642         /* Dump the cache to ensure that it has the correct number of items in it */
643         cache_dump = stasis_cache_dump(caching_topic, NULL);
644         ast_test_validate(test, 2 == ao2_container_count(cache_dump));
645         ao2_ref(cache_dump, -1);
646         cache_dump = NULL;
647
648         /* Clear snapshot 1 */
649         test_message1_clear = stasis_cache_clear_create(cache_type, "1");
650         ast_test_validate(test, NULL != test_message1_clear);
651         stasis_publish(topic, test_message1_clear);
652
653         actual_len = consumer_wait_for(consumer, 4);
654         ast_test_validate(test, 4 == actual_len);
655
656         actual_update = stasis_message_data(consumer->messages_rxed[3]);
657         ast_test_validate(test, topic == actual_update->topic);
658         ast_test_validate(test, test_message1_1 == actual_update->old_snapshot);
659         ast_test_validate(test, NULL == actual_update->new_snapshot);
660         ast_test_validate(test, NULL == stasis_cache_get(caching_topic, cache_type, "1"));
661
662         /* Dump the cache to ensure that it has the correct number of items in it */
663         cache_dump = stasis_cache_dump(caching_topic, NULL);
664         ast_test_validate(test, 1 == ao2_container_count(cache_dump));
665         ao2_ref(cache_dump, -1);
666         cache_dump = NULL;
667
668         /* Dump the cache to ensure that it has no subscription change items in it since those aren't cached */
669         cache_dump = stasis_cache_dump(caching_topic, stasis_subscription_change());
670         ast_test_validate(test, 0 == ao2_container_count(cache_dump));
671         ao2_ref(cache_dump, -1);
672         cache_dump = NULL;
673
674         return AST_TEST_PASS;
675 }
676
677 static int unload_module(void)
678 {
679         AST_TEST_UNREGISTER(message_type);
680         AST_TEST_UNREGISTER(message);
681         AST_TEST_UNREGISTER(subscription_messages);
682         AST_TEST_UNREGISTER(publish);
683         AST_TEST_UNREGISTER(unsubscribe_stops_messages);
684         AST_TEST_UNREGISTER(forward);
685         AST_TEST_UNREGISTER(cache_passthrough);
686         AST_TEST_UNREGISTER(cache);
687         return 0;
688 }
689
690 static int load_module(void)
691 {
692         AST_TEST_REGISTER(message_type);
693         AST_TEST_REGISTER(message);
694         AST_TEST_REGISTER(subscription_messages);
695         AST_TEST_REGISTER(publish);
696         AST_TEST_REGISTER(unsubscribe_stops_messages);
697         AST_TEST_REGISTER(forward);
698         AST_TEST_REGISTER(cache_passthrough);
699         AST_TEST_REGISTER(cache);
700         return AST_MODULE_LOAD_SUCCESS;
701 }
702
703 AST_MODULE_INFO(ASTERISK_GPL_KEY, 0, "Stasis testing",
704                 .load = load_module,
705                 .unload = unload_module
706         );