Skip to content

Latest commit

 

History

History
147 lines (113 loc) · 4.58 KB

ReadMe.md

File metadata and controls

147 lines (113 loc) · 4.58 KB

tappp.hpp - Header-only C++ TAP producer

SYNOPSIS

#include <tappp.hpp>
#include <vector>
#include <bitset>
#include <stdexcept>
#include <ctime>
#include <cstdlib>

using namespace TAP;

int main(void) {
    plan(10);

    diag("current time is ", time(0));
    pass("the first one's free");

    ok(1 < 255, "integer comparison works");
    is("55", 55, "pluggable comparison",
        [&](std::string s, int i) {
            return s == std::to_string(i);
        }
    );

    std::vector a{5,10,12};
    std::vector b{5,10,15};

    is(a[0], 5, "first element is 5");
    isnt(a[2], b[2], "last elements differ");

    TODO("they do differ, let's see");
    is(a[2], b[2], "give me diagnostics");
    TODO("compiles, works but can't diagnose");
    is(a, b, "differing vectors");

    SUBTEST("exercising exceptions") {
        throws<std::out_of_range>([&] { a.at(3); },
            "index 3 is out of bounds");

        throws_like([&] {
            std::bitset<5> mybitset(std::string("01234"));
        }, "bitset::_M_copy_from_ptr", "bitset takes only bits");

        TODO("research correct exception type!");
        throws<std::domain_error>([&] {
            b.resize(b.max_size() + 1);
        }, "resizing too much leaves domain");

        done_testing();
    }

    b[2] = a[2] = b[2] * 2;
    is(b[2], 30, "changed last element");
    is(a, b, "vectors match now");

    return EXIT_SUCCESS;
}
1..10
# current time is 1582508245
ok 1 - the first one's free
ok 2 - integer comparison works
ok 3 - pluggable comparison
ok 4 - first element is 5
ok 5 - last elements differ
not ok 6 - give me diagnostics # TODO they do differ, let's see
# Expected: '15'
#      Got: '12'
not ok 7 - differing vectors # TODO compiles, works but can't diagnose
    ok 1 - index 3 is out of bounds
    ok 2 - bitset takes only bits
    not ok 3 - resizing too much leaves domain # TODO research correct exception type!
    # different exception occurred
    1..3
ok 8 - exercising exceptions
ok 9 - changed last element
ok 10 - vectors match now

DESCRIPTION

This library consists of a single header tappp.hpp which implements an object-oriented Test Anything Protocol producer in C++17. For convenience, a procedural interface is written on top, which becomes nice to use once you are using namespace TAP.

The library is short and contains short documentation in the source code. The complete documentation is in the Documentation.md file.

The library's interface is close to Perl's Test::More and Raku's Test modules. There are other C++ libraries of this kind. The author is aware of libperl++ and libtap++, the latter being a fork of the former and this library taking inspiration from both. I wouldn't have written this library if there weren't things to improve in the existing ones, though. The advantages of tappp.hpp shared with libtap++ over libperl++ are:

  • The TAP producer is isolated into a single library.
  • There is no compile-time boost (or other) dependency. Just pure C++17.

What I consider to be unique advantages over libtap++:

  • tappp.hpp is just a single header, easy to include in projects.¹
  • It has been (cleanly!) written from scratch to use modern C++ conveniences.
  • It supports subtests compatible with TAP.

¹ The test suite of a project is compiled and run either by maintainers or on installation of the software you care about. If the tests pass, they are thrown away and the software is installed. As such, having a compile-time dependency on a full-blown shared library for producing TAP seems like useless overhead, especially since the object code isn't really shared all that much, and the library is highly templated anyway.

TODO

The feature set of this library is already quite what I imagined, but other TAP producers, such as Raku's Test module provide inspiration for more:

  • is_approx: testing relative error for numerics
  • is_deeply: recursive container unpacking

SEE ALSO

AUTHOR

Tobias Boege [email protected]

COPYRIGHT AND LICENSE

This software is copyright (C) 2020 by Tobias Boege.

This is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0.