mirror of
https://github.com/basnijholt/adaptive-lighting.git
synced 2026-09-11 22:34:04 +02:00
6283158ff7* build: dev container
Add a VS Code Dev Container from the blueprint at bceaae212f
* build: dev container test setup
Add support for unit testing in the dev container environment with debugging and code coverage.
* ci: adjust to dev container test restructuring
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* ci: fix coverage collection
* build: add dummy light to HA config
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* build: update dev container to Python 3.11 (for HA 2023.6)
* Add VS Code tasks
* Use pre-commit hooks for linting
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Unpin HA version
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Bas Nijholt <basnijholt@gmail.com>
36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
# Developer notes for the tests directory
|
|
|
|
To run the tests, check out the [CI configuration](../.github/workflows/pytest.yml) to see how they are executed in the CI pipeline.
|
|
Alternatively, you can use the provided Docker image to run the tests locally or run them with VS Code directly in the dev container.
|
|
|
|
To run the tests using the Docker image, navigate to the `adaptive-lighting` repo folder and execute the following command:
|
|
|
|
Linux / MacOS / Windows PowerShell:
|
|
```bash
|
|
docker run -v ${PWD}:/app basnijholt/adaptive-lighting:latest
|
|
```
|
|
|
|
- In windows command prompt, the command is:
|
|
```bash
|
|
docker run -v %cd%:/app basnijholt/adaptive-lighting:latest
|
|
```
|
|
|
|
This command will download the Docker image from [the adaptive-lighting Docker Hub repo](https://hub.docker.com/r/basnijholt/adaptive-lighting) and run the tests.
|
|
|
|
If you prefer to build the image yourself, use the following command:
|
|
|
|
```bash
|
|
docker build -t basnijholt/adaptive-lighting:latest --no-cache .
|
|
```
|
|
|
|
This might be necessary if the image on Docker Hub is outdated or if the [`test_dependencies.py`](../test_dependencies.py) file is updated.
|
|
|
|
## Passing arguments to pytest
|
|
|
|
You can pass arguments to pytest by appending them to the command:
|
|
|
|
For example, to run the tests with a custom log format, use the following command (this also gets rid of the captured stderr output):
|
|
|
|
```bash
|
|
docker run -v $(pwd):/app basnijholt/adaptive-lighting:latest --show-capture=log --log-format="%(asctime)s %(levelname)-8s %(name)s:%(filename)s:%(lineno)s %(message)s" --log-date-format="%H:%M:%S" tests/components/adaptive_lighting/
|
|
```
|