LUMIERA.clone/tests/basics/singleton-testmock-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

164 lines
3.9 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.

/*
SingletonTestMock(Test) - using Singleton for injecting Test-Mocks
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 singleton-testmock-test.cpp
** unit test \ref SingletonTestMock_test
*/
#include "lib/test/run.hpp"
#include "lib/depend-inject.hpp"
#include "lib/util.hpp"
#include "lib/format-cout.hpp"
#include "lib/format-string.hpp"
using util::_Fmt;
using util::isnil;
namespace lib {
namespace test{
/**
* Client Class normally to be instantiated as Singleton.
* But for tests, this class should be replaced by a Mock....
*/
class TestSingO
{
int callCnt_;
Symbol typid_;
_Fmt msg_;
public:
TestSingO(Symbol ty="TestSingO")
: callCnt_(0)
, typid_(ty)
, msg_("%s::doIt() call=%d\n")
{
TRACE (test, "ctor %s", typid_.c());
}
virtual
~TestSingO()
{
TRACE (test, "dtor %s", typid_.c());
}
void doIt ()
{
++callCnt_;
cout << msg_ % typid_ % callCnt_;
}
int getCnt ()
{
return callCnt_;
}
};
/**
* Mock-1 to replace the Client Class...
*/
struct Mock_1 : TestSingO
{
Mock_1() : TestSingO("Mock_1") { };
};
/**
* Mock-2 to replace the Client Class...
* @note no default ctor
*/
struct Mock_2 : TestSingO
{
int id;
Mock_2(Literal specialID, int i)
: TestSingO{Symbol (_Fmt{"%s_%d"} % specialID % i)}
, id{i}
{ };
};
/***************************************************************//**
* @test inject a Mock object into the Singleton Factory,
* to be returned and used in place of the original object.
* This test covers the full usage cycle: first access the
* Client Object, then replace it by two different mocks,
* and finally restore the original Client Object.
* @see lib::Depend
* @see depend-inject.hpp
* @see DependencyFactory_test
*/
class SingletonTestMock_test : public Test
{
void
run (Arg)
{
Depend<TestSingO> sing;
sing().doIt();
sing().doIt();
CHECK (sing().getCnt() == 2);
{
// shadow by local Mock instance
DependInject<TestSingO>::Local<Mock_1> mock_1;
sing().doIt();
sing().doIt();
sing().doIt();
sing().doIt();
sing().doIt();
CHECK (sing().getCnt() == 5);
// shadow again by different local Mock, this time with special ctor call
int instanceID = 0;
DependInject<TestSingO>::Local<Mock_2> mock_2 ([&]{ return new Mock_2{"Mock", instanceID}; });
// NOTE: the ctor call for the Mock really happens delayed...
instanceID = rani(10);
sing().doIt(); // ctor invoked on first access
CHECK (sing().getCnt() == 1);
// can access the Mock for instrumentation
CHECK (instanceID == mock_2->id);
}// original instance automatically un-shadowed here
CHECK (sing().getCnt() == 2);
sing().doIt();
CHECK (sing().getCnt() == 3);
}
};
/** Register this test class... */
LAUNCHER (SingletonTestMock_test, "unit common");
}} // namespace lib::test