lumiera_documentation/tests/steam/control/test-dummy-commands.hpp
Ichthyostega 3caa5cfb03 Tests: reorganise test folders
This resolves a long-standing issue:
we could not use proper include paths for test-helper code that was defined alongside the tests.

Since some test-helper code must now be relocated into the »Vault«-Layer,
I took the opportunity to finally resolve this annoyance. The solution is two-fold
 * introduce a dedicated test-support library
 * remove the quirks that were necessary to support some plain-C tests
Together, this allows to raise the include-directory by one level,
and then to adjust all folder names so that they match the namespace
2026-03-07 00:56:19 +01:00

160 lines
3.2 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.

/*
TEST-DUMMY-COMMANDS.hpp - dummy functions used to build test commands
Copyright (C)
2009, 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 test-dummy-commands.hpp
** Some dummy command functions used for building unit test cases.
** Any of these functions comes in triples of operation function, undo state
** capturing function and UNDO function. They are placed into a nested test
** namespace, together with some global variables, usable as backdoor to
** verify the effect of calling these functions.
**
** @see command-use1-test.cpp
** @see CommandBasic_test simple complete command definition example
**
*/
#ifndef COMMAND_TEST_DUMMY_COMMANDS_H
#define COMMAND_TEST_DUMMY_COMMANDS_H
#include "lib/error.hpp"
#include "test/test-helper.hpp"
#include "steam/control/command-setup.hpp"
#include <functional>
#include <sstream>
#include <string>
namespace steam {
namespace control {
namespace test {
using std::ostringstream;
using std::function;
using std::string;
namespace command1 { ///< test command just adding a given value
extern int64_t check_;
inline void
operate (int someVal)
{
check_ += someVal;
}
inline int64_t
capture (int)
{
return check_;
}
inline void
undoIt (int, int64_t oldVal)
{
check_ = oldVal;
}
}
namespace command2 { ///< test command writing capturing log and possibly throwing
using lumiera::error::External;
extern ostringstream check_;
typedef function<string()> FunS;
inline void
operate (FunS func, bool *fail)
{
if (fail and *fail) throw External("simulated exception");
check_ << func();
}
inline string
capture (FunS, bool*)
{
return check_.str();
}
inline void
undoIt (FunS, bool *fail, string previousProtocol)
{
if (fail and *fail) throw External("simulated exception in UNDO");
check_.str("");
check_ << previousProtocol << "|UNDO|";
}
}
namespace command3 { ///< test command with zero arguments
extern ulong check_;
inline void
operate ()
{
++check_;
}
inline ulong
capture ()
{
return check_;
}
inline void
undoIt (ulong oldVal)
{
check_ = oldVal;
}
}
/* ==== global static prototype definitions for these commands ==== */
/** test dummy command to add the argument to a global variable */
extern CommandSetup test_Dummy_command1;
/** test dummy command to invoke the given functor and
* append the result onto a global log string buffer */
extern CommandSetup test_Dummy_command2;
/** test dummy command to increment a global variable; no arguments */
extern CommandSetup test_Dummy_command3;
}}} // namespace steam::control::test
#endif