diff --git a/docs/src/dev-docs/index.md b/docs/src/dev-docs/index.md index c9146763b1..8d9f26d28a 100644 --- a/docs/src/dev-docs/index.md +++ b/docs/src/dev-docs/index.md @@ -63,7 +63,7 @@ building-package testing/index testing/unit-tests -testing/integration-tests +testing/integration-tests/index ::: :::{toctree} diff --git a/docs/src/dev-docs/testing/index.md b/docs/src/dev-docs/testing/index.md index 0fd9e03f82..6436a7d9e7 100644 --- a/docs/src/dev-docs/testing/index.md +++ b/docs/src/dev-docs/testing/index.md @@ -11,7 +11,7 @@ Docs about running unit tests for each component. ::: :::{grid-item-card} -:link: integration-tests +:link: integration-tests/index Integration tests ^^^ Docs about running CLP's integration tests. diff --git a/docs/src/dev-docs/testing/integration-tests/binary.md b/docs/src/dev-docs/testing/integration-tests/binary.md new file mode 100644 index 0000000000..9462427fc1 --- /dev/null +++ b/docs/src/dev-docs/testing/integration-tests/binary.md @@ -0,0 +1,5 @@ +# Testing the CLP binaries + +:::{warning} +🚧 This section is under construction. +::: diff --git a/docs/src/dev-docs/testing/integration-tests.md b/docs/src/dev-docs/testing/integration-tests/index.md similarity index 59% rename from docs/src/dev-docs/testing/integration-tests.md rename to docs/src/dev-docs/testing/integration-tests/index.md index 06ff02bd85..97d165b100 100644 --- a/docs/src/dev-docs/testing/integration-tests.md +++ b/docs/src/dev-docs/testing/integration-tests/index.md @@ -3,6 +3,8 @@ The `integration-tests` directory contains a Python project that provides end-to-end tests for CLP via the `pytest` framework. +--- + ## Running tests To run all integration tests: @@ -11,13 +13,31 @@ To run all integration tests: task tests:integration ``` +### Testing the CLP package + +To test the CLP package: + +```shell +task tests:integration:package +``` + +This command will build the package from your local code as well. For the complete package testing +guide, visit [Testing the CLP package](./package.md). + +### Testing the CLP binaries + To test the core CLP binaries: ```shell task tests:integration:core ``` -### Using `pytest` markers +This command will build the binaries from your local code as well. For the complete binary testing +guide, visit [Testing the CLP binaries](./binary.md). + +--- + +## Using `pytest` markers To run more specific sets of tests, you can use `pytest` directly with `pytest` markers. @@ -40,9 +60,9 @@ To run tests related to a specific marker (e.g., `clp_s`): uv run pytest -m clp_s ``` -### Specifying custom CLP binary paths - -You can override the default binary paths by setting the following environment variables: +:::{toctree} +:hidden: -* **`CLP_CORE_BINS_DIR`**: Directory containing the CLP core binaries to test. -* **`CLP_PACKAGE_DIR`**: Directory of the CLP package to test. +package +binary +::: diff --git a/docs/src/dev-docs/testing/integration-tests/package.md b/docs/src/dev-docs/testing/integration-tests/package.md new file mode 100644 index 0000000000..49d9c8f82f --- /dev/null +++ b/docs/src/dev-docs/testing/integration-tests/package.md @@ -0,0 +1,5 @@ +# Testing the CLP package + +:::{warning} +🚧 This section is under construction. +:::