[U-Boot] [PATCH V3 3/7] test/py: add test of setenv/printenv/echo

Stephen Warren
2016-01-05T22:58:31Z

This tests basic environment variable functionality.

Signed-off-by: Stephen Warren <swarren@wwwdotorg.org>
Signed-off-by: Stephen Warren <swarren@nvidia.com>
---
v3:
- Handle environment values that contain an = sign.
Reported by Michal Simek.
- Move test scripts into a sub-directory.
Suggested by Michal Simek.
- s/uboot/u[-_]boot/g. Suggested by Simon Glass.
- s/"/'/g. Suggested by Simon Glass.
- Add more documentation. Suggested by Simon Glass.
- Simplify command string construction. Suggested by Simon Glass.
- Move relevant edits to command_ut.c into this patch from a later one.
Suggested by Simon Glass.
---
test/command_ut.c | 4 --
test/py/tests/test_env.py | 169 ++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 169 insertions(+), 4 deletions(-)
create mode 100644 test/py/tests/test_env.py

diff --git a/test/command_ut.c b/test/command_ut.c
index 926573a39543..c086abe3ed3e 100644
--- a/test/command_ut.c
+++ b/test/command_ut.c
@@ -20,10 +20,6 @@ static int do_ut_cmd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
printf("%s: Testing commands\n", __func__);
run_command("env default -f -a", 0);

- /* run a single command */
- run_command("setenv single 1", 0);
- assert(!strcmp("1", getenv("single")));
-
/* make sure that compound statements work */
#ifdef CONFIG_SYS_HUSH_PARSER
run_command("if test -n ${single} ; then setenv check 1; fi", 0);
diff --git a/test/py/tests/test_env.py b/test/py/tests/test_env.py
new file mode 100644
index 000000000000..70e4d2a38aaf
--- /dev/null
+++ b/test/py/tests/test_env.py
@@ -0,0 +1,169 @@
+# Copyright (c) 2015 Stephen Warren
+# Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.
+#
+# SPDX-License-Identifier: GPL-2.0
+
+# Test operation of shell commands relating to environment variables.
+
+import pytest
+
+# FIXME: This might be useful for other tests;
+# perhaps refactor it into ConsoleBase or some other state object?
+class StateTestEnv(object):
+ '''Container that represents the state of all U-Boot environment variables.
+ This enables quick determination of existant/non-existant variable
+ names.'''
+
+ def __init__(self, u_boot_console):
+ '''Initialize a new StateTestEnv object.
+
+ u_boot_console: A U-Boot console.'''
+
+ self.u_boot_console = u_boot_console
+ self.get_env()
+ self.set_var = self.get_non_existent_var()
+
+ def get_env(self):
+ '''Read all current environment variables from U-Boot.'''
+
+ response = self.u_boot_console.run_command('printenv')
+ self.env = {}
+ for l in response.splitlines():
+ if not '=' in l:
+ continue
+ (var, value) = l.strip().split('=', 1)
+ self.env[var] = value
+
+ def get_existent_var(self):
+ '''Return the name on an environment variable that exists.'''
+
+ for var in self.env:
+ return var
+
+ def get_non_existent_var(self):
+ '''Return the name on an environment variable that does not exist.'''
+
+ n = 0
+ while True:
+ var = 'test_env_' + str(n)
+ if var not in self.env:
+ return var
+ n += 1
+
+ at pytest.fixture(scope='module')
+def state_test_env(u_boot_console):
+ '''pytest fixture to provide a StateTestEnv object to tests.'''
+
+ return StateTestEnv(u_boot_console)
+
+def unset_var(state_test_env, var):
+ '''Unset an environment variable, both by executing a U-Boot shell command
+ and updating a StateTestEnv object.
+
+ var: The variable name to unset.'''
+
+ state_test_env.u_boot_console.run_command('setenv %s' % var)
+ if var in state_test_env.env:
+ del state_test_env.env[var]
+
+def set_var(state_test_env, var, value):
+ '''Set an environment variable, both by executing a U-Boot shell command
+ and updating a StateTestEnv object.
+
+ var: The variable name to set.
+ value: The value to set the variable to.'''
+
+ state_test_env.u_boot_console.run_command('setenv %s "%s"' % (var, value))
+ state_test_env.env[var] = value
+
+def validate_empty(state_test_env, var):
+ '''Validate that a variable is not set, using U-Boot shell commands.
+
+ var: The variable name to test.'''
+
+ response = state_test_env.u_boot_console.run_command('echo $%s' % var)
+ assert response == ''
+
+def validate_set(state_test_env, var, value):
+ '''Validate that a variable is set, using U-Boot shell commands.
+
+ var: The variable name to test.
+ value: The value the variable is expected to have.'''
+
+ # echo does not preserve leading, internal, or trailing whitespace in the
+ # value. printenv does, and hence allows more complete testing.
+ response = state_test_env.u_boot_console.run_command('printenv %s' % var)
+ assert response == ('%s=%s' % (var, value))
+
+def test_env_echo_exists(state_test_env):
+ '''Test echoing a variable that exists.'''
+
+ var = state_test_env.get_existent_var()
+ value = state_test_env.env[var]
+ validate_set(state_test_env, var, value)
+
+def test_env_echo_non_existent(state_test_env):
+ '''Test echoing a variable that doesn't exist.'''
+
+ var = state_test_env.set_var
+ validate_empty(state_test_env, var)
+
+def test_env_printenv_non_existent(state_test_env):
+ '''Test printenv error message for non-existant variables.'''
+
+ var = state_test_env.set_var
+ c = state_test_env.u_boot_console
+ with c.disable_check('error_notification'):
+ response = c.run_command('printenv %s' % var)
+ assert(response == '## Error: "%s" not defined' % var)
+
+def test_env_unset_non_existent(state_test_env):
+ '''Test unsetting a nonexistent variable.'''
+
+ var = state_test_env.get_non_existent_var()
+ unset_var(state_test_env, var)
+ validate_empty(state_test_env, var)
+
+def test_env_set_non_existent(state_test_env):
+ '''Test set a non-existant variable.'''
+
+ var = state_test_env.set_var
+ value = 'foo'
+ set_var(state_test_env, var, value)
+ validate_set(state_test_env, var, value)
+
+def test_env_set_existing(state_test_env):
+ '''Test setting an existant variable.'''
+
+ var = state_test_env.set_var
+ value = 'bar'
+ set_var(state_test_env, var, value)
+ validate_set(state_test_env, var, value)
+
+def test_env_unset_existing(state_test_env):
+ '''Test unsetting a variable.'''
+
+ var = state_test_env.set_var
+ unset_var(state_test_env, var)
+ validate_empty(state_test_env, var)
+
+def test_env_expansion_spaces(state_test_env):
+ '''Test expanding an environment variable that contains a space in its
+ value.'''
+
+ var_space = None
+ var_test = None
+ try:
+ var_space = state_test_env.get_non_existent_var()
+ set_var(state_test_env, var_space, ' ')
+
+ var_test = state_test_env.get_non_existent_var()
+ value = ' 1${%(var_space)s}${%(var_space)s} 2 ' % locals()
+ set_var(state_test_env, var_test, value)
+ value = ' 1 2 '
+ validate_set(state_test_env, var_test, value)
+ finally:
+ if var_space:
+ unset_var(state_test_env, var_space)
+ if var_test:
+ unset_var(state_test_env, var_test)
--
2.6.4