1# Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.
2#
3# SPDX-License-Identifier: GPL-2.0
4
5# Test operation of the "if" shell command.
6
7import os
8import os.path
9import pytest
10
11# The list of "if test" conditions to test.
12subtests = (
13    # Base if functionality.
14
15    ('true', True),
16    ('false', False),
17
18    # Basic operators.
19
20    ('test aaa = aaa', True),
21    ('test aaa = bbb', False),
22
23    ('test aaa != bbb', True),
24    ('test aaa != aaa', False),
25
26    ('test aaa < bbb', True),
27    ('test bbb < aaa', False),
28
29    ('test bbb > aaa', True),
30    ('test aaa > bbb', False),
31
32    ('test 123 -eq 123', True),
33    ('test 123 -eq 456', False),
34
35    ('test 123 -ne 456', True),
36    ('test 123 -ne 123', False),
37
38    ('test 123 -lt 456', True),
39    ('test 123 -lt 123', False),
40    ('test 456 -lt 123', False),
41
42    ('test 123 -le 456', True),
43    ('test 123 -le 123', True),
44    ('test 456 -le 123', False),
45
46    ('test 456 -gt 123', True),
47    ('test 123 -gt 123', False),
48    ('test 123 -gt 456', False),
49
50    ('test 456 -ge 123', True),
51    ('test 123 -ge 123', True),
52    ('test 123 -ge 456', False),
53
54    ('test -z ""', True),
55    ('test -z "aaa"', False),
56
57    ('test -n "aaa"', True),
58    ('test -n ""', False),
59
60    # Inversion of simple tests.
61
62    ('test ! aaa = aaa', False),
63    ('test ! aaa = bbb', True),
64    ('test ! ! aaa = aaa', True),
65    ('test ! ! aaa = bbb', False),
66
67    # Binary operators.
68
69    ('test aaa != aaa -o bbb != bbb', False),
70    ('test aaa != aaa -o bbb = bbb', True),
71    ('test aaa = aaa -o bbb != bbb', True),
72    ('test aaa = aaa -o bbb = bbb', True),
73
74    ('test aaa != aaa -a bbb != bbb', False),
75    ('test aaa != aaa -a bbb = bbb', False),
76    ('test aaa = aaa -a bbb != bbb', False),
77    ('test aaa = aaa -a bbb = bbb', True),
78
79    # Inversion within binary operators.
80
81    ('test ! aaa != aaa -o ! bbb != bbb', True),
82    ('test ! aaa != aaa -o ! bbb = bbb', True),
83    ('test ! aaa = aaa -o ! bbb != bbb', True),
84    ('test ! aaa = aaa -o ! bbb = bbb', False),
85
86    ('test ! ! aaa != aaa -o ! ! bbb != bbb', False),
87    ('test ! ! aaa != aaa -o ! ! bbb = bbb', True),
88    ('test ! ! aaa = aaa -o ! ! bbb != bbb', True),
89    ('test ! ! aaa = aaa -o ! ! bbb = bbb', True),
90
91    # -z operator.
92
93    ('test -z "$ut_var_nonexistent"', True),
94    ('test -z "$ut_var_exists"', False),
95)
96
97def exec_hush_if(u_boot_console, expr, result):
98    """Execute a shell "if" command, and validate its result."""
99
100    config = u_boot_console.config.buildconfig
101    maxargs = int(config.get('config_sys_maxargs', '0'))
102    args = len(expr.split(' ')) - 1
103    if args > maxargs:
104        u_boot_console.log.warning('CONFIG_SYS_MAXARGS too low; need ' +
105            str(args))
106        pytest.skip()
107
108    cmd = 'if ' + expr + '; then echo true; else echo false; fi'
109    response = u_boot_console.run_command(cmd)
110    assert response.strip() == str(result).lower()
111
112@pytest.mark.buildconfigspec('hush_parser')
113def test_hush_if_test_setup(u_boot_console):
114    """Set up environment variables used during the "if" tests."""
115
116    u_boot_console.run_command('setenv ut_var_nonexistent')
117    u_boot_console.run_command('setenv ut_var_exists 1')
118
119@pytest.mark.buildconfigspec('hush_parser')
120@pytest.mark.parametrize('expr,result', subtests)
121def test_hush_if_test(u_boot_console, expr, result):
122    """Test a single "if test" condition."""
123
124    exec_hush_if(u_boot_console, expr, result)
125
126@pytest.mark.buildconfigspec('hush_parser')
127def test_hush_if_test_teardown(u_boot_console):
128    """Clean up environment variables used during the "if" tests."""
129
130    u_boot_console.run_command('setenv ut_var_exists')
131
132@pytest.mark.buildconfigspec('hush_parser')
133# We might test this on real filesystems via UMS, DFU, 'save', etc.
134# Of those, only UMS currently allows file removal though.
135@pytest.mark.boardspec('sandbox')
136def test_hush_if_test_host_file_exists(u_boot_console):
137    """Test the "if test -e" shell command."""
138
139    test_file = u_boot_console.config.result_dir + \
140        '/creating_this_file_breaks_u_boot_tests'
141
142    try:
143        os.unlink(test_file)
144    except:
145        pass
146    assert not os.path.exists(test_file)
147
148    expr = 'test -e hostfs - ' + test_file
149    exec_hush_if(u_boot_console, expr, False)
150
151    try:
152        with file(test_file, 'wb'):
153            pass
154        assert os.path.exists(test_file)
155
156        expr = 'test -e hostfs - ' + test_file
157        exec_hush_if(u_boot_console, expr, True)
158    finally:
159        os.unlink(test_file)
160
161    expr = 'test -e hostfs - ' + test_file
162    exec_hush_if(u_boot_console, expr, False)
163