mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
296 lines
11 KiB
Python
Executable File
296 lines
11 KiB
Python
Executable File
#!/usr/bin/env python
|
|
#
|
|
# SPDX-FileCopyrightText: 2019-2022 Espressif Systems (Shanghai) CO LTD
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
import json
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
from unittest import TestCase, main, mock
|
|
|
|
import elftools.common.utils as ecu
|
|
import jsonschema
|
|
from elftools.elf.elffile import ELFFile
|
|
|
|
try:
|
|
from StringIO import StringIO
|
|
except ImportError:
|
|
from io import StringIO
|
|
|
|
try:
|
|
import idf
|
|
except ImportError:
|
|
sys.path.append('..')
|
|
import idf
|
|
|
|
current_dir = os.path.dirname(os.path.realpath(__file__))
|
|
idf_py_path = os.path.join(current_dir, '..', 'idf.py')
|
|
extension_path = os.path.join(current_dir, 'test_idf_extensions', 'test_ext')
|
|
py_actions_path = os.path.join(current_dir, '..', 'idf_py_actions')
|
|
link_path = os.path.join(py_actions_path, 'test_ext')
|
|
|
|
|
|
class TestWithoutExtensions(TestCase):
|
|
@classmethod
|
|
def setUpClass(cls):
|
|
# Disable the component manager and extra extensions for these tests
|
|
cls.env_patcher = mock.patch.dict(os.environ, {
|
|
'IDF_COMPONENT_MANAGER': '0',
|
|
'IDF_EXTRA_ACTIONS_PATH': '',
|
|
})
|
|
cls.env_patcher.start()
|
|
|
|
super().setUpClass()
|
|
|
|
|
|
class TestExtensions(TestWithoutExtensions):
|
|
def test_extension_loading(self):
|
|
try:
|
|
os.symlink(extension_path, link_path)
|
|
os.environ['IDF_EXTRA_ACTIONS_PATH'] = os.path.join(current_dir, 'extra_path')
|
|
output = subprocess.check_output([sys.executable, idf_py_path, '--help'],
|
|
env=os.environ).decode('utf-8', 'ignore')
|
|
|
|
self.assertIn('--test-extension-option', output)
|
|
self.assertIn('test_subcommand', output)
|
|
self.assertIn('--some-extension-option', output)
|
|
self.assertIn('extra_subcommand', output)
|
|
finally:
|
|
os.remove(link_path)
|
|
|
|
def test_extension_execution(self):
|
|
try:
|
|
os.symlink(extension_path, link_path)
|
|
os.environ['IDF_EXTRA_ACTIONS_PATH'] = ';'.join([os.path.join(current_dir, 'extra_path')])
|
|
output = subprocess.check_output(
|
|
[sys.executable, idf_py_path, '--some-extension-option=awesome', 'test_subcommand', 'extra_subcommand'],
|
|
env=os.environ).decode('utf-8', 'ignore')
|
|
self.assertIn('!!! From some global callback: awesome', output)
|
|
self.assertIn('!!! From some subcommand', output)
|
|
self.assertIn('!!! From test global callback: test', output)
|
|
self.assertIn('!!! From some subcommand', output)
|
|
finally:
|
|
os.remove(link_path)
|
|
|
|
def test_hidden_commands(self):
|
|
try:
|
|
os.symlink(extension_path, link_path)
|
|
os.environ['IDF_EXTRA_ACTIONS_PATH'] = ';'.join([os.path.join(current_dir, 'extra_path')])
|
|
output = subprocess.check_output([sys.executable, idf_py_path, '--help'],
|
|
env=os.environ).decode('utf-8', 'ignore')
|
|
self.assertIn('test_subcommand', output)
|
|
self.assertNotIn('hidden_one', output)
|
|
|
|
finally:
|
|
os.remove(link_path)
|
|
|
|
|
|
class TestDependencyManagement(TestWithoutExtensions):
|
|
def test_dependencies(self):
|
|
result = idf.init_cli()(
|
|
args=['--dry-run', 'flash'],
|
|
standalone_mode=False,
|
|
)
|
|
self.assertEqual(['flash'], list(result.keys()))
|
|
|
|
def test_order_only_dependencies(self):
|
|
result = idf.init_cli()(
|
|
args=['--dry-run', 'build', 'fullclean', 'all'],
|
|
standalone_mode=False,
|
|
)
|
|
self.assertEqual(['fullclean', 'all'], list(result.keys()))
|
|
|
|
def test_repeated_dependencies(self):
|
|
result = idf.init_cli()(
|
|
args=['--dry-run', 'fullclean', 'app', 'fullclean', 'fullclean'],
|
|
standalone_mode=False,
|
|
)
|
|
self.assertEqual(['fullclean', 'app'], list(result.keys()))
|
|
|
|
def test_complex_case(self):
|
|
result = idf.init_cli()(
|
|
args=['--dry-run', 'clean', 'monitor', 'clean', 'fullclean', 'flash'],
|
|
standalone_mode=False,
|
|
)
|
|
self.assertEqual(['fullclean', 'clean', 'flash', 'monitor'], list(result.keys()))
|
|
|
|
def test_dupplicated_commands_warning(self):
|
|
capturedOutput = StringIO()
|
|
sys.stderr = capturedOutput
|
|
idf.init_cli()(
|
|
args=['--dry-run', 'clean', 'monitor', 'build', 'clean', 'fullclean', 'all'],
|
|
standalone_mode=False,
|
|
)
|
|
sys.stderr = sys.__stderr__
|
|
self.assertIn(
|
|
'WARNING: Commands "all", "clean" are found in the list of commands more than once.',
|
|
capturedOutput.getvalue())
|
|
|
|
sys.stderr = capturedOutput
|
|
idf.init_cli()(
|
|
args=['--dry-run', 'clean', 'clean'],
|
|
standalone_mode=False,
|
|
)
|
|
sys.stderr = sys.__stderr__
|
|
self.assertIn(
|
|
'WARNING: Command "clean" is found in the list of commands more than once.', capturedOutput.getvalue())
|
|
|
|
|
|
class TestVerboseFlag(TestWithoutExtensions):
|
|
def test_verbose_messages(self):
|
|
output = subprocess.check_output(
|
|
[
|
|
sys.executable,
|
|
idf_py_path,
|
|
'-C%s' % current_dir,
|
|
'-v',
|
|
'test-verbose',
|
|
], env=os.environ).decode('utf-8', 'ignore')
|
|
|
|
self.assertIn('Verbose mode on', output)
|
|
|
|
def test_verbose_messages_not_shown_by_default(self):
|
|
output = subprocess.check_output(
|
|
[
|
|
sys.executable,
|
|
idf_py_path,
|
|
'-C%s' % current_dir,
|
|
'test-verbose',
|
|
], env=os.environ).decode('utf-8', 'ignore')
|
|
|
|
self.assertIn('Output from test-verbose', output)
|
|
self.assertNotIn('Verbose mode on', output)
|
|
|
|
|
|
class TestGlobalAndSubcommandParameters(TestWithoutExtensions):
|
|
def test_set_twice_same_value(self):
|
|
"""Can set -D twice: globally and for subcommand if values are the same"""
|
|
|
|
idf.init_cli()(
|
|
args=['--dry-run', '-DAAA=BBB', '-DCCC=EEE', 'build', '-DAAA=BBB', '-DCCC=EEE'],
|
|
standalone_mode=False,
|
|
)
|
|
|
|
def test_set_twice_different_values(self):
|
|
"""Cannot set -D twice: for command and subcommand of idf.py (with different values)"""
|
|
|
|
with self.assertRaises(idf.FatalError):
|
|
idf.init_cli()(
|
|
args=['--dry-run', '-DAAA=BBB', 'build', '-DAAA=EEE', '-DCCC=EEE'],
|
|
standalone_mode=False,
|
|
)
|
|
|
|
|
|
class TestDeprecations(TestWithoutExtensions):
|
|
def test_exit_with_error_for_subcommand(self):
|
|
try:
|
|
subprocess.check_output(
|
|
[sys.executable, idf_py_path, '-C%s' % current_dir, 'test-2'], env=os.environ, stderr=subprocess.STDOUT)
|
|
except subprocess.CalledProcessError as e:
|
|
self.assertIn('Error: Command "test-2" is deprecated and was removed.', e.output.decode('utf-8', 'ignore'))
|
|
|
|
def test_exit_with_error_for_option(self):
|
|
try:
|
|
subprocess.check_output(
|
|
[sys.executable, idf_py_path, '-C%s' % current_dir, '--test-5=asdf'],
|
|
env=os.environ,
|
|
stderr=subprocess.STDOUT)
|
|
except subprocess.CalledProcessError as e:
|
|
self.assertIn(
|
|
'Error: Option "test_5" is deprecated since v2.0 and was removed in v3.0.',
|
|
e.output.decode('utf-8', 'ignore'))
|
|
|
|
def test_deprecation_messages(self):
|
|
output = subprocess.check_output(
|
|
[
|
|
sys.executable,
|
|
idf_py_path,
|
|
'-C%s' % current_dir,
|
|
'--test-0=a',
|
|
'--test-1=b',
|
|
'--test-2=c',
|
|
'--test-3=d',
|
|
'test-0',
|
|
'--test-sub-0=sa',
|
|
'--test-sub-1=sb',
|
|
'ta',
|
|
'test-1',
|
|
],
|
|
env=os.environ,
|
|
stderr=subprocess.STDOUT).decode('utf-8', 'ignore')
|
|
|
|
self.assertIn('Warning: Option "test_sub_1" is deprecated and will be removed in future versions.', output)
|
|
self.assertIn(
|
|
'Warning: Command "test-1" is deprecated and will be removed in future versions. '
|
|
'Please use alternative command.', output)
|
|
self.assertIn('Warning: Option "test_1" is deprecated and will be removed in future versions.', output)
|
|
self.assertIn(
|
|
'Warning: Option "test_2" is deprecated and will be removed in future versions. '
|
|
'Please update your parameters.', output)
|
|
self.assertIn('Warning: Option "test_3" is deprecated and will be removed in future versions.', output)
|
|
self.assertNotIn('"test-0" is deprecated', output)
|
|
self.assertNotIn('"test_0" is deprecated', output)
|
|
|
|
|
|
class TestHelpOutput(TestWithoutExtensions):
|
|
def test_output(self):
|
|
def action_test(commands, schema):
|
|
output_file = 'idf_py_help_output.json'
|
|
with open(output_file, 'w') as outfile:
|
|
subprocess.run(commands, env=os.environ, stdout=outfile)
|
|
with open(output_file, 'r') as outfile:
|
|
help_obj = json.load(outfile)
|
|
self.assertIsNone(jsonschema.validate(help_obj, schema))
|
|
|
|
with open(os.path.join(current_dir, 'idf_py_help_schema.json'), 'r') as schema_file:
|
|
schema_json = json.load(schema_file)
|
|
action_test(['idf.py', 'help', '--json'], schema_json)
|
|
action_test(['idf.py', 'help', '--json', '--add-options'], schema_json)
|
|
|
|
|
|
class TestROMs(TestWithoutExtensions):
|
|
def get_string_from_elf_by_addr(self, filename: str, address: int) -> str:
|
|
result = ''
|
|
with open(filename, 'rb') as stream:
|
|
elf_file = ELFFile(stream)
|
|
ro = elf_file.get_section_by_name('.rodata')
|
|
ro_addr_delta = ro['sh_addr'] - ro['sh_offset']
|
|
cstring = ecu.parse_cstring_from_stream(ro.stream, address - ro_addr_delta)
|
|
if cstring:
|
|
result = str(cstring.decode('utf-8'))
|
|
return result
|
|
|
|
def test_roms_validate_json(self):
|
|
with open(os.path.join(py_actions_path, 'roms.json'), 'r') as f:
|
|
roms_json = json.load(f)
|
|
|
|
with open(os.path.join(py_actions_path, 'roms_schema.json'), 'r') as f:
|
|
schema_json = json.load(f)
|
|
jsonschema.validate(roms_json, schema_json)
|
|
|
|
def test_roms_check_supported_chips(self):
|
|
from idf_py_actions.constants import SUPPORTED_TARGETS
|
|
with open(os.path.join(py_actions_path, 'roms.json'), 'r') as f:
|
|
roms_json = json.load(f)
|
|
for chip in SUPPORTED_TARGETS:
|
|
self.assertTrue(chip in roms_json, msg=f'Have no ROM data for chip {chip}')
|
|
|
|
def test_roms_validate_build_date(self):
|
|
sys.path.append(py_actions_path)
|
|
|
|
rom_elfs_dir = os.getenv('ESP_ROM_ELF_DIR')
|
|
with open(os.path.join(py_actions_path, 'roms.json'), 'r') as f:
|
|
roms_json = json.load(f)
|
|
|
|
for chip in roms_json:
|
|
for k in roms_json[chip]:
|
|
rom_file = os.path.join(rom_elfs_dir, f'{chip}_rev{k["rev"]}_rom.elf')
|
|
build_date_str = self.get_string_from_elf_by_addr(rom_file, int(k['build_date_str_addr'], base=16))
|
|
self.assertTrue(len(build_date_str) == 11)
|
|
self.assertTrue(build_date_str == k['build_date_str'])
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|