graph-api-test 0.1.0

Test utilities and property-based testing for the graph-api ecosystem
Documentation 
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
58
59
60
61
62
63
64
65
66
67

# Graph-API Test Suite

**Welcome to graph-api-test** — your friendly companion for ensuring your graph implementation behaves exactly as expected!

Implementing the Graph-API traits for your custom graph structure? This comprehensive test suite takes the guesswork out of compatibility testing, giving you confidence that your graph behaves correctly.

## Effortless Testing

Testing your graph implementation couldn't be easier:

```rust
#[cfg(test)]
mod test {
    use graph_api_test::test_suite;
    
    // One line to test everything!
    test_suite!(YourGraph::new());
}
```

With this simple macro, you'll validate that your graph implementation properly supports all the operations and behaviors expected by the Graph-API ecosystem. No need to write tedious test cases for each feature!

## Feature-Specific Testing

Implementing only a subset of Graph-API's optional capabilities? No problem! Simply include the features that match your implementation:

```toml
[dev-dependencies]
graph-api-test = { version = "0.1.0", features = [
    "vertex-label-index",
    "edge-label-index",
    "vertex-range-index"
]}
```

## Available Feature Tests

* `vertex-label-index`: Label-based vertex lookups
* `edge-label-index`: Label-based edge traversals
* `vertex-hash-index`: Hash-indexed vertex properties
* `edge-hash-index`: Hash-indexed edge properties
* `vertex-range-index`: Range queries for vertex properties
* `edge-range-index`: Range queries for edge properties
* `vertex-full-text-index`: Full-text search for vertex properties
* `graph-clear`: Graph clearing operations

## Standard Test Graph

Most tests use a consistent, well-defined graph with:

* **Vertices**: People (Bryn, Julia), Projects (GraphApi), and Technologies (Rust)
* **Edges**: Knowledge relationships, creation attribution, and technology connections

This standardized structure ensures that all graph implementations are tested against the same scenarios.

## Writing Custom Tests

Need to test specific aspects of your implementation? The suite provides helpful utilities:

* Ready-to-use test graph population
* Element comparison helpers
* Reference tracking for standard test elements
* Test patterns for different graph features

Make your graph implementation rock-solid with graph-api-test!

Learn more in the [graph-api book](https://bryncooke.github.io/graph-api/).