benn/lumiera_
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
lumiera_/tests/library/item-wrapper-test.cpp
Ichthyostega 24b3bec4be Doxygen: prepare all unit tests for inclusion in the documentation 
Doxygen will only process files with a @file documentation comment.
Up to now, none of our test code has such a comment, preventing the
cross-links to unit tests from working.

This is unfortunate, since unit tests, and even the code comments there,
can be considered as the most useful form of technical documentation.
Thus I'll start an initiative to fill in those missing comments automatically
2017-02-22 01:54:20 +01:00

326 lines
9.2 KiB
C++
Raw Blame History

/*
ItemWrapper(Test) - wrapping and holding arbitrary values, pointers and references
Copyright (C) Lumiera.org
2009, Hermann Vosseler <Ichthyostega@web.de>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
* *****************************************************/
/** @file item-wrapper-test.cpp
** unit test §§TODO§§
*/
#include "lib/test/run.hpp"
#include "lib/test/test-helper.hpp"
#include "lib/util.hpp"
#include "lib/wrapper.hpp"
#include <functional>
#include <iostream>
#include <cstdlib>
#include <string>
#include <vector>
namespace lib {
namespace wrapper {
namespace test{
using ::Test;
using lib::test::randStr;
using lib::test::showSizeof;
using util::isSameObject;
using std::placeholders::_1;
using std::ref;
using std::vector;
using std::string;
using std::rand;
using std::cout;
using std::endl;
namespace { // Test helper: yet another ctor/dtor counting class
long cntTracker = 0;
struct Tracker
{
uint i_;
Tracker() : i_(rand() % 500) { ++cntTracker; }
Tracker(Tracker const& ot) : i_(ot.i_) { ++cntTracker; }
~Tracker() { --cntTracker; }
};
bool operator== (Tracker const& t1, Tracker const& t2) { return t1.i_ == t2.i_; }
bool operator!= (Tracker const& t1, Tracker const& t2) { return t1.i_ != t2.i_; }
/// to be bound as test function....
int&
pickElement (vector<int>& vec, size_t idx)
{
return vec[idx];
}
function<int&(size_t)>
pickElement_ofVector (vector<int>& vec)
{
return std::bind (pickElement, ref(vec), _1 );
}
} // (END) Test helpers
/***************************************************************************//**
* @test use the ItemWrapper to define inline-storage holding values,
* pointers and references. Verify correct behaviour in each case,
* including (self)assignment, empty check, invalid dereferentiation.
*
* @see wrapper.hpp
*/
class ItemWrapper_test : public Test
{
virtual void
run (Arg)
{
ulong l1 (rand() % 1000);
ulong l2 (rand() % 1000);
string s1 (randStr(50));
string s2 (randStr(50));
const char* cp (s1.c_str());
verifyWrapper<ulong> (l1, l2);
verifyWrapper<ulong&> (l1, l2);
verifyWrapper<ulong*> (&l1, &l2);
verifyWrapper<ulong*> ((0), &l2);
verifyWrapper<ulong*> (&l1, (0));
verifyWrapper<ulong const&> (l1, l2);
verifyWrapper<string> (s1, s2);
verifyWrapper<string&> (s1, s2);
verifyWrapper<string*> (&s1, &s2);
verifyWrapper<const char*> (cp, "Lumiera");
verifySaneInstanceHandling();
verifyWrappedRef ();
verifyFunctionResult ();
verifyFunctionRefResult ();
}
template<typename X>
void
verifyWrapper (X val, X otherVal)
{
const ItemWrapper<X> wrap(val);
CHECK (wrap);
cout << "ItemWrapper: " << showSizeof(wrap) << endl;
ItemWrapper<X> copy1 (wrap);
ItemWrapper<X> copy2;
ItemWrapper<X> empty;
CHECK (copy1);
CHECK (!copy2);
CHECK (false == bool(empty));
CHECK (wrap == copy1);
CHECK (wrap != copy2);
CHECK (wrap != empty);
copy2 = copy1;
CHECK (copy2);
CHECK (wrap == copy2);
CHECK (wrap != empty);
copy2 = otherVal;
CHECK (copy2);
CHECK (wrap != copy2);
CHECK (wrap != empty);
CHECK (val == *wrap);
CHECK (val == *copy1);
CHECK (val != *copy2);
VERIFY_ERROR (BOTTOM_VALUE, *empty );
CHECK (otherVal == *copy2);
copy1 = copy2;
CHECK (otherVal == *copy1);
CHECK (otherVal == *copy2);
CHECK (wrap != copy1);
CHECK (wrap != copy2);
copy1 = empty; // assign empty to discard value
copy1 = copy1; // self-assign empty value
CHECK (!copy1);
copy1 = copy2;
CHECK (otherVal == *copy1);
copy1 = copy1; // self-assign (will be suppressed)
CHECK (otherVal == *copy1);
copy1 = *copy1; // self-assign also detected in this case
CHECK (otherVal == *copy2);
CHECK (copy1);
copy1.reset();
CHECK (!copy1);
CHECK (empty == copy1);
CHECK (copy2 != copy1);
VERIFY_ERROR (BOTTOM_VALUE, *copy1 );
};
/** @test verify that ctor and dtor calls are balanced,
* even when assigning and self-assigning.
*/
void
verifySaneInstanceHandling()
{
cntTracker = 0;
{
Tracker t1;
Tracker t2;
verifyWrapper<Tracker> (t1, t2);
verifyWrapper<Tracker&> (t1, t2);
verifyWrapper<Tracker*> (&t1, &t2);
}
CHECK (0 == cntTracker);
}
/** @test verify especially that we can wrap and handle
* a reference "value" in a pointer-like manner
*/
void
verifyWrappedRef ()
{
int x = 5;
ItemWrapper<int&> refWrap;
CHECK (!refWrap);
refWrap = x;
CHECK (refWrap);
CHECK (5 == *refWrap);
CHECK (x == *refWrap);
*refWrap += 5;
CHECK (x == 10);
ItemWrapper<int*> ptrWrap (& *refWrap);
CHECK ( isSameObject (**ptrWrap, x));
CHECK (!isSameObject ( *ptrWrap, &x));
**ptrWrap += 13;
CHECK (x == 23);
}
/** @test verify an extension built on top of the ItemWrapper:
* a function which remembers the last result. As a simple test,
* we bind the \c rand() standard lib function and remember the
* last returned random value.
*/
void
verifyFunctionResult()
{
FunctionResult<int(void)> randomVal (std::rand);
// function was never invoked, thus the remembered result is NIL
CHECK (!randomVal);
VERIFY_ERROR (BOTTOM_VALUE, *randomVal );
int v1 = randomVal();
CHECK (v1 == *randomVal);
CHECK (v1 == *randomVal);
CHECK (v1 == *randomVal);
CHECK (randomVal);
int v2;
do v2 = randomVal();
while (v1 == v2);
CHECK (v2 == *randomVal);
CHECK (v2 == *randomVal);
CHECK (v1 != *randomVal);
}
/** @test verify an extension built on top of the ItemWrapper:
* a function which remembers the last result. Here we use
* a test function, which picks a member of an vector and
* returns a \em reference to it. Thus the cached "result"
* can be used to access and change the values within the
* original vector. In a real world usage scenario, such a
* function could be an (expensive) data structure access.
*/
void
verifyFunctionRefResult()
{
vector<int> testVec;
for (uint i=0; i<10; ++i)
testVec.push_back(i);
FunctionResult<int&(size_t)> funRes (pickElement_ofVector(testVec));
// function was never invoked, thus the remembered result is NIL
CHECK (!funRes);
VERIFY_ERROR (BOTTOM_VALUE, *funRes );
int& r5 = funRes (5);
CHECK (funRes); // indicates existence of cached result
CHECK (5 == r5);
CHECK (isSameObject (r5, testVec[5]));
int& r5x = *funRes;
CHECK (isSameObject (r5, r5x));
CHECK ( isSameObject (r5, *funRes));
int& r7 = funRes (7);
CHECK (!isSameObject (r5, *funRes));
CHECK ( isSameObject (r7, *funRes));
-- r5x;
++ *funRes;
CHECK (5-1 == testVec[5]);
CHECK (7+1 == testVec[7]);
CHECK (7+1 == r7);
}
};
LAUNCHER (ItemWrapper_test, "unit common");
}}} // namespace lib::wrapper::test
Reference in a new issue View git blame Copy permalink