LUMIERA.clone/tests/library/helloworldtest.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

81 lines
2.1 KiB
C++

/*
HelloWorld(Test) - how to use this test framework...
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 helloworldtest.cpp
** unit test §§TODO§§
*/
#include "lib/test/run.hpp"
#include "lib/util.hpp"
#include <boost/lexical_cast.hpp>
#include <iostream>
using boost::lexical_cast;
using util::isnil;
using std::cout;
using std::endl;
namespace lumiera{
namespace test {
/**************************************//**
* Hellooooooo the world is just a test
* @test demo of using the test framework
*/
class HelloWorld_test : public Test
{
virtual void
run (Arg arg)
{
int num= isnil(arg)? 1 : lexical_cast<int> (arg[1]);
for ( ; 0 < num-- ; )
greeting();
}
void
greeting()
{
cout << "This is how the world ends..." <<endl;
}
};
/** Register this test class to be invoked in some test groups (suites)
* @remarks this macro \c LUNCHER is defined in run.hpp to simplify
* the registration of test classes. It expands to the
* following static variable definition
* \code
* Launch<HelloWorld_test> run_HelloWorld_test("HelloWorld_test","unit common");
* \endcode
*/
LAUNCHER (HelloWorld_test, "unit common");
}} // namespace lumiera::test