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 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 | /* * Copyright (c) 2016 Intel Corporation * * SPDX-License-Identifier: Apache-2.0 */ #include <zephyr/ztest.h> #include <zephyr/app_memory/app_memdomain.h> #ifdef CONFIG_USERSPACE #include <zephyr/sys/libc-hooks.h> #endif #include <zephyr/logging/log_ctrl.h> #include <zephyr/sys/reboot.h> #ifdef KERNEL static struct k_thread ztest_thread; #endif #ifdef CONFIG_ZTEST_SHUFFLE #include <stdlib.h> #include <time.h> #include <zephyr/random/rand32.h> #define NUM_ITER_PER_SUITE CONFIG_ZTEST_SHUFFLE_SUITE_REPEAT_COUNT #define NUM_ITER_PER_TEST CONFIG_ZTEST_SHUFFLE_TEST_REPEAT_COUNT #else #define NUM_ITER_PER_SUITE 1 #define NUM_ITER_PER_TEST 1 #endif /* ZTEST_DMEM and ZTEST_BMEM are used for the application shared memory test */ /** * @brief Each enum member represents a distinct phase of execution for the * test binary. TEST_PHASE_FRAMEWORK is active when internal ztest code * is executing; the rest refer to corresponding phases of user test * code. */ enum ztest_phase { TEST_PHASE_SETUP, TEST_PHASE_BEFORE, TEST_PHASE_TEST, TEST_PHASE_AFTER, TEST_PHASE_TEARDOWN, TEST_PHASE_FRAMEWORK }; /** * @brief The current status of the test binary */ enum ztest_status { ZTEST_STATUS_OK, ZTEST_STATUS_HAS_FAILURE, ZTEST_STATUS_CRITICAL_ERROR }; /** * @brief Tracks the current phase that ztest is operating in. */ ZTEST_DMEM enum ztest_phase phase = TEST_PHASE_FRAMEWORK; static ZTEST_BMEM enum ztest_status test_status = ZTEST_STATUS_OK; extern ZTEST_DMEM const struct ztest_arch_api ztest_api; void end_report(void) { if (test_status) { TC_END_REPORT(TC_FAIL); } else { TC_END_REPORT(TC_PASS); } } static int cleanup_test(struct ztest_unit_test *test) { int ret = TC_PASS; int mock_status; mock_status = z_cleanup_mock(); #ifdef KERNEL /* we need to remove the ztest_thread information from the timeout_q. * Because we reuse the same k_thread structure this would * causes some problems. */ if (IS_ENABLED(CONFIG_MULTITHREADING)) { k_thread_abort(&ztest_thread); } #endif if (!ret && mock_status == 1) { PRINT("Test %s failed: Unused mock parameter values\n", test->name); ret = TC_FAIL; } else if (!ret && mock_status == 2) { PRINT("Test %s failed: Unused mock return values\n", test->name); ret = TC_FAIL; } else { ; } return ret; } #ifdef KERNEL #ifdef CONFIG_SMP #define NUM_CPUHOLD (CONFIG_MP_NUM_CPUS - 1) #else #define NUM_CPUHOLD 0 #endif #define CPUHOLD_STACK_SZ (512 + CONFIG_TEST_EXTRA_STACK_SIZE) static struct k_thread cpuhold_threads[NUM_CPUHOLD]; K_KERNEL_STACK_ARRAY_DEFINE(cpuhold_stacks, NUM_CPUHOLD, CPUHOLD_STACK_SZ); static struct k_sem cpuhold_sem; volatile int cpuhold_active; /* "Holds" a CPU for use with the "1cpu" test cases. Note that we * can't use tools like the cpumask feature because we have tests that * may need to control that configuration themselves. We do this at * the lowest level, but locking interrupts directly and spinning. */ static void cpu_hold(void *arg1, void *arg2, void *arg3) { ARG_UNUSED(arg1); ARG_UNUSED(arg2); ARG_UNUSED(arg3); unsigned int key = arch_irq_lock(); uint32_t dt, start_ms = k_uptime_get_32(); k_sem_give(&cpuhold_sem); #if defined(CONFIG_ARM64) && defined(CONFIG_FPU_SHARING) /* * We'll be spinning with IRQs disabled. The flush-your-FPU request * IPI will never be serviced during that time. Therefore we flush * the FPU preemptively here to prevent any other CPU waiting after * this CPU forever and deadlock the system. */ extern void z_arm64_flush_local_fpu(void); z_arm64_flush_local_fpu(); #endif while (cpuhold_active) { k_busy_wait(1000); } /* Holding the CPU via spinning is expensive, and abusing this * for long-running test cases tends to overload the CI system * (qemu runs separate CPUs in different threads, but the CI * logic views it as one "job") and cause other test failures. */ dt = k_uptime_get_32() - start_ms; zassert_true(dt < 3000, "1cpu test took too long (%d ms)", dt); arch_irq_unlock(key); } void z_impl_z_test_1cpu_start(void) { cpuhold_active = 1; char tname[CONFIG_THREAD_MAX_NAME_LEN]; k_sem_init(&cpuhold_sem, 0, 999); /* Spawn N-1 threads to "hold" the other CPUs, waiting for * each to signal us that it's locked and spinning. * * Note that NUM_CPUHOLD can be a value that causes coverity * to flag the following loop as DEADCODE so suppress the warning. */ /* coverity[DEADCODE] */ for (int i = 0; i < NUM_CPUHOLD; i++) { k_thread_create(&cpuhold_threads[i], cpuhold_stacks[i], CPUHOLD_STACK_SZ, (k_thread_entry_t)cpu_hold, NULL, NULL, NULL, K_HIGHEST_THREAD_PRIO, 0, K_NO_WAIT); if (IS_ENABLED(CONFIG_THREAD_NAME)) { snprintk(tname, CONFIG_THREAD_MAX_NAME_LEN, "cpuhold%02d", i); k_thread_name_set(&cpuhold_threads[i], tname); } k_sem_take(&cpuhold_sem, K_FOREVER); } } void z_impl_z_test_1cpu_stop(void) { cpuhold_active = 0; /* Note that NUM_CPUHOLD can be a value that causes coverity * to flag the following loop as DEADCODE so suppress the warning. */ /* coverity[DEADCODE] */ for (int i = 0; i < NUM_CPUHOLD; i++) { k_thread_abort(&cpuhold_threads[i]); } } #ifdef CONFIG_USERSPACE void z_vrfy_z_test_1cpu_start(void) { z_impl_z_test_1cpu_start(); } #include <syscalls/z_test_1cpu_start_mrsh.c> void z_vrfy_z_test_1cpu_stop(void) { z_impl_z_test_1cpu_stop(); } #include <syscalls/z_test_1cpu_stop_mrsh.c> #endif /* CONFIG_USERSPACE */ #endif __maybe_unused static void run_test_rules(bool is_before, struct ztest_unit_test *test, void *data) { for (struct ztest_test_rule *rule = _ztest_test_rule_list_start; rule < _ztest_test_rule_list_end; ++rule) { if (is_before && rule->before_each) { rule->before_each(test, data); } else if (!is_before && rule->after_each) { rule->after_each(test, data); } } } static void run_test_functions(struct ztest_suite_node *suite, struct ztest_unit_test *test, void *data) { phase = TEST_PHASE_TEST; test->test(data); } enum ztest_result { ZTEST_RESULT_PENDING, ZTEST_RESULT_PASS, ZTEST_RESULT_FAIL, ZTEST_RESULT_SKIP, ZTEST_RESULT_SUITE_SKIP, ZTEST_RESULT_SUITE_FAIL, }; COND_CODE_1(KERNEL, (ZTEST_BMEM), ()) static enum ztest_result test_result; static int get_final_test_result(const struct ztest_unit_test *test, int ret) { enum ztest_expected_result expected_result = -1; for (struct ztest_expected_result_entry *expectation = _ztest_expected_result_entry_list_start; expectation < _ztest_expected_result_entry_list_end; ++expectation) { if (strcmp(expectation->test_name, test->name) == 0 && strcmp(expectation->test_suite_name, test->test_suite_name) == 0) { expected_result = expectation->expected_result; break; } } if (expected_result == ZTEST_EXPECTED_RESULT_FAIL) { /* Expected a failure: * - If we got a failure, return TC_PASS * - Otherwise force a failure */ return (ret == TC_FAIL) ? TC_PASS : TC_FAIL; } if (expected_result == ZTEST_EXPECTED_RESULT_SKIP) { /* Expected a skip: * - If we got a skip, return TC_PASS * - Otherwise force a failure */ return (ret == TC_SKIP) ? TC_PASS : TC_FAIL; } /* No expectation was made, no change is needed. */ return ret; } /** * @brief Get a friendly name string for a given test phrase. * * @param phase an enum ztest_phase value describing the desired test phase * @returns a string name for `phase` */ static inline const char *get_friendly_phase_name(enum ztest_phase phase) { switch (phase) { case TEST_PHASE_SETUP: return "setup"; case TEST_PHASE_BEFORE: return "before"; case TEST_PHASE_TEST: return "test"; case TEST_PHASE_AFTER: return "after"; case TEST_PHASE_TEARDOWN: return "teardown"; case TEST_PHASE_FRAMEWORK: return "framework"; default: return "(unknown)"; } } #ifndef KERNEL /* Static code analysis tool can raise a violation that the standard header * <setjmp.h> shall not be used. * * setjmp is using in a test code, not in a runtime code, it is acceptable. * It is a deliberate deviation. */ #include <setjmp.h> /* parasoft-suppress MISRAC2012-RULE_21_4-a MISRAC2012-RULE_21_4-b*/ #include <signal.h> #include <stdlib.h> #include <string.h> #define FAIL_FAST 0 static jmp_buf test_fail; static jmp_buf test_pass; static jmp_buf test_skip; static jmp_buf stack_fail; static jmp_buf test_suite_fail; void ztest_test_fail(void) { switch (phase) { case TEST_PHASE_SETUP: PRINT(" at %s function\n", get_friendly_phase_name(phase)); longjmp(test_suite_fail, 1); case TEST_PHASE_BEFORE: case TEST_PHASE_TEST: PRINT(" at %s function\n", get_friendly_phase_name(phase)); longjmp(test_fail, 1); case TEST_PHASE_AFTER: case TEST_PHASE_TEARDOWN: case TEST_PHASE_FRAMEWORK: PRINT(" ERROR: cannot fail in test '%s()', bailing\n", get_friendly_phase_name(phase)); longjmp(stack_fail, 1); } } void ztest_test_pass(void) { if (phase == TEST_PHASE_TEST) { longjmp(test_pass, 1); } PRINT(" ERROR: cannot pass in test '%s()', bailing\n", get_friendly_phase_name(phase)); longjmp(stack_fail, 1); } void ztest_test_skip(void) { switch (phase) { case TEST_PHASE_SETUP: case TEST_PHASE_BEFORE: case TEST_PHASE_TEST: longjmp(test_skip, 1); default: PRINT(" ERROR: cannot skip in test '%s()', bailing\n", get_friendly_phase_name(phase)); longjmp(stack_fail, 1); } } static int run_test(struct ztest_suite_node *suite, struct ztest_unit_test *test, void *data) { int ret = TC_PASS; TC_START(test->name); phase = TEST_PHASE_BEFORE; if (test_result == ZTEST_RESULT_SUITE_FAIL) { ret = TC_FAIL; goto out; } if (setjmp(test_fail)) { ret = TC_FAIL; goto out; } if (setjmp(test_pass)) { ret = TC_PASS; goto out; } if (setjmp(test_skip)) { ret = TC_SKIP; goto out; } run_test_rules(/*is_before=*/true, test, data); if (suite->before) { suite->before(data); } run_test_functions(suite, test, data); out: phase = TEST_PHASE_AFTER; if (test_result != ZTEST_RESULT_SUITE_FAIL) { if (suite->after != NULL) { suite->after(data); } run_test_rules(/*is_before=*/false, test, data); } phase = TEST_PHASE_FRAMEWORK; ret |= cleanup_test(test); ret = get_final_test_result(test, ret); Z_TC_END_RESULT(ret, test->name); return ret; } #else /* KERNEL */ /* Zephyr's probably going to cause all tests to fail if one test fails, so * skip the rest of tests if one of them fails */ #ifdef CONFIG_ZTEST_FAIL_FAST #define FAIL_FAST 1 #else #define FAIL_FAST 0 #endif K_THREAD_STACK_DEFINE(ztest_thread_stack, CONFIG_ZTEST_STACK_SIZE + CONFIG_TEST_EXTRA_STACK_SIZE); static void test_finalize(void) { if (IS_ENABLED(CONFIG_MULTITHREADING)) { k_thread_abort(&ztest_thread); k_thread_abort(k_current_get()); } } void ztest_test_fail(void) { switch (phase) { case TEST_PHASE_SETUP: test_result = ZTEST_RESULT_SUITE_FAIL; break; case TEST_PHASE_BEFORE: case TEST_PHASE_TEST: test_result = ZTEST_RESULT_FAIL; test_finalize(); break; default: PRINT(" ERROR: cannot fail in test '%s()', bailing\n", get_friendly_phase_name(phase)); test_status = ZTEST_STATUS_CRITICAL_ERROR; break; } } void ztest_test_pass(void) { switch (phase) { case TEST_PHASE_TEST: test_result = ZTEST_RESULT_PASS; test_finalize(); break; default: PRINT(" ERROR: cannot pass in test '%s()', bailing\n", get_friendly_phase_name(phase)); test_status = ZTEST_STATUS_CRITICAL_ERROR; if (phase == TEST_PHASE_BEFORE) { test_finalize(); } } } void ztest_test_skip(void) { switch (phase) { case TEST_PHASE_SETUP: test_result = ZTEST_RESULT_SUITE_SKIP; break; case TEST_PHASE_BEFORE: case TEST_PHASE_TEST: test_result = ZTEST_RESULT_SKIP; test_finalize(); break; default: PRINT(" ERROR: cannot skip in test '%s()', bailing\n", get_friendly_phase_name(phase)); test_status = ZTEST_STATUS_CRITICAL_ERROR; break; } } void ztest_simple_1cpu_before(void *data) { ARG_UNUSED(data); z_test_1cpu_start(); } void ztest_simple_1cpu_after(void *data) { ARG_UNUSED(data); z_test_1cpu_stop(); } static void test_cb(void *a, void *b, void *c) { struct ztest_suite_node *suite = a; struct ztest_unit_test *test = b; test_result = ZTEST_RESULT_PENDING; run_test_rules(/*is_before=*/true, test, /*data=*/c); if (suite->before) { suite->before(/*data=*/c); } run_test_functions(suite, test, c); test_result = ZTEST_RESULT_PASS; } static int run_test(struct ztest_suite_node *suite, struct ztest_unit_test *test, void *data) { int ret = TC_PASS; TC_START(test->name); phase = TEST_PHASE_BEFORE; /* If the suite's setup function marked us as skipped, don't bother * running the tests. */ if (IS_ENABLED(CONFIG_MULTITHREADING)) { get_start_time_cyc(); k_thread_create(&ztest_thread, ztest_thread_stack, K_THREAD_STACK_SIZEOF(ztest_thread_stack), (k_thread_entry_t)test_cb, suite, test, data, CONFIG_ZTEST_THREAD_PRIORITY, test->thread_options | K_INHERIT_PERMS, K_FOREVER); k_thread_access_grant(&ztest_thread, suite, test, suite->stats); if (test->name != NULL) { k_thread_name_set(&ztest_thread, test->name); } /* Only start the thread if we're not skipping the suite */ if (test_result != ZTEST_RESULT_SUITE_SKIP && test_result != ZTEST_RESULT_SUITE_FAIL) { k_thread_start(&ztest_thread); k_thread_join(&ztest_thread, K_FOREVER); } } else if (test_result != ZTEST_RESULT_SUITE_SKIP && test_result != ZTEST_RESULT_SUITE_FAIL) { test_result = ZTEST_RESULT_PENDING; get_start_time_cyc(); run_test_rules(/*is_before=*/true, test, data); if (suite->before) { suite->before(data); } run_test_functions(suite, test, data); } phase = TEST_PHASE_AFTER; if (suite->after != NULL) { suite->after(data); } run_test_rules(/*is_before=*/false, test, data); get_test_duration_ms(); if (tc_spend_time > test->stats->duration_worst_ms) { test->stats->duration_worst_ms = tc_spend_time; } phase = TEST_PHASE_FRAMEWORK; /* Flush all logs in case deferred mode and default logging thread are used. */ while (IS_ENABLED(CONFIG_TEST_LOGGING_FLUSH_AFTER_TEST) && IS_ENABLED(CONFIG_LOG_PROCESS_THREAD) && log_data_pending()) { k_msleep(100); } if (test_result == ZTEST_RESULT_FAIL || test_result == ZTEST_RESULT_SUITE_FAIL) { ret = TC_FAIL; } else if (test_result == ZTEST_RESULT_SKIP || test_result == ZTEST_RESULT_SUITE_SKIP) { ret = TC_SKIP; } if (test_result == ZTEST_RESULT_PASS || !FAIL_FAST) { ret |= cleanup_test(test); } ret = get_final_test_result(test, ret); Z_TC_END_RESULT(ret, test->name); return ret; } #endif /* !KERNEL */ static struct ztest_suite_node *ztest_find_test_suite(const char *name) { struct ztest_suite_node *node; for (node = _ztest_suite_node_list_start; node < _ztest_suite_node_list_end; ++node) { if (strcmp(name, node->name) == 0) { return node; } } return NULL; } struct ztest_unit_test *z_ztest_get_next_test(const char *suite, struct ztest_unit_test *prev) { struct ztest_unit_test *test = (prev == NULL) ? _ztest_unit_test_list_start : prev + 1; for (; test < _ztest_unit_test_list_end; ++test) { if (strcmp(suite, test->test_suite_name) == 0) { return test; } } return NULL; } #ifdef CONFIG_ZTEST_SHUFFLE static void z_ztest_shuffle(void *dest[], intptr_t start, size_t num_items, size_t element_size) { for (size_t i = 0; i < num_items; ++i) { int pos = sys_rand32_get() % num_items; const int start_pos = pos; /* Get the next valid position */ while (dest[pos] != NULL) { pos = (pos + 1) % num_items; __ASSERT_NO_MSG(pos != start_pos); } dest[pos] = (void *)(start + (i * element_size)); } } #endif /* CONFIG_ZTEST_SHUFFLE */ static int z_ztest_run_test_suite_ptr(struct ztest_suite_node *suite) { struct ztest_unit_test *test = NULL; void *data = NULL; int fail = 0; int tc_result = TC_PASS; if (test_status < 0) { return test_status; } if (suite == NULL) { test_status = ZTEST_STATUS_CRITICAL_ERROR; return -1; } #ifndef KERNEL if (setjmp(stack_fail)) { PRINT("TESTSUITE crashed.\n"); test_status = ZTEST_STATUS_CRITICAL_ERROR; end_report(); exit(1); } #else k_object_access_all_grant(&ztest_thread); #endif TC_SUITE_START(suite->name); test_result = ZTEST_RESULT_PENDING; phase = TEST_PHASE_SETUP; #ifndef KERNEL if (setjmp(test_suite_fail)) { test_result = ZTEST_RESULT_SUITE_FAIL; } #endif if (test_result != ZTEST_RESULT_SUITE_FAIL && suite->setup != NULL) { data = suite->setup(); } for (int i = 0; i < NUM_ITER_PER_TEST; i++) { fail = 0; #ifdef CONFIG_ZTEST_SHUFFLE struct ztest_unit_test *tests_to_run[ZTEST_TEST_COUNT]; memset(tests_to_run, 0, ZTEST_TEST_COUNT * sizeof(struct ztest_unit_test *)); z_ztest_shuffle((void **)tests_to_run, (intptr_t)_ztest_unit_test_list_start, ZTEST_TEST_COUNT, sizeof(struct ztest_unit_test)); for (size_t i = 0; i < ZTEST_TEST_COUNT; ++i) { test = tests_to_run[i]; /* Make sure that the test belongs to this suite */ if (strcmp(suite->name, test->test_suite_name) != 0) { continue; } if (ztest_api.should_test_run(suite->name, test->name)) { test->stats->run_count++; tc_result = run_test(suite, test, data); if (tc_result == TC_PASS) { test->stats->pass_count++; } else if (tc_result == TC_SKIP) { test->stats->skip_count++; } else if (tc_result == TC_FAIL) { test->stats->fail_count++; } if (tc_result == TC_FAIL) { fail++; } } if ((fail && FAIL_FAST) || test_status == ZTEST_STATUS_CRITICAL_ERROR) { break; } } #else while (((test = z_ztest_get_next_test(suite->name, test)) != NULL)) { if (ztest_api.should_test_run(suite->name, test->name)) { test->stats->run_count++; tc_result = run_test(suite, test, data); if (tc_result == TC_PASS) { test->stats->pass_count++; } else if (tc_result == TC_SKIP) { test->stats->skip_count++; } else if (tc_result == TC_FAIL) { test->stats->fail_count++; } if (tc_result == TC_FAIL) { fail++; } } if ((fail && FAIL_FAST) || test_status == ZTEST_STATUS_CRITICAL_ERROR) { break; } } #endif if (test_status == ZTEST_STATUS_OK && fail != 0) { test_status = ZTEST_STATUS_HAS_FAILURE; } } TC_SUITE_END(suite->name, (fail > 0 ? TC_FAIL : TC_PASS)); phase = TEST_PHASE_TEARDOWN; if (suite->teardown != NULL) { suite->teardown(data); } return fail; } int z_ztest_run_test_suite(const char *name) { return z_ztest_run_test_suite_ptr(ztest_find_test_suite(name)); } #ifdef CONFIG_USERSPACE K_APPMEM_PARTITION_DEFINE(ztest_mem_partition); #endif static void __ztest_init_unit_test_result_for_suite(struct ztest_suite_node *suite) { struct ztest_unit_test *test = NULL; while (((test = z_ztest_get_next_test(suite->name, test)) != NULL)) { test->stats->run_count = 0; test->stats->skip_count = 0; test->stats->fail_count = 0; test->stats->pass_count = 0; test->stats->duration_worst_ms = 0; } } static void flush_log(void) { if (IS_ENABLED(CONFIG_LOG_PROCESS_THREAD)) { while (log_data_pending()) { k_sleep(K_MSEC(10)); } k_sleep(K_MSEC(10)); } else { while (LOG_PROCESS()) { } } } /* Show one line summary for a test suite. */ static void __ztest_show_suite_summary_oneline(struct ztest_suite_node *suite) { int distinct_pass = 0, distinct_fail = 0, distinct_skip = 0, distinct_total = 0; int effective_total = 0; int expanded_pass = 0, expanded_passrate = 0; int passrate_major = 0, passrate_minor = 0, passrate_tail = 0; int suite_result = TC_PASS; struct ztest_unit_test *test = NULL; unsigned int suite_duration_worst_ms = 0; /** summary of disctinct run */ while (((test = z_ztest_get_next_test(suite->name, test)) != NULL)) { distinct_total++; suite_duration_worst_ms += test->stats->duration_worst_ms; if (test->stats->skip_count == test->stats->run_count) { distinct_skip++; } else if (test->stats->pass_count == test->stats->run_count) { distinct_pass++; } else { distinct_fail++; } } if (distinct_skip == distinct_total) { suite_result = TC_SKIP; passrate_major = passrate_minor = 0; } else { suite_result = (distinct_fail > 0) ? TC_FAIL : TC_PASS; effective_total = distinct_total - distinct_skip; expanded_pass = distinct_pass * 100000; expanded_passrate = expanded_pass / effective_total; passrate_major = expanded_passrate / 1000; passrate_minor = (expanded_passrate - passrate_major * 1000) / 10; passrate_tail = expanded_passrate - passrate_major * 1000 - passrate_minor * 10; if (passrate_tail >= 5) { /* rounding */ passrate_minor++; } } TC_SUMMARY_PRINT("SUITE %s - %3d.%02d%% [%s]: pass = %d, fail = %d, " "skip = %d, total = %d duration = %u.%03u seconds\n", TC_RESULT_TO_STR(suite_result), passrate_major, passrate_minor, suite->name, distinct_pass, distinct_fail, distinct_skip, distinct_total, suite_duration_worst_ms / 1000, suite_duration_worst_ms % 1000); flush_log(); } #ifdef CONFIG_ZTEST_VERBOSE_SUMMARY static void __ztest_show_suite_summary_verbose(struct ztest_suite_node *suite) { struct ztest_unit_test *test = NULL; int tc_result = TC_PASS; int flush_frequency = 0; __ztest_show_suite_summary_oneline(suite); while (((test = z_ztest_get_next_test(suite->name, test)) != NULL)) { if (test->stats->skip_count == test->stats->run_count) { tc_result = TC_SKIP; } else if (test->stats->pass_count == test->stats->run_count) { tc_result = TC_PASS; } else { tc_result = TC_FAIL; } TC_SUMMARY_PRINT(" - %s - [%s.%s] duration = %u.%03u seconds\n", TC_RESULT_TO_STR(tc_result), test->test_suite_name, test->name, test->stats->duration_worst_ms / 1000, test->stats->duration_worst_ms % 1000); if (flush_frequency % 3 == 0) { /** Reduce the flush frequencey a bit to speed up the output */ flush_log(); } flush_frequency++; } TC_SUMMARY_PRINT("\n"); flush_log(); } #endif static void __ztest_show_suite_summary(void) { /* Flush the log a lot to ensure that no summary content * is dropped if it goes through the logging subsystem. */ flush_log(); TC_SUMMARY_PRINT("\n------ TESTSUITE SUMMARY START ------\n\n"); flush_log(); for (struct ztest_suite_node *ptr = _ztest_suite_node_list_start; ptr < _ztest_suite_node_list_end; ++ptr) { #ifdef CONFIG_ZTEST_VERBOSE_SUMMARY __ztest_show_suite_summary_verbose(ptr); #else __ztest_show_suite_summary_oneline(ptr); #endif } TC_SUMMARY_PRINT("------ TESTSUITE SUMMARY END ------\n\n"); flush_log(); } static int __ztest_run_test_suite(struct ztest_suite_node *ptr, const void *state) { struct ztest_suite_stats *stats = ptr->stats; int count = 0; __ztest_init_unit_test_result_for_suite(ptr); for (int i = 0; i < NUM_ITER_PER_SUITE; i++) { if (ztest_api.should_suite_run(state, ptr)) { int fail = z_ztest_run_test_suite_ptr(ptr); count++; stats->run_count++; stats->fail_count += (fail != 0) ? 1 : 0; } else { stats->skip_count++; } } return count; } int z_impl_ztest_run_test_suites(const void *state) { int count = 0; if (test_status == ZTEST_STATUS_CRITICAL_ERROR) { return count; } #ifdef CONFIG_ZTEST_SHUFFLE struct ztest_suite_node *suites_to_run[ZTEST_SUITE_COUNT]; memset(suites_to_run, 0, ZTEST_SUITE_COUNT * sizeof(struct ztest_suite_node *)); z_ztest_shuffle((void **)suites_to_run, (intptr_t)_ztest_suite_node_list_start, ZTEST_SUITE_COUNT, sizeof(struct ztest_suite_node)); for (size_t i = 0; i < ZTEST_SUITE_COUNT; ++i) { count += __ztest_run_test_suite(suites_to_run[i], state); /* Stop running tests if we have a critical error or if we have a failure and * FAIL_FAST was set */ if (test_status == ZTEST_STATUS_CRITICAL_ERROR || (test_status == ZTEST_STATUS_HAS_FAILURE && FAIL_FAST)) { break; } } #else for (struct ztest_suite_node *ptr = _ztest_suite_node_list_start; ptr < _ztest_suite_node_list_end; ++ptr) { count += __ztest_run_test_suite(ptr, state); /* Stop running tests if we have a critical error or if we have a failure and * FAIL_FAST was set */ if (test_status == ZTEST_STATUS_CRITICAL_ERROR || (test_status == ZTEST_STATUS_HAS_FAILURE && FAIL_FAST)) { break; } } #endif __ztest_show_suite_summary(); return count; } void ztest_verify_all_test_suites_ran(void) { bool all_tests_run = true; struct ztest_suite_node *suite; struct ztest_unit_test *test; if (IS_ENABLED(CONFIG_ZTEST_VERIFY_RUN_ALL)) { for (suite = _ztest_suite_node_list_start; suite < _ztest_suite_node_list_end; ++suite) { if (suite->stats->run_count < 1) { PRINT("ERROR: Test suite '%s' did not run.\n", suite->name); all_tests_run = false; } } for (test = _ztest_unit_test_list_start; test < _ztest_unit_test_list_end; ++test) { suite = ztest_find_test_suite(test->test_suite_name); if (suite == NULL) { PRINT("ERROR: Test '%s' assigned to test suite '%s' which doesn't " "exist\n", test->name, test->test_suite_name); all_tests_run = false; } } if (!all_tests_run) { test_status = ZTEST_STATUS_HAS_FAILURE; } } for (test = _ztest_unit_test_list_start; test < _ztest_unit_test_list_end; ++test) { if (test->stats->fail_count + test->stats->pass_count + test->stats->skip_count != test->stats->run_count) { PRINT("Bad stats for %s.%s\n", test->test_suite_name, test->name); test_status = 1; } } } void ztest_run_all(const void *state) { ztest_api.run_all(state); } void __weak test_main(void) { ztest_run_all(NULL); ztest_verify_all_test_suites_ran(); } #ifndef KERNEL int main(void) { z_init_mock(); test_main(); end_report(); return test_status; } #else void main(void) { #ifdef CONFIG_USERSPACE /* Partition containing globals tagged with ZTEST_DMEM and ZTEST_BMEM * macros. Any variables that user code may reference need to be * placed in this partition if no other memory domain configuration * is made. */ k_mem_domain_add_partition(&k_mem_domain_default, &ztest_mem_partition); #ifdef Z_MALLOC_PARTITION_EXISTS /* Allow access to malloc() memory */ k_mem_domain_add_partition(&k_mem_domain_default, &z_malloc_partition); #endif #endif /* CONFIG_USERSPACE */ z_init_mock(); test_main(); end_report(); flush_log(); LOG_PANIC(); if (IS_ENABLED(CONFIG_ZTEST_RETEST_IF_PASSED)) { static __noinit struct { uint32_t magic; uint32_t boots; } state; const uint32_t magic = 0x152ac523; if (state.magic != magic) { state.magic = magic; state.boots = 0; } state.boots += 1; if (test_status == 0) { PRINT("Reset board #%u to test again\n", state.boots); k_msleep(10); sys_reboot(SYS_REBOOT_COLD); } else { PRINT("Failed after %u attempts\n", state.boots); state.boots = 0; } } } #endif |