Skip to content

README.md

Latest commit

 

History

History
83 lines (58 loc) · 3.04 KB

README.md

File metadata and controls

83 lines (58 loc) · 3.04 KB

GraphWalker

GraphWalker is a model-based testing tool. It reads models in the shape of directed graphs and generates test paths from them. Tests are modeled as graphs where vertices represent states and edges represent transitions between states. GraphWalker traverses these graphs using configurable path generators and stop conditions, producing sequences of steps that can drive automated test execution.

GraphWalker supports guards (boolean conditions on edges), actions (scripts that run on traversal), requirements tracking, weighted edges, shared states across multiple models, and several path generation algorithms ranging from pure random walks to optimal Chinese Postman routes.

Prerequisites

  • Rust (1.70 or later) — install via rustup
  • Git
  • Node.js and npm (only needed if building the Studio frontend from source)

Nix / NixOS Developer Environment

If you have the Nix package manager installed, you don't need to manually install Rust or Node.js. A fully configured developer environment is provided via flakes.

Simply run:

nix develop

This automatically boots a shell with rustc, cargo, rustfmt, clippy, rust-analyzer, nodejs, and all required libraries configured.

If you use direnv, you can automate this by running:

echo "use flake" > .envrc && direnv allow

Building

# Clone the repository
git clone https://github.com/GraphWalker/graphwalker-rs.git
cd graphwalker-rs

# Build all crates (debug)
cargo build

# Build optimized release binaries
cargo build --release

# Run tests
cargo test

The main binaries are:

Binary Location Description
graphwalker target/release/graphwalker CLI tool for offline/online test generation
graphwalker-studio target/release/graphwalker-studio Web-based visual model editor and test runner

Quick start

# Check a model for issues
graphwalker check -g model.json

# Generate a test path offline
graphwalker offline -m model.json "random(edge_coverage(100))"

# Start a REST API server
graphwalker online -s RESTFUL -p 8080 -m model.json "random(edge_coverage(100))"

# Start the visual Studio
graphwalker-studio

Documentation

Full documentation is available at graphwalker.github.io/graphwalker-rs.

License

MIT