generictask_test.cpp

/***************************************************************************
  tag: Peter Soetens  Mon Jun 26 13:26:02 CEST 2006  generictask_test.cpp

                        generictask_test.cpp -  description
                           -------------------
    begin                : Mon June 26 2006
    copyright            : (C) 2006 Peter Soetens
    email                : peter.soetens@fmtc.be

 ***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/


#include "unit.hpp"
#include "generictask_test.hpp"
#include <scripting/FunctionGraph.hpp>
#include <OperationCaller.hpp>
#include <Service.hpp>
#include <internal/RemoteOperationCaller.hpp>

#include <extras/SimulationActivity.hpp>
#include <extras/SimulationThread.hpp>

#include <boost/function_types/function_type.hpp>

#include <rtt-config.h>
#include <Service.hpp>

using namespace std;

void
Generic_TaskTest::setUp()
{
    tc =  new TaskContext( "root" );
    tc->addService( this->createOperationCallerFactory() );
    tsim = new SimulationActivity(0.001, tc->engine() );
}


void
Generic_TaskTest::tearDown()
{
//     if ( tc->getPeer("programs") )
//         delete tc->getPeer("programs");
    tsim->stop();
    SimulationThread::Instance()->stop();
    delete tc;
    delete tsim;
}

bool Generic_TaskTest::assertBool( bool b) {
    return b;
}

Service* Generic_TaskTest::createOperationCallerFactory()
{
    Service* to = new Service("methods");

    to->addOperation("assert", &Generic_TaskTest::assertBool, this).doc("assert").arg("b", "bd");

    to->addOperation("m0", &Generic_TaskTest::m0, this).doc("M0");
    to->addOperation("m1", &Generic_TaskTest::m1, this).doc("M1").arg("a", "ad");
    to->addOperation("m2", &Generic_TaskTest::m2, this).doc("M2").arg("a", "ad").arg("a", "ad");
    to->addOperation("m3", &Generic_TaskTest::m3, this).doc("M3").arg("a", "ad").arg("a", "ad").arg("a", "ad");
    to->addOperation("m4", &Generic_TaskTest::m4, this).doc("M4").arg("a", "ad").arg("a", "ad").arg("a", "ad").arg("a", "ad");
    return to;
}

// Registers the fixture into the 'registry'
BOOST_FIXTURE_TEST_SUITE(  Generic_TaskTestSuite,  Generic_TaskTest )


BOOST_AUTO_TEST_CASE(testRemoteOperationCaller)
{
    Operation<double(void)> m0;
    boost::shared_ptr<ActionInterface> implementation( new detail::RemoteOperationCaller<double(void)>(tc->provides("methods"),"m0") );
    m0 = implementation;
    BOOST_CHECK( m0.ready() );

    Operation<double(int)> m1;
    implementation.reset( new detail::RemoteOperationCaller<double(int)>(tc->provides("methods"),"m1") );
    m1 = implementation;
    BOOST_CHECK( m1.ready() );

    BOOST_CHECK_EQUAL( -2.0, m1(1) );
    BOOST_CHECK_EQUAL( -1.0, m0() );
}

BOOST_AUTO_TEST_CASE(testOperationCallersC)
{
    OperationCallerC mc;
    double r = 0.0;
    mc = tc->provides("methods")->create("m0").ret( r );
    BOOST_CHECK( mc.execute() );
    BOOST_CHECK( r == -1.0 );

    mc = tc->provides("methods")->create("m2").argC(1).argC(1.0).ret( r );
    BOOST_CHECK( mc.execute() );
    BOOST_CHECK( r == -3.0 );

    mc = tc->provides("methods")->create("m3").ret( r ).argC(1).argC(1.0).argC(true);
    BOOST_CHECK( mc.execute() );
    BOOST_CHECK( r == -4.0 );

#if 0
        +" set r = methods.m0()\n"
        +" do methods.assert( r == -1.0 )\n"
        +" set r = methods.m1(1)\n"
        +" do methods.assert( r == -2.0 )\n"
        +" set r = methods.m2(1, 1.0)\n"
        +" do methods.assert( r == -3.0 )\n"
        +" set r = methods.m3(1, 1.0, true)\n"
        +" do methods.assert( r == -4.0 )\n"
        +" set r = methods.m4(1, 1.0, true, \"hello\")\n"
        +" do methods.assert( r == -5.0 )\n"
#endif
}

BOOST_AUTO_TEST_CASE(testOperationCaller)
{
    Operation<double(void)> m0("m0", &Generic_TaskTest::m0, this);
    Operation<double(int)> m1("m1", &Generic_TaskTest::m1, this);
    Operation<double(int,double)> m2("m2", &Generic_TaskTest::m2, this);
    Operation<double(int,double,bool)> m3("m3", &Generic_TaskTest::m3, this);
    Operation<double(int,double,bool,std::string)> m4("m4", &Generic_TaskTest::m4, this);

    BOOST_CHECK_EQUAL( -1.0, m0() );
    BOOST_CHECK_EQUAL( -2.0, m1(1) );
    BOOST_CHECK_EQUAL( -3.0, m2(1, 2.0) );
    BOOST_CHECK_EQUAL( -4.0, m3(1, 2.0, false) );
    BOOST_CHECK_EQUAL( -5.0, m4(1, 2.0, false,"hello") );
}

BOOST_AUTO_TEST_CASE(testOperationCallerFactory)
{
    // Test the addition of 'simple' methods to the operation interface,
    // and retrieving it back in a new OperationCaller object.

    Operation<double(void)> m0("m0", &Generic_TaskTest::m0, this);
    Operation<double(int)> m1("m1", &Generic_TaskTest::m1, this);
    Operation<double(int,double)> m2("m2", &Generic_TaskTest::m2, this);

    Service to("task");

    BOOST_CHECK( to.addOperationCaller(&m0) );
    BOOST_CHECK( ! to.addOperationCaller(&m0) );
    BOOST_CHECK( to.addOperationCaller(&m1) );
    BOOST_CHECK( to.addOperationCaller(&m2) );

    // test constructor
    Operation<double(void)> mm0 = to.getOperationCaller<double(void)>("m0");
    BOOST_CHECK( mm0.getOperationCallerImpl() );
    BOOST_CHECK( mm0.ready() );

    // test operator=()
    Operation<double(int)> mm1;
    mm1 = to.getOperationCaller<double(int)>("m1");
    BOOST_CHECK( mm1.getOperationCallerImpl() );
    BOOST_CHECK( mm1.ready() );

    Operation<double(int,double)> mm2 = to.getOperationCaller<double(int,double)>("m2");
    BOOST_CHECK( mm2.getOperationCallerImpl() );
    BOOST_CHECK( mm2.ready() );

    // start the activity, such that methods are accepted.
    BOOST_CHECK( tsim->start()) ;
    // execute methods and check status:
    BOOST_CHECK_EQUAL( -1.0, mm0() );

    BOOST_CHECK_EQUAL( -2.0, mm1(1) );
    BOOST_CHECK_EQUAL( -3.0, mm2(1, 2.0) );

    // test error cases:
    // Add uninitialised method:
    Operation<void(void)> mvoid;
    BOOST_CHECK(to.addOperationCaller( &mvoid ) == false);
    mvoid = Operation<void(void)>("voidm");
    BOOST_CHECK(to.addOperationCaller( &mvoid ) == false);

    // wrong type 1:
    mvoid = to.getOperationCaller<void(void)>("m1");
    BOOST_CHECK( mvoid.ready() == false );
    // wrong type 2:
    mvoid = to.getOperationCaller<void(bool)>("m1");
    // wrong type 3:
    mvoid = to.getOperationCaller<double(void)>("m0");
    BOOST_CHECK( mvoid.ready() == false );
    // non existing
    mvoid = to.getOperationCaller<void(void)>("voidm");
    BOOST_CHECK( mvoid.ready() == false );

    // this line may not crash:
    mvoid();

}

BOOST_AUTO_TEST_CASE(testCROperationCaller)
{
    this->ret = -3.3;

    Operation<double&(void)> m0r("m0r", &Generic_TaskTest::m0r, this);
    Operation<const double&(void)> m0cr("m0cr", &Generic_TaskTest::m0cr, this);

    Operation<double(double&)> m1r("m1r", &Generic_TaskTest::m1r, this);
    Operation<double(const double&)> m1cr("m1cr", &Generic_TaskTest::m1cr, this);

    BOOST_CHECK_EQUAL( -3.3, m0r() );
    BOOST_CHECK_EQUAL( -3.3, m0cr() );

    double value = 5.3;
    BOOST_CHECK_EQUAL( 5.3*2, m1r(value) );
    BOOST_CHECK_EQUAL( 5.3*2, value );
    BOOST_CHECK_EQUAL( 5.3, m1cr(5.3) );
}


BOOST_AUTO_TEST_CASE(testOperationCallerFromDS)
{
    Service to("task");

    Operation<double(void)> m0("m0", &Generic_TaskTest::m0, this);
    Operation<double(int)> m1("m1", &Generic_TaskTest::m1, this);
    Operation<double(int,double)> m2("m2", &Generic_TaskTest::m2, this);
    Operation<double(int,double,bool)> m3("m3", &Generic_TaskTest::m3, this);
    Operation<double(int,double,bool,std::string)> m4("m4", &Generic_TaskTest::m4, this);

    to.addOperation( &m0 ).doc("desc");
    to.addOperation( &m1 ).doc("desc").arg("a1", "d1");
    to.addOperation( &m2 ).doc("desc").arg("a1", "d1").arg("a2", "d2");
    to.addOperation( &m3 ).doc("desc").arg("a1", "d1").arg("a2", "d2").arg("a3", "d3");
    to.addOperation( &m4 ).doc("desc").arg("a1", "d1").arg("a2", "d2").arg("a3", "d3").arg("a4", "d4");

    double ret;
    OperationCallerC mc0( to.methods(), "m0");
    mc0.ret(ret);
    OperationCallerC mc1( to.methods(), "m1");
    mc1.argC(1).ret(ret);
    OperationCallerC mc2( to.methods(), "m2");
    mc2.argC(1).argC(2.0).ret(ret);
    OperationCallerC mc3( to.methods(), "m3");
    mc3.argC(1).argC(2.0).argC(false).ret(ret);
    OperationCallerC mc4( to.methods(), "m4");
    mc4.argC(1).argC(2.0).argC(false).argC(std::string("hello")).ret(ret);

    BOOST_CHECK( mc0.execute() );
    BOOST_CHECK_EQUAL(-1.0, ret);
    BOOST_CHECK( mc1.execute() );
    BOOST_CHECK_EQUAL(-2.0, ret);
    BOOST_CHECK( mc2.execute() );
    BOOST_CHECK_EQUAL(-3.0, ret);
    BOOST_CHECK( mc3.execute() );
    BOOST_CHECK_EQUAL(-4.0, ret);
    BOOST_CHECK( mc4.execute() );
    BOOST_CHECK_EQUAL(-5.0, ret);
}

BOOST_AUTO_TEST_CASE(testDSOperationCaller)
{
    Service to("task");

    // A method of which the first argument type is a pointer to the object
    // on which it must be invoked. The pointer is internally stored as a weak_ptr,
    // thus the object must be stored in a shared_ptr, in a DataSource. Scripting
    // requires this for copying state machines.

    Operation<double(Generic_TaskTest*)> meth0("m0",
                                          &Generic_TaskTest::m0);

    method_ds("m0", &Generic_TaskTest::m0);

    Operation<double(Generic_TaskTest*,int)> meth1("m1",
                                          &Generic_TaskTest::m1);

    method_ds("m1", &Generic_TaskTest::m1);
    method_ds("ms",&Generic_TaskTest::comstr );

    boost::shared_ptr<Generic_TaskTest> ptr( new Generic_TaskTest() );
    ValueDataSource<boost::weak_ptr<Generic_TaskTest> >::shared_ptr wp = new ValueDataSource<boost::weak_ptr<Generic_TaskTest> >( ptr );
    BOOST_CHECK( to.addOperationCallerDS( wp.get(), meth0, "desc" ) );
    BOOST_CHECK( to.addOperationCallerDS( wp.get(), meth1, "desc", "a1", "d1" ) );

    // this actually works ! the method will detect the deleted pointer.
    //ptr.reset();

    BOOST_CHECK( tsim->start()) ;

    double ret;
    OperationCallerC c0  = to.create("m0").ret(ret);
    BOOST_CHECK( c0.execute() );
    BOOST_CHECK_EQUAL( -1.0, ret );
    OperationCallerC c1  = to.create("m1").argC(1).ret(ret);
    BOOST_CHECK( c1.execute() );
    BOOST_CHECK_EQUAL( -2.0, ret );

    BOOST_CHECK( tsim->stop()) ;

}

BOOST_AUTO_TEST_CASE(testAddOperationCaller)
{
    Operation<double(void)> m0 = method("m0", &Generic_TaskTest::m0, this);

    Operation<double(int)> m1 = method("m1", &Generic_TaskTest::m1, this);
    Operation<double(int,double)> m2 = method("m2", &Generic_TaskTest::m2, this);
    Operation<double(int,double,bool)> m3 = method("m3", &Generic_TaskTest::m3, this);
    Operation<double(int,double,bool,std::string)> m4 = method("m4", &Generic_TaskTest::m4, this);

    BOOST_CHECK_EQUAL( -1.0, m0() );
    BOOST_CHECK_EQUAL( -2.0, m1(1) );
    BOOST_CHECK_EQUAL( -3.0, m2(1, 2.0) );
    BOOST_CHECK_EQUAL( -4.0, m3(1, 2.0, false) );
    BOOST_CHECK_EQUAL( -5.0, m4(1, 2.0, false,"hello") );
}

BOOST_AUTO_TEST_SUITE_END()