LibCry

NOTE: I'm planning on changing how the symbol search works once time allows. Check the better-symbol-search branch for progress

---

A neat c testing library/framework with the goal of having the least boilerplate 🥲

Each test suite is its own self-contained binary with a consistent CLI. No more dedicated test runners! These binaries implement the Test Anything Protocol, so you can use any consumer that you'd like! TAP is pretty enough that you can just run them normally as well.

You can also run the tests under a debugger ! Woah !

Roadmap

• For 1.0

  • Forking test runner
  • Send message back to runner from test process
    • Force skip
    • Force fail
    • Force pass
  • Allow for setup and cleanup functions
  • Prettier asserts and such
  • Some man pages.. see meson
  • Test anything protocol implementation
  • Some nice CLI
    • List tests
    • Nice help message
    • Pick tests to run?
    • Add a flag for picking which file to mmap and dlopen?

• Other ideas

  • Windows/non ELF support?

Why the name?

I tried to use some testing libraries and they made me want to cry.

How do I use it?

Write a test file like:

#include "cry.h"
#include <stdbool.h>

test(add_to_two, "Checks that 1 + 1 = 2") {
    cry_assert(1 + 1 == 2);
}

bool returns_true() {
    return true;
}

test(check_true, "Ensure returns_true returns true") {
    cry_assert(returns_true());
}

You can add more if you want, check the macros in cry.h. Don't include a main function.

Then, assuming libcry.a is in library path compile like

gcc yourtest.c -lcry -rdynamic -o yourtest

NOTE: It's very important that you compile with the -rdynamic flag. It won't discover the tests otherwise.

Now you can run the tests like ./yourtest. The output executable runs the tests all by itself !! wow !!

In the future these will have more functionality.. stay tuned.. or add it yourself.

Contributing

Yes ! please ! please ! please !

Feel free to open an issue, a PR, send an issue to my email, or even send a git patch to my email ! (see git format-patch and git send-email). They are all welcome and I'll try to get back to you in time.

You can just build normally with meson, nothing fancy.

It threw an error at me

For most of the assumptions I've made, I left an error message about it so please include that in the bug report or whatever. Hopefully it can be fixed :'). If it just segfaults out of nowhere make sure to include the coredump and test file. Maybe even the compiled program.

are you ok

i spent like 8 hours trying to read the symbols and i've barely slept. but hey it works :)