[riot-notifications] [RIOT-OS/RIOT] dist/tools/compile_and_test_for_board: add basic script checks (#10837)

Alexandre Abadie notifications at github.com
Tue Jan 22 09:05:34 CET 2019

The RIOT community cares a lot about code quality.
Therefore, before describing what your contribution is about, we would like
you to make sure that your modifications are compliant with the RIOT
coding conventions, see https://github.com/RIOT-OS/RIOT/wiki/Coding-conventions.

### Contribution description

This PR is adding basic Python checks for the `compile_and_test_for_board.py` script. The checks are run using [Tox](https://tox.readthedocs.io/en/latest/). Performed are:
- doctest (via pytest)
- pylint
- flake8

To avoid issues with pytest automatic parsing, I renamed the `TestError` exception to `ErrorInTest`.

Put here the description of your contribution:
- describe which part(s) of RIOT is (are) involved
- if it's a bug fix, describe the bug that it solves and how it is solved
- you can also give more information to reviewers about how to test your changes

### Testing procedure

- Install tox:

    pip install tox --user

- Use it:

    cd dist/tools/compile_and_test_for_board
    tox compile_and_test_for_board.py

Details steps to test your contribution:
- which test/example to compile for which board and is there a 'test' command
- how to know that it was not working/available in master
- the expected success test output

### Issues/PRs references

Follow-up of #10818 and idea suggested by @cladmi 

Examples: Fixes #1234. See also #5678. Depends on PR #9876.

Please use keywords (e.g., fixes, resolve) with the links to the issues you
resolved, this way they will be automatically closed when your pull request
is merged. See https://help.github.com/articles/closing-issues-using-keywords/.

You can view, comment on, or merge this pull request online at:


-- Commit Summary --

  * tools/compile_test_one_board: rename TestError exception class
  * tools/compile_test_one_board: add tox.ini configuration file
  * tools/compile_test_one_board: update documentation README

-- File Changes --

    A dist/tools/compile_and_test_for_board/.gitignore (2)
    M dist/tools/compile_and_test_for_board/README.md (16)
    M dist/tools/compile_and_test_for_board/compile_and_test_for_board.py (10)
    A dist/tools/compile_and_test_for_board/tox.ini (25)

-- Patch Links --


You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190122/0d0bac68/attachment-0001.html>

More information about the notifications mailing list