hegel::TestCase Class Reference

Handle to the currently-executing test case. More...

#include <test_case.h>

Public Member Functions
	TestCase (const TestCase &)=delete
TestCase &	operator= (const TestCase &)=delete
	TestCase (TestCase &&)=delete
TestCase &	operator= (TestCase &&)=delete
template<typename T>
T	draw (const generators::Generator< T > &gen) const
	Draw a random value from a generator.
void	assume (bool condition) const
	Reject the current test case if condition is false.
void	note (std::string_view message) const
	Record a message that will be printed on the final replay of a failing test case.

Detailed Description

Handle to the currently-executing test case.

A TestCase is passed as the sole argument to the callback given to hegel::test(). It is the main way a test definition interacts with Hegel.

TestCase is a non-owning handle into state managed by the Hegel runner. It is neither copyable nor movable, and must not outlive the test-case callback.

hegel::test([](hegel::TestCase& tc) {
    namespace gs = hegel::generators;
    auto x = tc.draw(gs::integers<int>({.min_value = 0}));
    tc.assume(x != 0);
    tc.note("x = " + std::to_string(x));
});

Member Function Documentation

assume()

void hegel::TestCase::assume

(

bool

condition

)

const

Reject the current test case if condition is false.

auto age = tc.draw(gs::integers<int>());
tc.assume(age >= 18);

Parameters

condition

Value that must be true for the test case to continue. If false, the current test case is rejected.

draw()

template<typename T>

T hegel::TestCase::draw

(

const generators::Generator< T > &

gen

)

const

Draw a random value from a generator.

Template Parameters

T	The value type produced by gen

Parameters

gen	The generator to draw from

Returns

A freshly generated value of type T

note()

void hegel::TestCase::note

(

std::string_view

message

)

const

Record a message that will be printed on the final replay of a failing test case.

Parameters

message

The message to record.

---

The documentation for this class was generated from the following files:

• include/hegel/test_case.h
• include/hegel/core.h