|
| 1 | +iloveimg-python/tests/README.md |
| 2 | +``` |
| 3 | +# Tests Overview |
| 4 | +
|
| 5 | +This directory contains all test code for the **iLoveIMG Python** library. Tests are organized to ensure code quality, reliability, and correct integration with the iLoveIMG API. |
| 6 | +
|
| 7 | +## Structure |
| 8 | +
|
| 9 | +- `unit/` |
| 10 | + Contains unit tests for individual modules and classes. |
| 11 | + See [`unit/README.md`](unit/README.md) for details. |
| 12 | +
|
| 13 | +- `integration/` |
| 14 | + Contains integration tests that interact with the iLoveIMG API and test complete workflows. |
| 15 | + See [`integration/README.md`](integration/README.md) for details. |
| 16 | +
|
| 17 | +## Running Tests |
| 18 | +
|
| 19 | +You can run tests using [pytest](https://docs.pytest.org/): |
| 20 | +
|
| 21 | +```bash |
| 22 | +pytest tests/unit |
| 23 | +pytest tests/integration |
| 24 | +``` |
| 25 | + |
| 26 | +Or run all tests at once: |
| 27 | + |
| 28 | +```bash |
| 29 | +pytest tests |
| 30 | +``` |
| 31 | + |
| 32 | +For integration tests, ensure you have set up the required environment variables as described in [`.docker/README.md`](../.docker/README.md). |
| 33 | + |
| 34 | +### Using Docker |
| 35 | + |
| 36 | +To run tests in an isolated environment with multiple Python versions, use Docker Compose: |
| 37 | + |
| 38 | +```bash |
| 39 | +docker-compose -f .docker/docker-compose.yml run python39 |
| 40 | +docker-compose -f .docker/docker-compose.yml run python310 |
| 41 | +``` |
| 42 | + |
| 43 | +See [`.docker/README.md`](../.docker/README.md) for full instructions. |
| 44 | + |
| 45 | +## Coverage |
| 46 | + |
| 47 | +- **Unit tests** cover all core modules and public interfaces. |
| 48 | +- **Integration tests** cover end-to-end scenarios and API interactions. |
| 49 | + |
| 50 | +Each new core module or task must include: |
| 51 | +- At least one unit test in `unit/` |
| 52 | +- At least one integration test in `integration/` |
| 53 | + |
| 54 | +For more information, refer to the README files in each subfolder. |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## Related Documentation |
| 59 | + |
| 60 | +- [Project Overview](../README.md) |
| 61 | +- [Core Library](../iloveimg/README.md) |
| 62 | +- [Samples and Usage](../samples/README.md) |
| 63 | +- [Docker and Environment Setup](../.docker/README.md) |
0 commit comments