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 /* This is valid when a test is running, NULL otherwise */
  20 static struct unit_test_state *cur_test_state;
  21
  22 struct unit_test_state *test_get_state(void)
  23 {
  24         return cur_test_state;
  25 }
  26
  27 void test_set_state(struct unit_test_state *uts)
  28 {
  29         cur_test_state = uts;
  30 }
  31
  32 /**
  33  * dm_test_pre_run() - Get ready to run a driver model test
  34  *
  35  * This clears out the driver model data structures. For sandbox it resets the
  36  * state structure
  37  *
  38  * @uts: Test state
  39  */
  40 static int dm_test_pre_run(struct unit_test_state *uts)
  41 {
  42         bool of_live = uts->of_live;
  43
  44         uts->root = NULL;
  45         uts->testdev = NULL;
  46         uts->force_fail_alloc = false;
  47         uts->skip_post_probe = false;
  48         gd->dm_root = NULL;
  49         if (!CONFIG_IS_ENABLED(OF_PLATDATA))
  50                 memset(dm_testdrv_op_count, '\0', sizeof(dm_testdrv_op_count));
  51         state_reset_for_test(state_get_current());
  52
  53         /* Determine whether to make the live tree available */
  54         gd_set_of_root(of_live ? uts->of_root : NULL);
  55         ut_assertok(dm_init(of_live));
  56         uts->root = dm_root();
  57
  58         return 0;
  59 }
  60
  61 static int dm_test_post_run(struct unit_test_state *uts)
  62 {
  63         int id;
  64
  65         for (id = 0; id < UCLASS_COUNT; id++) {
  66                 struct uclass *uc;
  67
  68                 /*
  69                  * If the uclass doesn't exist we don't want to create it. So
  70                  * check that here before we call uclass_find_device().
  71                  */
  72                 uc = uclass_find(id);
  73                 if (!uc)
  74                         continue;
  75                 ut_assertok(uclass_destroy(uc));
  76         }
  77
  78         return 0;
  79 }
  80
  81 /* Ensure all the test devices are probed */
  82 static int do_autoprobe(struct unit_test_state *uts)
  83 {
  84         struct udevice *dev;
  85         int ret;
  86
  87         /* Scanning the uclass is enough to probe all the devices */
  88         for (ret = uclass_first_device(UCLASS_TEST, &dev);
  89              dev;
  90              ret = uclass_next_device(&dev))
  91                 ;
  92
  93         return ret;
  94 }
  95
  96 /*
  97  * ut_test_run_on_flattree() - Check if we should run a test with flat DT
  98  *
  99  * This skips long/slow tests where there is not much value in running a flat
 100  * DT test in addition to a live DT test.
 101  *
 102  * @return true to run the given test on the flat device tree
 103  */
 104 static bool ut_test_run_on_flattree(struct unit_test *test)
 105 {
 106         const char *fname = strrchr(test->file, '/') + 1;
 107
 108         if (!(test->flags & UT_TESTF_DM))
 109                 return false;
 110
 111         return !strstr(fname, "video") || strstr(test->name, "video_base");
 112 }
 113
 114 /**
 115  * test_pre_run() - Handle any preparation needed to run a test
 116  *
 117  * @uts: Test state
 118  * @test: Test to prepare for
 119  * @return 0 if OK, -EAGAIN to skip this test since some required feature is not
 120  *      available, other -ve on error (meaning that testing cannot likely
 121  *      continue)
 122  */
 123 static int test_pre_run(struct unit_test_state *uts, struct unit_test *test)
 124 {
 125         if (test->flags & UT_TESTF_DM)
 126                 ut_assertok(dm_test_pre_run(uts));
 127
 128         ut_set_skip_delays(uts, false);
 129
 130         uts->start = mallinfo();
 131
 132         if (test->flags & UT_TESTF_SCAN_PDATA)
 133                 ut_assertok(dm_scan_plat(false));
 134
 135         if (test->flags & UT_TESTF_PROBE_TEST)
 136                 ut_assertok(do_autoprobe(uts));
 137
 138         if (!CONFIG_IS_ENABLED(OF_PLATDATA) &&
 139             (test->flags & UT_TESTF_SCAN_FDT))
 140                 ut_assertok(dm_extended_scan(false));
 141
 142         if (test->flags & UT_TESTF_CONSOLE_REC) {
 143                 int ret = console_record_reset_enable();
 144
 145                 if (ret) {
 146                         printf("Skipping: Console recording disabled\n");
 147                         return -EAGAIN;
 148                 }
 149         }
 150         ut_silence_console(uts);
 151
 152         return 0;
 153 }
 154
 155 /**
 156  * test_post_run() - Handle cleaning up after a test
 157  *
 158  * @uts: Test state
 159  * @test: Test to clean up after
 160  * @return 0 if OK, -ve on error (meaning that testing cannot likely continue)
 161  */
 162 static int test_post_run(struct unit_test_state *uts, struct unit_test *test)
 163 {
 164         ut_unsilence_console(uts);
 165         if (test->flags & UT_TESTF_DM)
 166                 ut_assertok(dm_test_post_run(uts));
 167
 168         return 0;
 169 }
 170
 171 /**
 172  * ut_run_test() - Run a single test
 173  *
 174  * This runs the test, handling any preparation and clean-up needed. It prints
 175  * the name of each test before running it.
 176  *
 177  * @uts: Test state to update. The caller should ensure that this is zeroed for
 178  *      the first call to this function. On exit, @uts->fail_count is
 179  *      incremented by the number of failures (0, one hopes)
 180  * @test_name: Test to run
 181  * @name: Name of test, possibly skipping a prefix that should not be displayed
 182  * @return 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
 183  *      any failed
 184  */
 185 static int ut_run_test(struct unit_test_state *uts, struct unit_test *test,
 186                        const char *test_name)
 187 {
 188         const char *fname = strrchr(test->file, '/') + 1;
 189         const char *note = "";
 190         int ret;
 191
 192         if ((test->flags & UT_TESTF_DM) && !uts->of_live)
 193                 note = " (flat tree)";
 194         printf("Test: %s: %s%s\n", test_name, fname, note);
 195
 196         /* Allow access to test state from drivers */
 197         test_set_state(uts);
 198
 199         ret = test_pre_run(uts, test);
 200         if (ret == -EAGAIN)
 201                 return -EAGAIN;
 202         if (ret)
 203                 return ret;
 204
 205         test->func(uts);
 206
 207         ret = test_post_run(uts, test);
 208         if (ret)
 209                 return ret;
 210
 211         test_set_state( NULL);
 212
 213         return 0;
 214 }
 215
 216 int ut_run_test_live_flat(struct unit_test_state *uts, struct unit_test *test,
 217                           const char *name)
 218 {
 219         int runs;
 220
 221         /* Run with the live tree if possible */
 222         runs = 0;
 223         if (CONFIG_IS_ENABLED(OF_LIVE)) {
 224                 if (!(test->flags & UT_TESTF_FLAT_TREE)) {
 225                         uts->of_live = true;
 226                         ut_assertok(ut_run_test(uts, test, test->name));
 227                         runs++;
 228                 }
 229         }
 230
 231         /*
 232          * Run with the flat tree if we couldn't run it with live tree,
 233          * or it is a core test.
 234          */
 235         if (!(test->flags & UT_TESTF_LIVE_TREE) &&
 236             (!runs || ut_test_run_on_flattree(test))) {
 237                 uts->of_live = false;
 238                 ut_assertok(ut_run_test(uts, test, test->name));
 239                 runs++;
 240         }
 241
 242         return 0;
 243 }
 244
 245 int ut_run_tests(struct unit_test_state *uts, const char *prefix,
 246                  struct unit_test *tests, int count, const char *select_name)
 247 {
 248         struct unit_test *test;
 249         int prefix_len = prefix ? strlen(prefix) : 0;
 250         int found = 0;
 251
 252         for (test = tests; test < tests + count; test++) {
 253                 const char *test_name = test->name;
 254                 int ret;
 255
 256                 /* Remove the prefix */
 257                 if (prefix && !strncmp(test_name, prefix, prefix_len))
 258                         test_name += prefix_len;
 259
 260                 if (select_name && strcmp(select_name, test_name))
 261                         continue;
 262                 ret = ut_run_test_live_flat(uts, test, test_name);
 263                 found++;
 264                 if (ret == -EAGAIN)
 265                         continue;
 266                 if (ret)
 267                         return ret;
 268         }
 269         if (select_name && !found)
 270                 return -ENOENT;
 271
 272         return uts->fail_count ? -EBADF : 0;
 273 }
 274
 275 int ut_run_list(const char *category, const char *prefix,
 276                 struct unit_test *tests, int count, const char *select_name)
 277 {
 278         struct unit_test_state uts = { .fail_count = 0 };
 279         int ret;
 280
 281         if (!select_name)
 282                 printf("Running %d %s tests\n", count, category);
 283
 284         ret = ut_run_tests(&uts, prefix, tests, count, select_name);
 285
 286         if (ret == -ENOENT)
 287                 printf("Test '%s' not found\n", select_name);
 288         else
 289                 printf("Failures: %d\n", uts.fail_count);
 290
 291         return ret;
 292 }