lumiera_/tests/library/thread-wrapper-join-test.cpp
Ichthyostega 806db414dd Copyright: clarify and simplify the file headers
* Lumiera source code always was copyrighted by individual contributors
 * there is no entity "Lumiera.org" which holds any copyrights
 * Lumiera source code is provided under the GPL Version 2+

== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''

The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!

The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.
2024-11-17 23:42:55 +01:00

144 lines
3.8 KiB
C++
Raw Permalink 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.

/*
ThreadWrapperJoin(Test) - wait blocking on termination of a thread
Copyright (C)
2008, 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 thread-wrapper-join-test.cpp
** unit test \ref ThreadWrapperJoin_test
*/
#include "lib/test/run.hpp"
#include "lib/test/test-helper.hpp"
#include "lib/thread.hpp"
#include "lib/error.hpp"
#include <chrono>
using test::Test;
using std::this_thread::sleep_for;
using namespace std::chrono_literals;
namespace lib {
namespace test {
using error::LUMIERA_ERROR_LOGIC;
namespace {
const int DESTRUCTION_CODE = -23;
LUMIERA_ERROR_DEFINE(SPECIAL, "007 exception");
#define Type(_EXPR_) lib::test::showType<decltype(_EXPR_)>()
}
/***********************************************************************//**
* @test verify the special flavour of the thread-wrapper, allowing to block
* waiting on thread end and then pass result or error state.
* @see thread.hpp
* @see Result_test
* @see ThreadWrapper_test
* @see SyncLocking_test
*/
class ThreadWrapperJoin_test : public Test
{
virtual void
run (Arg)
{
seedRand();
simpleUse();
returnValue();
detectFailure();
joinOnceOnly();
}
void
simpleUse()
{
ThreadJoinable theThread{"test join-1"
,[]{ sleep_for (10ms); }};
CHECK (theThread);
theThread.join(); // blocks until thread-function has terminated
CHECK (not theThread);
}
int
theAction (int secretValue) ///< to be run in a new thread...
{
sleep_for (100ms); // pause 100ms prior to modifying
if (DESTRUCTION_CODE == secretValue)
throw error::External{"special agent detected"
, LUMIERA_ERROR_SPECIAL};
else
return secretValue+42;
}
void
returnValue()
{
int mySecret = rani(1000);
ThreadJoinable theThread{"test join-2"
,&ThreadWrapperJoin_test::theAction
, this, mySecret};
// Note: join() passes the result value captured in the thread
CHECK (mySecret+42 == theThread.join());
}
void
detectFailure()
{
ThreadJoinable theThread{"test join-3"
,&ThreadWrapperJoin_test::theAction
, this, DESTRUCTION_CODE};
// join() actually returns a proxy...
auto res = theThread.join();
CHECK (Type(res) == "Result<int>"_expect);
// can detect that the thread was aborted with an exception
CHECK (not res.isValid());
VERIFY_ERROR(SPECIAL, res.maybeThrow() );
VERIFY_ERROR(SPECIAL, (int)res );
}
void
joinOnceOnly()
{
ThreadJoinable theThread{"test join-4"
,[]{ sleep_for (10ms); }};
theThread.join();
VERIFY_ERROR(LOGIC, theThread.join() );
VERIFY_ERROR(LOGIC, theThread.join() );
}
};
/** Register this test class... */
LAUNCHER (ThreadWrapperJoin_test, "function common");
}} // namespace lib::test