2019-08-21 12:24:14 +00:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# Copyright 2019 Espressif Systems (Shanghai) CO 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.
|
|
|
|
|
2019-10-03 16:26:44 +00:00
|
|
|
import os
|
2021-01-26 02:49:01 +00:00
|
|
|
import subprocess
|
2019-08-21 12:24:14 +00:00
|
|
|
import sys
|
2022-05-27 08:41:48 +00:00
|
|
|
from unittest import TestCase, main, mock
|
2019-08-21 12:24:14 +00:00
|
|
|
|
|
|
|
try:
|
|
|
|
from StringIO import StringIO
|
|
|
|
except ImportError:
|
|
|
|
from io import StringIO
|
|
|
|
|
|
|
|
try:
|
|
|
|
import idf
|
|
|
|
except ImportError:
|
|
|
|
sys.path.append('..')
|
|
|
|
import idf
|
|
|
|
|
2019-10-03 16:26:44 +00:00
|
|
|
current_dir = os.path.dirname(os.path.realpath(__file__))
|
|
|
|
idf_py_path = os.path.join(current_dir, '..', 'idf.py')
|
2019-10-24 11:20:25 +00:00
|
|
|
extension_path = os.path.join(current_dir, 'test_idf_extensions', 'test_ext')
|
|
|
|
link_path = os.path.join(current_dir, '..', 'idf_py_actions', 'test_ext')
|
2019-10-03 16:26:44 +00:00
|
|
|
|
|
|
|
|
2022-05-27 08:41:48 +00:00
|
|
|
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):
|
2019-10-03 16:26:44 +00:00
|
|
|
def test_extension_loading(self):
|
|
|
|
try:
|
|
|
|
os.symlink(extension_path, link_path)
|
2021-01-26 02:49:01 +00:00
|
|
|
os.environ['IDF_EXTRA_ACTIONS_PATH'] = os.path.join(current_dir, 'extra_path')
|
|
|
|
output = subprocess.check_output([sys.executable, idf_py_path, '--help'],
|
2019-10-03 16:26:44 +00:00
|
|
|
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)
|
2021-01-26 02:49:01 +00:00
|
|
|
os.environ['IDF_EXTRA_ACTIONS_PATH'] = ';'.join([os.path.join(current_dir, 'extra_path')])
|
2019-10-03 16:26:44 +00:00
|
|
|
output = subprocess.check_output(
|
2021-01-26 02:49:01 +00:00
|
|
|
[sys.executable, idf_py_path, '--some-extension-option=awesome', 'test_subcommand', 'extra_subcommand'],
|
2019-10-03 16:26:44 +00:00
|
|
|
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)
|
|
|
|
|
2019-11-08 16:54:10 +00:00
|
|
|
def test_hidden_commands(self):
|
|
|
|
try:
|
|
|
|
os.symlink(extension_path, link_path)
|
2021-01-26 02:49:01 +00:00
|
|
|
os.environ['IDF_EXTRA_ACTIONS_PATH'] = ';'.join([os.path.join(current_dir, 'extra_path')])
|
|
|
|
output = subprocess.check_output([sys.executable, idf_py_path, '--help'],
|
2019-11-08 16:54:10 +00:00
|
|
|
env=os.environ).decode('utf-8', 'ignore')
|
|
|
|
self.assertIn('test_subcommand', output)
|
|
|
|
self.assertNotIn('hidden_one', output)
|
|
|
|
|
|
|
|
finally:
|
|
|
|
os.remove(link_path)
|
|
|
|
|
2019-08-21 12:24:14 +00:00
|
|
|
|
2022-05-27 08:41:48 +00:00
|
|
|
class TestDependencyManagement(TestWithoutExtensions):
|
2019-08-21 12:24:14 +00:00
|
|
|
def test_dependencies(self):
|
|
|
|
result = idf.init_cli()(
|
2019-10-03 16:26:44 +00:00
|
|
|
args=['--dry-run', 'flash'],
|
2019-08-21 12:24:14 +00:00
|
|
|
standalone_mode=False,
|
|
|
|
)
|
2020-02-14 07:24:11 +00:00
|
|
|
self.assertEqual(['flash'], list(result.keys()))
|
2019-08-21 12:24:14 +00:00
|
|
|
|
|
|
|
def test_order_only_dependencies(self):
|
|
|
|
result = idf.init_cli()(
|
2019-10-03 16:26:44 +00:00
|
|
|
args=['--dry-run', 'build', 'fullclean', 'all'],
|
2019-08-21 12:24:14 +00:00
|
|
|
standalone_mode=False,
|
|
|
|
)
|
|
|
|
self.assertEqual(['fullclean', 'all'], list(result.keys()))
|
|
|
|
|
|
|
|
def test_repeated_dependencies(self):
|
|
|
|
result = idf.init_cli()(
|
2019-10-03 16:26:44 +00:00
|
|
|
args=['--dry-run', 'fullclean', 'app', 'fullclean', 'fullclean'],
|
2019-08-21 12:24:14 +00:00
|
|
|
standalone_mode=False,
|
|
|
|
)
|
|
|
|
self.assertEqual(['fullclean', 'app'], list(result.keys()))
|
|
|
|
|
|
|
|
def test_complex_case(self):
|
|
|
|
result = idf.init_cli()(
|
2019-10-03 16:26:44 +00:00
|
|
|
args=['--dry-run', 'clean', 'monitor', 'clean', 'fullclean', 'flash'],
|
2019-08-21 12:24:14 +00:00
|
|
|
standalone_mode=False,
|
|
|
|
)
|
2020-02-14 07:24:11 +00:00
|
|
|
self.assertEqual(['fullclean', 'clean', 'flash', 'monitor'], list(result.keys()))
|
2019-08-21 12:24:14 +00:00
|
|
|
|
|
|
|
def test_dupplicated_commands_warning(self):
|
|
|
|
capturedOutput = StringIO()
|
2020-11-07 11:45:54 +00:00
|
|
|
sys.stderr = capturedOutput
|
2019-08-21 12:24:14 +00:00
|
|
|
idf.init_cli()(
|
2019-10-03 16:26:44 +00:00
|
|
|
args=['--dry-run', 'clean', 'monitor', 'build', 'clean', 'fullclean', 'all'],
|
2019-08-21 12:24:14 +00:00
|
|
|
standalone_mode=False,
|
|
|
|
)
|
2020-11-07 11:45:54 +00:00
|
|
|
sys.stderr = sys.__stderr__
|
2019-11-25 10:47:55 +00:00
|
|
|
self.assertIn(
|
|
|
|
'WARNING: Commands "all", "clean" are found in the list of commands more than once.',
|
|
|
|
capturedOutput.getvalue())
|
2019-08-21 12:24:14 +00:00
|
|
|
|
2020-11-07 11:45:54 +00:00
|
|
|
sys.stderr = capturedOutput
|
2019-08-21 12:24:14 +00:00
|
|
|
idf.init_cli()(
|
2019-10-03 16:26:44 +00:00
|
|
|
args=['--dry-run', 'clean', 'clean'],
|
2019-08-21 12:24:14 +00:00
|
|
|
standalone_mode=False,
|
|
|
|
)
|
2020-11-07 11:45:54 +00:00
|
|
|
sys.stderr = sys.__stderr__
|
2019-11-25 10:47:55 +00:00
|
|
|
self.assertIn(
|
|
|
|
'WARNING: Command "clean" is found in the list of commands more than once.', capturedOutput.getvalue())
|
|
|
|
|
|
|
|
|
2022-05-27 08:41:48 +00:00
|
|
|
class TestVerboseFlag(TestWithoutExtensions):
|
2019-11-25 10:47:55 +00:00
|
|
|
def test_verbose_messages(self):
|
|
|
|
output = subprocess.check_output(
|
|
|
|
[
|
|
|
|
sys.executable,
|
|
|
|
idf_py_path,
|
2021-01-26 02:49:01 +00:00
|
|
|
'-C%s' % current_dir,
|
|
|
|
'-v',
|
|
|
|
'test-verbose',
|
2019-11-25 10:47:55 +00:00
|
|
|
], 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,
|
2021-01-26 02:49:01 +00:00
|
|
|
'-C%s' % current_dir,
|
|
|
|
'test-verbose',
|
2019-11-25 10:47:55 +00:00
|
|
|
], env=os.environ).decode('utf-8', 'ignore')
|
|
|
|
|
|
|
|
self.assertIn('Output from test-verbose', output)
|
|
|
|
self.assertNotIn('Verbose mode on', output)
|
2019-08-21 12:24:14 +00:00
|
|
|
|
|
|
|
|
2022-05-27 08:41:48 +00:00
|
|
|
class TestGlobalAndSubcommandParameters(TestWithoutExtensions):
|
2019-08-21 12:24:14 +00:00
|
|
|
def test_set_twice_same_value(self):
|
|
|
|
"""Can set -D twice: globally and for subcommand if values are the same"""
|
|
|
|
|
|
|
|
idf.init_cli()(
|
2019-10-03 16:26:44 +00:00
|
|
|
args=['--dry-run', '-DAAA=BBB', '-DCCC=EEE', 'build', '-DAAA=BBB', '-DCCC=EEE'],
|
2019-08-21 12:24:14 +00:00
|
|
|
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()(
|
2019-10-03 16:26:44 +00:00
|
|
|
args=['--dry-run', '-DAAA=BBB', 'build', '-DAAA=EEE', '-DCCC=EEE'],
|
2019-08-21 12:24:14 +00:00
|
|
|
standalone_mode=False,
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2022-05-27 08:41:48 +00:00
|
|
|
class TestDeprecations(TestWithoutExtensions):
|
2019-11-14 12:48:24 +00:00
|
|
|
def test_exit_with_error_for_subcommand(self):
|
|
|
|
try:
|
2022-05-27 08:41:48 +00:00
|
|
|
subprocess.check_output(
|
|
|
|
[sys.executable, idf_py_path, '-C%s' % current_dir, 'test-2'], env=os.environ, stderr=subprocess.STDOUT)
|
2019-11-14 12:48:24 +00:00
|
|
|
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:
|
2022-05-27 08:41:48 +00:00
|
|
|
subprocess.check_output(
|
|
|
|
[sys.executable, idf_py_path, '-C%s' % current_dir, '--test-5=asdf'],
|
|
|
|
env=os.environ,
|
|
|
|
stderr=subprocess.STDOUT)
|
2019-11-14 12:48:24 +00:00
|
|
|
except subprocess.CalledProcessError as e:
|
2022-05-27 08:41:48 +00:00
|
|
|
self.assertIn(
|
|
|
|
'Error: Option "test_5" is deprecated since v2.0 and was removed in v3.0.',
|
|
|
|
e.output.decode('utf-8', 'ignore'))
|
2019-11-14 12:48:24 +00:00
|
|
|
|
|
|
|
def test_deprecation_messages(self):
|
|
|
|
output = subprocess.check_output(
|
|
|
|
[
|
|
|
|
sys.executable,
|
|
|
|
idf_py_path,
|
2021-01-26 02:49:01 +00:00
|
|
|
'-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',
|
2019-11-14 12:48:24 +00:00
|
|
|
],
|
2022-05-27 08:41:48 +00:00
|
|
|
env=os.environ,
|
|
|
|
stderr=subprocess.STDOUT).decode('utf-8', 'ignore')
|
2019-11-14 12:48:24 +00:00
|
|
|
|
|
|
|
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)
|
|
|
|
|
|
|
|
|
2019-08-21 12:24:14 +00:00
|
|
|
if __name__ == '__main__':
|
2022-05-27 08:41:48 +00:00
|
|
|
main()
|