test_event.c 70 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024
  1. #include <stdbool.h>
  2. #include <string.h>
  3. #include "esp_event.h"
  4. #include "sdkconfig.h"
  5. #include "freertos/FreeRTOS.h"
  6. #include "freertos/task.h"
  7. #include "esp_log.h"
  8. #include "driver/gptimer.h"
  9. #include "esp_event.h"
  10. #include "esp_event_private.h"
  11. #include "esp_event_internal.h"
  12. #include "esp_heap_caps.h"
  13. #include "esp_timer.h"
  14. #include "sdkconfig.h"
  15. #include "unity.h"
  16. #include "test_utils.h"
  17. #if !TEMPORARY_DISABLED_FOR_TARGETS(ESP32C2)
  18. //IDF-4035
  19. static const char* TAG = "test_event";
  20. #define TEST_CONFIG_ITEMS_TO_REGISTER 5
  21. #define TEST_CONFIG_TASKS_TO_SPAWN 2
  22. #define TEST_CONFIG_WAIT_MULTIPLIER 5
  23. // The initial logging "initializing test" is to ensure mutex allocation is not counted against memory not being freed
  24. // during teardown.
  25. #define TEST_SETUP() \
  26. ESP_LOGI(TAG, "initializing test"); \
  27. size_t free_mem_before = heap_caps_get_free_size(MALLOC_CAP_DEFAULT); \
  28. test_setup(); \
  29. s_test_core_id = xPortGetCoreID(); \
  30. s_test_priority = uxTaskPriorityGet(NULL);
  31. #define TEST_TEARDOWN() \
  32. test_teardown(); \
  33. vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER)); \
  34. TEST_ASSERT_EQUAL(free_mem_before, heap_caps_get_free_size(MALLOC_CAP_DEFAULT));
  35. typedef struct {
  36. void* data;
  37. SemaphoreHandle_t start;
  38. SemaphoreHandle_t done;
  39. } task_arg_t;
  40. typedef struct {
  41. esp_event_base_t base;
  42. int32_t id;
  43. esp_event_handler_t* handles;
  44. int32_t num;
  45. esp_event_loop_handle_t loop;
  46. bool is_registration;
  47. } handler_registration_data_t;
  48. typedef struct {
  49. esp_event_base_t base;
  50. int32_t id;
  51. esp_event_loop_handle_t loop;
  52. int32_t num;
  53. } post_event_data_t;
  54. typedef struct {
  55. int performed;
  56. int expected;
  57. SemaphoreHandle_t done;
  58. } performance_data_t;
  59. typedef struct {
  60. void* data;
  61. SemaphoreHandle_t mutex;
  62. } simple_arg_t;
  63. typedef struct {
  64. esp_event_handler_instance_t *context;
  65. void* data;
  66. } instance_unregister_data_t;
  67. typedef struct {
  68. int *arr;
  69. int index;
  70. } ordered_data_t;
  71. static BaseType_t s_test_core_id;
  72. static UBaseType_t s_test_priority;
  73. ESP_EVENT_DECLARE_BASE(s_test_base1);
  74. ESP_EVENT_DECLARE_BASE(s_test_base2);
  75. ESP_EVENT_DEFINE_BASE(s_test_base1);
  76. ESP_EVENT_DEFINE_BASE(s_test_base2);
  77. enum {
  78. TEST_EVENT_BASE1_EV1,
  79. TEST_EVENT_BASE1_EV2,
  80. TEST_EVENT_BASE1_MAX
  81. };
  82. enum {
  83. TEST_EVENT_BASE2_EV1,
  84. TEST_EVENT_BASE2_EV2,
  85. TEST_EVENT_BASE2_MAX
  86. };
  87. static BaseType_t test_event_get_core(void)
  88. {
  89. static int calls = 0;
  90. if (portNUM_PROCESSORS > 1) {
  91. return (s_test_core_id + calls++) % portNUM_PROCESSORS;
  92. } else {
  93. return s_test_core_id;
  94. }
  95. }
  96. static esp_event_loop_args_t test_event_get_default_loop_args(void)
  97. {
  98. esp_event_loop_args_t loop_config = {
  99. .queue_size = CONFIG_ESP_SYSTEM_EVENT_QUEUE_SIZE,
  100. .task_name = "loop",
  101. .task_priority = s_test_priority,
  102. .task_stack_size = 2048,
  103. .task_core_id = test_event_get_core()
  104. };
  105. return loop_config;
  106. }
  107. static void test_event_simple_handler(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
  108. {
  109. if (!event_handler_arg) {
  110. return;
  111. }
  112. simple_arg_t* arg = (simple_arg_t*) event_handler_arg;
  113. xSemaphoreTake(arg->mutex, portMAX_DELAY);
  114. int* count = (int*) arg->data;
  115. if (event_data == NULL) {
  116. (*count)++;
  117. } else {
  118. (*count) += *((int*) event_data);
  119. }
  120. xSemaphoreGive(arg->mutex);
  121. }
  122. static void test_event_ordered_dispatch(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
  123. {
  124. int *arg = (int*) event_handler_arg;
  125. ordered_data_t *data = *((ordered_data_t**) (event_data));
  126. data->arr[data->index++] = *arg;
  127. }
  128. static void test_event_performance_handler(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
  129. {
  130. performance_data_t* data = (performance_data_t*) event_handler_arg;
  131. data->performed++;
  132. if (data->performed >= data->expected) {
  133. xSemaphoreGive(data->done);
  134. }
  135. }
  136. static void test_event_post_task(void* args)
  137. {
  138. task_arg_t* arg = (task_arg_t*) args;
  139. post_event_data_t* data = arg->data;
  140. xSemaphoreTake(arg->start, portMAX_DELAY);
  141. for (int i = 0; i < data->num; i++) {
  142. TEST_ESP_OK(esp_event_post_to(data->loop, data->base, data->id, NULL, 0, portMAX_DELAY));
  143. vTaskDelay(1);
  144. }
  145. xSemaphoreGive(arg->done);
  146. vTaskDelete(NULL);
  147. }
  148. static void test_event_simple_handler_registration_task(void* args)
  149. {
  150. task_arg_t* arg = (task_arg_t*) args;
  151. handler_registration_data_t* data = (handler_registration_data_t*) arg->data;
  152. xSemaphoreTake(arg->start, portMAX_DELAY);
  153. for(int i = 0; i < data->num; i++) {
  154. if (data->is_registration) {
  155. TEST_ESP_OK(esp_event_handler_register_with(data->loop, data->base, data->id, data->handles[i], NULL));
  156. } else {
  157. TEST_ESP_OK(esp_event_handler_unregister_with(data->loop, data->base, data->id, data->handles[i]));
  158. }
  159. vTaskDelay(1);
  160. }
  161. xSemaphoreGive(arg->done);
  162. vTaskDelete(NULL);
  163. }
  164. static void test_handler_post_w_task(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
  165. {
  166. simple_arg_t* arg = (simple_arg_t*) event_handler_arg;
  167. esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_data;
  168. int* count = (int*) arg->data;
  169. (*count)++;
  170. if (*count <= 2) {
  171. if (event_base == s_test_base1 && event_id == TEST_EVENT_BASE1_EV1) {
  172. TEST_ESP_OK(esp_event_post_to(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  173. } else{
  174. xSemaphoreGive((SemaphoreHandle_t) arg->mutex);
  175. }
  176. } else {
  177. // Test that once the queue is full and the handler attempts to post to the same loop,
  178. // posting does not block indefinitely.
  179. if (event_base == s_test_base1 && event_id == TEST_EVENT_BASE1_EV1) {
  180. xSemaphoreTake((SemaphoreHandle_t) arg->mutex, portMAX_DELAY);
  181. TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  182. }
  183. }
  184. }
  185. static void test_handler_post_wo_task(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
  186. {
  187. simple_arg_t* arg = (simple_arg_t*) event_handler_arg;
  188. esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_data;
  189. int* count = (int*) arg->data;
  190. (*count)++;
  191. if (*count <= 2) {
  192. if (event_base == s_test_base1 && event_id == TEST_EVENT_BASE1_EV1) {
  193. TEST_ESP_OK(esp_event_post_to(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  194. } else{
  195. xSemaphoreGive((SemaphoreHandle_t) arg->mutex);
  196. }
  197. } else {
  198. // Test that once the queue is full and the handler attempts to post to the same loop,
  199. // posting does not block indefinitely.
  200. if (event_base == s_test_base1 && event_id == TEST_EVENT_BASE1_EV1) {
  201. xSemaphoreTake((SemaphoreHandle_t) arg->mutex, portMAX_DELAY);
  202. TEST_ESP_OK(esp_event_post_to(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  203. TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  204. }
  205. }
  206. }
  207. static void test_handler_unregister_itself(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
  208. {
  209. esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_data;
  210. int* unregistered = (int*) event_handler_arg;
  211. (*unregistered) += (event_base == s_test_base1 ? 0 : 10) + event_id + 1;
  212. // Unregister this handler for this event
  213. TEST_ESP_OK(esp_event_handler_unregister_with(*loop, event_base, event_id, test_handler_unregister_itself));
  214. }
  215. static void test_handler_instance_unregister_itself(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
  216. {
  217. esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_data;
  218. instance_unregister_data_t *unregister_data = (instance_unregister_data_t*) event_handler_arg;
  219. esp_event_handler_instance_t *context = (esp_event_handler_instance_t*) unregister_data->context;
  220. int *count = (int*) unregister_data->data;
  221. (*count)++;
  222. // Unregister this handler for this event
  223. TEST_ESP_OK(esp_event_handler_instance_unregister_with(*loop, event_base, event_id, *context));
  224. }
  225. static void test_post_from_handler_loop_task(void* args)
  226. {
  227. esp_event_loop_handle_t event_loop = (esp_event_loop_handle_t) args;
  228. while(1) {
  229. TEST_ESP_OK(esp_event_loop_run(event_loop, portMAX_DELAY));
  230. }
  231. }
  232. static void test_setup(void)
  233. {
  234. TEST_ASSERT_TRUE(TEST_CONFIG_TASKS_TO_SPAWN >= 2);
  235. TEST_ESP_OK(esp_event_loop_create_default());
  236. }
  237. static void test_teardown(void)
  238. {
  239. TEST_ESP_OK(esp_event_loop_delete_default());
  240. }
  241. TEST_CASE("can create and delete event loops", "[event]")
  242. {
  243. /* this test aims to verify that:
  244. * - creating loops with and without a task succeeds
  245. * - event queue can accomodate the set queue size, and drops the post when exceeded
  246. * - deleting loops with unconsumed posts and unregistered handlers (when unregistration is enabled) does not leak memory */
  247. TEST_SETUP();
  248. esp_event_loop_handle_t loop1; // with dedicated task
  249. esp_event_loop_handle_t loop2; // without dedicated task
  250. esp_event_loop_handle_t loop3; // with leftover post and handlers
  251. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  252. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop1));
  253. loop_args.task_name = NULL;
  254. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop2));
  255. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop3));
  256. TEST_ESP_OK(esp_event_handler_register_with(loop3, s_test_base1, TEST_EVENT_BASE1_EV1, (void*) 0x00000001, NULL));
  257. TEST_ESP_OK(esp_event_handler_register_with(loop3, s_test_base1, TEST_EVENT_BASE1_EV2, (void*) 0x00000002, NULL));
  258. TEST_ESP_OK(esp_event_handler_register_with(loop3, s_test_base2, TEST_EVENT_BASE1_EV1, (void*) 0x00000003, NULL));
  259. for (int i = 0; i < loop_args.queue_size; i++) {
  260. int mod = i % 4;
  261. switch(mod) {
  262. case 0:
  263. TEST_ESP_OK(esp_event_post_to(loop3, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  264. break;
  265. case 1:
  266. TEST_ESP_OK(esp_event_post_to(loop3, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  267. break;
  268. case 2:
  269. TEST_ESP_OK(esp_event_post_to(loop3, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  270. break;
  271. case 3:
  272. TEST_ESP_OK(esp_event_post_to(loop3, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  273. break;
  274. default:
  275. break;
  276. }
  277. }
  278. TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(loop3, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, pdMS_TO_TICKS(10)));
  279. TEST_ESP_OK(esp_event_loop_delete(loop1));
  280. TEST_ESP_OK(esp_event_loop_delete(loop2));
  281. TEST_ESP_OK(esp_event_loop_delete(loop3));
  282. TEST_TEARDOWN();
  283. }
  284. TEST_CASE("registering event handler instance without instance context works", "[event]") {
  285. TEST_SETUP();
  286. esp_event_loop_handle_t loop;
  287. int count_1 = 0;
  288. simple_arg_t arg_1 = {
  289. .data = &count_1,
  290. .mutex = xSemaphoreCreateMutex()
  291. };
  292. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  293. loop_args.task_name = NULL;
  294. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  295. TEST_ESP_OK(esp_event_handler_instance_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg_1, NULL));
  296. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  297. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  298. TEST_ASSERT_EQUAL(1, count_1);
  299. TEST_ESP_OK(esp_event_loop_delete(loop));
  300. vSemaphoreDelete(arg_1.mutex);
  301. TEST_TEARDOWN();
  302. }
  303. TEST_CASE("registering event twice with same handler yields updated handler arg", "[event]") {
  304. TEST_SETUP();
  305. esp_event_loop_handle_t loop;
  306. int count = 0;
  307. simple_arg_t arg = {
  308. .data = &count,
  309. .mutex = xSemaphoreCreateMutex()
  310. };
  311. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  312. loop_args.task_name = NULL;
  313. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  314. /* Register the handler twice to the same base and id but with a different argument (expects to return ESP_OK and log a warning)
  315. * This aims to verify: 1) Handler's argument to be updated
  316. * 2) Registration not to leak memory
  317. */
  318. TEST_ESP_OK(esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, NULL));
  319. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  320. // exec loop, no handler data: count stays 0
  321. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  322. TEST_ASSERT_EQUAL(0, count);
  323. // overriding the former registration of the same event
  324. TEST_ESP_OK(esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg));
  325. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  326. // exec loop, registered handler data exists: count increases
  327. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  328. TEST_ASSERT_EQUAL(1, count);
  329. TEST_ESP_OK(esp_event_loop_delete(loop));
  330. vSemaphoreDelete(arg.mutex);
  331. TEST_TEARDOWN();
  332. }
  333. TEST_CASE("registering event handler instance twice works", "[event]") {
  334. TEST_SETUP();
  335. esp_event_loop_handle_t loop;
  336. int count_1 = 0;
  337. int count_2 = 0;
  338. simple_arg_t arg_1 = {
  339. .data = &count_1,
  340. .mutex = xSemaphoreCreateMutex()
  341. };
  342. simple_arg_t arg_2 = {
  343. .data = &count_2,
  344. .mutex = xSemaphoreCreateMutex()
  345. };
  346. esp_event_handler_instance_t ctx_1;
  347. esp_event_handler_instance_t ctx_2;
  348. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  349. loop_args.task_name = NULL;
  350. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  351. TEST_ESP_OK(esp_event_handler_instance_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg_1, &ctx_1));
  352. TEST_ESP_OK(esp_event_handler_instance_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg_2, &ctx_2));
  353. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  354. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  355. TEST_ASSERT_EQUAL(1, count_1);
  356. TEST_ASSERT_EQUAL(1, count_2);
  357. TEST_ESP_OK(esp_event_loop_delete(loop));
  358. vSemaphoreDelete(arg_1.mutex);
  359. vSemaphoreDelete(arg_2.mutex);
  360. TEST_TEARDOWN();
  361. }
  362. TEST_CASE("registering with ANY_BASE but specific ID fails", "[event]") {
  363. TEST_SETUP();
  364. esp_event_loop_handle_t loop;
  365. int count = 0;
  366. simple_arg_t arg = {
  367. .data = &count,
  368. .mutex = xSemaphoreCreateMutex()
  369. };
  370. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  371. loop_args.task_name = NULL;
  372. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  373. TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
  374. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  375. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  376. TEST_ASSERT_EQUAL(0, count);
  377. TEST_ESP_OK(esp_event_loop_delete(loop));
  378. vSemaphoreDelete(arg.mutex);
  379. TEST_TEARDOWN();
  380. }
  381. TEST_CASE("registering instance with ANY_BASE but specific ID fails", "[event]") {
  382. TEST_SETUP();
  383. esp_event_loop_handle_t loop;
  384. int count = 0;
  385. esp_event_handler_instance_t ctx;
  386. simple_arg_t arg = {
  387. .data = &count,
  388. .mutex = xSemaphoreCreateMutex()
  389. };
  390. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  391. loop_args.task_name = NULL;
  392. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  393. TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_handler_instance_register_with(loop, ESP_EVENT_ANY_BASE, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg, &ctx));
  394. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  395. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  396. TEST_ASSERT_EQUAL(0, count);
  397. TEST_ESP_OK(esp_event_loop_delete(loop));
  398. vSemaphoreDelete(arg.mutex);
  399. TEST_TEARDOWN();
  400. }
  401. TEST_CASE("Check registering ANY_ID", "[event]") {
  402. TEST_SETUP();
  403. esp_event_loop_handle_t loop;
  404. int count = 0;
  405. simple_arg_t arg = {
  406. .data = &count,
  407. .mutex = xSemaphoreCreateMutex()
  408. };
  409. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  410. loop_args.task_name = NULL;
  411. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  412. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg));
  413. // handler shouldn't be triggered with different base
  414. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  415. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  416. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  417. TEST_ASSERT_EQUAL(0, count);
  418. // for all events with correct base, it should be triggered
  419. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  420. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  421. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  422. TEST_ASSERT_EQUAL(2, count);
  423. TEST_ESP_OK(esp_event_loop_delete(loop));
  424. vSemaphoreDelete(arg.mutex);
  425. TEST_TEARDOWN();
  426. }
  427. TEST_CASE("Check registering instance with ANY_ID", "[event]") {
  428. TEST_SETUP();
  429. esp_event_loop_handle_t loop;
  430. int count = 0;
  431. simple_arg_t arg = {
  432. .data = &count,
  433. .mutex = xSemaphoreCreateMutex()
  434. };
  435. esp_event_handler_instance_t ctx;
  436. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  437. loop_args.task_name = NULL;
  438. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  439. TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg, &ctx));
  440. // handler shouldn't be triggered with different base
  441. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  442. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  443. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  444. TEST_ASSERT_EQUAL(0, count);
  445. // for all events with correct base, it should be triggered
  446. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  447. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  448. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  449. TEST_ASSERT_EQUAL(2, count);
  450. TEST_ESP_OK(esp_event_loop_delete(loop));
  451. vSemaphoreDelete(arg.mutex);
  452. TEST_TEARDOWN();
  453. }
  454. TEST_CASE("Check registering specific event", "[event]") {
  455. TEST_SETUP();
  456. esp_event_loop_handle_t loop;
  457. int count = 0;
  458. simple_arg_t arg = {
  459. .data = &count,
  460. .mutex = xSemaphoreCreateMutex()
  461. };
  462. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  463. loop_args.task_name = NULL;
  464. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  465. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
  466. // handler should not be triggered with different base
  467. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  468. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  469. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  470. TEST_ASSERT_EQUAL(0, count);
  471. // for incorrect id, it should not be triggered
  472. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  473. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  474. TEST_ASSERT_EQUAL(0, count);
  475. // for correct event and base, it should be triggered
  476. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  477. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  478. TEST_ASSERT_EQUAL(1, count);
  479. TEST_ESP_OK(esp_event_loop_delete(loop));
  480. vSemaphoreDelete(arg.mutex);
  481. TEST_TEARDOWN();
  482. }
  483. TEST_CASE("Check registering instance with specific event", "[event]") {
  484. TEST_SETUP();
  485. esp_event_loop_handle_t loop;
  486. int count = 0;
  487. simple_arg_t arg = {
  488. .data = &count,
  489. .mutex = xSemaphoreCreateMutex()
  490. };
  491. esp_event_handler_instance_t ctx;
  492. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  493. loop_args.task_name = NULL;
  494. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  495. TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg, &ctx));
  496. // handler should not be triggered with different base
  497. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  498. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  499. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  500. TEST_ASSERT_EQUAL(0, count);
  501. // for incorrect id, it should not be triggered
  502. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  503. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  504. TEST_ASSERT_EQUAL(0, count);
  505. // for correct event and base, it should be triggered
  506. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  507. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  508. TEST_ASSERT_EQUAL(1, count);
  509. TEST_ESP_OK(esp_event_loop_delete(loop));
  510. vSemaphoreDelete(arg.mutex);
  511. TEST_TEARDOWN();
  512. }
  513. TEST_CASE("Specific event is not called when no correct events are posted", "[event]") {
  514. TEST_SETUP();
  515. esp_event_loop_handle_t loop;
  516. int count = 0;
  517. simple_arg_t arg = {
  518. .data = &count,
  519. .mutex = xSemaphoreCreateMutex()
  520. };
  521. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  522. loop_args.task_name = NULL;
  523. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  524. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
  525. // handler should not be triggered by any of these postings
  526. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  527. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  528. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  529. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  530. TEST_ASSERT_EQUAL(0, count);
  531. // Post unknown events.
  532. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_MAX, NULL, 0, portMAX_DELAY));
  533. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_MAX, NULL, 0, portMAX_DELAY));
  534. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  535. TEST_ASSERT_EQUAL(0, count);
  536. TEST_ESP_OK(esp_event_loop_delete(loop));
  537. vSemaphoreDelete(arg.mutex);
  538. TEST_TEARDOWN();
  539. }
  540. TEST_CASE("Specific event instance is not called when no correct events are posted", "[event]") {
  541. TEST_SETUP();
  542. esp_event_loop_handle_t loop;
  543. int count = 0;
  544. simple_arg_t arg = {
  545. .data = &count,
  546. .mutex = xSemaphoreCreateMutex()
  547. };
  548. esp_event_handler_instance_t ctx;
  549. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  550. loop_args.task_name = NULL;
  551. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  552. TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg, &ctx));
  553. // handler should not be triggered by any of these postings
  554. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  555. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  556. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  557. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  558. TEST_ASSERT_EQUAL(0, count);
  559. // Post unknown events.
  560. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_MAX, NULL, 0, portMAX_DELAY));
  561. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_MAX, NULL, 0, portMAX_DELAY));
  562. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  563. TEST_ASSERT_EQUAL(0, count);
  564. TEST_ESP_OK(esp_event_loop_delete(loop));
  565. vSemaphoreDelete(arg.mutex);
  566. TEST_TEARDOWN();
  567. }
  568. TEST_CASE("can register/unregister handlers for all events/all events for a specific base", "[event]")
  569. {
  570. /* this test aims to verify that handlers can be registered to be called on all events
  571. * or for all events with specific bases */
  572. TEST_SETUP();
  573. esp_event_loop_handle_t loop;
  574. int count = 0;
  575. simple_arg_t arg = {
  576. .data = &count,
  577. .mutex = xSemaphoreCreateMutex()
  578. };
  579. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  580. loop_args.task_name = NULL;
  581. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  582. /* Register the handler twice to the same base and id but with a different argument (expects to return ESP_OK and log a warning)
  583. * This aims to verify: 1) Handler's argument to be updated
  584. * 2) Registration not to leak memory
  585. */
  586. TEST_ESP_OK(esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, NULL));
  587. TEST_ESP_OK(esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg));
  588. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg));
  589. TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
  590. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
  591. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler, &arg));
  592. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
  593. TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, NULL, 0, portMAX_DELAY));
  594. TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, s_test_base1, ESP_EVENT_ANY_ID, NULL, 0, portMAX_DELAY));
  595. TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, ESP_EVENT_ANY_BASE, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  596. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY)); // exec loop, base and id level (+3)
  597. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY)); // exec loop, base and id level (+3)
  598. // Post unknown events. Respective loop level and base level handlers should still execute.
  599. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_MAX, NULL, 0, portMAX_DELAY)); // exec loop and base level (+2)
  600. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_MAX, NULL, 0, portMAX_DELAY)); // exec loop level (+1)
  601. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  602. TEST_ASSERT_EQUAL(9, count); // 3 + 3 + 2 + 1
  603. TEST_ESP_OK(esp_event_loop_delete(loop));
  604. vSemaphoreDelete(arg.mutex);
  605. TEST_TEARDOWN();
  606. }
  607. TEST_CASE("can unregister handler", "[event]")
  608. {
  609. /* this test aims to verify that unregistered handlers no longer execute when events are raised */
  610. TEST_SETUP();
  611. esp_event_loop_handle_t loop;
  612. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  613. loop_args.task_name = NULL;
  614. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  615. int count = 0;
  616. simple_arg_t arg = {
  617. .data = &count,
  618. .mutex = xSemaphoreCreateMutex()
  619. };
  620. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
  621. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
  622. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  623. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  624. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  625. TEST_ASSERT_EQUAL(2, count);
  626. TEST_ESP_OK(esp_event_handler_unregister_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler));
  627. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  628. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  629. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  630. TEST_ASSERT_EQUAL(3, count);
  631. TEST_ESP_OK(esp_event_loop_delete(loop));
  632. vSemaphoreDelete(arg.mutex);
  633. TEST_TEARDOWN();
  634. }
  635. TEST_CASE("can unregister handler instance", "[event]")
  636. {
  637. /* this test aims to verify that unregistered handlers no longer execute when events are raised */
  638. TEST_SETUP();
  639. esp_event_loop_handle_t loop;
  640. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  641. loop_args.task_name = NULL;
  642. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  643. int count = 0;
  644. simple_arg_t arg = {
  645. .data = &count,
  646. .mutex = xSemaphoreCreateMutex()
  647. };
  648. esp_event_handler_instance_t ctx;
  649. TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg, &ctx));
  650. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  651. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  652. TEST_ASSERT_EQUAL(1, count);
  653. TEST_ESP_OK(esp_event_handler_instance_unregister_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, ctx));
  654. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  655. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  656. TEST_ASSERT_EQUAL(1, count);
  657. TEST_ESP_OK(esp_event_loop_delete(loop));
  658. vSemaphoreDelete(arg.mutex);
  659. TEST_TEARDOWN();
  660. }
  661. TEST_CASE("handler can unregister itself", "[event]")
  662. {
  663. /* this test aims to verify that handlers can unregister themselves */
  664. TEST_SETUP();
  665. esp_event_loop_handle_t loop;
  666. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  667. loop_args.task_name = NULL;
  668. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  669. int unregistered = 0;
  670. /*
  671. * s_test_base1, ev1 = 1
  672. * s_test_base1, ev2 = 2
  673. * s_test_base2, ev1 = 11
  674. * s_test_base2, ev2 = 12
  675. */
  676. int expected_unregistered = 0;
  677. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_handler_unregister_itself, &unregistered));
  678. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_handler_unregister_itself, &unregistered));
  679. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE2_EV1, test_handler_unregister_itself, &unregistered));
  680. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE2_EV2, test_handler_unregister_itself, &unregistered));
  681. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, &loop, sizeof(loop), portMAX_DELAY));
  682. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  683. expected_unregistered = 2; // base1, ev2
  684. TEST_ASSERT_EQUAL(expected_unregistered, unregistered);
  685. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &loop, sizeof(loop), portMAX_DELAY));
  686. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_EV1, &loop, sizeof(loop), portMAX_DELAY));
  687. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  688. expected_unregistered += 1 + 11; // base1, ev1 + base2, ev1
  689. TEST_ASSERT_EQUAL(expected_unregistered, unregistered);
  690. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_EV2, &loop, sizeof(loop), portMAX_DELAY));
  691. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  692. expected_unregistered += 12; // base2, ev2
  693. TEST_ASSERT_EQUAL(expected_unregistered, unregistered);
  694. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &loop, sizeof(loop), portMAX_DELAY));
  695. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, &loop, sizeof(loop), portMAX_DELAY));
  696. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_EV1, &loop, sizeof(loop), portMAX_DELAY));
  697. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_EV2, &loop, sizeof(loop), portMAX_DELAY));
  698. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  699. TEST_ASSERT_EQUAL(expected_unregistered, unregistered); // all handlers unregistered
  700. TEST_ESP_OK(esp_event_loop_delete(loop));
  701. TEST_TEARDOWN();
  702. }
  703. TEST_CASE("handler instance can unregister itself", "[event]")
  704. {
  705. /* this test aims to verify that handlers can unregister themselves */
  706. TEST_SETUP();
  707. esp_event_loop_handle_t loop;
  708. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  709. loop_args.task_name = NULL;
  710. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  711. esp_event_handler_instance_t ctx;
  712. int count = 0;
  713. instance_unregister_data_t instance_data = {
  714. .context = &ctx,
  715. .data = &count
  716. };
  717. TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_handler_instance_unregister_itself, &instance_data, &ctx));
  718. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &loop, sizeof(loop), portMAX_DELAY));
  719. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  720. TEST_ASSERT_EQUAL(1, count);
  721. vTaskDelay(1000);
  722. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &loop, sizeof(loop), portMAX_DELAY));
  723. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  724. TEST_ASSERT_EQUAL(1, count);
  725. TEST_ESP_OK(esp_event_loop_delete(loop));
  726. TEST_TEARDOWN();
  727. }
  728. TEST_CASE("can exit running loop at approximately the set amount of time", "[event]")
  729. {
  730. /* this test aims to verify that running loop does not block indefinitely in cases where
  731. * events are posted frequently */
  732. TEST_SETUP();
  733. esp_event_loop_handle_t loop;
  734. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  735. loop_args.task_name = NULL;
  736. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  737. performance_data_t handler_data = {
  738. .performed = 0,
  739. .expected = INT32_MAX,
  740. .done = xSemaphoreCreateBinary()
  741. };
  742. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_performance_handler, &handler_data));
  743. post_event_data_t post_event_data = {
  744. .base = s_test_base1,
  745. .id = TEST_EVENT_BASE1_EV1,
  746. .loop = loop,
  747. .num = INT32_MAX
  748. };
  749. task_arg_t post_event_arg = {
  750. .data = &post_event_data,
  751. .done = xSemaphoreCreateBinary(),
  752. .start = xSemaphoreCreateBinary()
  753. };
  754. TaskHandle_t post_task;
  755. xTaskCreatePinnedToCore(test_event_post_task, "post", 2048, &post_event_arg, s_test_priority, &post_task, test_event_get_core());
  756. int runtime_ms = 10;
  757. int runtime_us = runtime_ms * 1000;
  758. int64_t start, diff;
  759. start = esp_timer_get_time();
  760. xSemaphoreGive(post_event_arg.start);
  761. // Run the loop for the runtime_ms set amount of time, regardless of whether events
  762. // are still being posted to the loop.
  763. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(runtime_ms)));
  764. diff = (esp_timer_get_time() - start);
  765. // Threshold is 25 percent.
  766. TEST_ASSERT(diff < runtime_us * 1.25f);
  767. // Verify that the post task still continues
  768. TEST_ASSERT_NOT_EQUAL(pdTRUE, xSemaphoreTake(post_event_arg.done, pdMS_TO_TICKS(10)));
  769. vSemaphoreDelete(post_event_arg.done);
  770. vSemaphoreDelete(post_event_arg.start);
  771. vSemaphoreDelete(handler_data.done);
  772. vTaskDelete(post_task);
  773. TEST_ESP_OK(esp_event_loop_delete(loop));
  774. TEST_TEARDOWN();
  775. }
  776. TEST_CASE("can register/unregister handlers simultaneously", "[event]")
  777. {
  778. /* this test aims to verify that the event handlers list remains consistent despite
  779. * simultaneous access by differenct tasks */
  780. TEST_SETUP();
  781. const char* base = "base";
  782. int32_t id = 0;
  783. esp_event_loop_handle_t loop;
  784. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  785. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  786. ESP_LOGI(TAG, "registering handlers");
  787. handler_registration_data_t* registration_data = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*registration_data));
  788. task_arg_t* registration_arg = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*registration_arg));
  789. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  790. registration_data[i].base = base;
  791. registration_data[i].id = id;
  792. registration_data[i].loop = loop;
  793. registration_data[i].handles = calloc(TEST_CONFIG_ITEMS_TO_REGISTER, sizeof(esp_event_handler_t));
  794. registration_data[i].num = TEST_CONFIG_ITEMS_TO_REGISTER;
  795. registration_data[i].is_registration = true;
  796. for (int j = 0; j < TEST_CONFIG_ITEMS_TO_REGISTER; j++) {
  797. registration_data[i].handles[j] = (void*) (i * TEST_CONFIG_ITEMS_TO_REGISTER) + (j + TEST_CONFIG_ITEMS_TO_REGISTER);
  798. }
  799. registration_arg[i].start = xSemaphoreCreateBinary();
  800. registration_arg[i].done = xSemaphoreCreateBinary();
  801. registration_arg[i].data = &registration_data[i];
  802. xTaskCreatePinnedToCore(test_event_simple_handler_registration_task, "register", 2048, &registration_arg[i], s_test_priority, NULL, test_event_get_core());
  803. }
  804. // Give the semaphores to the spawned registration task
  805. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  806. xSemaphoreGive(registration_arg[i].start);
  807. }
  808. // Take the same semaphores in order to proceed
  809. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  810. xSemaphoreTake(registration_arg[i].done, portMAX_DELAY);
  811. }
  812. ESP_LOGI(TAG, "checking consistency of handlers list");
  813. // Check consistency of events list
  814. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  815. for (int j = 0; j < TEST_CONFIG_ITEMS_TO_REGISTER; j++) {
  816. TEST_ASSERT_TRUE(esp_event_is_handler_registered(loop, base, id, registration_data[i].handles[j]));
  817. }
  818. }
  819. ESP_LOGI(TAG, "unregistering handlers");
  820. /* Test if tasks can unregister simultaneously */
  821. // Unregister registered events
  822. handler_registration_data_t* unregistration_data = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*unregistration_data));
  823. task_arg_t* unregistration_arg = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*unregistration_arg));
  824. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  825. unregistration_data[i].base = base;
  826. unregistration_data[i].id = id;
  827. unregistration_data[i].loop = loop;
  828. unregistration_data[i].handles = calloc(TEST_CONFIG_ITEMS_TO_REGISTER, sizeof(esp_event_handler_t));
  829. unregistration_data[i].num = TEST_CONFIG_ITEMS_TO_REGISTER;
  830. unregistration_data[i].is_registration = false;
  831. memcpy(unregistration_data[i].handles, registration_data[i].handles, TEST_CONFIG_ITEMS_TO_REGISTER * sizeof(esp_event_handler_t));
  832. unregistration_arg[i].data = &unregistration_data[i];
  833. unregistration_arg[i].start = xSemaphoreCreateBinary();
  834. unregistration_arg[i].done = xSemaphoreCreateBinary();
  835. xTaskCreatePinnedToCore(test_event_simple_handler_registration_task, "unregister", 2048, &unregistration_arg[i], s_test_priority, NULL, test_event_get_core());
  836. }
  837. // Give the semaphores to the spawned unregistration task
  838. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  839. xSemaphoreGive(unregistration_arg[i].start);
  840. }
  841. // Take the same semaphores in order to proceed
  842. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  843. xSemaphoreTake(unregistration_arg[i].done, portMAX_DELAY);
  844. }
  845. ESP_LOGI(TAG, "checking consistency of handlers list");
  846. // Check consistency of events list
  847. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  848. for (int j = 0; j < TEST_CONFIG_ITEMS_TO_REGISTER; j++) {
  849. TEST_ASSERT_FALSE(esp_event_is_handler_registered(loop, base, id, registration_data[i].handles[j]));
  850. }
  851. }
  852. // Do cleanup
  853. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  854. free(registration_data[i].handles);
  855. vSemaphoreDelete(registration_arg[i].start);
  856. vSemaphoreDelete(registration_arg[i].done);
  857. free(unregistration_data[i].handles);
  858. vSemaphoreDelete(unregistration_arg[i].start);
  859. vSemaphoreDelete(unregistration_arg[i].done);
  860. }
  861. free(registration_data);
  862. free(unregistration_data);
  863. free(registration_arg);
  864. free(unregistration_arg);
  865. TEST_ESP_OK(esp_event_loop_delete(loop));
  866. TEST_TEARDOWN();
  867. }
  868. TEST_CASE("posting ANY_EVENT or ANY_ID fails", "[event]") {
  869. TEST_SETUP();
  870. esp_event_loop_handle_t loop;
  871. int count = 0;
  872. simple_arg_t arg = {
  873. .data = &count,
  874. .mutex = xSemaphoreCreateMutex()
  875. };
  876. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  877. loop_args.task_name = NULL;
  878. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  879. TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, NULL, 0, portMAX_DELAY));
  880. TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, s_test_base1, ESP_EVENT_ANY_ID, NULL, 0, portMAX_DELAY));
  881. TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, ESP_EVENT_ANY_BASE, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  882. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  883. TEST_ASSERT_EQUAL(0, count);
  884. TEST_ESP_OK(esp_event_loop_delete(loop));
  885. vSemaphoreDelete(arg.mutex);
  886. TEST_TEARDOWN();
  887. }
  888. TEST_CASE("can post and run events", "[event]")
  889. {
  890. /* this test aims to verify that:
  891. * - multiple tasks can post to the queue simultaneously
  892. * - handlers recieve the appropriate handler arg and associated event data */
  893. TEST_SETUP();
  894. esp_event_loop_handle_t loop;
  895. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  896. loop_args.task_name = NULL;
  897. loop_args.queue_size = TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER;
  898. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  899. int count = 0;
  900. simple_arg_t arg = {
  901. .data = &count,
  902. .mutex = xSemaphoreCreateMutex()
  903. };
  904. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
  905. post_event_data_t* post_event_data = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*post_event_data));
  906. task_arg_t* post_event_arg = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*post_event_arg));
  907. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++)
  908. {
  909. post_event_data[i].base = s_test_base1;
  910. post_event_data[i].id = TEST_EVENT_BASE1_EV1;
  911. post_event_data[i].loop = loop;
  912. post_event_data[i].num = TEST_CONFIG_ITEMS_TO_REGISTER;
  913. post_event_arg[i].data = &post_event_data[i];
  914. post_event_arg[i].start = xSemaphoreCreateBinary();
  915. post_event_arg[i].done = xSemaphoreCreateBinary();
  916. xTaskCreatePinnedToCore(test_event_post_task, "post", 2048, &post_event_arg[i], s_test_priority, NULL, test_event_get_core());
  917. }
  918. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  919. xSemaphoreGive(post_event_arg[i].start);
  920. }
  921. // Execute some events as they are posted
  922. for (int i = 0; i < (TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER) / 2; i++) {
  923. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  924. }
  925. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  926. xSemaphoreTake(post_event_arg[i].done, portMAX_DELAY);
  927. }
  928. // Execute the rest
  929. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  930. TEST_ASSERT_EQUAL(TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER, count);
  931. // Cleanup
  932. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  933. vSemaphoreDelete(post_event_arg[i].start);
  934. vSemaphoreDelete(post_event_arg[i].done);
  935. }
  936. free(post_event_data);
  937. free(post_event_arg);
  938. TEST_ESP_OK(esp_event_loop_delete(loop));
  939. vSemaphoreDelete(arg.mutex);
  940. TEST_TEARDOWN();
  941. }
  942. TEST_CASE("can post and run events with instances", "[event]")
  943. {
  944. /* this test aims to verify that:
  945. * - multiple tasks can post to the queue simultaneously
  946. * - handlers recieve the appropriate handler arg and associated event data */
  947. TEST_SETUP();
  948. esp_event_loop_handle_t loop;
  949. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  950. loop_args.task_name = NULL;
  951. loop_args.queue_size = TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER;
  952. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  953. int count = 0;
  954. simple_arg_t arg = {
  955. .data = &count,
  956. .mutex = xSemaphoreCreateMutex()
  957. };
  958. esp_event_handler_instance_t ctx;
  959. TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg, &ctx));
  960. post_event_data_t* post_event_data = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*post_event_data));
  961. task_arg_t* post_event_arg = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*post_event_arg));
  962. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++)
  963. {
  964. post_event_data[i].base = s_test_base1;
  965. post_event_data[i].id = TEST_EVENT_BASE1_EV1;
  966. post_event_data[i].loop = loop;
  967. post_event_data[i].num = TEST_CONFIG_ITEMS_TO_REGISTER;
  968. post_event_arg[i].data = &post_event_data[i];
  969. post_event_arg[i].start = xSemaphoreCreateBinary();
  970. post_event_arg[i].done = xSemaphoreCreateBinary();
  971. xTaskCreatePinnedToCore(test_event_post_task, "post", 2048, &post_event_arg[i], s_test_priority, NULL, test_event_get_core());
  972. }
  973. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  974. xSemaphoreGive(post_event_arg[i].start);
  975. }
  976. // Execute some events as they are posted
  977. for (int i = 0; i < (TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER) / 2; i++) {
  978. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  979. }
  980. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  981. xSemaphoreTake(post_event_arg[i].done, portMAX_DELAY);
  982. }
  983. // Execute the rest
  984. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  985. TEST_ASSERT_EQUAL(TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER, count);
  986. // Cleanup
  987. for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
  988. vSemaphoreDelete(post_event_arg[i].start);
  989. vSemaphoreDelete(post_event_arg[i].done);
  990. }
  991. free(post_event_data);
  992. free(post_event_arg);
  993. TEST_ESP_OK(esp_event_loop_delete(loop));
  994. vSemaphoreDelete(arg.mutex);
  995. TEST_TEARDOWN();
  996. }
  997. static void loop_run_task(void* args)
  998. {
  999. esp_event_loop_handle_t event_loop = (esp_event_loop_handle_t) args;
  1000. while(1) {
  1001. esp_event_loop_run(event_loop, portMAX_DELAY);
  1002. }
  1003. }
  1004. static void performance_test(bool dedicated_task)
  1005. {
  1006. // rand() seems to do a one-time allocation. Call it here so that the memory it allocates
  1007. // is not counted as a leak.
  1008. unsigned int _rand __attribute__((unused)) = rand();
  1009. TEST_SETUP();
  1010. const char test_base[] = "qwertyuiopasdfghjklzxvbnmmnbvcxz";
  1011. #define TEST_CONFIG_BASES (sizeof(test_base) - 1)
  1012. #define TEST_CONFIG_IDS (TEST_CONFIG_BASES / 2)
  1013. // Create loop
  1014. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  1015. esp_event_loop_handle_t loop;
  1016. if (!dedicated_task) {
  1017. loop_args.task_name = NULL;
  1018. }
  1019. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  1020. performance_data_t data;
  1021. // Register the handlers
  1022. for (int base = 0; base < TEST_CONFIG_BASES; base++) {
  1023. for (int id = 0; id < TEST_CONFIG_IDS; id++) {
  1024. TEST_ESP_OK(esp_event_handler_register_with(loop, test_base + base, id, test_event_performance_handler, &data));
  1025. }
  1026. }
  1027. TaskHandle_t mtask = NULL;
  1028. if (!dedicated_task) {
  1029. xTaskCreate(loop_run_task, "loop_run", loop_args.task_stack_size, (void*) loop, loop_args.task_priority, &mtask);
  1030. }
  1031. // Perform performance test
  1032. float running_sum = 0;
  1033. float running_count = 0;
  1034. for (int bases = 1; bases <= TEST_CONFIG_BASES; bases *= 2) {
  1035. for (int ids = 1; ids <= TEST_CONFIG_IDS; ids *= 2) {
  1036. data.performed = 0;
  1037. data.expected = bases * ids;
  1038. data.done = xSemaphoreCreateBinary();
  1039. // Generate randomized list of posts
  1040. int post_bases[TEST_CONFIG_BASES];
  1041. int post_ids[TEST_CONFIG_IDS];
  1042. for (int i = 0; i < bases; i++) {
  1043. post_bases[i] = i;
  1044. }
  1045. for (int i = 0; i < ids; i++) {
  1046. post_ids[i] = i;
  1047. }
  1048. for (int i = 0; i < bases; i++) {
  1049. int rand_a = rand() % bases;
  1050. int rand_b = rand() % bases;
  1051. int temp = post_bases[rand_a];
  1052. post_bases[rand_a]= post_bases[rand_b];
  1053. post_bases[rand_b] = temp;
  1054. }
  1055. for (int i = 0; i < ids; i++) {
  1056. int rand_a = rand() % ids;
  1057. int rand_b = rand() % ids;
  1058. int temp = post_ids[rand_a];
  1059. post_ids[rand_a]= post_ids[rand_b];
  1060. post_ids[rand_b] = temp;
  1061. }
  1062. // Post the events
  1063. int64_t start = esp_timer_get_time();
  1064. for (int base = 0; base < bases; base++) {
  1065. for (int id = 0; id < ids; id++) {
  1066. TEST_ESP_OK(esp_event_post_to(loop, test_base + post_bases[base], post_ids[id], NULL, 0, portMAX_DELAY));
  1067. }
  1068. }
  1069. xSemaphoreTake(data.done, portMAX_DELAY);
  1070. int64_t elapsed = esp_timer_get_time() - start;
  1071. // Record data
  1072. TEST_ASSERT_EQUAL(data.expected, data.performed);
  1073. running_count++;
  1074. running_sum += data.performed / (elapsed / (1000000.0));
  1075. vSemaphoreDelete(data.done);
  1076. }
  1077. }
  1078. int average = (int) (running_sum / (running_count));
  1079. if (!dedicated_task) {
  1080. ((esp_event_loop_instance_t*) loop)->task = mtask;
  1081. }
  1082. TEST_ESP_OK(esp_event_loop_delete(loop));
  1083. TEST_TEARDOWN();
  1084. #ifdef CONFIG_ESP_EVENT_LOOP_PROFILING
  1085. ESP_LOGI(TAG, "events dispatched/second with profiling enabled: %d", average);
  1086. // Enabling profiling will slow down event dispatch, so the set threshold
  1087. // is not valid when it is enabled.
  1088. #else
  1089. #ifndef CONFIG_SPIRAM
  1090. TEST_PERFORMANCE_GREATER_THAN(EVENT_DISPATCH, "%d", average);
  1091. #else
  1092. TEST_PERFORMANCE_GREATER_THAN(EVENT_DISPATCH_PSRAM, "%d", average);
  1093. #endif // CONFIG_SPIRAM
  1094. #endif // CONFIG_ESP_EVENT_LOOP_PROFILING
  1095. }
  1096. TEST_CASE("performance test - dedicated task", "[event]")
  1097. {
  1098. performance_test(true);
  1099. }
  1100. TEST_CASE("performance test - no dedicated task", "[event]")
  1101. {
  1102. performance_test(false);
  1103. }
  1104. TEST_CASE("can post to loop from handler - dedicated task", "[event]")
  1105. {
  1106. TEST_SETUP();
  1107. esp_event_loop_handle_t loop_w_task;
  1108. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  1109. int count;
  1110. simple_arg_t arg = {
  1111. .data = &count,
  1112. .mutex = xSemaphoreCreateBinary()
  1113. };
  1114. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop_w_task));
  1115. count = 0;
  1116. // Test that a handler can post to a different loop while there is still slots on the queue
  1117. TEST_ESP_OK(esp_event_handler_register_with(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV1, test_handler_post_w_task, &arg));
  1118. TEST_ESP_OK(esp_event_handler_register_with(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, test_handler_post_w_task, &arg));
  1119. TEST_ESP_OK(esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV1, &loop_w_task, sizeof(&loop_w_task), portMAX_DELAY));
  1120. xSemaphoreTake(arg.mutex, portMAX_DELAY);
  1121. TEST_ASSERT_EQUAL(2, count);
  1122. // Test that other tasks can still post while there is still slots in the queue, while handler is executing
  1123. count = 100;
  1124. TEST_ESP_OK(esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV1, &loop_w_task, sizeof(&loop_w_task), portMAX_DELAY));
  1125. for (int i = 0; i < loop_args.queue_size; i++) {
  1126. TEST_ESP_OK(esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  1127. }
  1128. TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0,
  1129. pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER)));
  1130. xSemaphoreGive(arg.mutex);
  1131. vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
  1132. TEST_ESP_OK(esp_event_loop_delete(loop_w_task));
  1133. vSemaphoreDelete(arg.mutex);
  1134. TEST_TEARDOWN();
  1135. }
  1136. TEST_CASE("can post to loop from handler instance - dedicated task", "[event]")
  1137. {
  1138. TEST_SETUP();
  1139. esp_event_loop_handle_t loop_w_task;
  1140. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  1141. int count;
  1142. simple_arg_t arg = {
  1143. .data = &count,
  1144. .mutex = xSemaphoreCreateBinary()
  1145. };
  1146. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop_w_task));
  1147. count = 0;
  1148. esp_event_handler_instance_t ctx_1;
  1149. esp_event_handler_instance_t ctx_2;
  1150. // Test that a handler can post to a different loop while there is still slots on the queue
  1151. TEST_ESP_OK(esp_event_handler_instance_register_with(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV1, test_handler_post_w_task, &arg, &ctx_1));
  1152. TEST_ESP_OK(esp_event_handler_instance_register_with(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, test_handler_post_w_task, &arg, &ctx_2));
  1153. TEST_ESP_OK(esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV1, &loop_w_task, sizeof(&loop_w_task), portMAX_DELAY));
  1154. xSemaphoreTake(arg.mutex, portMAX_DELAY);
  1155. TEST_ASSERT_EQUAL(2, count);
  1156. // Test that other tasks can still post while there is still slots in the queue, while handler is executing
  1157. count = 100;
  1158. TEST_ESP_OK(esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV1, &loop_w_task, sizeof(&loop_w_task), portMAX_DELAY));
  1159. for (int i = 0; i < loop_args.queue_size; i++) {
  1160. TEST_ESP_OK(esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  1161. }
  1162. TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0,
  1163. pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER)));
  1164. xSemaphoreGive(arg.mutex);
  1165. vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
  1166. TEST_ESP_OK(esp_event_loop_delete(loop_w_task));
  1167. vSemaphoreDelete(arg.mutex);
  1168. TEST_TEARDOWN();
  1169. }
  1170. TEST_CASE("can post to loop from handler - no dedicated task", "[event]")
  1171. {
  1172. TEST_SETUP();
  1173. esp_event_loop_handle_t loop_wo_task;
  1174. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  1175. int count;
  1176. simple_arg_t arg = {
  1177. .data = &count,
  1178. .mutex = xSemaphoreCreateBinary()
  1179. };
  1180. count = 0;
  1181. loop_args.queue_size = 1;
  1182. loop_args.task_name = NULL;
  1183. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop_wo_task));
  1184. TaskHandle_t mtask;
  1185. xTaskCreate(test_post_from_handler_loop_task, "task", 2584, (void*) loop_wo_task, s_test_priority, &mtask);
  1186. // Test that a handler can post to a different loop while there is still slots on the queue
  1187. TEST_ESP_OK(esp_event_handler_register_with(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV1, test_handler_post_wo_task, &arg));
  1188. TEST_ESP_OK(esp_event_handler_register_with(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV2, test_handler_post_wo_task, &arg));
  1189. TEST_ESP_OK(esp_event_post_to(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV1, &loop_wo_task, sizeof(&loop_wo_task), portMAX_DELAY));
  1190. xSemaphoreTake(arg.mutex, portMAX_DELAY);
  1191. TEST_ASSERT_EQUAL(2, count);
  1192. count = 100;
  1193. TEST_ESP_OK(esp_event_post_to(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV1, &loop_wo_task, sizeof(&loop_wo_task), portMAX_DELAY));
  1194. vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
  1195. // For loop without tasks, posting is more restrictive. Posting should wait until execution of handler finishes
  1196. TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0,
  1197. pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER)));
  1198. xSemaphoreGive(arg.mutex);
  1199. vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
  1200. vTaskDelete(mtask);
  1201. TEST_ESP_OK(esp_event_loop_delete(loop_wo_task));
  1202. vSemaphoreDelete(arg.mutex);
  1203. TEST_TEARDOWN();
  1204. }
  1205. TEST_CASE("can post to loop from handler instance - no dedicated task", "[event]")
  1206. {
  1207. TEST_SETUP();
  1208. esp_event_loop_handle_t loop_wo_task;
  1209. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  1210. int count;
  1211. simple_arg_t arg = {
  1212. .data = &count,
  1213. .mutex = xSemaphoreCreateBinary()
  1214. };
  1215. count = 0;
  1216. esp_event_handler_instance_t ctx_1;
  1217. esp_event_handler_instance_t ctx_2;
  1218. loop_args.queue_size = 1;
  1219. loop_args.task_name = NULL;
  1220. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop_wo_task));
  1221. TaskHandle_t mtask;
  1222. xTaskCreate(test_post_from_handler_loop_task, "task", 2584, (void*) loop_wo_task, s_test_priority, &mtask);
  1223. // Test that a handler can post to a different loop while there is still slots on the queue
  1224. TEST_ESP_OK(esp_event_handler_instance_register_with(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV1, test_handler_post_wo_task, &arg, &ctx_1));
  1225. TEST_ESP_OK(esp_event_handler_instance_register_with(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV2, test_handler_post_wo_task, &arg, &ctx_2));
  1226. TEST_ESP_OK(esp_event_post_to(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV1, &loop_wo_task, sizeof(&loop_wo_task), portMAX_DELAY));
  1227. xSemaphoreTake(arg.mutex, portMAX_DELAY);
  1228. TEST_ASSERT_EQUAL(2, count);
  1229. count = 100;
  1230. TEST_ESP_OK(esp_event_post_to(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV1, &loop_wo_task, sizeof(&loop_wo_task), portMAX_DELAY));
  1231. vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
  1232. // For loop without tasks, posting is more restrictive. Posting should wait until execution of handler finishes
  1233. TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0,
  1234. pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER)));
  1235. xSemaphoreGive(arg.mutex);
  1236. vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
  1237. vTaskDelete(mtask);
  1238. TEST_ESP_OK(esp_event_loop_delete(loop_wo_task));
  1239. vSemaphoreDelete(arg.mutex);
  1240. TEST_TEARDOWN();
  1241. }
  1242. static void test_event_simple_handler_template(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
  1243. {
  1244. int* count = (int*) handler_arg;
  1245. (*count)++;
  1246. }
  1247. static void test_event_simple_handler_1(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
  1248. {
  1249. test_event_simple_handler_template(handler_arg, base, id, event_arg);
  1250. }
  1251. static void test_event_simple_handler_3(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
  1252. {
  1253. test_event_simple_handler_template(handler_arg, base, id, event_arg);
  1254. }
  1255. static void test_event_simple_handler_2(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
  1256. {
  1257. test_event_simple_handler_template(handler_arg, base, id, event_arg);
  1258. }
  1259. static void test_registration_from_handler_hdlr(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
  1260. {
  1261. esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_arg;
  1262. TEST_ESP_OK(esp_event_handler_register_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_1, handler_arg));
  1263. TEST_ESP_OK(esp_event_handler_register_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_2, handler_arg));
  1264. TEST_ESP_OK(esp_event_handler_register_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_3, handler_arg));
  1265. }
  1266. static void test_unregistration_from_handler_hdlr(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
  1267. {
  1268. esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_arg;
  1269. TEST_ESP_OK(esp_event_handler_unregister_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_1));
  1270. TEST_ESP_OK(esp_event_handler_unregister_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_2));
  1271. TEST_ESP_OK(esp_event_handler_unregister_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_3));
  1272. }
  1273. TEST_CASE("can register from handler", "[event]")
  1274. {
  1275. TEST_SETUP();
  1276. esp_event_loop_handle_t loop;
  1277. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  1278. loop_args.task_name = NULL;
  1279. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  1280. int count = 0;
  1281. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_registration_from_handler_hdlr, &count));
  1282. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE2_EV1, test_unregistration_from_handler_hdlr, &count));
  1283. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &loop, sizeof(&loop), portMAX_DELAY));
  1284. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  1285. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  1286. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  1287. TEST_ASSERT_EQUAL(3, count);
  1288. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_EV1, &loop, sizeof(&loop), portMAX_DELAY));
  1289. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  1290. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  1291. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  1292. TEST_ASSERT_EQUAL(3, count);
  1293. TEST_ESP_OK(esp_event_loop_delete(loop));
  1294. TEST_TEARDOWN();
  1295. }
  1296. static void test_create_loop_handler(void* handler_args, esp_event_base_t base, int32_t id, void* event_data)
  1297. {
  1298. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  1299. if (id == TEST_EVENT_BASE1_EV1) {
  1300. TEST_ESP_OK(esp_event_loop_create(&loop_args, (esp_event_loop_handle_t*) handler_args));
  1301. } else {
  1302. TEST_ESP_OK(esp_event_loop_delete(*((esp_event_loop_handle_t*) handler_args)));
  1303. }
  1304. }
  1305. TEST_CASE("can create and delete loop from handler", "[event]")
  1306. {
  1307. TEST_SETUP();
  1308. esp_event_loop_handle_t loop;
  1309. esp_event_loop_handle_t test_loop;
  1310. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  1311. loop_args.task_name = NULL;
  1312. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  1313. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_create_loop_handler, &test_loop));
  1314. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_create_loop_handler, &test_loop));
  1315. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  1316. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  1317. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
  1318. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  1319. TEST_ESP_OK(esp_event_loop_delete(loop));
  1320. TEST_TEARDOWN();
  1321. }
  1322. TEST_CASE("events are dispatched in the order they are registered", "[event]")
  1323. {
  1324. TEST_SETUP();
  1325. esp_event_loop_handle_t loop;
  1326. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  1327. loop_args.task_name = NULL;
  1328. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  1329. int id_arr[7];
  1330. for (int i = 0; i < 7; i++) {
  1331. id_arr[i] = i;
  1332. }
  1333. int data_arr[12] = {0};
  1334. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE2_EV1, test_event_ordered_dispatch, id_arr + 0));
  1335. TEST_ESP_OK(esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_ordered_dispatch, id_arr + 1));
  1336. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, ESP_EVENT_ANY_ID, test_event_ordered_dispatch, id_arr + 2));
  1337. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE2_EV2, test_event_ordered_dispatch, id_arr + 3));
  1338. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_ordered_dispatch, id_arr + 4));
  1339. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, ESP_EVENT_ANY_ID, test_event_ordered_dispatch, id_arr + 5));
  1340. TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_ordered_dispatch, id_arr + 6));
  1341. esp_event_dump(stdout);
  1342. ordered_data_t data = {
  1343. .arr = data_arr,
  1344. .index = 0
  1345. };
  1346. ordered_data_t* dptr = &data;
  1347. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, &dptr, sizeof(dptr), portMAX_DELAY));
  1348. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &dptr, sizeof(dptr), portMAX_DELAY));
  1349. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, &dptr, sizeof(dptr), portMAX_DELAY));
  1350. TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, &dptr, sizeof(dptr), portMAX_DELAY));
  1351. TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
  1352. // Expected data executing the posts above
  1353. int ref_arr[12] = {1, 3, 5, 1, 2, 4, 1, 2, 6, 0, 1, 5};
  1354. for (int i = 0; i < 12; i++) {
  1355. TEST_ASSERT_EQUAL(ref_arr[i], data_arr[i]);
  1356. }
  1357. TEST_ESP_OK(esp_event_loop_delete(loop));
  1358. TEST_TEARDOWN();
  1359. }
  1360. #if CONFIG_ESP_EVENT_POST_FROM_ISR
  1361. TEST_CASE("can properly prepare event data posted to loop", "[event]")
  1362. {
  1363. TEST_SETUP();
  1364. esp_event_loop_handle_t loop;
  1365. esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
  1366. loop_args.task_name = NULL;
  1367. TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
  1368. esp_event_post_instance_t post;
  1369. esp_event_loop_instance_t* loop_def = (esp_event_loop_instance_t*) loop;
  1370. TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
  1371. TEST_ASSERT_EQUAL(pdTRUE, xQueueReceive(loop_def->queue, &post, portMAX_DELAY));
  1372. TEST_ASSERT_EQUAL(false, post.data_set);
  1373. TEST_ASSERT_EQUAL(false, post.data_allocated);
  1374. TEST_ASSERT_EQUAL(NULL, post.data.ptr);
  1375. int sample = 0;
  1376. TEST_ESP_OK(esp_event_isr_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &sample, sizeof(sample), NULL));
  1377. TEST_ASSERT_EQUAL(pdTRUE, xQueueReceive(loop_def->queue, &post, portMAX_DELAY));
  1378. TEST_ASSERT_EQUAL(true, post.data_set);
  1379. TEST_ASSERT_EQUAL(false, post.data_allocated);
  1380. TEST_ASSERT_EQUAL(false, post.data.val);
  1381. TEST_ESP_OK(esp_event_loop_delete(loop));
  1382. TEST_TEARDOWN();
  1383. }
  1384. static void test_handler_post_from_isr(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
  1385. {
  1386. SemaphoreHandle_t *sem = (SemaphoreHandle_t*) event_handler_arg;
  1387. // Event data is just the address value (maybe have been truncated due to casting).
  1388. int *data = (int*) event_data;
  1389. TEST_ASSERT_EQUAL(*data, (int) (*sem));
  1390. xSemaphoreGive(*sem);
  1391. }
  1392. bool test_event_on_timer_alarm(gptimer_handle_t timer, const gptimer_alarm_event_data_t *edata, void *user_ctx)
  1393. {
  1394. int data = (int)user_ctx;
  1395. gptimer_stop(timer);
  1396. // Posting events with data more than 4 bytes should fail.
  1397. TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_isr_post(s_test_base1, TEST_EVENT_BASE1_EV1, &data, 5, NULL));
  1398. // This should succeedd, as data is int-sized. The handler for the event checks that the passed event data
  1399. // is correct.
  1400. BaseType_t task_unblocked;
  1401. TEST_ESP_OK(esp_event_isr_post(s_test_base1, TEST_EVENT_BASE1_EV1, &data, sizeof(data), &task_unblocked));
  1402. return task_unblocked == pdTRUE;
  1403. }
  1404. TEST_CASE("can post events from interrupt handler", "[event]")
  1405. {
  1406. SemaphoreHandle_t sem = xSemaphoreCreateBinary();
  1407. gptimer_handle_t gptimer = NULL;
  1408. /* Select and initialize basic parameters of the timer */
  1409. gptimer_config_t config = {
  1410. .clk_src = GPTIMER_CLK_SRC_DEFAULT,
  1411. .direction = GPTIMER_COUNT_UP,
  1412. .resolution_hz = 1000000, // 1MHz, 1 tick = 1us
  1413. };
  1414. TEST_ESP_OK(gptimer_new_timer(&config, &gptimer));
  1415. gptimer_alarm_config_t alarm_config = {
  1416. .reload_count = 0,
  1417. .alarm_count = 500000,
  1418. };
  1419. gptimer_event_callbacks_t cbs = {
  1420. .on_alarm = test_event_on_timer_alarm
  1421. };
  1422. TEST_ESP_OK(gptimer_register_event_callbacks(gptimer, &cbs, sem));
  1423. TEST_ESP_OK(gptimer_set_alarm_action(gptimer, &alarm_config));
  1424. TEST_ESP_OK(gptimer_enable(gptimer));
  1425. TEST_ESP_OK(gptimer_start(gptimer));
  1426. TEST_SETUP();
  1427. TEST_ESP_OK(esp_event_handler_register(s_test_base1, TEST_EVENT_BASE1_EV1,
  1428. test_handler_post_from_isr, &sem));
  1429. xSemaphoreTake(sem, portMAX_DELAY);
  1430. TEST_TEARDOWN();
  1431. TEST_ESP_OK(gptimer_disable(gptimer));
  1432. TEST_ESP_OK(gptimer_del_timer(gptimer));
  1433. }
  1434. #endif // CONFIG_ESP_EVENT_POST_FROM_ISR
  1435. #endif //!TEMPORARY_DISABLED_FOR_TARGETS(ESP32C2)