#!/usr/bin/env python # # Copyright 2019 Espressif Systems (Shanghai) PTE LTD # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import os import sys import unittest import tempfile import shutil try: from contextlib import redirect_stdout except ImportError: import contextlib @contextlib.contextmanager def redirect_stdout(target): original = sys.stdout sys.stdout = target yield sys.stdout = original try: from cStringIO import StringIO except ImportError: from io import StringIO # Need to do this before importing idf_tools.py os.environ['IDF_MAINTAINER'] = '1' try: import idf_tools except ImportError: sys.path.append('..') import idf_tools ESP32ULP = 'esp32ulp-elf' ESP32S2ULP = 'esp32s2ulp-elf' OPENOCD = 'openocd-esp32' XTENSA_ESP32_ELF = 'xtensa-esp32-elf' XTENSA_ESP32S2_ELF = 'xtensa-esp32s2-elf' ESP32ULP_VERSION = '2.28.51-esp-20191205' ESP32S2ULP_VERSION = '2.28.51-esp-20191205' OPENOCD_VERSION = 'v0.10.0-esp32-20210902' XTENSA_ESP32_ELF_VERSION = 'esp-2020r3-8.4.0' XTENSA_ESP32S2_ELF_VERSION = 'esp-2020r3-8.4.0' class TestUsage(unittest.TestCase): @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 if os.path.exists(old_tools_dir): mirror_prefix_map = 'https://dl.espressif.com/dl/toolchains/preview,file://' + os.path.join(old_tools_dir, 'dist') mirror_prefix_map += ';https://dl.espressif.com/dl,file://' + os.path.join(old_tools_dir, 'dist') mirror_prefix_map += ';https://github.com/espressif/.*/releases/download/.*/,file://' + os.path.join(old_tools_dir, 'dist', '') if mirror_prefix_map: print('Using IDF_MIRROR_PREFIX_MAP={}'.format(mirror_prefix_map)) os.environ['IDF_MIRROR_PREFIX_MAP'] = mirror_prefix_map cls.temp_tools_dir = tempfile.mkdtemp(prefix='idf_tools_tmp') 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(action) output = output_stream.getvalue() return output 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:' % 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) required_tools_installed = 5 output = self.run_idf_tools_with_action(['install']) self.check_install_tool(OPENOCD,OPENOCD_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_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 = 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: ' + XTENSA_ESP32_ELF_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/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.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) 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(XTENSA_ESP32S2_ELF,XTENSA_ESP32S2_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/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) 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(XTENSA_ESP32_ELF,XTENSA_ESP32_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) class TestMaintainer(unittest.TestCase): def test_validation(self): idf_tools.main(['validate']) def test_json_rewrite(self): idf_tools.main(['rewrite']) idf_path = os.getenv('IDF_PATH') if not idf_path: self.fail('IDF_PATH needs to be set to run this test') with open(os.path.join(idf_path, 'tools/tools.json'), 'r') as f: json_old = f.read() with open(os.path.join(idf_path, 'tools/tools.new.json'), 'r') as f: json_new = f.read() self.assertEqual(json_old, json_new) if __name__ == '__main__': unittest.main()