feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

ci(autocomplete): add test for file autocompletion

Browse Source 
Merge Request !31081 introduced support for file autocompletion. This
adds a basic test for README files autocompletion in the root directory
of the esp-idf repository.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
This commit is contained in:
Frantisek Hrbata
2024-12-06 13:33:07 +01:00
parent 1f4ea21092
commit 96e627d9a1
1 changed files with 51 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
tools/ci/test_autocomplete/test_autocomplete.py
View File

@@ -1,5 +1,5 @@
#!/usr/bin/env python #!/usr/bin/env python
# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD # SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
import collections import collections
import os import os
@@ -7,13 +7,49 @@ import unittest
import pexpect import pexpect
Test = collections.namedtuple('Test', ['name', 'term', 'pattern', 'ext']) Test = collections.namedtuple('Test', ['name', 'shell', 'term', 'prefix', 'pattern', 'ext'])
IDF_PATH = os.environ['IDF_PATH']
TESTS = (Test('fish', 'vt100', 'all.*app.*app-flash.*bootloader.*', 'fish'), TESTS = (
Test('bash', 'xterm-256color', 'all.*app.*app-flash.*bootloader.*bootloader-flash.*build-system-targets.*clean.*', 'sh'), Test('base',
Test('zsh', '', 'all.*app.*app-flash.*bootloader.*bootloader-flash.*build-system-targets.*clean.*', 'sh')) 'fish',
'vt100',
'',
'all.*app.*app-flash.*bootloader.*',
'fish'),
Test('base',
'bash',
'xterm-256color',
'',
'all.*app.*app-flash.*bootloader.*bootloader-flash.*build-system-targets.*clean.*',
'sh'),
Test('base',
'zsh',
'',
'',
'all.*app.*app-flash.*bootloader.*bootloader-flash.*build-system-targets.*clean.*',
'sh'),
# Tests for file autocompletion
Test('file',
'fish',
'vt100',
f'@{IDF_PATH}/README',
'.*README.*md.*',
'fish'),
Test('file',
'bash',
'xterm-256color',
f'@{IDF_PATH}/README',
'.*README.*md.*',
'sh'),
Test('file',
'zsh',
'',
f'@{IDF_PATH}/README',
'.*README.*md.*',
'sh')
)
# Additional positional arguments for all child.expect() calls are constant so we can rely on the order and print message # Additional positional arguments for all child.expect() calls are constant so we can rely on the order and print message
# about which pattern was matched # about which pattern was matched
@@ -34,19 +70,22 @@ def get_fail_msg(pproc: pexpect.spawn, msg: str, index: int) -> str:
class UTTest(unittest.TestCase): class UTTest(unittest.TestCase):
def test_shell(self) -> None: def test_shell(self) -> None:
idf_path = os.environ['IDF_PATH']
env = os.environ.copy() env = os.environ.copy()
for test in TESTS: for test in TESTS:
with self.subTest(): with self.subTest():
with open(os.path.join(idf_path, f'{test.name}.out'), 'wb') as o: with open(os.path.join(IDF_PATH, f'{test.shell}.{test.name}.out'), 'wb') as o:
env['TERM'] = test.term env['TERM'] = test.term
with pexpect.spawn(f'{test.name} -i', env=env, logfile=o, timeout=200) as pproc: with pexpect.spawn(f'{test.shell} -i', env=env, logfile=o, timeout=200) as pproc:
pproc.sendline(f'. {idf_path}/export.{test.ext}') if test.shell == 'bash':
# The @-argument autocomplete works reliably in bash only
# if @ is not included in COMP_WORDBREAKS.
pproc.sendline('COMP_WORDBREAKS=${COMP_WORDBREAKS//@/}')
pproc.sendline(f'. {IDF_PATH}/export.{test.ext}')
i = pproc.expect(['Go to the project directory and run.*idf\\.py build', *pargs]) i = pproc.expect(['Go to the project directory and run.*idf\\.py build', *pargs])
self.assertEqual(i, 0, get_fail_msg(pproc, 'Export was not successful!', i)) self.assertEqual(i, 0, get_fail_msg(pproc, 'Export was not successful!', i))
pproc.send('idf.py \t\t') pproc.send(f'idf.py {test.prefix}\t\t')
i = pproc.expect([test.pattern, *pargs], timeout=100) i = pproc.expect([test.pattern, *pargs], timeout=100)
self.assertEqual(i, 0, get_fail_msg(pproc, f'Autocompletion for idf.py failed in {test.name}!', i)) self.assertEqual(i, 0, get_fail_msg(pproc, f'Autocompletion for idf.py failed in {test.shell}!', i))
if __name__ == '__main__': if __name__ == '__main__':