From b614e7a46df70053419ba435855a7ca9c2607b33 Mon Sep 17 00:00:00 2001 From: Piotr Korkus Date: Mon, 26 Jan 2026 12:50:53 +0100 Subject: [PATCH] tests: separate UT and CIT/FIT --- README.md | 20 +++++++++++++++++--- docs/index.rst | 18 +++++++++++++++--- 2 files changed, 32 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1e8af75..7a5073b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository serves as a **template** for setting up **C++ and Rust projects* It provides a **standardized project structure**, ensuring best practices for: - **Build configuration** with Bazel. -- **Testing** (unit and integration tests). +- **Testing** (Component and Feature Integration Tests). - **Documentation** setup. - **CI/CD workflows**. - **Development environment** configuration. @@ -17,8 +17,8 @@ It provides a **standardized project structure**, ensuring best practices for: | File/Folder | Description | | ----------------------------------- | ------------------------------------------------- | | `README.md` | Short description & build instructions | -| `src/` | Source files for the module | -| `tests/` | Unit tests (UT) and integration tests (IT) | +| `src/` | Source files and Unit Tests for the module | +| `tests/` | Component and Feature Integration Tests (CIT&FIT) | | `examples/` | Example files used for guidance | | `docs/` | Documentation (Doxygen for C++ / mdBook for Rust) | | `.github/workflows/` | CI/CD pipelines | @@ -66,6 +66,20 @@ artifacts of the module. ### 3️⃣ Run Tests +All tests: + +```sh +bazel test //... +``` + +Unit tests: + +```sh +bazel test //src/... +``` + +Component / Feature integration tests: + ```sh bazel test //tests/... ``` diff --git a/docs/index.rst b/docs/index.rst index f8e53da..45bdd76 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,8 +44,8 @@ Project Layout The module template includes the following top-level structure: -- `src/`: Main C++/Rust sources -- `tests/`: Unit and integration tests +- `src/`: Main C++/Rust sources with Unit Tests +- `tests/`: Component and Feature Integration Tests - `examples/`: Usage examples - `docs/`: Documentation using `docs-as-code` - `.github/workflows/`: CI/CD pipelines @@ -59,7 +59,19 @@ To build the module: bazel build //src/... -To run tests: +To run all tests: + +.. code-block:: bash + + bazel test //... + +To run Unit Tests: + +.. code-block:: bash + + bazel test //src/... + +To run Component / Feature Integration Tests: .. code-block:: bash