test/test-main.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright 2021 Google LLC
   4  * Written by Simon Glass <sjg@chromium.org>
   5  */
   6
   7 #include <common.h>
   8 #include <console.h>
   9 #include <dm.h>
  10 #include <asm/state.h>
  11 #include <dm/root.h>
  12 #include <dm/test.h>
  13 #include <dm/uclass-internal.h>
  14 #include <test/test.h>
  15 #include <test/ut.h>
  16
  17 DECLARE_GLOBAL_DATA_PTR;
  18
  19 /**
  20  * dm_test_pre_run() - Get ready to run a driver model test
  21  *
  22  * This clears out the driver model data structures. For sandbox it resets the
  23  * state structure
  24  *
  25  * @uts: Test state
  26  */
  27 static int dm_test_pre_run(struct unit_test_state *uts)
  28 {
  29         bool of_live = uts->of_live;
  30
  31         uts->root = NULL;
  32         uts->testdev = NULL;
  33         uts->force_fail_alloc = false;
  34         uts->skip_post_probe = false;
  35         gd->dm_root = NULL;
  36         if (!CONFIG_IS_ENABLED(OF_PLATDATA))
  37                 memset(dm_testdrv_op_count, '\0', sizeof(dm_testdrv_op_count));
  38         state_reset_for_test(state_get_current());
  39
  40         /* Determine whether to make the live tree available */
  41         gd_set_of_root(of_live ? uts->of_root : NULL);
  42         ut_assertok(dm_init(of_live));
  43         uts->root = dm_root();
  44
  45         return 0;
  46 }
  47
  48 static int dm_test_post_run(struct unit_test_state *uts)
  49 {
  50         int id;
  51
  52         for (id = 0; id < UCLASS_COUNT; id++) {
  53                 struct uclass *uc;
  54
  55                 /*
  56                  * If the uclass doesn't exist we don't want to create it. So
  57                  * check that here before we call uclass_find_device().
  58                  */
  59                 uc = uclass_find(id);
  60                 if (!uc)
  61                         continue;
  62                 ut_assertok(uclass_destroy(uc));
  63         }
  64
  65         return 0;
  66 }
  67
  68 /* Ensure all the test devices are probed */
  69 static int do_autoprobe(struct unit_test_state *uts)
  70 {
  71         struct udevice *dev;
  72         int ret;
  73
  74         /* Scanning the uclass is enough to probe all the devices */
  75         for (ret = uclass_first_device(UCLASS_TEST, &dev);
  76              dev;
  77              ret = uclass_next_device(&dev))
  78                 ;
  79
  80         return ret;
  81 }
  82
  83 int test_pre_run(struct unit_test_state *uts, struct unit_test *test)
  84 {
  85         if (test->flags & UT_TESTF_DM)
  86                 ut_assertok(dm_test_pre_run(uts));
  87
  88         ut_set_skip_delays(uts, false);
  89
  90         uts->start = mallinfo();
  91
  92         if (test->flags & UT_TESTF_SCAN_PDATA)
  93                 ut_assertok(dm_scan_plat(false));
  94
  95         if (test->flags & UT_TESTF_PROBE_TEST)
  96                 ut_assertok(do_autoprobe(uts));
  97
  98         if (!CONFIG_IS_ENABLED(OF_PLATDATA) &&
  99             (test->flags & UT_TESTF_SCAN_FDT))
 100                 ut_assertok(dm_extended_scan(false));
 101
 102         if (test->flags & UT_TESTF_CONSOLE_REC) {
 103                 int ret = console_record_reset_enable();
 104
 105                 if (ret) {
 106                         printf("Skipping: Console recording disabled\n");
 107                         return -EAGAIN;
 108                 }
 109         }
 110         ut_silence_console(uts);
 111
 112         return 0;
 113 }
 114
 115 int test_post_run(struct unit_test_state *uts, struct unit_test *test)
 116 {
 117         ut_unsilence_console(uts);
 118         if (test->flags & UT_TESTF_DM)
 119                 ut_assertok(dm_test_post_run(uts));
 120
 121         return 0;
 122 }
 123
 124 int ut_run_tests(struct unit_test_state *uts, const char *prefix,
 125                  struct unit_test *tests, int count, const char *select_name)
 126 {
 127         struct unit_test *test;
 128         int prefix_len = prefix ? strlen(prefix) : 0;
 129         int found = 0;
 130
 131         for (test = tests; test < tests + count; test++) {
 132                 const char *test_name = test->name;
 133                 int ret;
 134
 135                 /* Remove the prefix */
 136                 if (prefix && !strncmp(test_name, prefix, prefix_len))
 137                         test_name += prefix_len;
 138
 139                 if (select_name && strcmp(select_name, test_name))
 140                         continue;
 141                 printf("Test: %s\n", test_name);
 142                 found++;
 143
 144                 ret = test_pre_run(uts, test);
 145                 if (ret == -EAGAIN)
 146                         continue;
 147                 if (ret)
 148                         return ret;
 149
 150                 test->func(uts);
 151
 152                 ret = test_post_run(uts, test);
 153                 if (ret)
 154                         return ret;
 155         }
 156         if (select_name && !found)
 157                 return -ENOENT;
 158
 159         return uts->fail_count ? -EBADF : 0;
 160 }
 161
 162 int ut_run_list(const char *category, const char *prefix,
 163                 struct unit_test *tests, int count, const char *select_name)
 164 {
 165         struct unit_test_state uts = { .fail_count = 0 };
 166         int ret;
 167
 168         if (!select_name)
 169                 printf("Running %d %s tests\n", count, category);
 170
 171         ret = ut_run_tests(&uts, prefix, tests, count, select_name);
 172
 173         if (ret == -ENOENT)
 174                 printf("Test '%s' not found\n", select_name);
 175         else
 176                 printf("Failures: %d\n", uts.fail_count);
 177
 178         return ret;
 179 }