u-boot/test
Tom Rini 2b28c3b871 Merge patch series "Modernize U-Boot shell"
Francis Laniel <francis.laniel@amarulasolutions.com> says:

During 2021 summer, Sean Anderson wrote a contribution to add a new shell, based
on LIL, to U-Boot [1, 2].
While one of the goals of this contribution was to address the fact actual
U-Boot shell, which is based on Busybox hush, is old there was a discussion
about adding a new shell versus updating the actual one [3, 4].

So, in this series, with Harald Seiler, we updated the actual U-Boot shell to
reflect what is currently in Busybox source code.
Basically, this contribution is about taking a snapshot of Busybox shell/hush.c
file (as it exists in commit 37460f5da) and adapt it to suit U-Boot needs.

This contribution was written to be as backward-compatible as possible to avoid
breaking the existing.
So, the modern hush flavor offers the same as the actual, that is to say:
1. Variable expansion.
2. Instruction lists (;, && and ||).
3. If, then and else.
4. Loops (for, while and until).
No new features offered by Busybox hush were implemented (e.g. functions).

It is possible to change the parser at runtime using the "cli" command:
=> cli print
old
=> cli set modern
=> cli print
modern
=> cli set old
The default parser is the old one.
Note that to use both parser, you would need to set both
CONFIG_HUSH_MODERN_PARSER and CONFIG_HUSH_OLD_PARSER.

In terms of testing, new unit tests were added to ut to ensure the new behavior
is the same as the old one and it does not add regression.
Nonetheless, if old behavior was buggy and fixed upstream, the fix is then added
to U-Boot [5].
In sandbox, all of these tests pass smoothly:
=> printenv board
board=sandbox
=> ut hush
Running 20 hush tests
...
Failures: 0
=> cli set modern
=> ut hush
Running 20 hush tests
...
Failures: 0

Thanks to the effort of Harald Seiler, I was successful booting a board:
=> printenv fdtfile
fdtfile=amlogic/meson-gxl-s905x-libretech-cc.dtb
=> cli get
old
=> boot
...
root@lepotato:~#
root@lepotato:~# reboot
...
=> cli set modern
=> cli get
modern
=> printenv fdtfile
fdtfile=amlogic/meson-gxl-s905x-libretech-cc.dtb
=> boot
...
root@lepotato:~#

This contribution indeed adds a lot of code and there were concern about its
size [6, 7].
With regard to the amount of code added, the cli_hush_upstream.c is 13030 lines
long but it seems a smaller subset is really used:
gcc -D__U_BOOT__ -E common/cli_hush_upstream.c | wc -l
2870
Despite this, it is better to still have the whole upstream code for the sake of
easing maintenance.
With regard to memory size, I conducted some experiments for version 8 of this
series and for a subset of arm64 boards and found the worst case to be 4K [8].
Tom Rini conducted more research on this and also found the increase to be
acceptable [9].

If you want to review it - your review will really be appreciated - here are
some information regarding the commits:
* commits marked as "test:" deal with unit tests.
* commit "cli: Add Busybox upstream hush.c file." copies Busybox shell/hush.c
into U-Boot tree, this explain why this commit contains around 12000 additions.
* commit "cli: Port Busybox 2021 hush to U-Boot." modifies previously added file
to permit us to use this as new shell.
The really good idea of #include'ing Busybox code into a wrapper file to define
some particular functions while minimizing modifications to upstream code comes
from Harald Seiler.
* commit "cmd: Add new parser command" adds a new command which permits
selecting parser at runtime.
I am not really satisfied with the fact it calls cli_init() and cli_loop() each
time the parser is set, so your reviews would be welcomed.
* Other commits focus on enabling features we need (e.g. if).
2023-12-28 14:38:25 -05:00
..
boot cli: add modern hush as parser for run_command*() 2023-12-28 12:02:56 -05:00
cmd test: font: Add dependencies on fonts 2023-12-13 18:39:05 -05:00
common test: event: Only run test_event_probe() on sandbox 2023-12-13 18:39:05 -05:00
dm global: Restrict use of '#include <linux/kconfig.h>' 2023-12-21 08:54:05 -05:00
env sandbox: add test of CONFIG_ENV_IMPORT_FDT 2021-05-04 12:52:30 -04:00
fs Use grep -E or plain grep instead of egrep 2023-01-11 15:02:24 -05:00
fuzz cmd: Convert existing long help messages to the new macro 2023-10-16 10:24:58 -04:00
hush Merge patch series "Modernize U-Boot shell" 2023-12-28 14:38:25 -05:00
image Merge patch series "fs: fat: calculate FAT type based on cluster count" 2023-11-28 20:10:36 -05:00
lib test: lmb: Move tests into the lib suite 2023-12-13 18:39:05 -05:00
log log: Remove some places where we redefine LOGLEVEL 2022-12-23 10:07:03 -05:00
optee test: Add a macros for finding tests in linker_lists 2021-03-12 09:57:30 -05:00
overlay test: Add a macros for finding tests in linker_lists 2021-03-12 09:57:30 -05:00
py test: hush: Test hush variable expansion 2023-12-28 12:02:56 -05:00
stdint Remove <inttypes.h> includes and PRI* usages in printf() entirely 2018-09-10 20:48:17 -04:00
trace SPDX: Convert all of our single license tags to Linux Kernel style 2018-05-07 09:34:12 -04:00
bloblist.c bloblist: Add functions to obtain base address and size 2022-01-13 09:13:41 -07:00
bootm.c test: Fix bootm_test_subst_var() running independently 2022-09-12 18:06:36 -04:00
cmd_ut.c test: Add framework to test hush behavior 2023-12-28 12:02:56 -05:00
command_ut.c unit-test: cover run_commandf() by test-cases 2023-03-30 15:09:59 -04:00
common.sh Consistently use nproc for counting the CPUs 2020-01-30 13:30:35 -05:00
compression.c test: compression: add zstd uncompression test 2023-01-18 19:41:15 -05:00
Kconfig test: Run bootstd tests only on sandbox 2023-12-13 18:39:05 -05:00
Makefile test: Add framework to test hush behavior 2023-12-28 12:02:56 -05:00
print_ut.c test: print: Skip test on x86 2023-12-13 18:39:05 -05:00
run test: Run the VPL tests with 'make check' 2023-04-03 06:53:53 +12:00
str_ut.c lib: Add a function to split a string into substrings 2023-01-23 18:11:39 -05:00
test-main.c spl: Allow enabling SPL_OF_REAL and SPL_OF_PLATDATA at the same time 2023-10-17 20:50:52 -04:00
time_ut.c common: Drop linux/delay.h from common header 2020-05-18 21:19:23 -04:00
unicode_ut.c test: unicode: fix a sizeof() vs ARRAY_SIZE() bug 2023-08-08 17:41:52 -04:00
ut.c test: Add helper to skip to partial console line 2023-12-13 18:39:05 -05:00