LUMIERA.clone/tests/steam/control/command-message-binding-test.cpp
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

129 lines
3.5 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.

/*
CommandMessageBinding(Test) - verify argument binding via GenNode-Message, with immutable types
Copyright (C)
2016, 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 command-message-binding-test.cpp
** unit test \ref CommandMessageBinding_test
*/
#include "test/run.hpp"
#include "test/test-helper.hpp"
#include "steam/control/command-def.hpp"
#include "lib/time/timevalue.hpp"
#include "lib/diff/gen-node.hpp"
namespace steam {
namespace control {
namespace test {
using ::test::randTime;
using lib::time::Time;
using lib::time::TimeVar;
using lib::time::TimeValue;
using lib::time::TimeSpan;
using lib::time::Duration;
using lib::diff::Rec;
namespace { // functions to be invoked through the command system
TimeVar implicitTestState;
void
operate (Duration dur)
{
implicitTestState += dur;
}
Time
capture (Duration)
{
return implicitTestState;
}
void
undoIt (Duration, Time 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.
* - likewise we support to use an immutable type as captured state
* memento, which is demonstrated by capturing a Time value
*
* @see BusTerm_test
* @see TupleRecordInit_test
*/
class CommandMessageBinding_test : public Test
{
virtual void
run (Arg)
{
seedRand();
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 steam::control::test