Skip to content
2 changes: 1 addition & 1 deletion docs/src/dev-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ building-package

testing/index
testing/unit-tests
testing/integration-tests
testing/integration-tests/index
:::

:::{toctree}
Expand Down
2 changes: 1 addition & 1 deletion docs/src/dev-docs/testing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 5 additions & 0 deletions docs/src/dev-docs/testing/integration-tests/binary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Testing the CLP binaries

:::{warning}
🚧 This section is under construction.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.

Expand All @@ -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
:::
5 changes: 5 additions & 0 deletions docs/src/dev-docs/testing/integration-tests/package.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Testing the CLP package

:::{warning}
🚧 This section is under construction.
:::
Loading