lumiera_/tests/core/proc/control/command-message-binding-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

134 lines
3.7 KiB
C++

/*
CommandMessageBinding(Test) - verify argument binding via GenNode-Message, with immutable types
Copyright (C) Lumiera.org
2016, 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 command-message-binding-test.cpp
** unit test §§TODO§§
*/
#include "lib/test/run.hpp"
#include "lib/test/test-helper.hpp"
#include "proc/control/command-def.hpp"
#include "lib/time/timevalue.hpp"
#include "lib/diff/gen-node.hpp"
namespace proc {
namespace control {
namespace test {
using lib::time::Time;
using lib::time::TimeVar;
using lib::time::TimeValue;
using lib::time::TimeSpan;
using lib::time::Duration;
using lib::test::randTime;
using lib::diff::Rec;
namespace { // functions to be invoked through the command system
TimeVar implicitTestState;
void
operate (Duration dur)
{
implicitTestState += dur;
}
TimeVar
capture (Duration)
{
return implicitTestState;
}
void
undoIt (Duration, TimeVar oldVal)
{
implicitTestState = oldVal;
}
}
/***********************************************************************//**
* @test verify the simple standard usage pattern, where command arguments
* for binding are passed via UI-Bus message with GenNode elements.
* This is a simplified demonstration, but covers some tricky aspects.
* - commands may define arguments of arbitrary type, and at runtime
* these are initialised from the set of standard types allowed
* within GenNode elements. Here the Duration is initialised from
* a TimeSpan object
* - we support immutable argument types, which means the command binding
* machinery works without (re)assignment, only copy construction of
* argument holders into an inline buffer.
*
* @see BusTerm_test
* @see TupleRecordInit_test
*/
class CommandMessageBinding_test : public Test
{
virtual void
run (Arg)
{
Time five(TimeValue(5));
implicitTestState = five;
CommandDef ("test.command2")
.operation (operate)
.captureUndo (capture)
.undoOperation (undoIt)
;
TimeSpan testSpan (randTime(), randTime());
Rec argMsg {testSpan};
// bind the command argument from a GenNode message
Command ourCmd = Command::get("test.command2");
CHECK (not ourCmd.canExec());
ourCmd.bindArg (argMsg);
CHECK (ourCmd.canExec());
// invoke the command
ourCmd();
CHECK (implicitTestState == five + Duration(testSpan));
// undo the effect of the command
ourCmd.undo();
CHECK (implicitTestState == five);
}
};
/** Register this test class... */
LAUNCHER (CommandMessageBinding_test, "unit controller");
}}} // namespace proc::control::test