:leaves: Mint is a minimal header-only C++ test runner.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Luiserebii eb0ea79f6f
Updating README.md
3 days ago
.circleci Adding new structuring tests to CircleCI 2 weeks ago
docs Important note to docs regarding ensuring custom types/classes have == overloaded if passing into equal() 2 weeks ago
examples Minor corrections 3 days ago
include/mint Fix, tests now passing 2 weeks ago
test Refactor appears to be working! Let's add writeTestFail()... 3 weeks ago
.gitignore Initial commit 3 weeks ago
CMakeLists.txt Adding CMakeLists.txt for Mint 3 weeks ago
LICENSE Adding LICENSE 3 weeks ago
README.md Updating README.md 3 days ago

README.md

Mint

mint-image

GitHub CircleCI Codacy Badge

Mint is a minimal header-only C++ test runner.

Installation

A CMakeLists.txt file has been added for simple linking with CMake. For more on this, check the examples/ directory.

Usage

Using Mint is intentionally simple. The basic flow of a test program using Mint:

  1. Initialize a Mint object.
  2. Call assertions.
  3. Return with end() to clean-up and return with status code.

Example:

#include <mint/mint.h>

int main() {

    //Declare and intialize Mint
    Mint m;

    //Title test
    m.title("Testing Integer Equality");

    //Assertions
    m.equal(10, 10, "integers of same value are equal");

    //Finish tests, and return exit code
    return m.end();
}

Documentation

Documentation can be found by checking the docs/ directory.

Expected output

Output for the above test:

============================
  Testing Integer Equality
============================
  ✓ integers of same value are equal

SUCCESS! All tests (1) passing with no tests failing. Returned with exit code "0".

A snippet from a seperate test:

======================
  Testing Assertions
======================
  ✓ number equality
  ✗ number inequality
    FAIL: Expected "4", found: "1"
  ✓ true
  ✗ false
    FAIL: false is false
  ✓ throws caught from throwing function
  ✗ throws not caught from non-throwing function
    FAIL: willNotThrow() failed to throw (function did not throw)

FAIL! 3 tests failing with 3 tests passing. Returned with exit code "1".

Contact

Questions? Comments? Suggestions?
Open an issue, make a pull request!

Or, you can email me at: luis@serebii.io