| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034 |
- #include <stdbool.h>
- #include <string.h>
- #include "esp_event.h"
- #include "sdkconfig.h"
- #include "freertos/FreeRTOS.h"
- #include "freertos/task.h"
- #include "esp_log.h"
- #include "driver/periph_ctrl.h"
- #include "driver/timer.h"
- #include "esp_event.h"
- #include "esp_event_private.h"
- #include "esp_event_internal.h"
- #include "esp_heap_caps.h"
- #include "esp_timer.h"
- #include "sdkconfig.h"
- #include "unity.h"
- #include "test_utils.h"
- static const char* TAG = "test_event";
- #define TEST_CONFIG_ITEMS_TO_REGISTER 5
- #define TEST_CONFIG_TASKS_TO_SPAWN 2
- #define TEST_CONFIG_WAIT_MULTIPLIER 5
- // The initial logging "initializing test" is to ensure mutex allocation is not counted against memory not being freed
- // during teardown.
- #define TEST_SETUP() \
- ESP_LOGI(TAG, "initializing test"); \
- size_t free_mem_before = heap_caps_get_free_size(MALLOC_CAP_DEFAULT); \
- test_setup(); \
- s_test_core_id = xPortGetCoreID(); \
- s_test_priority = uxTaskPriorityGet(NULL);
- #define TEST_TEARDOWN() \
- test_teardown(); \
- vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER)); \
- TEST_ASSERT_EQUAL(free_mem_before, heap_caps_get_free_size(MALLOC_CAP_DEFAULT));
- typedef struct {
- void* data;
- SemaphoreHandle_t start;
- SemaphoreHandle_t done;
- } task_arg_t;
- typedef struct {
- esp_event_base_t base;
- int32_t id;
- esp_event_handler_t* handles;
- int32_t num;
- esp_event_loop_handle_t loop;
- bool is_registration;
- } handler_registration_data_t;
- typedef struct {
- esp_event_base_t base;
- int32_t id;
- esp_event_loop_handle_t loop;
- int32_t num;
- } post_event_data_t;
- typedef struct {
- int performed;
- int expected;
- SemaphoreHandle_t done;
- } performance_data_t;
- typedef struct {
- void* data;
- SemaphoreHandle_t mutex;
- } simple_arg_t;
- typedef struct {
- esp_event_handler_instance_t *context;
- void* data;
- } instance_unregister_data_t;
- typedef struct {
- int *arr;
- int index;
- } ordered_data_t;
- static BaseType_t s_test_core_id;
- static UBaseType_t s_test_priority;
- ESP_EVENT_DECLARE_BASE(s_test_base1);
- ESP_EVENT_DECLARE_BASE(s_test_base2);
- ESP_EVENT_DEFINE_BASE(s_test_base1);
- ESP_EVENT_DEFINE_BASE(s_test_base2);
- enum {
- TEST_EVENT_BASE1_EV1,
- TEST_EVENT_BASE1_EV2,
- TEST_EVENT_BASE1_MAX
- };
- enum {
- TEST_EVENT_BASE2_EV1,
- TEST_EVENT_BASE2_EV2,
- TEST_EVENT_BASE2_MAX
- };
- static BaseType_t test_event_get_core(void)
- {
- static int calls = 0;
- if (portNUM_PROCESSORS > 1) {
- return (s_test_core_id + calls++) % portNUM_PROCESSORS;
- } else {
- return s_test_core_id;
- }
- }
- static esp_event_loop_args_t test_event_get_default_loop_args(void)
- {
- esp_event_loop_args_t loop_config = {
- .queue_size = CONFIG_ESP_SYSTEM_EVENT_QUEUE_SIZE,
- .task_name = "loop",
- .task_priority = s_test_priority,
- .task_stack_size = 2048,
- .task_core_id = test_event_get_core()
- };
- return loop_config;
- }
- static void test_event_simple_handler(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
- {
- if (!event_handler_arg) {
- return;
- }
- simple_arg_t* arg = (simple_arg_t*) event_handler_arg;
- xSemaphoreTake(arg->mutex, portMAX_DELAY);
- int* count = (int*) arg->data;
- if (event_data == NULL) {
- (*count)++;
- } else {
- (*count) += *((int*) event_data);
- }
- xSemaphoreGive(arg->mutex);
- }
- static void test_event_ordered_dispatch(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
- {
- int *arg = (int*) event_handler_arg;
- ordered_data_t *data = *((ordered_data_t**) (event_data));
- data->arr[data->index++] = *arg;
- }
- static void test_event_performance_handler(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
- {
- performance_data_t* data = (performance_data_t*) event_handler_arg;
- data->performed++;
- if (data->performed >= data->expected) {
- xSemaphoreGive(data->done);
- }
- }
- static void test_event_post_task(void* args)
- {
- task_arg_t* arg = (task_arg_t*) args;
- post_event_data_t* data = arg->data;
- xSemaphoreTake(arg->start, portMAX_DELAY);
- for (int i = 0; i < data->num; i++) {
- TEST_ESP_OK(esp_event_post_to(data->loop, data->base, data->id, NULL, 0, portMAX_DELAY));
- vTaskDelay(1);
- }
- xSemaphoreGive(arg->done);
- vTaskDelete(NULL);
- }
- static void test_event_simple_handler_registration_task(void* args)
- {
- task_arg_t* arg = (task_arg_t*) args;
- handler_registration_data_t* data = (handler_registration_data_t*) arg->data;
- xSemaphoreTake(arg->start, portMAX_DELAY);
- for(int i = 0; i < data->num; i++) {
- if (data->is_registration) {
- TEST_ESP_OK(esp_event_handler_register_with(data->loop, data->base, data->id, data->handles[i], NULL));
- } else {
- TEST_ESP_OK(esp_event_handler_unregister_with(data->loop, data->base, data->id, data->handles[i]));
- }
- vTaskDelay(1);
- }
- xSemaphoreGive(arg->done);
- vTaskDelete(NULL);
- }
- static void test_handler_post_w_task(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
- {
- simple_arg_t* arg = (simple_arg_t*) event_handler_arg;
- esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_data;
- int* count = (int*) arg->data;
- (*count)++;
- if (*count <= 2) {
- if (event_base == s_test_base1 && event_id == TEST_EVENT_BASE1_EV1) {
- TEST_ESP_OK(esp_event_post_to(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- } else{
- xSemaphoreGive((SemaphoreHandle_t) arg->mutex);
- }
- } else {
- // Test that once the queue is full and the handler attempts to post to the same loop,
- // posting does not block indefinitely.
- if (event_base == s_test_base1 && event_id == TEST_EVENT_BASE1_EV1) {
- xSemaphoreTake((SemaphoreHandle_t) arg->mutex, portMAX_DELAY);
- TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- }
- }
- }
- static void test_handler_post_wo_task(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
- {
- simple_arg_t* arg = (simple_arg_t*) event_handler_arg;
- esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_data;
- int* count = (int*) arg->data;
- (*count)++;
- if (*count <= 2) {
- if (event_base == s_test_base1 && event_id == TEST_EVENT_BASE1_EV1) {
- TEST_ESP_OK(esp_event_post_to(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- } else{
- xSemaphoreGive((SemaphoreHandle_t) arg->mutex);
- }
- } else {
- // Test that once the queue is full and the handler attempts to post to the same loop,
- // posting does not block indefinitely.
- if (event_base == s_test_base1 && event_id == TEST_EVENT_BASE1_EV1) {
- xSemaphoreTake((SemaphoreHandle_t) arg->mutex, portMAX_DELAY);
- TEST_ESP_OK(esp_event_post_to(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- }
- }
- }
- static void test_handler_unregister_itself(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
- {
- esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_data;
- int* unregistered = (int*) event_handler_arg;
- (*unregistered) += (event_base == s_test_base1 ? 0 : 10) + event_id + 1;
- // Unregister this handler for this event
- TEST_ESP_OK(esp_event_handler_unregister_with(*loop, event_base, event_id, test_handler_unregister_itself));
- }
- static void test_handler_instance_unregister_itself(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
- {
- esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_data;
- instance_unregister_data_t *unregister_data = (instance_unregister_data_t*) event_handler_arg;
- esp_event_handler_instance_t *context = (esp_event_handler_instance_t*) unregister_data->context;
- int *count = (int*) unregister_data->data;
- (*count)++;
- // Unregister this handler for this event
- TEST_ESP_OK(esp_event_handler_instance_unregister_with(*loop, event_base, event_id, *context));
- }
- static void test_post_from_handler_loop_task(void* args)
- {
- esp_event_loop_handle_t event_loop = (esp_event_loop_handle_t) args;
- while(1) {
- TEST_ESP_OK(esp_event_loop_run(event_loop, portMAX_DELAY));
- }
- }
- static void test_setup(void)
- {
- TEST_ASSERT_TRUE(TEST_CONFIG_TASKS_TO_SPAWN >= 2);
- TEST_ESP_OK(esp_event_loop_create_default());
- }
- static void test_teardown(void)
- {
- TEST_ESP_OK(esp_event_loop_delete_default());
- }
- #define TIMER_DIVIDER 16 // Hardware timer clock divider
- #define TIMER_SCALE (TIMER_BASE_CLK / TIMER_DIVIDER) // convert counter value to seconds
- #define TIMER_INTERVAL0_SEC (2.0) // sample test interval for the first timer
- TEST_CASE("can create and delete event loops", "[event]")
- {
- /* this test aims to verify that:
- * - creating loops with and without a task succeeds
- * - event queue can accomodate the set queue size, and drops the post when exceeded
- * - deleting loops with unconsumed posts and unregistered handlers (when unregistration is enabled) does not leak memory */
- TEST_SETUP();
- esp_event_loop_handle_t loop1; // with dedicated task
- esp_event_loop_handle_t loop2; // without dedicated task
- esp_event_loop_handle_t loop3; // with leftover post and handlers
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop1));
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop2));
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop3));
- TEST_ESP_OK(esp_event_handler_register_with(loop3, s_test_base1, TEST_EVENT_BASE1_EV1, (void*) 0x00000001, NULL));
- TEST_ESP_OK(esp_event_handler_register_with(loop3, s_test_base1, TEST_EVENT_BASE1_EV2, (void*) 0x00000002, NULL));
- TEST_ESP_OK(esp_event_handler_register_with(loop3, s_test_base2, TEST_EVENT_BASE1_EV1, (void*) 0x00000003, NULL));
- for (int i = 0; i < loop_args.queue_size; i++) {
- int mod = i % 4;
- switch(mod) {
- case 0:
- TEST_ESP_OK(esp_event_post_to(loop3, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- break;
- case 1:
- TEST_ESP_OK(esp_event_post_to(loop3, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- break;
- case 2:
- TEST_ESP_OK(esp_event_post_to(loop3, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- break;
- case 3:
- TEST_ESP_OK(esp_event_post_to(loop3, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- break;
- default:
- break;
- }
- }
- TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(loop3, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, pdMS_TO_TICKS(10)));
- TEST_ESP_OK(esp_event_loop_delete(loop1));
- TEST_ESP_OK(esp_event_loop_delete(loop2));
- TEST_ESP_OK(esp_event_loop_delete(loop3));
- TEST_TEARDOWN();
- }
- TEST_CASE("registering event handler instance without instance context works", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count_1 = 0;
- simple_arg_t arg_1 = {
- .data = &count_1,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- 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));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(1, count_1);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg_1.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("registering event twice with same handler yields updated handler arg", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- /* Register the handler twice to the same base and id but with a different argument (expects to return ESP_OK and log a warning)
- * This aims to verify: 1) Handler's argument to be updated
- * 2) Registration not to leak memory
- */
- TEST_ESP_OK(esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, NULL));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- // exec loop, no handler data: count stays 0
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- // overriding the former registration of the same event
- TEST_ESP_OK(esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- // exec loop, registered handler data exists: count increases
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(1, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("registering event handler instance twice works", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count_1 = 0;
- int count_2 = 0;
- simple_arg_t arg_1 = {
- .data = &count_1,
- .mutex = xSemaphoreCreateMutex()
- };
- simple_arg_t arg_2 = {
- .data = &count_2,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_handler_instance_t ctx_1;
- esp_event_handler_instance_t ctx_2;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- 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));
- 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));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(1, count_1);
- TEST_ASSERT_EQUAL(1, count_2);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg_1.mutex);
- vSemaphoreDelete(arg_2.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("registering with ANY_BASE but specific ID fails", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- 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));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("registering instance with ANY_BASE but specific ID fails", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- esp_event_handler_instance_t ctx;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- 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));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("Check registering ANY_ID", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg));
- // handler shouldn't be triggered with different base
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- // for all events with correct base, it should be triggered
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(2, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("Check registering instance with ANY_ID", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_handler_instance_t ctx;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg, &ctx));
- // handler shouldn't be triggered with different base
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- // for all events with correct base, it should be triggered
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(2, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("Check registering specific event", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
- // handler should not be triggered with different base
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- // for incorrect id, it should not be triggered
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- // for correct event and base, it should be triggered
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(1, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("Check registering instance with specific event", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_handler_instance_t ctx;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg, &ctx));
- // handler should not be triggered with different base
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- // for incorrect id, it should not be triggered
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- // for correct event and base, it should be triggered
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(1, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("Specific event is not called when no correct events are posted", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
- // handler should not be triggered by any of these postings
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- // Post unknown events.
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_MAX, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_MAX, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("Specific event instance is not called when no correct events are posted", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_handler_instance_t ctx;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg, &ctx));
- // handler should not be triggered by any of these postings
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- // Post unknown events.
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_MAX, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_MAX, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("can register/unregister handlers for all events/all events for a specific base", "[event]")
- {
- /* this test aims to verify that handlers can be registered to be called on all events
- * or for all events with specific bases */
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- /* Register the handler twice to the same base and id but with a different argument (expects to return ESP_OK and log a warning)
- * This aims to verify: 1) Handler's argument to be updated
- * 2) Registration not to leak memory
- */
- TEST_ESP_OK(esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, NULL));
- TEST_ESP_OK(esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, ESP_EVENT_ANY_ID, test_event_simple_handler, &arg));
- 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));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler, &arg));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
- TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, NULL, 0, portMAX_DELAY));
- TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, s_test_base1, ESP_EVENT_ANY_ID, NULL, 0, portMAX_DELAY));
- TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, ESP_EVENT_ANY_BASE, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- 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)
- 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)
- // Post unknown events. Respective loop level and base level handlers should still execute.
- 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)
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_MAX, NULL, 0, portMAX_DELAY)); // exec loop level (+1)
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(9, count); // 3 + 3 + 2 + 1
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("can unregister handler", "[event]")
- {
- /* this test aims to verify that unregistered handlers no longer execute when events are raised */
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(2, count);
- TEST_ESP_OK(esp_event_handler_unregister_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(3, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("can unregister handler instance", "[event]")
- {
- /* this test aims to verify that unregistered handlers no longer execute when events are raised */
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_handler_instance_t ctx;
- TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg, &ctx));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(1, count);
- TEST_ESP_OK(esp_event_handler_instance_unregister_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, ctx));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(1, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("handler can unregister itself", "[event]")
- {
- /* this test aims to verify that handlers can unregister themselves */
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- int unregistered = 0;
- /*
- * s_test_base1, ev1 = 1
- * s_test_base1, ev2 = 2
- * s_test_base2, ev1 = 11
- * s_test_base2, ev2 = 12
- */
- int expected_unregistered = 0;
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_handler_unregister_itself, &unregistered));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_handler_unregister_itself, &unregistered));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE2_EV1, test_handler_unregister_itself, &unregistered));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE2_EV2, test_handler_unregister_itself, &unregistered));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, &loop, sizeof(loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- expected_unregistered = 2; // base1, ev2
- TEST_ASSERT_EQUAL(expected_unregistered, unregistered);
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &loop, sizeof(loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_EV1, &loop, sizeof(loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- expected_unregistered += 1 + 11; // base1, ev1 + base2, ev1
- TEST_ASSERT_EQUAL(expected_unregistered, unregistered);
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_EV2, &loop, sizeof(loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- expected_unregistered += 12; // base2, ev2
- TEST_ASSERT_EQUAL(expected_unregistered, unregistered);
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &loop, sizeof(loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, &loop, sizeof(loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_EV1, &loop, sizeof(loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_EV2, &loop, sizeof(loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(expected_unregistered, unregistered); // all handlers unregistered
- TEST_ESP_OK(esp_event_loop_delete(loop));
- TEST_TEARDOWN();
- }
- TEST_CASE("handler instance can unregister itself", "[event]")
- {
- /* this test aims to verify that handlers can unregister themselves */
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- esp_event_handler_instance_t ctx;
- int count = 0;
- instance_unregister_data_t instance_data = {
- .context = &ctx,
- .data = &count
- };
- 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));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &loop, sizeof(loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(1, count);
- vTaskDelay(1000);
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &loop, sizeof(loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(1, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- TEST_TEARDOWN();
- }
- TEST_CASE("can exit running loop at approximately the set amount of time", "[event]")
- {
- /* this test aims to verify that running loop does not block indefinitely in cases where
- * events are posted frequently */
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- performance_data_t handler_data = {
- .performed = 0,
- .expected = INT32_MAX,
- .done = xSemaphoreCreateBinary()
- };
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_performance_handler, &handler_data));
- post_event_data_t post_event_data = {
- .base = s_test_base1,
- .id = TEST_EVENT_BASE1_EV1,
- .loop = loop,
- .num = INT32_MAX
- };
- task_arg_t post_event_arg = {
- .data = &post_event_data,
- .done = xSemaphoreCreateBinary(),
- .start = xSemaphoreCreateBinary()
- };
- TaskHandle_t post_task;
- xTaskCreatePinnedToCore(test_event_post_task, "post", 2048, &post_event_arg, s_test_priority, &post_task, test_event_get_core());
- int runtime_ms = 10;
- int runtime_us = runtime_ms * 1000;
- int64_t start, diff;
- start = esp_timer_get_time();
- xSemaphoreGive(post_event_arg.start);
- // Run the loop for the runtime_ms set amount of time, regardless of whether events
- // are still being posted to the loop.
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(runtime_ms)));
- diff = (esp_timer_get_time() - start);
- // Threshold is 25 percent.
- TEST_ASSERT(diff < runtime_us * 1.25f);
- // Verify that the post task still continues
- TEST_ASSERT_NOT_EQUAL(pdTRUE, xSemaphoreTake(post_event_arg.done, pdMS_TO_TICKS(10)));
- vSemaphoreDelete(post_event_arg.done);
- vSemaphoreDelete(post_event_arg.start);
- vSemaphoreDelete(handler_data.done);
- vTaskDelete(post_task);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- TEST_TEARDOWN();
- }
- TEST_CASE("can register/unregister handlers simultaneously", "[event]")
- {
- /* this test aims to verify that the event handlers list remains consistent despite
- * simultaneous access by differenct tasks */
- TEST_SETUP();
- const char* base = "base";
- int32_t id = 0;
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- ESP_LOGI(TAG, "registering handlers");
- handler_registration_data_t* registration_data = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*registration_data));
- task_arg_t* registration_arg = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*registration_arg));
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- registration_data[i].base = base;
- registration_data[i].id = id;
- registration_data[i].loop = loop;
- registration_data[i].handles = calloc(TEST_CONFIG_ITEMS_TO_REGISTER, sizeof(esp_event_handler_t));
- registration_data[i].num = TEST_CONFIG_ITEMS_TO_REGISTER;
- registration_data[i].is_registration = true;
- for (int j = 0; j < TEST_CONFIG_ITEMS_TO_REGISTER; j++) {
- registration_data[i].handles[j] = (void*) (i * TEST_CONFIG_ITEMS_TO_REGISTER) + (j + TEST_CONFIG_ITEMS_TO_REGISTER);
- }
- registration_arg[i].start = xSemaphoreCreateBinary();
- registration_arg[i].done = xSemaphoreCreateBinary();
- registration_arg[i].data = ®istration_data[i];
- xTaskCreatePinnedToCore(test_event_simple_handler_registration_task, "register", 2048, ®istration_arg[i], s_test_priority, NULL, test_event_get_core());
- }
- // Give the semaphores to the spawned registration task
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- xSemaphoreGive(registration_arg[i].start);
- }
- // Take the same semaphores in order to proceed
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- xSemaphoreTake(registration_arg[i].done, portMAX_DELAY);
- }
- ESP_LOGI(TAG, "checking consistency of handlers list");
- // Check consistency of events list
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- for (int j = 0; j < TEST_CONFIG_ITEMS_TO_REGISTER; j++) {
- TEST_ASSERT_TRUE(esp_event_is_handler_registered(loop, base, id, registration_data[i].handles[j]));
- }
- }
- ESP_LOGI(TAG, "unregistering handlers");
- /* Test if tasks can unregister simultaneously */
- // Unregister registered events
- handler_registration_data_t* unregistration_data = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*unregistration_data));
- task_arg_t* unregistration_arg = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*unregistration_arg));
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- unregistration_data[i].base = base;
- unregistration_data[i].id = id;
- unregistration_data[i].loop = loop;
- unregistration_data[i].handles = calloc(TEST_CONFIG_ITEMS_TO_REGISTER, sizeof(esp_event_handler_t));
- unregistration_data[i].num = TEST_CONFIG_ITEMS_TO_REGISTER;
- unregistration_data[i].is_registration = false;
- memcpy(unregistration_data[i].handles, registration_data[i].handles, TEST_CONFIG_ITEMS_TO_REGISTER * sizeof(esp_event_handler_t));
- unregistration_arg[i].data = &unregistration_data[i];
- unregistration_arg[i].start = xSemaphoreCreateBinary();
- unregistration_arg[i].done = xSemaphoreCreateBinary();
- xTaskCreatePinnedToCore(test_event_simple_handler_registration_task, "unregister", 2048, &unregistration_arg[i], s_test_priority, NULL, test_event_get_core());
- }
- // Give the semaphores to the spawned unregistration task
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- xSemaphoreGive(unregistration_arg[i].start);
- }
- // Take the same semaphores in order to proceed
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- xSemaphoreTake(unregistration_arg[i].done, portMAX_DELAY);
- }
- ESP_LOGI(TAG, "checking consistency of handlers list");
- // Check consistency of events list
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- for (int j = 0; j < TEST_CONFIG_ITEMS_TO_REGISTER; j++) {
- TEST_ASSERT_FALSE(esp_event_is_handler_registered(loop, base, id, registration_data[i].handles[j]));
- }
- }
- // Do cleanup
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- free(registration_data[i].handles);
- vSemaphoreDelete(registration_arg[i].start);
- vSemaphoreDelete(registration_arg[i].done);
- free(unregistration_data[i].handles);
- vSemaphoreDelete(unregistration_arg[i].start);
- vSemaphoreDelete(unregistration_arg[i].done);
- }
- free(registration_data);
- free(unregistration_data);
- free(registration_arg);
- free(unregistration_arg);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- TEST_TEARDOWN();
- }
- TEST_CASE("posting ANY_EVENT or ANY_ID fails", "[event]") {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, NULL, 0, portMAX_DELAY));
- TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, s_test_base1, ESP_EVENT_ANY_ID, NULL, 0, portMAX_DELAY));
- TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_post_to(loop, ESP_EVENT_ANY_BASE, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(0, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("can post and run events", "[event]")
- {
- /* this test aims to verify that:
- * - multiple tasks can post to the queue simultaneously
- * - handlers recieve the appropriate handler arg and associated event data */
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- loop_args.queue_size = TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg));
- post_event_data_t* post_event_data = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*post_event_data));
- task_arg_t* post_event_arg = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*post_event_arg));
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++)
- {
- post_event_data[i].base = s_test_base1;
- post_event_data[i].id = TEST_EVENT_BASE1_EV1;
- post_event_data[i].loop = loop;
- post_event_data[i].num = TEST_CONFIG_ITEMS_TO_REGISTER;
- post_event_arg[i].data = &post_event_data[i];
- post_event_arg[i].start = xSemaphoreCreateBinary();
- post_event_arg[i].done = xSemaphoreCreateBinary();
- xTaskCreatePinnedToCore(test_event_post_task, "post", 2048, &post_event_arg[i], s_test_priority, NULL, test_event_get_core());
- }
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- xSemaphoreGive(post_event_arg[i].start);
- }
- // Execute some events as they are posted
- for (int i = 0; i < (TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER) / 2; i++) {
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- }
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- xSemaphoreTake(post_event_arg[i].done, portMAX_DELAY);
- }
- // Execute the rest
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER, count);
- // Cleanup
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- vSemaphoreDelete(post_event_arg[i].start);
- vSemaphoreDelete(post_event_arg[i].done);
- }
- free(post_event_data);
- free(post_event_arg);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("can post and run events with instances", "[event]")
- {
- /* this test aims to verify that:
- * - multiple tasks can post to the queue simultaneously
- * - handlers recieve the appropriate handler arg and associated event data */
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- loop_args.queue_size = TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- int count = 0;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateMutex()
- };
- esp_event_handler_instance_t ctx;
- TEST_ESP_OK(esp_event_handler_instance_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_simple_handler, &arg, &ctx));
- post_event_data_t* post_event_data = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*post_event_data));
- task_arg_t* post_event_arg = calloc(TEST_CONFIG_TASKS_TO_SPAWN, sizeof(*post_event_arg));
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++)
- {
- post_event_data[i].base = s_test_base1;
- post_event_data[i].id = TEST_EVENT_BASE1_EV1;
- post_event_data[i].loop = loop;
- post_event_data[i].num = TEST_CONFIG_ITEMS_TO_REGISTER;
- post_event_arg[i].data = &post_event_data[i];
- post_event_arg[i].start = xSemaphoreCreateBinary();
- post_event_arg[i].done = xSemaphoreCreateBinary();
- xTaskCreatePinnedToCore(test_event_post_task, "post", 2048, &post_event_arg[i], s_test_priority, NULL, test_event_get_core());
- }
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- xSemaphoreGive(post_event_arg[i].start);
- }
- // Execute some events as they are posted
- for (int i = 0; i < (TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER) / 2; i++) {
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- }
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- xSemaphoreTake(post_event_arg[i].done, portMAX_DELAY);
- }
- // Execute the rest
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(TEST_CONFIG_TASKS_TO_SPAWN * TEST_CONFIG_ITEMS_TO_REGISTER, count);
- // Cleanup
- for (int i = 0; i < TEST_CONFIG_TASKS_TO_SPAWN; i++) {
- vSemaphoreDelete(post_event_arg[i].start);
- vSemaphoreDelete(post_event_arg[i].done);
- }
- free(post_event_data);
- free(post_event_arg);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- static void loop_run_task(void* args)
- {
- esp_event_loop_handle_t event_loop = (esp_event_loop_handle_t) args;
- while(1) {
- esp_event_loop_run(event_loop, portMAX_DELAY);
- }
- }
- static void performance_test(bool dedicated_task)
- {
- // rand() seems to do a one-time allocation. Call it here so that the memory it allocates
- // is not counted as a leak.
- unsigned int _rand __attribute__((unused)) = rand();
- TEST_SETUP();
- const char test_base[] = "qwertyuiopasdfghjklzxvbnmmnbvcxz";
- #define TEST_CONFIG_BASES (sizeof(test_base) - 1)
- #define TEST_CONFIG_IDS (TEST_CONFIG_BASES / 2)
- // Create loop
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- esp_event_loop_handle_t loop;
- if (!dedicated_task) {
- loop_args.task_name = NULL;
- }
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- performance_data_t data;
- // Register the handlers
- for (int base = 0; base < TEST_CONFIG_BASES; base++) {
- for (int id = 0; id < TEST_CONFIG_IDS; id++) {
- TEST_ESP_OK(esp_event_handler_register_with(loop, test_base + base, id, test_event_performance_handler, &data));
- }
- }
- TaskHandle_t mtask = NULL;
- if (!dedicated_task) {
- xTaskCreate(loop_run_task, "loop_run", loop_args.task_stack_size, (void*) loop, loop_args.task_priority, &mtask);
- }
- // Perform performance test
- float running_sum = 0;
- float running_count = 0;
- for (int bases = 1; bases <= TEST_CONFIG_BASES; bases *= 2) {
- for (int ids = 1; ids <= TEST_CONFIG_IDS; ids *= 2) {
- data.performed = 0;
- data.expected = bases * ids;
- data.done = xSemaphoreCreateBinary();
- // Generate randomized list of posts
- int post_bases[TEST_CONFIG_BASES];
- int post_ids[TEST_CONFIG_IDS];
- for (int i = 0; i < bases; i++) {
- post_bases[i] = i;
- }
- for (int i = 0; i < ids; i++) {
- post_ids[i] = i;
- }
- for (int i = 0; i < bases; i++) {
- int rand_a = rand() % bases;
- int rand_b = rand() % bases;
- int temp = post_bases[rand_a];
- post_bases[rand_a]= post_bases[rand_b];
- post_bases[rand_b] = temp;
- }
- for (int i = 0; i < ids; i++) {
- int rand_a = rand() % ids;
- int rand_b = rand() % ids;
- int temp = post_ids[rand_a];
- post_ids[rand_a]= post_ids[rand_b];
- post_ids[rand_b] = temp;
- }
- // Post the events
- int64_t start = esp_timer_get_time();
- for (int base = 0; base < bases; base++) {
- for (int id = 0; id < ids; id++) {
- TEST_ESP_OK(esp_event_post_to(loop, test_base + post_bases[base], post_ids[id], NULL, 0, portMAX_DELAY));
- }
- }
- xSemaphoreTake(data.done, portMAX_DELAY);
- int64_t elapsed = esp_timer_get_time() - start;
- // Record data
- TEST_ASSERT_EQUAL(data.expected, data.performed);
- running_count++;
- running_sum += data.performed / (elapsed / (1000000.0));
- vSemaphoreDelete(data.done);
- }
- }
- int average = (int) (running_sum / (running_count));
- if (!dedicated_task) {
- ((esp_event_loop_instance_t*) loop)->task = mtask;
- }
- TEST_ESP_OK(esp_event_loop_delete(loop));
- TEST_TEARDOWN();
- #ifdef CONFIG_ESP_EVENT_LOOP_PROFILING
- ESP_LOGI(TAG, "events dispatched/second with profiling enabled: %d", average);
- // Enabling profiling will slow down event dispatch, so the set threshold
- // is not valid when it is enabled.
- #else
- #ifndef CONFIG_SPIRAM
- TEST_PERFORMANCE_GREATER_THAN(EVENT_DISPATCH, "%d", average);
- #else
- TEST_PERFORMANCE_GREATER_THAN(EVENT_DISPATCH_PSRAM, "%d", average);
- #endif // CONFIG_SPIRAM
- #endif // CONFIG_ESP_EVENT_LOOP_PROFILING
- }
- TEST_CASE("performance test - dedicated task", "[event]")
- {
- performance_test(true);
- }
- TEST_CASE("performance test - no dedicated task", "[event]")
- {
- performance_test(false);
- }
- TEST_CASE("can post to loop from handler - dedicated task", "[event]")
- {
- TEST_SETUP();
- esp_event_loop_handle_t loop_w_task;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- int count;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateBinary()
- };
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop_w_task));
- count = 0;
- // Test that a handler can post to a different loop while there is still slots on the queue
- TEST_ESP_OK(esp_event_handler_register_with(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV1, test_handler_post_w_task, &arg));
- TEST_ESP_OK(esp_event_handler_register_with(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, test_handler_post_w_task, &arg));
- 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));
- xSemaphoreTake(arg.mutex, portMAX_DELAY);
- TEST_ASSERT_EQUAL(2, count);
- // Test that other tasks can still post while there is still slots in the queue, while handler is executing
- count = 100;
- 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));
- for (int i = 0; i < loop_args.queue_size; i++) {
- TEST_ESP_OK(esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- }
- TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0,
- pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER)));
- xSemaphoreGive(arg.mutex);
- vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
- TEST_ESP_OK(esp_event_loop_delete(loop_w_task));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("can post to loop from handler instance - dedicated task", "[event]")
- {
- TEST_SETUP();
- esp_event_loop_handle_t loop_w_task;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- int count;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateBinary()
- };
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop_w_task));
- count = 0;
- esp_event_handler_instance_t ctx_1;
- esp_event_handler_instance_t ctx_2;
- // Test that a handler can post to a different loop while there is still slots on the queue
- 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));
- 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));
- 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));
- xSemaphoreTake(arg.mutex, portMAX_DELAY);
- TEST_ASSERT_EQUAL(2, count);
- // Test that other tasks can still post while there is still slots in the queue, while handler is executing
- count = 100;
- 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));
- for (int i = 0; i < loop_args.queue_size; i++) {
- TEST_ESP_OK(esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- }
- TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(loop_w_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0,
- pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER)));
- xSemaphoreGive(arg.mutex);
- vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
- TEST_ESP_OK(esp_event_loop_delete(loop_w_task));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("can post to loop from handler - no dedicated task", "[event]")
- {
- TEST_SETUP();
- esp_event_loop_handle_t loop_wo_task;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- int count;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateBinary()
- };
- count = 0;
- loop_args.queue_size = 1;
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop_wo_task));
- TaskHandle_t mtask;
- xTaskCreate(test_post_from_handler_loop_task, "task", 2584, (void*) loop_wo_task, s_test_priority, &mtask);
- // Test that a handler can post to a different loop while there is still slots on the queue
- TEST_ESP_OK(esp_event_handler_register_with(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV1, test_handler_post_wo_task, &arg));
- TEST_ESP_OK(esp_event_handler_register_with(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV2, test_handler_post_wo_task, &arg));
- 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));
- xSemaphoreTake(arg.mutex, portMAX_DELAY);
- TEST_ASSERT_EQUAL(2, count);
- count = 100;
- 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));
- vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
- // For loop without tasks, posting is more restrictive. Posting should wait until execution of handler finishes
- TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0,
- pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER)));
- xSemaphoreGive(arg.mutex);
- vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
- vTaskDelete(mtask);
- TEST_ESP_OK(esp_event_loop_delete(loop_wo_task));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- TEST_CASE("can post to loop from handler instance - no dedicated task", "[event]")
- {
- TEST_SETUP();
- esp_event_loop_handle_t loop_wo_task;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- int count;
- simple_arg_t arg = {
- .data = &count,
- .mutex = xSemaphoreCreateBinary()
- };
- count = 0;
- esp_event_handler_instance_t ctx_1;
- esp_event_handler_instance_t ctx_2;
- loop_args.queue_size = 1;
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop_wo_task));
- TaskHandle_t mtask;
- xTaskCreate(test_post_from_handler_loop_task, "task", 2584, (void*) loop_wo_task, s_test_priority, &mtask);
- // Test that a handler can post to a different loop while there is still slots on the queue
- 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));
- 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));
- 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));
- xSemaphoreTake(arg.mutex, portMAX_DELAY);
- TEST_ASSERT_EQUAL(2, count);
- count = 100;
- 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));
- vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
- // For loop without tasks, posting is more restrictive. Posting should wait until execution of handler finishes
- TEST_ASSERT_EQUAL(ESP_ERR_TIMEOUT, esp_event_post_to(loop_wo_task, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0,
- pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER)));
- xSemaphoreGive(arg.mutex);
- vTaskDelay(pdMS_TO_TICKS(CONFIG_ESP_INT_WDT_TIMEOUT_MS * TEST_CONFIG_WAIT_MULTIPLIER));
- vTaskDelete(mtask);
- TEST_ESP_OK(esp_event_loop_delete(loop_wo_task));
- vSemaphoreDelete(arg.mutex);
- TEST_TEARDOWN();
- }
- static void test_event_simple_handler_template(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
- {
- int* count = (int*) handler_arg;
- (*count)++;
- }
- static void test_event_simple_handler_1(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
- {
- test_event_simple_handler_template(handler_arg, base, id, event_arg);
- }
- static void test_event_simple_handler_3(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
- {
- test_event_simple_handler_template(handler_arg, base, id, event_arg);
- }
- static void test_event_simple_handler_2(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
- {
- test_event_simple_handler_template(handler_arg, base, id, event_arg);
- }
- static void test_registration_from_handler_hdlr(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
- {
- esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_arg;
- TEST_ESP_OK(esp_event_handler_register_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_1, handler_arg));
- TEST_ESP_OK(esp_event_handler_register_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_2, handler_arg));
- TEST_ESP_OK(esp_event_handler_register_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_3, handler_arg));
- }
- static void test_unregistration_from_handler_hdlr(void* handler_arg, esp_event_base_t base, int32_t id, void* event_arg)
- {
- esp_event_loop_handle_t* loop = (esp_event_loop_handle_t*) event_arg;
- TEST_ESP_OK(esp_event_handler_unregister_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_1));
- TEST_ESP_OK(esp_event_handler_unregister_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_2));
- TEST_ESP_OK(esp_event_handler_unregister_with(*loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_simple_handler_3));
- }
- TEST_CASE("can register from handler", "[event]")
- {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- int count = 0;
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_registration_from_handler_hdlr, &count));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE2_EV1, test_unregistration_from_handler_hdlr, &count));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &loop, sizeof(&loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(3, count);
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE2_EV1, &loop, sizeof(&loop), portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ASSERT_EQUAL(3, count);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- TEST_TEARDOWN();
- }
- static void test_create_loop_handler(void* handler_args, esp_event_base_t base, int32_t id, void* event_data)
- {
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- if (id == TEST_EVENT_BASE1_EV1) {
- TEST_ESP_OK(esp_event_loop_create(&loop_args, (esp_event_loop_handle_t*) handler_args));
- } else {
- TEST_ESP_OK(esp_event_loop_delete(*((esp_event_loop_handle_t*) handler_args)));
- }
- }
- TEST_CASE("can create and delete loop from handler", "[event]")
- {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_handle_t test_loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_create_loop_handler, &test_loop));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_create_loop_handler, &test_loop));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, NULL, 0, portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- TEST_ESP_OK(esp_event_loop_delete(loop));
- TEST_TEARDOWN();
- }
- TEST_CASE("events are dispatched in the order they are registered", "[event]")
- {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- int id_arr[7];
- for (int i = 0; i < 7; i++) {
- id_arr[i] = i;
- }
- int data_arr[12] = {0};
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE2_EV1, test_event_ordered_dispatch, id_arr + 0));
- TEST_ESP_OK(esp_event_handler_register_with(loop, ESP_EVENT_ANY_BASE, ESP_EVENT_ANY_ID, test_event_ordered_dispatch, id_arr + 1));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, ESP_EVENT_ANY_ID, test_event_ordered_dispatch, id_arr + 2));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, TEST_EVENT_BASE2_EV2, test_event_ordered_dispatch, id_arr + 3));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV1, test_event_ordered_dispatch, id_arr + 4));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base2, ESP_EVENT_ANY_ID, test_event_ordered_dispatch, id_arr + 5));
- TEST_ESP_OK(esp_event_handler_register_with(loop, s_test_base1, TEST_EVENT_BASE1_EV2, test_event_ordered_dispatch, id_arr + 6));
- esp_event_dump(stdout);
- ordered_data_t data = {
- .arr = data_arr,
- .index = 0
- };
- ordered_data_t* dptr = &data;
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV2, &dptr, sizeof(dptr), portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &dptr, sizeof(dptr), portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV2, &dptr, sizeof(dptr), portMAX_DELAY));
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base2, TEST_EVENT_BASE1_EV1, &dptr, sizeof(dptr), portMAX_DELAY));
- TEST_ESP_OK(esp_event_loop_run(loop, pdMS_TO_TICKS(10)));
- // Expected data executing the posts above
- int ref_arr[12] = {1, 3, 5, 1, 2, 4, 1, 2, 6, 0, 1, 5};
- for (int i = 0; i < 12; i++) {
- TEST_ASSERT_EQUAL(ref_arr[i], data_arr[i]);
- }
- TEST_ESP_OK(esp_event_loop_delete(loop));
- TEST_TEARDOWN();
- }
- #if CONFIG_ESP_EVENT_POST_FROM_ISR
- TEST_CASE("can properly prepare event data posted to loop", "[event]")
- {
- TEST_SETUP();
- esp_event_loop_handle_t loop;
- esp_event_loop_args_t loop_args = test_event_get_default_loop_args();
- loop_args.task_name = NULL;
- TEST_ESP_OK(esp_event_loop_create(&loop_args, &loop));
- esp_event_post_instance_t post;
- esp_event_loop_instance_t* loop_def = (esp_event_loop_instance_t*) loop;
- TEST_ESP_OK(esp_event_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, NULL, 0, portMAX_DELAY));
- TEST_ASSERT_EQUAL(pdTRUE, xQueueReceive(loop_def->queue, &post, portMAX_DELAY));
- TEST_ASSERT_EQUAL(false, post.data_set);
- TEST_ASSERT_EQUAL(false, post.data_allocated);
- TEST_ASSERT_EQUAL(NULL, post.data.ptr);
- int sample = 0;
- TEST_ESP_OK(esp_event_isr_post_to(loop, s_test_base1, TEST_EVENT_BASE1_EV1, &sample, sizeof(sample), NULL));
- TEST_ASSERT_EQUAL(pdTRUE, xQueueReceive(loop_def->queue, &post, portMAX_DELAY));
- TEST_ASSERT_EQUAL(true, post.data_set);
- TEST_ASSERT_EQUAL(false, post.data_allocated);
- TEST_ASSERT_EQUAL(false, post.data.val);
- TEST_ESP_OK(esp_event_loop_delete(loop));
- TEST_TEARDOWN();
- }
- static void test_handler_post_from_isr(void* event_handler_arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
- {
- SemaphoreHandle_t *sem = (SemaphoreHandle_t*) event_handler_arg;
- // Event data is just the address value (maybe have been truncated due to casting).
- int *data = (int*) event_data;
- TEST_ASSERT_EQUAL(*data, (int) (*sem));
- xSemaphoreGive(*sem);
- }
- void IRAM_ATTR test_event_on_timer_alarm(void* para)
- {
- /* Retrieve the interrupt status and the counter value
- from the timer that reported the interrupt */
- uint64_t timer_counter_value =
- timer_group_get_counter_value_in_isr(TIMER_GROUP_0, TIMER_0);
- timer_group_clr_intr_status_in_isr(TIMER_GROUP_0, TIMER_0);
- timer_counter_value += (uint64_t) (TIMER_INTERVAL0_SEC * TIMER_SCALE);
- timer_group_set_alarm_value_in_isr(TIMER_GROUP_0, TIMER_0, timer_counter_value);
- int data = (int) para;
- // Posting events with data more than 4 bytes should fail.
- TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_event_isr_post(s_test_base1, TEST_EVENT_BASE1_EV1, &data, 5, NULL));
- // This should succeedd, as data is int-sized. The handler for the event checks that the passed event data
- // is correct.
- BaseType_t task_unblocked;
- TEST_ESP_OK(esp_event_isr_post(s_test_base1, TEST_EVENT_BASE1_EV1, &data, sizeof(data), &task_unblocked));
- if (task_unblocked == pdTRUE) {
- portYIELD_FROM_ISR();
- }
- }
- TEST_CASE("can post events from interrupt handler", "[event]")
- {
- SemaphoreHandle_t sem = xSemaphoreCreateBinary();
- /* Select and initialize basic parameters of the timer */
- timer_config_t config;
- config.divider = TIMER_DIVIDER;
- config.counter_dir = TIMER_COUNT_UP;
- config.counter_en = TIMER_PAUSE;
- config.alarm_en = TIMER_ALARM_EN;
- config.intr_type = TIMER_INTR_LEVEL;
- config.auto_reload = false;
- timer_init(TIMER_GROUP_0, TIMER_0, &config);
- /* Timer's counter will initially start from value below.
- Also, if auto_reload is set, this value will be automatically reload on alarm */
- timer_set_counter_value(TIMER_GROUP_0, TIMER_0, 0x00000000ULL);
- /* Configure the alarm value and the interrupt on alarm. */
- timer_set_alarm_value(TIMER_GROUP_0, TIMER_0, TIMER_INTERVAL0_SEC * TIMER_SCALE);
- timer_enable_intr(TIMER_GROUP_0, TIMER_0);
- timer_isr_register(TIMER_GROUP_0, TIMER_0, test_event_on_timer_alarm,
- (void *) sem, ESP_INTR_FLAG_IRAM, NULL);
- timer_start(TIMER_GROUP_0, TIMER_0);
- TEST_SETUP();
- TEST_ESP_OK(esp_event_handler_register(s_test_base1, TEST_EVENT_BASE1_EV1,
- test_handler_post_from_isr, &sem));
- xSemaphoreTake(sem, portMAX_DELAY);
- TEST_TEARDOWN();
- }
- #endif // CONFIG_ESP_EVENT_POST_FROM_ISR
|