1# Copyright (c) 2015 Stephen Warren 2# Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved. 3# 4# SPDX-License-Identifier: GPL-2.0 5 6# Test operation of shell commands relating to environment variables. 7 8import pytest 9 10# FIXME: This might be useful for other tests; 11# perhaps refactor it into ConsoleBase or some other state object? 12class StateTestEnv(object): 13 """Container that represents the state of all U-Boot environment variables. 14 This enables quick determination of existant/non-existant variable 15 names. 16 """ 17 18 def __init__(self, u_boot_console): 19 """Initialize a new StateTestEnv object. 20 21 Args: 22 u_boot_console: A U-Boot console. 23 24 Returns: 25 Nothing. 26 """ 27 28 self.u_boot_console = u_boot_console 29 self.get_env() 30 self.set_var = self.get_non_existent_var() 31 32 def get_env(self): 33 """Read all current environment variables from U-Boot. 34 35 Args: 36 None. 37 38 Returns: 39 Nothing. 40 """ 41 42 if self.u_boot_console.config.buildconfig.get( 43 'config_version_variable', 'n') == 'y': 44 with self.u_boot_console.disable_check('main_signon'): 45 response = self.u_boot_console.run_command('printenv') 46 else: 47 response = self.u_boot_console.run_command('printenv') 48 self.env = {} 49 for l in response.splitlines(): 50 if not '=' in l: 51 continue 52 (var, value) = l.strip().split('=', 1) 53 self.env[var] = value 54 55 def get_existent_var(self): 56 """Return the name of an environment variable that exists. 57 58 Args: 59 None. 60 61 Returns: 62 The name of an environment variable. 63 """ 64 65 for var in self.env: 66 return var 67 68 def get_non_existent_var(self): 69 """Return the name of an environment variable that does not exist. 70 71 Args: 72 None. 73 74 Returns: 75 The name of an environment variable. 76 """ 77 78 n = 0 79 while True: 80 var = 'test_env_' + str(n) 81 if var not in self.env: 82 return var 83 n += 1 84 85ste = None 86@pytest.fixture(scope='function') 87def state_test_env(u_boot_console): 88 """pytest fixture to provide a StateTestEnv object to tests.""" 89 90 global ste 91 if not ste: 92 ste = StateTestEnv(u_boot_console) 93 return ste 94 95def unset_var(state_test_env, var): 96 """Unset an environment variable. 97 98 This both executes a U-Boot shell command and updates a StateTestEnv 99 object. 100 101 Args: 102 state_test_env: The StateTestEnv object to update. 103 var: The variable name to unset. 104 105 Returns: 106 Nothing. 107 """ 108 109 state_test_env.u_boot_console.run_command('setenv %s' % var) 110 if var in state_test_env.env: 111 del state_test_env.env[var] 112 113def set_var(state_test_env, var, value): 114 """Set an environment variable. 115 116 This both executes a U-Boot shell command and updates a StateTestEnv 117 object. 118 119 Args: 120 state_test_env: The StateTestEnv object to update. 121 var: The variable name to set. 122 value: The value to set the variable to. 123 124 Returns: 125 Nothing. 126 """ 127 128 state_test_env.u_boot_console.run_command('setenv %s "%s"' % (var, value)) 129 state_test_env.env[var] = value 130 131def validate_empty(state_test_env, var): 132 """Validate that a variable is not set, using U-Boot shell commands. 133 134 Args: 135 var: The variable name to test. 136 137 Returns: 138 Nothing. 139 """ 140 141 response = state_test_env.u_boot_console.run_command('echo $%s' % var) 142 assert response == '' 143 144def validate_set(state_test_env, var, value): 145 """Validate that a variable is set, using U-Boot shell commands. 146 147 Args: 148 var: The variable name to test. 149 value: The value the variable is expected to have. 150 151 Returns: 152 Nothing. 153 """ 154 155 # echo does not preserve leading, internal, or trailing whitespace in the 156 # value. printenv does, and hence allows more complete testing. 157 response = state_test_env.u_boot_console.run_command('printenv %s' % var) 158 assert response == ('%s=%s' % (var, value)) 159 160def test_env_echo_exists(state_test_env): 161 """Test echoing a variable that exists.""" 162 163 var = state_test_env.get_existent_var() 164 value = state_test_env.env[var] 165 validate_set(state_test_env, var, value) 166 167def test_env_echo_non_existent(state_test_env): 168 """Test echoing a variable that doesn't exist.""" 169 170 var = state_test_env.set_var 171 validate_empty(state_test_env, var) 172 173def test_env_printenv_non_existent(state_test_env): 174 """Test printenv error message for non-existant variables.""" 175 176 var = state_test_env.set_var 177 c = state_test_env.u_boot_console 178 with c.disable_check('error_notification'): 179 response = c.run_command('printenv %s' % var) 180 assert(response == '## Error: "%s" not defined' % var) 181 182def test_env_unset_non_existent(state_test_env): 183 """Test unsetting a nonexistent variable.""" 184 185 var = state_test_env.get_non_existent_var() 186 unset_var(state_test_env, var) 187 validate_empty(state_test_env, var) 188 189def test_env_set_non_existent(state_test_env): 190 """Test set a non-existant variable.""" 191 192 var = state_test_env.set_var 193 value = 'foo' 194 set_var(state_test_env, var, value) 195 validate_set(state_test_env, var, value) 196 197def test_env_set_existing(state_test_env): 198 """Test setting an existant variable.""" 199 200 var = state_test_env.set_var 201 value = 'bar' 202 set_var(state_test_env, var, value) 203 validate_set(state_test_env, var, value) 204 205def test_env_unset_existing(state_test_env): 206 """Test unsetting a variable.""" 207 208 var = state_test_env.set_var 209 unset_var(state_test_env, var) 210 validate_empty(state_test_env, var) 211 212def test_env_expansion_spaces(state_test_env): 213 """Test expanding a variable that contains a space in its value.""" 214 215 var_space = None 216 var_test = None 217 try: 218 var_space = state_test_env.get_non_existent_var() 219 set_var(state_test_env, var_space, ' ') 220 221 var_test = state_test_env.get_non_existent_var() 222 value = ' 1${%(var_space)s}${%(var_space)s} 2 ' % locals() 223 set_var(state_test_env, var_test, value) 224 value = ' 1 2 ' 225 validate_set(state_test_env, var_test, value) 226 finally: 227 if var_space: 228 unset_var(state_test_env, var_space) 229 if var_test: 230 unset_var(state_test_env, var_test) 231