lumiera_/tests/library/singleton-subclass-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

150 lines
4.3 KiB
C++

/*
SingletonSubclass(Test) - actually creating a subclass of the Singleton Type
Copyright (C) Lumiera.org
2008, 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 singleton-subclass-test.cpp
** unit test §§TODO§§
*/
#include "lib/test/run.hpp"
#include "lib/test/test-helper.hpp"
#include "lib/format-string.hpp"
#include "lib/format-cout.hpp"
#include "lib/util.hpp"
#include "test-target-obj.hpp"
#include "lib/depend.hpp"
#include <boost/lexical_cast.hpp>
using boost::lexical_cast;
using util::isSameObject;
using util::_Fmt;
using util::isnil;
using std::string;
namespace lib {
namespace test{
using lumiera::error::LUMIERA_ERROR_LIFECYCLE;
/**
* Target object to be instantiated as Singleton
* Allocates a variable amount of additional heap memory
* and prints diagnostic messages.
*/
class Interface : public TestTargetObj
{
public:
static int cnt;
static void setCountParam (uint c) { Interface::cnt = c; }
virtual string identify() { return "Interface"; }
protected:
Interface () : TestTargetObj(cnt) {}
virtual ~Interface() {}
friend class lib::DependencyFactory;
};
int Interface::cnt = 0;
class Impl : public Interface
{
public:
virtual string identify() { return "Implementation"; }
};
// for checking the safety.....
class Impl_XXX : public Impl { };
class Unrelated { };
/***************************************************************//**
* @test specialised variant of the Singleton Factory, for creating
* subclasses (implementation classes) without coupling the
* caller to the concrete class type.
* Expected results: an instance of the subclass is created.
* @see lib::Depend
* @see lib::buildSingleton()
* @see lib/dependency-factory.hpp
*/
class SingletonSubclass_test : public Test
{
virtual void
run(Arg arg)
{
uint num= isnil(arg)? 1 : lexical_cast<uint>(arg[1]);
cout << _Fmt("using the Singleton should create TargetObj(%d)...\n") % num;
Interface::setCountParam(num);
// marker to declare the concrete type to be created
DependencyFactory::InstanceConstructor factoryFunction = buildSingleton<Impl>();
// define an instance of the Singleton factory,
// specialised to create the concrete Type passed in
Depend<Interface> instance (factoryFunction);
// Now use the Singleton factory...
// Note: we get the Base type
Interface& t1 = instance();
Interface& t2 = instance();
CHECK (isSameObject (t1, t2), "not a Singleton, got two different instances." );
cout << "calling a non-static method on the Singleton-"
<< t1.identify() << endl
<< t1 << endl;
verify_error_detection ();
}
void
verify_error_detection ()
{
VERIFY_ERROR (LIFECYCLE, Depend<Interface> instance (buildSingleton<Impl_XXX>()) );
VERIFY_ERROR (LIFECYCLE, Depend<Interface> instance (buildSingleton<Unrelated>()) );
Depend<Interface> newFactory;
CHECK ( INSTANCEOF (Impl, &newFactory() )); // works as before
}
};
/** Register this test class... */
LAUNCHER (SingletonSubclass_test, "unit common");
}} // namespace lib::test