jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-08 09:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add tests requirements installation information (#1865)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Bruno Enten 2024-06-08 10:59:35 +02:00 committed by GitHub
parent 16edbcf8c4
commit 62fb1e29a7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/development_testing.md
View File

@ -2,13 +2,15 @@
title: "Testing your code" title: "Testing your code"
--- ---
As it states in the [Style guidelines section](development_guidelines.md) all code is checked to verify the following: As stated in the [Style guidelines section](development_guidelines.md) all code is checked to verify the following:
- All the unit tests pass - All the unit tests pass
- All code passes the checks from the linting tools - All code passes the checks from the linting tools
Local testing is done using [pytest](https://docs.pytest.org/) and using [pre-commit](https://pre-commit.com/) for running out linters, which has been installed as part of running `script/setup` in the [virtual environment](development_environment.mdx). Local testing is done using [pytest](https://docs.pytest.org/) and using [pre-commit](https://pre-commit.com/) for running out linters, which has been installed as part of running `script/setup` in the [virtual environment](development_environment.mdx).
Python test requirements need to be installed before tests can be run. This can be achieved by using the VScode devcontainer and the corresponding task. Check the [devcontainer documentation](/docs/development_environment#tasks) for guidance about running tasks.
To run our linters, on the full code base, run the following command: To run our linters, on the full code base, run the following command:
```shell ```shell