benn/lumiera_
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
lumiera_/tests/core/steam/engine/buffer-metadata-key-test.cpp
Ichthyostega a90b9e5f16 Library: uniform definition scheme for error-IDs 
In the Lumiera code base, we use C-String constants as unique error-IDs.
Basically this allows to create new unique error IDs anywhere in the code.

However, definition of such IDs in arbitrary namespaces tends to create
slight confusion and ambiguities, while maintaining the proper use statements
requires some manual work.

Thus I introduce a new **standard scheme**
 * Error-IDs for widespread use shall be defined _exclusively_ into `namespace lumiera::error`
 * The shorthand-Macro `LERR_()` can now be used to simplify inclusion and referral
 * (for local or single-usage errors, a local or even hidden definition is OK)
2024-03-21 19:57:34 +01:00

401 lines
14 KiB
C++
Raw Blame History

/*
BufferMetadataKey(Test) - calculation of (internal) buffer metadata type keys
Copyright (C) Lumiera.org
2011, 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 buffer-metadata-key-test.cpp
** unit test \ref BufferMetadataKey_test
*/
#include "lib/error.hpp"
#include "lib/test/run.hpp"
#include "lib/test/test-helper.hpp"
#include "steam/engine/buffer-metadata.hpp"
#include <cstdlib>
#include <cstring>
#include <limits>
using util::isnil;
using util::isSameObject;
namespace steam {
namespace engine{
namespace metadata{
namespace test {
namespace { // Test fixture
const size_t TEST_MAX_SIZE = 1024 * 1024;
const size_t SIZE_A = 1 + rand() % TEST_MAX_SIZE;
const size_t SIZE_B = 1 + rand() % TEST_MAX_SIZE;
/**
* Test Mock to verify the attachment of objects to the buffer.
* An instance of this class overwrites the occupied storage
* with an ascending sequence of numbers on construction,
* and clears the memory area on destruction.
*
* This allows to verify that an instance of this class
* has actually been placed into the buffer, and will be
* cleaned up properly
*/
template<size_t siz>
struct PlacedNumbers
{
typedef char Pattern[siz];
Pattern pattern_;
PlacedNumbers()
{
for (size_t i=0; i<siz; ++i)
pattern_[i] = i % CHAR_MAX;
}
~PlacedNumbers()
{
for (size_t i=0; i<siz; ++i)
pattern_[i] = 0;
}
/* === diagnostics === */
static bool
verifyFilled (const void* buff)
{
REQUIRE (buff);
const Pattern& patt = *reinterpret_cast<const Pattern*> (buff);
for (size_t i=0; i<siz; ++i)
if (patt[i] != char(i % CHAR_MAX))
return false;
return true;
}
static bool
verifyCleared (const void* buff)
{
REQUIRE (buff);
const Pattern& patt = *reinterpret_cast<const Pattern*> (buff);
for (size_t i=0; i<siz; ++i)
if (patt[i])
return false;
return true;
}
};
/**
* Helper to investigate the settings stored in Metadata Key elements.
* Since these are protected, we use an derived class as adapter
*/
struct KeyTypeSpecialisationDiagnostics
: Key
{
size_t const& investigateSize() const { return this->storageSize_; }
TypeHandler const& investigateHandler() const { return this->instanceFunc_; }
LocalKey const& investigateSpecifics() const { return this->specifics_; }
KeyTypeSpecialisationDiagnostics (Key const& toInvestigate)
: Key(toInvestigate)
{ }
};
inline size_t
verifySize (Key const& subject)
{
return KeyTypeSpecialisationDiagnostics(subject).investigateSize();
}
inline const TypeHandler
verifyHandler (Key const& subject)
{
return KeyTypeSpecialisationDiagnostics(subject).investigateHandler();
}
inline const LocalKey
verifySpecifics (Key const& subject)
{
return KeyTypeSpecialisationDiagnostics(subject).investigateSpecifics();
}
}//(End) Test helpers
/*******************************************************************//**
* @test verify calculation and relations of Buffer metadata type keys.
* These are used internally within the standard implementation
* of BufferProvider to keep track of various kinds of buffers,
* to provide a service for attaching metadata, e.g. a state flag.
* These metadata key entries are based on chained hash values,
* thus forming sort-of a "type" hierarchy.
* - the actual BufferProvider instance-ID is the top level
* - second level is the size of the buffer required
* - optionally, custom ctor/dtor functions can be registered
* - also optionally, implementation might attach an private-ID
*/
class BufferMetadataKey_test : public Test
{
virtual void
run (Arg)
{
CHECK (ensure_proper_fixture());
buildSimpleKeys();
verifyChainedHashes();
verifyTypeHandler<500>();
verifyTypeSpecialisation();
}
bool
ensure_proper_fixture()
{
return (SIZE_A != SIZE_B);
}
void
buildSimpleKeys()
{
HashVal family(123);
Key k1(family, SIZE_A);
Key k12(k1, SIZE_B);
Key k123(k12, LocalKey(56));
CHECK (HashVal (k1));
CHECK (HashVal (k12));
CHECK (HashVal (k123));
}
void
verifyChainedHashes()
{
HashVal family(123);
HashVal otherFamily(456);
Key k1(family, SIZE_A);
Key k1o(otherFamily, SIZE_A);
CHECK (HashVal(k1) != HashVal(k1o));
// hash is reproducible
CHECK (HashVal(k1) == HashVal(Key(family, SIZE_A)));
// differentiate on buffer size
Key k12(k1, SIZE_B);
Key k121(k12, SIZE_A);
Key k2(family, SIZE_B);
CHECK (HashVal(k1) != HashVal(k121));
CHECK (HashVal(k12) != HashVal(k2));
// so the specialisation path really matters, but this is reproducible...
CHECK (HashVal(k121) == HashVal(Key(Key(Key(family,SIZE_A),SIZE_B),SIZE_A)));
}
template<size_t SIZ>
void
verifyTypeHandler()
{
char buff[SIZ];
memset (buff, '\0', SIZ);
typedef PlacedNumbers<SIZ> Pattern;
TypeHandler attachPattern = TypeHandler::create<Pattern>();
CHECK (attachPattern.isValid());
CHECK (0 != hash_value(attachPattern));
CHECK (Pattern::verifyCleared (buff));
attachPattern.createAttached (buff); // invoke the ctor-functor to place an instance of PlacedNumbers
CHECK (Pattern::verifyFilled (buff));
attachPattern.destroyAttached (buff); // invoke the dtor-functor to clear the attached instance
CHECK (Pattern::verifyCleared (buff));
}
void
verifyTypeSpecialisation()
{
HashVal family(123);
Key kb (family, SIZE_A); // "root" key
typedef PlacedNumbers<45> Marker;
TypeHandler placeMarker = TypeHandler::create<Marker>();
TypeHandler noHandler;
LocalKey opaque1 (rand() % 1000);
LocalKey opaque2 (1000 + rand() % 1000);
Key k_siz (kb, SIZE_B); // sub-key to "root": use a different buffer size
Key k_han0(kb, noHandler); // sub-key to "root": use a locally defined type functor
Key k_han1(kb, placeMarker); // sub-key to "root": use yet another type functor
Key k_loc1(kb, opaque1); // sub-key to "root": attach an private opaque ID
Key k_loc2(kb, opaque2); // sub-key to "root": attach another opaque ID
CHECK (kb != k_siz );
CHECK (kb != k_han0);
CHECK (kb != k_han1);
CHECK (kb != k_loc1);
CHECK (kb != k_loc2);
CHECK (k_siz != k_han0);
CHECK (k_siz != k_han1);
CHECK (k_siz != k_loc1);
CHECK (k_siz != k_loc2);
CHECK (k_han0 != k_han1);
CHECK (k_han0 != k_loc1);
CHECK (k_han0 != k_loc2);
CHECK (k_han1 != k_loc1);
CHECK (k_han1 != k_loc2);
CHECK (k_loc1 != k_loc2);
CHECK (HashVal(kb ) != HashVal(k_siz ));
CHECK (HashVal(kb ) != HashVal(k_han0));
CHECK (HashVal(kb ) != HashVal(k_han1));
CHECK (HashVal(kb ) != HashVal(k_loc1));
CHECK (HashVal(kb ) != HashVal(k_loc2));
CHECK (HashVal(k_siz ) != HashVal(k_han0));
CHECK (HashVal(k_siz ) != HashVal(k_han1));
CHECK (HashVal(k_siz ) != HashVal(k_loc1));
CHECK (HashVal(k_siz ) != HashVal(k_loc2));
CHECK (HashVal(k_han0) != HashVal(k_han1));
CHECK (HashVal(k_han0) != HashVal(k_loc1));
CHECK (HashVal(k_han0) != HashVal(k_loc2));
CHECK (HashVal(k_han1) != HashVal(k_loc1));
CHECK (HashVal(k_han1) != HashVal(k_loc2));
CHECK (HashVal(k_loc1) != HashVal(k_loc2));
CHECK (SIZE_A == verifySize(kb ));
CHECK (SIZE_B == verifySize(k_siz ));
CHECK (SIZE_A == verifySize(k_han0));
CHECK (SIZE_A == verifySize(k_han1));
CHECK (SIZE_A == verifySize(k_loc1));
CHECK (SIZE_A == verifySize(k_loc2));
CHECK (RAW_BUFFER == verifyHandler(kb ));
CHECK (RAW_BUFFER == verifyHandler(k_siz ));
CHECK (noHandler == verifyHandler(k_han0));
CHECK (placeMarker == verifyHandler(k_han1));
CHECK (RAW_BUFFER == verifyHandler(k_loc1));
CHECK (RAW_BUFFER == verifyHandler(k_loc2));
CHECK (UNSPECIFIC == verifySpecifics(kb ));
CHECK (UNSPECIFIC == verifySpecifics(k_siz ));
CHECK (UNSPECIFIC == verifySpecifics(k_han0));
CHECK (UNSPECIFIC == verifySpecifics(k_han1));
CHECK (opaque1 == verifySpecifics(k_loc1));
CHECK (opaque2 == verifySpecifics(k_loc2));
// Verify 2nd level specialisation (some examples)
Key k_han1_siz (k_han1, SIZE_B); // sub-key deriving from k_han1, but differing buffer size
Key k_siz_han1 (k_siz, placeMarker); // sub-key deriving from k_siz, but using another type functor
// Verify some 3rd level specialisations
Key k_han1_siz_loc2 (k_han1_siz, opaque2);
Key k_loc2_han1_siz (Key(k_loc2,placeMarker), SIZE_B);
CHECK (SIZE_B == verifySize(k_han1_siz ));
CHECK (SIZE_B == verifySize(k_siz_han1 ));
CHECK (SIZE_B == verifySize(k_han1_siz_loc2));
CHECK (SIZE_B == verifySize(k_loc2_han1_siz));
CHECK (placeMarker == verifyHandler(k_han1_siz ));
CHECK (placeMarker == verifyHandler(k_siz_han1 ));
CHECK (placeMarker == verifyHandler(k_han1_siz_loc2));
CHECK (placeMarker == verifyHandler(k_loc2_han1_siz));
CHECK (UNSPECIFIC == verifySpecifics(k_han1_siz ));
CHECK (UNSPECIFIC == verifySpecifics(k_siz_han1 ));
CHECK (opaque2 == verifySpecifics(k_han1_siz_loc2));
CHECK (opaque2 == verifySpecifics(k_loc2_han1_siz));
// for equality, also the order of specialisation matters
CHECK (k_han1_siz != k_siz_han1 );
CHECK (k_han1_siz_loc2 != k_loc2_han1_siz);
CHECK (HashVal(k_han1_siz ) != HashVal(k_siz_han1 ));
CHECK (HashVal(k_han1_siz_loc2) != HashVal(k_loc2_han1_siz));
// yet this *is* an semantic equality test
Key k_again (Key(k_han1,SIZE_B), opaque2);
CHECK (k_again == k_han1_siz_loc2);
CHECK (HashVal(k_again) == HashVal(k_han1_siz_loc2));
// pick just some combinations for cross verification...
CHECK (kb != k_han1_siz );
CHECK (kb != k_siz_han1 );
CHECK (kb != k_han1_siz_loc2);
CHECK (kb != k_loc2_han1_siz);
CHECK (k_han1 != k_han1_siz );
CHECK (k_han1 != k_siz_han1 );
CHECK (k_han1 != k_han1_siz_loc2);
CHECK (k_han1 != k_loc2_han1_siz);
CHECK (k_siz != k_han1_siz );
CHECK (k_siz != k_siz_han1 );
CHECK (k_siz != k_han1_siz_loc2);
CHECK (k_siz != k_loc2_han1_siz);
CHECK (k_loc2 != k_han1_siz );
CHECK (k_loc2 != k_siz_han1 );
CHECK (k_loc2 != k_han1_siz_loc2);
CHECK (k_loc2 != k_loc2_han1_siz);
CHECK (HashVal(kb ) != HashVal(k_han1_siz ));
CHECK (HashVal(kb ) != HashVal(k_siz_han1 ));
CHECK (HashVal(kb ) != HashVal(k_han1_siz_loc2));
CHECK (HashVal(kb ) != HashVal(k_loc2_han1_siz));
CHECK (HashVal(k_han1) != HashVal(k_han1_siz ));
CHECK (HashVal(k_han1) != HashVal(k_siz_han1 ));
CHECK (HashVal(k_han1) != HashVal(k_han1_siz_loc2));
CHECK (HashVal(k_han1) != HashVal(k_loc2_han1_siz));
CHECK (HashVal(k_siz ) != HashVal(k_han1_siz ));
CHECK (HashVal(k_siz ) != HashVal(k_siz_han1 ));
CHECK (HashVal(k_siz ) != HashVal(k_han1_siz_loc2));
CHECK (HashVal(k_siz ) != HashVal(k_loc2_han1_siz));
CHECK (HashVal(k_loc2) != HashVal(k_han1_siz ));
CHECK (HashVal(k_loc2) != HashVal(k_siz_han1 ));
CHECK (HashVal(k_loc2) != HashVal(k_han1_siz_loc2));
CHECK (HashVal(k_loc2) != HashVal(k_loc2_han1_siz));
}
};
/** Register this test class... */
LAUNCHER (BufferMetadataKey_test, "unit player");
}}}} // namespace steam::engine::metadata::test
Reference in a new issue View git blame Copy permalink