From dca046509508a4f254e08cb961215e94ea0145e6 Mon Sep 17 00:00:00 2001 From: Fu Hanxi Date: Tue, 10 Sep 2024 10:13:57 +0200 Subject: [PATCH] feat: split pytest requirements to base and test-specific --- .gitlab/ci/common.yml | 6 +++--- .../contribute/esp-idf-tests-with-pytest.rst | 8 +++++++- .../contribute/esp-idf-tests-with-pytest.rst | 8 +++++++- tools/ci/check_requirement_files.py | 3 +-- tools/requirements.json | 6 ++++++ tools/requirements/requirements.pytest.txt | 18 ----------------- .../requirements.test-specific.txt | 20 +++++++++++++++++++ 7 files changed, 44 insertions(+), 25 deletions(-) create mode 100644 tools/requirements/requirements.test-specific.txt diff --git a/.gitlab/ci/common.yml b/.gitlab/ci/common.yml index 5f80c6ba26..298631b912 100644 --- a/.gitlab/ci/common.yml +++ b/.gitlab/ci/common.yml @@ -147,16 +147,16 @@ variables: # install latest python packages # target test jobs if [[ "${CI_JOB_STAGE}" == "target_test" ]]; then - run_cmd bash install.sh --enable-ci --enable-pytest + run_cmd bash install.sh --enable-ci --enable-pytest --enable-test-specific elif [[ "${CI_JOB_STAGE}" == "build_doc" ]]; then run_cmd bash install.sh --enable-ci --enable-docs elif [[ "${CI_JOB_STAGE}" == "build" ]]; then - run_cmd bash install.sh --enable-ci --enable-pytest + run_cmd bash install.sh --enable-ci else if ! echo "${CI_JOB_NAME}" | egrep ".*pytest.*"; then run_cmd bash install.sh --enable-ci else - run_cmd bash install.sh --enable-ci --enable-pytest + run_cmd bash install.sh --enable-ci --enable-pytest --enable-test-specific fi fi diff --git a/docs/en/contribute/esp-idf-tests-with-pytest.rst b/docs/en/contribute/esp-idf-tests-with-pytest.rst index a27137ec3a..424bf4218e 100644 --- a/docs/en/contribute/esp-idf-tests-with-pytest.rst +++ b/docs/en/contribute/esp-idf-tests-with-pytest.rst @@ -33,12 +33,18 @@ On the host side, ESP-IDF employs the pytest framework (alongside certain pytest Installation ============ -All dependencies could be installed by running the ESP-IDF install script with the ``--enable-pytest`` argument: +All basic dependencies could be installed by running the ESP-IDF install script with the ``--enable-pytest`` argument: .. code-block:: bash $ install.sh --enable-pytest +Additional test script specific dependencies could be installed separately by running the ESP-IDF install script with the ``--enable-pytest-specific`` argument: + +.. code-block:: bash + + $ install.sh --enable-test-specific + Several mechanisms have been implemented to ensure the successful execution of the installation processes. If you encounter any issues during installation, please submit an issue report to our `GitHub issue tracker `__. Common Concepts diff --git a/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst b/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst index 99f3d9b6b7..db6ffa1df9 100644 --- a/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst +++ b/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst @@ -33,12 +33,18 @@ ESP-IDF 在主机端使用 pytest 框架（以及一些 pytest 插件）来自 安装 ============ -所有依赖项都可以通过执行 ESP-IDF 安装脚本 ``--enable-pytest`` 进行安装： +基础依赖项可以通过执行 ESP-IDF 安装脚本 ``--enable-pytest`` 进行安装： .. code-block:: bash $ install.sh --enable-pytest +额外的测试脚本依赖项可以通过执行 ESP-IDF 安装脚本 ``--enable-pytest-specific`` 进行安装： + +.. code-block:: bash + + $ install.sh --enable-test-specific + 上面的脚本已预先实现了一些机制，以确保所有安装过程顺利进行。如果您在安装过程中遇到任何问题，请在 `GitHub Issue 版块 `__ 上提交问题说明。 常见概念 diff --git a/tools/ci/check_requirement_files.py b/tools/ci/check_requirement_files.py index b91790801e..85e0571ce7 100755 --- a/tools/ci/check_requirement_files.py +++ b/tools/ci/check_requirement_files.py @@ -1,7 +1,6 @@ #!/usr/bin/env python # SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Apache-2.0 - import json import os import re @@ -13,7 +12,7 @@ from idf_ci_utils import IDF_PATH JSON_PATH = os.path.join(IDF_PATH, 'tools', 'requirements.json') SCHEMA_PATH = os.path.join(IDF_PATH, 'tools', 'requirements_schema.json') REQ_DIR = os.path.join(IDF_PATH, 'tools', 'requirements') -RE_FEATURE = re.compile(r'requirements\.(\w+)\.txt') +RE_FEATURE = re.compile(r'requirements\.([\w-]+)\.txt') def action_validate(req_obj: Any) -> None: # "Any" because we are checking this in this script diff --git a/tools/requirements.json b/tools/requirements.json index ac5ced813a..c31f895335 100644 --- a/tools/requirements.json +++ b/tools/requirements.json @@ -19,6 +19,12 @@ "optional": true, "requirement_path": "tools/requirements/requirements.pytest.txt" }, + { + "name": "test-specific", + "description": "Packages for specific test scripts", + "optional": true, + "requirement_path": "tools/requirements/requirements.test-specific.txt" + }, { "name": "ci", "description": "Packages for ESP-IDF CI scripts", diff --git a/tools/requirements/requirements.pytest.txt b/tools/requirements/requirements.pytest.txt index 277a8a09de..d94ee14ddb 100644 --- a/tools/requirements/requirements.pytest.txt +++ b/tools/requirements/requirements.pytest.txt @@ -15,21 +15,3 @@ minio # build python-gitlab idf-build-apps - -# dependencies in pytest test scripts -scapy -websocket-client -netifaces -rangehttpserver -dbus-python; sys_platform == 'linux' -protobuf -bleak -paho-mqtt -paramiko -netmiko - -# iperf_test_util -pyecharts - -# for twai tests, communicate with socket can device (e.g. Canable) -python-can diff --git a/tools/requirements/requirements.test-specific.txt b/tools/requirements/requirements.test-specific.txt new file mode 100644 index 0000000000..5f8745716a --- /dev/null +++ b/tools/requirements/requirements.test-specific.txt @@ -0,0 +1,20 @@ +# Python package requirements for specific test scripts in ESP-IDF. +# This feature can be enabled by running "install.{sh,bat,ps1,fish} --enable-test-specific" + +# dependencies in pytest test scripts +scapy +websocket-client +netifaces +rangehttpserver +dbus-python; sys_platform == 'linux' +protobuf +bleak +paho-mqtt +paramiko +netmiko + +# iperf_test_util +pyecharts + +# for twai tests, communicate with socket can device (e.g. Canable) +python-can