ITADN
ararog/caramelo
README.md

caramelo

Crates.io downloads crates.io Build Status Crates.io MSRV Documentation MIT licensed codecov

Caramelo (caramel in Portuguese, named after popular brazilian dog) is a comprehensive, production-ready unit testing framework for Rust with a focus on simplicity and ease of use.

Features

Several useful matchers:

  • relational: eq, ne, le, lt, ge and gt
  • logical: and, or
  • range: 1..2 or 1.. or ..2 and its variants
  • array: item, len, _in_
  • wildcard: any
  • string: contains, starts-with, ends-with
  • http: method, path, header, header_value, body
  • json: exact_json_body, partial_json_body
  • xml: exact_xml_body, partial_xml_body
  • others: custom

Quick Start

Add caramelo to your Cargo.toml:

caramelo = { version = "0.1.0" }

Usage Example

Here's how simple it is to create unit tests with caramelo:

use caramelo::{expect, matchers::eq, assertions::Is};

/// Test equality matcher

#[test]
fn test_equal() {
    expect(1).to_be(eq(1));
}

#[test]
#[should_panic(expected = "Expected 1 to be equals to 2")]
fn test_not_equal() {
    expect(1).to_be(eq(2));
}

Subprojects

caramelo

Base crate for caramelo.

caramelo-macros

A crate with collection of convenience macros for caramelo.

License

Licensed under either of

at your option.

Author

Rogerio Pereira Araujo rogerio.araujo@gmail.com