Skip to content

Commit 79cf832

Browse files
committed
test: establish docs-mirrored directory structure for integration tests
Creates database/, resources/, and mqtt/ directories under integrationTests/ as placeholder structure ahead of merging #1207#1211. Updates the top-level integrationTests/README.md with a directory map mirroring the Harper v5 docs and pointing new tests away from the legacy apiTests/ bucket (see #1215).
1 parent 81efaaf commit 79cf832

4 files changed

Lines changed: 38 additions & 0 deletions

File tree

integrationTests/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# Harper Integration Tests
22

3+
## Directory Structure
4+
5+
Directory structure mirrors the [Harper v5 reference docs](https://docs.harperdb.io/reference/v5):
6+
7+
| Directory | Coverage |
8+
|---|---|
9+
| `database/` | Schema types, TTL, blob, scale |
10+
| `resources/` | Custom resources, REST API patterns |
11+
| `mqtt/` | MQTT broker, JWT auth, ACL, topic patterns |
12+
| `server/` | Caching (sourcedFrom, SWR), thread management, crash recovery |
13+
| `components/` | Component deployment, lifecycle, fixtures |
14+
| `security/` | TLS, certificates, auth |
15+
| `operations-api/` | Operations API, CLI commands |
16+
| `upgrade/` | v4→v5 upgrade / migration tests |
17+
| `apiTests/` | Legacy bucket — being migrated to the above (see #1215) |
18+
19+
New tests should go in the appropriate subdirectory, not `apiTests/`.
20+
21+
---
22+
323
This directory contains the integration tests for Harper. They run against the built Harper distribution using the [`@harperfast/integration-testing`](https://github.com/HarperFast/integration-testing-framework) framework and the included Node.js test runner script.
424

525
For full background on the testing philosophy, framework APIs, and runner configuration, see the **[`@harperfast/integration-testing` documentation](https://github.com/HarperFast/integration-testing-framework#readme)**. This document covers what is specific to running and writing tests in this repository.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# database/
2+
Integration tests for Harper database features: schema types, TTL/expiration, blob storage, and large-scale data patterns.
3+
4+
Incoming: `ttl.test.ts` from HarperFast/harper#1210.
5+
6+
See also: `unitTests/resources/` for unit-level coverage of the same features.

integrationTests/mqtt/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# mqtt/
2+
Integration tests for the MQTT broker: JWT auth, ACL enforcement, and topic patterns.
3+
4+
Incoming: `mqtt.test.ts` from HarperFast/harper#1211.
5+
6+
See also: `unitTests/` for unit-level coverage of the same features.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# resources/
2+
Integration tests for custom resources, REST API patterns, and routing.
3+
4+
Incoming: `custom-resources.test.ts` from HarperFast/harper#1209.
5+
6+
See also: `unitTests/resources/` for unit-level coverage of the same features.

0 commit comments

Comments
 (0)