cutest/README at master · viys/cutest · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
CuTest
======

CuTest is a lightweight C unit test framework with a small core and a
repo-local self-test harness.

Repository layout
-----------------

- `src/`
  Portable CuTest package containing the core library and generator tooling.
- `src/memory/`
  Optional memory middleware used when `CUTEST_USE_MEMORY_MIDDLEWARE=1`.
- `src/scripts/`
  Portable tooling for generating an aggregated test entry.
- `test/`
  This repository's self-test project, generator configuration, and generated
  `AllTests.c`.
- `docs/`
  Porting notes and repository-specific workflow documentation.

Minimal porting set
-------------------

For a normal integration, the minimal file set is:

- `src/CuTest.c`
- `src/CuTest.h`

When you enable the optional memory middleware, include these as well:

- `src/memory/CuMemory.c`
- `src/memory/CUMemory.h`

To carry the framework and aggregation generator together, copy the complete
`src/` directory. A downstream project should provide its own generator JSON
configuration; `test/make-tests.json` only describes this repository's tests.
The files under `test/` and `test.ps1` are not required downstream.

Build and test this repository
------------------------------

From the repository root:

    ./test.ps1

Useful variants:

    ./test.ps1 update
    ./test.ps1 cmake
    ./test.ps1 make
    ./test.ps1 run

More documentation
------------------

- Current detailed API notes: `readme.md`