Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 | /* * Copyright (c) 2018 Laczen * * SPDX-License-Identifier: Apache-2.0 */ /** @file * @brief Settings functional test suite * */ #include <zephyr.h> #include <ztest.h> #include <errno.h> #include <settings/settings.h> #include <logging/log.h> LOG_MODULE_REGISTER(settings_basic_test); #if defined(CONFIG_SETTINGS_FCB) || defined(CONFIG_SETTINGS_NVS) #include <storage/flash_map.h> #endif #if IS_ENABLED(CONFIG_SETTINGS_FS) #include <fs/fs.h> #include <fs/littlefs.h> #endif /* The standard test expects a cleared flash area. Make sure it has * one. */ static void test_clear_settings(void) { #if IS_ENABLED(CONFIG_SETTINGS_FCB) || IS_ENABLED(CONFIG_SETTINGS_NVS) const struct flash_area *fap; int rc = flash_area_open(DT_FLASH_AREA_STORAGE_ID, &fap); if (rc == 0) { rc = flash_area_erase(fap, 0, fap->fa_size); flash_area_close(fap); } zassert_true(rc == 0, "clear settings failed"); #endif #if IS_ENABLED(CONFIG_SETTINGS_FS) FS_LITTLEFS_DECLARE_DEFAULT_CONFIG(cstorage); /* mounting info */ static struct fs_mount_t littlefs_mnt = { .type = FS_LITTLEFS, .fs_data = &cstorage, .storage_dev = (void *)DT_FLASH_AREA_STORAGE_ID, .mnt_point = "/ff" }; int rc; rc = fs_mount(&littlefs_mnt); zassert_true(rc == 0, "mounting littlefs [%d]\n", rc); rc = fs_unlink(CONFIG_SETTINGS_FS_FILE); zassert_true(rc == 0 || rc == -ENOENT, "can't delete config file%d\n", rc); #endif } /* * Test the two support routines that settings provides: * * settings_name_steq(name, key, next): compares the start of name with key * settings_name_next(name, next): returns the location of the first * separator */ static void test_support_rtn(void) { const char test1[] = "bt/a/b/c/d"; const char test2[] = "bt/a/b/c/d="; const char *next1, *next2; int rc; /* complete match: return 1, next = NULL */ rc = settings_name_steq(test1, "bt/a/b/c/d", &next1); zassert_true(rc == 1, "_steq comparison failure"); zassert_is_null(next1, "_steq comparison next error"); rc = settings_name_steq(test2, "bt/a/b/c/d", &next2); zassert_true(rc == 1, "_steq comparison failure"); zassert_is_null(next2, "_steq comparison next error"); /* partial match: return 1, next <> NULL */ rc = settings_name_steq(test1, "bt/a/b/c", &next1); zassert_true(rc == 1, "_steq comparison failure"); zassert_not_null(next1, "_steq comparison next error"); zassert_equal_ptr(next1, test1+9, "next points to wrong location"); rc = settings_name_steq(test2, "bt/a/b/c", &next2); zassert_true(rc == 1, "_steq comparison failure"); zassert_not_null(next2, "_steq comparison next error"); zassert_equal_ptr(next2, test2+9, "next points to wrong location"); /* no match: return 0, next = NULL */ rc = settings_name_steq(test1, "bta", &next1); zassert_true(rc == 0, "_steq comparison failure"); zassert_is_null(next1, "_steq comparison next error"); rc = settings_name_steq(test2, "bta", &next2); zassert_true(rc == 0, "_steq comparison failure"); zassert_is_null(next2, "_steq comparison next error"); /* no match: return 0, next = NULL */ rc = settings_name_steq(test1, "b", &next1); zassert_true(rc == 0, "_steq comparison failure"); zassert_is_null(next1, "_steq comparison next error"); rc = settings_name_steq(test2, "b", &next2); zassert_true(rc == 0, "_steq comparison failure"); zassert_is_null(next2, "_steq comparison next error"); /* first separator: return 2, next <> NULL */ rc = settings_name_next(test1, &next1); zassert_true(rc == 2, "_next wrong return value"); zassert_not_null(next1, "_next wrong next"); zassert_equal_ptr(next1, test1+3, "next points to wrong location"); rc = settings_name_next(test2, &next2); zassert_true(rc == 2, "_next wrong return value"); zassert_not_null(next2, "_next wrong next"); zassert_equal_ptr(next2, test2+3, "next points to wrong location"); /* second separator: return 1, next <> NULL */ rc = settings_name_next(next1, &next1); zassert_true(rc == 1, "_next wrong return value"); zassert_not_null(next1, "_next wrong next"); zassert_equal_ptr(next1, test1+5, "next points to wrong location"); rc = settings_name_next(next2, &next2); zassert_true(rc == 1, "_next wrong return value"); zassert_not_null(next2, "_next wrong next"); zassert_equal_ptr(next2, test2+5, "next points to wrong location"); /* third separator: return 1, next <> NULL */ rc = settings_name_next(next1, &next1); zassert_true(rc == 1, "_next wrong return value"); zassert_not_null(next1, "_next wrong next"); rc = settings_name_next(next2, &next2); zassert_true(rc == 1, "_next wrong return value"); zassert_not_null(next2, "_next wrong next"); /* fourth separator: return 1, next <> NULL */ rc = settings_name_next(next1, &next1); zassert_true(rc == 1, "_next wrong return value"); zassert_not_null(next1, "_next wrong next"); rc = settings_name_next(next2, &next2); zassert_true(rc == 1, "_next wrong return value"); zassert_not_null(next2, "_next wrong next"); /* fifth separator: return 1, next == NULL */ rc = settings_name_next(next1, &next1); zassert_true(rc == 1, "_next wrong return value"); zassert_is_null(next1, "_next wrong next"); rc = settings_name_next(next2, &next2); zassert_true(rc == 1, "_next wrong return value"); zassert_is_null(next2, "_next wrong next"); } struct stored_data { u8_t val1; u8_t val2; u8_t val3; bool en1; bool en2; bool en3; }; struct stored_data data; int val1_set(const char *key, size_t len, settings_read_cb read_cb, void *cb_arg) { data.val1 = 1; return 0; } int val1_commit(void) { data.en1 = true; return 0; } static struct settings_handler val1_settings = { .name = "ps", .h_set = val1_set, .h_commit = val1_commit, }; int val2_set(const char *key, size_t len, settings_read_cb read_cb, void *cb_arg) { data.val2 = 2; return 0; } int val2_commit(void) { data.en2 = true; return 0; } static struct settings_handler val2_settings = { .name = "ps/ss/ss", .h_set = val2_set, .h_commit = val2_commit, }; int val3_set(const char *key, size_t len, settings_read_cb read_cb, void *cb_arg) { data.val3 = 3; return 0; } int val3_commit(void) { data.en3 = true; return 0; } static struct settings_handler val3_settings = { .name = "ps/ss", .h_set = val3_set, .h_commit = val3_commit, }; /* helper routine to remove a handler from settings */ int settings_deregister(struct settings_handler *handler) { extern sys_slist_t settings_handlers; return sys_slist_find_and_remove(&settings_handlers, &handler->node); } static void test_register_and_loading(void) { int rc, err; u8_t val = 0; rc = settings_subsys_init(); zassert_true(rc == 0, "subsys init failed"); settings_save_one("ps/ss/ss/val2", &val, sizeof(u8_t)); memset(&data, 0, sizeof(struct stored_data)); rc = settings_register(&val1_settings); zassert_true(rc == 0, "register of val1 settings failed"); /* when we load settings now data.val1 should receive the value*/ rc = settings_load(); zassert_true(rc == 0, "settings_load failed"); err = (data.val1 == 1) && (data.val2 == 0) && (data.val3 == 0); zassert_true(err, "wrong data value found"); /* commit is only called for val1_settings */ err = (data.en1) && (!data.en2) && (!data.en3); zassert_true(err, "wrong data enable found"); /* Next register should be ok */ rc = settings_register(&val2_settings); zassert_true(rc == 0, "register of val2 settings failed"); /* Next register should fail (same name) */ rc = settings_register(&val2_settings); zassert_true(rc == -EEXIST, "double register of val2 settings allowed"); memset(&data, 0, sizeof(struct stored_data)); /* when we load settings now data.val2 should receive the value*/ rc = settings_load(); zassert_true(rc == 0, "settings_load failed"); err = (data.val1 == 0) && (data.val2 == 2) && (data.val3 == 0); zassert_true(err, "wrong data value found"); /* commit is called for val1_settings and val2_settings*/ err = (data.en1) && (data.en2) && (!data.en3); zassert_true(err, "wrong data enable found"); settings_save_one("ps/ss/val3", &val, sizeof(u8_t)); memset(&data, 0, sizeof(struct stored_data)); /* when we load settings now data.val2 and data.val1 should receive a * value */ rc = settings_load(); zassert_true(rc == 0, "settings_load failed"); err = (data.val1 == 1) && (data.val2 == 2) && (data.val3 == 0); zassert_true(err, "wrong data value found"); /* commit is called for val1_settings and val2_settings*/ err = (data.en1) && (data.en2) && (!data.en3); zassert_true(err, "wrong data enable found"); /* val3 settings should be inserted in between val1_settings and * val2_settings */ rc = settings_register(&val3_settings); zassert_true(rc == 0, "register of val3 settings failed"); memset(&data, 0, sizeof(struct stored_data)); /* when we load settings now data.val2 and data.val3 should receive a * value */ rc = settings_load(); zassert_true(rc == 0, "settings_load failed"); err = (data.val1 == 0) && (data.val2 == 2) && (data.val3 == 3); zassert_true(err, "wrong data value found"); /* commit is called for val1_settings, val2_settings and val3_settings */ err = (data.en1) && (data.en2) && (data.en3); zassert_true(err, "wrong data enable found"); settings_save_one("ps/val1", &val, sizeof(u8_t)); memset(&data, 0, sizeof(struct stored_data)); /* when we load settings all data should receive a value loaded */ rc = settings_load(); zassert_true(rc == 0, "settings_load failed"); err = (data.val1 == 1) && (data.val2 == 2) && (data.val3 == 3); zassert_true(err, "wrong data value found"); /* commit is called for all settings*/ err = (data.en1) && (data.en2) && (data.en3); zassert_true(err, "wrong data enable found"); memset(&data, 0, sizeof(struct stored_data)); /* test subtree loading: subtree "ps/ss" data.val2 and data.val3 should * receive a value */ rc = settings_load_subtree("ps/ss"); zassert_true(rc == 0, "settings_load failed"); err = (data.val1 == 0) && (data.val2 == 2) && (data.val3 == 3); zassert_true(err, "wrong data value found"); /* commit is called for val2_settings and val3_settings */ err = (!data.en1) && (data.en2) && (data.en3); zassert_true(err, "wrong data enable found"); memset(&data, 0, sizeof(struct stored_data)); /* test subtree loading: subtree "ps/ss/ss" only data.val2 should * receive a value */ rc = settings_load_subtree("ps/ss/ss"); zassert_true(rc == 0, "settings_load failed"); err = (data.val1 == 0) && (data.val2 == 2) && (data.val3 == 0); zassert_true(err, "wrong data value found"); /* commit is called only for val2_settings */ err = (!data.en1) && (data.en2) && (!data.en3); zassert_true(err, "wrong data enable found"); /* clean up by deregisterring settings_handler */ rc = settings_deregister(&val1_settings); zassert_true(rc, "deregistering val1_settings failed"); rc = settings_deregister(&val2_settings); zassert_true(rc, "deregistering val1_settings failed"); rc = settings_deregister(&val3_settings); zassert_true(rc, "deregistering val1_settings failed"); } int val123_set(const char *key, size_t len, settings_read_cb read_cb, void *cb_arg) { int rc; u8_t val; zassert_equal(1, len, "Unexpected size"); rc = read_cb(cb_arg, &val, sizeof(val)); zassert_equal(sizeof(val), rc, "read_cb failed"); if (!strcmp("1", key)) { data.val1 = val; data.en1 = true; return 0; } if (!strcmp("2", key)) { data.val2 = val; data.en2 = true; return 0; } if (!strcmp("3", key)) { data.val3 = val; data.en3 = true; return 0; } zassert_unreachable("Unexpected key value: %s", key); return 0; } static struct settings_handler val123_settings = { .name = "val", .h_set = val123_set, }; unsigned int direct_load_cnt; u8_t val_directly_loaded; int direct_loader( const char *key, size_t len, settings_read_cb read_cb, void *cb_arg, void *param) { int rc; u8_t val; zassert_equal(0x1234, (size_t)param, NULL); zassert_equal(1, len, NULL); zassert_is_null(key, "Unexpected key: %s", key); zassert_not_null(cb_arg, NULL); rc = read_cb(cb_arg, &val, sizeof(val)); zassert_equal(sizeof(val), rc, NULL); val_directly_loaded = val; direct_load_cnt += 1; return 0; } static void test_direct_loading(void) { int rc; u8_t val; val = 11; settings_save_one("val/1", &val, sizeof(u8_t)); val = 23; settings_save_one("val/2", &val, sizeof(u8_t)); val = 35; settings_save_one("val/3", &val, sizeof(u8_t)); rc = settings_register(&val123_settings); zassert_true(rc == 0, NULL); memset(&data, 0, sizeof(data)); rc = settings_load(); zassert_true(rc == 0, NULL); zassert_equal(11, data.val1, NULL); zassert_equal(23, data.val2, NULL); zassert_equal(35, data.val3, NULL); /* Load subtree */ memset(&data, 0, sizeof(data)); rc = settings_load_subtree("val/2"); zassert_true(rc == 0, NULL); zassert_equal(0, data.val1, NULL); zassert_equal(23, data.val2, NULL); zassert_equal(0, data.val3, NULL); /* Direct loading now */ memset(&data, 0, sizeof(data)); val_directly_loaded = 0; direct_load_cnt = 0; rc = settings_load_subtree_direct( "val/2", direct_loader, (void *)0x1234); zassert_true(rc == 0, NULL); zassert_equal(0, data.val1, NULL); zassert_equal(0, data.val2, NULL); zassert_equal(0, data.val3, NULL); zassert_equal(1, direct_load_cnt, NULL); zassert_equal(23, val_directly_loaded, NULL); } struct test_loading_data { const char *n; const char *v; }; /* Final data */ static const struct test_loading_data data_final[] = { { .n = "val/1", .v = "final 1" }, { .n = "val/2", .v = "final 2" }, { .n = "val/3", .v = "final 3" }, { .n = "val/4", .v = "final 4" }, { .n = NULL } }; /* The counter of the callback called */ static unsigned int data_final_called[ARRAY_SIZE(data_final)]; static int filtered_loader( const char *key, size_t len, settings_read_cb read_cb, void *cb_arg) { int rc; const char *next; char buf[32]; const struct test_loading_data *ldata; printk("-- Called: %s\n", key); /* Searching for a element in an array */ for (ldata = data_final; ldata->n; ldata += 1) { if (settings_name_steq(key, ldata->n, &next)) { break; } } zassert_not_null(ldata->n, "Unexpected data name: %s", key); zassert_is_null(next, NULL); zassert_equal(strlen(ldata->v) + 1, len, "e: \"%s\", a:\"%s\"", ldata->v, buf); zassert_true(len <= sizeof(buf), NULL); rc = read_cb(cb_arg, buf, len); zassert_equal(len, rc, NULL); zassert_false(strcmp(ldata->v, buf), "e: \"%s\", a:\"%s\"", ldata->v, buf); /* Count an element that was properly loaded */ data_final_called[ldata - data_final] += 1; return 0; } static struct settings_handler filtered_loader_settings = { .name = "filtered_test", .h_set = filtered_loader, }; static int direct_filtered_loader( const char *key, size_t len, settings_read_cb read_cb, void *cb_arg, void *param) { zassert_equal(0x3456, (size_t)param, NULL); return filtered_loader(key, len, read_cb, cb_arg); } static void test_direct_loading_filter(void) { int rc; const struct test_loading_data *ldata; const char *prefix = filtered_loader_settings.name; char buffer[48]; size_t n; /* Duplicated data */ static const struct test_loading_data data_duplicates[] = { { .n = "val/1", .v = "dup abc" }, { .n = "val/2", .v = "dup 123" }, { .n = "val/3", .v = "dup 11" }, { .n = "val/4", .v = "dup 34" }, { .n = "val/1", .v = "dup 56" }, { .n = "val/2", .v = "dup 7890" }, { .n = "val/4", .v = "dup niety" }, { .n = "val/3", .v = "dup er" }, { .n = "val/3", .v = "dup super" }, { .n = "val/3", .v = "dup xxx" }, { .n = NULL } }; /* Data that is going to be deleted */ strcpy(buffer, prefix); strcat(buffer, "/to_delete"); settings_save_one(buffer, "1", 2); settings_delete(buffer); /* Saving all the data */ for (ldata = data_duplicates; ldata->n; ++ldata) { strcpy(buffer, prefix); strcat(buffer, "/"); strcat(buffer, ldata->n); settings_save_one(buffer, ldata->v, strlen(ldata->v) + 1); } for (ldata = data_final; ldata->n; ++ldata) { strcpy(buffer, prefix); strcat(buffer, "/"); strcat(buffer, ldata->n); settings_save_one(buffer, ldata->v, strlen(ldata->v) + 1); } memset(data_final_called, 0, sizeof(data_final_called)); rc = settings_load_subtree_direct( prefix, direct_filtered_loader, (void *)0x3456); zassert_equal(0, rc, NULL); /* Check if all the data was called */ for (n = 0; data_final[n].n; ++n) { zassert_equal(1, data_final_called[n], "Unexpected number of calls (%u) of (%s) element", n, data_final[n].n); } rc = settings_register(&filtered_loader_settings); zassert_true(rc == 0, NULL); rc = settings_load_subtree(prefix); zassert_equal(0, rc, NULL); /* Check if all the data was called */ for (n = 0; data_final[n].n; ++n) { zassert_equal(2, data_final_called[n], "Unexpected number of calls (%u) of (%s) element", n, data_final[n].n); } } void test_main(void) { ztest_test_suite(settings_test_suite, ztest_unit_test(test_clear_settings), ztest_unit_test(test_support_rtn), ztest_unit_test(test_register_and_loading), ztest_unit_test(test_direct_loading), ztest_unit_test(test_direct_loading_filter) ); ztest_run_test_suite(settings_test_suite); } |