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         /*
  66          * With of-platdata-inst the uclasses are created at build time. If we
  67          * destroy them we cannot get them back since uclass_add() is not
  68          * supported. So skip this.
  69          */
  70         if (!CONFIG_IS_ENABLED(OF_PLATDATA_INST)) {
  71                 for (id = 0; id < UCLASS_COUNT; id++) {
  72                         struct uclass *uc;
  73
  74                         /*
  75                          * If the uclass doesn't exist we don't want to create
  76                          * it. So check that here before we call
  77                          * uclass_find_device().
  78                          */
  79                         uc = uclass_find(id);
  80                         if (!uc)
  81                                 continue;
  82                         ut_assertok(uclass_destroy(uc));
  83                 }
  84         }
  85
  86         return 0;
  87 }
  88
  89 /* Ensure all the test devices are probed */
  90 static int do_autoprobe(struct unit_test_state *uts)
  91 {
  92         struct udevice *dev;
  93         int ret;
  94
  95         /* Scanning the uclass is enough to probe all the devices */
  96         for (ret = uclass_first_device(UCLASS_TEST, &dev);
  97              dev;
  98              ret = uclass_next_device(&dev))
  99                 ;
 100
 101         return ret;
 102 }
 103
 104 /*
 105  * ut_test_run_on_flattree() - Check if we should run a test with flat DT
 106  *
 107  * This skips long/slow tests where there is not much value in running a flat
 108  * DT test in addition to a live DT test.
 109  *
 110  * @return true to run the given test on the flat device tree
 111  */
 112 static bool ut_test_run_on_flattree(struct unit_test *test)
 113 {
 114         const char *fname = strrchr(test->file, '/') + 1;
 115
 116         if (!(test->flags & UT_TESTF_DM))
 117                 return false;
 118
 119         return !strstr(fname, "video") || strstr(test->name, "video_base");
 120 }
 121
 122 /**
 123  * test_matches() - Check if a test should be run
 124  *
 125  * This checks if the a test should be run. In the normal case of running all
 126  * tests, @select_name is NULL.
 127  *
 128  * @prefix: String prefix for the tests. Any tests that have this prefix will be
 129  *      printed without the prefix, so that it is easier to see the unique part
 130  *      of the test name. If NULL, any suite name (xxx_test) is considered to be
 131  *      a prefix.
 132  * @test_name: Name of current test
 133  * @select_name: Name of test to run (or NULL for all)
 134  * @return true to run this test, false to skip it
 135  */
 136 static bool test_matches(const char *prefix, const char *test_name,
 137                          const char *select_name)
 138 {
 139         if (!select_name)
 140                 return true;
 141
 142         if (!strcmp(test_name, select_name))
 143                 return true;
 144
 145         if (!prefix) {
 146                 const char *p = strstr(test_name, "_test_");
 147
 148                 /* convert xxx_test_yyy to yyy, i.e. remove the suite name */
 149                 if (p)
 150                         test_name = p + 6;
 151         } else {
 152                 /* All tests have this prefix */
 153                 if (!strncmp(test_name, prefix, strlen(prefix)))
 154                         test_name += strlen(prefix);
 155         }
 156
 157         if (!strcmp(test_name, select_name))
 158                 return true;
 159
 160         return false;
 161 }
 162
 163 /**
 164  * ut_list_has_dm_tests() - Check if a list of tests has driver model ones
 165  *
 166  * @tests: List of tests to run
 167  * @count: Number of tests to ru
 168  * @return true if any of the tests have the UT_TESTF_DM flag
 169  */
 170 static bool ut_list_has_dm_tests(struct unit_test *tests, int count)
 171 {
 172         struct unit_test *test;
 173
 174         for (test = tests; test < tests + count; test++) {
 175                 if (test->flags & UT_TESTF_DM)
 176                         return true;
 177         }
 178
 179         return false;
 180 }
 181
 182 /**
 183  * dm_test_restore() Put things back to normal so sandbox works as expected
 184  *
 185  * @of_root: Value to set for of_root
 186  * @return 0 if OK, -ve on error
 187  */
 188 static int dm_test_restore(struct device_node *of_root)
 189 {
 190         int ret;
 191
 192         gd_set_of_root(of_root);
 193         gd->dm_root = NULL;
 194         ret = dm_init(CONFIG_IS_ENABLED(OF_LIVE));
 195         if (ret)
 196                 return ret;
 197         dm_scan_plat(false);
 198         if (!CONFIG_IS_ENABLED(OF_PLATDATA))
 199                 dm_scan_fdt(false);
 200
 201         return 0;
 202 }
 203
 204 /**
 205  * test_pre_run() - Handle any preparation needed to run a test
 206  *
 207  * @uts: Test state
 208  * @test: Test to prepare for
 209  * @return 0 if OK, -EAGAIN to skip this test since some required feature is not
 210  *      available, other -ve on error (meaning that testing cannot likely
 211  *      continue)
 212  */
 213 static int test_pre_run(struct unit_test_state *uts, struct unit_test *test)
 214 {
 215         if (test->flags & UT_TESTF_DM)
 216                 ut_assertok(dm_test_pre_run(uts));
 217
 218         ut_set_skip_delays(uts, false);
 219
 220         uts->start = mallinfo();
 221
 222         if (test->flags & UT_TESTF_SCAN_PDATA)
 223                 ut_assertok(dm_scan_plat(false));
 224
 225         if (test->flags & UT_TESTF_PROBE_TEST)
 226                 ut_assertok(do_autoprobe(uts));
 227
 228         if (!CONFIG_IS_ENABLED(OF_PLATDATA) &&
 229             (test->flags & UT_TESTF_SCAN_FDT))
 230                 ut_assertok(dm_extended_scan(false));
 231
 232         if (test->flags & UT_TESTF_CONSOLE_REC) {
 233                 int ret = console_record_reset_enable();
 234
 235                 if (ret) {
 236                         printf("Skipping: Console recording disabled\n");
 237                         return -EAGAIN;
 238                 }
 239         }
 240         ut_silence_console(uts);
 241
 242         return 0;
 243 }
 244
 245 /**
 246  * test_post_run() - Handle cleaning up after a test
 247  *
 248  * @uts: Test state
 249  * @test: Test to clean up after
 250  * @return 0 if OK, -ve on error (meaning that testing cannot likely continue)
 251  */
 252 static int test_post_run(struct unit_test_state *uts, struct unit_test *test)
 253 {
 254         ut_unsilence_console(uts);
 255         if (test->flags & UT_TESTF_DM)
 256                 ut_assertok(dm_test_post_run(uts));
 257
 258         return 0;
 259 }
 260
 261 /**
 262  * ut_run_test() - Run a single test
 263  *
 264  * This runs the test, handling any preparation and clean-up needed. It prints
 265  * the name of each test before running it.
 266  *
 267  * @uts: Test state to update. The caller should ensure that this is zeroed for
 268  *      the first call to this function. On exit, @uts->fail_count is
 269  *      incremented by the number of failures (0, one hopes)
 270  * @test_name: Test to run
 271  * @name: Name of test, possibly skipping a prefix that should not be displayed
 272  * @return 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
 273  *      any failed
 274  */
 275 static int ut_run_test(struct unit_test_state *uts, struct unit_test *test,
 276                        const char *test_name)
 277 {
 278         const char *fname = strrchr(test->file, '/') + 1;
 279         const char *note = "";
 280         int ret;
 281
 282         if ((test->flags & UT_TESTF_DM) && !uts->of_live)
 283                 note = " (flat tree)";
 284         printf("Test: %s: %s%s\n", test_name, fname, note);
 285
 286         /* Allow access to test state from drivers */
 287         test_set_state(uts);
 288
 289         ret = test_pre_run(uts, test);
 290         if (ret == -EAGAIN)
 291                 return -EAGAIN;
 292         if (ret)
 293                 return ret;
 294
 295         test->func(uts);
 296
 297         ret = test_post_run(uts, test);
 298         if (ret)
 299                 return ret;
 300
 301         test_set_state( NULL);
 302
 303         return 0;
 304 }
 305
 306 /**
 307  * ut_run_test_live_flat() - Run a test with both live and flat tree
 308  *
 309  * This calls ut_run_test() with livetree enabled, which is the standard setup
 310  * for runnig tests. Then, for driver model test, it calls it again with
 311  * livetree disabled. This allows checking of flattree being used when OF_LIVE
 312  * is enabled, as is the case in U-Boot proper before relocation, as well as in
 313  * SPL.
 314  *
 315  * @uts: Test state to update. The caller should ensure that this is zeroed for
 316  *      the first call to this function. On exit, @uts->fail_count is
 317  *      incremented by the number of failures (0, one hopes)
 318  * @test: Test to run
 319  * @name: Name of test, possibly skipping a prefix that should not be displayed
 320  * @return 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
 321  *      any failed
 322  */
 323 static int ut_run_test_live_flat(struct unit_test_state *uts,
 324                                  struct unit_test *test, const char *name)
 325 {
 326         int runs;
 327
 328         /* Run with the live tree if possible */
 329         runs = 0;
 330         if (CONFIG_IS_ENABLED(OF_LIVE)) {
 331                 if (!(test->flags & UT_TESTF_FLAT_TREE)) {
 332                         uts->of_live = true;
 333                         ut_assertok(ut_run_test(uts, test, test->name));
 334                         runs++;
 335                 }
 336         }
 337
 338         /*
 339          * Run with the flat tree if we couldn't run it with live tree,
 340          * or it is a core test.
 341          */
 342         if (!(test->flags & UT_TESTF_LIVE_TREE) &&
 343             (!runs || ut_test_run_on_flattree(test))) {
 344                 uts->of_live = false;
 345                 ut_assertok(ut_run_test(uts, test, test->name));
 346                 runs++;
 347         }
 348
 349         return 0;
 350 }
 351
 352 /**
 353  * ut_run_tests() - Run a set of tests
 354  *
 355  * This runs the tests, handling any preparation and clean-up needed. It prints
 356  * the name of each test before running it.
 357  *
 358  * @uts: Test state to update. The caller should ensure that this is zeroed for
 359  *      the first call to this function. On exit, @uts->fail_count is
 360  *      incremented by the number of failures (0, one hopes)
 361  * @prefix: String prefix for the tests. Any tests that have this prefix will be
 362  *      printed without the prefix, so that it is easier to see the unique part
 363  *      of the test name. If NULL, no prefix processing is done
 364  * @tests: List of tests to run
 365  * @count: Number of tests to run
 366  * @select_name: Name of a single test to run (from the list provided). If NULL
 367  *      then all tests are run
 368  * @return 0 if all tests passed, -ENOENT if test @select_name was not found,
 369  *      -EBADF if any failed
 370  */
 371 static int ut_run_tests(struct unit_test_state *uts, const char *prefix,
 372                         struct unit_test *tests, int count,
 373                         const char *select_name)
 374 {
 375         struct unit_test *test;
 376         int found = 0;
 377
 378         for (test = tests; test < tests + count; test++) {
 379                 const char *test_name = test->name;
 380                 int ret;
 381
 382                 if (!test_matches(prefix, test_name, select_name))
 383                         continue;
 384                 ret = ut_run_test_live_flat(uts, test, select_name);
 385                 found++;
 386                 if (ret == -EAGAIN)
 387                         continue;
 388                 if (ret)
 389                         return ret;
 390         }
 391         if (select_name && !found)
 392                 return -ENOENT;
 393
 394         return uts->fail_count ? -EBADF : 0;
 395 }
 396
 397 int ut_run_list(const char *category, const char *prefix,
 398                 struct unit_test *tests, int count, const char *select_name)
 399 {
 400         struct unit_test_state uts = { .fail_count = 0 };
 401         bool has_dm_tests = false;
 402         int ret;
 403
 404         if (!CONFIG_IS_ENABLED(OF_PLATDATA) &&
 405             ut_list_has_dm_tests(tests, count)) {
 406                 has_dm_tests = true;
 407                 /*
 408                  * If we have no device tree, or it only has a root node, then
 409                  * these * tests clearly aren't going to work...
 410                  */
 411                 if (!gd->fdt_blob || fdt_next_node(gd->fdt_blob, 0, NULL) < 0) {
 412                         puts("Please run with test device tree:\n"
 413                              "    ./u-boot -d arch/sandbox/dts/test.dtb\n");
 414                         return CMD_RET_FAILURE;
 415                 }
 416         }
 417
 418         if (!select_name)
 419                 printf("Running %d %s tests\n", count, category);
 420
 421         uts.of_root = gd_of_root();
 422         ret = ut_run_tests(&uts, prefix, tests, count, select_name);
 423
 424         if (ret == -ENOENT)
 425                 printf("Test '%s' not found\n", select_name);
 426         else
 427                 printf("Failures: %d\n", uts.fail_count);
 428
 429         /* Best efforts only...ignore errors */
 430         if (has_dm_tests)
 431                 dm_test_restore(uts.of_root);
 432
 433         return ret;
 434 }