1 # Copyright (c) 2015 Stephen Warren
2 # Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.
4 # SPDX-License-Identifier: GPL-2.0
6 # Test operation of shell commands relating to environment variables.
10 # FIXME: This might be useful for other tests;
11 # perhaps refactor it into ConsoleBase or some other state object?
12 class StateTestEnv(object):
13 '''Container that represents the state of all U-Boot environment variables.
14 This enables quick determination of existant/non-existant variable
18 def __init__(self, u_boot_console):
19 '''Initialize a new StateTestEnv object.
22 u_boot_console: A U-Boot console.
28 self.u_boot_console = u_boot_console
30 self.set_var = self.get_non_existent_var()
33 '''Read all current environment variables from U-Boot.
42 response = self.u_boot_console.run_command('printenv')
44 for l in response.splitlines():
47 (var, value) = l.strip().split('=', 1)
50 def get_existent_var(self):
51 '''Return the name of an environment variable that exists.
57 The name of an environment variable.
63 def get_non_existent_var(self):
64 '''Return the name of an environment variable that does not exist.
70 The name of an environment variable.
75 var = 'test_env_' + str(n)
76 if var not in self.env:
80 @pytest.fixture(scope='module')
81 def state_test_env(u_boot_console):
82 '''pytest fixture to provide a StateTestEnv object to tests.'''
84 return StateTestEnv(u_boot_console)
86 def unset_var(state_test_env, var):
87 '''Unset an environment variable.
89 This both executes a U-Boot shell command and updates a StateTestEnv
93 state_test_env: The StateTestEnv object to updata.
94 var: The variable name to unset.
100 state_test_env.u_boot_console.run_command('setenv %s' % var)
101 if var in state_test_env.env:
102 del state_test_env.env[var]
104 def set_var(state_test_env, var, value):
105 '''Set an environment variable.
107 This both executes a U-Boot shell command and updates a StateTestEnv
111 state_test_env: The StateTestEnv object to updata.
112 var: The variable name to set.
113 value: The value to set the variable to.
119 state_test_env.u_boot_console.run_command('setenv %s "%s"' % (var, value))
120 state_test_env.env[var] = value
122 def validate_empty(state_test_env, var):
123 '''Validate that a variable is not set, using U-Boot shell commands.
126 var: The variable name to test.
132 response = state_test_env.u_boot_console.run_command('echo $%s' % var)
133 assert response == ''
135 def validate_set(state_test_env, var, value):
136 '''Validate that a variable is set, using U-Boot shell commands.
139 var: The variable name to test.
140 value: The value the variable is expected to have.
146 # echo does not preserve leading, internal, or trailing whitespace in the
147 # value. printenv does, and hence allows more complete testing.
148 response = state_test_env.u_boot_console.run_command('printenv %s' % var)
149 assert response == ('%s=%s' % (var, value))
151 def test_env_echo_exists(state_test_env):
152 '''Test echoing a variable that exists.'''
154 var = state_test_env.get_existent_var()
155 value = state_test_env.env[var]
156 validate_set(state_test_env, var, value)
158 def test_env_echo_non_existent(state_test_env):
159 '''Test echoing a variable that doesn't exist.'''
161 var = state_test_env.set_var
162 validate_empty(state_test_env, var)
164 def test_env_printenv_non_existent(state_test_env):
165 '''Test printenv error message for non-existant variables.'''
167 var = state_test_env.set_var
168 c = state_test_env.u_boot_console
169 with c.disable_check('error_notification'):
170 response = c.run_command('printenv %s' % var)
171 assert(response == '## Error: "%s" not defined' % var)
173 def test_env_unset_non_existent(state_test_env):
174 '''Test unsetting a nonexistent variable.'''
176 var = state_test_env.get_non_existent_var()
177 unset_var(state_test_env, var)
178 validate_empty(state_test_env, var)
180 def test_env_set_non_existent(state_test_env):
181 '''Test set a non-existant variable.'''
183 var = state_test_env.set_var
185 set_var(state_test_env, var, value)
186 validate_set(state_test_env, var, value)
188 def test_env_set_existing(state_test_env):
189 '''Test setting an existant variable.'''
191 var = state_test_env.set_var
193 set_var(state_test_env, var, value)
194 validate_set(state_test_env, var, value)
196 def test_env_unset_existing(state_test_env):
197 '''Test unsetting a variable.'''
199 var = state_test_env.set_var
200 unset_var(state_test_env, var)
201 validate_empty(state_test_env, var)
203 def test_env_expansion_spaces(state_test_env):
204 '''Test expanding a variable that contains a space in its value.'''
209 var_space = state_test_env.get_non_existent_var()
210 set_var(state_test_env, var_space, ' ')
212 var_test = state_test_env.get_non_existent_var()
213 value = ' 1${%(var_space)s}${%(var_space)s} 2 ' % locals()
214 set_var(state_test_env, var_test, value)
216 validate_set(state_test_env, var_test, value)
219 unset_var(state_test_env, var_space)
221 unset_var(state_test_env, var_test)