esp-idf/tools/test_build_system/test_common.py

74 lines
2.7 KiB
Python

# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: Apache-2.0
import shutil
import subprocess
from pathlib import Path
import pytest
from _pytest.monkeypatch import MonkeyPatch
from test_build_system_helpers import IdfPyFunc, get_snapshot, replace_in_file
@pytest.mark.usefixtures('test_app_copy')
@pytest.mark.test_app_copy('examples/get-started/blink')
def test_compile_commands_json_updated_by_reconfigure(idf_py: IdfPyFunc) -> None:
output = idf_py('reconfigure')
assert 'Building ESP-IDF components for target esp32' in output.stdout
snapshot_1 = get_snapshot(['build/compile_commands.json'])
snapshot_2 = get_snapshot(['build/compile_commands.json'])
snapshot_2.assert_same(snapshot_1)
idf_py('reconfigure')
snapshot_3 = get_snapshot(['build/compile_commands.json'])
snapshot_3.assert_different(snapshot_2)
@pytest.mark.usefixtures('test_app_copy')
def test_of_test_app_copy(idf_py: IdfPyFunc) -> None:
p = Path('main/idf_component.yml')
p.write_text('syntax_error\n')
try:
with (pytest.raises(subprocess.CalledProcessError)) as exc_info:
idf_py('reconfigure')
assert 'ERROR: Unknown format of the manifest file:' in exc_info.value.stderr
finally:
p.unlink()
@pytest.mark.usefixtures('test_app_copy')
def test_hints_no_color_output_when_noninteractive(idf_py: IdfPyFunc) -> None:
"""Check that idf.py hints don't include color escape codes in non-interactive builds"""
# make the build fail in such a way that idf.py shows a hint
replace_in_file('main/build_test_app.c', '// placeholder_inside_main',
'esp_chip_info_t chip_info; esp_chip_info(&chip_info);')
with (pytest.raises(subprocess.CalledProcessError)) as exc_info:
idf_py('build')
# Should not actually include a color escape sequence!
# Change the assert to the correct value once the bug is fixed.
assert '\x1b[0;33mHINT: esp_chip_info.h' in exc_info.value.stderr
@pytest.mark.usefixtures('test_app_copy')
def test_idf_copy(idf_copy: Path, idf_py: IdfPyFunc) -> None:
# idf_copy is the temporary IDF copy.
# For example, we can check if idf.py build can work without the .git directory:
shutil.rmtree(idf_copy / '.git', ignore_errors=True)
idf_py('build')
def test_idf_build_with_env_var_sdkconfig_defaults(
test_app_copy: Path,
idf_py: IdfPyFunc,
monkeypatch: MonkeyPatch,
) -> None:
with open(test_app_copy / 'sdkconfig.test', 'w') as fw:
fw.write('CONFIG_BT_ENABLED=y')
monkeypatch.setenv('SDKCONFIG_DEFAULTS', 'sdkconfig.test')
idf_py('build')
with open(test_app_copy / 'sdkconfig') as fr:
assert 'CONFIG_BT_ENABLED=y' in fr.read()