https://github.com/veeso/pocket-ic-harness

A test harness for Internet Computer canisters using PocketIC.
https://github.com/veeso/pocket-ic-harness

dfinity ic internet-computer pocket-ic

Last synced: 4 days ago
JSON representation

A test harness for Internet Computer canisters using PocketIC.

• Host: GitHub
• URL: https://github.com/veeso/pocket-ic-harness
• Owner: veeso
• License: mit
• Created: 2026-03-31T19:07:07.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2026-03-31T20:16:03.000Z (2 months ago)
• Last Synced: 2026-03-31T20:33:25.009Z (2 months ago)
• Topics: dfinity, ic, internet-computer, pocket-ic
• Language: Rust
• Homepage:
• Size: 0 Bytes
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# pocket-ic-harness

[![license-mit](https://img.shields.io/crates/l/pocket-ic-harness.svg?logo=rust)](https://opensource.org/licenses/MIT)

[![repo-stars](https://img.shields.io/github/stars/veeso/pocket-ic-harness?style=flat)](https://github.com/veeso/pocket-ic-harness/stargazers)

[![downloads](https://img.shields.io/crates/d/pocket-ic-harness.svg?logo=rust)](https://crates.io/crates/pocket-ic-harness)

[![latest-version](https://img.shields.io/crates/v/pocket-ic-harness.svg?logo=rust)](https://crates.io/crates/pocket-ic-harness)

[![conventional-commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

[![ci](https://github.com/veeso/pocket-ic-harness/actions/workflows/ci.yml/badge.svg)](https://github.com/veeso/pocket-ic-harness/actions)

[![docs](https://docs.rs/pocket-ic-harness/badge.svg?logo=rust)](https://docs.rs/pocket-ic-harness)

A test harness for Internet Computer canisters using PocketIC.

## Overview

pocket-ic-harness provides reusable utilities for integration testing IC canisters

with PocketIC:

- **`Canister` trait** - define your canisters and their WASM paths

- **`CanisterSetup` trait** - define how canisters are installed before each test

- **`PocketIcTestEnv`** - generic test environment with canister installation and registry

- **`PocketIcClient`** - typed query/update calls with Candid encoding

- **`init_new_agent()`** - create IC agents against PocketIC endpoints

- **`#[pocket_ic_harness::test]`** - proc-macro for automatic setup/teardown

## Quick Start

Define your canisters and setup:

```rust

use std::path::Path;

use candid::Encode;

use pocket_ic_harness::{Canister, CanisterSetup, PocketIcTestEnv};

#[derive(Debug, Clone, Hash, PartialEq, Eq)]

enum MyCanister {

    Backend,

}

impl Canister for MyCanister {

    fn as_path(&self) -> &Path {

        match self {

            MyCanister::Backend => Path::new("path/to/backend.wasm.gz"),

        }

    }

}

struct MySetup;

impl CanisterSetup for MySetup {

    type Canister = MyCanister;

    async fn setup(env: &mut PocketIcTestEnv) {

        let init_arg = Encode!(&()).unwrap();

        env.install_canister(MyCanister::Backend, init_arg).await;

    }

}

```

Write tests with the proc-macro — canisters are already installed:

```rust

#[pocket_ic_harness::test]

async fn test_my_canister(ctx: PocketIcTestEnv) {

    let canister_id = ctx.canister_id(&MyCanister::Backend);

    // test your canister...

}

```

## Get Started

Add to your `Cargo.toml`:

```toml

[dev-dependencies]

pocket-ic-harness = "0.1"

```

## License

Licensed under the MIT license. See [LICENSE](LICENSE) for details.