mirror of
https://github.com/espressif/esp-idf.git
synced 2026-04-27 19:13:21 +00:00
refactor(tools): test_idf_tools.py ruff changes
This commit is contained in:
Marek Fiala
@@ -90,7 +90,7 @@ class TestUsage(unittest.TestCase):
|
||||
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
with open(os.path.join(os.getenv('IDF_PATH'), 'tools/tools.json'), 'r') as json_file:
|
||||
with open(os.path.join(os.getenv('IDF_PATH'), 'tools/tools.json')) as json_file:
|
||||
tools_dict = json.load(json_file)
|
||||
cls.tools_dict = tools_dict
|
||||
|
||||
@@ -109,7 +109,7 @@ class TestUsage(unittest.TestCase):
|
||||
|
||||
cls.temp_tools_dir = tempfile.mkdtemp(prefix='idf_tools_tmp')
|
||||
|
||||
print('Using IDF_TOOLS_PATH={}'.format(cls.temp_tools_dir))
|
||||
print(f'Using IDF_TOOLS_PATH={cls.temp_tools_dir}')
|
||||
os.environ['IDF_TOOLS_PATH'] = cls.temp_tools_dir
|
||||
cls.idf_env_json = os.path.join(cls.temp_tools_dir, 'idf-env.json')
|
||||
|
||||
@@ -148,14 +148,14 @@ class TestUsage(unittest.TestCase):
|
||||
|
||||
def test_usage_basic(self):
|
||||
output = self.run_idf_tools_with_action(['list'])
|
||||
self.assertIn('* %s:' % ESP32ULP, output)
|
||||
self.assertIn('- %s (recommended)' % ESP32ULP_VERSION, output)
|
||||
self.assertIn('* %s:' % OPENOCD, output)
|
||||
self.assertIn('- %s (recommended)' % OPENOCD_VERSION, output)
|
||||
self.assertIn('* %s:' % RISCV_ELF, output)
|
||||
self.assertIn('- %s (recommended)' % RISCV_ELF_VERSION, output)
|
||||
self.assertIn('* %s:' % XTENSA_ELF, output)
|
||||
self.assertIn('- %s (recommended)' % XTENSA_ELF_VERSION, output)
|
||||
self.assertIn(f'* {ESP32ULP}:', output)
|
||||
self.assertIn(f'- {ESP32ULP_VERSION} (recommended)', output)
|
||||
self.assertIn(f'* {OPENOCD}:', output)
|
||||
self.assertIn(f'- {OPENOCD_VERSION} (recommended)', output)
|
||||
self.assertIn(f'* {RISCV_ELF}:', output)
|
||||
self.assertIn(f'- {RISCV_ELF_VERSION} (recommended)', output)
|
||||
self.assertIn(f'* {XTENSA_ELF}:', output)
|
||||
self.assertIn(f'- {XTENSA_ELF_VERSION} (recommended)', output)
|
||||
|
||||
required_tools_installed = 7
|
||||
output = self.run_idf_tools_with_action(['install'])
|
||||
@@ -179,20 +179,19 @@ class TestUsage(unittest.TestCase):
|
||||
self.assertIn('version installed in tools directory: ' + ESP_ROM_ELFS_VERSION, output)
|
||||
|
||||
output = self.run_idf_tools_with_action(['export'])
|
||||
self.assertIn('%s/tools/esp32ulp-elf/%s/esp32ulp-elf/bin' %
|
||||
(self.temp_tools_dir, ESP32ULP_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp-elf/%s/xtensa-esp-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ELF_VERSION), output)
|
||||
self.assertIn('%s/tools/openocd-esp32/%s/openocd-esp32/bin' %
|
||||
(self.temp_tools_dir, OPENOCD_VERSION), output)
|
||||
self.assertIn('%s/tools/riscv32-esp-elf/%s/riscv32-esp-elf/bin' %
|
||||
(self.temp_tools_dir, RISCV_ELF_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp-elf-gdb/%s/xtensa-esp-elf-gdb/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP_GDB_VERSION), output)
|
||||
self.assertIn('%s/tools/riscv32-esp-elf-gdb/%s/riscv32-esp-elf-gdb/bin' %
|
||||
(self.temp_tools_dir, RISCV_ESP_GDB_VERSION), output)
|
||||
self.assertIn('%s/tools/esp-rom-elfs/%s/' %
|
||||
(self.temp_tools_dir, ESP_ROM_ELFS_VERSION), output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/esp32ulp-elf/{ESP32ULP_VERSION}/esp32ulp-elf/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/xtensa-esp-elf/{XTENSA_ELF_VERSION}/xtensa-esp-elf/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/openocd-esp32/{OPENOCD_VERSION}/openocd-esp32/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/riscv32-esp-elf/{RISCV_ELF_VERSION}/riscv32-esp-elf/bin', output)
|
||||
self.assertIn(
|
||||
f'{self.temp_tools_dir}/tools/xtensa-esp-elf-gdb/{XTENSA_ESP_GDB_VERSION}/xtensa-esp-elf-gdb/bin',
|
||||
output,
|
||||
)
|
||||
self.assertIn(
|
||||
f'{self.temp_tools_dir}/tools/riscv32-esp-elf-gdb/{RISCV_ESP_GDB_VERSION}/riscv32-esp-elf-gdb/bin',
|
||||
output,
|
||||
)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/esp-rom-elfs/{ESP_ROM_ELFS_VERSION}/', output)
|
||||
|
||||
output = self.run_idf_tools_with_action(['list', '--outdated'])
|
||||
self.assertEqual('', output)
|
||||
@@ -246,20 +245,19 @@ class TestUsage(unittest.TestCase):
|
||||
self.assertIn('version installed in tools directory: ' + ESP_ROM_ELFS_VERSION, output)
|
||||
|
||||
output = self.run_idf_tools_with_action(['export'])
|
||||
self.assertIn('%s/tools/esp32ulp-elf/%s/esp32ulp-elf/bin' %
|
||||
(self.temp_tools_dir, ESP32ULP_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp-elf/%s/xtensa-esp-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ELF_VERSION), output)
|
||||
self.assertIn('%s/tools/openocd-esp32/%s/openocd-esp32/bin' %
|
||||
(self.temp_tools_dir, OPENOCD_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp-elf-gdb/%s/xtensa-esp-elf-gdb/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP_GDB_VERSION), output)
|
||||
self.assertNotIn('%s/tools/riscv32-esp-elf/%s/riscv32-esp-elf/bin' %
|
||||
(self.temp_tools_dir, RISCV_ELF_VERSION), output)
|
||||
self.assertNotIn('%s/tools/riscv32-esp-elf-gdb/%s/riscv32-esp-elf-gdb/bin' %
|
||||
(self.temp_tools_dir, RISCV_ESP_GDB_VERSION), output)
|
||||
self.assertIn('%s/tools/esp-rom-elfs/%s/' %
|
||||
(self.temp_tools_dir, ESP_ROM_ELFS_VERSION), output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/esp32ulp-elf/{ESP32ULP_VERSION}/esp32ulp-elf/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/xtensa-esp-elf/{XTENSA_ELF_VERSION}/xtensa-esp-elf/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/openocd-esp32/{OPENOCD_VERSION}/openocd-esp32/bin', output)
|
||||
self.assertIn(
|
||||
f'{self.temp_tools_dir}/tools/xtensa-esp-elf-gdb/{XTENSA_ESP_GDB_VERSION}/xtensa-esp-elf-gdb/bin',
|
||||
output,
|
||||
)
|
||||
self.assertNotIn(f'{self.temp_tools_dir}/tools/riscv32-esp-elf/{RISCV_ELF_VERSION}/riscv32-esp-elf/bin', output)
|
||||
self.assertNotIn(
|
||||
f'{self.temp_tools_dir}/tools/riscv32-esp-elf-gdb/{RISCV_ESP_GDB_VERSION}/riscv32-esp-elf-gdb/bin',
|
||||
output,
|
||||
)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/esp-rom-elfs/{ESP_ROM_ELFS_VERSION}/', output)
|
||||
|
||||
def test_tools_for_esp32c3(self):
|
||||
required_tools_installed = 4
|
||||
@@ -281,18 +279,15 @@ class TestUsage(unittest.TestCase):
|
||||
self.assertIn('version installed in tools directory: ' + ESP_ROM_ELFS_VERSION, output)
|
||||
|
||||
output = self.run_idf_tools_with_action(['export'])
|
||||
self.assertIn('%s/tools/openocd-esp32/%s/openocd-esp32/bin' %
|
||||
(self.temp_tools_dir, OPENOCD_VERSION), output)
|
||||
self.assertIn('%s/tools/riscv32-esp-elf/%s/riscv32-esp-elf/bin' %
|
||||
(self.temp_tools_dir, RISCV_ELF_VERSION), output)
|
||||
self.assertNotIn('%s/tools/esp32ulp-elf/%s/esp32ulp-elf/bin' %
|
||||
(self.temp_tools_dir, ESP32ULP_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp-elf/%s/xtensa-esp-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ELF_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp-elf-gdb/%s/xtensa-esp-elf-gdb/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP_GDB_VERSION), output)
|
||||
self.assertIn('%s/tools/esp-rom-elfs/%s/' %
|
||||
(self.temp_tools_dir, ESP_ROM_ELFS_VERSION), output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/openocd-esp32/{OPENOCD_VERSION}/openocd-esp32/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/riscv32-esp-elf/{RISCV_ELF_VERSION}/riscv32-esp-elf/bin', output)
|
||||
self.assertNotIn(f'{self.temp_tools_dir}/tools/esp32ulp-elf/{ESP32ULP_VERSION}/esp32ulp-elf/bin', output)
|
||||
self.assertNotIn(f'{self.temp_tools_dir}/tools/xtensa-esp-elf/{XTENSA_ELF_VERSION}/xtensa-esp-elf/bin', output)
|
||||
self.assertNotIn(
|
||||
f'{self.temp_tools_dir}/tools/xtensa-esp-elf-gdb/{XTENSA_ESP_GDB_VERSION}/xtensa-esp-elf-gdb/bin',
|
||||
output,
|
||||
)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/esp-rom-elfs/{ESP_ROM_ELFS_VERSION}/', output)
|
||||
|
||||
def test_tools_for_esp32s2(self):
|
||||
required_tools_installed = 6
|
||||
@@ -314,20 +309,19 @@ class TestUsage(unittest.TestCase):
|
||||
self.assertIn('version installed in tools directory: ' + ESP_ROM_ELFS_VERSION, output)
|
||||
|
||||
output = self.run_idf_tools_with_action(['export'])
|
||||
self.assertIn('%s/tools/xtensa-esp-elf/%s/xtensa-esp-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ELF_VERSION), output)
|
||||
self.assertIn('%s/tools/openocd-esp32/%s/openocd-esp32/bin' %
|
||||
(self.temp_tools_dir, OPENOCD_VERSION), output)
|
||||
self.assertIn('%s/tools/esp32ulp-elf/%s/esp32ulp-elf/bin' %
|
||||
(self.temp_tools_dir, ESP32ULP_VERSION), output)
|
||||
self.assertIn('%s/tools/riscv32-esp-elf/%s/riscv32-esp-elf/bin' %
|
||||
(self.temp_tools_dir, RISCV_ELF_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp-elf-gdb/%s/xtensa-esp-elf-gdb/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP_GDB_VERSION), output)
|
||||
self.assertNotIn('%s/tools/riscv32-esp-elf-gdb/%s/riscv32-esp-elf-gdb/bin' %
|
||||
(self.temp_tools_dir, RISCV_ESP_GDB_VERSION), output)
|
||||
self.assertIn('%s/tools/esp-rom-elfs/%s/' %
|
||||
(self.temp_tools_dir, ESP_ROM_ELFS_VERSION), output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/xtensa-esp-elf/{XTENSA_ELF_VERSION}/xtensa-esp-elf/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/openocd-esp32/{OPENOCD_VERSION}/openocd-esp32/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/esp32ulp-elf/{ESP32ULP_VERSION}/esp32ulp-elf/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/riscv32-esp-elf/{RISCV_ELF_VERSION}/riscv32-esp-elf/bin', output)
|
||||
self.assertIn(
|
||||
f'{self.temp_tools_dir}/tools/xtensa-esp-elf-gdb/{XTENSA_ESP_GDB_VERSION}/xtensa-esp-elf-gdb/bin',
|
||||
output,
|
||||
)
|
||||
self.assertNotIn(
|
||||
f'{self.temp_tools_dir}/tools/riscv32-esp-elf-gdb/{RISCV_ESP_GDB_VERSION}/riscv32-esp-elf-gdb/bin',
|
||||
output,
|
||||
)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/esp-rom-elfs/{ESP_ROM_ELFS_VERSION}/', output)
|
||||
|
||||
def test_tools_for_esp32s3(self):
|
||||
required_tools_installed = 6
|
||||
@@ -350,20 +344,19 @@ class TestUsage(unittest.TestCase):
|
||||
self.assertIn('version installed in tools directory: ' + ESP_ROM_ELFS_VERSION, output)
|
||||
|
||||
output = self.run_idf_tools_with_action(['export'])
|
||||
self.assertIn('%s/tools/openocd-esp32/%s/openocd-esp32/bin' %
|
||||
(self.temp_tools_dir, OPENOCD_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp-elf/%s/xtensa-esp-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ELF_VERSION), output)
|
||||
self.assertIn('%s/tools/esp32ulp-elf/%s/esp32ulp-elf/bin' %
|
||||
(self.temp_tools_dir, ESP32ULP_VERSION), output)
|
||||
self.assertIn('%s/tools/riscv32-esp-elf/%s/riscv32-esp-elf/bin' %
|
||||
(self.temp_tools_dir, RISCV_ELF_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp-elf-gdb/%s/xtensa-esp-elf-gdb/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP_GDB_VERSION), output)
|
||||
self.assertNotIn('%s/tools/riscv32-esp-elf-gdb/%s/riscv32-esp-elf-gdb/bin' %
|
||||
(self.temp_tools_dir, RISCV_ESP_GDB_VERSION), output)
|
||||
self.assertIn('%s/tools/esp-rom-elfs/%s/' %
|
||||
(self.temp_tools_dir, ESP_ROM_ELFS_VERSION), output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/openocd-esp32/{OPENOCD_VERSION}/openocd-esp32/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/xtensa-esp-elf/{XTENSA_ELF_VERSION}/xtensa-esp-elf/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/esp32ulp-elf/{ESP32ULP_VERSION}/esp32ulp-elf/bin', output)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/riscv32-esp-elf/{RISCV_ELF_VERSION}/riscv32-esp-elf/bin', output)
|
||||
self.assertIn(
|
||||
f'{self.temp_tools_dir}/tools/xtensa-esp-elf-gdb/{XTENSA_ESP_GDB_VERSION}/xtensa-esp-elf-gdb/bin',
|
||||
output,
|
||||
)
|
||||
self.assertNotIn(
|
||||
f'{self.temp_tools_dir}/tools/riscv32-esp-elf-gdb/{RISCV_ESP_GDB_VERSION}/riscv32-esp-elf-gdb/bin',
|
||||
output,
|
||||
)
|
||||
self.assertIn(f'{self.temp_tools_dir}/tools/esp-rom-elfs/{ESP_ROM_ELFS_VERSION}/', output)
|
||||
|
||||
# a different test for qemu because of "on_request"
|
||||
def test_tools_for_qemu_with_required(self):
|
||||
@@ -542,16 +535,16 @@ class TestMaintainer(unittest.TestCase):
|
||||
|
||||
def test_json_rewrite(self):
|
||||
idf_tools.main(['rewrite'])
|
||||
with open(self.tools_old, 'r') as f:
|
||||
with open(self.tools_old) as f:
|
||||
json_old = f.read()
|
||||
with open(self.tools_new, 'r') as f:
|
||||
with open(self.tools_new) as f:
|
||||
json_new = f.read()
|
||||
self.assertEqual(json_old, json_new, "Please check 'tools/tools.new.json' to find a cause!")
|
||||
|
||||
def add_version_get_expected_json(self, addition_file, replace=False):
|
||||
with open(self.tools_old, 'r') as f:
|
||||
with open(self.tools_old) as f:
|
||||
expected_json = json.load(f)
|
||||
with open(addition_file, 'r') as f:
|
||||
with open(addition_file) as f:
|
||||
addition_json = json.load(f)
|
||||
for tool in expected_json['tools']:
|
||||
if tool['name'] == self.test_tool_name:
|
||||
@@ -564,7 +557,7 @@ class TestMaintainer(unittest.TestCase):
|
||||
|
||||
def test_add_version_artifact_addition(self):
|
||||
filenames = []
|
||||
with open('add_version/artifact_input.json', 'r') as f:
|
||||
with open('add_version/artifact_input.json') as f:
|
||||
add_tools_info = json.load(f)
|
||||
for tool in add_tools_info:
|
||||
filenames.append(tool['filename'])
|
||||
@@ -584,7 +577,7 @@ class TestMaintainer(unittest.TestCase):
|
||||
] + filenames
|
||||
)
|
||||
expected_json = self.add_version_get_expected_json('add_version/artifact_expected_addition.json')
|
||||
with open(self.tools_new, 'r') as f1:
|
||||
with open(self.tools_new) as f1:
|
||||
self.assertEqual(json.load(f1), expected_json, "Please check 'tools/tools.new.json' to find a cause!")
|
||||
|
||||
def test_add_version_checksum_addition(self):
|
||||
@@ -602,7 +595,7 @@ class TestMaintainer(unittest.TestCase):
|
||||
]
|
||||
)
|
||||
expected_json = self.add_version_get_expected_json('add_version/checksum_expected_addition.json')
|
||||
with open(self.tools_new, 'r') as f1:
|
||||
with open(self.tools_new) as f1:
|
||||
self.assertEqual(json.load(f1), expected_json, "Please check 'tools/tools.new.json' to find a cause!")
|
||||
|
||||
def test_add_version_checksum_with_override(self):
|
||||
@@ -621,7 +614,7 @@ class TestMaintainer(unittest.TestCase):
|
||||
]
|
||||
)
|
||||
expected_json = self.add_version_get_expected_json('add_version/checksum_expected_override.json', True)
|
||||
with open(self.tools_new, 'r') as f1:
|
||||
with open(self.tools_new) as f1:
|
||||
self.assertEqual(json.load(f1), expected_json, "Please check 'tools/tools.new.json' to find a cause!")
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user