From facb6809cc3168f297feeadc02171e39fe15428a Mon Sep 17 00:00:00 2001 From: Quinn Date: Fri, 28 Nov 2025 16:47:13 +0000 Subject: [PATCH 1/2] Restructure dev-docs directory to accommodate package integration test docs . --- docs/src/dev-docs/index.md | 2 +- docs/src/dev-docs/testing/index.md | 2 +- .../src/dev-docs/testing/integration-tests.md | 48 ------------------- .../testing/integration-tests/binary.md | 5 ++ .../testing/integration-tests/index.md | 44 +++++++++++++++++ .../testing/integration-tests/package.md | 5 ++ 6 files changed, 56 insertions(+), 50 deletions(-) delete mode 100644 docs/src/dev-docs/testing/integration-tests.md create mode 100644 docs/src/dev-docs/testing/integration-tests/binary.md create mode 100644 docs/src/dev-docs/testing/integration-tests/index.md create mode 100644 docs/src/dev-docs/testing/integration-tests/package.md 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.md b/docs/src/dev-docs/testing/integration-tests.md deleted file mode 100644 index 06ff02bd85..0000000000 --- a/docs/src/dev-docs/testing/integration-tests.md +++ /dev/null @@ -1,48 +0,0 @@ -# Integration tests - -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: - -```shell -task tests:integration -``` - -To test the core CLP binaries: - -```shell -task tests:integration:core -``` - -### Using `pytest` markers - -To run more specific sets of tests, you can use `pytest` directly with `pytest` markers. - -:::{note} -Before running tests using `pytest`, ensure that the CLP package and/or core binaries have been -built. -::: - -Ensure all commands below are run from inside the `integration-tests` directory. - -To list all available markers: - -```shell -uv run pytest --markers -``` - -To run tests related to a specific marker (e.g., `clp_s`): - -```shell -uv run pytest -m clp_s -``` - -### Specifying custom CLP binary paths - -You can override the default binary paths by setting the following environment variables: - -* **`CLP_CORE_BINS_DIR`**: Directory containing the CLP core binaries to test. -* **`CLP_PACKAGE_DIR`**: Directory of the CLP package to test. 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/index.md b/docs/src/dev-docs/testing/integration-tests/index.md new file mode 100644 index 0000000000..dbe5212df6 --- /dev/null +++ b/docs/src/dev-docs/testing/integration-tests/index.md @@ -0,0 +1,44 @@ +# Integration tests + +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: + +```shell +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 +``` + +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). + + +:::{toctree} +:hidden: + +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. +::: From 2c46ca6aec8558c58d745322d01a43c5427f499a Mon Sep 17 00:00:00 2001 From: Quinn Date: Tue, 16 Dec 2025 16:08:19 +0000 Subject: [PATCH 2/2] Restore deleted content. --- .../testing/integration-tests/index.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/src/dev-docs/testing/integration-tests/index.md b/docs/src/dev-docs/testing/integration-tests/index.md index dbe5212df6..97d165b100 100644 --- a/docs/src/dev-docs/testing/integration-tests/index.md +++ b/docs/src/dev-docs/testing/integration-tests/index.md @@ -35,6 +35,30 @@ task tests:integration:core 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. + +:::{note} +Before running tests using `pytest`, ensure that the CLP package and/or core binaries have been +built. +::: + +Ensure all commands below are run from inside the `integration-tests` directory. + +To list all available markers: + +```shell +uv run pytest --markers +``` + +To run tests related to a specific marker (e.g., `clp_s`): + +```shell +uv run pytest -m clp_s +``` :::{toctree} :hidden: