test: Allow showing basic information about tests
[platform/kernel/u-boot.git] / test / cmd_ut.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * (C) Copyright 2015
4  * Joe Hershberger, National Instruments, joe.hershberger@ni.com
5  */
6
7 #include <common.h>
8 #include <command.h>
9 #include <console.h>
10 #include <test/suites.h>
11 #include <test/test.h>
12 #include <test/ut.h>
13
14 static int do_ut_all(struct cmd_tbl *cmdtp, int flag, int argc,
15                      char *const argv[]);
16
17 static int do_ut_info(struct cmd_tbl *cmdtp, int flag, int argc,
18                       char *const argv[]);
19
20 int cmd_ut_category(const char *name, const char *prefix,
21                     struct unit_test *tests, int n_ents,
22                     int argc, char *const argv[])
23 {
24         int runs_per_text = 1;
25         bool force_run = false;
26         int ret;
27
28         while (argc > 1 && *argv[1] == '-') {
29                 const char *str = argv[1];
30
31                 switch (str[1]) {
32                 case 'r':
33                         runs_per_text = dectoul(str + 2, NULL);
34                         break;
35                 case 'f':
36                         force_run = true;
37                         break;
38                 }
39                 argv++;
40                 argc++;
41         }
42
43         ret = ut_run_list(name, prefix, tests, n_ents,
44                           argc > 1 ? argv[1] : NULL, runs_per_text, force_run);
45
46         return ret ? CMD_RET_FAILURE : 0;
47 }
48
49 static struct cmd_tbl cmd_ut_sub[] = {
50         U_BOOT_CMD_MKENT(all, CONFIG_SYS_MAXARGS, 1, do_ut_all, "", ""),
51         U_BOOT_CMD_MKENT(info, 1, 1, do_ut_info, "", ""),
52 #ifdef CONFIG_BOOTSTD
53         U_BOOT_CMD_MKENT(bootstd, CONFIG_SYS_MAXARGS, 1, do_ut_bootstd,
54                          "", ""),
55 #endif
56         U_BOOT_CMD_MKENT(common, CONFIG_SYS_MAXARGS, 1, do_ut_common, "", ""),
57 #if defined(CONFIG_UT_DM)
58         U_BOOT_CMD_MKENT(dm, CONFIG_SYS_MAXARGS, 1, do_ut_dm, "", ""),
59 #endif
60 #if defined(CONFIG_UT_ENV)
61         U_BOOT_CMD_MKENT(env, CONFIG_SYS_MAXARGS, 1, do_ut_env, "", ""),
62 #endif
63 #ifdef CONFIG_CMD_FDT
64         U_BOOT_CMD_MKENT(fdt, CONFIG_SYS_MAXARGS, 1, do_ut_fdt, "", ""),
65 #endif
66 #ifdef CONFIG_CONSOLE_TRUETYPE
67         U_BOOT_CMD_MKENT(font, CONFIG_SYS_MAXARGS, 1, do_ut_font, "", ""),
68 #endif
69 #ifdef CONFIG_UT_OPTEE
70         U_BOOT_CMD_MKENT(optee, CONFIG_SYS_MAXARGS, 1, do_ut_optee, "", ""),
71 #endif
72 #ifdef CONFIG_UT_OVERLAY
73         U_BOOT_CMD_MKENT(overlay, CONFIG_SYS_MAXARGS, 1, do_ut_overlay, "", ""),
74 #endif
75 #ifdef CONFIG_UT_LIB
76         U_BOOT_CMD_MKENT(lib, CONFIG_SYS_MAXARGS, 1, do_ut_lib, "", ""),
77 #endif
78 #ifdef CONFIG_UT_LOG
79         U_BOOT_CMD_MKENT(log, CONFIG_SYS_MAXARGS, 1, do_ut_log, "", ""),
80 #endif
81         U_BOOT_CMD_MKENT(mem, CONFIG_SYS_MAXARGS, 1, do_ut_mem, "", ""),
82 #if defined(CONFIG_SANDBOX) && defined(CONFIG_CMD_SETEXPR)
83         U_BOOT_CMD_MKENT(setexpr, CONFIG_SYS_MAXARGS, 1, do_ut_setexpr, "",
84                          ""),
85 #endif
86         U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_ut_print, "", ""),
87 #ifdef CONFIG_UT_TIME
88         U_BOOT_CMD_MKENT(time, CONFIG_SYS_MAXARGS, 1, do_ut_time, "", ""),
89 #endif
90 #if CONFIG_IS_ENABLED(UT_UNICODE) && !defined(API_BUILD)
91         U_BOOT_CMD_MKENT(unicode, CONFIG_SYS_MAXARGS, 1, do_ut_unicode, "", ""),
92 #endif
93 #ifdef CONFIG_SANDBOX
94         U_BOOT_CMD_MKENT(compression, CONFIG_SYS_MAXARGS, 1, do_ut_compression,
95                          "", ""),
96         U_BOOT_CMD_MKENT(bloblist, CONFIG_SYS_MAXARGS, 1, do_ut_bloblist,
97                          "", ""),
98         U_BOOT_CMD_MKENT(bootm, CONFIG_SYS_MAXARGS, 1, do_ut_bootm, "", ""),
99 #endif
100         U_BOOT_CMD_MKENT(str, CONFIG_SYS_MAXARGS, 1, do_ut_str, "", ""),
101 #ifdef CONFIG_CMD_ADDRMAP
102         U_BOOT_CMD_MKENT(addrmap, CONFIG_SYS_MAXARGS, 1, do_ut_addrmap, "", ""),
103 #endif
104 #ifdef CONFIG_CMD_LOADM
105         U_BOOT_CMD_MKENT(loadm, CONFIG_SYS_MAXARGS, 1, do_ut_loadm, "", ""),
106 #endif
107 };
108
109 static int do_ut_all(struct cmd_tbl *cmdtp, int flag, int argc,
110                      char *const argv[])
111 {
112         int i;
113         int retval;
114         int any_fail = 0;
115
116         for (i = 1; i < ARRAY_SIZE(cmd_ut_sub); i++) {
117                 printf("----Running %s tests----\n", cmd_ut_sub[i].name);
118                 retval = cmd_ut_sub[i].cmd(cmdtp, flag, 1, &cmd_ut_sub[i].name);
119                 if (!any_fail)
120                         any_fail = retval;
121         }
122
123         return any_fail;
124 }
125
126 static int do_ut_info(struct cmd_tbl *cmdtp, int flag, int argc,
127                       char *const argv[])
128 {
129         printf("Test suites: %d\n", (int)ARRAY_SIZE(cmd_ut_sub));
130         printf("Total tests: %d\n", (int)UNIT_TEST_ALL_COUNT());
131
132         return 0;
133 }
134
135 static int do_ut(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
136 {
137         struct cmd_tbl *cp;
138
139         if (argc < 2)
140                 return CMD_RET_USAGE;
141
142         /* drop initial "ut" arg */
143         argc--;
144         argv++;
145
146         cp = find_cmd_tbl(argv[0], cmd_ut_sub, ARRAY_SIZE(cmd_ut_sub));
147
148         if (cp)
149                 return cp->cmd(cmdtp, flag, argc, argv);
150
151         return CMD_RET_USAGE;
152 }
153
154 #ifdef CONFIG_SYS_LONGHELP
155 static char ut_help_text[] =
156         "[-r] [-f] [<suite>] - run unit tests\n"
157         "   -r<runs>   Number of times to run each test\n"
158         "   -f         Force 'manual' tests to run as well\n"
159         "   <suite>    Test suite to run, or all\n"
160         "\n"
161         "\nOptions for <suite>:"
162         "\nall - execute all enabled tests"
163         "\ninfo - show info about tests"
164 #ifdef CONFIG_CMD_ADDRMAP
165         "\naddrmap - very basic test of addrmap command"
166 #endif
167 #ifdef CONFIG_SANDBOX
168         "\nbloblist - bloblist implementation"
169 #endif
170 #ifdef CONFIG_BOOTSTD
171         "\nbootstd - standard boot implementation"
172 #endif
173 #ifdef CONFIG_SANDBOX
174         "\ncompression - compressors and bootm decompression"
175 #endif
176 #ifdef CONFIG_UT_DM
177         "\ndm - driver model"
178 #endif
179 #ifdef CONFIG_UT_ENV
180         "\nenv - environment"
181 #endif
182 #ifdef CONFIG_CMD_FDT
183         "\nfdt - fdt command"
184 #endif
185 #ifdef CONFIG_CONSOLE_TRUETYPE
186         "\nut font - font command\n"
187 #endif
188 #ifdef CONFIG_CMD_LOADM
189         "\nloadm - loadm command parameters and loading memory blob"
190 #endif
191 #ifdef CONFIG_UT_LIB
192         "\nlib - library functions"
193 #endif
194 #ifdef CONFIG_UT_LOG
195         "\nlog - logging functions"
196 #endif
197         "\nmem - memory-related commands"
198 #ifdef CONFIG_UT_OPTEE
199         "\noptee - test OP-TEE"
200 #endif
201 #ifdef CONFIG_UT_OVERLAY
202         "\noverlay - device tree overlays"
203 #endif
204         "\nprint  - printing things to the console"
205         "\nsetexpr - setexpr command"
206 #ifdef CONFIG_SANDBOX
207         "\nstr - basic test of string functions"
208 #endif
209 #ifdef CONFIG_UT_TIME
210         "\ntime - very basic test of time functions"
211 #endif
212 #if defined(CONFIG_UT_UNICODE) && \
213         !defined(CONFIG_SPL_BUILD) && !defined(API_BUILD)
214         "\nunicode - Unicode functions"
215 #endif
216         ;
217 #endif /* CONFIG_SYS_LONGHELP */
218
219 U_BOOT_CMD(
220         ut, CONFIG_SYS_MAXARGS, 1, do_ut,
221         "unit tests", ut_help_text
222 );