lumiera_documentation/tests/steam/mobject/session/test-scopes.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

77 lines
2.4 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-SCOPES.hpp - builds a test PlacementIndex containing dummy Placements as nested scopes
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-scopes.hpp
** Unit test helper to generate a system of nested test scopes.
** These can be used to verify session search and discovery functionality.
** The build_testScopes() function generates a system of placements and MObjects
** with a known, fixed layout.
*/
#ifndef MOBJECT_SESSION_TEST_TEST_SCOPES_H
#define MOBJECT_SESSION_TEST_TEST_SCOPES_H
#include "steam/mobject/test-dummy-mobject.hpp"
#include "steam/mobject/session/placement-index.hpp"
#include "steam/mobject/session/scope-query.hpp"
#include "steam/mobject/placement.hpp"
#include <memory>
namespace steam {
namespace mobject {
namespace session {
namespace test {
using namespace mobject::test;
typedef TestPlacement<DummyMO> PDum;
typedef std::shared_ptr<PlacementIndex> PPIdx;
typedef ScopeQuery<MObject>::iterator _ScopeIterMO;
/** helper for tests: create a pseudo-session (actually just a PlacementIndex),
* which contains some nested placement scopes.
* @return new PlacementIndex, which has already been activated to be used
* by all Placements from now on. This activation will be cleared
* automatically, when this object goes out of scope.
*
* @see mobject::PlacementIndex
* @see session::SessManagerImpl::getCurrentIndex()
* @see mobject::session::SessionServiceMockIndex::reset_PlacementIndex
*/
PPIdx build_testScopes();
/** complement to the helper: retrieve one of the dummy placements
* which is a Placement<> and way down into the hierarchy
*/
PlacementMO& retrieve_startElm();
PlacementMO& retrieve_firstTestSubMO21();
/** shortcut to explore the contents of a scope within the current index.
* Usually, clients would use QueryFocus or ScopeLocator to perform this task,
* but for the purpose of testing we're better off to invoke the query directly
*/
_ScopeIterMO explore_testScope (PlacementMO const& scopeTop);
}}}} // namespace steam::mobject::session::test
#endif