Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/jasmcaus/tau

A Micro (1k lines of code) Unit Test Framework for C/C++
https://github.com/jasmcaus/tau

1k-lines assertion-macros assertions binary-comparisons c c-plus-plus c11 c17 cmake cpp cpp11 cpp17 cpp20 embedded macros tau test-framework testing testing-framework unit-testing

Last synced: 4 months ago
JSON representation

A Micro (1k lines of code) Unit Test Framework for C/C++

Host: GitHub
URL: https://github.com/jasmcaus/tau
Owner: jasmcaus
License: mit
Created: 2021-02-23T07:35:42.000Z (over 3 years ago)
Default Branch: dev
Last Pushed: 2024-03-12T11:44:11.000Z (4 months ago)
Last Synced: 2024-03-12T13:07:46.901Z (4 months ago)
Topics: 1k-lines, assertion-macros, assertions, binary-comparisons, c, c-plus-plus, c11, c17, cmake, cpp, cpp11, cpp17, cpp20, embedded, macros, tau, test-framework, testing, testing-framework, unit-testing
Language: C
Homepage:
Size: 3.59 MB
Stars: 142
Watchers: 8
Forks: 28
Open Issues: 11
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Lists

awesome-c-zh - Tau - C/C的微型单元测试框架 (〜1k代码行)。包括一组丰富的断言宏，支持自动测试注册，并且可以输出为多种格式，如TAP格式或JUnit XML。支持Linux、macOS、FreeBSD和Windows。[](https://spdx.org/licenses/MIT.html) (测试 / YAML)

README

        


Tau τ


[![Standard](https://img.shields.io/badge/C-11/14/17-blue.svg)](https://en.wikipedia.org/wiki/C_(programming_language))

[![Standard](https://img.shields.io/badge/C%2B%2B-11/14/17/20-blue.svg)](https://en.wikipedia.org/wiki/C%2B%2B)

[![License](https://img.shields.io/github/license/jasmcaus/tau?label=license)][license]

[![Twitter](https://img.shields.io/twitter/follow/jasmcaus.svg?style=flatl&label=Follow&logo=twitter&logoColor=white&color=1da1f2)][twitter-badge]

[![Download](https://img.shields.io/badge/download%20%20-link-green.svg)](https://github.com/jasmcaus/tau/releases)

[![Docs](https://img.shields.io/badge/docs%20%20-online-blue.svg)][docs]



A Micro Unit Testing Framework for >C11/C++11 projects, with the promise of *always being tiny* - about 1k lines of

code. This framework is a *much* simpler, *much* lighter and *much* faster alternative to heavier frameworks like

Google Test, & Catch2, making it suitable for on-to-go testing (embedded developers will especially love us!).

I initially wrote Tau to be a unit testing framework for C; however, initial results showed great promise of

compiling with (and testing) C++ code. While Tau doesn't currently support mocking, or a way to test for exceptions

in C++, its limitations are in fact its biggest strength - you get *negligible* overhead & fast compilation speeds

for the sacrifice of a few constructs.

## Features

* *Ultra-light* (~1k lines of code)

* **8x** times faster than GoogleTest and Catch2

* Can test both C and C++ code (see [ThirdParty tests](https://github.com/jasmcaus/tau/blob/dev/test/ThirdParty))

* [Blazing Fast Assertions](https://github.com/jasmcaus/tau/blob/dev/benchmarks)

* Gtest-like Assertion Macros

* Supports Test Fixtures

* Allows filtering of test cases

# Installation

None! Tau is header-only, so simply include it in your project.

```c

#include 

```

To build Tau with CMake, read through the [CMake Quickstart Guide](https://github.com/jasmcaus/tau/blob/dev/docs/cmake-quickstart.md).

Alternatively, use `-I tau` to add the repository directory to the compiler search paths.

# Prerequistes

To begin, you **must** include the following in *any* (but only one) C/C++ file. This initializes Tau to set up

all your tests:

```c

TAU_MAIN() // IMPORTANT: No semicolon at the end

```

This defines a main function, so if you write a `main()` function ***and*** declare `TAU_MAIN()`, your compiler will

throw a `redeclaration of main` error.

If you must write a `main()` function, use the following instead:

```c

TAU_NO_MAIN()

```

This won't define a main function, but sets up any variables/methods that Tau needs to run properly.

# Getting Started

## Defining a Test Suite

To define a test suite, simply do the following:

```c

TEST(TestSuiteName, TestName) {

    CHECK(1); // does not fail

    ... rest of the test body ...

}

```

The `TEST` macro takes two parameters - the first is the name of the Test Suite, and the second is the name of the

test. This allows tests to be grouped for convenience.

## Testing Macros

Tau provides two variants of Assertion Macros - `CHECK`s and `ASSERT`s. These resemble function calls. When these

assertions fail, Tau prints the source code location (file + line number) along with a failure message.

`ASSERT`s generate *fatal* failures - the test suite will cease its execution and move on to the next test suite to

run.

`CHECK`s generate *non-fatal* failures - the remainder of the test suite will still execute, allowing for further

checks to run.

Read [the Primer](https://github.com/jasmcaus/tau/blob/dev/docs/tau-primer.md) for more details, including the

other testing macros Tau provides you with.

## Example Usage

Below is a slightly contrived example showing a number of possible supported operations:

```C

#include 

TAU_MAIN() // sets up Tau (+ main function)

TEST(foo, bar1) {

    int a = 42;

    int b = 13;

    CHECK_GE(a, b); // pass :)

    CHECK_LE(b, 8); // fail - Test suite not aborted

}

TEST(foo, bar2) {

    char* a = "foo";

    char* b = "foobar";

    REQUIRE_STREQ(a, a); // pass :)

    REQUIRE_STREQ(a, b); // fail - Test suite aborted

}

```

# Supported Platforms

Tau supports codebases and compilers that are compliant with the C11/C++11 standard or newer. Tau's source

code is officially supported on the following platforms. If you notice any problems on your platform, please

file an issue on the [Tau Github Issue Tracker][issues]. PRs with fixes are welcome!

Operating Systems          | Compilers

-------------------------- | --------------------------

Linux                      | gcc 5.0+

macOS                      | clang 5.0+

Windows                    | MSVC 2017+

# Contributing

We appreciate all contributions, feedback and issues. If you plan to contribute new features, utility functions,

or extensions to the core, please go through our [Contribution Guidelines][contributing].

To contribute, start working through the `Tau` codebase, read the [Documentation][docs], navigate to the

[Issues][issues] tab and start looking through interesting issues.

# Asking for help

If you have any questions, please:

1. [Read the docs][docs].

2. [Look it up in our Github Discussions (or add a new question)][discussions].

2. [Search through the issues][issues].

# Who uses Tau?

In addition to several of my personal projects, Tau is also used in the following notable projects:

* The [Adorad Programming Language](https://github.com/adorad/adorad)

# Supporting This Project

If you are able to and would like to sponsor this project, you may do so using either of the links below. Thank you very much in advance :)



    

    

    



# License

This project was written by [Jason Dsouza](https://github.com/jasmcaus) and licensed under the [MIT License](LICENSE).

[contributing]: https://github.com/jasmcaus/tau/blob/dev/.github/CONTRIBUTING.md

[docs]: https://github.com/jasmcaus/tau/blob/dev/docs

[discussions]: https://github.com/jasmcaus/tau/discussions

[issues]: https://github.com/jasmcaus/tau/issues

[twitter-badge]: https://twitter.com/jasmcaus

[license]: https://github.com/jasmcaus/tau/blob/dev/LICENSE