OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/.github/workflows/devicetree_checks.yml

65 lines
1.9 KiB
YAML
Raw Normal View History

scripts: dts: convert test suites to pytest Use the pytest test framework in the dtlib.py and edtlib.py test suites (testdtlib.py and testedtlib.py respectively). The goal here is not to change what is being tested. The existing test suite is excellent and very thorough. However, it is made up of executable scripts where all of the tests are run using a hand-rolled framework in a single function per file. This is a bit all-or-nothing and prevents various nice features available in the de-facto standard pytest test framework from being used. In particular, pytest can: - drop into a debugger (pdb) when there is a problem - accept a pattern which specifies a subset of tests to run - print very detailed error messages about the actual and expected results in various traceback formats from brief to very verbose - gather coverage data for the python scripts being tested (via plugin) - run tests in parallel (via plugin) - It's easy in pytest to run tests with temporary directories using the tmp_path and other fixtures. This us avoid temporarily dirtying the working tree as is done now. Moving to pytest lets us leverage all of these things without any loss in ease of use (in fact, some things are nicer in pytest): - Any function that starts with "test_" is automatically picked up and run. No need for rolling up lists of functions into a test suite. - Tests are written using ordinary Python 'assert' statements. - Pytest magic unpacks the AST of failed asserts to print details on what went wrong in really nice ways. For example, it will show you exactly what parts of two strings that are expected to be equal differ. For the most part, this is a pretty mechanical conversion: - extract helpers and test cases into separate functions - insert temporary paths and adjust tests accordingly to not match file names exactly - use 'assert CONDITION' instead of 'if not CONDITION: fail()' There are a few cases where making this happen required slightly larger changes than that, but they are limited. Move the checks from check_compliance.py to a new GitHub workflow, removing hacks that are no longer needed. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-09-30 08:04:34 +08:00
# Copyright (c) 2020 Linaro Limited.
# Copyright (c) 2020 Nordic Semiconductor ASA
# SPDX-License-Identifier: Apache-2.0
name: Devicetree script tests
on:
push:
paths:
- 'scripts/dts/**'
devicetree_checks.yml: Add itself to path filter So build is run when devicetree_checks.yml is changed. Signed-off-by: Øyvind Rønningstad <oyvind.ronningstad@nordicsemi.no>
2020-12-11 03:36:58 +08:00
- '.github/workflows/devicetree_checks.yml'
scripts: dts: convert test suites to pytest Use the pytest test framework in the dtlib.py and edtlib.py test suites (testdtlib.py and testedtlib.py respectively). The goal here is not to change what is being tested. The existing test suite is excellent and very thorough. However, it is made up of executable scripts where all of the tests are run using a hand-rolled framework in a single function per file. This is a bit all-or-nothing and prevents various nice features available in the de-facto standard pytest test framework from being used. In particular, pytest can: - drop into a debugger (pdb) when there is a problem - accept a pattern which specifies a subset of tests to run - print very detailed error messages about the actual and expected results in various traceback formats from brief to very verbose - gather coverage data for the python scripts being tested (via plugin) - run tests in parallel (via plugin) - It's easy in pytest to run tests with temporary directories using the tmp_path and other fixtures. This us avoid temporarily dirtying the working tree as is done now. Moving to pytest lets us leverage all of these things without any loss in ease of use (in fact, some things are nicer in pytest): - Any function that starts with "test_" is automatically picked up and run. No need for rolling up lists of functions into a test suite. - Tests are written using ordinary Python 'assert' statements. - Pytest magic unpacks the AST of failed asserts to print details on what went wrong in really nice ways. For example, it will show you exactly what parts of two strings that are expected to be equal differ. For the most part, this is a pretty mechanical conversion: - extract helpers and test cases into separate functions - insert temporary paths and adjust tests accordingly to not match file names exactly - use 'assert CONDITION' instead of 'if not CONDITION: fail()' There are a few cases where making this happen required slightly larger changes than that, but they are limited. Move the checks from check_compliance.py to a new GitHub workflow, removing hacks that are no longer needed. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-09-30 08:04:34 +08:00
pull_request:
paths:
- 'scripts/dts/**'
devicetree_checks.yml: Add itself to path filter So build is run when devicetree_checks.yml is changed. Signed-off-by: Øyvind Rønningstad <oyvind.ronningstad@nordicsemi.no>
2020-12-11 03:36:58 +08:00
- '.github/workflows/devicetree_checks.yml'
scripts: dts: convert test suites to pytest Use the pytest test framework in the dtlib.py and edtlib.py test suites (testdtlib.py and testedtlib.py respectively). The goal here is not to change what is being tested. The existing test suite is excellent and very thorough. However, it is made up of executable scripts where all of the tests are run using a hand-rolled framework in a single function per file. This is a bit all-or-nothing and prevents various nice features available in the de-facto standard pytest test framework from being used. In particular, pytest can: - drop into a debugger (pdb) when there is a problem - accept a pattern which specifies a subset of tests to run - print very detailed error messages about the actual and expected results in various traceback formats from brief to very verbose - gather coverage data for the python scripts being tested (via plugin) - run tests in parallel (via plugin) - It's easy in pytest to run tests with temporary directories using the tmp_path and other fixtures. This us avoid temporarily dirtying the working tree as is done now. Moving to pytest lets us leverage all of these things without any loss in ease of use (in fact, some things are nicer in pytest): - Any function that starts with "test_" is automatically picked up and run. No need for rolling up lists of functions into a test suite. - Tests are written using ordinary Python 'assert' statements. - Pytest magic unpacks the AST of failed asserts to print details on what went wrong in really nice ways. For example, it will show you exactly what parts of two strings that are expected to be equal differ. For the most part, this is a pretty mechanical conversion: - extract helpers and test cases into separate functions - insert temporary paths and adjust tests accordingly to not match file names exactly - use 'assert CONDITION' instead of 'if not CONDITION: fail()' There are a few cases where making this happen required slightly larger changes than that, but they are limited. Move the checks from check_compliance.py to a new GitHub workflow, removing hacks that are no longer needed. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-09-30 08:04:34 +08:00
jobs:
actions: use descriptive job names Use descriptive and unique job names, otherwise we end up with those showing up in different location with no way to know which is which. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-12-16 03:01:25 +08:00
devicetree-checks:
name: Devicetree script tests
scripts: dts: convert test suites to pytest Use the pytest test framework in the dtlib.py and edtlib.py test suites (testdtlib.py and testedtlib.py respectively). The goal here is not to change what is being tested. The existing test suite is excellent and very thorough. However, it is made up of executable scripts where all of the tests are run using a hand-rolled framework in a single function per file. This is a bit all-or-nothing and prevents various nice features available in the de-facto standard pytest test framework from being used. In particular, pytest can: - drop into a debugger (pdb) when there is a problem - accept a pattern which specifies a subset of tests to run - print very detailed error messages about the actual and expected results in various traceback formats from brief to very verbose - gather coverage data for the python scripts being tested (via plugin) - run tests in parallel (via plugin) - It's easy in pytest to run tests with temporary directories using the tmp_path and other fixtures. This us avoid temporarily dirtying the working tree as is done now. Moving to pytest lets us leverage all of these things without any loss in ease of use (in fact, some things are nicer in pytest): - Any function that starts with "test_" is automatically picked up and run. No need for rolling up lists of functions into a test suite. - Tests are written using ordinary Python 'assert' statements. - Pytest magic unpacks the AST of failed asserts to print details on what went wrong in really nice ways. For example, it will show you exactly what parts of two strings that are expected to be equal differ. For the most part, this is a pretty mechanical conversion: - extract helpers and test cases into separate functions - insert temporary paths and adjust tests accordingly to not match file names exactly - use 'assert CONDITION' instead of 'if not CONDITION: fail()' There are a few cases where making this happen required slightly larger changes than that, but they are limited. Move the checks from check_compliance.py to a new GitHub workflow, removing hacks that are no longer needed. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-09-30 08:04:34 +08:00
runs-on: ${{ matrix.os }}
strategy:
matrix:
python-version: [3.6, 3.7, 3.8]
scripts: dts: pass tests on windows Doing this just requires a bit of os.fspath()-ery. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-10-02 04:29:28 +08:00
os: [ubuntu-latest, macos-latest, windows-latest]
scripts: dts: convert test suites to pytest Use the pytest test framework in the dtlib.py and edtlib.py test suites (testdtlib.py and testedtlib.py respectively). The goal here is not to change what is being tested. The existing test suite is excellent and very thorough. However, it is made up of executable scripts where all of the tests are run using a hand-rolled framework in a single function per file. This is a bit all-or-nothing and prevents various nice features available in the de-facto standard pytest test framework from being used. In particular, pytest can: - drop into a debugger (pdb) when there is a problem - accept a pattern which specifies a subset of tests to run - print very detailed error messages about the actual and expected results in various traceback formats from brief to very verbose - gather coverage data for the python scripts being tested (via plugin) - run tests in parallel (via plugin) - It's easy in pytest to run tests with temporary directories using the tmp_path and other fixtures. This us avoid temporarily dirtying the working tree as is done now. Moving to pytest lets us leverage all of these things without any loss in ease of use (in fact, some things are nicer in pytest): - Any function that starts with "test_" is automatically picked up and run. No need for rolling up lists of functions into a test suite. - Tests are written using ordinary Python 'assert' statements. - Pytest magic unpacks the AST of failed asserts to print details on what went wrong in really nice ways. For example, it will show you exactly what parts of two strings that are expected to be equal differ. For the most part, this is a pretty mechanical conversion: - extract helpers and test cases into separate functions - insert temporary paths and adjust tests accordingly to not match file names exactly - use 'assert CONDITION' instead of 'if not CONDITION: fail()' There are a few cases where making this happen required slightly larger changes than that, but they are limited. Move the checks from check_compliance.py to a new GitHub workflow, removing hacks that are no longer needed. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-09-30 08:04:34 +08:00
steps:
- name: checkout
uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
with:
python-version: ${{ matrix.python-version }}
- name: cache-pip-linux
if: startsWith(runner.os, 'Linux')
uses: actions/cache@v1
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ matrix.python-version }}
restore-keys: |
${{ runner.os }}-pip-${{ matrix.python-version }}
- name: cache-pip-mac
if: startsWith(runner.os, 'macOS')
uses: actions/cache@v1
with:
path: ~/Library/Caches/pip
# Trailing '-' was just to get a different cache name
key: ${{ runner.os }}-pip-${{ matrix.python-version }}-
restore-keys: |
${{ runner.os }}-pip-${{ matrix.python-version }}-
scripts: dts: pass tests on windows Doing this just requires a bit of os.fspath()-ery. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-10-02 04:29:28 +08:00
- name: cache-pip-win
if: startsWith(runner.os, 'Windows')
uses: actions/cache@v1
with:
path: ~\AppData\Local\pip\Cache
key: ${{ runner.os }}-pip-${{ matrix.python-version }}
restore-keys: |
${{ runner.os }}-pip-${{ matrix.python-version }}
scripts: dts: convert test suites to pytest Use the pytest test framework in the dtlib.py and edtlib.py test suites (testdtlib.py and testedtlib.py respectively). The goal here is not to change what is being tested. The existing test suite is excellent and very thorough. However, it is made up of executable scripts where all of the tests are run using a hand-rolled framework in a single function per file. This is a bit all-or-nothing and prevents various nice features available in the de-facto standard pytest test framework from being used. In particular, pytest can: - drop into a debugger (pdb) when there is a problem - accept a pattern which specifies a subset of tests to run - print very detailed error messages about the actual and expected results in various traceback formats from brief to very verbose - gather coverage data for the python scripts being tested (via plugin) - run tests in parallel (via plugin) - It's easy in pytest to run tests with temporary directories using the tmp_path and other fixtures. This us avoid temporarily dirtying the working tree as is done now. Moving to pytest lets us leverage all of these things without any loss in ease of use (in fact, some things are nicer in pytest): - Any function that starts with "test_" is automatically picked up and run. No need for rolling up lists of functions into a test suite. - Tests are written using ordinary Python 'assert' statements. - Pytest magic unpacks the AST of failed asserts to print details on what went wrong in really nice ways. For example, it will show you exactly what parts of two strings that are expected to be equal differ. For the most part, this is a pretty mechanical conversion: - extract helpers and test cases into separate functions - insert temporary paths and adjust tests accordingly to not match file names exactly - use 'assert CONDITION' instead of 'if not CONDITION: fail()' There are a few cases where making this happen required slightly larger changes than that, but they are limited. Move the checks from check_compliance.py to a new GitHub workflow, removing hacks that are no longer needed. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-09-30 08:04:34 +08:00
- name: install python dependencies
run: |
pip3 install wheel
dts: separate DT libraries from gen_defines.py We are now in the process of extracting edtlib and dtlib into a standalone source code library that we intend to share with other projects. Links related to the work making this standalone: https://pypi.org/project/devicetree/ https://python-devicetree.readthedocs.io/en/latest/ https://github.com/zephyrproject-rtos/python-devicetree This standalone repo includes the same features as what we have in Zephyr, but in its own 'devicetree' python package with PyPI integration, etc. To avoid making this a hard fork, move the code that's being made standalone around in Zephyr into a new scripts/dts/python-devicetree subdirectory, and handle the package and sys.path changes in the various places in the tree that use it. From now on, it will be possible to update the standalone repository by just recursively copying scripts/dts/python-devicetree's contents into it and committing the results. This is an interim step; do NOT 'pip install devicetree' yet. The code in the zephyr repository is still the canonical location. (In the long term, people will get the devicetree package from PyPI just like they do the 'yaml' package today, but that won't happen for the foreseeable future.) This commit is purely intended to avoid a hard fork for the standalone code, and no functional changes besides the package structure and location of the code itself are expected. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-03-27 07:18:58 +08:00
pip3 install pytest pyyaml tox
- name: run tox
working-directory: scripts/dts/python-devicetree
scripts: dts: convert test suites to pytest Use the pytest test framework in the dtlib.py and edtlib.py test suites (testdtlib.py and testedtlib.py respectively). The goal here is not to change what is being tested. The existing test suite is excellent and very thorough. However, it is made up of executable scripts where all of the tests are run using a hand-rolled framework in a single function per file. This is a bit all-or-nothing and prevents various nice features available in the de-facto standard pytest test framework from being used. In particular, pytest can: - drop into a debugger (pdb) when there is a problem - accept a pattern which specifies a subset of tests to run - print very detailed error messages about the actual and expected results in various traceback formats from brief to very verbose - gather coverage data for the python scripts being tested (via plugin) - run tests in parallel (via plugin) - It's easy in pytest to run tests with temporary directories using the tmp_path and other fixtures. This us avoid temporarily dirtying the working tree as is done now. Moving to pytest lets us leverage all of these things without any loss in ease of use (in fact, some things are nicer in pytest): - Any function that starts with "test_" is automatically picked up and run. No need for rolling up lists of functions into a test suite. - Tests are written using ordinary Python 'assert' statements. - Pytest magic unpacks the AST of failed asserts to print details on what went wrong in really nice ways. For example, it will show you exactly what parts of two strings that are expected to be equal differ. For the most part, this is a pretty mechanical conversion: - extract helpers and test cases into separate functions - insert temporary paths and adjust tests accordingly to not match file names exactly - use 'assert CONDITION' instead of 'if not CONDITION: fail()' There are a few cases where making this happen required slightly larger changes than that, but they are limited. Move the checks from check_compliance.py to a new GitHub workflow, removing hacks that are no longer needed. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-09-30 08:04:34 +08:00
run: |
dts: separate DT libraries from gen_defines.py We are now in the process of extracting edtlib and dtlib into a standalone source code library that we intend to share with other projects. Links related to the work making this standalone: https://pypi.org/project/devicetree/ https://python-devicetree.readthedocs.io/en/latest/ https://github.com/zephyrproject-rtos/python-devicetree This standalone repo includes the same features as what we have in Zephyr, but in its own 'devicetree' python package with PyPI integration, etc. To avoid making this a hard fork, move the code that's being made standalone around in Zephyr into a new scripts/dts/python-devicetree subdirectory, and handle the package and sys.path changes in the various places in the tree that use it. From now on, it will be possible to update the standalone repository by just recursively copying scripts/dts/python-devicetree's contents into it and committing the results. This is an interim step; do NOT 'pip install devicetree' yet. The code in the zephyr repository is still the canonical location. (In the long term, people will get the devicetree package from PyPI just like they do the 'yaml' package today, but that won't happen for the foreseeable future.) This commit is purely intended to avoid a hard fork for the standalone code, and no functional changes besides the package structure and location of the code itself are expected. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-03-27 07:18:58 +08:00
tox