RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

tests/sys/shell_lock: increase robustness of the test

Browse Source 
Before the test used the `help` command to verify that access to the
shell is present. While this does have the benefit of not requiring a
custom command, it does have some robustness issues:

- When new default commands get added, this test will fail
- When the help message of a command gets reworded, the test will fail
- When the order of commands in the test will change, the test will fail
    - Note that with the XFA based `SHELL_COMMAND()` macro, we do not
      guarantee any particular order. Specifically, the order can change
      with implementation details.
This commit is contained in:
Marian Buschsieweke 2024-11-07 10:45:50 +01:00
parent 06aaf648e3
commit abb666bf73
No known key found for this signature in database
GPG Key ID: 758BD52517F79C41
2 changed files with 21 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
tests/sys/shell_lock/main.c
View File

@ -20,6 +20,21 @@
#include "test_utils/interactive_sync.h" #include "test_utils/interactive_sync.h"
/* this command is used by the test automation to check whether commands are
* executed or not (due to the shell being locked). */
static int _cmd_ping(int argc, char **argv)
{
if (argc != 1) {
printf("Usage: %s\n", argv[0]);
return 1;
}
puts("PONG!");
return 0;
}
SHELL_COMMAND(ping, "Echo \"PONG!\"", _cmd_ping);
int main(void) int main(void)
{ {
test_utils_interactive_sync(); test_utils_interactive_sync();

23
tests/sys/shell_lock/tests/01-run.py
View File

@ -22,15 +22,6 @@ PASSWORDS_INCORRECT = [
"_password" "_password"
] ]
EXPECTED_HELP = (
'Command Description',
'---------------------------------------',
'lock Lock the shell',
'pm interact with layered PM subsystem',
'reboot Reboot the node',
'version Prints current RIOT_VERSION',
)
AUTO_LOCK_TIMEOUT_MS = 7000 AUTO_LOCK_TIMEOUT_MS = 7000
SHELL_PROMPT = '> ' SHELL_PROMPT = '> '
PASSWORD_PROMPT = 'Password: ' PASSWORD_PROMPT = 'Password: '
@ -49,16 +40,15 @@ def testfunc(child):
child.expect_exact(SHELL_PROMPT) child.expect_exact(SHELL_PROMPT)
# check we have access # check we have access
child.sendline('help') child.sendline('ping')
for line in EXPECTED_HELP: child.expect_exact("PONG!")
child.expect_exact(line)
# lock # lock
child.sendline('lock') child.sendline('lock')
child.expect(SHELL_PROMPT) child.expect(SHELL_PROMPT)
# trigger password prompt # trigger password prompt
child.sendline('help') child.sendline('ping')
child.expect('The shell is locked. Enter a valid password to unlock.') child.expect('The shell is locked. Enter a valid password to unlock.')
# test different incorrect passwords # test different incorrect passwords
@ -82,16 +72,15 @@ def testfunc(child):
child.expect_exact(SHELL_PROMPT) child.expect_exact(SHELL_PROMPT)
# check we have access # check we have access
child.sendline('help') child.sendline('ping')
for line in EXPECTED_HELP: child.expect_exact("PONG!")
child.expect_exact(line)
# wait until auto_lock locks the shell after # wait until auto_lock locks the shell after
# CONFIG_SHELL_LOCK_AUTO_LOCK_TIMEOUT_MS (+ 1 second buffer time) # CONFIG_SHELL_LOCK_AUTO_LOCK_TIMEOUT_MS (+ 1 second buffer time)
time.sleep((AUTO_LOCK_TIMEOUT_MS / 1000.0) + 1) time.sleep((AUTO_LOCK_TIMEOUT_MS / 1000.0) + 1)
# trigger password prompt # trigger password prompt
child.sendline('help') child.sendline('ping')
child.expect('The shell is locked. Enter a valid password to unlock.') child.expect('The shell is locked. Enter a valid password to unlock.')