lumiera_documentation/tests/library/unique-malloc-owner-test.cpp
Ichthyostega 9c74466778 Tests: build an link a test-support library
This is something I wanted to clean-up since a very long time indeed,
but always postponed it, since it requires a lot of nasty clean-up and disentangling....

Several parts had been stashed away into `src/lib/test`, which are not really related:
 * the testrunner and testsuite builder
 * generic helper utilities
 * specialised test-support facilities, e.g. the EventLog

This changeset introduces a new top-level test folder and a namespace `::test`
Code from this folder is linked into a shared library `libtestsupport.so`,
which resides in the linkage hierarchy between »Vessel« and »Vault«,
yet is no longer part of the Lumiera application and only linked into the test-suite.
2026-03-06 23:16:32 +01:00

108 lines
3 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
UniqueMallocOwner(Test) - Concept to dispatch according to the verbs of a DSL
Copyright (C)
2014, Hermann Vosseler <Ichthyostega@web.de>
  **Lumiera** 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. See the file COPYING for further details.
* *****************************************************************/
/** @file unique-malloc-owner-test.cpp
** unit test \ref UniqueMallocOwner_test
*/
#include "test/run.hpp"
#include "test/test-helper.hpp"
#include "lib/unique-malloc-owner.hpp"
#include "lib/util.hpp"
#include <utility>
#include <cstring>
#include <string>
using std::string;
using util::isnil;
namespace lib {
namespace test{
namespace {
void*
mallocMess (size_t siz)
{
return malloc(siz);
}
}
/***************************************************************************//**
* @test Verify automatic management of memory originally allocated by C malloc.
* This situation typically arises when some plain-C function returns
* results in a heap allocated buffer, requiring the client to care
* for proper clean-up. To avoid creating a liability, we wrap the
* buffer into a smart pointer, which acts as ownership token
* and abstracts the specifics of clean-up.
*
* This test places a given (or random) string into a heap malloced
* buffer, and then pushes the "hot potato" of ownership responsibility
* around; another function checks the content of the buffer and consumes
* the token as a side-effect. At the end, there should be no memory leak
* and the ownership token should be empty.
*
* @see lib::UniqueMallocOwner
* @see lib::meta::demangleCxx
*/
class UniqueMallocOwner_test : public Test
{
using CharOwner = UniqueMallocOwner<char>;
virtual void
run (Arg args)
{
string probeString = isnil(args)? randStr(123) : args[0];
auto hotPotato = place_into_malloced_buffer (probeString);
CHECK (!isnil (hotPotato));
verify_and_consume (std::move(hotPotato), probeString);
CHECK (isnil (hotPotato));
}
CharOwner
place_into_malloced_buffer (string probeString)
{
CharOwner hotPotato(mallocMess (1 + probeString.length()));
std::strcpy(hotPotato.get(), probeString.c_str());
return hotPotato;
}
void
verify_and_consume (CharOwner hotPotato, string refString)
{
CHECK (refString == hotPotato.get());
} // note sideeffect: hotPotato goes out of scope here...
};
/** Register this test class... */
LAUNCHER (UniqueMallocOwner_test, "unit common");
}} // namespace lib::test