mirror of
https://github.com/espressif/esp-idf.git
synced 2025-08-08 04:02:27 +00:00
tools: Installing tools for given IDF_TARGET
Allow user to select specific ESP_TARGET while setting up ESD_IDF. Only necessary tools for given target will be downloaded and installed. Closes https://github.com/espressif/esp-idf/issues/5113
This commit is contained in:
Marek Fiala
@@ -46,10 +46,27 @@ except ImportError:
|
||||
sys.path.append('..')
|
||||
import idf_tools
|
||||
|
||||
ESP32ULP = 'esp32ulp-elf'
|
||||
ESP32S2ULP = 'esp32s2ulp-elf'
|
||||
OPENOCD = 'openocd-esp32'
|
||||
RISC = 'riscv32-esp-elf'
|
||||
XTENSA_ESP32_ELF = 'xtensa-esp32-elf'
|
||||
XTENSA_ESP32S2_ELF = 'xtensa-esp32s2-elf'
|
||||
XTENSA_ESP32S3_ELF = 'xtensa-esp32s3-elf'
|
||||
|
||||
ESP32ULP_VERSION = '2.28.51-esp-20191205'
|
||||
ESP32S2ULP_VERSION = '2.28.51-esp-20191205'
|
||||
OPENOCD_VERSION = 'v0.10.0-esp32-20210401'
|
||||
RISC_VERSION = 'esp-2021r1-8.4.0'
|
||||
XTENSA_ESP32_ELF_VERSION = 'esp-2021r1-8.4.0'
|
||||
XTENSA_ESP32S2_ELF_VERSION = 'esp-2021r1-8.4.0'
|
||||
XTENSA_ESP32S3_ELF_VERSION = 'esp-2021r1-8.4.0'
|
||||
|
||||
|
||||
class TestUsage(unittest.TestCase):
|
||||
|
||||
def test_usage_basic(self):
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
old_tools_dir = os.environ.get('IDF_TOOLS_PATH') or os.path.expanduser(idf_tools.IDF_TOOLS_PATH_DEFAULT)
|
||||
|
||||
mirror_prefix_map = None
|
||||
@@ -61,53 +78,243 @@ class TestUsage(unittest.TestCase):
|
||||
print('Using IDF_MIRROR_PREFIX_MAP={}'.format(mirror_prefix_map))
|
||||
os.environ['IDF_MIRROR_PREFIX_MAP'] = mirror_prefix_map
|
||||
|
||||
temp_tools_dir = tempfile.mkdtemp(prefix='idf_tools_tmp')
|
||||
print('Using IDF_TOOLS_PATH={}'.format(temp_tools_dir))
|
||||
os.environ['IDF_TOOLS_PATH'] = temp_tools_dir
|
||||
cls.temp_tools_dir = tempfile.mkdtemp(prefix='idf_tools_tmp')
|
||||
|
||||
self.addCleanup(shutil.rmtree, temp_tools_dir)
|
||||
print('Using IDF_TOOLS_PATH={}'.format(cls.temp_tools_dir))
|
||||
os.environ['IDF_TOOLS_PATH'] = cls.temp_tools_dir
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls):
|
||||
shutil.rmtree(cls.temp_tools_dir)
|
||||
|
||||
def tearDown(self):
|
||||
if os.path.isdir(os.path.join(self.temp_tools_dir, 'dist')):
|
||||
shutil.rmtree(os.path.join(self.temp_tools_dir, 'dist'))
|
||||
|
||||
if os.path.isdir(os.path.join(self.temp_tools_dir, 'tools')):
|
||||
shutil.rmtree(os.path.join(self.temp_tools_dir, 'tools'))
|
||||
|
||||
if os.path.isfile(os.path.join(self.temp_tools_dir, 'idf-env.json')):
|
||||
os.remove(os.path.join(self.temp_tools_dir, 'idf-env.json'))
|
||||
|
||||
def check_install_tool(self,tool,tool_version,output,assertIn=True):
|
||||
if assertIn:
|
||||
self.assertIn('Installing %s@' % tool + tool_version, output)
|
||||
self.assertIn('Downloading %s' % tool, output)
|
||||
else:
|
||||
self.assertNotIn('Installing %s@' % tool + tool_version, output)
|
||||
self.assertNotIn('Downloading %s' % tool, output)
|
||||
|
||||
def check_install_esp32_ulp(self,output,assertIn=True):
|
||||
if assertIn:
|
||||
self.assertIn('Installing esp32ulp-elf@' + ESP32ULP_VERSION, output)
|
||||
self.assertIn('Downloading binutils-esp32ulp', output)
|
||||
else:
|
||||
self.assertNotIn('Installing esp32ulp-elf@' + ESP32ULP_VERSION, output)
|
||||
self.assertNotIn('Downloading binutils-esp32ulp', output)
|
||||
|
||||
def check_install_esp32s2_ulp(self,output,assertIn=True):
|
||||
if assertIn:
|
||||
self.assertIn('Installing esp32s2ulp-elf@' + ESP32S2ULP_VERSION, output)
|
||||
self.assertIn('Downloading binutils-esp32s2ulp', output)
|
||||
else:
|
||||
self.assertNotIn('Installing esp32s2ulp-elf@' + ESP32S2ULP_VERSION, output)
|
||||
self.assertNotIn('Downloading binutils-esp32s2ulp', output)
|
||||
|
||||
def run_idf_tools_with_action(self,action):
|
||||
output_stream = StringIO()
|
||||
with redirect_stdout(output_stream):
|
||||
idf_tools.main(['list'])
|
||||
idf_tools.main(action)
|
||||
output = output_stream.getvalue()
|
||||
return output
|
||||
|
||||
xtensa_esp32_elf_version = 'esp-2021r1-8.4.0'
|
||||
esp32ulp_version = '2.28.51-esp-20191205'
|
||||
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:' % ESP32S2ULP, output)
|
||||
self.assertIn('- %s (recommended)' % ESP32S2ULP_VERSION, output)
|
||||
self.assertIn('* %s:' % OPENOCD, output)
|
||||
self.assertIn('- %s (recommended)' % OPENOCD_VERSION, output)
|
||||
self.assertIn('* %s:' % RISC, output)
|
||||
self.assertIn('- %s (recommended)' % RISC_VERSION, output)
|
||||
self.assertIn('* %s:' % XTENSA_ESP32_ELF, output)
|
||||
self.assertIn('- %s (recommended)' % XTENSA_ESP32_ELF_VERSION, output)
|
||||
self.assertIn('* %s:' % XTENSA_ESP32S2_ELF, output)
|
||||
self.assertIn('- %s (recommended)' % XTENSA_ESP32S2_ELF_VERSION, output)
|
||||
self.assertIn('* %s:' % XTENSA_ESP32S3_ELF, output)
|
||||
self.assertIn('- %s (recommended)' % XTENSA_ESP32S3_ELF_VERSION, output)
|
||||
|
||||
self.assertIn('* xtensa-esp32-elf:', output)
|
||||
self.assertIn('- %s (recommended)' % xtensa_esp32_elf_version, output)
|
||||
self.assertIn('* esp32ulp-elf', output)
|
||||
self.assertIn('- %s (recommended)' % esp32ulp_version, output)
|
||||
required_tools_installed = 7
|
||||
output = self.run_idf_tools_with_action(['install'])
|
||||
self.check_install_tool(OPENOCD,OPENOCD_VERSION,output)
|
||||
self.check_install_tool(RISC,RISC_VERSION,output)
|
||||
self.check_install_tool(XTENSA_ESP32_ELF,XTENSA_ESP32_ELF_VERSION,output)
|
||||
self.check_install_tool(XTENSA_ESP32S2_ELF,XTENSA_ESP32S2_ELF_VERSION,output)
|
||||
self.check_install_tool(XTENSA_ESP32S3_ELF,XTENSA_ESP32S3_ELF_VERSION,output)
|
||||
self.check_install_esp32_ulp(output)
|
||||
self.check_install_esp32s2_ulp(output)
|
||||
self.assertIn('to ' + os.path.join(self.temp_tools_dir, 'dist'), output)
|
||||
self.assertEqual(required_tools_installed,output.count('Done'))
|
||||
|
||||
output_stream = StringIO()
|
||||
with redirect_stdout(output_stream):
|
||||
idf_tools.main(['install'])
|
||||
output = output_stream.getvalue()
|
||||
|
||||
self.assertIn('Installing esp32ulp-elf@' + esp32ulp_version, output)
|
||||
self.assertIn('Downloading binutils-esp32ulp', output)
|
||||
self.assertIn('Installing xtensa-esp32-elf@' + xtensa_esp32_elf_version, output)
|
||||
self.assertIn('Downloading xtensa-esp32-elf', output)
|
||||
self.assertIn('to ' + os.path.join(temp_tools_dir, 'dist'), output)
|
||||
|
||||
output_stream = StringIO()
|
||||
with redirect_stdout(output_stream):
|
||||
idf_tools.main(['check'])
|
||||
output = output_stream.getvalue()
|
||||
|
||||
self.assertIn('version installed in tools directory: ' + esp32ulp_version, output)
|
||||
self.assertIn('version installed in tools directory: ' + xtensa_esp32_elf_version, output)
|
||||
|
||||
output_stream = StringIO()
|
||||
with redirect_stdout(output_stream):
|
||||
idf_tools.main(['export'])
|
||||
output = output_stream.getvalue()
|
||||
output = self.run_idf_tools_with_action(['check'])
|
||||
self.assertIn('version installed in tools directory: ' + ESP32ULP_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + ESP32S2ULP_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + OPENOCD_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + RISC_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + XTENSA_ESP32_ELF_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + XTENSA_ESP32S2_ELF_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + XTENSA_ESP32S3_ELF_VERSION, output)
|
||||
|
||||
output = self.run_idf_tools_with_action(['export'])
|
||||
self.assertIn('%s/tools/esp32ulp-elf/%s/esp32ulp-elf-binutils/bin' %
|
||||
(temp_tools_dir, esp32ulp_version), output)
|
||||
(self.temp_tools_dir, ESP32ULP_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp32-elf/%s/xtensa-esp32-elf/bin' %
|
||||
(temp_tools_dir, xtensa_esp32_elf_version), output)
|
||||
(self.temp_tools_dir, XTENSA_ESP32_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, RISC_VERSION), output)
|
||||
self.assertIn('%s/tools/esp32s2ulp-elf/%s/esp32s2ulp-elf-binutils/bin' %
|
||||
(self.temp_tools_dir, ESP32S2ULP_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp32s2-elf/%s/xtensa-esp32s2-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32S2_ELF_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp32s3-elf/%s/xtensa-esp32s3-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32S3_ELF_VERSION), output)
|
||||
|
||||
def test_tools_for_esp32(self):
|
||||
required_tools_installed = 3
|
||||
output = self.run_idf_tools_with_action(['install', '--targets=esp32'])
|
||||
self.check_install_tool(XTENSA_ESP32_ELF,XTENSA_ESP32_ELF_VERSION,output)
|
||||
self.check_install_tool(OPENOCD,OPENOCD_VERSION,output)
|
||||
self.check_install_esp32_ulp(output)
|
||||
self.check_install_tool(RISC,RISC_VERSION,output,assertIn=False)
|
||||
self.check_install_tool(XTENSA_ESP32S2_ELF,XTENSA_ESP32S2_ELF_VERSION,output,assertIn=False)
|
||||
self.check_install_tool(XTENSA_ESP32S3_ELF,XTENSA_ESP32S3_ELF_VERSION,output,assertIn=False)
|
||||
self.check_install_esp32s2_ulp(output,assertIn=False)
|
||||
self.assertIn('to ' + os.path.join(self.temp_tools_dir, 'dist'), output)
|
||||
self.assertEqual(required_tools_installed,output.count('Done'))
|
||||
|
||||
output = self.run_idf_tools_with_action(['check'])
|
||||
self.assertIn('version installed in tools directory: ' + ESP32ULP_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + XTENSA_ESP32_ELF_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + OPENOCD_VERSION, output)
|
||||
|
||||
output = self.run_idf_tools_with_action(['export'])
|
||||
self.assertIn('%s/tools/esp32ulp-elf/%s/esp32ulp-elf-binutils/bin' %
|
||||
(self.temp_tools_dir, ESP32ULP_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp32-elf/%s/xtensa-esp32-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32_ELF_VERSION), output)
|
||||
self.assertIn('%s/tools/openocd-esp32/%s/openocd-esp32/bin' %
|
||||
(self.temp_tools_dir, OPENOCD_VERSION), output)
|
||||
self.assertNotIn('%s/tools/riscv32-esp-elf/%s/riscv32-esp-elf/bin' %
|
||||
(self.temp_tools_dir, RISC_VERSION), output)
|
||||
self.assertNotIn('%s/tools/esp32s2ulp-elf/%s/esp32s2ulp-elf-binutils/bin' %
|
||||
(self.temp_tools_dir, ESP32S2ULP_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp32s2-elf/%s/xtensa-esp32s2-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32S2_ELF_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp32s3-elf/%s/xtensa-esp32s3-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32S3_ELF_VERSION), output)
|
||||
|
||||
def test_tools_for_esp32c3(self):
|
||||
required_tools_installed = 2
|
||||
output = self.run_idf_tools_with_action(['install', '--targets=esp32c3'])
|
||||
self.check_install_tool(OPENOCD,OPENOCD_VERSION,output)
|
||||
self.check_install_tool(RISC,RISC_VERSION,output)
|
||||
self.check_install_tool(XTENSA_ESP32_ELF,XTENSA_ESP32_ELF_VERSION,output,assertIn=False)
|
||||
self.check_install_tool(XTENSA_ESP32S2_ELF,XTENSA_ESP32S2_ELF_VERSION,output,assertIn=False)
|
||||
self.check_install_tool(XTENSA_ESP32S3_ELF,XTENSA_ESP32S3_ELF_VERSION,output,assertIn=False)
|
||||
self.check_install_esp32_ulp(output,assertIn=False)
|
||||
self.check_install_esp32s2_ulp(output,assertIn=False)
|
||||
self.assertIn('to ' + os.path.join(self.temp_tools_dir, 'dist'), output)
|
||||
self.assertEqual(required_tools_installed,output.count('Done'))
|
||||
|
||||
output = self.run_idf_tools_with_action(['check'])
|
||||
self.assertIn('version installed in tools directory: ' + OPENOCD_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + RISC_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, RISC_VERSION), output)
|
||||
self.assertNotIn('%s/tools/esp32ulp-elf/%s/esp32ulp-elf-binutils/bin' %
|
||||
(self.temp_tools_dir, ESP32ULP_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp32-elf/%s/xtensa-esp32-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32_ELF_VERSION), output)
|
||||
self.assertNotIn('%s/tools/esp32s2ulp-elf/%s/esp32s2ulp-elf-binutils/bin' %
|
||||
(self.temp_tools_dir, ESP32S2ULP_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp32s2-elf/%s/xtensa-esp32s2-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32S2_ELF_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp32s3-elf/%s/xtensa-esp32s3-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32S3_ELF_VERSION), output)
|
||||
|
||||
def test_tools_for_esp32s2(self):
|
||||
required_tools_installed = 3
|
||||
output = self.run_idf_tools_with_action(['install', '--targets=esp32s2'])
|
||||
self.check_install_tool(XTENSA_ESP32S2_ELF,XTENSA_ESP32S2_ELF_VERSION,output)
|
||||
self.check_install_tool(OPENOCD,OPENOCD_VERSION,output)
|
||||
self.check_install_esp32s2_ulp(output)
|
||||
self.check_install_tool(RISC,RISC_VERSION,output,assertIn=False)
|
||||
self.check_install_tool(XTENSA_ESP32_ELF,XTENSA_ESP32_ELF_VERSION,output,assertIn=False)
|
||||
self.check_install_tool(XTENSA_ESP32S3_ELF,XTENSA_ESP32S3_ELF_VERSION,output,assertIn=False)
|
||||
self.check_install_esp32_ulp(output,assertIn=False)
|
||||
self.assertIn('to ' + os.path.join(self.temp_tools_dir, 'dist'), output)
|
||||
self.assertEqual(required_tools_installed,output.count('Done'))
|
||||
|
||||
output = self.run_idf_tools_with_action(['check'])
|
||||
self.assertIn('version installed in tools directory: ' + ESP32S2ULP_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + OPENOCD_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + XTENSA_ESP32S2_ELF_VERSION, output)
|
||||
|
||||
output = self.run_idf_tools_with_action(['export'])
|
||||
self.assertIn('%s/tools/esp32s2ulp-elf/%s/esp32s2ulp-elf-binutils/bin' %
|
||||
(self.temp_tools_dir, ESP32S2ULP_VERSION), output)
|
||||
self.assertIn('%s/tools/xtensa-esp32s2-elf/%s/xtensa-esp32s2-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32S2_ELF_VERSION), output)
|
||||
self.assertIn('%s/tools/openocd-esp32/%s/openocd-esp32/bin' %
|
||||
(self.temp_tools_dir, OPENOCD_VERSION), output)
|
||||
self.assertNotIn('%s/tools/esp32ulp-elf/%s/esp32ulp-elf-binutils/bin' %
|
||||
(self.temp_tools_dir, ESP32ULP_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp32-elf/%s/xtensa-esp32-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32_ELF_VERSION), output)
|
||||
self.assertNotIn('%s/tools/riscv32-esp-elf/%s/riscv32-esp-elf/bin' %
|
||||
(self.temp_tools_dir, RISC_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp32s3-elf/%s/xtensa-esp32s3-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32S3_ELF_VERSION), output)
|
||||
|
||||
def test_tools_for_esp32s3(self):
|
||||
required_tools_installed = 2
|
||||
output = self.run_idf_tools_with_action(['install', '--targets=esp32s3'])
|
||||
self.check_install_tool(OPENOCD,OPENOCD_VERSION,output)
|
||||
self.check_install_tool(XTENSA_ESP32S3_ELF,XTENSA_ESP32S3_ELF_VERSION,output)
|
||||
self.check_install_tool(RISC,RISC_VERSION,output,assertIn=False)
|
||||
self.check_install_tool(XTENSA_ESP32_ELF,XTENSA_ESP32_ELF_VERSION,output,assertIn=False)
|
||||
self.check_install_tool(XTENSA_ESP32S2_ELF,XTENSA_ESP32S2_ELF_VERSION,output,assertIn=False)
|
||||
self.check_install_esp32_ulp(output,assertIn=False)
|
||||
self.check_install_esp32s2_ulp(output,assertIn=False)
|
||||
self.assertIn('to ' + os.path.join(self.temp_tools_dir, 'dist'), output)
|
||||
self.assertEqual(required_tools_installed,output.count('Done'))
|
||||
|
||||
output = self.run_idf_tools_with_action(['check'])
|
||||
self.assertIn('version installed in tools directory: ' + OPENOCD_VERSION, output)
|
||||
self.assertIn('version installed in tools directory: ' + XTENSA_ESP32S3_ELF_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-esp32s3-elf/%s/xtensa-esp32s3-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32S3_ELF_VERSION), output)
|
||||
self.assertNotIn('%s/tools/esp32ulp-elf/%s/esp32ulp-elf-binutils/bin' %
|
||||
(self.temp_tools_dir, ESP32ULP_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp32-elf/%s/xtensa-esp32-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32_ELF_VERSION), output)
|
||||
self.assertNotIn('%s/tools/riscv32-esp-elf/%s/riscv32-esp-elf/bin' %
|
||||
(self.temp_tools_dir, RISC_VERSION), output)
|
||||
self.assertNotIn('%s/tools/esp32s2ulp-elf/%s/esp32s2ulp-elf-binutils/bin' %
|
||||
(self.temp_tools_dir, ESP32S2ULP_VERSION), output)
|
||||
self.assertNotIn('%s/tools/xtensa-esp32s2-elf/%s/xtensa-esp32s2-elf/bin' %
|
||||
(self.temp_tools_dir, XTENSA_ESP32S2_ELF_VERSION), output)
|
||||
|
||||
|
||||
class TestMaintainer(unittest.TestCase):
|
||||
|
||||
Reference in New Issue
Block a user